Make path resolution lazy

Author: jdalton

src/commands/raw-npm.ts

@@ -5,8 +5,8 @@ import meow from 'meow'
 
 import constants from '../constants'
 import { commonFlags, validationFlags } from '../flags'
+import { getNpmBinPath } from '../shadow/npm-paths'
 import { getFlagListOutput } from '../utils/output-formatting'
-import { findBinPathDetails } from '../utils/path-resolve'
 
 import type { CliSubcommand } from '../utils/meow-with-subcommands'
 
@@ -62,16 +62,7 @@ async function setupCommand(
     cli.showHelp()
     return
   }
-  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, {
+  const spawnPromise = spawn(getNpmBinPath(), <string[]>argv, {
     signal: abortSignal,
     stdio: 'inherit'
   })

src/commands/raw-npx.ts

@@ -5,8 +5,8 @@ import meow from 'meow'
 
 import constants from '../constants'
 import { commonFlags, validationFlags } from '../flags'
+import { getNpxBinPath } from '../shadow/npm-paths'
 import { getFlagListOutput } from '../utils/output-formatting'
-import { findBinPathDetails } from '../utils/path-resolve'
 
 import type { CliSubcommand } from '../utils/meow-with-subcommands'
 
@@ -62,16 +62,7 @@ async function setupCommand(
     cli.showHelp()
     return
   }
-  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, {
+  const spawnPromise = spawn(getNpxBinPath(), <string[]>argv, {
     signal: abortSignal,
     stdio: 'inherit'
   })

src/shadow/arborist/index.ts

@@ -3,18 +3,18 @@ import { SafeEdge } from './lib/edge'
 import { SafeNode } from './lib/node'
 import { SafeOverrideSet } from './lib/override-set'
 import {
-  arboristClassPath,
-  arboristEdgeClassPath,
-  arboristNodeClassPath,
-  arboristOverrideSetClassPath
+  getArboristClassPath,
+  getArboristEdgeClassPath,
+  getArboristNodeClassPath,
+  getArboristOverrideSetClassPath
 } from '../npm-paths'
 
 export function installSafeArborist() {
   // Override '@npmcli/arborist' module exports with patched variants based on
   // https://github.com/npm/cli/pull/7025.
   const cache: { [key: string]: any } = require.cache
-  cache[arboristClassPath] = { exports: SafeArborist }
-  cache[arboristEdgeClassPath] = { exports: SafeEdge }
-  cache[arboristNodeClassPath] = { exports: SafeNode }
-  cache[arboristOverrideSetClassPath] = { exports: SafeOverrideSet }
+  cache[getArboristClassPath()] = { exports: SafeArborist }
+  cache[getArboristEdgeClassPath()] = { exports: SafeEdge }
+  cache[getArboristNodeClassPath()] = { exports: SafeNode }
+  cache[getArboristOverrideSetClassPath()] = { exports: SafeOverrideSet }
 }

src/shadow/arborist/lib/arborist/index.ts

@@ -1,10 +1,10 @@
 import { kRiskyReify, reify } from './reify'
-import { arboristClassPath } from '../../../npm-paths'
+import { getArboristClassPath } from '../../../npm-paths'
 
 import type { ArboristClass, ArboristReifyOptions } from './types'
 import type { SafeNode } from '../node'
 
-export const Arborist: ArboristClass = require(arboristClassPath)
+export const Arborist: ArboristClass = require(getArboristClassPath())
 
 export const kCtorArgs = Symbol('ctorArgs')
 

src/shadow/arborist/lib/dep-valid.ts

@@ -1,4 +1,4 @@
-import { arboristDepValidPath } from '../../npm-paths'
+import { getArboristDepValidPath } from '../../npm-paths'
 
 import type { SafeNode } from './node'
 
@@ -7,4 +7,4 @@ export const depValid: (
   requested: string,
   accept: string | undefined,
   requester: SafeNode
-) => boolean = require(arboristDepValidPath)
+) => boolean = require(getArboristDepValidPath())

src/shadow/arborist/lib/edge.ts

@@ -1,7 +1,7 @@
 import { depValid } from './dep-valid'
 import { SafeNode } from './node'
 import { SafeOverrideSet } from './override-set'
-import { arboristEdgeClassPath } from '../../npm-paths'
+import { getArboristEdgeClassPath } from '../../npm-paths'
 
 import type { Edge as BaseEdge, DependencyProblem } from '@npmcli/arborist'
 
@@ -56,7 +56,7 @@ export type Explanation = {
   from: object | undefined
 } | null
 
-export const Edge: EdgeClass = require(arboristEdgeClassPath)
+export const Edge: EdgeClass = require(getArboristEdgeClassPath())
 
 // The Edge class makes heavy use of private properties which subclasses do NOT
 // have access to. So we have to recreate any functionality that relies on those

src/shadow/arborist/lib/node.ts

@@ -1,7 +1,7 @@
 import semver from 'semver'
 
 import { SafeOverrideSet } from './override-set'
-import { arboristNodeClassPath } from '../../npm-paths'
+import { getArboristNodeClassPath } from '../../npm-paths'
 import { getLogger } from '../../proc-log'
 
 import type { SafeEdge } from './edge'
@@ -74,7 +74,7 @@ type NodeClass = Omit<
   updateOverridesEdgeInRemoved(otherOverrideSet: SafeOverrideSet): boolean
 }
 
