Add signal exits

Author: jdalton

bin/cli.js

@@ -27,9 +27,13 @@ if (DIST_TYPE === 'require') {
       stdio: 'inherit'
     }
   )
-  spawnPromise.process.on('exit', (code, signal) => {
-    if (signal) {
-      process.kill(process.pid, signal)
+  // See https://nodejs.org/api/all.html#all_child_process_event-exit.
+  spawnPromise.process.on('exit', (code, signalName) => {
+    if (abortSignal.aborted) {
+      return
+    }
+    if (signalName) {
+      process.kill(process.pid, signalName)
     } else if (code !== null) {
       process.exit(code)
     }

src/commands/raw-npm.ts

@@ -4,16 +4,19 @@ import meow from 'meow'
 import constants from '../constants'
 import { commonFlags, validationFlags } from '../flags'
 import { printFlagList } from '../utils/formatting'
+import { findBinPathDetails } from '../utils/path-resolve'
 
 import type { CliSubcommand } from '../utils/meow-with-subcommands'
 
 const { abortSignal } = constants
 
+const binName = 'npm'
+
 export const rawNpm: CliSubcommand = {
-  description: 'Temporarily disable the Socket npm wrapper',
+  description: `Temporarily disable the Socket ${binName} wrapper`,
   async run(argv, importMeta, { parentName }) {
     await setupCommand(
-      `${parentName} raw-npm`,
+      `${parentName} raw-${binName}`,
       rawNpm.description,
       argv,
       importMeta
@@ -34,7 +37,7 @@ async function setupCommand(
   const cli = meow(
     `
     Usage
-      $ ${name} <npm command>
+      $ ${name} <${binName} command>
 
     Options
       ${printFlagList(flags, 6)}
@@ -57,13 +60,26 @@ async function setupCommand(
     cli.showHelp()
     return
   }
-  const spawnPromise = spawn('npm', <string[]>argv, {
+  const { path: binPath } = await findBinPathDetails(binName)
+  if (!binPath) {
+    // The exit code 127 indicates that the command or binary being executed
+    // could not be found.
+    console.error(
+      `Socket unable to locate ${binName}; ensure it is available in the PATH environment variable.`
+    )
+    process.exit(127)
+  }
+  const spawnPromise = spawn(binPath, <string[]>argv, {
     signal: abortSignal,
     stdio: 'inherit'
   })
-  spawnPromise.process.on('exit', (code, signal) => {
-    if (signal) {
-      process.kill(process.pid, signal)
+  // See https://nodejs.org/api/all.html#all_child_process_event-exit.
+  spawnPromise.process.on('exit', (code, signalName) => {
+    if (abortSignal.aborted) {
+      return
+    }
+    if (signalName) {
+      process.kill(process.pid, signalName)
     } else if (code !== null) {
       process.exit(code)
     }

src/commands/raw-npx.ts

@@ -4,16 +4,19 @@ import meow from 'meow'
 import constants from '../constants'
 import { commonFlags, validationFlags } from '../flags'
 import { printFlagList } from '../utils/formatting'
+import { findBinPathDetails } from '../utils/path-resolve'
 
 import type { CliSubcommand } from '../utils/meow-with-subcommands'
 
 const { abortSignal } = constants
 
+const binName = 'npx'
+
 export const rawNpx: CliSubcommand = {
-  description: 'Temporarily disable the Socket npm/npx wrapper',
+  description: `Temporarily disable the Socket ${binName} wrapper`,
   async run(argv, importMeta, { parentName }) {
     await setupCommand(
-      `${parentName} raw-npx`,
+      `${parentName} raw-${binName}`,
       rawNpx.description,
       argv,
       importMeta
@@ -34,7 +37,7 @@ async function setupCommand(
   const cli = meow(
     `
     Usage
-      $ ${name} <npx command>
+      $ ${name} <${binName} command>
 
     Options
       ${printFlagList(flags, 6)}
@@ -57,13 +60,26 @@ async function setupCommand(
     cli.showHelp()
     return
   }
-  const spawnPromise = spawn('npx', [argv.join(' ')], {
+  const { path: binPath } = await findBinPathDetails(binName)
+  if (!binPath) {
+    // The exit code 127 indicates that the command or binary being executed
+    // could not be found.
+    console.error(
+      `Socket unable to locate ${binName}; ensure it is available in the PATH environment variable.`
+    )
+    process.exit(127)
+  }
+  const spawnPromise = spawn(binPath, <string[]>argv, {
     signal: abortSignal,
     stdio: 'inherit'
   })
-  spawnPromise.process.on('exit', (code, signal) => {
-    if (signal) {
-      process.kill(process.pid, signal)
+  // See https://nodejs.org/api/all.html#all_child_process_event-exit.
+  spawnPromise.process.on('exit', (code, signalName) => {
+    if (abortSignal.aborted) {
+      return
+    }
+    if (signalName) {
+      process.kill(process.pid, signalName)
     } else if (code !== null) {
       process.exit(code)
     }

src/shadow/link.ts

@@ -1,10 +1,9 @@
-import { realpathSync } from 'node:fs'
 import path from 'node:path'
 
 import cmdShim from 'cmd-shim'
-import which from 'which'
 
 import constants from '../constants'
+import { findBinPathDetails } from '../utils/path-resolve'
 
 const { WIN32, rootDistPath } = constants
 
@@ -13,34 +12,21 @@ export async function installLinks(
   binName: 'npm' | 'npx'
 ): Promise<string> {
   // Find package manager being shadowed by this process.
-  const bins =
-    (await which(binName, {
-      all: true,
-      nothrow: true
-    })) ?? []
-  let shadowIndex = -1
-  const binPath = bins.find((binPath, i) => {
-    // Skip our bin directory if it's in the front.
-    if (realpathSync(path.dirname(binPath)) === realBinPath) {
-      shadowIndex = i
-      return false
-    }
-    return true
-  })
+  const { path: binPath, shadowed } = await findBinPathDetails(binName)
   if (!binPath) {
-    console.error(
-      `Socket unable to locate ${binName}; ensure it is available in the PATH environment variable`
-    )
     // The exit code 127 indicates that the command or binary being executed
     // could not be found.
+    console.error(
+      `Socket unable to locate ${binName}; ensure it is available in the PATH environment variable.`
+    )
     process.exit(127)
   }
   // TODO: Is this early exit needed?
   if (WIN32 && binPath) {
     return binPath
   }
   // Move our bin directory to front of PATH so its found first.
-  if (shadowIndex === -1) {
+  if (!shadowed) {
     if (WIN32) {
       await cmdShim(
         path.join(rootDistPath, `${binName}-cli.js`),

src/shadow/shadow-bin.ts

@@ -11,16 +11,17 @@ const { abortSignal, distPath, execPath, shadowBinPath } = constants
 
 const injectionPath = path.join(distPath, 'npm-injection.js')
 
-export default async function shadow(binName: 'npm' | 'npx') {
+export default async function shadow(
+  binName: 'npm' | 'npx',
+  binArgs = process.argv.slice(2)
+) {
   const binPath = await installLinks(shadowBinPath, binName)
   if (abortSignal.aborted) {
     return
   }
   // Adding the `--quiet` and `--no-progress` flags when the `proc-log` module
   // is found to fix a UX issue when running the command with recent versions of
   // npm (input swallowed by the standard npm spinner)
-  const binArgs: string[] = process.argv.slice(2)
-
   if (
     binName === 'npm' &&
     binArgs.includes('install') &&
@@ -60,9 +61,13 @@ export default async function shadow(binName: 'npm' | 'npx') {
       stdio: 'inherit'
     }
   )
-  spawnPromise.process.on('exit', (code, signal) => {
-    if (signal) {
-      process.kill(process.pid, signal)
+  // See https://nodejs.org/api/all.html#all_child_process_event-exit.
+  spawnPromise.process.on('exit', (code, signalName) => {
+    if (abortSignal.aborted) {
+      return
+    }
+    if (signalName) {
+      process.kill(process.pid, signalName)
     } else if (code !== null) {
       process.exit(code)
     }