Use methods instead of maps for agent specific actions

jdalton · jdalton · commit ff5788afbcc5 · 2025-07-17T10:32:15.000-04:00
diff --git a/src/commands/optimize/add-overrides.mts b/src/commands/optimize/add-overrides.mts
@@ -8,25 +8,24 @@ import { fetchPackageManifest } from '@socketsecurity/registry/lib/packages'
 import { pEach } from '@socketsecurity/registry/lib/promises'
 import { Spinner } from '@socketsecurity/registry/lib/spinner'
 
-import { depsIncludesByAgent } from './deps-includes-by-agent.mts'
+import { lsStdoutIncludes } from './deps-includes-by-agent.mts'
 import { getDependencyEntries } from './get-dependency-entries.mts'
 import {
   getOverridesData,
   getOverridesDataNpm,
   getOverridesDataYarnClassic,
 } from './get-overrides-by-agent.mts'
-import { lockfileIncludesByAgent } from './lockfile-includes-by-agent.mts'
-import { lsByAgent } from './ls-by-agent.mts'
+import { lockSrcIncludes } from './lockfile-includes-by-agent.mts'
+import { listPackages } from './ls-by-agent.mts'
 import { CMD_NAME } from './shared.mts'
-import { updateManifestByAgent } from './update-manifest-by-agent.mts'
+import { updateManifest } from './update-manifest-by-agent.mts'
 import constants from '../../constants.mts'
 import { cmdPrefixMessage } from '../../utils/cmd.mts'
 import { globWorkspace } from '../../utils/glob.mts'
 import { npa } from '../../utils/npm-package-arg.mts'
 import { getMajor } from '../../utils/semver.mts'
 
 import type { GetOverridesResult } from './get-overrides-by-agent.mts'
-import type { AgentLockIncludesFn } from './lockfile-includes-by-agent.mts'
 import type { AliasResult } from '../../utils/npm-package-arg.mts'
 import type { EnvDetails } from '../../utils/package-environment.mts'
 import type { Logger } from '@socketsecurity/registry/lib/logger'
@@ -118,6 +117,7 @@ export async function addOverrides(
     ),
   )
 
+  const addingText = `Adding overrides to ${workspace}...`
   let loggedAddingText = false
 
   // Chunk package names to process them in parallel 3 at a time.
@@ -158,32 +158,30 @@ export async function addOverrides(
             state.addedInWorkspaces.add(workspace)
           }
           if (!loggedAddingText) {
-            spinner?.setText(`Adding overrides to ${workspace}...`)
+            spinner?.setText(addingText)
             loggedAddingText = true
           }
         }
         depAliasMap.set(origPkgName, thisSpec)
       }
     }
     if (isWorkspaceRoot) {
-      // The AgentDepsIncludesFn and AgentLockIncludesFn types overlap in their
-      // first two parameters. AgentLockIncludesFn accepts an optional third
-      // parameter which AgentDepsIncludesFn will ignore so we cast thingScanner
-      // as an AgentLockIncludesFn type.
+      // The lockSrcIncludes and lsStdoutIncludes functions overlap in their
+      // first two parameters. lockSrcIncludes accepts an optional third parameter
+      // which lsStdoutIncludes will ignore.
       const thingScanner = (
-        isLockScanned
-          ? lockfileIncludesByAgent.get(agent)
-          : depsIncludesByAgent.get(agent)
-      ) as AgentLockIncludesFn
+        isLockScanned ? lockSrcIncludes : lsStdoutIncludes
+      ) as typeof lockSrcIncludes
+
       const thingToScan = isLockScanned
         ? lockSrc
