ES|QL: Validate TOP_SNIPPETS query argument is foldable by mridula-s109 · Pull Request #142763 · elastic/elasticsearch

mridula-s109 · 2026-02-20T14:37:47Z

Implements compile-time validation for the TOP_SNIPPETS function to ensure that its query parameter is foldable (constant). This follows the same pattern as other full-text functions like Kql/FullTextFunction.

Changes:

TopSnippets.java: Added foldable query validation in resolveType() using Foldables.resolveTypeQuery(), following the Kql/FullTextFunction pattern
TopSnippetsTests.java: Updated assertion style per code review feedback
VerifierTests.java: Added analyzer-level verification tests for query foldability
top-snippets.csv-spec: Added integration tests for foldable query validation
230_folding.yml: Added YAML REST integration tests for folding
docs/changelog/142462.yaml: Added changelog entry

Fixes #142462

…on time Implements compile-time validation for the TOP_SNIPPETS function to ensure that its query parameter is foldable (constant). This follows the same pattern as other full-text functions like Match. Changes: - TopSnippets.java: Implements PostOptimizationVerificationAware interface and adds postOptimizationVerification() method using Foldables.resolveTypeQuery() - TopSnippetsValidationTests.java: New unit tests for validation logic - TopSnippetsTests.java: Updated assertion style per code review feedback - LogicalPlanOptimizerTests.java: Added post-optimization validation tests - top-snippets.csv-spec: Added integration tests for foldable query validation - docs/changelog/142462.yaml: Added changelog entry Fixes elastic#142462

elasticsearchmachine · 2026-02-20T14:38:19Z

Hi @mridula-s109, I've created a changelog YAML for you.

# Conflicts: # x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/TopSnippetsValidationTests.java

elasticsearchmachine · 2026-02-23T19:01:43Z

Pinging @elastic/es-search-relevance (Team:Search Relevance)

elasticsearchmachine · 2026-02-23T19:01:44Z

Hi @mridula-s109, I've updated the changelog YAML for you.

carlosdelest

LGTM 👍

Some minor questions about tests

x-pack/plugin/esql/qa/testFixtures/src/main/resources/top-snippets.csv-spec

...rc/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/TopSnippets.java

carlosdelest · 2026-02-24T07:30:09Z

x-pack/plugin/src/yamlRestTest/resources/rest-api-spec/test/esql/230_folding.yml

  - match: { values.0.2: "Alice Smith" }
+
+---
+TOP_SNIPPETS with foldable query:


Don't we need a capability for mixed clusters? Will this work when issued against an older cluster? 🤔

x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/analysis/VerifierTests.java

mridula-s109 · 2026-02-24T12:56:00Z

Thanks for the comments @carlosdelest and @ioanatia, i am looking into them, will rerequest review post addressing them.

# Conflicts: # x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/TopSnippetsTests.java

…efore checking for Literals

ioanatia · 2026-03-12T09:36:54Z

...gin/esql/src/test/java/org/elasticsearch/xpack/esql/optimizer/LogicalPlanOptimizerTests.java

        as(registeredDomain.child(), EsRelation.class);
    }
