Changes related to Meilisearch v1.12.0

[curquiza]

This issue gathers the changes related to the v1.12.0 of Meilisearch that will impact the integrations scope.

📅 Release date: 2024-12-23

Timelines & steps

Pre-release

• With the help of the changelog & this CI, define which integrations should be updated and how (New feature? Update README? Update tests?)
  • Fill in the "What to implement?" section below in this issue 👇. Minial implementation: PHP, JS, Instant-meilisearch.
  • Open implementation issues in repositories that need implementation.
  • Discuss with the Product team if needed. At least share this issue to let them know about the decisions.
• Create a branch by running Octopus script: only open branches for the integrations we choose to update (defined in the previous step) + Kubernetes repository + Cloud provider repository (changing the version)
• Update integrations according to the decisions (cf "What to implement?" section below in this issue 👇)
  ⚠️ If possible, this step is done before pre-release, once the feature is ready thanks to the prototype released by the engine team
  • JS: opt-out setting, reverse, batch, indices
  • PHP: opt-out setting, reverse, batch, indices
  • Instant-meilisearch: fix tests
  • Ruby: fix tests
• Add code samples for the chosen up-to-date integrations with the new version of Meilisearch: v1.12: Code sample updates documentation#3065
• Update the library version of the related integrations and prepare the changelogs
  • JS
  • PHP

Release day

• Release the integrations or only merged the related PRs (sometimes a release is not needed)
  • JS
  • PHP
  • Instant-meilisearch: ⚠️ update meilisearch-js version ⚠️ before merging and releasing
  • Merge Ruby PR (but no need to release)
• Merge the related PR in K8s repository
• Publish DevOps tools:
  • create the git tag
  • publish images (steps are in CONTRIBUTING.md)
• Remove useless AWS images (by using our internal script)
• Open issues in the repositories that are not up-to-date with the latest version of Meilisearch (including code samples)

What to implement?

Opt-out settings

Related issue in the engine: meilisearch/meilisearch#4979

Add index settings to customize indexing of users: facetSearch, prefixSearch.

TODO:

• JS: [v1.12.0] New settings: facetSearch & prefixSearch meilisearch-js#1770
• PHP: [v1.12.0] New settings: facetSearch & prefixSearch meilisearch-php#694

Parameter to reverse the order of the task queue

Related issue in the engine: meilisearch/meilisearch#5047

Add a new parameter in GET /tasks route: reverse

TODO:

• JS: [v1.12.0] reverse parameter when querying tasks meilisearch-js#1769
• PHP: [v1.12.0] reverse parameter when querying tasks meilisearch-php#693

Give more visibility around batch when indexing

Related issue in the engine:

• Give visibility about batch details in tasks meilisearch#4977
• Implement the progress part of the batches meilisearch#5068

Changes:

• The task object gets updated with a new field: batchUid.
• New routes returning a batch object
  • GET /batches/:uid
  • GET /batches

TODO:

• JS: [v1.12.0] New batch routes meilisearch-js#1771
• PHP: [v1.12.0] New batch routes meilisearch-php#695
• Second run:
  • JS: [v1.12] Implement progress field in batch object meilisearch-js#1798
  • PHP: [v1.12] Implement progress field in batch object meilisearch-php#708

New field in _matchPosition

Related PR: meilisearch/meilisearch#5005

Add a new indices field in the _matchesPosition response.

TODO:

• JS: [v1.12.0] Add new indices in _matchesPosition meilisearch-js#1772
• PHP: Nothing to change 🎉

Highlight changes

Related to this PR: meilisearch/meilisearch#4928

The above PR led to changes in highlight behavior (checked internally with the engine team, these are expected). We need to adapt the tests of instant-meilisearch

TODO

• Instant-meilisearch: [v1.12.0] Adapt tests to new Meilisearch highlight behavior meilisearch-js-plugins#1340

AI changes

Related PR: meilisearch/meilisearch#4900

Some tests in some SDKs have to be updated because of breaking changes

• Ruby: [v1.12.0] Adapt tests following AI changes meilisearch-ruby#576