Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 4 commits into from Jul 18, 2018
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 13 additions & 1 deletion src/which.js
Expand Up @@ -13,13 +13,25 @@ common.register('which', _which, {
// 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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will not do this check for Windows platform.

Sounds good

var FILE_EXECUTABLE_MODE = 1;

// Cross-platform method for splitting environment `PATH` variables
function splitPath(p) {
return p ? p.split(path.delimiter) : [];
}

function isExecutable(pathName) {
try {
fs.accessSync(pathName, FILE_EXECUTABLE_MODE);
} catch (err) {
return false;
}
return true;
}

function checkPath(pathName) {
return fs.existsSync(pathName) && !common.statFollowLinks(pathName).isDirectory();
return fs.existsSync(pathName) && !common.statFollowLinks(pathName).isDirectory() && isExecutable(pathName);
}

//@
Expand Down
1 change: 1 addition & 0 deletions test/resources/which/node
@@ -0,0 +1 @@
text file, not an executable
23 changes: 22 additions & 1 deletion test/which.js
@@ -1,4 +1,5 @@
import fs from 'fs';
import path from 'path';

import test from 'ava';

Expand Down Expand Up @@ -69,5 +70,25 @@ test('Searching with -a flag returns an array with first item equals to the regu
t.falsy(shell.error());
t.truthy(resultForWhich);
t.truthy(resultForWhichA);
t.is(resultForWhich.toString(), resultForWhichA[0].toString());
t.is(resultForWhich.toString(), resultForWhichA[0]);
});

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;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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").

const extraPath = path.resolve(__dirname, 'resources', 'which');
const matchingFile = path.resolve(extraPath, commandName);

// make sure that file is exists (will throw error otherwise)
fs.statSync(matchingFile);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


process.env.path = process.env.Path = process.env.PATH = extraPath + path.delimiter + pathEnv;
const resultForWhich = shell.which(commandName);
const resultForWhichA = shell.which('-a', commandName);
t.falsy(shell.error());
t.truthy(resultForWhich);
t.truthy(resultForWhichA);
t.truthy(resultForWhichA.length);
t.not(resultForWhich.toString(), matchingFile);
t.not(resultForWhichA[0], matchingFile);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

});