introduce socket-npm and socket-npx

Author: bmeck

.eslintrc

@@ -6,6 +6,9 @@
   "parserOptions": {
     "project": "./tsconfig.json"
   },
+  "ignorePatterns": [
+    "lib/shadow/bin"
+  ],
   "rules": {
     "@typescript-eslint/quotes": ["error", "single", { "avoidEscape": true, "allowTemplateLiterals": false }],
     "no-console": "warn"

.gitignore

@@ -6,6 +6,8 @@
 /.nyc_output
 /.vscode
 
+/lib/shadow/bin
+
 # We're a library, so please, no lock files
 /package-lock.json
 /yarn.lock

lib/commands/index.js

@@ -1,2 +1,4 @@
 export * from './info/index.js'
 export * from './report/index.js'
+export * from './npm/index.js'
+export * from './npx/index.js'

lib/commands/npm/index.js

@@ -0,0 +1,22 @@
+import { spawn } from 'child_process'
+import { fileURLToPath } from 'url'
+
+const description = 'npm wrapper functionality'
+
+/** @type {import('../../utils/meow-with-subcommands').CliSubcommand} */
+export const npm = {
+  description,
+  run: async (argv, _importMeta, _ctx) => {
+    const wrapperPath = fileURLToPath(new URL('../../shadow/npm-cli.cjs', import.meta.url))
+    process.exitCode = 1
+    spawn(process.execPath, [wrapperPath, ...argv], {
+      stdio: 'inherit'
+    }).on('exit', (code, signal) => {
+      if (signal) {
+        process.kill(process.pid, signal)
+      } else if (code !== null) {
+        process.exit(code)
+      }
+    })
+  }
+}

lib/commands/npx/index.js

@@ -0,0 +1,22 @@
+import { spawn } from 'child_process'
+import { fileURLToPath } from 'url'
+
+const description = 'npx wrapper functionality'
+
+/** @type {import('../../utils/meow-with-subcommands').CliSubcommand} */
+export const npx = {
+  description,
+  run: async (argv, _importMeta, _ctx) => {
+    const wrapperPath = fileURLToPath(new URL('../../shadow/npx-cli.cjs', import.meta.url))
+    process.exitCode = 1
+    spawn(process.execPath, [wrapperPath, ...argv], {
+      stdio: 'inherit'
+    }).on('exit', (code, signal) => {
+      if (signal) {
+        process.kill(process.pid, signal)
+      } else if (code !== null) {
+        process.exit(code)
+      }
+    })
+  }
+}

lib/shadow/link.cjs

@@ -0,0 +1,43 @@
+/* eslint-disable no-console */
+const { chmodSync, realpathSync } = require('fs')
+const path = require('path')
+
+const which = require('which')
+
+/**
+ * @param {string} realDirname path to shadow/bin
+ * @param {'npm' | 'npx'} binname
+ * @returns {string} path to npm provided cli / npx bin
+ */
+function installLinks (realDirname, binname) {
+  const realNpmShadowBinDir = realDirname
+  // find npm being shadowed by this process
+  const npms = which.sync(binname, {
+    all: true
+  })
+  let shadowIndex = -1
+  const npmpath = npms.find((npmPath, i) => {
+    const isShadow = realpathSync(path.dirname(npmPath)) === realNpmShadowBinDir
+    if (isShadow) {
+      shadowIndex = i
+    }
+    return !isShadow
+  })
+  if (!npmpath) {
+    console.error('Socket unable to locate npm ensure it is available in the PATH environment variable')
+    process.exit(127)
+  }
+  if (shadowIndex === -1) {
+    chmodSync(realNpmShadowBinDir, parseInt('755', 8))
+    const bindir = path.join(realDirname)
+    process.env['PATH'] = `${
+      bindir
+    }${
+      process.platform === 'win32' ? ';' : ':'
+    }${
+      process.env['PATH']
+    }`
+  }
+  return npmpath
+}
+module.exports = installLinks

lib/shadow/npm-cli.cjs

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+// THIS FILE USES .cjs to get around the extension-free entrypoint problem with ESM
+'use strict'
+const { spawn } = require('child_process')
+const { realpathSync } = require('fs')
+const path = require('path')
+
+const realFilename = realpathSync(__filename)
+const realDirname = path.dirname(realFilename)
+
+/**
+ */
+async function main () {
+  const npmpath = await require('./link.cjs')(path.join(realDirname, 'bin'), 'npm')
+  process.exitCode = 1
+  const injectionpath = path.join(realDirname, 'npm-injection.cjs')
+  spawn(process.execPath, ['--require', injectionpath, npmpath, ...process.argv.slice(2)], {
+    stdio: 'inherit'
+  }).on('exit', (code, signal) => {
+    if (signal) {
+      process.kill(process.pid, signal)
+    } else if (code !== null) {
+      process.exit(code)
+    }
+  })
+}
+main()