feat(NODE-4081): fix and deprecate change stream resume options #3270
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
dariakp
added
the
Primary Review
dariakp
requested changes
May 26, 2022
baileympearson
force-pushed
the
NODE-4081-fix-change-stream-resume-options
branch
from
a94affc
to
23e1f17
Compare
dariakp
requested changes
May 31, 2022
dariakp
added
Team Review
dariakp
previously approved these changes
May 31, 2022
nbbeeken
requested changes
May 31, 2022
nbbeeken
previously approved these changes
May 31, 2022
dariakp
previously approved these changes
May 31, 2022
- remove calls to Reflect from the resume options getter - deprecate the ResumeOptions interface - make use of ChangeStreamCursorOptions instead of ResumeOptions internally
baileympearson
force-pushed
the
NODE-4081-fix-change-stream-resume-options
branch
from
7fc29ae
to
4f38419
Compare
nbbeeken
changed the title
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.
Description
What is changing?
resumeOptionsgetter on the change stream class copies all of the existing options (including bson options)resumeOptionsgetter applies thestartAfter,resumeAfterandstartAtOperationTimeproperties to the resume options according to the spec (outlined here)ResumeOptionsinterfaceReflectin theResumeOptionsgetter so that we have Typescript support when constructing theResumeOptionsIs there new documentation needed for these changes?
No.
What is the motivation for this change?
This PR is the first step in addressing the change stream resumability issues in the Node driver.
Double check the following
npm run check:lintscript<type>(NODE-xxxx)<!>: <description>