Improve arborist debug

Author: jdalton

src/commands/fix/npm-fix.mts

@@ -19,9 +19,13 @@ import type {
   InstallOptions,
   InstallerResult,
 } from './agent-fix.mts'
-import type { NodeClass } from '../../shadow/npm/arborist/types.mts'
+import type {
+  ArboristInstance,
+  NodeClass,
+} from '../../shadow/npm/arborist/types.mts'
 import type { CResult } from '../../types.mts'
 import type { EnvDetails } from '../../utils/package-environment.mts'
+import type { AlertsByPurl } from '../../utils/socket-package-alert.mts'
 import type { PackageJson } from '@socketsecurity/registry/lib/packages'
 
 async function install(
@@ -120,28 +124,40 @@ export async function npmFix(
   })
 
   let actualTree: NodeClass | undefined
-  let alertsMap
+  let alertsMap: AlertsByPurl | undefined
   try {
     if (purls.length) {
       alertsMap = await getAlertsMapFromPurls(purls, getFixAlertsMapOptions())
     } else {
-      const arb = new Arborist({
-        path: pkgEnvDetails.pkgPath,
-        ...flatConfig,
-        ...SAFE_WITH_SAVE_ARBORIST_REIFY_OPTIONS_OVERRIDES,
-      })
-      actualTree = await arb.reify()
-      // Calling arb.reify() creates the arb.diff object, nulls-out arb.idealTree,
-      // and populates arb.actualTree.
+      let arb: ArboristInstance | undefined
+      try {
+        arb = new Arborist({
+          path: pkgEnvDetails.pkgPath,
+          ...flatConfig,
+          ...SAFE_WITH_SAVE_ARBORIST_REIFY_OPTIONS_OVERRIDES,
+        })
+        // Calling arb.reify() creates the arb.diff object, nulls-out arb.idealTree,
+        // and populates arb.actualTree.
+        actualTree = await arb.reify()
+      } catch (e) {
+        spinner?.stop()
+        debugFn('error', 'caught: await arb.reify() error')
+        debugDir('inspect', { error: e })
+        return {
+          ok: false,
+          message: 'Arborist error',
+          cause: (e as Error)?.message || 'Unknown Arborist error.',
+        }
+      }
       alertsMap = await getAlertsMapFromArborist(arb, getFixAlertsMapOptions())
     }
   } catch (e) {
     spinner?.stop()
-    debugFn('error', 'caught: PURL API')
+    debugFn('error', 'caught: Socket batch PURL API error')
     debugDir('inspect', { error: e })
     return {
       ok: false,
-      message: 'API Error',
+      message: 'Socket API error',
       cause: (e as Error)?.message || 'Unknown Socket batch PURL API error.',
     }
   }

src/commands/fix/pnpm-fix.mts

@@ -152,11 +152,11 @@ export async function pnpmFix(
       : await getAlertsMapFromPnpmLockfile(lockfile, getFixAlertsMapOptions())
   } catch (e) {
     spinner?.stop()
-    debugFn('error', 'caught: PURL API')
+    debugFn('error', 'caught: Socket batch PURL API error')
     debugDir('inspect', { error: e })
     return {
       ok: false,
-      message: 'API Error',
+      message: 'Socket API error',
       cause: (e as Error)?.message || 'Unknown Socket batch PURL API error.',
     }
   }

src/commands/scan/fetch-report-data.mts

@@ -134,16 +134,16 @@ export async function fetchScanData(
       updateScan('failure; unknown blocking error occurred')
       return {
         ok: false as const,
-        message: 'Unexpected Socket API error',
-        cause: `We encountered an unexpected error while requesting the Scan from the API: ${e?.message || '(no error message found)'}${e?.cause ? ` (cause: ${e.cause})` : ''}`,
+        message: 'Socket API error',
+        cause: `Error requesting scan: ${e?.message || '(no error message found)'}${e?.cause ? ` (cause: ${e.cause})` : ''}`,
       }
     }),
     fetchSecurityPolicy().catch(e => {
       updatePolicy('failure; unknown blocking error occurred')
       return {
         ok: false as const,
-        message: 'Unexpected Socket API error',
-        cause: `We encountered an unexpected error while requesting the policy from the Socket API: ${e?.message || '(no error message found)'}${e?.cause ? ` (cause: ${e.cause})` : ''}`,
+        message: 'Socket API error',
+        cause: `Error requesting policy: ${e?.message || '(no error message found)'}${e?.cause ? ` (cause: ${e.cause})` : ''}`,
       }
     }),
   ]).finally(() => {

src/utils/package-environment.mts

@@ -433,7 +433,7 @@ export async function detectAndValidatePackageEnvironment(
     const minVersion = constants.minimumVersionByAgent.get(agent)!
     return {
       ok: false,
-      message: 'Version Mismatch',
+      message: 'Version mismatch',
       cause: cmdPrefixMessage(
         cmdName,
         `Requires ${agent} >=${minVersion}. Current version: ${agentVersion}.`,
@@ -444,7 +444,7 @@ export async function detectAndValidatePackageEnvironment(
     const minVersion = constants.maintainedNodeVersions.last
     return {
       ok: false,
-      message: 'Version Mismatch',
+      message: 'Version mismatch',
       cause: cmdPrefixMessage(
         cmdName,
         `Requires Node >=${minVersion}. Current version: ${nodeVersion}.`,
@@ -454,7 +454,7 @@ export async function detectAndValidatePackageEnvironment(
   if (!details.pkgSupports.agent) {
     return {
       ok: false,
-      message: 'Engine Mismatch',
+      message: 'Engine mismatch',
       cause: cmdPrefixMessage(
         cmdName,
         `Package engine "${agent}" requires ${pkgRequirements.agent}. Current version: ${agentVersion}`,
@@ -464,7 +464,7 @@ export async function detectAndValidatePackageEnvironment(
   if (!details.pkgSupports.node) {
     return {
       ok: false,
-      message: 'Version Mismatch',
+      message: 'Version mismatch',
       cause: cmdPrefixMessage(
         cmdName,
         `Package engine "node" requires ${pkgRequirements.node}. Current version: ${nodeVersion}`,
@@ -475,14 +475,14 @@ export async function detectAndValidatePackageEnvironment(
   if (details.lockName === undefined || details.lockSrc === undefined) {
     return {
       ok: false,
-      message: 'Missing Lock File',
+      message: 'Missing lockfile',
       cause: cmdPrefixMessage(cmdName, `No ${lockName} found`),
     }
   }
   if (details.lockSrc.trim() === '') {
     return {
       ok: false,
-      message: 'Empty Lock File',
+      message: 'Empty lockfile',
       cause: cmdPrefixMessage(cmdName, `${lockName} is empty`),
     }
   }