test, tools: add common.noop and common.mustNotCall lint rule #12027

jasnell · 2017-03-24T19:47:27Z

Throughout the tests, creation of non-op functions is fairly extensive, and it is not uncommon to find common.mustCall(() => {}) or common.mustCall(function() {}), or noop = () => {}; type declarations throughout.

This PR introduces a common.noop non-op function that is used as an alternative to redeclaring nonops all the time.

The common.mustCall() method is also modified such that the fn argument defaults to common.noop if undefined, making it unnecessary to pass in a function when a nonop is needed.

There were also a couple of places where common.mustCall(fn, 0) was used to identify a function that should not be called. These are replace with common.mustNotCall() and a lint rule is added.

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

Affected core subsystem(s)

test, tools

Trott · 2017-03-24T20:18:27Z

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

@@ -0,0 +1,31 @@
+/**
+ * @fileoverview Prefer common.mustNotCall(msg)


Nit: Indicate what you are preferring it over. Maybe Prefer common.mustNotCall(msg) over common.mustCall(fn, 0) or whatever.

(Ah, I see it's also in the message supplied to the user. Might not be terrible to put it in the comment overview too, though.)

Fishrock123

Seems good to me.

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

(LGTM but I'd like more eyes, large changes XD)

gibfahn · 2017-03-25T01:08:46Z

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

+        if (node.callee.property &&
+            node.callee.property.name === 'mustCall') {
+          if (node.arguments.length >= 2) {
+            if (node.arguments[1].value == 0) {


Are you using nested ifs instead of lots of && because it looks cleaner?

Could you at least break these out into one or more helper functions (isCommonMethod(), isMustCall())?

gibfahn · 2017-03-25T01:10:12Z

cc/ @not-an-aardvark, @silverwind, @targos for the eslint side

not-an-aardvark

Linter rule LGTM

cjihrig · 2017-03-25T01:48:52Z

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

+        if (node.callee.property &&
+            node.callee.property.name === 'mustCall') {
+          if (node.arguments.length >= 2) {
+            if (node.arguments[1].value == 0) {


Could you at least break these out into one or more helper functions (isCommonMethod(), isMustCall())?

jasnell · 2017-03-25T02:00:03Z

@cjihrig ... updated! new and improved!

cjihrig · 2017-03-25T02:37:37Z

Beautiful. One thing I just noticed - do you think it's worth adjusting the argument checking in the lint rule, since common.mustCall(0) would be possible now too?

jasnell · 2017-03-25T03:05:40Z

Good point lol

gibfahn · 2017-03-25T12:21:27Z

common.mustCall(0) would be possible now too?

Out of interest, is there a reason to allow common.mustCall(0)? If the linter tells you to replace that with common.mustCall() that makes sense to me.

cjihrig · 2017-03-25T13:20:12Z

The point is that common.mustCall(0) should be caught by the lint rule. It should be replaced with common.mustNotCall(). common.mustCall(0) was not a valid use of mustCall() prior to this PR.

Export a new common.noop no-operation function for general use. Allow using common.mustCall() without a fn argument to simplify test cases. Replace various non-op functions throughout tests with common.noop

Prefer using `common.mustNotCall()` over `common.mustCall(fn, 0)`

jasnell · 2017-03-26T19:09:30Z

@cjihrig ... updated to catch common.mustCall(0)

jasnell · 2017-03-26T19:10:32Z

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

cjihrig · 2017-03-26T19:13:09Z

The rule LGTM. I didn't re-review everything else. I'm assuming that part didn't change.

jasnell · 2017-03-26T19:47:29Z

Only CI failure is unrelated.

Export a new common.noop no-operation function for general use. Allow using common.mustCall() without a fn argument to simplify test cases. Replace various non-op functions throughout tests with common.noop PR-URL: #12027 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Teddy Katz <teddy.katz@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>

Prefer using `common.mustNotCall()` over `common.mustCall(fn, 0)` PR-URL: #12027 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Teddy Katz <teddy.katz@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>

jasnell · 2017-03-26T19:50:44Z

Landed in 4f2e372...20b1823

MylesBorins · 2017-03-28T22:36:34Z

This will need to be manually backported to v7.x

sam-github · 2017-05-15T19:48:07Z

@jasnell this needs backporting, because its absence blocks #11876 (and will probably block more tests from backporting)

gibfahn · 2017-06-17T22:48:04Z

@jasnell would you mind backporting to v6.x-staging?

guide.

MylesBorins · 2017-07-17T15:58:04Z

ping @jasnell one more time for backport

Export a new common.noop no-operation function for general use. Allow using common.mustCall() without a fn argument to simplify test cases. Replace various non-op functions throughout tests with common.noop PR-URL: #12027 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Teddy Katz <teddy.katz@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>

Prefer using `common.mustNotCall()` over `common.mustCall(fn, 0)` PR-URL: #12027 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Teddy Katz <teddy.katz@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>

Export a new common.noop no-operation function for general use. Allow using common.mustCall() without a fn argument to simplify test cases. Replace various non-op functions throughout tests with common.noop PR-URL: #12027 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Teddy Katz <teddy.katz@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>

Prefer using `common.mustNotCall()` over `common.mustCall(fn, 0)` PR-URL: #12027 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Teddy Katz <teddy.katz@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>

nodejs-github-bot added the test Issues and PRs related to the tests. label Mar 24, 2017

Trott reviewed Mar 24, 2017

View reviewed changes

Fishrock123 approved these changes Mar 24, 2017

View reviewed changes

jasnell force-pushed the common-noop branch from f375496 to f4c70c4 Compare March 24, 2017 22:07

richardlau approved these changes Mar 25, 2017

View reviewed changes

gibfahn reviewed Mar 25, 2017

View reviewed changes

gibfahn approved these changes Mar 25, 2017

View reviewed changes

not-an-aardvark approved these changes Mar 25, 2017

View reviewed changes

cjihrig approved these changes Mar 25, 2017

View reviewed changes

jasnell force-pushed the common-noop branch from f4c70c4 to e9a3c84 Compare March 25, 2017 01:59

fhinkel approved these changes Mar 26, 2017

View reviewed changes

jasnell added 2 commits March 26, 2017 12:07

test: add common.noop, default for common.mustCall()

78afc49

Export a new common.noop no-operation function for general use. Allow using common.mustCall() without a fn argument to simplify test cases. Replace various non-op functions throughout tests with common.noop

tools: add rule prefering common.mustNotCall()

5215766

Prefer using `common.mustNotCall()` over `common.mustCall(fn, 0)`

jasnell force-pushed the common-noop branch from e9a3c84 to 5215766 Compare March 26, 2017 19:09

jasnell closed this Mar 26, 2017

MylesBorins added the backport-to-v7.x label Mar 28, 2017

jasnell mentioned this pull request Apr 4, 2017

8.0.0 Release Proposal #12220

Closed

evanlucas mentioned this pull request Apr 25, 2017

stream: Fixes missing 'unpipe' event for pipes made with {end: false} #11876

Closed

3 tasks

gibfahn removed the backport-requested-v7.x label Jun 14, 2017

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

gibfahn added the backport-requested-v6.x label Jun 17, 2017

Trott mentioned this pull request Jul 17, 2017

timers: do not use user object call/apply #12960

Closed

3 tasks

refack mentioned this pull request Jul 17, 2017

test: check number of message events #13125

Closed

2 tasks

MylesBorins added backported-to-v6.x and removed backport-requested-v6.x labels Aug 14, 2017

MylesBorins mentioned this pull request Aug 16, 2017

v6.11.3-proposal #14852

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test, tools: add common.noop and common.mustNotCall lint rule #12027

test, tools: add common.noop and common.mustNotCall lint rule #12027

jasnell commented Mar 24, 2017

Trott Mar 24, 2017

Trott Mar 24, 2017

jasnell Mar 24, 2017

Fishrock123 left a comment

gibfahn Mar 25, 2017

cjihrig Mar 25, 2017

gibfahn commented Mar 25, 2017

not-an-aardvark left a comment

cjihrig Mar 25, 2017

jasnell commented Mar 25, 2017

cjihrig commented Mar 25, 2017

jasnell commented Mar 25, 2017

gibfahn commented Mar 25, 2017

cjihrig commented Mar 25, 2017

jasnell commented Mar 26, 2017

jasnell commented Mar 26, 2017

cjihrig commented Mar 26, 2017

jasnell commented Mar 26, 2017

jasnell commented Mar 26, 2017

MylesBorins commented Mar 28, 2017

sam-github commented May 15, 2017

gibfahn commented Jun 17, 2017

MylesBorins commented Jul 17, 2017

		@@ -0,0 +1,31 @@
		/**
		* @fileoverview Prefer common.mustNotCall(msg)

test, tools: add common.noop and common.mustNotCall lint rule #12027

test, tools: add common.noop and common.mustNotCall lint rule #12027

Conversation

jasnell commented Mar 24, 2017

Checklist

Affected core subsystem(s)

Trott Mar 24, 2017

Choose a reason for hiding this comment

Trott Mar 24, 2017

Choose a reason for hiding this comment

jasnell Mar 24, 2017

Choose a reason for hiding this comment

Fishrock123 left a comment

Choose a reason for hiding this comment

gibfahn Mar 25, 2017

Choose a reason for hiding this comment

cjihrig Mar 25, 2017

Choose a reason for hiding this comment

gibfahn commented Mar 25, 2017

not-an-aardvark left a comment

Choose a reason for hiding this comment

cjihrig Mar 25, 2017

Choose a reason for hiding this comment

jasnell commented Mar 25, 2017

cjihrig commented Mar 25, 2017

jasnell commented Mar 25, 2017

gibfahn commented Mar 25, 2017

cjihrig commented Mar 25, 2017

jasnell commented Mar 26, 2017

jasnell commented Mar 26, 2017

cjihrig commented Mar 26, 2017

jasnell commented Mar 26, 2017

jasnell commented Mar 26, 2017

MylesBorins commented Mar 28, 2017

sam-github commented May 15, 2017

gibfahn commented Jun 17, 2017

MylesBorins commented Jul 17, 2017