-        : await lsByAgent.get(agent)!(pkgEnvDetails, pkgPath, { npmExecPath })
+        : await listPackages(pkgEnvDetails, { cwd: pkgPath, npmExecPath })
       // Chunk package names to process them in parallel 3 at a time.
       await pEach(overridesDataObjects, 3, async ({ overrides, type }) => {
         const overrideExists = hasOwn(overrides, origPkgName)
         if (
           overrideExists ||
-          thingScanner(thingToScan, origPkgName, lockName)
+          thingScanner(pkgEnvDetails, thingToScan, origPkgName, lockName)
         ) {
           const oldSpec = overrideExists ? overrides[origPkgName]! : undefined
           const origDepAlias = depAliasMap.get(origPkgName)
@@ -231,7 +229,7 @@ export async function addOverrides(
             const addedOrUpdated = overrideExists ? 'updated' : 'added'
             state[addedOrUpdated].add(sockRegPkgName)
             if (!loggedAddingText) {
-              spinner?.setText(`Adding overrides to ${workspace}...`)
+              spinner?.setText(addingText)
               loggedAddingText = true
             }
           }
@@ -280,8 +278,9 @@ export async function addOverrides(
     )
     if (isWorkspaceRoot) {
       for (const { overrides, type } of overridesDataObjects) {
-        updateManifestByAgent.get(type)!(
-          pkgEnvDetails,
+        updateManifest(
+          type,
+          pkgEnvDetails.editablePkgJson,
           toSortedObject(overrides),
         )
       }
diff --git a/src/commands/optimize/deps-includes-by-agent.mts b/src/commands/optimize/deps-includes-by-agent.mts
@@ -1,24 +1,31 @@
 import constants from '../../constants.mts'
 
-import type { Agent } from '../../utils/package-environment.mts'
-
-type AgentDepsIncludesFn = (stdout: string, name: string) => boolean
+import type { EnvDetails } from '../../utils/package-environment.mts'
 
 const { BUN, NPM, PNPM, VLT, YARN_BERRY, YARN_CLASSIC } = constants
 
-function matchLsCmdViewHumanStdout(stdout: string, name: string) {
+export function matchLsCmdViewHumanStdout(stdout: string, name: string) {
   return stdout.includes(` ${name}@`)
 }
 
-function matchQueryCmdStdout(stdout: string, name: string) {
+export function matchQueryCmdStdout(stdout: string, name: string) {
   return stdout.includes(`"${name}"`)
 }
 
-export const depsIncludesByAgent = new Map<Agent, AgentDepsIncludesFn>([
-  [BUN, matchLsCmdViewHumanStdout],
-  [NPM, matchQueryCmdStdout],
-  [PNPM, matchQueryCmdStdout],
-  [VLT, matchQueryCmdStdout],
-  [YARN_BERRY, matchLsCmdViewHumanStdout],
-  [YARN_CLASSIC, matchLsCmdViewHumanStdout],
-])
+export function lsStdoutIncludes(
+  pkgEnvDetails: EnvDetails,
+  stdout: string,
+  name: string,
+): boolean {
+  switch (pkgEnvDetails.agent) {
+    case BUN:
+    case YARN_BERRY:
+    case YARN_CLASSIC:
+      return matchLsCmdViewHumanStdout(stdout, name)
+    case PNPM:
+    case VLT:
+    case NPM:
+    default:
+      return matchQueryCmdStdout(stdout, name)
+  }
+}
diff --git a/src/commands/optimize/lockfile-includes-by-agent.mts b/src/commands/optimize/lockfile-includes-by-agent.mts
@@ -2,34 +2,32 @@ import { escapeRegExp } from '@socketsecurity/registry/lib/regexps'
 
 import constants from '../../constants.mts'
 
-import type { Agent } from '../../utils/package-environment.mts'
-
-export type AgentLockIncludesFn = (
-  lockSrc: string,
-  name: string,
-  ext?: string | undefined,
-) => boolean
+import type { EnvDetails } from '../../utils/package-environment.mts'
 
 const { BUN, LOCK_EXT, NPM, PNPM, VLT, YARN_BERRY, YARN_CLASSIC } = constants
 
-function includesNpm(lockSrc: string, name: string) {
+export function npmLockSrcIncludes(lockSrc: string, name: string) {
   // Detects the package name in the following cases:
   //   "name":
   return lockSrc.includes(`"${name}":`)
 }
 
-function includesBun(lockSrc: string, name: string, lockName?: string) {
+export function bunLockSrcIncludes(
+  lockSrc: string,
+  name: string,
+  lockName?: string | undefined,
+) {
   // This is a bit counterintuitive. When lockName ends with a .lockb
   // we treat it as a yarn.lock. When lockName ends with a .lock we
   // treat it as a package-lock.json. The bun.lock format is not identical
   // package-lock.json, however it close enough for npmLockIncludes to work.
   const lockfileScanner = lockName?.endsWith(LOCK_EXT)
-    ? includesNpm
-    : includesYarn
+    ? npmLockSrcIncludes
+    : yarnLockSrcIncludes
   return lockfileScanner(lockSrc, name)
 }
 
-function includesPnpm(lockSrc: string, name: string) {
+export function pnpmLockSrcIncludes(lockSrc: string, name: string) {
   const escapedName = escapeRegExp(name)
   return new RegExp(
     // Detects the package name.
@@ -44,13 +42,13 @@ function includesPnpm(lockSrc: string, name: string) {
   ).test(lockSrc)
 }
 
-function includesVlt(lockSrc: string, name: string) {
+export function vltLockSrcIncludes(lockSrc: string, name: string) {
   // Detects the package name in the following cases:
   //   "name"
   return lockSrc.includes(`"${name}"`)
 }
 
-function includesYarn(lockSrc: string, name: string) {
+export function yarnLockSrcIncludes(lockSrc: string, name: string) {
   const escapedName = escapeRegExp(name)
   return new RegExp(
     // Detects the package name in the following cases:
@@ -63,11 +61,25 @@ function includesYarn(lockSrc: string, name: string) {
   ).test(lockSrc)
 }
 
-export const lockfileIncludesByAgent = new Map<Agent, AgentLockIncludesFn>([
-  [BUN, includesBun],
-  [NPM, includesNpm],
-  [PNPM, includesPnpm],
-  [VLT, includesVlt],
-  [YARN_BERRY, includesYarn],
-  [YARN_CLASSIC, includesYarn],
-])
+export function lockSrcIncludes(
+  pkgEnvDetails: EnvDetails,
+  lockSrc: string,
+  name: string,
+  lockName?: string | undefined,
+): boolean {
+  switch (pkgEnvDetails.agent) {
+    case BUN:
+      return bunLockSrcIncludes(lockSrc, name, lockName)
+    case PNPM:
+      return pnpmLockSrcIncludes(lockSrc, name)
+    case VLT:
+      return vltLockSrcIncludes(lockSrc, name)
+    case YARN_BERRY:
+      return yarnLockSrcIncludes(lockSrc, name)
+    case YARN_CLASSIC:
+      return yarnLockSrcIncludes(lockSrc, name)
+    case NPM:
+    default:
+      return npmLockSrcIncludes(lockSrc, name)
+  }
+}
diff --git a/src/commands/optimize/ls-by-agent.mts b/src/commands/optimize/ls-by-agent.mts
@@ -2,7 +2,7 @@ import { spawn } from '@socketsecurity/registry/lib/spawn'
 
 import constants from '../../constants.mts'
 
-import type { Agent, EnvDetails } from '../../utils/package-environment.mts'
+import type { EnvDetails } from '../../utils/package-environment.mts'
 
 const { BUN, NPM, PNPM, VLT, YARN_BERRY, YARN_CLASSIC } = constants
 
@@ -58,7 +58,14 @@ async function npmQuery(npmExecPath: string, cwd: string): Promise<string> {
   return cleanupQueryStdout(stdout)
 }
 
-async function lsBun(pkgEnvDetails: EnvDetails, cwd: string): Promise<string> {
+export async function lsBun(
+  pkgEnvDetails: EnvDetails,
+  options?: AgentListDepsOptions | undefined,
+): Promise<string> {
+  const { cwd = process.cwd() } = {
+    __proto__: null,
+    ...options,
+  } as AgentListDepsOptions
   try {
     // Bun does not support filtering by production packages yet.
     // https://github.com/oven-sh/bun/issues/8283
@@ -73,16 +80,25 @@ async function lsBun(pkgEnvDetails: EnvDetails, cwd: string): Promise<string> {
   return ''
 }
 
-async function lsNpm(pkgEnvDetails: EnvDetails, cwd: string): Promise<string> {
+export async function lsNpm(
+  pkgEnvDetails: EnvDetails,
+  options?: AgentListDepsOptions | undefined,
+): Promise<string> {
+  const { cwd = process.cwd() } = {
+    __proto__: null,
+    ...options,
+  } as AgentListDepsOptions
   return await npmQuery(pkgEnvDetails.agentExecPath, cwd)
 }
 
-async function lsPnpm(
+export async function lsPnpm(
   pkgEnvDetails: EnvDetails,
-  cwd: string,
   options?: AgentListDepsOptions | undefined,
 ): Promise<string> {
-  const npmExecPath = options?.npmExecPath
+  const { cwd = process.cwd(), npmExecPath } = {
+    __proto__: null,
+    ...options,
+  } as AgentListDepsOptions
   if (npmExecPath && npmExecPath !== NPM) {
     const result = await npmQuery(npmExecPath, cwd)
     if (result) {
@@ -108,7 +124,14 @@ async function lsPnpm(
   return parsableToQueryStdout(stdout)
 }
 
-async function lsVlt(pkgEnvDetails: EnvDetails, cwd: string): Promise<string> {
+export async function lsVlt(
+  pkgEnvDetails: EnvDetails,
+  options?: AgentListDepsOptions | undefined,
+): Promise<string> {
+  const { cwd = process.cwd() } = {
+    __proto__: null,
+    ...options,
+  } as AgentListDepsOptions
   let stdout = ''
   try {
     // See https://docs.vlt.sh/cli/commands/list#options.
@@ -127,10 +150,14 @@ async function lsVlt(pkgEnvDetails: EnvDetails, cwd: string): Promise<string> {
   return cleanupQueryStdout(stdout)
 }
 
-async function lsYarnBerry(
+export async function lsYarnBerry(
   pkgEnvDetails: EnvDetails,
-  cwd: string,
+  options?: AgentListDepsOptions | undefined,
 ): Promise<string> {
+  const { cwd = process.cwd() } = {
+    __proto__: null,
+    ...options,
+  } as AgentListDepsOptions
   try {
     // Yarn Berry does not support filtering by production packages yet.
     // https://github.com/yarnpkg/berry/issues/5117
@@ -149,10 +176,14 @@ async function lsYarnBerry(
   return ''
 }
 
-async function lsYarnClassic(
+export async function lsYarnClassic(
   pkgEnvDetails: EnvDetails,
-  cwd: string,
+  options?: AgentListDepsOptions | undefined,
 ): Promise<string> {
+  const { cwd = process.cwd() } = {
+    __proto__: null,
+    ...options,
+  } as AgentListDepsOptions
   try {
     // However, Yarn Classic does support it.
     // https://github.com/yarnpkg/yarn/releases/tag/v1.0.0
@@ -169,19 +200,28 @@ async function lsYarnClassic(
   return ''
 }
 
-export type AgentListDepsOptions = { npmExecPath?: string }
+export type AgentListDepsOptions = {
+  cwd?: string | undefined
+  npmExecPath?: string | undefined
+}
 
-export type AgentListDepsFn = (
+export async function listPackages(
   pkgEnvDetails: EnvDetails,
-  cwd: string,
   options?: AgentListDepsOptions | undefined,
-) => Promise<string>
-
-export const lsByAgent = new Map<Agent, AgentListDepsFn>([
-  [BUN, lsBun],
-  [NPM, lsNpm],
-  [PNPM, lsPnpm],
-  [VLT, lsVlt],
-  [YARN_BERRY, lsYarnBerry],
-  [YARN_CLASSIC, lsYarnClassic],
-])
+): Promise<string> {
+  switch (pkgEnvDetails.agent) {
+    case BUN:
+      return await lsBun(pkgEnvDetails, options)
+    case PNPM:
+      return await lsPnpm(pkgEnvDetails, options)
+    case VLT:
+      return await lsVlt(pkgEnvDetails, options)
+    case YARN_BERRY:
+      return await lsYarnBerry(pkgEnvDetails, options)
+    case YARN_CLASSIC:
+      return await lsYarnClassic(pkgEnvDetails, options)
+    case NPM:
+    default:
+      return await lsNpm(pkgEnvDetails, options)
+  }
+}
diff --git a/src/commands/optimize/update-manifest-by-agent.mts b/src/commands/optimize/update-manifest-by-agent.mts
