socket 0.15.31 → 0.15.33

package/dist/cli.js

@@ -3655,7 +3655,6 @@ async function outputFixResult(result, outputKind) {
   }
   logger.logger.log('');
   logger.logger.success('Finished!');
-  logger.logger.log('');
 }
 
 function formatBranchName(name) {
@@ -3712,6 +3711,7 @@ async function gitCleanFdx(cwd = process.cwd()) {
     cwd,
     stdio: 'ignore'
   };
+  // TODO: propagate CResult?
   await spawn.spawn('git', ['clean', '-fdx'], stdioIgnoreOptions);
 }
 async function gitCreateAndPushBranch(branch, commitMsg, filepaths, options) {
@@ -3796,12 +3796,24 @@ async function gitResetHard(branch = 'HEAD', cwd = process.cwd()) {
   await spawn.spawn('git', ['reset', '--hard', branch], stdioIgnoreOptions);
 }
 async function gitUnstagedModifiedFiles(cwd = process.cwd()) {
-  const stdioPipeOptions = {
-    cwd
-  };
-  const stdout = (await spawn.spawn('git', ['diff', '--name-only'], stdioPipeOptions)).stdout.trim();
-  const rawFiles = stdout.split('\n') ?? [];
-  return rawFiles.map(relPath => path$1.normalizePath(relPath));
+  try {
+    const stdioPipeOptions = {
+      cwd
+    };
+    const stdout = (await spawn.spawn('git', ['diff', '--name-only'], stdioPipeOptions)).stdout.trim();
+    const rawFiles = stdout.split('\n') ?? [];
+    return {
+      ok: true,
+      data: rawFiles.map(relPath => path$1.normalizePath(relPath))
+    };
+  } catch (e) {
+    debug.debugFn('Unexpected error trying to run git diff --name-only');
+    return {
+      ok: false,
+      message: 'Git Error',
+      cause: 'Unexpected error while trying to ask git whether repo is dirty'
+    };
+  }
 }
 
 let _octokit;
@@ -4236,8 +4248,13 @@ async function npmFix(pkgEnvDetails, {
     }));
   } catch (e) {
     spinner?.stop();
-    logger.logger.error(e?.message || 'Unknown Socket batch PURL API error.');
-    return;
+    debug.debugFn('API Error thrown:');
+    debug.debugFn(e);
+    return {
+      ok: false,
+      message: 'API Error',
+      cause: e?.message || 'Unknown Socket batch PURL API error.'
+    };
   }
   const infoByPkgName = utils.getCveInfoFromAlertsMap(alertsMap, {
     limit
@@ -4245,7 +4262,12 @@ async function npmFix(pkgEnvDetails, {
   if (!infoByPkgName) {
     spinner?.stop();
     logger.logger.info('No fixable vulns found.');
-    return;
+    return {
+      ok: true,
+      data: {
+        fixed: false
+      }
+    };
   }
 
   // Lazily access constants.ENV properties.
@@ -4257,9 +4279,14 @@ async function npmFix(pkgEnvDetails, {
   // Process the workspace root last since it will add an override to package.json.
   pkgEnvDetails.editablePkgJson.filename];
   const handleInstallFail = () => {
-    logger.logger.error(`Unexpected condition: ${pkgEnvDetails.agent} install failed.\n`);
+    debug.debugFn(`Unexpected condition: ${pkgEnvDetails.agent} install failed.\n`);
     logger.logger.dedent();
     spinner?.dedent();
+    return {
+      ok: false,
+      message: 'Installation failure',
+      cause: `Unexpected condition: ${pkgEnvDetails.agent} install failed.`
+    };
   };
   spinner?.stop();
   let count = 0;
@@ -4411,9 +4438,15 @@ async function npmFix(pkgEnvDetails, {
           spinner?.stop();
           if (!errored && isCi) {
             try {
-              const moddedFilepaths =
               // eslint-disable-next-line no-await-in-loop
-              (await gitUnstagedModifiedFiles(cwd)).filter(p => {
+              const result = await gitUnstagedModifiedFiles(cwd);
+              if (!result.ok) {
+                // Do we fail if this fails? If this git command
+                // fails then probably other git commands do too?
+                logger.logger.warn('Unexpected condition: Nothing to commit, skipping PR creation.');
+                continue infosLoop;
+              }
+              const moddedFilepaths = result.data.filter(p => {
                 const basename = path.basename(p);
                 return basename === 'package.json' || basename === 'package-lock.json';
               });
@@ -4451,8 +4484,7 @@ async function npmFix(pkgEnvDetails, {
                 });
                 if (!maybeActualTree) {
                   // Exit early if install fails.
-                  handleInstallFail();
-                  return;
+                  return handleInstallFail();
                 }
                 actualTree = maybeActualTree;
                 continue infosLoop;
@@ -4528,8 +4560,7 @@ async function npmFix(pkgEnvDetails, {
               spinner?.stop();
               if (!maybeActualTree) {
                 // Exit early if install fails.
-                handleInstallFail();
-                return;
+                return handleInstallFail();
               }
               actualTree = maybeActualTree;
             }
@@ -4556,6 +4587,12 @@ async function npmFix(pkgEnvDetails, {
     spinner?.dedent();
   }
   spinner?.stop();
+  return {
+    ok: true,
+    data: {
+      fixed: true
+    }
+  }; // true? did we actually change anything?
 }
 
 const {
@@ -4655,8 +4692,11 @@ async function pnpmFix(pkgEnvDetails, {
   // Check !lockfileContent to make TypeScript happy.
   if (!lockfile || !lockfileContent) {
     spinner?.stop();
-    logger.logger.error('Required pnpm-lock.yaml not found or usable.');
-    return;
+    return {
+      ok: false,
+      message: 'Missing lockfile',
+      cause: 'Required pnpm-lock.yaml not found or usable'
+    };
   }
   let alertsMap;
   try {
@@ -4667,8 +4707,13 @@ async function pnpmFix(pkgEnvDetails, {
     }));
   } catch (e) {
     spinner?.stop();
-    logger.logger.error(e?.message || 'Unknown Socket batch PURL API error.');
-    return;
+    debug.debugFn('Unexpected Socket batch PURL API error:');
+    debug.debugFn(e);
+    return {
+      ok: false,
+      message: 'API Error',
+      cause: e?.message || 'Unknown Socket batch PURL API error.'
+    };
   }
   const infoByPkgName = utils.getCveInfoFromAlertsMap(alertsMap, {
     limit
@@ -4676,7 +4721,12 @@ async function pnpmFix(pkgEnvDetails, {
   if (!infoByPkgName) {
     spinner?.stop();
     logger.logger.info('No fixable vulns found.');
-    return;
+    return {
+      ok: true,
+      data: {
+        fixed: false
+      }
+    };
   }
 
   // Lazily access constants.ENV properties.
@@ -4688,9 +4738,13 @@ async function pnpmFix(pkgEnvDetails, {
   // Process the workspace root last since it will add an override to package.json.
   pkgEnvDetails.editablePkgJson.filename];
   const handleInstallFail = () => {
-    logger.logger.error(`Unexpected condition: ${pkgEnvDetails.agent} install failed.\n`);
     logger.logger.dedent();
     spinner?.dedent();
+    return {
+      ok: false,
+      message: 'Install failed',
+      cause: `Unexpected condition: ${pkgEnvDetails.agent} install failed`
+    };
   };
   spinner?.stop();
   let count = 0;
@@ -4750,8 +4804,7 @@ async function pnpmFix(pkgEnvDetails, {
       }
       if (!actualTree) {
         // Exit early if install fails.
-        handleInstallFail();
-        return;
+        return handleInstallFail();
       }
       const oldVersions = arrays.arrayUnique(shadowInject.findPackageNodes(actualTree, name).map(n => n.version).filter(Boolean));
       if (!oldVersions.length) {
@@ -4910,9 +4963,13 @@ async function pnpmFix(pkgEnvDetails, {
           spinner?.stop();
           if (!errored && isCi) {
             try {
-              const moddedFilepaths =
               // eslint-disable-next-line no-await-in-loop
-              (await gitUnstagedModifiedFiles(cwd)).filter(p => {
+              const result = await gitUnstagedModifiedFiles(cwd);
+              if (!result.ok) {
+                logger.logger.warn('Unexpected condition: Nothing to commit, skipping PR creation.');
+                continue;
+              }
+              const moddedFilepaths = result.data.filter(p => {
                 const basename = path.basename(p);
                 return basename === 'package.json' || basename === 'pnpm-lock.yaml';
               });
@@ -4958,8 +5015,7 @@ async function pnpmFix(pkgEnvDetails, {
                   continue infosLoop;
                 }
                 // Exit early if install fails.
-                handleInstallFail();
-                return;
+                return handleInstallFail();
               }
 
               // eslint-disable-next-line no-await-in-loop
@@ -5044,11 +5100,14 @@ async function pnpmFix(pkgEnvDetails, {
                 lockfileContent = maybeLockfileContent;
               } else {
                 // Exit early if install fails.
-                handleInstallFail();
-                return;
+                return handleInstallFail();
               }
             }
-            logger.logger.fail(`Update failed for ${oldId} in ${workspace}.`, ...(error ? [error] : []));
+            return {
+              ok: false,
+              message: 'Update failed',
+              cause: `Update failed for ${oldId} in ${workspace}${error ? '; ' + error : ''}`
+            };
           }
           if (++count >= limit) {
             logger.logger.dedent();
@@ -5071,6 +5130,12 @@ async function pnpmFix(pkgEnvDetails, {
     spinner?.dedent();
   }
   spinner?.stop();
+  return {
+    ok: true,
+    data: {
+      fixed: true
+    }
+  }; // or, did we change anything?
 }
 
 const {
@@ -5086,11 +5151,14 @@ async function runFix({
   test,
   testScript
 }) {
-  // TODO: make detectAndValidatePackageEnvironment return a CResult<pkgEnvDetails> and propagate it
-  const pkgEnvDetails = await utils.detectAndValidatePackageEnvironment(cwd, {
+  const result = await utils.detectAndValidatePackageEnvironment(cwd, {
     cmdName: CMD_NAME$1,
     logger: logger.logger
   });
+  if (!result.ok) {
+    return result;
+  }
+  const pkgEnvDetails = result.data;
   if (!pkgEnvDetails) {
     return {
       ok: false,
@@ -5103,8 +5171,7 @@ async function runFix({
     agent
   } = pkgEnvDetails;
   if (agent === NPM$8) {
-    // TODO: make npmFix return a CResult and propagate it
-    await npmFix(pkgEnvDetails, {
+    return await npmFix(pkgEnvDetails, {
       autoMerge,
       cwd,
       limit,
@@ -5114,8 +5181,7 @@ async function runFix({
       testScript
     });
   } else if (agent === PNPM$6) {
-    // TODO: make pnpmFix return a CResult and propagate it
-    await pnpmFix(pkgEnvDetails, {
+    return await pnpmFix(pkgEnvDetails, {
       autoMerge,
       cwd,
       limit,
@@ -5131,10 +5197,6 @@ async function runFix({
       cause: `${agent} is not supported by this command at the moment.`
     };
   }
-  return {
-    ok: true,
-    data: undefined
-  };
 }
 
 async function handleFix({
@@ -5219,10 +5281,14 @@ const config$F = {
   },
   help: (command, config) => `
     Usage
-      $ ${command}
+      $ ${command} [options] [CWD=.]
 
     Options
       ${utils.getFlagListOutput(config.flags, 6)}
+
+    Examples
+      $ ${command}
+      $ ${command} ./proj/tree --autoMerge
   `
 };
 const cmdFix = {
@@ -5249,7 +5315,6 @@ async function run$F(argv, importMeta, {
     rangeStyle,
     test
   } = cli.flags;
-  // TODO: impl json/md further
   const outputKind = utils.getOutputKind(json, markdown);
   let [cwd = '.'] = cli.input;
   // Note: path.resolve vs .join:
@@ -7951,34 +8016,43 @@ async function updateLockfile(pkgEnvDetails, options) {
     }
   } catch (e) {
     spinner?.stop();
-    logger?.fail(utils.cmdPrefixMessage(cmdName, `${pkgEnvDetails.agent} install failed to update ${pkgEnvDetails.lockName}`));
-    logger?.error(e);
+    debug.debugFn(e);
+    return {
+      ok: false,
+      message: 'Update failed',
+      cause: utils.cmdPrefixMessage(cmdName, `${pkgEnvDetails.agent} install failed to update ${pkgEnvDetails.lockName}`)
+    };
   }
   if (isSpinning) {
     spinner?.start();
   } else {
     spinner?.stop();
   }
+  return {
+    ok: true,
+    data: undefined
+  };
 }
 
 const {
   VLT
 } = constants;
-function createActionMessage(verb, overrideCount, workspaceCount) {
-  return `${verb} ${overrideCount} Socket.dev optimized ${words.pluralize('override', overrideCount)}${workspaceCount ? ` in ${workspaceCount} ${words.pluralize('workspace', workspaceCount)}` : ''}`;
-}
 async function applyOptimization(cwd, pin, prod) {
-  const pkgEnvDetails = await utils.detectAndValidatePackageEnvironment(cwd, {
+  const result = await utils.detectAndValidatePackageEnvironment(cwd, {
     cmdName: CMD_NAME,
     logger: logger.logger,
     prod
   });
-  if (!pkgEnvDetails) {
-    return;
+  if (!result.ok) {
+    return result;
   }
+  const pkgEnvDetails = result.data;
   if (pkgEnvDetails.agent === VLT) {
-    logger.logger.warn(utils.cmdPrefixMessage(CMD_NAME, `${VLT} does not support overrides. Soon, though ⚡`));
-    return;
+    return {
+      ok: false,
+      message: 'Unsupported',
+      cause: utils.cmdPrefixMessage(CMD_NAME, `${VLT} does not support overrides. Soon, though ⚡`)
+    };
   }
 
   // Lazily access constants.spinner.
@@ -7996,22 +8070,66 @@ async function applyOptimization(cwd, pin, prod) {
   const updatedCount = state.updated.size;
   const pkgJsonChanged = addedCount > 0 || updatedCount > 0;
   if (pkgJsonChanged || pkgEnvDetails.features.npmBuggyOverrides) {
-    await updateLockfile(pkgEnvDetails, {
+    const result = await updateLockfile(pkgEnvDetails, {
       cmdName: CMD_NAME,
       logger: logger.logger,
       spinner
     });
+    if (!result.ok) {
+      return result;
+    }
   }
   spinner.stop();
-  if (updatedCount > 0) {
-    logger.logger?.log(`${createActionMessage('Updated', updatedCount, state.updatedInWorkspaces.size)}${addedCount ? '.' : '🚀'}`);
+  return {
+    ok: true,
+    data: {
+      addedCount,
+      updatedCount,
+      pkgJsonChanged,
+      updatedInWorkspaces: state.updatedInWorkspaces.size,
+      addedInWorkspaces: state.addedInWorkspaces.size
+    }
+  };
+}
+
+async function outputOptimizeResult(result, outputKind) {
+  if (!result.ok) {
+    process.exitCode = result.code ?? 1;
+  }
+  if (outputKind === 'json') {
+    logger.logger.log(utils.serializeResultJson(result));
+    return;
+  }
+  if (!result.ok) {
+    logger.logger.fail(utils.failMsgWithBadge(result.message, result.cause));
+    return;
+  }
+  const data = result.data;
+  if (data.updatedCount > 0) {
+    logger.logger?.log(`${createActionMessage('Updated', data.updatedCount, data.updatedInWorkspaces)}${data.addedCount ? '.' : '🚀'}`);
   }
-  if (addedCount > 0) {
-    logger.logger?.log(`${createActionMessage('Added', addedCount, state.addedInWorkspaces.size)} 🚀`);
+  if (data.addedCount > 0) {
+    logger.logger?.log(`${createActionMessage('Added', data.addedCount, data.addedInWorkspaces)} 🚀`);
   }
-  if (!pkgJsonChanged) {
+  if (!data.pkgJsonChanged) {
     logger.logger?.log('Scan complete. No Socket.dev optimized overrides applied.');
   }
+  logger.logger.log('');
+  logger.logger.success('Finished!');
+  logger.logger.log('');
+}
+function createActionMessage(verb, overrideCount, workspaceCount) {
+  return `${verb} ${overrideCount} Socket.dev optimized ${words.pluralize('override', overrideCount)}${workspaceCount ? ` in ${workspaceCount} ${words.pluralize('workspace', workspaceCount)}` : ''}`;
+}
+
+async function handleOptimize({
+  cwd,
+  outputKind,
+  pin,
+  prod
+}) {
+  const result = await applyOptimization(cwd, pin, prod);
+  await outputOptimizeResult(result, outputKind);
 }
 
 const {
@@ -8036,14 +8154,14 @@ const config$q = {
   },
   help: (command, config) => `
     Usage
-      $ ${command}
+      $ ${command} [options] [CWD=.]
 
     Options
       ${utils.getFlagListOutput(config.flags, 6)}
 
     Examples
       $ ${command}
-      $ ${command} --pin
+      $ ${command} ./proj/tree --pin
   `
 };
 const cmdOptimize = {
@@ -8060,15 +8178,29 @@ async function run$q(argv, importMeta, {
     importMeta,
     parentName
   });
-
-  // TODO: impl json/md
-
-  const cwd = process.cwd();
+  const {
+    json,
+    markdown
+  } = cli.flags;
+  const {
+    pin,
+    prod
+  } = cli.flags;
+  const outputKind = utils.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.logger.log(DRY_RUN_BAILING_NOW$o);
     return;
   }
-  await applyOptimization(cwd, Boolean(cli.flags['pin']), Boolean(cli.flags['prod']));
+  await handleOptimize({
+    cwd,
+    pin: Boolean(pin),
+    outputKind,
+    prod: Boolean(prod)
+  });
 }
 
 async function fetchOrganization() {
@@ -11716,7 +11848,8 @@ async function handleCreateGithubScan({
     logger.logger.fail(utils.failMsgWithBadge(result.message, result.cause));
     return;
   }
-  logger.logger.success('Ok! Finished!');
+  logger.logger.log('');
+  logger.logger.success('Finished!');
 }
 
 const {
@@ -13449,5 +13582,5 @@ void (async () => {
     await utils.captureException(e);
   }
 })();
-//# debugId=e400d892-bcd3-4bf3-a6e0-ddafe9d984ad
+//# debugId=2fd0bc0c-3a6c-42d6-8ccd-1745d5682e7e
 //# sourceMappingURL=cli.js.map