fix(shell-api): don't pass options into cursor.close() MONGOSH-1356 #1379
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
baileympearson
commented
Jan 5, 2023
| @@ -53,8 +53,8 @@ export abstract class AbstractCursor<CursorType extends ServiceProviderAggregati | |||
| } | |||
|
|
|||
| @returnsPromise | |||
| async close(options: Document = {}): Promise<void> { | |||
| await this._cursor.close(options); | |||
| async close(): Promise<void> { | |||
There was a problem hiding this comment.
I wasn't sure if this was okay (I'm not sure if this method gets exposed). If we need to preserve the method signature, I can skip the "no unused vars" lint rule for this line.
There was a problem hiding this comment.
I'm thinking maybe for users who are executing scripts with the shell this is exposed and options are potentially being passed in even if a no-op. Maybe safer to leave with the lint rule skipping. Thoughts @addaleax ?
There was a problem hiding this comment.
Mh yeah … I guess this would be an issue only if we ever would decide to reintroduce an argument for this function (with possibly different semantics), but that seems very unlikely? I think this is fine as it is, tbh.
addaleax
changed the title
addaleax
approved these changes
Jan 6, 2023
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.
Here's a patch from the driver running against the changes in this branch:
https://spruce.mongodb.com/version/63b7157961837d672d740cca/tasks?sorts=STATUS%3AASC%3BBASE_STATUS%3ADESC