Enhance search customization (#2591)

* Merge ElasticSearch and Solr custom criterion, sort clause and aggregation. Criteria, sort clauses and aggregations don't depend on the search engine, only their visitors and other handlers do. (cherry picked from commit c765208) --------- Co-authored-by: adriendupuis <[email protected]> Co-authored-by: Marek Nocoń <[email protected]>
ibexa · Feb 11, 2025 · e06b15a · e06b15a
1 parent 49d1f0d
commit e06b15a
Show file tree

Hide file tree

Showing 39 changed files with 337 additions and 352 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -182,10 +182,19 @@ jobs:
             -   name: Convert code_samples usages for comment
                 if: steps.list.outputs.CODE_SAMPLES_CHANGE != '' && steps.diff.outputs.CODE_SAMPLES_DIFF != '0'
                 run: |
-                    echo '# code_samples/ change report' >> code_samples_usage.diff.md
+                    title='# code_samples/ change report'
+                    link='<a href="${{ steps.artifact.outputs.artifact-url }}">Download colorized diff</a>'
+                    echo "$title" > code_samples_usage.diff.md
                     echo '' >> code_samples_usage.diff.md
                     php tools/code_samples/code_samples_usage_diff2html.php $HOME/code_samples_usage.diff >> code_samples_usage.diff.md
-                    echo '<a href="${{ steps.artifact.outputs.artifact-url }}">Download colorized diff</a>' >> code_samples_usage.diff.md
+                    echo "$link" >> code_samples_usage.diff.md
+                    if [[ `wc -m < code_samples_usage.diff.md | xargs` -ge $((2**16)) ]]; then
+                        echo "$title" > code_samples_usage.diff.md
+                        echo '' >> code_samples_usage.diff.md
+                        echo "Report's diff is too long to be displayed in a comment." >> code_samples_usage.diff.md
+                        echo '' >> code_samples_usage.diff.md
+                        echo "$link" >> code_samples_usage.diff.md
+                    fi
             -   name: Find Comment
                 id: find-comment
                 uses: peter-evans/find-comment@v3

diff --git a/code_samples/search/custom/config/aggregation_services.yaml b/code_samples/search/custom/config/aggregation_services.yaml
@@ -0,0 +1,49 @@
+services:
+    app.search.solr.query.aggregation_visitor.priority_range_aggregation:
+        class: Ibexa\Solr\Query\Common\AggregationVisitor\RangeAggregationVisitor
+        factory: [ '@Ibexa\Solr\Query\Common\AggregationVisitor\Factory\SearchFieldAggregationVisitorFactory', 'createRangeAggregationVisitor' ]
+        arguments:
+            $aggregationClass: 'App\Query\Aggregation\Solr\PriorityRangeAggregation'
+            $searchIndexFieldName: 'priority_i'
+        tags:
+            - { name: ibexa.search.solr.query.location.aggregation.visitor }
+
+    app.search.elasticsearch.query.aggregation_visitor.priority_range_aggregation:
+        class: Ibexa\Elasticsearch\Query\AggregationVisitor\RangeAggregationVisitor
+        factory: [ '@Ibexa\Elasticsearch\Query\AggregationVisitor\Factory\SearchFieldAggregationVisitorFactory', 'createRangeAggregationVisitor' ]
+        arguments:
+            $aggregationClass: 'App\Query\Aggregation\Elasticsearch\PriorityRangeAggregation'
+            $searchIndexFieldName: 'priority_i'
+        tags:
+            - { name: ibexa.search.elasticsearch.query.location.aggregation.visitor }
+
+    app.search.solr.query.aggregation_result_extractor.priority_range_aggregation:
+        class: Ibexa\Solr\ResultExtractor\AggregationResultExtractor\RangeAggregationResultExtractor
+        arguments:
+            $aggregationClass: 'App\Query\Aggregation\Solr\PriorityRangeAggregation'
+            $keyMapper: 'Ibexa\Solr\ResultExtractor\AggregationResultExtractor\RangeAggregationKeyMapper\IntRangeAggregationKeyMapper'
+        tags:
+            - { name: ibexa.search.solr.query.location.aggregation.result.extractor }
+
+    app.search.elasticsearch.query.aggregation_result_extractor.priority_range_aggregation:
+        class: Ibexa\Elasticsearch\Query\ResultExtractor\AggregationResultExtractor\RangeAggregationResultExtractor
+        arguments:
+            $aggregationClass: 'App\Query\Aggregation\Elasticsearch\PriorityRangeAggregation'
+        tags:
+            - { name: ibexa.search.elasticsearch.query.location.aggregation.result.extractor }
+
+    App\Query\Aggregation\Solr\PriorityRangeAggregationVisitor:
+        tags:
+            - { name: ibexa.search.solr.query.location.aggregation.visitor }
+
+    App\Query\Aggregation\Solr\PriorityRangeAggregationResultExtractor:
+        tags:
+            - { name: ibexa.search.solr.query.location.aggregation.result.extractor }
+
+    App\Query\Aggregation\Elasticsearch\PriorityRangeAggregationVisitor:
+        tags:
+            - { name: ibexa.search.elasticsearch.query.location.aggregation.visitor }
+
+    App\Query\Aggregation\Elasticsearch\PriorityRangeAggregationResultExtractor:
+        tags:
+            - { name: ibexa.search.elasticsearch.query.location.aggregation.result.extractor }
diff --git a/...sticsearch/config/criterion_services.yaml → ...rch/custom/config/criterion_services.yaml b/...sticsearch/config/criterion_services.yaml → ...rch/custom/config/criterion_services.yaml
@@ -1,4 +1,9 @@
 services:
+    App\Query\Criterion\Solr\CameraManufacturerVisitor:
+        tags:
+            - { name: ibexa.search.solr.query.content.criterion.visitor }
+            - { name: ibexa.search.solr.query.location.criterion.visitor }
+
     App\Query\Criterion\Elasticsearch\CameraManufacturerVisitor:
         tags:
             - { name: ibexa.search.elasticsearch.query.content.criterion.visitor }

diff --git a/...ch/solr/config/field_mapper_services.yaml → .../custom/config/field_mapper_services.yaml b/...ch/solr/config/field_mapper_services.yaml → .../custom/config/field_mapper_services.yaml
diff --git a/...earch/config/group_resolver_services.yaml → ...ustom/config/group_resolver_services.yaml b/...earch/config/group_resolver_services.yaml → ...ustom/config/group_resolver_services.yaml
diff --git a/...rch/config/packages/elasticsearch-en.yaml → ...tom/config/packages/elasticsearch-en.yaml b/...rch/config/packages/elasticsearch-en.yaml → ...tom/config/packages/elasticsearch-en.yaml
diff --git a/...search/config/packages/elasticsearch.yaml → ...custom/config/packages/elasticsearch.yaml b/...search/config/packages/elasticsearch.yaml → ...custom/config/packages/elasticsearch.yaml
diff --git a/...icsearch/config/sort_clause_services.yaml → ...h/custom/config/sort_clause_services.yaml b/...icsearch/config/sort_clause_services.yaml → ...h/custom/config/sort_clause_services.yaml
@@ -1,4 +1,9 @@
 services:
+    App\Query\SortClause\Solr\ScoreVisitor:
+        tags:
+            - { name: ibexa.search.solr.query.content.sort_clause.visitor }
+            - { name: ibexa.search.solr.query.location.sort_clause.visitor }
+
     App\Query\SortClause\Elasticsearch\ScoreVisitor:
         tags:
             - { name: ibexa.search.elasticsearch.query.content.sort_clause.visitor }

diff --git a/code_samples/search/custom/src/EventSubscriber/CustomIndexDataSubscriber.php b/code_samples/search/custom/src/EventSubscriber/CustomIndexDataSubscriber.php
@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\EventSubscriber;
+
+use Ibexa\Contracts\Core\Search\Field;
+use Ibexa\Contracts\Core\Search\FieldType\StringField;
+use Ibexa\Contracts\Elasticsearch\Mapping\Event\ContentIndexCreateEvent;
+use Ibexa\Contracts\Elasticsearch\Mapping\Event\LocationIndexCreateEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+final class CustomIndexDataSubscriber implements EventSubscriberInterface
+{
+    public function onContentDocumentCreate(ContentIndexCreateEvent $event): void
+    {
+        $document = $event->getDocument();
+        $document->fields[] = new Field(
+            'custom_field',
+            'Custom field value',
+            new StringField()
+        );
+    }
+
+    public function onLocationDocumentCreate(LocationIndexCreateEvent $event): void
+    {
+        $document = $event->getDocument();
+        $document->fields[] = new Field(
+            'custom_field',
+            'Custom field value',
+            new StringField()
+        );
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            ContentIndexCreateEvent::class => 'onContentDocumentCreate',
+            LocationIndexCreateEvent::class => 'onLocationDocumentCreate',
+        ];
+    }
+}
diff --git a/code_samples/search/custom/src/EventSubscriber/CustomQueryFilterSubscriber.php b/code_samples/search/custom/src/EventSubscriber/CustomQueryFilterSubscriber.php
@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\EventSubscriber;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\LogicalAnd;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\ObjectStateIdentifier;
+use Ibexa\Contracts\ElasticSearch\Query\Event\QueryFilterEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+final class CustomQueryFilterSubscriber implements EventSubscriberInterface
+{
+    public function onQueryFilter(QueryFilterEvent $event): void
+    {
+        $query = $event->getQuery();
+
+        $additionalCriteria = new ObjectStateIdentifier('locked');
+
+        if ($query->filter !== null) {
+            $query->filter = $additionalCriteria;
+        } else {
+            // Append Criterion to existing filter
+            $query->filter = new LogicalAnd([
+                $query->filter,
+                $additionalCriteria,
+            ]);
+        }
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            QueryFilterEvent::class => 'onQueryFilter',
+        ];
+    }
+}
diff --git a/...esolver/ContentTypeGroupGroupResolver.php → ...esolver/ContentTypeGroupGroupResolver.php b/...esolver/ContentTypeGroupGroupResolver.php → ...esolver/ContentTypeGroupGroupResolver.php
diff --git a/...ch/PriorityAggregationResultExtractor.php → ...iorityRangeAggregationResultExtractor.php b/...ch/PriorityAggregationResultExtractor.php → ...iorityRangeAggregationResultExtractor.php
@@ -4,12 +4,13 @@
 
 namespace App\Query\Aggregation\Elasticsearch;
 
