Fix bug in rule_query where text_expansion errored because it was not rewritten #105365
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| pr: 105365 | ||
| summary: Fix bug in `rule_query` where `text_expansion` errored because it was not | ||
| rewritten | ||
| area: Application | ||
| type: bug | ||
| issues: [] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -111,18 +111,6 @@ private RuleQueryBuilder( | |
| throw new IllegalArgumentException("rulesetId must not be null or empty"); | ||
| } | ||
|
|
||
|
There was a problem hiding this comment. @benwtrent had a great observation that these checks don't do anything because pinnedIds and docs are interstitial - moved these checks down into rewrite. There was a problem hiding this comment. They are so interstitial, they are never set in this constructor, as once we have them (or not) we return a different kind of query. Could we remove them from the ctor here? Its private, so not that big of a deal, but we always pass There was a problem hiding this comment. I was going to remove them, but then ran into the transport client changes, so figured I'd hold off for this PR... |
||
| this.organicQuery = organicQuery; | ||
| this.matchCriteria = matchCriteria; | ||
| this.rulesetId = rulesetId; | ||
|
|
@@ -174,6 +162,9 @@ protected void doXContent(XContentBuilder builder, Params params) throws IOExcep | |
|
|
||
| @Override | ||
| protected Query doToQuery(SearchExecutionContext context) throws IOException { | ||
| // NOTE: this is old query logic, as in 8.12.2+ and 8.13.0+ we will always rewrite this query | ||
| // into a pinned query or the organic query. This logic remains here for backwards compatibility | ||
| // with coordinator nodes running versions 8.10.0 - 8.12.1. | ||
kderusso marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if ((pinnedIds != null && pinnedIds.isEmpty() == false) && (pinnedDocs != null && pinnedDocs.isEmpty() == false)) { | ||
| throw new IllegalArgumentException("applied rules contain both pinned ids and pinned docs, only one of ids or docs is allowed"); | ||
kderusso marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
@@ -187,21 +178,25 @@ protected Query doToQuery(SearchExecutionContext context) throws IOException { | |
| } else { | ||
| return organicQuery.toQuery(context); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext) { | ||
| if (pinnedIdsSupplier != null && pinnedDocsSupplier != null) { | ||
| List<String> identifiedPinnedIds = pinnedIdsSupplier.get(); | ||
| List<Item> identifiedPinnedDocs = pinnedDocsSupplier.get(); | ||
| if (identifiedPinnedIds == null || identifiedPinnedDocs == null) { | ||
| return this; // Not executed yet | ||
kderusso marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } else if (identifiedPinnedIds.isEmpty() && identifiedPinnedDocs.isEmpty()) { | ||
| return organicQuery; // Nothing to pin here | ||
| } else if (identifiedPinnedIds.isEmpty() == false && identifiedPinnedDocs.isEmpty() == false) { | ||
| throw new IllegalArgumentException( | ||
| "applied rules contain both pinned ids and pinned docs, only one of ids or docs is allowed" | ||
| ); | ||
| } else if (identifiedPinnedIds.isEmpty() == false) { | ||
| return new PinnedQueryBuilder(organicQuery, truncateList(identifiedPinnedIds).toArray(new String[0])); | ||
| } else { | ||
| return new PinnedQueryBuilder(organicQuery, truncateList(identifiedPinnedDocs).toArray(new Item[0])); | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -244,18 +239,19 @@ public void onFailure(Exception e) { | |
| }); | ||
| }); | ||
|
|
||
| return new RuleQueryBuilder(organicQuery, matchCriteria, this.rulesetId, null, null, pinnedIdsSetOnce::get, pinnedDocsSetOnce::get) | ||
| .boost(this.boost) | ||
| .queryName(this.queryName); | ||
| } | ||
|
|
||
| private List<?> truncateList(List<?> input) { | ||
| // PinnedQueryBuilder will return an error if we attempt to return more than the maximum number of | ||
| // pinned hits. Here, we truncate matching rules rather than return an error. | ||
| if (input.size() > MAX_NUM_PINNED_HITS) { | ||
| HeaderWarning.addWarning("Truncating query rule pinned hits to " + MAX_NUM_PINNED_HITS + " documents"); | ||
| return input.subList(0, MAX_NUM_PINNED_HITS); | ||
| } | ||
| return input; | ||
| } | ||
|
|
||
| @Override | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My guess is that this needs to have a
skipversion for the version that this is fixed in. Generally, how to handle this, is to make it restrictive on main (e.g. 8.13 only) (this may be even trickier if 8.13 branch is already cut, if so, this skip should initially be 8.14, and after backports, adjust). and in the back port adjust it to8.12.2/3. Once the backport is merged, adjust main to8.12.2/3.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this - I'll make sure to do this