Make abortSignal a constant

Author: jdalton

bin/cli.js

@@ -3,34 +3,28 @@
 
 const constants = require('../dist/constants')
 
-const { DIST_TYPE, execPath } = constants
+const { DIST_TYPE } = constants
 
 if (DIST_TYPE === 'require') {
-  require(`../dist/require/cli.js`)
+  require(`../dist/${DIST_TYPE}/cli.js`)
 } else {
   const path = require('node:path')
   const spawn = require('@npmcli/promise-spawn')
-  const { onExit } = require('signal-exit')
 
-  const abortController = new AbortController()
-  const { signal: abortSignal } = abortController
-
-  // Detect ^C, i.e. Ctrl + C.
-  onExit(() => {
-    abortController.abort()
-  })
+  const { abortSignal, execPath, rootDistPath } = constants
 
+  process.exitCode = 1
   const spawnPromise = spawn(
     execPath,
     [
       // Lazily access constants.nodeNoWarningsFlags.
       ...constants.nodeNoWarningsFlags,
-      path.join(constants.rootDistPath, DIST_TYPE, 'cli.js'),
+      path.join(rootDistPath, DIST_TYPE, 'cli.js'),
       ...process.argv.slice(2)
     ],
     {
-      stdio: 'inherit',
-      signal: abortSignal
+      signal: abortSignal,
+      stdio: 'inherit'
     }
   )
   spawnPromise.process.on('exit', (code, signal) => {

src/commands/npm.ts

@@ -6,7 +6,7 @@ import constants from '../constants'
 
 import type { CliSubcommand } from '../utils/meow-with-subcommands'
 
-const { execPath, rootBinPath } = constants
+const { abortSignal, execPath, rootBinPath } = constants
 
 const description = 'npm wrapper functionality'
 
@@ -23,7 +23,10 @@ export const npm: CliSubcommand = {
         wrapperPath,
         ...argv
       ],
-      { stdio: 'inherit' }
+      {
+        signal: abortSignal,
+        stdio: 'inherit'
+      }
     )
     spawnPromise.process.on('exit', (code, signal) => {
       if (signal) {

src/commands/npx.ts

@@ -6,7 +6,7 @@ import constants from '../constants'
 
 import type { CliSubcommand } from '../utils/meow-with-subcommands'
 
-const { execPath, rootBinPath } = constants
+const { abortSignal, execPath, rootBinPath } = constants
 
 const description = 'npx wrapper functionality'
 
@@ -23,7 +23,10 @@ export const npx: CliSubcommand = {
         wrapperPath,
         ...argv
       ],
-      { stdio: 'inherit' }
+      {
+        abortSignal,
+        stdio: 'inherit'
+      }
     )
     spawnPromise.process.on('exit', (code, signal) => {
       if (signal) {

src/commands/optimize.ts

@@ -42,8 +42,12 @@ import type { Spinner } from '@socketregistry/yocto-spinner'
 
 type PackageJson = Awaited<ReturnType<typeof readPackageJson>>
 
-const { UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE, execPath, rootBinPath } =
-  constants
+const {
+  UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE,
+  abortSignal,
+  execPath,
+  rootBinPath
+} = constants
 
 const COMMAND_TITLE = 'Socket Optimize'
 const OVERRIDES_FIELD_NAME = 'overrides'
@@ -896,6 +900,7 @@ export const optimize: CliSubcommand = {
         if (isNpm) {
           const wrapperPath = path.join(rootBinPath, 'npm-cli.js')
           const npmSpawnOptions: Parameters<typeof spawn>[2] = {
+            signal: abortSignal,
             stdio: 'ignore',
             env: {
               ...process.env,
@@ -923,7 +928,10 @@ export const optimize: CliSubcommand = {
           )
         } else {
           // All package managers support the "install" command.
-          await spawn(agentExecPath, ['install'], { stdio: 'ignore' })
+          await spawn(agentExecPath, ['install'], {
+            signal: abortSignal,
+            stdio: 'ignore'
+          })
         }
         spinner.stop()
         if (isNpm) {

src/commands/raw-npm.ts

@@ -1,11 +1,14 @@
 import spawn from '@npmcli/promise-spawn'
 import meow from 'meow'
 
+import constants from '../constants'
 import { commonFlags, validationFlags } from '../flags'
 import { printFlagList } from '../utils/formatting'
 
 import type { CliSubcommand } from '../utils/meow-with-subcommands'
 
+const { abortSignal } = constants
+
 export const rawNpm: CliSubcommand = {
   description: 'Temporarily disable the Socket npm wrapper',
   async run(argv, importMeta, { parentName }) {
@@ -55,6 +58,7 @@ async function setupCommand(
     return
   }
   const spawnPromise = spawn('npm', <string[]>argv, {
+    signal: abortSignal,
     stdio: 'inherit'
   })
   spawnPromise.process.on('exit', (code, signal) => {

src/commands/raw-npx.ts

@@ -1,11 +1,14 @@
 import spawn from '@npmcli/promise-spawn'
 import meow from 'meow'
 
+import constants from '../constants'
 import { commonFlags, validationFlags } from '../flags'
 import { printFlagList } from '../utils/formatting'
 
 import type { CliSubcommand } from '../utils/meow-with-subcommands'
 
+const { abortSignal } = constants
+
 export const rawNpx: CliSubcommand = {
   description: 'Temporarily disable the Socket npm/npx wrapper',
   async run(argv, importMeta, { parentName }) {
@@ -55,6 +58,7 @@ async function setupCommand(
     return
   }
   const spawnPromise = spawn('npx', [argv.join(' ')], {
+    signal: abortSignal,
     stdio: 'inherit'
   })
   spawnPromise.process.on('exit', (code, signal) => {

src/constants.ts

@@ -1,6 +1,8 @@
 import { realpathSync } from 'node:fs'
 import path from 'node:path'
 
+import { onExit } from 'signal-exit'
+
 import { envAsBoolean } from '@socketsecurity/registry/lib/env'
 import registryConstants from '@socketsecurity/registry/lib/constants'
 
@@ -43,6 +45,14 @@ const LAZY_DIST_TYPE = () =>
 
 const lazyDistPath = () => path.join(rootDistPath, constants.DIST_TYPE)
 
+const abortController = new AbortController()
+const { signal: abortSignal } = abortController
+
+// Detect ^C, i.e. Ctrl + C.
+onExit(() => {
+  abortController.abort()
+})
+
 const constants = <
   {
     readonly API_V0_URL: 'https://api.socket.dev/v0'
@@ -51,6 +61,8 @@ const constants = <
     readonly NPM_REGISTRY_URL: 'https://registry.npmjs.org'
     readonly SOCKET_CLI_ISSUES_URL: 'https://github.com/SocketDev/socket-cli/issues'
     readonly UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE: 'UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE'
+    readonly abortController: typeof abortController
+    readonly abortSignal: typeof abortSignal
     readonly cdxgenBinPath: string
     readonly distPath: string
     readonly nmBinPath: string
@@ -70,6 +82,8 @@ const constants = <
     NPM_REGISTRY_URL,
     SOCKET_CLI_ISSUES_URL,
     UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE,
+    abortController,
+    abortSignal,
     cdxgenBinPath,
     distPath: undefined,
     nmBinPath,

src/shadow/arborist.ts

@@ -10,7 +10,6 @@ import yoctoSpinner from '@socketregistry/yocto-spinner'
 import isInteractive from 'is-interactive'
 import npa from 'npm-package-arg'
 import semver from 'semver'
-import { onExit } from 'signal-exit'
 
 import config from '@socketsecurity/config'
 import { isObject } from '@socketsecurity/registry/lib/objects'
@@ -223,6 +222,7 @@ const {
   SOCKET_CLI_ISSUES_URL,
   SOCKET_PUBLIC_API_KEY,
   UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE,
+  abortSignal,
   rootPath
 } = constants
 
@@ -300,14 +300,6 @@ const pacote = tryRequire(<'pacote'>path.join(npmNmPath, 'pacote'), 'pacote')!
 const { tarball } = pacote
 const translations = require(path.join(rootPath, 'translations.json'))
 
-const abortController = new AbortController()
-const { signal: abortSignal } = abortController
-
-// Detect ^C, i.e. Ctrl + C.
-onExit(() => {
-  abortController.abort()
-})
-
 const Arborist: ArboristClass = require(arboristClassPath)
 const depValid: (
   child: NodeClass,

src/shadow/link.ts

@@ -13,9 +13,11 @@ export async function installLinks(
   binName: 'npm' | 'npx'
 ): Promise<string> {
   // Find package manager being shadowed by this process.
-  const bins = await which(binName, {
-    all: true
-  })
+  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.

src/shadow/shadow-bin.ts

@@ -7,12 +7,15 @@ import constants from '../constants'
 import { installLinks } from './link'
 import { findRoot } from '../utils/path-resolve'
 
-const { distPath, execPath, shadowBinPath } = constants
+const { abortSignal, distPath, execPath, shadowBinPath } = constants
 
 const injectionPath = path.join(distPath, 'npm-injection.js')
 
 export default async function shadow(binName: 'npm' | 'npx') {
   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)
@@ -52,7 +55,10 @@ export default async function shadow(binName: 'npm' | 'npx') {
       binPath,
       ...binArgs
     ],
-    { stdio: 'inherit' }
+    {
+      signal: abortSignal,
+      stdio: 'inherit'
+    }
   )
   spawnPromise.process.on('exit', (code, signal) => {
     if (signal) {