+use App\Query\Aggregation\PriorityRangeAggregation;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;
 use Ibexa\Contracts\Core\Repository\Values\Content\Search\AggregationResult;
 use Ibexa\Contracts\Elasticsearch\Query\AggregationResultExtractor;
 use Ibexa\Contracts\Elasticsearch\Query\LanguageFilter;
 
-final class PriorityAggregationResultExtractor implements AggregationResultExtractor
+final class PriorityRangeAggregationResultExtractor implements AggregationResultExtractor
 {
     public function supports(Aggregation $aggregation, LanguageFilter $languageFilter): bool
     {

diff --git a/...sticsearch/PriorityAggregationVisitor.php → ...earch/PriorityRangeAggregationVisitor.php b/...sticsearch/PriorityAggregationVisitor.php → ...earch/PriorityRangeAggregationVisitor.php
@@ -4,19 +4,20 @@
 
 namespace App\Query\Aggregation\Elasticsearch;
 
+use App\Query\Aggregation\PriorityRangeAggregation;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;
 use Ibexa\Contracts\Elasticsearch\Query\AggregationVisitor;
 use Ibexa\Contracts\Elasticsearch\Query\LanguageFilter;
 
-final class PriorityAggregationVisitor implements AggregationVisitor
+final class PriorityRangeAggregationVisitor implements AggregationVisitor
 {
     public function supports(Aggregation $aggregation, LanguageFilter $languageFilter): bool
     {
         return $aggregation instanceof PriorityRangeAggregation;
     }
 
     /**
-     * @param PriorityRangeAggregation $aggregation
+     * @param \App\Query\Aggregation\PriorityRangeAggregation $aggregation
      */
     public function visit(AggregationVisitor $dispatcher, Aggregation $aggregation, LanguageFilter $languageFilter): array
     {

diff --git a/...egation/Solr/PriorityRangeAggregation.php → .../Aggregation/PriorityRangeAggregation.php b/...egation/Solr/PriorityRangeAggregation.php → .../Aggregation/PriorityRangeAggregation.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace App\Query\Aggregation\Solr;
+namespace App\Query\Aggregation;
 
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\AbstractRangeAggregation;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\LocationAggregation;

diff --git a/...lr/PriorityAggregationResultExtractor.php → ...iorityRangeAggregationResultExtractor.php b/...lr/PriorityAggregationResultExtractor.php → ...iorityRangeAggregationResultExtractor.php
@@ -4,6 +4,7 @@
 
 namespace App\Query\Aggregation\Solr;
 
+use App\Query\Aggregation\PriorityRangeAggregation;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Range;
 use Ibexa\Contracts\Core\Repository\Values\Content\Search\AggregationResult;
@@ -12,7 +13,7 @@
 use Ibexa\Contracts\Solr\ResultExtractor\AggregationResultExtractor;
 use stdClass;
 
-final class PriorityAggregationResultExtractor implements AggregationResultExtractor
+final class PriorityRangeAggregationResultExtractor implements AggregationResultExtractor
 {
     public function canVisit(Aggregation $aggregation, array $languageFilter): bool
     {

diff --git a/.../Solr/PriorityRangeAggregationVisitor.php → .../Solr/PriorityRangeAggregationVisitor.php b/.../Solr/PriorityRangeAggregationVisitor.php → .../Solr/PriorityRangeAggregationVisitor.php
@@ -4,6 +4,7 @@
 
 namespace App\Query\Aggregation\Solr;
 
+use App\Query\Aggregation\PriorityRangeAggregation;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;
 use Ibexa\Contracts\Solr\Query\AggregationVisitor;
 

diff --git a/...rion/Solr/CameraManufacturerCriterion.php → ...Criterion/CameraManufacturerCriterion.php b/...rion/Solr/CameraManufacturerCriterion.php → ...Criterion/CameraManufacturerCriterion.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace App\Query\Criterion\Solr;
+namespace App\Query\Criterion;
 
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator;

diff --git a/...asticsearch/CameraManufacturerVisitor.php → ...asticsearch/CameraManufacturerVisitor.php b/...asticsearch/CameraManufacturerVisitor.php → ...asticsearch/CameraManufacturerVisitor.php
@@ -4,6 +4,7 @@
 
 namespace App\Query\Criterion\Elasticsearch;
 
+use App\Query\Criterion\CameraManufacturerCriterion;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
 use Ibexa\Contracts\Elasticsearch\Query\CriterionVisitor;
 use Ibexa\Contracts\Elasticsearch\Query\LanguageFilter;
@@ -15,6 +16,9 @@ public function supports(Criterion $criterion, LanguageFilter $languageFilter):
         return $criterion instanceof CameraManufacturerCriterion;
     }
 
+    /**
+     * @param \App\Query\Criterion\Elasticsearch\CameraManufacturerCriterion $criterion
+     */
     public function visit(CriterionVisitor $dispatcher, Criterion $criterion, LanguageFilter $languageFilter): array
     {
         return [

diff --git a/...terion/Solr/CameraManufacturerVisitor.php → ...terion/Solr/CameraManufacturerVisitor.php b/...terion/Solr/CameraManufacturerVisitor.php → ...terion/Solr/CameraManufacturerVisitor.php
@@ -4,6 +4,7 @@
 
 namespace App\Query\Criterion\Solr;
 
+use App\Query\Criterion\CameraManufacturerCriterion;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
 use Ibexa\Contracts\Solr\Query\CriterionVisitor;
 
@@ -14,6 +15,9 @@ public function canVisit(Criterion $criterion)
         return $criterion instanceof CameraManufacturerCriterion;
     }
 
+    /**
+     * @param \App\Query\Criterion\Solr\CameraManufacturerCriterion $criterion
+     */
     public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
     {
         $expressions = array_map(

diff --git a/...SortClause/Elasticsearch/ScoreVisitor.php → ...SortClause/Elasticsearch/ScoreVisitor.php b/...SortClause/Elasticsearch/ScoreVisitor.php → ...SortClause/Elasticsearch/ScoreVisitor.php
@@ -4,6 +4,7 @@
 
 namespace App\Query\SortClause\Elasticsearch;
 
+use App\Query\SortClause\ScoreSortClause;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause;
 use Ibexa\Contracts\Elasticsearch\Query\LanguageFilter;

diff --git a/...Query/SortClause/Solr/ScoreSortClause.php → .../src/Query/SortClause/ScoreSortClause.php b/...Query/SortClause/Solr/ScoreSortClause.php → .../src/Query/SortClause/ScoreSortClause.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace App\Query\SortClause\Solr;
+namespace App\Query\SortClause;
 
 use Ibexa\Contracts\Core\Repository\Values\Content\Query;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause;

diff --git a/...rc/Query/SortClause/Solr/ScoreVisitor.php → ...rc/Query/SortClause/Solr/ScoreVisitor.php b/...rc/Query/SortClause/Solr/ScoreVisitor.php → ...rc/Query/SortClause/Solr/ScoreVisitor.php
@@ -4,14 +4,15 @@
 
 namespace App\Query\SortClause\Solr;
 
+use App\Query\SortClause\ScoreSortClause;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause;
 use Ibexa\Contracts\Solr\Query\SortClauseVisitor;
 
 class ScoreVisitor extends SortClauseVisitor
 {
     public function canVisit(SortClause $sortClause): bool
     {
-        return $sortClause instanceof SortClause\Score;
+        return $sortClause instanceof ScoreSortClause;
     }
 
     public function visit(SortClause $sortClause): string

diff --git a/.../WebinarEventTitleFulltextFieldMapper.php → .../WebinarEventTitleFulltextFieldMapper.php b/.../WebinarEventTitleFulltextFieldMapper.php → .../WebinarEventTitleFulltextFieldMapper.php
diff --git a/code_samples/search/elasticsearch/config/aggregation_services.yaml b/code_samples/search/elasticsearch/config/aggregation_services.yaml
diff --git a/...les/search/elasticsearch/src/Query/Aggregation/Elasticsearch/PriorityRangeAggregation.php b/...les/search/elasticsearch/src/Query/Aggregation/Elasticsearch/PriorityRangeAggregation.php
diff --git a/...es/search/elasticsearch/src/Query/Criterion/Elasticsearch/CameraManufacturerCriterion.php b/...es/search/elasticsearch/src/Query/Criterion/Elasticsearch/CameraManufacturerCriterion.php