feat(elasticsearch): re-introduce v7 support

Frank Verschuren · Frank Verschuren · commit 35160cfc82ef · 2024-12-22T08:39:06.000+01:00
diff --git a/composer.json b/composer.json
@@ -127,7 +127,7 @@
         "doctrine/mongodb-odm": "^2.6",
         "doctrine/mongodb-odm-bundle": "^4.0 || ^5.0",
         "doctrine/orm": "^2.17 || ^3.0",
-        "elasticsearch/elasticsearch": "^8.4",
+        "elasticsearch/elasticsearch": "^7.17 || ^8.4",
         "friends-of-behat/mink-browserkit-driver": "^1.3.1",
         "friends-of-behat/mink-extension": "^2.2",
         "friends-of-behat/symfony-extension": "^2.1",
diff --git a/src/Elasticsearch/State/CollectionProvider.php b/src/Elasticsearch/State/CollectionProvider.php
@@ -24,6 +24,8 @@
 use Elastic\Elasticsearch\Client;
 use Elastic\Elasticsearch\Exception\ClientResponseException;
 use Elastic\Elasticsearch\Response\Elasticsearch;
+use Elasticsearch\Client as V7Client;
+use Elasticsearch\Common\Exceptions\Missing404Exception as V7Missing404Exception;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 
 /**
@@ -37,7 +39,7 @@ final class CollectionProvider implements ProviderInterface
     /**
      * @param RequestBodySearchCollectionExtensionInterface[] $collectionExtensions
      */
-    public function __construct(private readonly Client $client, private readonly ?DenormalizerInterface $denormalizer = null, private readonly ?Pagination $pagination = null, private readonly iterable $collectionExtensions = [], private readonly ?InflectorInterface $inflector = new Inflector())
+    public function __construct(private readonly V7Client|Client $client, private readonly ?DenormalizerInterface $denormalizer = null, private readonly ?Pagination $pagination = null, private readonly iterable $collectionExtensions = [], private readonly ?InflectorInterface $inflector = new Inflector())
     {
     }
 
@@ -69,12 +71,14 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
 
         try {
             $documents = $this->client->search($params);
+        } catch (V7Missing404Exception $e) {
+            throw new Error(status: $e->getCode(), detail: $e->getMessage(), title: $e->getMessage(), originalTrace: $e->getTrace());
         } catch (ClientResponseException $e) {
             $response = $e->getResponse();
             throw new Error(status: $response->getStatusCode(), detail: (string) $response->getBody(), title: $response->getReasonPhrase(), originalTrace: $e->getTrace());
         }
 
