Merge pull request #1995 from guillaume-sainthillier/claude/dazzling-mayer-2PJ8g

Add Elasticsearch 9 and Elastica 9 support

Author: XWB

.github/workflows/continuous-integration.yaml

@@ -48,13 +48,20 @@ jobs:
           - '8.0.*'
         elasticsearch:
           - '8.12.0'
+          - '9.0.0'
         dependencies:
           - 'highest'
         include:
           - php: '8.1'
             dependencies: 'lowest'
             symfony: '6.4.*'
             elasticsearch: '8.12.0'
+            elastica: '^8.0'
+          # Pin Elastica to the major matching the Elasticsearch server version
+          - elasticsearch: '8.12.0'
+            elastica: '^8.0'
+          - elasticsearch: '9.0.0'
+            elastica: '^9.0'
         exclude:
           - php: '8.1'
             symfony: '7.4.*'
@@ -77,6 +84,9 @@ jobs:
           tools: 'pecl, composer:v2, flex'
           extensions: 'curl, json, mbstring, mongodb, openssl'
 
+      - name: 'Pin Elastica to ${{ matrix.elastica }}'
+        run: 'composer require --no-update "ruflin/elastica:${{ matrix.elastica }}"'
+
       - name: "Install Composer dependencies (${{ matrix.dependencies }})"
         uses: "ramsey/composer-install@v3"
         with:

CHANGELOG-7.0.md

@@ -5,6 +5,11 @@ This changelog references the relevant changes (bug and security fixes) done
 in 7.x versions.
 
 ### 7.1.1 (2026-xx-xx)
+* Added Elasticsearch 9 and Elastica 9 support.
+* `headers` client config is now applied via `Transport::setHeader()` so it works uniformly across Guzzle, Symfony HTTP Client, and elastic-transport's bundled Curl client.
+* `timeout` client config is now translated to `CURLOPT_TIMEOUT` at runtime when the active transport client is elastic-transport's bundled Curl — Guzzle/Symfony HTTP Client keep consuming the original `'timeout'` key as before.
+* Default config no longer injects `'headers' => []` / `'timeout' => 30` into `http_client_options`, which would otherwise break elastic-transport's bundled Curl client (PHP 8+ `ValueError` on unknown `curl_setopt_array` keys).
+* **Deprecated** the top-level `headers` and `timeout` client config. Move them into `client_options` — for Guzzle/Symfony HTTP Client use `headers` / `timeout`, for the bundled Curl client use `CURLOPT_HTTPHEADER` / `CURLOPT_TIMEOUT`.
 * Fix deprecated Symfony method call.
 * Instantiate custom repositories using the DI service locator.
 * Add compatibility with `doctrine/doctrine-bundle` 3.x, `doctrine/phpcr-odm` 3.x and Symfony 8.0 in highest-deps CI.

README.md

@@ -28,15 +28,15 @@ Installation instructions can be found in the [documentation](doc/setup.md)
 Versions & Dependencies
 -----------------------
 
