Cleanup spinner wiring in fix command

Author: jdalton

src/commands/fix/agent-fix.mts

@@ -60,13 +60,13 @@ import type { AlertsByPurl } from '../../utils/socket-package-alert.mts'
 import type { EditablePackageJson } from '@socketsecurity/registry/lib/packages'
 import type { Spinner } from '@socketsecurity/registry/lib/spinner'
 
-export type FixOptions = {
+export type FixConfig = {
   autoMerge: boolean
   cwd: string
   limit: number
   purls: string[]
   rangeStyle: RangeStyle
-  spinner?: Spinner | undefined
+  spinner: Spinner | undefined
   test: boolean
   testScript: string
 }
@@ -83,7 +83,7 @@ export type InstallPhaseHandler = (
   oldVersion: string,
   newVersion: string,
   vulnerableVersionRange: string,
-  options: FixOptions,
+  fixConfig: FixConfig,
 ) => Promise<void>
 
 export type Installer = (
@@ -110,11 +110,11 @@ export async function agentFix(
   },
   ciEnv: CiEnv | null,
   openPrs: PrMatch[],
-  options: FixOptions,
+  fixConfig: FixConfig,
 ): Promise<CResult<{ fixed: boolean }>> {
-  const { autoMerge, cwd, limit, rangeStyle, test, testScript } = options
-  const { spinner } = constants
   const { pkgPath: rootPath } = pkgEnvDetails
+  const { autoMerge, cwd, limit, rangeStyle, spinner, test, testScript } =
+    fixConfig
 
   let count = 0
 
@@ -342,7 +342,7 @@ export async function agentFix(
             oldVersion,
             newVersion,
             vulnerableVersionRange,
-            options,
+            fixConfig,
           )
           updatePackageJsonFromNode(
             editablePkgJson,
@@ -393,7 +393,7 @@ export async function agentFix(
                 oldVersion,
                 newVersion,
                 vulnerableVersionRange,
-                options,
+                fixConfig,
               )
               if (test) {
                 spinner?.info(`Testing ${newId} in ${workspace}.`)
@@ -574,7 +574,7 @@ export async function agentFix(
                 oldVersion,
                 newVersion,
                 vulnerableVersionRange,
-                options,
+                fixConfig,
               )
               // eslint-disable-next-line no-await-in-loop
               await Promise.all([

src/commands/fix/cmd-fix.mts

@@ -126,6 +126,7 @@ async function run(
     json: boolean
     markdown: boolean
   }
+
   const outputKind = getOutputKind(json, markdown)
 
   let rangeStyle = cli.flags['rangeStyle'] as RangeStyle
@@ -148,6 +149,10 @@ async function run(
     return
   }
 
+  // Lazily access constants.spinner.
+  const { spinner } = constants
+  const { unknownFlags } = cli
+
   let [cwd = '.'] = cli.input
   // Note: path.resolve vs .join:
   // If given path is absolute then cwd should not affect it.
@@ -167,7 +172,6 @@ async function run(
       : Infinity) || Infinity
   const purls = cmdFlagValueToArray(cli.flags['purl'])
   const testScript = String(cli.flags['testScript'] || 'test')
-  const { unknownFlags } = cli
 
   await handleFix({
     autoMerge,
@@ -177,6 +181,7 @@ async function run(
     outputKind,
     purls,
     rangeStyle,
+    spinner,
     test,
     testScript,
     unknownFlags,

src/commands/fix/handle-fix.mts

@@ -11,14 +11,14 @@ import { cmdFlagValueToArray } from '../../utils/cmd.mts'
 import { spawnCoana } from '../../utils/coana.mts'
 import { detectAndValidatePackageEnvironment } from '../../utils/package-environment.mts'
 
-import type { FixOptions } from './agent-fix.mts'
+import type { FixConfig } from './agent-fix.mts'
 import type { OutputKind } from '../../types.mts'
 import type { Remap } from '@socketsecurity/registry/lib/objects'
 
 const { NPM, PNPM } = constants
 
-export type HandleFixOptions = Remap<
-  FixOptions & {
+export type HandleFixConfig = Remap<
+  FixConfig & {
     ghsas: string[]
     outputKind: OutputKind
     unknownFlags: string[]
@@ -33,24 +33,22 @@ export async function handleFix({
   outputKind,
   purls,
   rangeStyle,
+  spinner,
   test,
   testScript,
   unknownFlags,
-}: HandleFixOptions) {
-  // Lazily access constants.spinner.
-  const { spinner } = constants
-
+}: HandleFixConfig) {
   let { length: ghsasCount } = ghsas
   if (ghsasCount) {
-    spinner.start('Fetching GHSA IDs...')
+    spinner?.start('Fetching GHSA IDs...')
 
     if (ghsasCount === 1 && ghsas[0] === 'auto') {
       const autoCResult = await spawnCoana(
         ['compute-fixes-and-upgrade-purls', cwd],
         { cwd, spinner },
       )
 
-      spinner.stop()
+      spinner?.stop()
 
       if (autoCResult.ok) {
         ghsas = cmdFlagValueToArray(
@@ -68,11 +66,11 @@ export async function handleFix({
         ghsasCount = 0
       }
 
-      spinner.start()
+      spinner?.start()
     }
 
     if (ghsasCount) {
-      spinner.info(`Found ${ghsasCount} GHSA ${pluralize('ID', ghsasCount)}.`)
+      spinner?.info(`Found ${ghsasCount} GHSA ${pluralize('ID', ghsasCount)}.`)
 
       const applyFixesCResult = await spawnCoana(
         [
@@ -85,7 +83,7 @@ export async function handleFix({
         { cwd, spinner },
       )
 
-      spinner.stop()
+      spinner?.stop()
 
       if (!applyFixesCResult.ok) {
         debugFn('coana fail:', {
@@ -98,7 +96,7 @@ export async function handleFix({
       return
     }
 
-    spinner.infoAndStop('No GHSA IDs found.')
+    spinner?.infoAndStop('No GHSA IDs found.')
 
     await outputFixResult(
       {

src/commands/fix/npm-fix.mts

@@ -24,7 +24,7 @@ import { getAlertsMapFromArborist } from '../../shadow/npm/arborist-helpers.mts'
 import { runAgentInstall } from '../../utils/agent.mts'
 import { getAlertsMapFromPurls } from '../../utils/alerts-map.mts'
 
-import type { FixOptions, InstallOptions } from './agent-fix.mts'
+import type { FixConfig, InstallOptions } from './agent-fix.mts'
 import type {
   ArboristOptions,
   NodeClass,
@@ -54,9 +54,9 @@ async function install(
 
 export async function npmFix(
   pkgEnvDetails: EnvDetails,
-  options: FixOptions,
+  fixConfig: FixConfig,
 ): Promise<CResult<{ fixed: boolean }>> {
-  const { limit, purls, spinner } = options
+  const { limit, purls, spinner } = fixConfig
 
   spinner?.start()
 
@@ -150,6 +150,6 @@ export async function npmFix(
     },
     ciEnv,
     openPrs,
-    options,
+    fixConfig,
   )
 }

src/commands/fix/pnpm-fix.mts

@@ -22,7 +22,7 @@ import {
 import { applyRange } from '../../utils/semver.mts'
 import { getOverridesDataPnpm } from '../optimize/get-overrides-by-agent.mts'
 
-import type { FixOptions, InstallOptions } from './agent-fix.mts'
+import type { FixConfig, InstallOptions } from './agent-fix.mts'
 import type { NodeClass } from '../../shadow/npm/arborist/types.mts'
 import type { CResult, StringKeyValueObject } from '../../types.mts'
 import type { EnvDetails } from '../../utils/package-environment.mts'
@@ -59,9 +59,9 @@ async function install(
 
 export async function pnpmFix(
   pkgEnvDetails: EnvDetails,
-  options: FixOptions,
+  fixConfig: FixConfig,
 ): Promise<CResult<{ fixed: boolean }>> {
-  const { cwd, limit, purls, spinner } = options
+  const { cwd, limit, purls, spinner } = fixConfig
 
   spinner?.start()
 
@@ -229,6 +229,6 @@ export async function pnpmFix(
     },
     ciEnv,
     openPrs,
-    options,
+    fixConfig,
   )
 }