assert: respect assert.doesNotThrow message. #2407

diversario · 2015-08-17T04:01:53Z

Addresses #2385.
Special handling to detect when user has supplied a custom message.
Added a test for user message.
When testing if actual value is an error use
util.isError instead of instanceof.

brendanashworth · 2015-08-26T07:25:49Z

Would you mind fixing up the docs for throws and doesNotThrow? They lack some information:

The docs for throws() don't mention what message really does, so you're forced to look in the code. The docs for doesNotThrow() are even worse.

diversario · 2015-08-26T13:23:06Z

Good point, I'll update them.

jasnell · 2015-11-16T17:31:14Z

@diversario ... is this still something you'd like to pursue?

diversario · 2015-11-16T17:34:11Z

I would; I actually asked a question here about it because I'm not quite sure how to proceed.

jasnell · 2015-11-16T17:35:19Z

@nodejs/ctc ... any thoughts on this one?

cjihrig · 2015-11-16T17:38:07Z

I thought assert was being locked down?

jasnell · 2015-11-16T17:50:11Z

@cjihrig good point... does that only include API changes or also behavioral fixes like this one?

cjihrig · 2015-11-16T17:54:28Z

I would have to go back and look at the CTC meeting notes, but I thought the idea was to only take patches that were relevant to Node's tests.

mscdex · 2015-11-16T17:54:46Z

I thought we would still accept actual bug fixes just not new features?

cjihrig · 2015-11-16T17:58:43Z

I'm cool with fixing actual bugs.

rvagg · 2015-11-17T10:40:50Z

lib/assert.js

