Skip to content

assert: improve assertion errors #27781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
BridgeAR wants to merge 4 commits into from
Closed

assert: improve assertion errors #27781

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6bf9806
assert: improve regular expression validation
BridgeAR May 19, 2019
e36fd00
assert: add partial support for evaluated code in simple assert
BridgeAR May 20, 2019
6dd4ba5
doc: update assert's validation functions
BridgeAR May 19, 2019
25dedd6
fixup: doc: update assert's validation functions
BridgeAR Jun 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: update assert's validation functions 
Using `assert.throws()` or `assert.rejects()` in combination with
validation function can be very powerful. Using them by returning
any value besides `true` makes debugging very difficult though
because there's no context or reason why the error validation failed.
Thus, it is recommended to throw an error in such cases instead of
returning anything besides `true`.
  • Loading branch information
@BridgeAR
BridgeAR committed Jun 5, 2019
commit 6dd4ba5558d81b00f431d55dd5c3dfc1d92a0dae
12 changes: 8 additions & 4 deletions doc/api/assert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1210,10 +1210,14 @@ assert.throws(
() => {
throw new Error('Wrong value');
},
function(err) {
if ((err instanceof Error) && /value/.test(err)) {
return true;
}
(err) => {
assert(err instanceof Error);
assert(/value/.test(err));
// Returning anything from validation functions besides `true` is not
// recommended. Doing so results in the caught error being thrown again.
// That is mostly not the desired outcome. Throw an error about the specific
Comment thread
BridgeAR marked this conversation as resolved.
Resolved
// validation that failed instead (as done in this example).
return true;
},
'unexpected error'
);
Expand Down