-const Node: NodeClass = require(arboristNodeClassPath)
+const Node: NodeClass = require(getArboristNodeClassPath())
 
 // Implementation code not related to patch https://github.com/npm/cli/pull/7025
 // is based on https://github.com/npm/cli/blob/v11.0.0/workspaces/arborist/lib/node.js:

src/shadow/arborist/lib/override-set.ts

@@ -2,7 +2,7 @@ import npa from 'npm-package-arg'
 import semver from 'semver'
 
 import constants from '../../../constants'
-import { arboristOverrideSetClassPath } from '../../npm-paths'
+import { getArboristOverrideSetClassPath } from '../../npm-paths'
 import { getLogger } from '../../proc-log'
 
 import type { SafeEdge } from './edge'
@@ -31,7 +31,7 @@ interface OverrideSetClass {
   isEqual(otherOverrideSet: SafeOverrideSet | undefined): boolean
 }
 
-const OverrideSet: OverrideSetClass = require(arboristOverrideSetClassPath)
+const OverrideSet: OverrideSetClass = require(getArboristOverrideSetClassPath())
 
 // Implementation code not related to patch https://github.com/npm/cli/pull/7025
 // is based on https://github.com/npm/cli/blob/v11.0.0/workspaces/arborist/lib/override-set.js:

src/shadow/link.ts

@@ -3,29 +3,30 @@ import process from 'node:process'
 
 import cmdShim from 'cmd-shim'
 
+import {
+  getNpmBinPath,
+  getNpxBinPath,
+  isNpmBinPathShadowed,
+  isNpxBinPathShadowed
+} from './npm-paths'
 import constants from '../constants'
