Range Validation by urmichm · Pull Request #20518 · opensearch-project/OpenSearch

urmichm · 2026-02-01T14:35:12Z

Description

Added range validation for the query builder and the field mapper.

Related Issues

Resolves #20497

Check List

Functionality includes testing.
API changes companion pull request created, if applicable.
Public documentation issue/PR created, if applicable.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

coderabbitai · 2026-02-01T14:35:44Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

📝 Walkthrough

Walkthrough

Adds strict validation for range bounds during indexing and query parsing, refactors range parsing into a dedicated method that handles CIDR/IP input and ignore_malformed, and adds tests plus a changelog entry. No public API signature changes.

Changes

Cohort / File(s)	Summary
Range mapper implementation `server/src/main/java/org/opensearch/index/mapper/RangeFieldMapper.java`	Refactors parsing into a private `parseRange(ParseContext)`; validates single-assignment and inclusivity for bounds, supports CIDR IP strings, handles `ignore_malformed`, fills missing bounds with type min/max, and centralizes error handling. Adjusts when `_field_names` is created.
Range query parsing `server/src/main/java/org/opensearch/index/query/RangeQueryBuilder.java`	Introduces nullable `Boolean` include flags, uses `DeprecationHandler`-aware parsing, enforces single-assignment and GT/GTE / LT/LTE consistency, adds explicit invalid-bound error messages, and applies include flags only when explicitly provided.
Mapper & Query tests `server/src/test/java/org/opensearch/index/mapper/RangeFieldMapperTests.java`, `server/src/test/java/org/opensearch/index/query/RangeQueryBuilderTests.java`	Adds tests asserting parsing errors for conflicting/duplicate lower and upper bound configurations in both the mapper and the query builder (note: `RangeFieldMapperTests` contains duplicated test methods).
Changelog `CHANGELOG.md`	Adds an Unreleased 3.x entry: "Add range validations in query builder and field mapper ([`#20497`])".

Sequence Diagram(s)

mermaid
sequenceDiagram
participant Client as Client
participant Parser as ParseContext / XContentParser
participant Mapper as RangeFieldMapper
participant Type as RangeType
rect rgba(220,220,255,0.5)
Client->>Parser: send JSON range input
Parser->>Mapper: parseRange(context)
Mapper->>Parser: read tokens (gt/gte/lt/lte, cidr, null)
alt CIDR string detected
Mapper->>Type: parseIpRangeFromCidr(...)
Type-->>Mapper: Range or error
else Object bounds
Mapper->>Type: rangeType.parseFrom/parseTo(...)
Type-->>Mapper: parsed bound values
end
Mapper->>Mapper: validate single-assignment & inclusivity
alt malformed and ignore_malformed
Mapper->>Mapper: record ignored field, return null
else valid
Mapper->>Type: rangeType.createFields(...)
Type-->>Mapper: Lucene fields
Mapper->>Parser: optionally create _field_names
end
end

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check	❓ Inconclusive	The title "Range Validation" is overly vague and generic, using non-descriptive terms that do not clearly convey what specific change was made.	Make the title more specific, e.g., "Add range validations in query builder and field mapper" or "Validate inclusive/exclusive bounds in range fields."

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description check	✅ Passed	The pull request description is mostly complete with a clear description, linked issue reference, and checklist acknowledgment, though some optional sections remain unchecked.
Linked Issues check	✅ Passed	The code changes successfully implement range validation for both query builder and field mapper to reject conflicting/invalid inclusive-exclusive bounds as required by issue `#20497`.
Out of Scope Changes check	✅ Passed	All code changes are directly related to range validation requirements in issue `#20497`; changelog update is appropriate and no extraneous changes detected.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2026-02-01T16:02:47Z

❕ Gradle check result for 9a9b3a9: UNSTABLE

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

codecov · 2026-02-01T16:03:24Z

Codecov Report

❌ Patch coverage is 88.46154% with 12 lines in your changes missing coverage. Please review.
✅ Project coverage is 73.37%. Comparing base (ac911ed) to head (cfd1fd1).
⚠️ Report is 11 commits behind head on main.

Files with missing lines	Patch %	Lines
.../org/opensearch/index/mapper/RangeFieldMapper.java	83.05%	5 Missing and 5 partials ⚠️
.../org/opensearch/index/query/RangeQueryBuilder.java	95.55%	0 Missing and 2 partials ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #20518      +/-   ##
============================================
+ Coverage     73.28%   73.37%   +0.09%     
- Complexity    72143    72221      +78     
============================================
  Files          5798     5798              
  Lines        329791   329830      +39     
  Branches      47531    47545      +14     
============================================
+ Hits         241681   242023     +342     
+ Misses        68786    68419     -367     
- Partials      19324    19388      +64

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

urmichm · 2026-02-01T20:32:41Z

@coderabbitai review

coderabbitai · 2026-02-01T20:32:50Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

github-actions · 2026-02-01T20:48:25Z

❌ Gradle check result for a8697d1: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

urmichm · 2026-02-01T21:22:21Z

Regression
org.opensearch.action.admin.cluster.filecache.PruneFileCacheIT.testPruneCacheWithRealData

Error Message

java.lang.AssertionError: Should have pruned bytes

Stacktrace

java.lang.AssertionError: Should have pruned bytes
	at __randomizedtesting.SeedInfo.seed([CDE0C412E58D517C:374F261BFA2814E2]:0)
	at org.junit.Assert.fail(Assert.java:89)
	at org.junit.Assert.assertTrue(Assert.java:42)
.....

urmichm · 2026-02-02T07:41:10Z

org.opensearch.action.admin.cluster.filecache.PruneFileCacheIT.testPruneCacheWithRealData is a known flaky test -> #19724