-        if ($documents instanceof Elasticsearch) {
+        if (class_exists(Elastic\Elasticsearch\Response\Elasticsearch::class) && $documents instanceof Elasticsearch) {
             $documents = $documents->asArray();
         }
 
diff --git a/src/Elasticsearch/State/ItemProvider.php b/src/Elasticsearch/State/ItemProvider.php
@@ -23,6 +23,8 @@
 use Elastic\Elasticsearch\Client;
 use Elastic\Elasticsearch\Exception\ClientResponseException;
 use Elastic\Elasticsearch\Response\Elasticsearch;
+use Elasticsearch\Client as V7Client;
+use Elasticsearch\Common\Exceptions\Missing404Exception as V7Missing404Exception;
 use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 
@@ -34,7 +36,7 @@
  */
 final class ItemProvider implements ProviderInterface
 {
-    public function __construct(private readonly Client $client, private readonly ?DenormalizerInterface $denormalizer = null, private readonly ?InflectorInterface $inflector = new Inflector())
+    public function __construct(private readonly V7Client|Client $client, private readonly ?DenormalizerInterface $denormalizer = null, private readonly ?InflectorInterface $inflector = new Inflector())
     {
     }
 
@@ -56,6 +58,8 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
 
         try {
             $document = $this->client->get($params);
+        } catch (V7Missing404Exception) {
+            return null;
         } catch (ClientResponseException $e) {
             $response = $e->getResponse();
             if (404 === $response->getStatusCode()) {
@@ -65,7 +69,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
             throw new Error(status: $response->getStatusCode(), detail: (string) $response->getBody(), title: $response->getReasonPhrase(), originalTrace: $e->getTrace());
         }
 
-        if ($document instanceof Elasticsearch) {
+        if (class_exists(Elastic\Elasticsearch\Response\Elasticsearch::class) && $documents instanceof Elasticsearch) {
             $document = $document->asArray();
         }
 
diff --git a/src/Elasticsearch/composer.json b/src/Elasticsearch/composer.json
@@ -27,7 +27,7 @@
         "api-platform/metadata": "^3.4 || ^4.0",
         "api-platform/serializer": "^3.4 || ^4.0",
         "api-platform/state": "^3.4 || ^4.0",
-        "elasticsearch/elasticsearch": "^8.4",
+        "elasticsearch/elasticsearch": "^7.17 || ^8.4",
         "symfony/cache": "^6.4 || ^7.0",
         "symfony/console": "^6.4 || ^7.0",
         "symfony/property-access": "^6.4 || ^7.0",
diff --git a/src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php b/src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php
@@ -810,7 +810,11 @@ private function registerElasticsearchConfiguration(ContainerBuilder $container,
             return;
         }
 
-        $clientClass = class_exists(\Elasticsearch\Client::class) ? \Elasticsearch\Client::class : \Elastic\Elasticsearch\Client::class;
+        $clientClass = class_exists(\Elasticsearch\Client::class)
+            // ES v8 and up
+            ? \Elasticsearch\Client::class
+            // ES v7
+            : \Elastic\Elasticsearch\Client::class;
 
         $clientDefinition = new Definition($clientClass);
         $container->setDefinition('api_platform.elasticsearch.client', $clientDefinition);
diff --git a/src/Symfony/Bundle/DependencyInjection/Compiler/ElasticsearchClientPass.php b/src/Symfony/Bundle/DependencyInjection/Compiler/ElasticsearchClientPass.php
@@ -40,8 +40,10 @@ public function process(ContainerBuilder $container): void
         }
 
         if (class_exists(\Elasticsearch\ClientBuilder::class)) {
+            // ES v7
             $builderName = \Elasticsearch\ClientBuilder::class;
         } else {
+            // ES v8 and up
             $builderName = \Elastic\Elasticsearch\ClientBuilder::class;
         }
 
diff --git a/src/Symfony/Bundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/DependencyInjection/Configuration.php
@@ -468,7 +468,12 @@ private function addElasticsearchSection(ArrayNodeDefinition $rootNode): void
                             ->validate()
                                 ->ifTrue()
                                 ->then(static function (bool $v): bool {
-                                    if (!(class_exists(\Elasticsearch\Client::class) || class_exists(\Elastic\Elasticsearch\Client::class))) {
+                                    if (
+                                        // ES v8 and up
+                                        !class_exists(\Elasticsearch\Client::class)
+                                        // ES v7
+                                        && !class_exists(\Elastic\Elasticsearch\Client::class)
+                                    ) {
                                         throw new InvalidConfigurationException('The elasticsearch/elasticsearch package is required for Elasticsearch support.');
                                     }
 
diff --git a/tests/Behat/ElasticsearchContext.php b/tests/Behat/ElasticsearchContext.php
@@ -15,6 +15,7 @@
 
 use Behat\Behat\Context\Context;
 use Elastic\Elasticsearch\Client;
+use Elasticsearch\Client as V7Client;
 use Symfony\Component\Finder\Finder;
 
 /**
@@ -24,7 +25,7 @@
  */
 final class ElasticsearchContext implements Context
 {
-    public function __construct(private readonly Client $client, private readonly string $elasticsearchMappingsPath, private readonly string $elasticsearchFixturesPath)
+    public function __construct(private readonly V7Client|Client $client, private readonly string $elasticsearchMappingsPath, private readonly string $elasticsearchFixturesPath)
     {
     }
 
diff --git a/tests/Symfony/Bundle/DependencyInjection/Compiler/ElasticsearchClientPassTest.php b/tests/Symfony/Bundle/DependencyInjection/Compiler/ElasticsearchClientPassTest.php
@@ -36,6 +36,7 @@ public function testConstruct(): void
 
     public function testProcess(): void
     {
+        // ES v7
         if (class_exists(\Elasticsearch\ClientBuilder::class)) {
             $clientBuilder = \Elasticsearch\ClientBuilder::class;
 
@@ -45,6 +46,7 @@ public function testProcess(): void
                 Argument::withEntry('tracer', Argument::type(Reference::class)),
                 Argument::size(3),
             ];
+        // ES v8 and up
         } else {
             $clientBuilder = \Elastic\Elasticsearch\ClientBuilder::class;
 
@@ -75,7 +77,11 @@ public function testProcess(): void
 
     public function testProcessWithoutConfiguration(): void
     {
-        $clientBuilder = class_exists(\Elasticsearch\ClientBuilder::class) ? \Elasticsearch\ClientBuilder::class : \Elastic\Elasticsearch\ClientBuilder::class;
+        $clientBuilder = class_exists(\Elasticsearch\ClientBuilder::class)
+            // ES v7
+            ? \Elasticsearch\ClientBuilder::class
+            // ES v8 and up
+            : \Elastic\Elasticsearch\ClientBuilder::class;
 
         $clientDefinitionProphecy = $this->prophesize(Definition::class);
         $clientDefinitionProphecy->setFactory([$clientBuilder, 'build'])->willReturn($clientDefinitionProphecy->reveal())->shouldBeCalled();

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@`
`23`	`23`	`use Elastic\Elasticsearch\Client;`
`24`	`24`	`use Elastic\Elasticsearch\Exception\ClientResponseException;`
`25`	`25`	`use Elastic\Elasticsearch\Response\Elasticsearch;`
	`26`	`+use Elasticsearch\Client as V7Client;`
	`27`	`+use Elasticsearch\Common\Exceptions\Missing404Exception as V7Missing404Exception;`
`26`	`28`	`use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;`
`27`	`29`	`use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;`
`28`	`30`
`@@ -34,7 +36,7 @@`
`34`	`36`	`*/`
`35`	`37`	`final class ItemProvider implements ProviderInterface`
`36`	`38`	`{`
`37`		`- public function __construct(private readonly Client $client, private readonly ?DenormalizerInterface $denormalizer = null, private readonly ?InflectorInterface $inflector = new Inflector())`
	`39`	`+ public function __construct(private readonly V7Client\|Client $client, private readonly ?DenormalizerInterface $denormalizer = null, private readonly ?InflectorInterface $inflector = new Inflector())`
`38`	`40`	`{`
`39`	`41`	`}`
`40`	`42`
`@@ -56,6 +58,8 @@ public function provide(Operation $operation, array $uriVariables = [], array $c`
`56`	`58`
`57`	`59`	`try {`
`58`	`60`	`$document = $this->client->get($params);`
	`61`	`+ } catch (V7Missing404Exception) {`
	`62`	`+ return null;`
`59`	`63`	`} catch (ClientResponseException $e) {`
`60`	`64`	`$response = $e->getResponse();`
`61`	`65`	`if (404 === $response->getStatusCode()) {`
`@@ -65,7 +69,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c`
`65`	`69`	`throw new Error(status: $response->getStatusCode(), detail: (string) $response->getBody(), title: $response->getReasonPhrase(), originalTrace: $e->getTrace());`
`66`	`70`	`}`
`67`	`71`
`68`		`- if ($document instanceof Elasticsearch) {`
	`72`	`+ if (class_exists(Elastic\Elasticsearch\Response\Elasticsearch::class) && $documents instanceof Elasticsearch) {`
`69`	`73`	`$document = $document->asArray();`
`70`	`74`	`}`
`71`	`75`
Original file line number	Diff line number	Diff line change
`@@ -40,8 +40,10 @@ public function process(ContainerBuilder $container): void`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`if (class_exists(\Elasticsearch\ClientBuilder::class)) {`
	`43`	`+ // ES v7`
`43`	`44`	`$builderName = \Elasticsearch\ClientBuilder::class;`
`44`	`45`	`} else {`
	`46`	`+ // ES v8 and up`
`45`	`47`	`$builderName = \Elastic\Elasticsearch\ClientBuilder::class;`
`46`	`48`	`}`
`47`	`49`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`
`16`	`16`	`use Behat\Behat\Context\Context;`
`17`	`17`	`use Elastic\Elasticsearch\Client;`
	`18`	`+use Elasticsearch\Client as V7Client;`
`18`	`19`	`use Symfony\Component\Finder\Finder;`
`19`	`20`
`20`	`21`	`/**`
`@@ -24,7 +25,7 @@`
`24`	`25`	`*/`
`25`	`26`	`final class ElasticsearchContext implements Context`
`26`	`27`	`{`
`27`		`- public function __construct(private readonly Client $client, private readonly string $elasticsearchMappingsPath, private readonly string $elasticsearchFixturesPath)`
	`28`	`+ public function __construct(private readonly V7Client\|Client $client, private readonly string $elasticsearchMappingsPath, private readonly string $elasticsearchFixturesPath)`
`28`	`29`	`{`
`29`	`30`	`}`
`30`	`31`