Add workaround for npm cmd shims (#109)

Author: jasongin

.appveyor.yml

@@ -1,6 +1,6 @@
 version: "{build}"
 environment:
-  nodejs_version: 6
+  nodejs_version: 10
   nodejs_arch: x64
 install:
 - ps: Install-Product node $env:nodejs_version $env:nodejs_arch

.eslintignore

@@ -1,2 +1,3 @@
+node_modules/
 deps/
 test/temp/

.travis.yml

@@ -3,7 +3,7 @@ os:
 - osx
 language: node_js
 node_js:
-- "6"
+- "10"
 addons:
   apt:
     packages:

lib/addRemove.js

@@ -15,6 +15,8 @@ const NodeVersion = require('./version');
 let nvsDownload = null;  // Delay-load
 let nvsExtract = null;  // Delay-load
 
+const isWindows = process.platform === 'win32';
+
 /**
  * Downloads and extracts a version of node.
  *
@@ -163,6 +165,8 @@ function downloadAndExtractAsync(version) {
 				}
 			});
 		}
+
+		return fixNpmCmdShimsAsync(targetDir);
 	}).catch(e => {
 		removeDirectoryIfEmpty(targetDir);
 		removeDirectoryIfEmpty(path.dirname(targetDir));
@@ -272,6 +276,53 @@ function removeDirectoryIfEmpty(dir) {
 	}
 }
 
+/**
+ * Fix Windows .cmd shims for npm executables, which are installed incorrectly
+ * by Node.js and may block global npm package updates.
+ *
+ * @param {string} targetDir Directory where a node version was extracted.
+ */
+async function fixNpmCmdShimsAsync(targetDir) {
+	if (!isWindows) return;
+
+	try {
+		// This assumes the npm version carried with the node installation
+		// includes a `cmd-shim` module. Currently true for at least npm >= 3.
+		const cmdShimPath = path.join(
+			targetDir, 'node_modules', 'npm', 'node_modules', 'cmd-shim');
+		const cmdShim = require(cmdShimPath);
+
+		// Enumerate .cmd files in the target directory and fix if they are shims.
+		for (let childName of fs.readdirSync(targetDir)) {
+			if (path.extname(childName).toLowerCase() !== '.cmd') {
+				continue;
+			}
+
+			const cmdName = path.basename(childName, '.cmd');
+			const shimPath = path.join(targetDir, cmdName);
+			const jsCliPath = path.join(
+				targetDir, 'node_modules', 'npm', 'bin', `${cmdName}-cli.js`);
+			if (!fs.existsSync(jsCliPath)) {
+				// A corresponding JS CLI file does not exist in the npm bin dir.
+				// Probably this is some other .cmd file that isn't an npm shim.
+				continue;
+			}
+
+			// Found an npm shim. Call the cmd-shim module to fix it.
+			await new Promise((resolve, reject) => {
+				cmdShim(jsCliPath, shimPath, (e) => {
+					if (e) reject(e);
+					else resolve();
+				});
+			});
+		}
+	} catch (e) {
+		// Not a fatal error. Most things still work if the shims are not fixed.
+		// The only problem may be that the global npm package cannot be upgraded.
+		console.warn('Warning: Failed to fix npm cmd shims: ' + e.message);
+	}
+}
+
 module.exports = {
 	addAsync,
 	remove,

test/cli/bashTests.js

@@ -8,7 +8,7 @@ const nvsRootDir = path.resolve(__dirname, '..', '..');
 const testParentDir = path.resolve(__dirname, '..', 'temp');
 const testDir = path.join(testParentDir, 'bash');
 
-const testNodeVersion = '6.10.3';
+const testNodeVersion = '8.5.0';
 
 test.before(t => {
 	require('../fsUtil').createDirectoryIfNotFound(testParentDir);
@@ -26,7 +26,7 @@ test('Bash CLI', t => {
 	const commands = [
 		'echo $NVS_HOME',
 		'. ./nvs.sh',
-		'nvs lsr',
+		'nvs lsr 8',
 		'nvs add ' + testNodeVersion,
 		'nvs link ' + testNodeVersion,
 		'nvs use',

test/cli/cmdTests.js

@@ -8,7 +8,8 @@ const nvsRootDir = path.resolve(__dirname, '..', '..');
 const testParentDir = path.resolve(__dirname, '..', 'temp');
 const testDir = path.join(testParentDir, 'cmd');
 
-const testNodeVersion = '6.10.3';
+const testNodeVersion = '8.5.0';
+const testNpmVersion = '6.4.1';
 
 test.before(t => {
 	require('../fsUtil').createDirectoryIfNotFound(testParentDir);
@@ -25,12 +26,14 @@ if (process.platform !== 'win32') {
 test('Command Prompt CLI', t => {
 	const commands = [
 		'echo %NVS_HOME%',
-		'.\\nvs.cmd lsr',
+		'.\\nvs.cmd lsr 8',
 		'.\\nvs.cmd add ' + testNodeVersion,
 		'.\\nvs.cmd link ' + testNodeVersion,
 		'.\\nvs.cmd use',
 		'echo !PATH!',
 		'node -v',
+		'npm install -g npm@' + testNpmVersion,
+		'npm -v',
 		'.\\nvs.cmd unlink',
 		'rd /q /s %NVS_HOME%',
 	];
@@ -56,4 +59,5 @@ test('Command Prompt CLI', t => {
 		});
 	const output = result.stdout.toString().trim().replace(/\r\n/g, '\n');
 	t.regex(output, new RegExp('\n> node -v *\nv' + testNodeVersion + ' *\n', 'm'));
+	t.regex(output, new RegExp('\n> npm -v *\n' + testNpmVersion + ' *\n', 'm'));
 });

test/cli/gitBashTests.js

@@ -8,7 +8,8 @@ const nvsRootDir = path.resolve(__dirname, '..', '..');
 const testParentDir = path.resolve(__dirname, '..', 'temp');
 const testDir = path.join(testParentDir, 'git-bash');
 
-const testNodeVersion = '6.10.3';
+const testNodeVersion = '8.5.0';
+const testNpmVersion = '6.4.1';
 
 test.before(t => {
 	require('../fsUtil').createDirectoryIfNotFound(testParentDir);
@@ -26,12 +27,17 @@ test('Git Bash CLI', t => {
 	const commands = [
 		'echo $NVS_HOME',
 		'. ./nvs.sh',
-		'nvs lsr',
+		'nvs lsr 8',
 		'nvs add ' + testNodeVersion,
 		'nvs link ' + testNodeVersion,
 		'nvs use',
 		'echo $PATH',
 		'node -v',
+		// `npm install -g npm` doesn't work in Git bash, because the `npm` script file
+		// (being executed) is locked while the npm install process tries to update it.
+		// The workaround is to run the command via cmd.exe outside of bash.
+		`cmd "/C npm install -g npm@${testNpmVersion}"`,
+		'npm -v',
 		'nvs unlink',
 		'rm -rf $NVS_HOME',
 	];
@@ -55,4 +61,5 @@ test('Git Bash CLI', t => {
 		});
 	const output = result.stdout.toString().trim().replace(/\r\n/g, '\n');
 	t.regex(output, new RegExp('\n> node -v *\nv' + testNodeVersion + ' *\n', 'm'));
+	t.regex(output, new RegExp('\n> npm -v *\n' + testNpmVersion + ' *\n', 'm'));
 });

test/cli/psTests.js

@@ -8,7 +8,8 @@ const nvsRootDir = path.resolve(__dirname, '..', '..');
 const testParentDir = path.resolve(__dirname, '..', 'temp');
 const testDir = path.join(testParentDir, 'ps');
 
-const testNodeVersion = '6.10.3';
+const testNodeVersion = '8.5.0';
+const testNpmVersion = '6.4.1';
 
 test.before(t => {
 	require('../fsUtil').createDirectoryIfNotFound(testParentDir);
@@ -25,12 +26,14 @@ if (process.platform !== 'win32') {
 test('PowerShell CLI', t => {
 	const commands = [
 		'echo $env:NVS_HOME',
-		'.\\nvs.ps1 lsr',
+		'.\\nvs.ps1 lsr 8',
 		'.\\nvs.ps1 add ' + testNodeVersion,
 		'.\\nvs.ps1 link ' + testNodeVersion,
 		'.\\nvs.ps1 use',
 		'echo $env:PATH',
 		'node -v',
+		'npm install -g npm@' + testNpmVersion,
+		'npm -v',
 		'.\\nvs.ps1 unlink',
 		'Remove-Item -Recurse -Force $env:NVS_HOME',
 	];
@@ -51,6 +54,8 @@ test('PowerShell CLI', t => {
 			},
 			cwd: nvsRootDir,
 		});
+
 	const output = result.stdout.toString().trim().replace(/\r\n/g, '\n');
 	t.regex(output, new RegExp('\n> node -v *\nv' + testNodeVersion + ' *\n', 'm'));
+	t.regex(output, new RegExp('\n> npm -v *\n' + testNpmVersion + ' *\n', 'm'));
 });

test/cli/zshTests.js

@@ -8,7 +8,7 @@ const nvsRootDir = path.resolve(__dirname, '..', '..');
 const testParentDir = path.resolve(__dirname, '..', 'temp');
 const testDir = path.join(testParentDir, 'zsh');
 
-const testNodeVersion = '6.10.3';
+const testNodeVersion = '8.5.0';
 
 test.before(t => {
 	require('../fsUtil').createDirectoryIfNotFound(testParentDir);
@@ -26,7 +26,7 @@ test('Zsh CLI', t => {
 	const commands = [
 		'echo $NVS_HOME',
 		'. ./nvs.sh',
-		'nvs lsr',
+		'nvs lsr 8',
 		'nvs add ' + testNodeVersion,
 		'nvs link ' + testNodeVersion,
 		'nvs use',