Fix(which): match only executable files (#657) #874

termosa · 2018-07-12T19:04:25Z

Fixes #657.

codecov-io · 2018-07-12T20:12:35Z

Codecov Report

Merging #874 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff            @@
##           master    #874      +/-   ##
=========================================
+ Coverage    95.8%   95.8%   +<.01%     
=========================================
  Files          34      34              
  Lines        1263    1264       +1     
=========================================
+ Hits         1210    1211       +1     
  Misses         53      53

Impacted Files	Coverage Δ
src/which.js	`95% <100%> (+0.12%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6d66a1a...ce70542. Read the comment docs.

nfischer

Thanks for the great (and quick) PR!

nfischer · 2018-07-12T21:18:10Z

test/which.js

+
+test('None executable files does not appear in the result list', t => {
+  const commandName = 'node'; // Should be an existing command
+  const pathEnv = process.env.path || process.env.Path || process.env.PATH;


This doesn't look right. This should be process.env.PATH.

Only all-caps $PATH works on unix. On Windows, process.env.path is totally the same as process.env.PATH (and all variations of capitalization of "path").

nfischer · 2018-07-12T21:30:54Z

test/which.js

+  const matchingFile = path.resolve(extraPath, commandName);
+
+  // make sure that file is exists (will throw error otherwise)
+  fs.statSync(matchingFile);


nit: can you make this t.truthy(fs.existsSync())? We generally prefer assertion failures over exceptions.

nfischer · 2018-07-12T21:39:17Z

src/which.js

 // set on Windows.
 var XP_DEFAULT_PATHEXT = '.com;.exe;.bat;.cmd;.vbs;.vbe;.js;.jse;.wsf;.wsh';

+// For earlier versions of NodeJS that doesn't have a list of constants (< v6)


Could you add a TODO to use the node-provided constant on v6+? We'll eventually drop v4/5.

Also, I'm trusting that (1) this value is respected on v4, even though the constant does not exist, and (2) the value is treated the same as F_OK on Windows, just as X_OK is documented:

Flag indicating that the file can be executed by the calling process. This has no effect on Windows (will behave like fs.constants.F_OK).

True, on Windows X_OK and F_OK are equivalent. But on Windows platform file extensions are used to determine if file is executable or not.
I will not do this check for Windows platform.

I will not do this check for Windows platform.

Sounds good

nfischer · 2018-07-12T21:46:45Z

test/which.js

+  t.truthy(resultForWhichA);
+  t.truthy(resultForWhichA.length);
+  t.not(resultForWhich.toString(), matchingFile);
+  t.not(resultForWhichA[0], matchingFile);


Could you rewrite this as:

t.falsy(resultForWhichA.includes(matchingFile));

Also, I think it makes sense to skip this test on Windows, or to assert the array does contain the value on Windows. WDYT?

includes is not handled by Ava and it is not supported in node@5. I would also save [0] index to make sure that order is proper.

nfischer

LGTM % comment.

Also, can you check the coverage on your local machine? codecov says isExecutable() is not covered. If this is a codecov bug, can you add /* istanbul ignore next */ and add a comment mentioning codecov is to blame?

nfischer · 2018-07-15T01:59:18Z

test/which.js

+  t.truthy(resultForWhichA.length);
+  t.not(resultForWhich.toString(), matchingFile);
+  // TODO(node-support): this can be used starting from node@6: t.falsy(resultForWhichA.includes(matchingFile))
+  t.not(resultForWhichA[0], matchingFile);


Sorry, I thought .includes() was added by babel. Could you instead write this as:

t.is(resultForWhichA.indexOf(matchingFile), -1);

That way we have the correct semantics for the assertion.

termosa · 2018-07-18T15:36:50Z

@nfischer done

nfischer · 2018-07-18T22:31:35Z

test/which.js

+  t.not(resultForWhich.toString(), matchingFile);
+  t.is(resultForWhichA.indexOf(matchingFile), -1);
+
+  process.env.PATH = pathEnv;


Oh sorry, I must have missed this. This should go in an test.afterEach.always block. Example:

shelljs/test/exec.js

Lines 14 to 17 in 6d66a1a

test.afterEach.always(() => {

process.chdir(CWD);

shell.config.execPath = ORIG_EXEC_PATH;

});

This shouldn't block this change. I added a comment to #834 to track this.

nfischer · 2018-07-18T22:33:32Z

Thanks @termosa!

termosa added 2 commits July 12, 2018 22:02

fix(which): match only executable files (shelljs#657)

79b8feb

fix(which): replace constant to support earlier versions of NodeJS (s…

644e632

…helljs#657)

termosa force-pushed the b/657/which-finds-executables branch from 2369ccd to 644e632 Compare July 12, 2018 19:51

nfischer reviewed Jul 12, 2018

View reviewed changes

nfischer self-assigned this Jul 12, 2018

fix(which): address @nfischer comments (shelljs#657)

9157b53

termosa force-pushed the b/657/which-finds-executables branch from 51fd66a to 9157b53 Compare July 14, 2018 11:23

nfischer reviewed Jul 15, 2018

View reviewed changes

fix(which): use indexOf (shelljs#657)

ce70542

termosa force-pushed the b/657/which-finds-executables branch from 25232fc to ce70542 Compare July 15, 2018 11:14

nfischer mentioned this pull request Jul 18, 2018

Robustly clean up and restore state after tests #834

Open

nfischer reviewed Jul 18, 2018

View reviewed changes

nfischer approved these changes Jul 18, 2018

View reviewed changes

nfischer merged commit 8dae55f into shelljs:master Jul 18, 2018

termosa deleted the b/657/which-finds-executables branch July 19, 2018 09:26

snyk-bot mentioned this pull request Oct 27, 2019

[Snyk] Upgrade shelljs from 0.8.3 to 0.8.3 ajesse11x/WebGL#5

Open

This was referenced Nov 29, 2019

[Snyk] Upgrade shelljs from 0.3.0 to 0.8.3 sharksandcupcakes/html-inspector#1

Open

[Snyk] Upgrade shelljs from 0.8.2 to 0.8.3 dyna-dot/angular#4

Open

snyk-bot mentioned this pull request Dec 18, 2019

[Snyk] Upgrade shelljs from 0.7.8 to 0.8.3 BeeTech-global/generator-api-ecma6#5

Open

snyk-bot mentioned this pull request Mar 8, 2020

[Snyk] Upgrade shelljs from 0.3.0 to 0.8.3 michelvankessel/colored-coins-copay-wallet#1

Open

This was referenced Mar 24, 2020

[Snyk] Upgrade shelljs from 0.7.8 to 0.8.3 DeviaVir/zenbot#2006

Merged

[Snyk] Upgrade shelljs from 0.7.8 to 0.8.3 DeviaVir/zenbot#2010

Merged

snyk-bot mentioned this pull request Apr 3, 2020

[Snyk] Upgrade shelljs from 0.7.8 to 0.8.3 telegraph/api-responder#2

Open

This was referenced Apr 28, 2020

[Snyk] Upgrade shelljs from 0.8.3 to 0.8.4 DeviaVir/zenbot#2108

Merged

[Snyk] Upgrade shelljs from 0.8.3 to 0.8.4 tobiasbueschel/git-push-pr#51

Merged

nurrony mentioned this pull request Sep 8, 2024

[Snyk] Upgrade: , async-each, git-url-parse, ora, path-exists, shelljs, yargs nurrony/gtni#161

Open

UbyXsofT mentioned this pull request Sep 8, 2024

[Snyk] Upgrade: properties-parser, shelljs UbyXsofT/PENDULUM-METRONOMO#14

Open

	test.afterEach.always(() => {
	process.chdir(CWD);
	shell.config.execPath = ORIG_EXEC_PATH;
	});

Fix(which): match only executable files (#657) #874

Fix(which): match only executable files (#657) #874

Uh oh!

Conversation

termosa commented Jul 12, 2018

Uh oh!

codecov-io commented Jul 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

nfischer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nfischer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

termosa commented Jul 18, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nfischer commented Jul 18, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov-io commented Jul 12, 2018 •

edited

Loading