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.

---------

Co-authored-by: adriendupuis <[email protected]>
Co-authored-by: Marek Nocoń <[email protected]>

Author: adriendupuis

.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

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 }

code_samples/search/elasticsearch/config/criterion_services.yaml renamed to code_samples/search/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 }

code_samples/search/solr/config/field_mapper_services.yaml renamed to code_samples/search/custom/config/field_mapper_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 }

code_samples/search/elasticsearch/config/group_resolver_services.yaml renamed to code_samples/search/custom/config/group_resolver_services.yaml

@@ -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',
+        ];
+    }
+}

code_samples/search/elasticsearch/config/packages/elasticsearch-en.yaml renamed to code_samples/search/custom/config/packages/elasticsearch-en.yaml

@@ -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',
+        ];
+    }
+}