tools: eslint rule for assert.throws -> common.expectsError #17557

apapirovski · 2017-12-08T21:44:43Z

Pretty straight-forward — eslint rule that checks for usage of assert.throws(fn, common.expectsError(err)); and suggests using common.expectsError(fn, err); instead.

First commit fixes all remaining instances that violate this rule. Second commit introduces the rule & a test for it.

Checklist

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

Affected core subsystem(s)

test, tools

cjihrig · 2017-12-09T03:05:32Z

tools/eslint-rules/prefer-common-expectserror.js

+
+module.exports = function(context) {
+  return {
+    CallExpression(node) {


Could no-restricted-syntax handle this?

Hmm, possibly but it'll definitely be a pretty convoluted rule in that case. There's no "or" for AST selectors, as far as I know, so it would get super verbose and repetitive to account for all these possibilities. Even with "or" it would be super long.

You don't need the "or" condition since that checks for a function as the first argument to assert.throws(), which is always required. This selector seems to match all of the cases you have in this PR:

"CallExpression[callee.object.name='assert'][callee.property.name='throws'][arguments.length<3][arguments.1.type='CallExpression'][arguments.1.callee.object.name='common'][arguments.1.callee.property.name='expectsError']"

It's not beautiful, but it might be able to be simplified further.

Good point. That should work. Will update.

A possible problem with no-restricted-syntax here is that this is a rule that should only apply in test. I'm not sure if there's a way to specify no-restricted-syntax in test in a way that won't override no-restricted-syntax from the config file in the parent directory. /cc @not-an-aardvark

I'm guessing that's why we also have prefer-common-mustnotcall rule.

Unfortunately, there's not a good way to do that at the moment. As a workaround, you could copy-paste the configuration from the parent directory, add the new entry, and put the resulting config in test/.eslintrc.yaml. This would have the desired effect, but it could cause the two configs to get out of sync if someone updates .eslintrc.yaml later on and forgets to update the copied version in test/.eslintrc.yaml.

There is some discussion on improving this in eslint/eslint#9192.

That's unfortunate. I'm not a fan of adding custom rules that we don't need, but keeping the two config files in sync seems like a worse idea.

Trott · 2017-12-09T03:46:20Z

This might be overly ambitious but here's an idea: Instead of forcing common.expectsError() in all of test, implement the missing functionality in assert.throws() itself and then get rid of common.expectsError() altogether.

Doesn't have to be in this PR, though, especially since it might stall due to some resistance. Can be a future enhancement.

apapirovski · 2017-12-09T04:22:11Z

This might be overly ambitious but here's an idea: Instead of forcing common.expectsError() in all of test, implement the missing functionality in assert.throws() itself and then get rid of common.expectsError() altogether.

I've thought about that before but is that something we even want? The Node.js core error objects are pretty specific and the functionality within common.expectsError is pretty targeted towards those. We could always make it more generic but then it would lose quite a bit of the functionality.

apapirovski · 2017-12-09T16:30:09Z

@cjihrig PTAL — I've updated it to use AST selectors instead. Thanks for the suggestion.

Add lint rule to validate that common.expectsError is being used instead of assert.throws(fn, common.expectsError(err));

apapirovski · 2017-12-09T16:59:44Z

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

(had an extra space in one of the error messages, force pushed a fix)

BridgeAR · 2017-12-09T17:08:03Z

@Trott as @apapirovski already pointed out common.expectsError is very specific for Node.js. The functionality would definitely deviate from the current implementation and it would be specific for assert.throws and assert.doesNotThrow would not work that similar anymore.

apapirovski · 2017-12-11T23:26:07Z

Landed in 094bfaf and e51fb90

PR-URL: #17557 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

Add lint rule to validate that common.expectsError(fn, err) is being used instead of assert.throws(fn, common.expectsError(err)); PR-URL: #17557 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

PR-URL: #17557 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

Add lint rule to validate that common.expectsError(fn, err) is being used instead of assert.throws(fn, common.expectsError(err)); PR-URL: #17557 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

PR-URL: #17557 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

Add lint rule to validate that common.expectsError(fn, err) is being used instead of assert.throws(fn, common.expectsError(err)); PR-URL: #17557 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

gibfahn · 2017-12-20T01:19:22Z

Could this be backported to v8.x-staging and v6.x-staging?

guide

From now on it is possible to use a validation object in throws instead of the other possibilites. PR-URL: nodejs#17584 Refs: nodejs#17557 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Ron Korving <ron@ronkorving.nl> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>

From now on it is possible to use a validation object in throws instead of the other possibilites. Backport-PR-URL: #19230 PR-URL: #17584 Refs: #17557 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Ron Korving <ron@ronkorving.nl> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>

From now on it is possible to use a validation object in throws instead of the other possibilites. PR-URL: nodejs#17584 Refs: nodejs#17557 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Ron Korving <ron@ronkorving.nl> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>

From now on it is possible to use a validation object in throws instead of the other possibilites. Backport-PR-URL: #23223 PR-URL: #17584 Refs: #17557 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Ron Korving <ron@ronkorving.nl> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>

nodejs-github-bot added the tools Issues and PRs related to the tools directory. label Dec 8, 2017

cjihrig reviewed Dec 9, 2017

View reviewed changes

apapirovski force-pushed the patch-eslint-test-throws branch from ed808a6 to 229e049 Compare December 9, 2017 04:20

apapirovski force-pushed the patch-eslint-test-throws branch 4 times, most recently from 155251f to 849a7a1 Compare December 9, 2017 16:29

BridgeAR approved these changes Dec 9, 2017

View reviewed changes

apapirovski added 2 commits December 9, 2017 11:58

test: use common.expectsError

9d11b02

tools: prefer common.expectsError in tests

a8e3c37

Add lint rule to validate that common.expectsError is being used instead of assert.throws(fn, common.expectsError(err));

apapirovski force-pushed the patch-eslint-test-throws branch from 849a7a1 to a8e3c37 Compare December 9, 2017 16:59

BridgeAR mentioned this pull request Dec 10, 2017

assert: .throws accept objects #17584

Closed

4 tasks

cjihrig approved these changes Dec 11, 2017

View reviewed changes

apapirovski closed this Dec 11, 2017

apapirovski deleted the patch-eslint-test-throws branch December 11, 2017 23:26

apapirovski added a commit that referenced this pull request Dec 11, 2017

test: replace assert.throws w/ common.expectsError

094bfaf

PR-URL: #17557 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

MylesBorins pushed a commit that referenced this pull request Dec 12, 2017

test: replace assert.throws w/ common.expectsError

167daa7

PR-URL: #17557 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

MylesBorins pushed a commit that referenced this pull request Dec 12, 2017

test: replace assert.throws w/ common.expectsError

49d6628

PR-URL: #17557 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

MylesBorins mentioned this pull request Dec 12, 2017

v9.3.0 proposal #17631

Merged

gibfahn added backport-requested-v6.x labels Dec 20, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tools: eslint rule for assert.throws -> common.expectsError #17557

tools: eslint rule for assert.throws -> common.expectsError #17557

apapirovski commented Dec 8, 2017

cjihrig Dec 9, 2017

apapirovski Dec 9, 2017 •

edited

Loading

cjihrig Dec 9, 2017

apapirovski Dec 9, 2017

Trott Dec 9, 2017 •

edited

Loading

apapirovski Dec 9, 2017

not-an-aardvark Dec 9, 2017

cjihrig Dec 9, 2017

Trott commented Dec 9, 2017

apapirovski commented Dec 9, 2017 •

edited

Loading

apapirovski commented Dec 9, 2017 •

edited

Loading

apapirovski commented Dec 9, 2017

BridgeAR commented Dec 9, 2017

apapirovski commented Dec 11, 2017

gibfahn commented Dec 20, 2017

tools: eslint rule for assert.throws -> common.expectsError #17557

tools: eslint rule for assert.throws -> common.expectsError #17557

Conversation

apapirovski commented Dec 8, 2017

Checklist

Affected core subsystem(s)

cjihrig Dec 9, 2017

Choose a reason for hiding this comment

apapirovski Dec 9, 2017 • edited Loading

Choose a reason for hiding this comment

cjihrig Dec 9, 2017

Choose a reason for hiding this comment

apapirovski Dec 9, 2017

Choose a reason for hiding this comment

Trott Dec 9, 2017 • edited Loading

Choose a reason for hiding this comment

apapirovski Dec 9, 2017

Choose a reason for hiding this comment

not-an-aardvark Dec 9, 2017

Choose a reason for hiding this comment

cjihrig Dec 9, 2017

Choose a reason for hiding this comment

Trott commented Dec 9, 2017

apapirovski commented Dec 9, 2017 • edited Loading

apapirovski commented Dec 9, 2017 • edited Loading

apapirovski commented Dec 9, 2017

BridgeAR commented Dec 9, 2017

apapirovski commented Dec 11, 2017

gibfahn commented Dec 20, 2017

apapirovski Dec 9, 2017 •

edited

Loading

Trott Dec 9, 2017 •

edited

Loading

apapirovski commented Dec 9, 2017 •

edited

Loading

apapirovski commented Dec 9, 2017 •

edited

Loading