src/Elasticsearch/Framework/DataAbstractionLayer/ElasticsearchEntitySearcher.php line 38

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Elasticsearch\Framework\DataAbstractionLayer;
  5. use OpenSearch\Client;
  6. use OpenSearchDSL\Aggregation\AbstractAggregation;
  7. use OpenSearchDSL\Aggregation\Bucketing\FilterAggregation;
  8. use OpenSearchDSL\Aggregation\Metric\CardinalityAggregation;
  9. use OpenSearchDSL\Search;
  10. use Shopware\Core\Framework\Context;
  11. use Shopware\Core\Framework\DataAbstractionLayer\EntityDefinition;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearcherInterface;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\MultiFilter;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\Grouping\FieldGrouping;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\IdSearchResult;
  17. use Shopware\Core\Framework\Log\Package;
  18. use Shopware\Elasticsearch\Framework\DataAbstractionLayer\Event\ElasticsearchEntitySearcherSearchEvent;
  19. use Shopware\Elasticsearch\Framework\ElasticsearchHelper;
  20. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  22. #[Package('core')]
  23. class ElasticsearchEntitySearcher implements EntitySearcherInterface
  24. {
  25.     final public const MAX_LIMIT = 10000;
  26.     final public const RESULT_STATE = 'loaded-by-elastic';
  28.     /**
  29.      * @internal
  30.      */
  31.     public function __construct(private readonly Client $client, private readonly EntitySearcherInterface $decorated, private readonly ElasticsearchHelper $helper, private readonly CriteriaParser $criteriaParser, private readonly AbstractElasticsearchSearchHydrator $hydrator, private readonly EventDispatcherInterface $eventDispatcher)
  32.     {
  33.     }
  35.     public function search(EntityDefinition $definition, Criteria $criteria, Context $context): IdSearchResult
  36.     {
  37.         if (!$this->helper->allowSearch($definition, $context, $criteria)) {
  38.             return $this->decorated->search($definition, $criteria, $context);
  39.         }
  41.         if ($criteria->getLimit() === 0) {
  42.             return new IdSearchResult(0, [], $criteria, $context);
  43.         }
  45.         $search = $this->createSearch($criteria, $definition, $context);
  47.         $this->eventDispatcher->dispatch(
  48.             new ElasticsearchEntitySearcherSearchEvent(
  49.                 $search,
  50.                 $definition,
  51.                 $criteria,
  52.                 $context
  53.             )
  54.         );
  56.         $search = $this->convertSearch($criteria, $definition, $context, $search);
  58.         try {
  59.             $result = $this->client->search([
  60.                 'index' => $this->helper->getIndexName($definition, $context->getLanguageId()),
  61.                 'track_total_hits' => true,
  62.                 'body' => $search,
  63.             ]);
  64.         } catch (\Throwable $e) {
  65.             $this->helper->logAndThrowException($e);
  67.             return $this->decorated->search($definition, $criteria, $context);
  68.         }
  70.         $result = $this->hydrator->hydrate($definition, $criteria, $context, $result);
  72.         $result->addState(self::RESULT_STATE);
  74.         return $result;
  75.     }
  77.     private function createSearch(Criteria $criteria, EntityDefinition $definition, Context $context): Search
  78.     {
  79.         $search = new Search();
  81.         $this->helper->handleIds($definition, $criteria, $search, $context);
  82.         $this->helper->addFilters($definition, $criteria, $search, $context);
  83.         $this->helper->addPostFilters($definition, $criteria, $search, $context);
  84.         $this->helper->addQueries($definition, $criteria, $search, $context);
  85.         $this->helper->addSortings($definition, $criteria, $search, $context);
  86.         $this->helper->addTerm($criteria, $search, $context, $definition);
  88.         $search->setSize(self::MAX_LIMIT);
  89.         $limit = $criteria->getLimit();
  90.         if ($limit !== null) {
  91.             $search->setSize($limit);
  92.         }
  93.         $search->setFrom((int) $criteria->getOffset());
  95.         return $search;
  96.     }
  98.     /**
  99.      * @return array<string, mixed>
  100.      */
  101.     private function convertSearch(Criteria $criteria, EntityDefinition $definition, Context $context, Search $search): array
  102.     {
  103.         if (!$criteria->getGroupFields()) {
  104.             return $search->toArray();
  105.         }
  107.         $aggregation = $this->buildTotalCountAggregation($criteria, $definition, $context);
  109.         $search->addAggregation($aggregation);
  111.         $array = $search->toArray();
  112.         $array['collapse'] = $this->parseGrouping($criteria->getGroupFields(), $definition, $context);
  114.         return $array;
  115.     }
  117.     /**
  118.      * @param FieldGrouping[] $groupings
  119.      *
  120.      * @return array{field: string, inner_hits?: array{name: string}}
  121.      */
  122.     private function parseGrouping(array $groupings, EntityDefinition $definition, Context $context): array
  123.     {
  124.         /** @var FieldGrouping $grouping */
  125.         $grouping = array_shift($groupings);
  127.         $accessor = $this->criteriaParser->buildAccessor($definition, $grouping->getField(), $context);
  128.         if (empty($groupings)) {
  129.             return ['field' => $accessor];
  130.         }
  132.         return [
  133.             'field' => $accessor,
  134.             'inner_hits' => [
  135.                 'name' => 'inner',
  136.                 'collapse' => $this->parseGrouping($groupings, $definition, $context),
  137.             ],
  138.         ];
  139.     }
  141.     private function buildTotalCountAggregation(Criteria $criteria, EntityDefinition $definition, Context $context): AbstractAggregation
  142.     {
  143.         $groupings = $criteria->getGroupFields();
  145.         if (\count($groupings) === 1) {
  146.             $first = array_shift($groupings);
  148.             $accessor = $this->criteriaParser->buildAccessor($definition, $first->getField(), $context);
  150.             $aggregation = new CardinalityAggregation('total-count');
  151.             $aggregation->setField($accessor);
  153.             return $this->addPostFilterAggregation($criteria, $definition, $context, $aggregation);
  154.         }
  156.         $fields = [];
  157.         foreach ($groupings as $grouping) {
  158.             $accessor = $this->criteriaParser->buildAccessor($definition, $grouping->getField(), $context);
  160.             $fields[] = sprintf(
  161.                 '
  162.                 if (doc[\'%s\'].size()==0) {
  163.                     value = value + \'empty\';
  164.                 } else {
  165.                     value = value + doc[\'%s\'].value;
  166.                 }',
  167.                 $accessor,
  168.                 $accessor
  169.             );
  170.         }
  172.         $script = '
  173.             def value = \'\';
  175.             ' . implode(' ', $fields) . '
  177.             return value;
  178.         ';
  180.         $aggregation = new CardinalityAggregation('total-count');
  181.         $aggregation->setScript($script);
  183.         return $this->addPostFilterAggregation($criteria, $definition, $context, $aggregation);
  184.     }
  186.     private function addPostFilterAggregation(Criteria $criteria, EntityDefinition $definition, Context $context, CardinalityAggregation $aggregation): AbstractAggregation
  187.     {
  188.         if (!$criteria->getPostFilters()) {
  189.             return $aggregation;
  190.         }
  192.         $query = $this->criteriaParser->parseFilter(
  193.             new MultiFilter(MultiFilter::CONNECTION_AND, $criteria->getPostFilters()),
  194.             $definition,
  195.             $definition->getEntityName(),
  196.             $context
  197.         );
  199.         $filterAgg = new FilterAggregation('total-filtered-count', $query);
  200.         $filterAgg->addAggregation($aggregation);
  202.         return $filterAgg;
  203.     }
  204. }