tools: custom eslint autofix for inspector-check.js #16646

shobhitchittora · 2017-10-31T19:16:47Z

This adds eslint fixer method for inspector-check.js. When running eslint with --fix flag, the fixer will add common.skipIfInspectorDisabled(); to the file automatically.

Refs : #16636

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
Added/Updated the test cases.
Followed commit guidelines.
python ./tools/test.py parallel/test-eslint-inspector-check

Affected core subsystem(s)

Tools

apapirovski

See my comment in the other PR re: creating tests for these to verify they're working as expected. Thanks!

apapirovski · 2017-10-31T20:17:44Z

tools/eslint-rules/inspector-check.js

+        fix: (fixer) => {
+          return fixer.insertTextAfter(
+            node,
+            '\n\n common.skipIfInspectorDisabled();'


What does the node refer to in this context? I feel like this might be getting inserted in the wrong place.

Also, why the errant space after \n\n?

You are right. This inserts the correction at the end of the file. Working on inserting it below require('../common'). Also will fix space after\n\n.

Made a new commit fixing the same. Please verify. Thanks.

BridgeAR

LGTM

BridgeAR · 2017-11-23T22:04:39Z

This needs a rebase.

shobhitchittora · 2017-11-26T06:57:20Z

@BridgeAR Rebased with mater.

addaleax · 2017-11-30T02:15:48Z

CI: https://ci.nodejs.org/job/node-test-commit/14473/

addaleax · 2017-12-01T20:17:14Z

@shobhitchittora Could you run make test on this PR? It looks like the test for this is failing here…

apapirovski · 2017-12-09T20:59:54Z

I won't outright block this but I'm -1 on landing this. I really don't like the idea of auto fixing these skip checks because of the potential for things going really wrong. The fact that it has to lookup an entirely unrelated part of the code to insert the check is concerning. There are so many different possibilities for what a require that passes that RegExp could actually be requiring.

shobhitchittora · 2017-12-10T13:06:24Z

@addaleax I'm getting 68 errors while running make -j4 test on the latest master. Getting errors while Running Markdown linter on docs....

BridgeAR · 2018-01-05T11:47:44Z

@nodejs/collaborators PTAL

BridgeAR

A few comments.

BridgeAR · 2018-01-19T17:02:14Z

tools/eslint-rules/inspector-check.js

  var hasInspectorCheck = false;

  function testInspectorUsage(context, node) {
    if (utils.isRequired(node, ['inspector'])) {
      missingCheckNodes.push(node);
    }
+
+    if (utils.isCommonModule(node)) {
+      commonModuleNodes.push(node);


Since there is only one required (and only one should be present) using an array here is actually not necessary and a simple assign would be enough as well.

Yup correct. Fixing this.

BridgeAR · 2018-01-19T17:02:24Z

tools/eslint-rules/inspector-check.js

@@ -11,16 +11,21 @@ const utils = require('./rules-utils.js');
 // Rule Definition
 //------------------------------------------------------------------------------
 const msg = 'Please add a skipIfInspectorDisabled() call to allow this ' +
-            'test to be skippped when Node is built \'--without-inspector\'.';
+  'test to be skippped when Node is built \'--without-inspector\'.';


Nit: Unrelated change?

BridgeAR · 2018-01-19T17:03:13Z

tools/eslint-rules/rules-utils.js

+    expression.callee &&
+    (expression.callee.name === 'skip' ||
+      expression.callee.property &&
+      expression.callee.property.name === 'skip');


Nit: unrelated change. The same applies to the part above.

BridgeAR · 2018-01-19T17:06:44Z

test/parallel/test-eslint-inspector-check.js

+    'common.skipIfInspectorDisabled(); require("inspector");',
+    `require("common");
+     common.skipIfInspectorDisabled();
+     require("inspector");`


We normally do not use multiline template strings. It will work in this case but it was very hard for me to even see that it is a template string and not three individual entries. So it would be great to change that to either a single line or +.

BridgeAR · 2018-01-19T17:06:47Z

test/parallel/test-eslint-inspector-check.js

+      errors: [{ message }],
+      output: 'require("common");\n' +
+              'common.skipIfInspectorDisabled();\n' +
+              'require("inspector");'


@shobhitchittora is this definitely going to work and will it also insert require("common"); here? Because I do not see this happening in the fixer.

BridgeAR · 2018-01-19T17:09:34Z

Mini-CI (enough to test this): https://ci.nodejs.org/job/node-test-commit-light/146/

BridgeAR · 2018-01-19T17:49:07Z

not ok 460 parallel/test-eslint-inspector-check
  ---
  duration_ms: 0.330
  severity: fail
  stack: |-
    /data/iojs/build/workspace/node-test-commit-linuxone/nodes/rhel72-s390x/tools/node_modules/eslint/lib/testers/rule-tester.js:148
            throw err;
            ^
    
    TypeError: Cannot read property 'range' of undefined

BridgeAR · 2018-01-31T02:04:25Z

Ping @shobhitchittora

shobhitchittora · 2018-01-31T02:45:00Z

@BridgeAR I'm on it.

shobhitchittora

Made the said changes.

shobhitchittora · 2018-02-04T12:32:34Z

Same error here -

=== release test-eslint-inspector-check ===
Path: parallel/test-eslint-inspector-check
assert.js:43
  throw new errors.AssertionError(obj);
  ^

AssertionError [ERR_ASSERTION]: Output is incorrect.

@starkwang How did you check the diffs for the test runner?

BridgeAR · 2018-02-07T03:13:02Z

@shobhitchittora I am not sure what your question is really about. Can you elaborate so someone else might also be able to answer that question?

shobhitchittora · 2018-02-07T03:29:16Z

@BridgeAR I'm stuck as the test for the rule is failing, throwing -

AssertionError [ERR_ASSERTION]: Output is incorrect.

While running - python ./tools/test.py parallel/test-eslint-inspector-check I'd like the test-runner to show me the expected and actual output received, i.e, the diff ( similar to what @starkwang did for a previous PR of ours).

PS: I tried adding/removing 'require("common");\n' + from the output of the test, but it's not working.

BridgeAR

Please check the comments and I recommend to rebase. That way you get a better error output. Please also add a new test case that checks code that imported common.

BridgeAR · 2018-02-10T17:40:14Z

test/parallel/test-eslint-inspector-check.js

+      errors: [{ message }],
+      output: 'require("common");\n' +
+              'common.skipIfInspectorDisabled();\n' +
+              'require("inspector");'


This is very certain not the correct output as common was not imported in the checked code.

BridgeAR · 2018-02-10T17:43:42Z

test/parallel/test-eslint-inspector-check.js

+    'common.skipIfInspectorDisabled(); require("inspector");',
+    'require("common");\n' +
+    'common.skipIfInspectorDisabled();\n' +
+    'require("inspector");'


Please either use a single code line (I would do that as in the example above the added one) or indent the code so the concatenated part is deeper indented than the start of the string.

1. Adds fixer method 2. Extends test 3. Fixes merge issue Refs: nodejs#16636

1. Removes extra indentation 2. Removes array to track commomModule AST node. 3. Refactored test Refs: nodejs#16636

Review comments + updates tests to work with fixer Refs: nodejs#16636

shobhitchittora · 2018-02-15T10:14:44Z

@BridgeAR Hope this does it. Please run the CI on this.

BridgeAR · 2018-02-17T00:49:47Z

tools/eslint-rules/rules-utils.js

+var commonModuleRegExp = new RegExp(/^(\.\.\/)*common(\.js)?$/);
+module.exports.isCommonModule = function(node) {
+  return node.callee.name === 'require' &&
+         commonModuleRegExp.test(node.arguments[0].value);


Here the access to the first argument has to be guarded. In case a node has no arguments, this will trigger an error.

So please add a node.arguments.length !== 0 && in the middle.

BridgeAR · 2018-02-17T00:50:35Z

test/parallel/test-eslint-inspector-check.js

-    'common.skipIfInspectorDisabled(); require("inspector");'
+    'require("common")\n' +
+    'common.skipIfInspectorDisabled();\n' +
+    'require("inspector")'


Can you please indent the last two lines by two spaces? :-)

rules-utils arguments check + spacing in test file Refs: nodejs#16636

BridgeAR

LGTM if CI is green

BridgeAR · 2018-02-17T05:23:42Z

CI https://ci.nodejs.org/job/node-test-commit-light/287/

1. Adds fixer method 2. Extends test PR-URL: nodejs#16646 Refs: nodejs#16636 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

BridgeAR · 2018-02-17T16:16:04Z

Landed in 5156342 🎉

Due to the other rule landing earlier there was a conflict that I resolved while landing.

1. Adds fixer method 2. Extends test PR-URL: #16646 Refs: #16636 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

1. Adds fixer method 2. Extends test PR-URL: nodejs#16646 Refs: nodejs#16636 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

1. Adds fixer method 2. Extends test PR-URL: #16646 Refs: #16636 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

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

shobhitchittora changed the title ~~eslint autofix for inspector-check~~ tools: eslint autofix for inspector-check Oct 31, 2017

shobhitchittora changed the title ~~tools: eslint autofix for inspector-check~~ tools: eslint autofix for inspector-check.js Oct 31, 2017

shobhitchittora changed the title ~~tools: eslint autofix for inspector-check.js~~ tools: custom eslint autofix for inspector-check.js Oct 31, 2017

apapirovski reviewed Oct 31, 2017

View reviewed changes

BridgeAR approved these changes Nov 23, 2017

View reviewed changes

shobhitchittora force-pushed the inspector-check-fix branch from fecdd5f to 0a80a94 Compare November 26, 2017 06:56

addaleax approved these changes Nov 30, 2017

View reviewed changes

addaleax added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. and removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Nov 30, 2017

MylesBorins force-pushed the master branch from b7405ab to 7f086dd Compare December 8, 2017 16:37

shobhitchittora force-pushed the inspector-check-fix branch from 7b44bfb to e61a79e Compare December 10, 2017 12:42

jasnell approved these changes Jan 5, 2018

View reviewed changes

shobhitchittora force-pushed the inspector-check-fix branch from e61a79e to bf946c0 Compare January 5, 2018 17:30

BridgeAR reviewed Jan 19, 2018

View reviewed changes

maclover7 force-pushed the master branch from bb5575a to 993b716 Compare January 26, 2018 22:02

cjihrig force-pushed the master branch from 993b716 to 082f952 Compare January 26, 2018 22:36

shobhitchittora commented Feb 4, 2018

View reviewed changes

BridgeAR requested changes Feb 10, 2018

View reviewed changes

shobhitchittora added 2 commits February 12, 2018 10:44

tools: custom eslint autofix for inspector-check.js

0e860d0

1. Adds fixer method 2. Extends test 3. Fixes merge issue Refs: nodejs#16636

tools: custom eslint autofix for inspector-check.js

4afc45d

1. Removes extra indentation 2. Removes array to track commomModule AST node. 3. Refactored test Refs: nodejs#16636

shobhitchittora force-pushed the inspector-check-fix branch from 4c93df0 to 4afc45d Compare February 12, 2018 05:32

tools: custom eslint autofix for inspector-check.js

c4b5e8b

Review comments + updates tests to work with fixer Refs: nodejs#16636

BridgeAR reviewed Feb 17, 2018

View reviewed changes

tools: custom eslint autofix for inspector-check.js

3b1ce16

rules-utils arguments check + spacing in test file Refs: nodejs#16636

BridgeAR approved these changes Feb 17, 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 Feb 17, 2018

BridgeAR closed this Feb 17, 2018

MylesBorins mentioned this pull request Feb 21, 2018

v9.6.0 proposal #18902

Merged

MylesBorins added the land-on-v8.x label Aug 7, 2018

MylesBorins mentioned this pull request Aug 16, 2018

v8.12.0 proposal #21593

Merged

tools: custom eslint autofix for inspector-check.js #16646

tools: custom eslint autofix for inspector-check.js #16646

Conversation

shobhitchittora commented Oct 31, 2017 • edited

Checklist

Affected core subsystem(s)

apapirovski left a comment

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 left a comment

Choose a reason for hiding this comment

BridgeAR commented Nov 23, 2017

shobhitchittora commented Nov 26, 2017

addaleax commented Nov 30, 2017

addaleax commented Dec 1, 2017

apapirovski commented Dec 9, 2017

shobhitchittora commented Dec 10, 2017

BridgeAR commented Jan 5, 2018

BridgeAR left a comment

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BridgeAR commented Jan 19, 2018

BridgeAR commented Jan 19, 2018

BridgeAR commented Jan 31, 2018

shobhitchittora commented Jan 31, 2018

shobhitchittora left a comment

Choose a reason for hiding this comment

shobhitchittora commented Feb 4, 2018

BridgeAR commented Feb 7, 2018

shobhitchittora commented Feb 7, 2018

BridgeAR left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shobhitchittora commented Feb 15, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BridgeAR left a comment

Choose a reason for hiding this comment

BridgeAR commented Feb 17, 2018

BridgeAR commented Feb 17, 2018

shobhitchittora commented Oct 31, 2017 •

edited