CSHARP-6020: Add builders for the doesNotAffect field for in, range, equals and compound Atlas Search operators#2032
Open
sanych-sun wants to merge 4 commits into
Open
CSHARP-6020: Add builders for the doesNotAffect field for in, range, equals and compound Atlas Search operators#2032sanych-sun wants to merge 4 commits into
sanych-sun wants to merge 4 commits into
Conversation
…ls and compound Atlas Search operators
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds support for rendering Atlas Search’s doesNotAffect option across several operators so facet counts can be computed over the full result set even when certain operators are applied.
Changes:
- Added
doesNotAffectrendering forequals,in, andrangeoperators, plus a fluentDoesNotAffect(...)builder forcompound. - Introduced new
SearchDefinitionBuilderoverloads to acceptdoesNotAffectforEquals,In, andRange. - Added unit and Atlas integration tests validating
doesNotAffectrendering and behavior.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 24 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/MongoDB.Driver.Tests/Search/SearchDefinitionBuilderTests.cs | Adds rendering tests for doesNotAffect on compound, equals, in, and range. |
| tests/MongoDB.Driver.Tests/Search/AtlasSearchTests.cs | Adds Atlas integration coverage for doesNotAffect with facets; introduces Movie.Year mapping. |
| src/MongoDB.Driver/Search/SearchDefinitionBuilder.cs | Adds public overloads for doesNotAffect; updates (and in several cases regresses) XML docs around SearchPathDefinition. |
| src/MongoDB.Driver/Search/OperatorSearchDefinitions.cs | Implements doesNotAffect serialization for Compound, Equals, In, and Range operator definitions. |
| src/MongoDB.Driver/Search/CompoundSearchDefinitionBuilder.cs | Adds fluent DoesNotAffect(string facetName) to the compound builder and passes it through to rendering. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+139
to
+143
| public SearchDefinition<TDocument> Equals<TField>( | ||
| FieldDefinition<TDocument, TField> path, | ||
| TField value, | ||
| IEnumerable<string> doesNotAffect, | ||
| SearchScoreDefinition<TDocument> score = null) => |
Member
Author
There was a problem hiding this comment.
Do not agree. Even though this looks like ambiguous call, having 3rd parameter as null should resolve to the overload with SearchScoreDefinition parameter. However it does not really matter what overload will be selected - it will result in call having both score and doesNotAffect having null as a value.
We probably should consider builder pattern here for future, but it would be a breaking change - so not in scope of this PR, but might be a good idea for major release.
Member
Author
There was a problem hiding this comment.
Reworked the added parameter as Options struct instead. CC: @BorisDog
| : base(OperatorType.Equals, path, score) | ||
| { | ||
| _value = value; | ||
| _doesNotAffect = doesNotAffect?.ToArray(); |
| { | ||
| Ensure.IsNotNullOrEmpty(values, nameof(values)); | ||
| _values = values.ToArray(); | ||
| _doesNotAffect = doesNotAffect?.ToArray(); |
| : base(OperatorType.Range, path, score) | ||
| { | ||
| _range = range; | ||
| _doesNotAffect = doesNotAffect?.ToArray(); |
sanych-sun
changed the title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.