Tweak wasSpinning

Author: jdalton

src/commands/fix/npm-fix.mts

@@ -71,7 +71,8 @@ async function install(
     ...(extraArgs ?? []),
   ]
 
-  const isSpinning = spinner?.isSpinning
+  const wasSpinning = !!spinner?.isSpinning
+
   spinner?.stop()
 
   const quotedCmd = `\`${pkgEnvDetails.agent} install ${args.join(' ')}\``
@@ -91,14 +92,16 @@ async function install(
 
   const treeResult = await getActualTree(cwd)
   if (treeResult.actualTree) {
-    if (isSpinning) {
+    if (wasSpinning) {
       spinner.start()
     }
     return treeResult
   }
+
   debugFn('error', 'caught: await arb.loadActual() error')
   debugDir('inspect', treeResult)
-  if (isSpinning) {
+
+  if (wasSpinning) {
     spinner.start()
   }
   return treeResult

src/commands/fix/pnpm-fix.mts

@@ -58,7 +58,8 @@ async function install(
     ...(extraArgs ?? []),
   ]
 
-  const isSpinning = spinner?.isSpinning
+  const wasSpinning = !!spinner?.isSpinning
+
   spinner?.stop()
 
   const quotedCmd = `\`${pkgEnvDetails.agent} install ${args.join(' ')}\``
@@ -78,14 +79,16 @@ async function install(
 
   const treeResult = await getActualTree(cwd)
   if (treeResult.actualTree) {
-    if (isSpinning) {
+    if (wasSpinning) {
       spinner.start()
     }
     return treeResult
   }
+
   debugFn('error', 'caught: await arb.loadActual() error')
   debugDir('inspect', treeResult)
-  if (isSpinning) {
+
+  if (wasSpinning) {
     spinner.start()
   }
   return treeResult

src/commands/optimize/update-lockfile.mts

@@ -29,11 +29,11 @@ export async function updateLockfile(
     __proto__: null,
     ...options,
   } as UpdateLockfileOptions
-  const isSpinning = !!spinner?.isSpinning
-  if (!isSpinning) {
-    spinner?.start()
-  }
-  spinner?.setText(`Updating ${pkgEnvDetails.lockName}...`)
+
+  const wasSpinning = !!spinner?.isSpinning
+
+  spinner?.start(`Updating ${pkgEnvDetails.lockName}...`)
+
   try {
     await runAgentInstall(pkgEnvDetails, { spinner })
     if (pkgEnvDetails.features.npmBuggyOverrides) {
@@ -48,6 +48,10 @@ export async function updateLockfile(
     debugFn('error', 'fail: update')
     debugDir('inspect', { error: e })
 
+    if (wasSpinning) {
+      spinner.start()
+    }
+
     return {
       ok: false,
       message: 'Update failed',
@@ -57,10 +61,11 @@ export async function updateLockfile(
       ),
     }
   }
-  if (isSpinning) {
-    spinner?.start()
-  } else {
-    spinner?.stop()
+
+  spinner?.stop()
+
+  if (wasSpinning) {
+    spinner.start()
   }
 
   return { ok: true, data: undefined }

src/commands/scan/cmd-scan-create.mts

@@ -321,8 +321,10 @@ async function run(
             message: 'Canceled by user',
             cause: 'Org selector was canceled by user',
           },
-          outputKind,
-          false,
+          {
+            interactive: false,
+            outputKind,
+          },
         )
         return
       }

src/commands/scan/handle-create-new-scan.mts

@@ -77,7 +77,10 @@ export async function handleCreateNewScan({
 
   const supportedFilesCResult = await fetchSupportedScanFileNames()
   if (!supportedFilesCResult.ok) {
-    await outputCreateNewScan(supportedFilesCResult, outputKind, interactive)
+    await outputCreateNewScan(supportedFilesCResult, {
+      interactive,
+      outputKind,
+    })
     return
   }
 
@@ -141,7 +144,7 @@ export async function handleCreateNewScan({
     spinner.stop()
 
     if (!reachResult.ok) {
-      await outputCreateNewScan(reachResult, outputKind, interactive)
+      await outputCreateNewScan(reachResult, { interactive, outputKind })
       return
     }
 
@@ -199,12 +202,17 @@ export async function handleCreateNewScan({
           cause: 'Server did not respond with a scan ID',
           data: fullScanCResult.data,
         },
-        outputKind,
-        interactive,
+        {
+          interactive,
+          outputKind,
+        },
       )
     }
   } else {
-    await outputCreateNewScan(fullScanCResult, outputKind, interactive)
+    spinner.stop()
+    spinner.clear()
+
+    await outputCreateNewScan(fullScanCResult, { interactive, outputKind })
   }
 }
 
@@ -250,7 +258,7 @@ async function performReachabilityAnalysis(
 
   const sockSdk = sockSdkCResult.data
 
-  const wasSpinning = spinner?.isSpinning ?? false
+  const wasSpinning = !!spinner?.isSpinning
 
   // Upload manifests to get tar hash
   spinner?.start('Uploading manifests for reachability analysis...')
@@ -266,17 +274,20 @@ async function performReachabilityAnalysis(
       spinner,
     },
   )
+
+  spinner?.stop()
+
   if (!uploadCResult.ok) {
-    if (!wasSpinning) {
-      spinner?.stop()
+    if (wasSpinning) {
+      spinner.start()
     }
     return uploadCResult
   }
 
   const tarHash = (uploadCResult.data as { tarHash?: string })?.tarHash
   if (!tarHash) {
-    if (!wasSpinning) {
-      spinner?.stop()
+    if (wasSpinning) {
+      spinner.start()
     }
     return {
       ok: false,
@@ -285,11 +296,11 @@ async function performReachabilityAnalysis(
     }
   }
 
+  spinner?.start()
   spinner?.success(`Manifests uploaded successfully. Tar hash: ${tarHash}`)
+  spinner?.infoAndStop('Running reachability analysis with Coana...')
 
   // Run Coana with the manifests tar hash.
-  spinner?.info('Running reachability analysis with Coana...')
-
   const coanaResult = await spawnCoana(
     [
       'run',
@@ -304,29 +315,29 @@ async function performReachabilityAnalysis(
     ],
     {
       cwd,
-      stdio: 'inherit',
       env: {
         ...process.env,
         SOCKET_REPO_NAME: repoName,
         SOCKET_BRANCH_NAME: branchName,
       },
+      spinner,
+      stdio: 'inherit',
     },
   )
 
-  if (!wasSpinning) {
-    spinner?.stop()
-  }
-  if (!coanaResult.ok) {
-    return coanaResult
-  }
-  // Use the DOT_SOCKET_DOT_FACTS_JSON file for the scan.
-  return {
-    ok: true,
-    data: {
-      scanPaths: [constants.DOT_SOCKET_DOT_FACTS_JSON],
-      tier1ReachabilityScanId: extractTier1ReachabilityScanId(
-        constants.DOT_SOCKET_DOT_FACTS_JSON,
-      ),
-    },
+  if (wasSpinning) {
+    spinner.start()
   }
+  return coanaResult.ok
+    ? {
+        ok: true,
+        data: {
+          // Use the DOT_SOCKET_DOT_FACTS_JSON file for the scan.
+          scanPaths: [constants.DOT_SOCKET_DOT_FACTS_JSON],
+          tier1ReachabilityScanId: extractTier1ReachabilityScanId(
+            constants.DOT_SOCKET_DOT_FACTS_JSON,
+          ),
+        },
+      }
+    : coanaResult
 }

src/commands/scan/output-create-new-scan.mts

@@ -4,27 +4,52 @@ import colors from 'yoctocolors-cjs'
 import { logger } from '@socketsecurity/registry/lib/logger'
 import { confirm } from '@socketsecurity/registry/lib/prompts'
 
+import constants from '../../constants.mts'
 import { failMsgWithBadge } from '../../utils/fail-msg-with-badge.mts'
 import { serializeResultJson } from '../../utils/serialize-result-json.mts'
 
 import type { CResult, OutputKind } from '../../types.mts'
+import type { Spinner } from '@socketsecurity/registry/lib/spinner'
 import type { SocketSdkSuccessResult } from '@socketsecurity/sdk'
 
+export type CreateNewScanOptions = {
+  interactive?: boolean | undefined
+  outputKind?: OutputKind | undefined
+  spinner?: Spinner | undefined
+}
+
 export async function outputCreateNewScan(
   result: CResult<SocketSdkSuccessResult<'CreateOrgFullScan'>['data']>,
-  outputKind: OutputKind,
-  interactive: boolean,
+  options?: CreateNewScanOptions | undefined,
 ) {
+  const {
+    interactive = false,
+    outputKind = 'text',
+    // Lazily access constants.spinner.
+    spinner = constants.spinner,
+  } = { __proto__: null, ...options } as CreateNewScanOptions
+
   if (!result.ok) {
     process.exitCode = result.code ?? 1
   }
 
+  const wasSpinning = !!spinner?.isSpinning
+
+  spinner?.stop()
+
   if (outputKind === 'json') {
     logger.log(serializeResultJson(result))
+    if (wasSpinning) {
+      spinner.start()
+    }
     return
   }
+
   if (!result.ok) {
     logger.fail(failMsgWithBadge(result.message, result.cause))
+    if (wasSpinning) {
+      spinner.start()
+    }
     return
   }
 
@@ -47,19 +72,31 @@ export async function outputCreateNewScan(
       )
     }
     logger.log('')
+    if (wasSpinning) {
+      spinner.start()
+    }
     return
   }
 
   const link = colors.underline(colors.cyan(`${result.data.html_report_url}`))
+
+  logger.log('')
   logger.log(`Available at: ${link}`)
 
   if (
     interactive &&
-    (await confirm({
-      message: 'Would you like to open it in your browser?',
-      default: false,
-    }))
+    (await confirm(
+      {
+        message: 'Would you like to open it in your browser?',
+        default: false,
+      },
+      { spinner },
+    ))
   ) {
     await open(`${result.data.html_report_url}`)
   }
+
+  if (wasSpinning) {
+    spinner.start()
+  }
 }