Meilisearch v1.50 revamps the Dynamic Search Rules, adds support for federated document fetch in sharded configurations, among other improvements
Breaking changes
This release introduces breaking changes for users using some experimental features
dynamicSearchRules experimental feature
Request type changes
priorityhas been replaced withprecedence, which better reflects the behavior (lower precedence means the rule is applied first)conditionshas been modified from an array to an object with two fields: "query" of typeQueryConditionand "time" of timeTimeCondition- New type
QueryConditionthat contains the fieldsisEmpty(as previously) andwordsinstead ofcontains(same type) - It is now possible to pass
isEmpty: falsewithwordsin aQueryCondition. PassingisEmpty:truewithwordsstill results in a synchronous error. - New type
TimeConditionwith fieldsstartandend(unchanged semantics from previous type). - When specifying the
selectorof anAction, it is now mandatory to specify anid. Previously, it was optional, but the action would never trigger. - When listing rules with
POST /dynamic-search-rules,filter.attributePatternshas been replaced withfilter.query, an optional string that searches in ruledescriptionandconditions.query.words. - When calling
DELETE /dynamic-search-rules/{:ruleUid}orPATCH /dynamic-search-rules/{:ruleUid}in a sharded configuration, endpoint will not return a HTTP 400 error if called on a follower remote rather than on the leader.
Response changes
PATCH /dynamic-search-rules/{:ruleUid}andDELETE /dynamic-search-rules/{:ruleUid}now register an asynchronous task..- The response is modified to return the registered task instead of the modified dynamic search rule.
- HTTP 404 is no longer returned if the
{:ruleUid}portion of the URL refers to a rule that doesn't exist. This is because rules are processed asynchronously, and is consistent with the behavior ofDELETE /indexes/{:indexUid}/documents/{:docId}for{:docId}
network experimental feature
The default behavior for users using the network experimental feature with sharding configured (leader not null) will change on the following routes:
- GET
indexes/:uid/documents - GET
indexes/:uid/documents/:document_id - POST
indexes/:uid/documents/fetch
Meilisearch will now fetch the documents from all the shards and not only on the local machine when processing the request.
To keep the same behavior as before, users will have to set useNetwork to false when making their request.
🌈 Improvements
Scaling up the Dynamic Search Rules
- Dynamic search rules scale up to 75K rules without any impact on the search
- The API of Dynamic Search Rules has been simplified
- It is harder to send conditions that will result in the rules never activating
- This also unlocks future improvements such as filter activation conditions for search rules
Additions
- Add a new
DELETE /dynamic-search-ruleroute that deletes all the DSRs - Add the concept of "DSR fuel" that determines how much energy is spent resolving DSR during a search. The fuel is initialized with some default variables that can be overridden using environment variables:
MEILI_EXPERIMENTAL_DSR_FUEL_MAX_COUNTED_WORDS: max number of words considered inside of a search query for the purpose of findingconditions.query.wordsconstraints. Defaults to 10, max value is 255MEILI_EXPERIMENTAL_DSR_FUEL_MAX_ACTIVE_RULES: max number of active rules whose actions are evaluated. Defaults to 1000, max value is 4294967295MEILI_EXPERIMENTAL_DSR_FUEL_MAX_PIN_ACTIONS: max number of pin actions that are applied. Defaults to 100, max value is 4294967295MEILI_EXPERIMENTAL_DSR_FUEL_WORD_FUEL: max number of constraint combinations that are evaluated for the purpose of findingconditions.query.wordsconstraints. Defaults to 4096, max value is 4294967295
By @dureuill in #6484 and #6506
Behavior changes
- The
conditions.query.wordsbehaves differently fromquery.contains: previously, a rule would match if its conditionsquery.containswould be substrings ofqin the search query in the sense ofstr::contains. Now, a rule matches if all the words inconditions.query.wordsappear inq(after normalization). Forq = hero super,query.contains = super herowould not match, whereasconditions.query.words = super herodoes now match. This behavior is more in line with regular search, and allows improving performance. - Dynamic search rules are now replicated from the leader to its follower, when in a sharded configuration
Federated document fetch routes
GET indexes/:uid/documents, GET indexes/:uid/documents/:document_id and POST indexes/:uid/documents/fetch will now fetch the documents from all the shards in the configured network.
Moreover, a new useNetwork parameter is available to activate or deactivate the usage of the network.
By @ManyTheFish in #6495
Support partial wildcards when requesting facets
The facets parameter in search and federated search now supports more wildcards. Previously, only the single wildcard "*" was supported, requesting all filterable fields.
Now, patterns containing * are supported with the same matching rules as in filterableAttributes.attributePatterns and localizedAttributes.attributePatterns, such as dogs.*, which will add to the facet distribution all filterable fields that match the pattern (such as dogs.intel, dogs.kefir, etc.).
By @Kerollmops in #6497
🦋 Fixes
Fix migration from v1.48 and earlier
Migration via --experimental-dumpless-upgrade would fail in some cases in v1.49, when trying to migrate synonyms that contained no words (empty synonyms, or containing only separator tokens such as &).
Such synonyms are now ignored during migration, avoiding the issue.
By @Kerollmops in #6501
Fix filter memory consumption in some cases
In some conditions, the memory consumption of filters would increase quadratically with the length of the filter. This is now resolved for these cases.
By @ManyTheFish in #6509
No longer reject some correctly-escaped filters
Fix a bug where some filters containing escaped characters (such as \) would cause search requests to fail with invalid_search_filter
More fault-tolerant S3 snapshots
Potentially fix an issue when sending a request to AWS S3 to create a new multipart upload, ensuring we resend the request if it fails.
By @Kerollmops in #6494
🔩 Miscellaneous changes
- Add missing route descriptions for documentation by @curquiza in #6500
- Make the prototype docs clearer by @curquiza in #6503
- Improve maintenability by simplifying partitioning step by @ManyTheFish in #6511
- Fix frequently failing tests on Windows by @dureuill in #6520
Full Changelog: v1.49.0...v1.50.0