assert: add default operator to `assert.fail()` #22694

BridgeAR · 2018-09-04T22:59:38Z

This makes sure assert.fail() contains an operator instead of being
undefined.

On top of that it also fixes the err.generatedMessage property.
Before, it was not always set correct.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

This makes sure `assert.fail()` contains an operator instead of being undefined. On top of that it also fixes the `err.generatedMessage` property. Before, it was not always set correct.

nodejs-github-bot · 2018-09-04T23:00:31Z

@BridgeAR build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/792/pipeline

Trott · 2018-09-05T04:39:19Z

semver-major in case someone is adding a property called generatedMessage to their assertion errors? Or is that too far-fetched?

Trott · 2018-09-05T04:40:13Z

Is there a reason to expose generatedMessage? If there's no reason, to expose it then should we hide it? If there is a reason to expose it, should we document it?

BridgeAR · 2018-09-05T09:13:16Z

@Trott the generatedMessage property was also present before. It was just not set correct all the time. It is also already documented on the AssertionError class.

BridgeAR · 2018-09-08T00:42:56Z

PTAL @nodejs/util

BridgeAR · 2018-09-08T00:43:10Z

@nodejs/testing

Trott · 2018-09-08T01:57:07Z

I see that operator can be 'throws' and 'doesNotThrow'. Is that a relatively recent addition? I was under the impression that operator was always a JavaScript comparison operator like !==. A function name is surprising to me. I'm guessing it's too late to prevent such a change from ending up in a release. (Maybe I'm wrong and 'throws' has been a legit value for operator for years?)

I bring this up because I'd rather operator be undefined than fail unless there's a compelling reason to make it the function name sometimes but not all the time. That just seems odd to me. But my argument there is less compelling as we've already started going down this road apparently.

BridgeAR · 2018-09-08T06:49:09Z

@Trott I am not sure anymore since when that is the case. I think since v8 or v9. Using e.g., === would have been wrong as that is not the actual used comparison. That is why they changed to the function name. Only the loose equal checks contain == and != as operator, plus assert.ok() and partially assert.fail(). Since we filter the function name from the stack trace, it's good to know what function actually triggered the assertion. That's also why they changed to the function name and why I added it here as well.

Trott · 2018-09-08T14:16:42Z

@BridgeAR Thanks. Just to be clear: Not objecting. Just surprised. :-D

BridgeAR · 2018-09-11T12:01:33Z

PTAL this could use some reviews.

jdalton · 2018-09-11T14:20:57Z

lib/assert.js

    actual,
    expected,
-    message,
-    operator,
+    operator: operator || 'fail',


Does Node have a consistent way of checking for optional params or default params?
In this case the falsey check means that users can't specify it as null or "".

No, it's often mixed and fasly values are often set to a default while in other cases only undefined is set to a default.

This method has a mix of deprecated/legacy and new/different functionality. Would moving the operator juggle into a argLength < 2 branch with the other argLen checks be doable? That way it touches less of the overlapping code paths.

That was done on purpose since I believe it is best to just properly do this for all cases.

Shall I maybe change the check to: operator === undefined ? 'fail' : operator?

BridgeAR · 2018-09-12T22:19:37Z

PTAL

jdalton · 2018-09-12T22:40:56Z

lib/assert.js

@@ -106,13 +107,23 @@ function fail(actual, expected, message, operator, stackStartFn) {
      operator = '!=';
  }

-  innerFail({
+  if (message instanceof Error) throw message;
+


☝️ Should use the util for isError (internal reference) for this since it avoids the error of errors from other realms.

Only changing this here is likely not the best way. It would have to be changed throughout assert in total or not at all. It is also sad that the util function is not a safe check as the Symbol.toStringTag could be set and isError would happily return true in some weird cases.

Only changing this here is likely not the best way.

Ah, didn't know this was consistent with the rest of assert. A follow up would be best.

It is also sad that the util function is not a safe check as the Symbol.toStringTag could be set and isError would happily return true in some weird cases.

Oh I thought the new isNativeError was more robust.

Oh, I missed the isNativeError somehow. We have multiple places in core where we should likely switch to this check.

BridgeAR · 2018-09-16T15:54:07Z

PTAL

mcollina

LGTM

BridgeAR · 2018-09-17T09:46:25Z

CI https://ci.nodejs.org/job/node-test-pull-request/17229/

This makes sure `assert.fail()` contains an operator instead of being undefined. On top of that it also fixes the `err.generatedMessage` property. Before, it was not always set correct. PR-URL: nodejs#22694 Reviewed-By: John-David Dalton <john.david.dalton@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

BridgeAR · 2018-09-17T14:11:03Z

Landed in eee5adf 🎉

This makes sure `assert.fail()` contains an operator instead of being undefined. On top of that it also fixes the `err.generatedMessage` property. Before, it was not always set correct. PR-URL: #22694 Reviewed-By: John-David Dalton <john.david.dalton@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

assert: add default operator to assert.fail()

f92573f

This makes sure `assert.fail()` contains an operator instead of being undefined. On top of that it also fixes the `err.generatedMessage` property. Before, it was not always set correct.

nodejs-github-bot added the assert Issues and PRs related to the assert subsystem. label Sep 4, 2018

BridgeAR mentioned this pull request Sep 4, 2018

assert: accept undefined as message input #22696

Closed

4 tasks

BridgeAR requested review from mcollina, benjamingr, jasnell and jdalton September 11, 2018 12:02

jdalton reviewed Sep 11, 2018

View reviewed changes

fixup: strictor operator check

dd512bc

jdalton reviewed Sep 12, 2018

View reviewed changes

jdalton approved these changes Sep 16, 2018

View reviewed changes

mcollina approved these changes Sep 16, 2018

View reviewed changes

BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 17, 2018

BridgeAR closed this Sep 17, 2018

targos mentioned this pull request Sep 18, 2018

Release proposal: v10.11.0 #22932

Merged

wsmd mentioned this pull request Dec 5, 2019

Improve error message format for Node's assert.fail jestjs/jest#9262

Merged

BridgeAR deleted the improve-assert-fail branch January 20, 2020 11:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

assert: add default operator to `assert.fail()` #22694

assert: add default operator to `assert.fail()` #22694

BridgeAR commented Sep 4, 2018

nodejs-github-bot commented Sep 4, 2018

Trott commented Sep 5, 2018

Trott commented Sep 5, 2018 •

edited

BridgeAR commented Sep 5, 2018 •

edited

BridgeAR commented Sep 8, 2018

BridgeAR commented Sep 8, 2018

Trott commented Sep 8, 2018 •

edited

BridgeAR commented Sep 8, 2018

Trott commented Sep 8, 2018

BridgeAR commented Sep 11, 2018

jdalton Sep 11, 2018

BridgeAR Sep 11, 2018

jdalton Sep 11, 2018

BridgeAR Sep 11, 2018

BridgeAR commented Sep 12, 2018

jdalton Sep 12, 2018

BridgeAR Sep 12, 2018

jdalton Sep 12, 2018

BridgeAR Sep 12, 2018

BridgeAR commented Sep 16, 2018

mcollina left a comment

BridgeAR commented Sep 17, 2018

BridgeAR commented Sep 17, 2018

assert: add default operator to assert.fail() #22694

assert: add default operator to assert.fail() #22694

Conversation

BridgeAR commented Sep 4, 2018

Checklist

nodejs-github-bot commented Sep 4, 2018

Trott commented Sep 5, 2018

Trott commented Sep 5, 2018 • edited

BridgeAR commented Sep 5, 2018 • edited

BridgeAR commented Sep 8, 2018

BridgeAR commented Sep 8, 2018

Trott commented Sep 8, 2018 • edited

BridgeAR commented Sep 8, 2018

Trott commented Sep 8, 2018

BridgeAR commented Sep 11, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BridgeAR commented Sep 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BridgeAR commented Sep 16, 2018

mcollina left a comment

Choose a reason for hiding this comment

BridgeAR commented Sep 17, 2018

BridgeAR commented Sep 17, 2018

assert: add default operator to `assert.fail()` #22694

assert: add default operator to `assert.fail()` #22694

Trott commented Sep 5, 2018 •

edited

BridgeAR commented Sep 5, 2018 •

edited

Trott commented Sep 8, 2018 •

edited