-Version 7 of the FOSElasticaBundle is compatible with Elasticsearch 8. It requires Symfony 6.4 or greater. When using
+Version 7 of the FOSElasticaBundle is compatible with Elasticsearch 8 and 9. It requires Symfony 6.4 or greater. When using
 Symfony Flex there is also a [recipe to ease the setup](https://github.com/symfony/recipes-contrib/tree/master/friendsofsymfony/elastica-bundle/5.0).
 Earlier versions of the FOSElasticaBundle are not maintained anymore and only work with older versions of the dependencies.
 The following table shows the compatibilities of different versions of the bundle.
 
-| FOSElasticaBundle | Elastica | Elasticsearch | Symfony    | PHP   |
-|-------------------|----------|---------------| ---------- | ----- |
-| [6.6] (6.x)       | ^7.1     | 7.\*          | ^5.4\|^6.4\|^7.1 | ^7.4\|^8.1 |
-| [7.1] (master)    | ^8.0     | 8.\*          | ^6.4\|^7.4\|^8.0 | ^8.1 |
+| FOSElasticaBundle | Elastica         | Elasticsearch | Symfony    | PHP   |
+|-------------------|------------------|---------------| ---------- | ----- |
+| [6.6] (6.x)       | ^7.1             | 7.\*          | ^5.4\|^6.4\|^7.1 | ^7.4\|^8.1 |
+| [7.1] (master)    | ^8.0 \|\| ^9.0   | 8.\* \|\| 9.\* | ^6.4\|^7.4\|^8.0 | ^8.1 |
 
 License
 -------

composer.json

@@ -33,7 +33,7 @@
         "php": "^8.1",
         "pagerfanta/pagerfanta": "^3.0 || ^4.0",
         "psr/log": "^3.0",
-        "ruflin/elastica": "^8.0",
+        "ruflin/elastica": "^8.0 || ^9.0",
         "symfony/console": "^6.4 || ^7.4 || ^8.0",
         "symfony/dependency-injection": "^6.4 || ^7.4 || ^8.0",
         "symfony/event-dispatcher": "^6.4 || ^7.4 || ^8.0",
@@ -51,13 +51,15 @@
         "jms/serializer": "^3.32",
         "jms/serializer-bundle": "^5.4",
         "knplabs/knp-components": "^4.0 || ^5.0",
+        "nyholm/psr7": "^1.8",
         "php-cs-fixer/shim": "3.60.0",
         "phpstan/extension-installer": "^1.1",
         "phpstan/phpstan": "^1.12",
         "phpstan/phpstan-phpunit": "^1.4",
         "phpstan/phpstan-symfony": "^1.4",
         "phpunit/phpunit": "^9.5",
         "symfony/expression-language": "^6.4 || ^7.4 || ^8.0",
+        "symfony/http-client": "^6.4 || ^7.4 || ^8.0",
         "symfony/messenger": "^6.4 || ^7.4 || ^8.0",
         "symfony/serializer": "^6.4 || ^7.4 || ^8.0",
         "symfony/twig-bundle": "^6.4 || ^7.4 || ^8.0",
@@ -85,6 +87,7 @@
     "config": {
         "allow-plugins": {
             "ergebnis/composer-normalize": true,
+            "php-http/discovery": true,
             "phpstan/extension-installer": true
         }
     },

doc/cookbook/elastica-http-client-configuration.md

@@ -4,10 +4,16 @@ Configuring Elastica HTTP client
 Setting HTTP Headers
 --------------------
 
+> **Deprecated since 7.1**: the top-level `headers` client option is deprecated.
+> Move headers into `client_options` for your HTTP client (`headers` key for
+> Guzzle/Symfony HTTP Client, `CURLOPT_HTTPHEADER` for elastic-transport's
+> bundled Curl client).
+
 It may be necessary to set HTTP headers on the Elastica client, for example an
 Authorization header.
 
-They can be set using the `headers` configuration key:
+They can be set using the deprecated `headers` configuration key (still works,
+applied via `Transport::setHeader` so it covers every HTTP client):
 
 ```yaml
 # app/config/config.yml
@@ -59,7 +65,7 @@ fos_elastica:
 Setting other client options
 --------------------
 
-Any other client option for Elastica client can be set using the `client_options` configuration key:
+`client_options` is a raw pass-through to the underlying HTTP client (Guzzle, Symfony HTTP Client, or elastic-transport's bundled Curl client). Configure it with whatever option names your client understands:
 
 ```yaml
 # app/config/config.yml
@@ -68,7 +74,16 @@ fos_elastica:
         default:
             hosts: ['http://example.com:80']
             client_options:
-              !php/const \CURLOPT_RANDOM_FILE: /dev/urandom
+              # Guzzle / Symfony HTTP Client
+              timeout: 30
+              connect_timeout: 10
               proxy: 'http://localhost:8125'
-              connect_timeout: 10 # if using Guzzle
+
+              # elastic-transport's bundled Curl client (used when neither Guzzle nor
+              # Symfony HTTP Client is installed). Use CURLOPT_* integer keys:
+              !php/const \CURLOPT_TIMEOUT: 30
+              !php/const \CURLOPT_CONNECTTIMEOUT: 10
+              !php/const \CURLOPT_RANDOM_FILE: /dev/urandom
 ```
+
+> **Deprecated since 7.1:** the top-level `timeout` client option is no longer applied — move it into `client_options` for your specific HTTP client (`timeout` for Guzzle/Symfony, `CURLOPT_TIMEOUT` for bundled Curl).

src/DependencyInjection/Configuration.php

@@ -356,12 +356,22 @@ private function addClientsSection(ArrayNodeDefinition $rootNode): void
                                 ->prototype('scalar')->end()
                             ->end()
                             ->arrayNode('headers')
+                                ->setDeprecated(
+                                    'friendsofsymfony/elastica-bundle',
+                                    '7.1',
+                                    'The "%node%" option is deprecated. Configure headers via "client_options" instead — for Guzzle/Symfony HTTP Client use "headers", for elastic-transport\'s bundled Curl client use CURLOPT_HTTPHEADER.',
+                                )
                                 ->normalizeKeys(false)
                                 ->useAttributeAsKey('name')
                                 ->prototype('scalar')->end()
                             ->end()
                             ->scalarNode('timeout')
                                 ->defaultValue(30)
+                                ->setDeprecated(
+                                    'friendsofsymfony/elastica-bundle',
+                                    '7.1',
+                                    'The "%node%" option is deprecated. Configure your HTTP client directly via "client_options" instead — "timeout" for Guzzle/Symfony HTTP Client, CURLOPT_TIMEOUT for elastic-transport\'s bundled Curl client.',
+                                )
                             ->end()
                             ->scalarNode('retry_on_conflict')
                                 ->defaultValue(0)

src/Elastica/Client.php

@@ -14,6 +14,7 @@
 use Elastic\Elasticsearch\Exception\ClientResponseException;
 use Elastic\Elasticsearch\Exception\ElasticsearchException;
 use Elastic\Elasticsearch\Response\Elasticsearch;
+use Elastic\Transport\Client\Curl;
 use Elastica\Client as BaseClient;
 use Elastica\Exception\ClientException;
 use FOS\ElasticaBundle\Event\ElasticaRequestExceptionEvent;
@@ -36,7 +37,55 @@ class Client extends BaseClient implements ResetInterface
 {
     public function __construct(array|string $config = [], private readonly array $forbiddenCodes = [400, 403, 404], ?LoggerInterface $logger = null)
     {
+        // Reroute deprecated http_client_options.headers via Transport::setHeader so it works for any
+        // PSR-18 client — elastic-transport's bundled Curl client ValueErrors on string keys in curl_setopt_array.
+        $headers = [];
+        if (\is_array($config) && \is_array($config['transport_config']['http_client_options']['headers'] ?? null)) {
+            $headers = $config['transport_config']['http_client_options']['headers'];
+            unset($config['transport_config']['http_client_options']['headers']);
+        }
+
         parent::__construct($config, $logger);
+
+        foreach ($headers as $name => $value) {
+            $this->getTransport()->setHeader($name, $value);
+        }
+
+        $this->translateOptionsForBundledCurl();
+    }
+
+    /**
+     * When the active transport client is elastic-transport's bundled Curl, swap any 'timeout' string
+     * key (deprecated bundle alias) to CURLOPT_TIMEOUT — otherwise curl_setopt_array ValueErrors on
+     * the unknown option.
+     */
+    private function translateOptionsForBundledCurl(): void
+    {
+        if (!\class_exists(Curl::class)) {
+            return;
+        }
+
+        $transportClient = $this->getTransport()->getClient();
+        if (!$transportClient instanceof Curl) {
+            return;
+        }
+
+        $optionsProperty = new \ReflectionProperty($transportClient, 'options');
+        $options = $optionsProperty->getValue($transportClient);
+
+        // `timeout` -> CURLOPT_TIMEOUT
+        if (isset($options['timeout'])) {
+            $options[\CURLOPT_TIMEOUT] = $options['timeout'];
+            unset($options['timeout']);
+        }
+
+        // `connect_timeout` -> CURLOPT_CONNECTTIMEOUT
+        if (isset($options['connect_timeout'])) {
+            $options[\CURLOPT_CONNECTTIMEOUT] = $options['connect_timeout'];
+            unset($options['connect_timeout']);
+        }
+
+        $transportClient->setOptions($options);
     }
 
     /**

src/Elastica/ElasticsearchVersionDetector.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the FOSElasticaBundle package.
+ *
+ * (c) FriendsOfSymfony <https://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\ElasticaBundle\Elastica;
+
+/**
+ * Static probes for the installed Elastica library's API generation.
+ *
+ * Despite the name, the detection here is about the ruflin/elastica PHP library
+ * (Elastica 8 vs Elastica 9), not the Elasticsearch server. The two move
+ * roughly in lockstep but the runtime decisions the bundle has to make
+ * (which template-API shape to produce, which endpoint to hit) are driven by
+ * the client library, not the server.
+ */
+final class ElasticsearchVersionDetector
+{
+    private function __construct()
+    {
+    }
+
+    /**
+     * Returns true when the active Elastica's IndexTemplate exclusively hits the
+     * new `_index_template` API (body must wrap `mappings`/`settings` under a
+     * `template` key). False when it defaults to (or only supports) the legacy
+     * `_template` API.
+     *
+     * Detection uses \Elastica\Request as the marker: it ships in every 8.x
+     * release and was removed in 9.0 (documented in Elastica's UPGRADE-9.0.md
+     * under "Removed Classes"). Cleaner than property/version probes — the
+     * class boundary precisely matches the major-version boundary.
+     */
+    public static function usesNewIndexTemplateApi(): bool
+    {
+        return !\class_exists(\Elastica\Request::class);
+    }
+}

src/Event/PreElasticaRequestEvent.php

@@ -13,11 +13,12 @@
 
 namespace FOS\ElasticaBundle\Event;
 
-use Elastica\Request;
 use Symfony\Contracts\EventDispatcher\Event;
 
 class PreElasticaRequestEvent extends Event
 {
+    public const DEFAULT_CONTENT_TYPE = 'application/json';
+
     /**
      * @param array<string, mixed>|string $data
      */
@@ -32,7 +33,7 @@ public function __construct(
          * @var array<string, mixed>
          */
         private readonly array $query,
-        private readonly string $contentType = Request::DEFAULT_CONTENT_TYPE
+        private readonly string $contentType = self::DEFAULT_CONTENT_TYPE
     ) {
     }
 

src/Index/MappingBuilder.php

@@ -13,6 +13,7 @@
 
 use FOS\ElasticaBundle\Configuration\IndexConfigInterface;
 use FOS\ElasticaBundle\Configuration\IndexTemplateConfig;
+use FOS\ElasticaBundle\Elastica\ElasticsearchVersionDetector;
 use FOS\ElasticaBundle\Event\PostIndexMappingBuildEvent;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
@@ -54,11 +55,27 @@ public function buildIndexMapping(IndexConfigInterface $indexConfig): array
     /**
      * Builds mappings for an entire index template.
      *
-     * @return array{mappings: TMapping, settings: TSettings, index_patterns: list<non-empty-string>}
+     * @return array{index_patterns: list<non-empty-string>, mappings?: TMapping, settings?: TSettings, template?: array{mappings?: TMapping, settings?: TSettings}}
      */
     public function buildIndexTemplateMapping(IndexTemplateConfig $indexTemplateConfig): array
     {
         $mapping = $this->buildIndexMapping($indexTemplateConfig);
+
+        if (ElasticsearchVersionDetector::usesNewIndexTemplateApi()) {
+            $template = [];
+            if (isset($mapping['mappings'])) {
+                $template['mappings'] = $mapping['mappings'];
+                unset($mapping['mappings']);
+            }
+            if (isset($mapping['settings'])) {
+                $template['settings'] = $mapping['settings'];
+                unset($mapping['settings']);
+            }
+            if ($template) {
+                $mapping['template'] = $template;
+            }
+        }
+
         $mapping['index_patterns'] = $indexTemplateConfig->getIndexPatterns();
 
         return $mapping;