MONGOCRYPT-661 enable "range" by default #861
Merged
Conversation
This file contains 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
unconditionally set `use_range_v2` to true
Document "rangePreview" and "RangePreview" as removed. Using either results in an error. Keep documentation of "range" as unstable. Protocol changes are in progress. "range" is expected to be stable for the upcoming 1.11.0 release.
expect error when "rangePreview" is used
expect an error when "rangePreview" is used
This check may be unnecessary. libmongocrypt validates options. However, the check is kept and updated to use "Range" to avoid changing the thrown exception.
kevinAlbs
requested review from
jyemin,
rozza,
a team,
nbbeeken,
durran,
baileympearson,
dariakp and
addaleax
as code owners
kevinAlbs
requested review from
vbabanin and
adriandole
and removed request for
rozza and
dariakp
I added that so existing apps that use rangePreview on MongoDB <=7.0 wouldn't break when upgrading to the latest version of pymongocrypt. If the plan is to break "rangePreview" across the board then that you can go ahead and remove the enable_range_v2 argument and property. Users will just need to pin to an older version of pymongocrypt or upgrade to "range". |
adriandole
approved these changes
Jul 16, 2024
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.
Summary
This PR partially resolves MONGOCRYPT-661:
mongocrypt_setopt_use_range_v2as it is no longer necessary.Background & Motivation
Patch build: https://spruce.mongodb.com/version/66912f5f6df6a60007ec877e
As implemented, libmongocrypt does not currently support both "range" and "rangePreview" simultaneously. Instead,
mongocrypt_setopt_use_range_v2controls whether "range" is supported. Server 8.0 drops the experimental "rangePreview". Drivers are expected to drop "rangePreview" as well.I expect removing "rangePreview" in a minor release is OK. "rangePreview" was documented as unstable in libmongocrypt and in drivers as "experimental only". For historical precedent: the unstable QEv1 protocol was updated to the incompatible QEv2 protocol in minor libmongocrypt release for DRIVERS-2435.
Documentation noting "range" as unstable is expected to be short-lived. Once remaining "range" protocol changes are completed, a subseqent PR is planned to document "range" as stable.
This PR includes updates to language bindings to fix tests and update documentation. Notably, Python's
enable_range_v2is not modified. It may be OK to deprecate or remove as it is no-longer-needed (rangeV2 is always enabled).