+  if (!shouldThrow &&
+      actual instanceof Error &&
+      typeof message === 'string' &&
+      expectedException(actual, expected) ||


I'd prefer to see a more liberal use of parens to make it explicit what the evaluation order is that you're using here, mixing && and || without parens makes this very difficult to parse. The number of conditions in here adds to that difficulty and it'd be nice to reduce it with some compacting variables—although not essential, just would be nice to make this less terse.

Breaking out the || part into a var sounds good.

rvagg · 2015-11-17T10:41:21Z

I'm fine with fixing bugs like this

jasnell · 2016-04-02T04:53:09Z

@diversario ... still interested in this?

diversario · 2016-04-02T14:28:12Z

Oof... Is this still relevant? It's been so long. If it's still OK to go to master and there's no further PR feedback I can make the change @rvagg suggested and push up.

jasnell · 2016-04-04T22:10:33Z

@diversario ... yeah, still relevant. Just needs updated per @rvagg's comments and a couple of review sign offs.

diversario · 2016-04-10T17:25:47Z

Pushed an update.

jasnell · 2016-04-11T23:41:17Z

doc/api/assert.markdown

@@ -51,7 +51,7 @@ Tests for deep inequality. Opposite of `assert.deepStrictEqual`.
 ## assert.throws(block[, error][, message])

 Expects `block` to throw an error. `error` can be constructor, `RegExp` or
-validation function.
+validation function. When assertion fails, `message` will be included in the `AssertionError` message.


Can you line wrap these so each line is <= 80

jasnell · 2016-04-11T23:45:48Z

Generally LGTM with a few nits

diversario · 2016-04-13T23:42:00Z

Thanks for the feedback! I tried the ES6 syntax but I get a syntax error; I think this branch is off an old master that didn't have support for that yet.

jasnell · 2016-04-15T06:51:08Z

Can you rebase and update?

Addresses nodejs#2385. Special handling to detect when user has supplied a custom message. Added a test for user message. When testing if `actual` value is an error use `util.isError` instead of `instanceof`.

Addresses nodejs#2407. Break out conditional into named variables for readability. Explain the purpose of `message` in throws/doesNotThrow assertions.

Special handling to detect when user has supplied a custom message. Added a test for user message. When testing if `actual` value is an error use `util.isError` instead of `instanceof`. Fixes: #2385 PR-URL: #2407 Reviewed-By: James M Snell <jasnell@gmail.com>

jasnell · 2016-04-18T23:52:16Z

Landed in c1d82ac

Special handling to detect when user has supplied a custom message. Added a test for user message. When testing if `actual` value is an error use `util.isError` instead of `instanceof`. Fixes: #2385 PR-URL: #2407 Reviewed-By: James M Snell <jasnell@gmail.com>

MylesBorins · 2016-04-21T06:50:06Z

@jasnell lts?

jasnell · 2016-04-21T12:53:22Z

Yes
On Apr 20, 2016 11:50 PM, "Myles Borins" notifications@github.com wrote:

@jasnell https://github.com/jasnell lts?

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#2407 (comment)

Special handling to detect when user has supplied a custom message. Added a test for user message. When testing if `actual` value is an error use `util.isError` instead of `instanceof`. Fixes: #2385 PR-URL: #2407 Reviewed-By: James M Snell <jasnell@gmail.com>

Special handling to detect when user has supplied a custom message. Added a test for user message. When testing if `actual` value is an error use `util.isError` instead of `instanceof`. Fixes: nodejs#2385 PR-URL: nodejs#2407 Reviewed-By: James M Snell <jasnell@gmail.com>

Special handling to detect when user has supplied a custom message. Added a test for user message. When testing if `actual` value is an error use `util.isError` instead of `instanceof`. Fixes: #2385 PR-URL: #2407 Reviewed-By: James M Snell <jasnell@gmail.com>

LinusU · 2016-09-27T21:34:56Z

lib/assert.js

@@ -330,7 +330,14 @@ function _throws(shouldThrow, block, expected, message) {
    fail(actual, expected, 'Missing expected exception' + message);
  }

-  if (!shouldThrow && expectedException(actual, expected)) {
+  const userProvidedMessage = typeof message === 'string';


A year late to the party here but won't this always evaluate to true since message is forced into a string 7 lines up (line 326)?

ping @diversario, @jasnell

Just because I stumbled upon this comment right now: this is fixed in newer versions.

brendanashworth added the assert Issues and PRs related to the assert subsystem. label Aug 17, 2015

rvagg force-pushed the master branch from 11c25c2 to ba02bd0 Compare September 6, 2015 11:55

jasnell added the stalled Issues and PRs that are stalled. label Nov 16, 2015

rvagg reviewed Nov 17, 2015
View reviewed changes

Trott force-pushed the master branch from 1e896a6 to 082cc8d Compare December 27, 2015 02:00

jasnell reviewed Apr 11, 2016
View reviewed changes

Ilya Shaisultanov and others added 2 commits April 15, 2016 11:31

assert: respect assert.doesNotThrow message.

83ec4b5

Addresses nodejs#2385. Special handling to detect when user has supplied a custom message. Added a test for user message. When testing if `actual` value is an error use `util.isError` instead of `instanceof`.

assert: clean up conditional for _throws, fix docs.

d741140

Addresses nodejs#2407. Break out conditional into named variables for readability. Explain the purpose of `message` in throws/doesNotThrow assertions.

jasnell removed the stalled Issues and PRs that are stalled. label Apr 18, 2016

jasnell closed this Apr 18, 2016

MylesBorins mentioned this pull request Apr 20, 2016

V5.10.2 proposal #6311

Closed

This was referenced Apr 21, 2016

V5.11.0 proposal #6321

Closed

V5.11.0 proposal #6322

Closed

Audit commits not found on v4.x #5647

Closed

MylesBorins added the lts-watch-v4.x label Apr 21, 2016

ChALkeR mentioned this pull request May 2, 2016

API stability level «Locked» is inaccurate #6528

Closed

MylesBorins added land-on-v4.x and removed lts-watch-v4.x labels May 3, 2016

MylesBorins mentioned this pull request May 18, 2016

v4.4.5 proposal #6824

Merged

LinusU reviewed Sep 27, 2016

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

assert: respect assert.doesNotThrow message. #2407

assert: respect assert.doesNotThrow message. #2407

diversario commented Aug 17, 2015

brendanashworth commented Aug 26, 2015

diversario commented Aug 26, 2015

jasnell commented Nov 16, 2015

diversario commented Nov 16, 2015

jasnell commented Nov 16, 2015

cjihrig commented Nov 16, 2015

jasnell commented Nov 16, 2015

cjihrig commented Nov 16, 2015

mscdex commented Nov 16, 2015

cjihrig commented Nov 16, 2015

rvagg Nov 17, 2015

diversario Apr 2, 2016

rvagg commented Nov 17, 2015

jasnell commented Apr 2, 2016

diversario commented Apr 2, 2016

jasnell commented Apr 4, 2016

diversario commented Apr 10, 2016

jasnell Apr 11, 2016

jasnell commented Apr 11, 2016

diversario commented Apr 13, 2016

jasnell commented Apr 15, 2016

jasnell commented Apr 18, 2016

MylesBorins commented Apr 21, 2016

jasnell commented Apr 21, 2016

LinusU Sep 27, 2016

BridgeAR Aug 23, 2017

assert: respect assert.doesNotThrow message. #2407

assert: respect assert.doesNotThrow message. #2407

Conversation

diversario commented Aug 17, 2015

brendanashworth commented Aug 26, 2015

diversario commented Aug 26, 2015

jasnell commented Nov 16, 2015

diversario commented Nov 16, 2015

jasnell commented Nov 16, 2015

cjihrig commented Nov 16, 2015

jasnell commented Nov 16, 2015

cjihrig commented Nov 16, 2015

mscdex commented Nov 16, 2015

cjihrig commented Nov 16, 2015

rvagg Nov 17, 2015

Choose a reason for hiding this comment

diversario Apr 2, 2016

Choose a reason for hiding this comment

rvagg commented Nov 17, 2015

jasnell commented Apr 2, 2016

diversario commented Apr 2, 2016

jasnell commented Apr 4, 2016

diversario commented Apr 10, 2016

jasnell Apr 11, 2016

Choose a reason for hiding this comment

jasnell commented Apr 11, 2016

diversario commented Apr 13, 2016

jasnell commented Apr 15, 2016

jasnell commented Apr 18, 2016

MylesBorins commented Apr 21, 2016

jasnell commented Apr 21, 2016

LinusU Sep 27, 2016

Choose a reason for hiding this comment

BridgeAR Aug 23, 2017

Choose a reason for hiding this comment