Ensure assertion message is a string - Fixes #1125 #1174
Conversation
lib/assert.js
Outdated
| x.pass = msg => { | ||
| test(true, create(true, true, 'pass', msg, x.pass)); | ||
| test(true, create(true, true, 'pass', stringMsg(msg), x.pass)); |
There was a problem hiding this comment.
Instead of wrapping every msg, you can just add the validation to the create function.
There was a problem hiding this comment.
@sindresorhus : Great catch! I wonder why I didn't see that.
lib/assert.js
Outdated
| @@ -30,45 +30,49 @@ function test(ok, opts) { | |||
| } | |||
| } | |||
|
|
|||
| function stringMsg(msg) { | |||
| return msg instanceof Error ? msg.message : typeof msg === "string" ? msg : msg ? JSON.stringify(msg) : null; | |||
There was a problem hiding this comment.
It should fail if msg is anything other than a string, not gracefully handle it.
There was a problem hiding this comment.
Following your comment, I can think of two possible ways to go about this.
Throw an exception when msg is anything other than
- A string or
- A string or Error object (since for errro type, the message propoerty value can be used).
There was a problem hiding this comment.
- Message should always be a string
sindresorhus
changed the title
lib/assert.js
Outdated
| stackStartFunction: fn | ||
| }; | ||
| } | ||
| throw new TypeError('assertion message must be a string'); |
There was a problem hiding this comment.
Would be better to invert the check and put the throw in the if-statement. Also: assertion => Assertion
There was a problem hiding this comment.
I can check if msg exists and not string then throw an error in within the if-statement:
if(msg && typeof msg !== 'string'){ throw error }
But that logic is flawed because 0 will slip through uncaught. Also, inverting the logic as suggested seem flawed as well since an OR condition is short-circuited once first test is truthy.
I'll look more closely.
Cheers!
There was a problem hiding this comment.
I simply meant:
if (msg !== undefined && typeof msg !== 'string') {
throw ...
}
return ...
|
This looks good now, but needs a test. |
There was a problem hiding this comment.
("Reviewing" so the PR status reflects that this still needs a test. No worries if you're busy @leewaygroups.)
|
@novemberborn Yeah, some delays from me there. Sorry about that. I'll check-in the test in shortly. |
|
Hi @leewaygroups, just checking in 😄 |
|
Closing for lack of activity. |
This PR is intended to fix #1125 .
stringMsgandstringMsgis invoked only in assertion methods it is needed (in my opinion)Note: If msg is an object and non Error instance, the msg object is stringified using JSON.stringify.
All comments/reviews are welcome.
Cheers!!