Merge pull request #2455 from meyerbaptiste/elasticsearch

Various fixes and improvements for Elasticsearch reading support

Author: dunglas

phpstan.neon

@@ -2,7 +2,7 @@ parameters:
     autoload_files:
         - tests/Fixtures/app/AppKernel.php
     excludes_analyse:
-        - tests/Fixtures/app/cache
+        - tests/Fixtures/app/var/cache
         # The Symfony Configuration API isn't good enough to be analysed
         - src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php
     ignoreErrors:

src/Bridge/Elasticsearch/DataProvider/CollectionDataProvider.php

@@ -14,7 +14,7 @@
 namespace ApiPlatform\Core\Bridge\Elasticsearch\DataProvider;
 
 use ApiPlatform\Core\Bridge\Elasticsearch\Api\IdentifierExtractorInterface;
-use ApiPlatform\Core\Bridge\Elasticsearch\DataProvider\Extension\FullBodySearchCollectionExtensionInterface;
+use ApiPlatform\Core\Bridge\Elasticsearch\DataProvider\Extension\RequestBodySearchCollectionExtensionInterface;
 use ApiPlatform\Core\Bridge\Elasticsearch\Exception\IndexNotFoundException;
 use ApiPlatform\Core\Bridge\Elasticsearch\Exception\NonUniqueIdentifierException;
 use ApiPlatform\Core\Bridge\Elasticsearch\Metadata\Document\Factory\DocumentMetadataFactoryInterface;
@@ -41,7 +41,7 @@ final class CollectionDataProvider implements ContextAwareCollectionDataProvider
     private $collectionExtensions;
 
     /**
-     * @param FullBodySearchCollectionExtensionInterface[] $collectionExtensions
+     * @param RequestBodySearchCollectionExtensionInterface[] $collectionExtensions
      */
     public function __construct(Client $client, DocumentMetadataFactoryInterface $documentMetadataFactory, IdentifierExtractorInterface $identifierExtractor, DenormalizerInterface $denormalizer, Pagination $pagination, iterable $collectionExtensions = [])
     {

src/Bridge/Elasticsearch/DataProvider/Extension/AbstractFilterExtension.php

@@ -23,7 +23,7 @@
  *
  * @author Baptiste Meyer <[email protected]>
  */
-abstract class AbstractFilterExtension implements FullBodySearchCollectionExtensionInterface
+abstract class AbstractFilterExtension implements RequestBodySearchCollectionExtensionInterface
 {
     private $resourceMetadataFactory;
     private $filterLocator;

src/Bridge/Elasticsearch/DataProvider/Extension/FullBodySearchCollectionExtensionInterface.php renamed to src/Bridge/Elasticsearch/DataProvider/Extension/RequestBodySearchCollectionExtensionInterface.php

@@ -14,16 +14,15 @@
 namespace ApiPlatform\Core\Bridge\Elasticsearch\DataProvider\Extension;
 
 /**
- * Interface of Elasticsearch full-body search extensions for collection queries.
+ * Interface of Elasticsearch request body search extensions for collection queries.
  *
- * @see https://www.elastic.co/guide/en/elasticsearch/guide/current/full-body-search.html
  * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html
  *
  * @experimental
  *
  * @author Baptiste Meyer <[email protected]>
  */
-interface FullBodySearchCollectionExtensionInterface
+interface RequestBodySearchCollectionExtensionInterface
 {
     public function applyToCollection(array $requestBody, string $resourceClass, ?string $operationName = null, array $context = []): array;
 }

src/Bridge/Elasticsearch/DataProvider/Extension/SortExtension.php

@@ -23,14 +23,13 @@
 /**
  * Applies selected sorting while querying resource collection.
  *
- * @see https://www.elastic.co/guide/en/elasticsearch/guide/current/_sorting.html
  * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-sort.html
  *
  * @experimental
  *
  * @author Baptiste Meyer <[email protected]>
  */
-final class SortExtension implements FullBodySearchCollectionExtensionInterface
+final class SortExtension implements RequestBodySearchCollectionExtensionInterface
 {
     use FieldDatatypeTrait;
 

src/Bridge/Elasticsearch/DataProvider/Extension/SortFilterExtension.php

@@ -18,7 +18,6 @@
 /**
  * Applies filters on the sort parameter while querying resource collection.
  *
- * @see https://www.elastic.co/guide/en/elasticsearch/guide/current/_sorting.html
  * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-sort.html
  *
  * @experimental

src/Bridge/Elasticsearch/DataProvider/Filter/OrderFilter.php

@@ -21,7 +21,6 @@
 /**
  * Order the collection by given properties.
  *
- * @see https://www.elastic.co/guide/en/elasticsearch/guide/current/_sorting.html
  * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-sort.html
  *
  * @experimental

src/Bridge/Elasticsearch/Metadata/Document/DocumentMetadata.php

@@ -16,7 +16,7 @@
 /**
  * Document metadata.
  *
- * @see https://www.elastic.co/guide/en/elasticsearch/guide/current/_document_metadata.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html
  *
  * @experimental
  *

src/Bridge/Symfony/Bundle/ApiPlatformBundle.php

@@ -15,6 +15,7 @@
 
 use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\AnnotationFilterPass;
 use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\DataProviderPass;
+use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\ElasticsearchClientPass;
 use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\FilterPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
@@ -36,5 +37,6 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new DataProviderPass());
         $container->addCompilerPass(new AnnotationFilterPass());
         $container->addCompilerPass(new FilterPass());
+        $container->addCompilerPass(new ElasticsearchClientPass());
     }
 }

src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -18,7 +18,7 @@
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\FilterEagerLoadingExtension;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryCollectionExtensionInterface as DoctrineQueryCollectionExtensionInterface;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryItemExtensionInterface;
-use ApiPlatform\Core\Bridge\Elasticsearch\DataProvider\Extension\FullBodySearchCollectionExtensionInterface as ElasticSearchQueryCollectionExtensionInterface;
+use ApiPlatform\Core\Bridge\Elasticsearch\DataProvider\Extension\RequestBodySearchCollectionExtensionInterface;
 use ApiPlatform\Core\DataPersister\DataPersisterInterface;
 use ApiPlatform\Core\DataProvider\CollectionDataProviderInterface;
 use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
@@ -570,10 +570,10 @@ private function registerElasticsearchConfiguration(ContainerBuilder $container,
 
         $loader->load('elasticsearch.xml');
 
-        $container->registerForAutoconfiguration(ElasticSearchQueryCollectionExtensionInterface::class)
-            ->addTag('api_platform.elasticsearch.query_extension.collection');
+        $container->registerForAutoconfiguration(RequestBodySearchCollectionExtensionInterface::class)
+            ->addTag('api_platform.elasticsearch.request_body_search_extension.collection');
 
-        $container->setParameter('api_platform.elasticsearch.host', $config['elasticsearch']['host']);
+        $container->setParameter('api_platform.elasticsearch.hosts', $config['elasticsearch']['hosts']);
         $container->setParameter('api_platform.elasticsearch.mapping', $config['elasticsearch']['mapping']);
     }
 }