Changes related to MeiliSearch v0.21.0

[curquiza]

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

Ranaming of buildDate into commitDate

Related to meilisearch/transplant#138.

Will impact all the SDKs implementing the method for /version route.

New update status value

Related to meilisearch/transplant#107.

The new status for an update are:

• enqueued: the update is enqueued and will start to be processed soon
• processing: the update is processing.
• processed: the update is processed and it succeeded.
• failed: A failure occurred during when processing.

Will impact all the SDKs:

• About the update status is the status is declared as an enum
• The waitForPendingUpdate method

The waitForPendingUpdate must now check if the status of the update is different from enqueued or processing, not only enqueued.

New ranking rules

Related to meilisearch/transplant#85

Will impact some tests in some SDKs
Will also impact docs-scraper

Phrase search

Related to meilisearch/transplant#198

The SDK should test the phrase search, I mean the SDK can handle " in the q parameter, like:

{
  "q": "coco \"harry\""
}

⚠️ No need to check the relevancy, only the " can be handled.

Filterable attributes

Related to meilisearch/transplant#187

attributesForFaceting is renamed into filterableAttributes.

⚠️ This impacts SDKs but also back-end integrations in the READMEs/Wikis and even in the codebases.

⚠️ Some key in code-samples.yml will change! Don't forget to update the keys!

Filtering

Related to meilisearch/transplant#81 and meilisearch/transplant#140

⚠️ This impacts SDKs but also a lot instant-meilisearch!

• filters is renamed into filter
• facetFilters is removed
• filter can accept both syntaxes: array of string and string -> the tests should check both syntaxes are handled
• The users need to pass the attributes they want to filter on into filterableAttributes -> it might impact the instant-meilisearch README?
• You can now filter/facet on numbers -> it means new components are now compatible with instant-meilisearch!

New fields in dumps routes

Related to meilisearch/transplant#20

• 2 fields have been added when calling the GET /dumps/:uid/status route: startedAt and finishedAt
  ex:

curl -X GET 'http://localhost:7700/dumps/20210601-144339391/status'

{
    "uid": "20210601-144339391",
    "status": "done",
    "startedAt": "2021-06-01T14:43:39.392327Z",
    "finishedAt": "2021-06-01T14:43:43.793802Z"
}

• 1 new field has been added when calling the POST /dumps route: startedAt
  ex:

curl -X POST 'http://localhost:7700/dumps'

{
    "uid": "20210601-144339391",
    "status": "in_progress",
    "startedAt": "2021-06-01T14:43:39.392327Z"
}

Impacts SDKs and tests.

Rename fieldsDistribution into fieldDistribution

Related to: meilisearch/transplant#188

Rename fieldsDistribution into fieldDistribution.

Impacts SDKs and tests.

Stop-words and synonyms accept null

Related to meilisearch/transplant#217

The user can pass the null value when updating the settings (using POST). This resets the setting to its default value.

In MeilISearch v0.20 this behavior is possible for all the settings except the synonyms and the stop-words. The v0.21.0 should make all the settings consistent by allowing the null value when updating.

Impacts SDK tests -> we should add tests to check we can pass a null value when updating the synonyms and the stop-words. The tests for the other settings (when passing a null value`) are already done thanks to @alallema!

0 value are not present in facetsDistribution

Related to meilisearch/transplant#234

This might impact SDK tests.

exhaustiveFacetsCount always returns false

Related to meilisearch/transplant#236

This might impact SDK tests

TODO

SDKs:

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

Front-end:

• instant-meilisearch

Back-end:

• meilisearch-rails
• meilisearch-symfony

Misc:

• docs-scraper

🔥🔥🔥 Don't forget the code-samples and the READMEs 🔥🔥🔥

[bidoubiwa]

There are additionnal breaking changes that are due to either fixes or undefined behavior becoming defined:

• attributesToRetrieve does not apply on _formatted anymore v0.21 attributesToRetrieve does not apply on _formatted anymore meilisearch#1491
• Unexpected behavior when no valid inferable primary key is provided Unexpected behavior when no valid inferable primary key is provided meilisearch#1487

[bidoubiwa]

Some error codes have been added or removed and impact SDK's listing all error codes:

• invalid_facet removed
• missing_header removed
• search_error removed
• bad_parameter removed

Impacted SDK's:

• meilisearch-rust

[bidoubiwa]

The complete list of code-samples that must be updated are here.

@guimachiavelli

Code samples

Update .code-samples.meilisearch.yaml in Curl, Golang, JavaScript, PHP, Python, Ruby, Rust, and Swift repos

1. attributesForFaceting changed to filterableAttributes

• faceted_search_update_settings_1
• faceted_search_walkthrough_attributes_for_faceting_1 -> faceted_search_walkthrough_filterable_attributes_1
• get_attributes_for_faceting_1 -> get_filterable_attributes_1
• update_attributes_for_faceting_1 -> update_filterable_attributes_1
• reset_attributes_for_faceting_1 -> reset_filterable_attributes_1

2. filters changed to filter

• filtering_guide_1, filtering_guide_2, filtering_guide_3, filtering_guide_4
• search_parameter_guide_filter_1, search_parameter_guide_filter_2
• search_guide_2
• search_parameter_guide_matches_1--example changed

3. facetFilters changed to filter

• faceted_search_facet_filters_1 -> faceted_search_filter_1
• faceted_search_walkthrough_facet_filters_1 -> faceted_search_walkthrough_filter_1

4. wordsPosition removed and words switched with typo

• update_ranking_rules_1
• settings_guide_ranking_rules_1
• update_settings_1

[curquiza]

@bidoubiwa the JS SDK will be impacted by this breaking change you found out 😇
meilisearch/meilisearch#1489

[bidoubiwa]

Absolutely! The tests were commented out until a decision was taken. I will update them asap

[curquiza]

Done! Well done everyone! 😄