IBX-6413: Search Suggestion (Autocomplete for search)

[kisztof]

Question	Answer
Tickets	IBX-6413
Bug fix?	no
New feature?	yes
BC breaks?	no
Tests pass?	yes/no
Doc needed?	yes
License	GPL-2.0

Note

Related PR ibexa/admin-ui#959

Configuraton

  ibexa:
    system:
       default: # configuration per siteaccess or siteaccess group
           search:
               suggestion:
                   min_query_length: 3
                   result_limit: 5

Endpoint

Endpoint: /suggestion?query=ala&limit=10

###Endpoint structure

[
  {
    "contentId": 73,
    "contentTypeIdentifier": "article",
    "type": "content",
    "score": 50,
    "name": "Ala ma kota",
    "pathString": "2/74",
    "parentsLocation": [
      {
        "id": 52,
        "locationId": 2,
        "name": "Ibexa Digital Experience Platform"
      },
      {
        "id": 73,
        "locationId": 74,
        "name": "Ala ma kota"
      }
    ]
  },
  {
    "contentId": 74,
    "contentTypeIdentifier": "article",
    "type": "content",
    "score": 50,
    "name": "Ala ma psa",
    "pathString": "2/74/75",
    "parentsLocation": [
      {
        "id": 52,
        "locationId": 2,
        "name": "Ibexa Digital Experience Platform"
      },
      {
        "id": 73,
        "locationId": 74,
        "name": "Ala ma kota"
      },
      {
        "id": 74,
        "locationId": 75,
        "name": "Ala ma psa"
      }
    ]
  }
]

Implementing custom DataSource

\Ibexa\Contracts\Search\Event\SuggestionEvent

final class ContentSuggestionSubscriber implements EventSubscriberInterface
{
    public function __construct(CustomDataSource $customDataSource)
    {
        //...
    }
    public static function getSubscribedEvents(): array
    {
        return [
            SuggestionEvent::class => 'onSuggestion',
        ];
    }

    public function onSuggestion(SuggestionEvent $event): SuggestionEvent
    {
        $results = $this->customDataSource->find($event->getQuery);
        //...
        
        return $event;
    }
}

New suggestion model

The new suggestion model ought to inherit from \Ibexa\Contracts\Search\Model\Suggestion\Suggestion

final class CustomSuggestion extends Suggestion
{
}

Adding normalizers

Create your custom normalizer using implementation Symfony\Component\Serializer\Normalizer\NormalizerInterface

Annotate your custom normalizer using the tag ibexa.search.serializer.normalizer and it will be automatically used by the serializer.

    App\Normalizer\YourCustomNormalizer:
        tags:
              - { name: 'ibexa.search.serializer.normalizer' }

Checklist:

• Implement tests
• Coding standards ($ composer fix-cs)

[konradoboza]

Also, SonarCloud seems to report some valid code smells.

[Steveb-p]

I'd like to see an integration test for data serialization (encoding into JSON), because this is the crucial point and I think you might have a slight difference when there is 0, 1 and more items in the Location collection.

[Steveb-p]

Integration tests, since those are missing on the package, can be postponed.

[bogusez]

@kisztof as we discussed we have an error with the number of displayed autocomplete search results. The configuration that we define in ibexa.yaml doesn't respect the provided value. For example I set result_limit to 10 and autocomplete suggest me always 5 results even though, I have 6 contents in the system that meet the search conditions.

Edit:: I can approve the pull request and we can fix the issue right after beta3 release as you requested.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
3 Code Smells

No Coverage information
0.0% Duplication

[bogusez]

@kisztof as we discussed we have an error with the number of displayed autocomplete search results. The configuration that we define in ibexa.yaml doesn't respect the provided value. For example I set result_limit to 10 and autocomplete suggest me always 5 results even though, I have 6 contents in the system that meet the search conditions.

Edit:: I can approve the pull request and we can fix the issue right after beta3 release as you requested.

bd48916
fix solved the issue. thanks

[bogusez]

Regression tests passed:
ibexa/commerce#476
ibexa/experience#272
ibexa/headless#28