Uh oh!
There was an error while loading. Please reload this page.
doc: add guides on writing tests involving promises - #20988
Closed
joyeecheung wants to merge 3 commits into
Closed
Conversation
Mention `common.crashOnUnhandledRejection()` and wrapping the handlers in `common.mustCall()` or `common.mustNotCall()`
vsemozhetbyt
approved these changes
May 27, 2018
| When writing tests involving promises, either make sure that the | ||
| `onFulfilled` or the `onRejected` handler is wrapped in | ||
| `common.mustCall()` or `common.mustNotCall` accordingly, or |
Contributor
There was a problem hiding this comment.
common.mustNotCall -> common.mustNotCall()?
| const fs = require('fs').promises; | ||
| // Use `common.crashOnUnhandledRejection()` to make sure unhandled rejections | ||
| // will fail the test |
| // will fail the test | ||
| common.crashOnUnhandledRejection(); | ||
| // Or, wrap the `onRejected` handler in `common.mustNotCall()` |
| // Or, wrap the `onRejected` handler in `common.mustNotCall()` | ||
| fs.writeFile('test-file', 'test').catch(common.mustNotCall()); | ||
| // Or, wrap the `onFulfilled` handler in `common.mustCall()` |
| (content) => assert.strictEqual(content.toString(), 'test') | ||
| )); | ||
| ``` | ||
lpinca
reviewed
May 27, 2018
| fs.readFile('test-file').then( | ||
| common.mustCall( | ||
| (content) => assert.strictEqual(content.toString(), 'test') | ||
| )); |
Member
There was a problem hiding this comment.
It's an example, but I think it makes sense to add catch() to handle the case where the assertion fails.
MemberAuthor
There was a problem hiding this comment.
@lpinca that is demonstrated in the first example...also the onFullfilled and the onRejected handler are mutually exclusive so common.mustCall should be able to catch that.
Member
There was a problem hiding this comment.
I'm not sure I understand, this
constcommon=require('../common');constassert=require('assert');constfs=require('fs');constfsPromises=fs.promises;fs.writeFileSync('test-file','foo');fsPromises.readFile('test-file').then(common.mustCall((content)=>{assert.strictEqual(content.toString(),'test');}));should make the test fails, but it doesn't if common.crashOnUnhandledRejection(); is not added.
MemberAuthor
There was a problem hiding this comment.
@lpinca I see what you mean now, the catch needs to handle possible failures if the onFulfilled handler is not empty. Thanks for catching that!
danbev
approved these changes
May 28, 2018
joyeecheung
commented
May 28, 2018
MemberAuthor
lpinca
approved these changes
May 28, 2018
BridgeAR
approved these changes
May 28, 2018
trivikr
approved these changes
May 28, 2018
jasnell
approved these changes
May 29, 2018
apapirovski
commented
Jun 1, 2018
Contributor
Landed in df16d20 |
apapirovski pushed a commit
that referenced
this pull request
Jun 1, 2018
Mention `common.crashOnUnhandledRejection()` and wrapping the handlers in `common.mustCall()` or `common.mustNotCall()`. PR-URL: #20988 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit
that referenced
this pull request
Jun 6, 2018
Mention `common.crashOnUnhandledRejection()` and wrapping the handlers in `common.mustCall()` or `common.mustNotCall()`. PR-URL: #20988 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
9 participants
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.
Mention
common.crashOnUnhandledRejection()and wrapping thehandlers in
common.mustCall()orcommon.mustNotCall()Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes