Changes related to MeiliSearch v0.22.0

[curquiza]

This issue gathers the changes related to the v0.22.0 of MeiliSearch that will impact the integrations

Only 1 issue impacts the integration team for this iteration! 🎉

Sort during query time

The users are now able to sort the result during query time, see this issue: meilisearch/meilisearch#1581

⚠️ Please refer to the spec for more details: https://github.com/meilisearch/specifications/blob/develop/text/0055-sort.md

New settings: sortableAttributes

• Add the new settings sortableAttributes
• Add new methods to get, update and reset it
• Add tests

New search parameter: sort

• Add the new search parameter sort
• Add tests

New sort ranking rules

A new sort ranking rule is added, in the third position.
This can impact the tests.

New custom ranking rule syntax

Before:

"asc(title)"

Now:

"title:asc"

Can impact the tests

Code samples

• New code samples will be added, I'll let you know as soon as I synchronize with the docs team.
• Some code samples should be updated: about the new ranking rule and the custom ranking rule syntax

Impact

The SDKs are impacted

• meilisearch-dart
• meilisearch-dotnet
• meilisearch-go
• meilisearch-java
• meilisearch-js
• meilisearch-php
• meilisearch-python
• meilisearch-ruby
• meilisearch-rust
• meilisearch-swift

Also

• instant-meilisearch: new feature could be now available thanks to the sort introduction, @bidoubiwa can you confirm?

[bidoubiwa]

Compatible Widget

Sortby Widget

• Sort by

Ui of the widget:

Usage of the widget:

<SortBy
  defaultRefinement="instant_search"
  items={[
    { value: 'instant_search', label: 'Featured' },
    { value: 'instant_search_price_asc', label: 'Price asc.' },
    { value: 'instant_search_price_desc', label: 'Price desc.' },
  ]}
/>

• items is the list of indices to search in, with each item:
  • label: string: the label of the index to display.
  • value: string: the name of the index to target.
• defaultRefinement: The index selected by default.

The way it works in instantSearch and algoliaClient is that for every item, you provide a label that is shown in the drop down menu and, a value that represents the index containing the ranking rule relevant to its purpose.

As it is technically possible in MeiliSearch to do the same, we should choose if we want to go this route or if we prefer using the sortBy at query time.

1. Algolia's way

Suggest to the user to create multiple indexes with different ranking rules adding asc(..) or desc() and use it the same way Algolia does.

2. Query time way

    { value: 'instant_search', label: 'Featured' },
    { value: 'instant_search_price_asc', label: 'Price asc.' },
    { value: 'instant_search_price_desc', label: 'Price desc.' },

we ask to the user to syntax the value field the following way value="release_date:asc" and instead of switching index we use the value as the sort search parameter in instant-meilisearch.

and for the defaultRefinement the user should add the sort instead of the index name:
defaultRefinement="age:asc"

    { value: '', label: 'Featured' },
    { value: 'price:asc', label: 'Price asc.' },
    { value: 'price:desc', label: 'Price desc.' },

Due to instantSearch overriding the indexName when using sortby the following syntax is now used

{
  value: 'steam-video-games:recommendationCount:asc',
  label: 'Least Recommended',
},

Not compatible Widgets

RelevanSort Widget

Relevant sort is a premium feature that Algolia offers which let the user activate or desactive a relevancyStrictness setting.

By default the sort is applied after the hits are found via their relevancy rules, by switching mode using the relevanctSort widget, the relevancyStrictness is applied which will make the sorting more or less important (ie: change the position of sort in the ranking rules`).

As we do not propse toggling between modes in MeiliSearch this widget is not compatible.

the following widgets are still not compatible with sortBy as they are sortBy on the facets values (ex: adventure, comedy, ..):

• refinementlist
• menuSelect
• Menu

[curquiza]

Thanks @bidoubiwa!!

About code samples, here are the new ones:

sorting_guide_update_sortable_attributes_1: |-
sorting_guide_update_ranking_rules_1: |-
sorting_guide_sort_parameter_1: |-
sorting_guide_sort_parameter_2: |-
get_sortable_attributes_1
update_sortable_attributes_1
reset_sortable_attributes_1
search_parameter_guide_sort_1: |-

Please refer to the Gui's PR: https://github.com/meilisearch/documentation/pull/1087/files

Edit: the list has been updated with the new titles

[curquiza]

The whole work has been done! 🎉