urmichm · 2026-02-07T15:11:49Z

Hello, all tests passed, please review my PR
@msfroh @epugh @sandeshkr419

Updated the description for range validation in query builder and field mapper. Signed-off-by: Sandesh Kumar <sandeshkr419@gmail.com>

sandeshkr419

Looks good, thanks for working on this @urmichm!

github-actions · 2026-02-09T20:09:43Z

❌ Gradle check result for 343cdbe: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

asimmahmood1 · 2026-02-09T20:24:01Z

@coderabbitai review

coderabbitai · 2026-02-09T20:24:08Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

github-actions · 2026-02-09T21:01:54Z

❌ Gradle check result for 343cdbe:

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

asimmahmood1

LGTM! I think this the right approach and avoid abigious requests to complete.

I am wondering though, other than the change log note, is there another place in 3.6 release we can state something like in the release blog:

OS 3.6 now has more strict validation for range queries. When upgrading to OS 3.6, there is chance that previous request with ambiguous range queries, e.g. with lte and lt, multiple lt, users should fix those request before upgrading.

github-actions · 2026-02-09T21:59:14Z

❌ Gradle check result for 343cdbe: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

Signed-off-by: Mikhail Urmich <32458509+urmichm@users.noreply.github.com>

urmichm · 2026-02-10T07:10:11Z

Thank you @asimmahmood1 @sandeshkr419 for approving the PR

Failed tests on the pipeline are related to FlightClientManagerTests, which is known for flaky tests (#19728 #18938)
I have resolved the conflict on README, could you re-trigger the build?

Failed test:
Test Result (1 failure / +1)
org.opensearch.arrow.flight.bootstrap.FlightClientManagerTests.testFailedClusterUpdateButSuccessfulDirectRequest

github-actions · 2026-02-10T21:11:27Z

❌ Gradle check result for cfd1fd1: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2026-02-11T18:39:23Z

✅ Gradle check result for cfd1fd1: SUCCESS

urmichm · 2026-02-11T19:02:32Z

@sandeshkr419 Gradle check succeeded ✅
Please check if PR can be merged before we get conflicts and rebase triggers a new gradle check 😅

…roject#20518) Signed-off-by: Michael <urmich.m@gmail.com> Signed-off-by: Mikhail Urmich <32458509+urmichm@users.noreply.github.com> Signed-off-by: Sandesh Kumar <sandeshkr419@gmail.com> Co-authored-by: Sandesh Kumar <sandeshkr419@gmail.com>

urmichm requested review from a team, Bukhtawar, CEHENKLE, Rishikesh1159, anasalkouz, andrross, ashking94, cwperks, dbwiddis, gbbafna, jed326, kotwanikunal, mch2, msfroh, owaiskazi19, reta, sachinpkale, saratvemulapalli, shwetathareja and sohami as code owners February 1, 2026 14:35

github-actions bot added bug Something isn't working Indexing Indexing, Bulk Indexing and anything related to indexing labels Feb 1, 2026

changelog nit

343cdbe

Updated the description for range validation in query builder and field mapper. Signed-off-by: Sandesh Kumar <sandeshkr419@gmail.com>

sandeshkr419 approved these changes Feb 9, 2026

View reviewed changes

asimmahmood1 approved these changes Feb 9, 2026

View reviewed changes

Merge branch 'main' into 20497-range-validation

cfd1fd1

Signed-off-by: Mikhail Urmich <32458509+urmichm@users.noreply.github.com>

sandeshkr419 closed this Feb 10, 2026

sandeshkr419 reopened this Feb 10, 2026

sandeshkr419 added the skip-diff-analyzer Maintainer to skip code-diff-analyzer check, after reviewing issues in AI analysis. label Feb 10, 2026

andrross approved these changes Feb 12, 2026

View reviewed changes

andrross merged commit d7eb5e7 into opensearch-project:main Feb 12, 2026
83 of 102 checks passed

urmichm deleted the 20497-range-validation branch February 12, 2026 09:19

dhrubo-os mentioned this pull request Feb 21, 2026

Fix numeric type preservation in ML inference query template substitution opensearch-project/ml-commons#4656

Merged

5 tasks

opensearch-ci-bot mentioned this pull request Feb 28, 2026

[AUTOCUT] Gradle Check Flaky Test Report for SegmentReplicationIT #14328

Open

andrross mentioned this pull request Mar 21, 2026

Add release notes for 3.6.0 andrross/OpenSearch#215

Closed

1 task

Conversation

urmichm commented Feb 1, 2026

Description

Related Issues

Check List

Uh oh!

coderabbitai bot commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Uh oh!

github-actions bot commented Feb 1, 2026

Uh oh!

codecov bot commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

urmichm commented Feb 1, 2026

Uh oh!

coderabbitai bot commented Feb 1, 2026

Uh oh!

github-actions bot commented Feb 1, 2026

Uh oh!

urmichm commented Feb 1, 2026

Uh oh!

urmichm commented Feb 2, 2026

Uh oh!

urmichm commented Feb 7, 2026

Uh oh!

sandeshkr419 left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 9, 2026

Uh oh!

asimmahmood1 commented Feb 9, 2026

Uh oh!

coderabbitai bot commented Feb 9, 2026

Uh oh!

github-actions bot commented Feb 9, 2026

Uh oh!

asimmahmood1 left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 9, 2026

Uh oh!

urmichm commented Feb 10, 2026

Uh oh!

github-actions bot commented Feb 10, 2026

Uh oh!

github-actions bot commented Feb 11, 2026

Uh oh!

urmichm commented Feb 11, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

coderabbitai bot commented Feb 1, 2026 •

edited

Loading

codecov bot commented Feb 1, 2026 •

edited

Loading