fix(NODE-4108): improve return type for withTransaction() #3236
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
5 tasks
nbbeeken
force-pushed
the
NODE-4108/withTransaction-return-type
branch
from
1905dfd
to
a73ca1d
Compare
nbbeeken
force-pushed
the
NODE-4108/withTransaction-return-type
branch
from
a73ca1d
to
54e309e
Compare
durran
reviewed
May 9, 2022
| @@ -36,6 +36,14 @@ declare global { | |||
| } | |||
|
|
|||
| namespace Mocha { | |||
| interface SuiteFunction { | |||
There was a problem hiding this comment.
Not a request for changes just wanting to understand the rationale for including these 2 definitions here.
There was a problem hiding this comment.
Our metadata UI also allows specifying filters at the describe level, only in the 3 argument form of title, metadata, function So this just prevents type issues when using a metadata object in describe or context. I just don't think we've used metadata at the suite level much before or we haven't needed it in TS test yet. But the transactions tests will always need to filter up to 4.2 maybe 4.4 so it makes sense to specify it higher up.
durran
approved these changes
May 9, 2022
baileympearson
approved these changes
May 12, 2022
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
The
withTransaction()function signature implies thatwithTransaction()returns the same value that the user-provided callback returns but that is incorrect.Reported in Automattic/mongoose#9919
What is changing?
Function signature for
withTransaction()maintains the T argument but goes unused. Added tests for asserting the expected outcomes.What is the motivation for this change?
Fixes the type bug, but also adds documentation to the three possible outcomes of the function.
Double check the following
npm run check:lintscript<type>(NODE-xxxx)<!>: <description>