Support async functions as callback in pm.test #919
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
Async functions return a promise. Currently with pm.test('description', async function () {}) will mark the test as successfull and completed, even if an exception is thrown.
|
The PR would still require some tests, but I would first welcome some feedback on the proposed change before tuning the PR. |
kevinswiber
reviewed
May 19, 2023
| @@ -104,12 +104,16 @@ module.exports = function (pm, onAssertionComplete) { | |||
| } | |||
| // if the assertion function does not expect a callback, we synchronously execute the same | |||
| else { | |||
| try { assert(); } | |||
| try { | |||
| Promise.resolve(assert()) | |||
There was a problem hiding this comment.
The vast majority of tests aren't going to be async functions, and we'll likely hit a small performance penalty on running all test functions through Promise resolution. Wondering if we could do something like...
try {
const maybePromise = assert();
if (maybePromise instanceof Promise) {
Promise.resolve(maybePromise)
.catch(e => markAssertionAsFailure(assertionData, e));
}
} catch (e) {
markAssertionAsFailure(assertionData, e);
}
onAssertionComplete(assertionData);Alternatively, we could also check if the function's constructor name is AsyncFunction and split logic based on that without having to execute the function first.
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.
Async functions return a promise. Currently with pm.test('description', async function () {}) will mark the test as successful and completed, even if an exception is thrown.