+
+    public void testTopSnippetsQueryMustBeFoldable() {


I initially suggested to @mridula-s109 to add a similar test in VerifierTests, because we already had some tests that were checking for constant arguments.
If the validation is actually done post-optimization, it makes sense to have the test here.

* ES|QL: Validate TOP_SNIPPETS query argument is foldable at verification time Implements compile-time validation for the TOP_SNIPPETS function to ensure that its query parameter is foldable (constant). This follows the same pattern as other full-text functions like Match. Changes: - TopSnippets.java: Implements PostOptimizationVerificationAware interface and adds postOptimizationVerification() method using Foldables.resolveTypeQuery() - TopSnippetsValidationTests.java: New unit tests for validation logic - TopSnippetsTests.java: Updated assertion style per code review feedback - LogicalPlanOptimizerTests.java: Added post-optimization validation tests - top-snippets.csv-spec: Added integration tests for foldable query validation - docs/changelog/142462.yaml: Added changelog entry Fixes elastic#142462 * Update docs/changelog/142763.yaml * [CI] Auto commit changes from spotless * [CI] Auto commit changes from spotless * Update 142763.yaml * Delete docs/changelog/142462.yaml * Removed validation test # Conflicts: # x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/TopSnippetsValidationTests.java * Removed the constantQuery Test * Moved validation to verification level * tests added * modified the test cases * Update TopSnippets.java * [CI] Auto commit changes from spotless * fixed bug * [CI] Auto commit changes from spotless * Update docs/changelog/142763.yaml * Add foldable validation to TOP_SNIPPETS query parameter * [CI] Auto commit changes from spotless * Fix YAML tests * Fix tests * Remove protected access * Use postOptimizationVerification to let optimizer to fold constants before checking for Literals * Move test to optimization tests as folding check happens there --------- Co-authored-by: elasticsearchmachine <infra-root+elasticsearchmachine@elastic.co> Co-authored-by: carlosdelest <carlos.delgado@elastic.co> Co-authored-by: Carlos Delgado <6339205+carlosdelest@users.noreply.github.com>

mridula-s109 requested a review from ioanatia February 20, 2026 14:37

mridula-s109 self-assigned this Feb 20, 2026

mridula-s109 added >enhancement Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch :Search Relevance/ES|QL Search functionality in ES|QL v9.4.0 labels Feb 20, 2026

Update docs/changelog/142763.yaml

8b44639

mridula-s109 changed the title ~~ES|QL: Validate TOP_SNIPPETS query argument is foldable at verification~~ ES|QL: Validate TOP_SNIPPETS query argument is foldable Feb 20, 2026

elasticsearchmachine and others added 16 commits February 20, 2026 14:46

[CI] Auto commit changes from spotless

84c48a3

Merge branch 'main' into topsnippet/foldable

06009b7

[CI] Auto commit changes from spotless

810bb14

Update 142763.yaml

3cf533f

Delete docs/changelog/142462.yaml

da9e449

Removed validation test

472f982

# Conflicts: # x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/TopSnippetsValidationTests.java

Removed the constantQuery Test

b56254e

Moved validation to verification level

74b3044

tests added

a8767f4

modified the test cases

f381874

Update TopSnippets.java

9aae38f

Merge branch 'main' into topsnippet/foldable

00a317b

[CI] Auto commit changes from spotless

05c775f

fixed bug

0ad2083

Merge branch 'main' into topsnippet/foldable

e746564

[CI] Auto commit changes from spotless

a716cb4

mridula-s109 marked this pull request as ready for review February 23, 2026 19:01

mridula-s109 requested a review from carlosdelest February 23, 2026 19:01

Update docs/changelog/142763.yaml

7e51579

carlosdelest approved these changes Feb 24, 2026

View reviewed changes

ioanatia approved these changes Feb 24, 2026

View reviewed changes

x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/analysis/VerifierTests.java Outdated Show resolved Hide resolved

mridula-s109 and others added 3 commits March 3, 2026 14:21

Add foldable validation to TOP_SNIPPETS query parameter

7f5f2a2

Merge branch 'main' into topsnippet/foldable

ef48273

[CI] Auto commit changes from spotless

f7f0179

carlosdelest self-assigned this Mar 10, 2026

carlosdelest and others added 7 commits March 11, 2026 18:14

Merge remote-tracking branch 'origin/main' into topsnippet/foldable

058bd8c

# Conflicts: # x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/TopSnippetsTests.java

Fix YAML tests

4413d0c

Fix tests

ff2a08c

Remove protected access

381895c

Use postOptimizationVerification to let optimizer to fold constants b…

67012ad

…efore checking for Literals

Move test to optimization tests as folding check happens there

ee39555

Merge branch 'main' into topsnippet/foldable

8d868b2

carlosdelest requested a review from ioanatia March 12, 2026 09:21

ioanatia approved these changes Mar 12, 2026

View reviewed changes

carlosdelest merged commit 47d658b into elastic:main Mar 12, 2026
36 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ES|QL: Validate TOP_SNIPPETS query argument is foldable#142763

ES|QL: Validate TOP_SNIPPETS query argument is foldable#142763
carlosdelest merged 29 commits intoelastic:mainfrom
mridula-s109:topsnippet/foldable

mridula-s109 commented Feb 20, 2026 •

edited

Loading

Uh oh!

elasticsearchmachine commented Feb 20, 2026

Uh oh!

elasticsearchmachine commented Feb 23, 2026

Uh oh!

elasticsearchmachine commented Feb 23, 2026

Uh oh!

carlosdelest left a comment

Uh oh!

Uh oh!

Uh oh!

carlosdelest Feb 24, 2026

Uh oh!

Uh oh!

mridula-s109 commented Feb 24, 2026

Uh oh!

ioanatia Mar 12, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

mridula-s109 commented Feb 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elasticsearchmachine commented Feb 20, 2026

Uh oh!

elasticsearchmachine commented Feb 23, 2026

Uh oh!

elasticsearchmachine commented Feb 23, 2026

Uh oh!

carlosdelest left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

carlosdelest Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mridula-s109 commented Feb 24, 2026

Uh oh!

ioanatia Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mridula-s109 commented Feb 20, 2026 •

edited

Loading