-import { findBinPathDetails } from '../utils/path-resolve'
+
+const { NPX } = constants
 
 export async function installLinks(
   realBinPath: string,
   binName: 'npm' | 'npx'
 ): Promise<string> {
+  const isNpx = binName === NPX
   // Find package manager being shadowed by this process.
-  const { path: binPath, shadowed } = 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 binPath = isNpx ? getNpxBinPath() : getNpmBinPath()
   // Lazily access constants.WIN32.
   const { WIN32 } = constants
   // TODO: Is this early exit needed?
   if (WIN32 && binPath) {
     return binPath
   }
+  const shadowed = isNpx ? isNpxBinPathShadowed() : isNpmBinPathShadowed()
   // Move our bin directory to front of PATH so its found first.
   if (!shadowed) {
     if (WIN32) {

src/shadow/npm-paths.ts

@@ -3,38 +3,147 @@ import path from 'node:path'
 import process from 'node:process'
 
 import constants from '../constants'
-import { findNpmPath } from '../utils/path-resolve'
+import { findBinPathDetailsSync, findNpmPathSync } from '../utils/path-resolve'
 
-const { NODE_MODULES, SOCKET_CLI_ISSUES_URL } = constants
+const { NODE_MODULES, NPM, NPX, SOCKET_CLI_ISSUES_URL } = constants
 
-const npmEntrypoint = realpathSync.native(process.argv[1]!)
-const npmPath = findNpmPath(npmEntrypoint)
-if (npmPath === undefined) {
+function exitWithBinPathError(binName: string): never {
   console.error(
-    `Unable to find npm CLI install directory.
-Searched parent directories of ${npmEntrypoint}.
-
-This is may be a bug with socket-npm related to changes to the npm CLI.
-Please report to ${SOCKET_CLI_ISSUES_URL}.`
+    `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.
   process.exit(127)
 }
 
-export const npmNmPath = path.join(npmPath, NODE_MODULES)
-export const arboristPkgPath = path.join(npmNmPath, '@npmcli/arborist')
-export const arboristClassPath = path.join(
-  arboristPkgPath,
-  'lib/arborist/index.js'
-)
-export const arboristDepValidPath = path.join(
-  arboristPkgPath,
-  'lib/dep-valid.js'
-)
-export const arboristEdgeClassPath = path.join(arboristPkgPath, 'lib/edge.js')
-export const arboristNodeClassPath = path.join(arboristPkgPath, 'lib/node.js')
-export const arboristOverrideSetClassPath = path.join(
-  arboristPkgPath,
-  'lib/override-set.js'
-)
+let _npmBinPathDetails: ReturnType<typeof findBinPathDetailsSync> | undefined
+function getNpmBinPathDetails(): ReturnType<typeof findBinPathDetailsSync> {
+  if (_npmBinPathDetails === undefined) {
+    _npmBinPathDetails = findBinPathDetailsSync(NPM)
+  }
+  return _npmBinPathDetails
+}
+
+let _npxBinPathDetails: ReturnType<typeof findBinPathDetailsSync> | undefined
+function getNpxBinPathDetails(): ReturnType<typeof findBinPathDetailsSync> {
+  if (_npxBinPathDetails === undefined) {
+    _npxBinPathDetails = findBinPathDetailsSync(NPX)
+  }
+  return _npxBinPathDetails
+}
+
+let _npmBinPath: string | undefined
+export function getNpmBinPath(): string {
+  if (_npmBinPath === undefined) {
+    _npmBinPath = getNpmBinPathDetails().path
+    if (!_npmBinPath) {
+      exitWithBinPathError(NPM)
+    }
+  }
+  return _npmBinPath
+}
+
+export function isNpmBinPathShadowed() {
+  return getNpmBinPathDetails().shadowed
+}
+
+let _npxBinPath: string | undefined
+export function getNpxBinPath(): string {
+  if (_npxBinPath === undefined) {
+    _npxBinPath = getNpxBinPathDetails().path
+    if (!_npxBinPath) {
+      exitWithBinPathError(NPX)
+    }
+  }
+  return _npxBinPath
+}
+
+export function isNpxBinPathShadowed() {
+  return getNpxBinPathDetails().shadowed
+}
+
+let _npmPath: string | undefined
+export function getNpmPath() {
+  if (_npmPath === undefined) {
+    const npmEntrypoint = path.dirname(realpathSync.native(getNpmBinPath()))
+    _npmPath = findNpmPathSync(npmEntrypoint)
+    if (!_npmPath) {
+      console.error(
+        `Unable to find npm CLI install directory.
+    Searched parent directories of ${npmEntrypoint}.
+
+    This is may be a bug with socket-npm related to changes to the npm CLI.
+    Please report to ${SOCKET_CLI_ISSUES_URL}.`
+      )
+      // The exit code 127 indicates that the command or binary being executed
+      // could not be found.
+      process.exit(127)
+    }
+  }
+  return _npmPath
+}
+
+let _npmNmPath: string | undefined
+export function getNpmNodeModulesPath() {
+  if (_npmNmPath === undefined) {
+    _npmNmPath = path.join(getNpmPath(), NODE_MODULES)
+  }
+  return _npmNmPath
+}
+
+let _arboristPkgPath: string | undefined
+export function getArboristPackagePath() {
+  if (_arboristPkgPath === undefined) {
+    _arboristPkgPath = path.join(getNpmNodeModulesPath(), '@npmcli/arborist')
+  }
+  return _arboristPkgPath
+}
+
+let _arboristClassPath: string | undefined
+export function getArboristClassPath() {
+  if (_arboristClassPath === undefined) {
+    _arboristClassPath = path.join(
+      getArboristPackagePath(),
+      'lib/arborist/index.js'
+    )
+  }
+  return _arboristClassPath
+}
+
+let _arboristDepValidPath: string | undefined
+export function getArboristDepValidPath() {
+  if (_arboristDepValidPath === undefined) {
+    _arboristDepValidPath = path.join(
+      getArboristPackagePath(),
+      'lib/dep-valid.js'
+    )
+  }
+  return _arboristDepValidPath
+}
+
+let _arboristEdgeClassPath: string | undefined
+export function getArboristEdgeClassPath() {
+  if (_arboristEdgeClassPath === undefined) {
+    _arboristEdgeClassPath = path.join(getArboristPackagePath(), 'lib/edge.js')
+  }
+  return _arboristEdgeClassPath
+}
+
+let _arboristNodeClassPath: string | undefined
+export function getArboristNodeClassPath() {
+  if (_arboristNodeClassPath === undefined) {
+    _arboristNodeClassPath = path.join(getArboristPackagePath(), 'lib/node.js')
+  }
+  return _arboristNodeClassPath
+}
+
+let _arboristOverrideSetClassPath: string | undefined
+export function getArboristOverrideSetClassPath() {
+  if (_arboristOverrideSetClassPath === undefined) {
+    _arboristOverrideSetClassPath = path.join(
+      getArboristPackagePath(),
+      'lib/override-set.js'
+    )
+  }
+  return _arboristOverrideSetClassPath
+}