Cresultify socket optimize (#615)

* Cresultify socket optimize

* CResult updateLockfile

Author: pvdz

src/commands/fix/cmd-fix.mts

@@ -82,10 +82,14 @@ const config: CliCommandConfig = {
   },
   help: (command, config) => `
     Usage
-      $ ${command}
+      $ ${command} [options] [CWD=.]
 
     Options
       ${getFlagListOutput(config.flags, 6)}
+
+    Examples
+      $ ${command}
+      $ ${command} ./proj/tree --autoMerge
   `,
 }
 
@@ -109,12 +113,12 @@ async function run(
 
   const { autopilot, json, markdown } = cli.flags
   let { autoMerge, rangeStyle, test } = cli.flags
-  // TODO: impl json/md further
   const outputKind = getOutputKind(json, markdown)
   let [cwd = '.'] = cli.input
   // Note: path.resolve vs .join:
   // If given path is absolute then cwd should not affect it.
   cwd = path.resolve(process.cwd(), cwd)
+
   if (autopilot) {
     autoMerge = true
     test = true

src/commands/fix/cmd-fix.test.mts

@@ -17,7 +17,7 @@ describe('socket fix', async () => {
         "Update dependencies with "fixable" Socket alerts
 
           Usage
-            $ socket fix
+            $ socket fix [options] [CWD=.]
 
           Options
             --autoMerge       Enable auto-merge for pull requests that Socket opens.
@@ -38,7 +38,11 @@ describe('socket fix', async () => {
                                 * preserve - Retain the existing version range style as-is
                                 * tilde - Use ~ range for patch/minor updates (e.g. ~1.2.3)
             --test            Verify the fix by running unit tests
-            --testScript      The test script to run for each fix attempt"
+            --testScript      The test script to run for each fix attempt
+
+          Examples
+            $ socket fix
+            $ socket fix ./proj/tree --autoMerge"
       `,
       )
       expect(`\n   ${stderr}`).toMatchInlineSnapshot(`

src/commands/optimize/apply-optimization.mts

@@ -1,5 +1,4 @@
 import { logger } from '@socketsecurity/registry/lib/logger'
-import { pluralize } from '@socketsecurity/registry/lib/words'
 
 import { addOverrides } from './add-overrides.mts'
 import { CMD_NAME } from './shared.mts'
@@ -8,21 +7,23 @@ import constants from '../../constants.mts'
 import { cmdPrefixMessage } from '../../utils/cmd.mts'
 import { detectAndValidatePackageEnvironment } from '../../utils/package-environment.mts'
 
-const { VLT } = constants
+import type { CResult } from '../../types.mts'
 
-function createActionMessage(
-  verb: string,
-  overrideCount: number,
-  workspaceCount: number,
-): string {
-  return `${verb} ${overrideCount} Socket.dev optimized ${pluralize('override', overrideCount)}${workspaceCount ? ` in ${workspaceCount} ${pluralize('workspace', workspaceCount)}` : ''}`
-}
+const { VLT } = constants
 
 export async function applyOptimization(
   cwd: string,
   pin: boolean,
   prod: boolean,
-) {
+): Promise<
+  CResult<{
+    addedCount: number
+    updatedCount: number
+    pkgJsonChanged: boolean
+    updatedInWorkspaces: number
+    addedInWorkspaces: number
+  }>
+> {
   const result = await detectAndValidatePackageEnvironment(cwd, {
     cmdName: CMD_NAME,
     logger,
@@ -32,21 +33,17 @@ export async function applyOptimization(
   if (!result.ok) {
     return result
   }
-
   const pkgEnvDetails = result.data
-  if (!pkgEnvDetails) {
-    // TODO: probably not necessary
-    return
-  }
 
   if (pkgEnvDetails.agent === VLT) {
-    logger.warn(
-      cmdPrefixMessage(
+    return {
+      ok: false,
+      message: 'Unsupported',
+      cause: cmdPrefixMessage(
         CMD_NAME,
         `${VLT} does not support overrides. Soon, though ⚡`,
       ),
-    )
-    return
+    }
   }
 
   // Lazily access constants.spinner.
@@ -66,22 +63,26 @@ export async function applyOptimization(
   const pkgJsonChanged = addedCount > 0 || updatedCount > 0
 
   if (pkgJsonChanged || pkgEnvDetails.features.npmBuggyOverrides) {
-    await updateLockfile(pkgEnvDetails, { cmdName: CMD_NAME, logger, spinner })
+    const result = await updateLockfile(pkgEnvDetails, {
+      cmdName: CMD_NAME,
+      logger,
+      spinner,
+    })
+    if (!result.ok) {
+      return result
+    }
   }
 
   spinner.stop()
 
-  if (updatedCount > 0) {
-    logger?.log(
-      `${createActionMessage('Updated', updatedCount, state.updatedInWorkspaces.size)}${addedCount ? '.' : '🚀'}`,
-    )
-  }
-  if (addedCount > 0) {
-    logger?.log(
-      `${createActionMessage('Added', addedCount, state.addedInWorkspaces.size)} 🚀`,
-    )
-  }
-  if (!pkgJsonChanged) {
-    logger?.log('Scan complete. No Socket.dev optimized overrides applied.')
+  return {
+    ok: true,
+    data: {
+      addedCount,
+      updatedCount,
+      pkgJsonChanged,
+      updatedInWorkspaces: state.updatedInWorkspaces.size,
+      addedInWorkspaces: state.addedInWorkspaces.size,
+    },
   }
 }

src/commands/optimize/cmd-optimize.mts

@@ -1,8 +1,11 @@
+import path from 'node:path'
+
 import { logger } from '@socketsecurity/registry/lib/logger'
 
-import { applyOptimization } from './apply-optimization.mts'
+import { handleOptimize } from './handle-optimize.mts'
 import constants from '../../constants.mts'
 import { commonFlags } from '../../flags.mts'
+import { getOutputKind } from '../../utils/get-output-kind.mts'
 import { meowOrExit } from '../../utils/meow-with-subcommands.mts'
 import { getFlagListOutput } from '../../utils/output-formatting.mts'
 
@@ -29,14 +32,14 @@ const config: CliCommandConfig = {
   },
   help: (command, config) => `
     Usage
-      $ ${command}
+      $ ${command} [options] [CWD=.]
 
     Options
       ${getFlagListOutput(config.flags, 6)}
 
     Examples
       $ ${command}
-      $ ${command} --pin
+      $ ${command} ./proj/tree --pin
   `,
 }
 
@@ -58,18 +61,23 @@ async function run(
     parentName,
   })
 
-  // TODO: impl json/md
-
-  const cwd = process.cwd()
+  const { json, markdown } = cli.flags
+  const { pin, prod } = cli.flags
+  const outputKind = getOutputKind(json, markdown)
+  let [cwd = '.'] = cli.input
+  // Note: path.resolve vs .join:
+  // If given path is absolute then cwd should not affect it.
+  cwd = path.resolve(process.cwd(), cwd)
 
   if (cli.flags['dryRun']) {
     logger.log(DRY_RUN_BAILING_NOW)
     return
   }
 
-  await applyOptimization(
+  await handleOptimize({
     cwd,
-    Boolean(cli.flags['pin']),
-    Boolean(cli.flags['prod']),
-  )
+    pin: Boolean(pin),
+    outputKind,
+    prod: Boolean(prod),
+  })
 }

src/commands/optimize/cmd-optimize.test.mts

@@ -19,7 +19,7 @@ describe('socket optimize', async () => {
         "Optimize dependencies with @socketregistry overrides
 
           Usage
-            $ socket optimize
+            $ socket optimize [options] [CWD=.]
 
           Options
             --help            Print this help
@@ -28,7 +28,7 @@ describe('socket optimize', async () => {
 
           Examples
             $ socket optimize
-            $ socket optimize --pin"
+            $ socket optimize ./proj/tree --pin"
       `,
       )
       expect(`\n   ${stderr}`).toMatchInlineSnapshot(`

src/commands/optimize/handle-optimize.mts

@@ -0,0 +1,20 @@
+import { applyOptimization } from './apply-optimization.mts'
+import { outputOptimizeResult } from './output-optimize-result.mts'
+
+import type { OutputKind } from '../../types.mts'
+
+export async function handleOptimize({
+  cwd,
+  outputKind,
+  pin,
+  prod,
+}: {
+  cwd: string
+  outputKind: OutputKind
+  pin: boolean
+  prod: boolean
+}) {
+  const result = await applyOptimization(cwd, pin, prod)
+
+  await outputOptimizeResult(result, outputKind)
+}

src/commands/optimize/output-optimize-result.mts

@@ -0,0 +1,59 @@
+import { logger } from '@socketsecurity/registry/lib/logger'
+import { pluralize } from '@socketsecurity/registry/lib/words'
+
+import { failMsgWithBadge } from '../../utils/fail-msg-with-badge.mts'
+import { serializeResultJson } from '../../utils/serialize-result-json.mts'
+
+import type { CResult, OutputKind } from '../../types.mts'
+
+export async function outputOptimizeResult(
+  result: CResult<{
+    addedCount: number
+    updatedCount: number
+    pkgJsonChanged: boolean
+    updatedInWorkspaces: number
+    addedInWorkspaces: number
+  }>,
+  outputKind: OutputKind,
+) {
+  if (!result.ok) {
+    process.exitCode = result.code ?? 1
+  }
+
+  if (outputKind === 'json') {
+    logger.log(serializeResultJson(result))
+    return
+  }
+  if (!result.ok) {
+    logger.fail(failMsgWithBadge(result.message, result.cause))
+    return
+  }
+
+  const data = result.data
+
+  if (data.updatedCount > 0) {
+    logger?.log(
+      `${createActionMessage('Updated', data.updatedCount, data.updatedInWorkspaces)}${data.addedCount ? '.' : '🚀'}`,
+    )
+  }
+  if (data.addedCount > 0) {
+    logger?.log(
+      `${createActionMessage('Added', data.addedCount, data.addedInWorkspaces)} 🚀`,
+    )
+  }
+  if (!data.pkgJsonChanged) {
+    logger?.log('Scan complete. No Socket.dev optimized overrides applied.')
+  }
+
+  logger.log('')
+  logger.success('Finished!')
+  logger.log('')
+}
+
+function createActionMessage(
+  verb: string,
+  overrideCount: number,
+  workspaceCount: number,
+): string {
+  return `${verb} ${overrideCount} Socket.dev optimized ${pluralize('override', overrideCount)}${workspaceCount ? ` in ${workspaceCount} ${pluralize('workspace', workspaceCount)}` : ''}`
+}

src/commands/optimize/update-lockfile.mts

@@ -1,9 +1,11 @@
+import { debugFn } from '@socketsecurity/registry/lib/debug'
 import { Spinner } from '@socketsecurity/registry/lib/spinner'
 
 import constants from '../../constants.mts'
 import { runAgentInstall } from '../../utils/agent.mts'
 import { cmdPrefixMessage } from '../../utils/cmd.mts'
 
+import type { CResult } from '../../types.mts'
 import type { EnvDetails } from '../../utils/package-environment.mts'
 import type { Logger } from '@socketsecurity/registry/lib/logger'
 
@@ -18,7 +20,7 @@ export type UpdateLockfileOptions = {
 export async function updateLockfile(
   pkgEnvDetails: EnvDetails,
   options: UpdateLockfileOptions,
-) {
+): Promise<CResult<unknown>> {
   const {
     cmdName = '',
     logger,
@@ -42,17 +44,21 @@ export async function updateLockfile(
     }
   } catch (e) {
     spinner?.stop()
-    logger?.fail(
-      cmdPrefixMessage(
+    debugFn(e)
+    return {
+      ok: false,
+      message: 'Update failed',
+      cause: cmdPrefixMessage(
         cmdName,
         `${pkgEnvDetails.agent} install failed to update ${pkgEnvDetails.lockName}`,
       ),
-    )
-    logger?.error(e)
+    }
   }
   if (isSpinning) {
     spinner?.start()
   } else {
     spinner?.stop()
   }
+
+  return { ok: true, data: undefined }
 }