@socketsecurity/cli-with-sentry 0.15.32 → 0.15.34

package/dist/utils.js

@@ -376,7 +376,7 @@ let _cachedConfig;
 // When using --config or SOCKET_CLI_CONFIG, do not persist the config.
 let _readOnlyConfig = false;
 function overrideCachedConfig(jsonConfig) {
-  debug.debugFn('Overriding entire config, marking config as read-only.');
+  debug.debugFn('override: full config (not stored)');
   let config;
   try {
     config = JSON.parse(String(jsonConfig));
@@ -417,7 +417,8 @@ function overrideCachedConfig(jsonConfig) {
   };
 }
 function overrideConfigApiToken(apiToken) {
-  debug.debugFn('Overriding API token, marking config as read-only.');
+  debug.debugFn('override: API token (not stored)');
+
   // Set token to the local cached config and mark it read-only so it doesn't persist
   _cachedConfig = {
     ...vendor.configExports,
@@ -486,7 +487,7 @@ function captureExceptionSync(exception, hint) {
   if (!Sentry) {
     return '';
   }
-  debug.debugFn(`Sending exception to Sentry.`);
+  debug.debugFn('send: exception to Sentry');
   return Sentry.captureException(exception, hint);
 }
 
@@ -607,13 +608,13 @@ async function handleApiCall(value, fetchingDesc) {
     spinner.successAndStop(`Received API response (after requesting ${fetchingDesc}).`);
   } catch (e) {
     spinner.failAndStop(`An error was thrown while requesting ${fetchingDesc}`);
-    debug.debugFn(`${fetchingDesc} threw error:\n`, e);
     const message = `${e || 'No error message returned'}`;
-    const cause = `${e || 'No error message returned'}`;
+    const reason = `${e || 'No error message returned'}`;
+    debug.debugFn(`${fetchingDesc} threw error:\n`, e);
     return {
       ok: false,
       message: 'Socket API returned an error',
-      cause: `${message}${cause ? ` ( Reason: ${cause} )` : ''}`
+      cause: `${message}${reason ? ` ( Reason: ${reason} )` : ''}`
     };
   } finally {
     spinner.stop();
@@ -623,11 +624,14 @@ async function handleApiCall(value, fetchingDesc) {
   if (result.success === false) {
     const err = result;
     const message = `${err.error || 'No error message returned'}`;
+    const {
+      cause: reason
+    } = err;
     debug.debugFn(`${fetchingDesc} bad response:\n`, err);
     return {
       ok: false,
       message: 'Socket API returned an error',
-      cause: `${message}${err.cause ? ` ( Reason: ${err.cause} )` : ''}`,
+      cause: `${message}${reason ? ` ( Reason: ${reason} )` : ''}`,
       data: {
         code: result.status
       }
@@ -645,13 +649,13 @@ async function handleApiCallNoSpinner(value, description) {
   try {
     result = await value;
   } catch (e) {
-    debug.debugFn(`${description} threw error:\n`, e);
     const message = `${e || 'No error message returned'}`;
-    const cause = `${e || 'No error message returned'}`;
+    const reason = `${e || 'No error message returned'}`;
+    debug.debugFn(`${description} threw error:\n`, e);
     return {
       ok: false,
       message: 'Socket API returned an error',
-      cause: `${message}${cause ? ` ( Reason: ${cause} )` : ''}`
+      cause: `${message}${reason ? ` ( Reason: ${reason} )` : ''}`
     };
   }
 
@@ -750,13 +754,13 @@ async function queryApiSafeText(path, fetchSpinnerDesc) {
       } = constants;
       spinner.failAndStop(`An error was thrown while requesting ${fetchSpinnerDesc}`);
     }
-    debug.debugFn('Error thrown trying to await queryApi():\n', e);
-    const msg = e?.message;
+    const cause = e?.message;
+    debug.debugFn('catch: error in queryApi()\n', e);
     return {
       ok: false,
       message: 'API Request failed to complete',
-      ...(msg ? {
-        cause: msg
+      ...(cause ? {
+        cause
       } : {})
     };
   }
@@ -775,7 +779,7 @@ async function queryApiSafeText(path, fetchSpinnerDesc) {
       data
     };
   } catch (e) {
-    debug.debugFn('Error thrown trying to await result.text():\n', e);
+    debug.debugFn('catch: await result.text()\n', e);
     return {
       ok: false,
       message: 'API Request failed to complete',
@@ -896,30 +900,33 @@ cols) {
 function serializeResultJson(data) {
   if (typeof data !== 'object' || !data) {
     process.exitCode = 1;
-    // We should not allow to expect the json value to be "null", or a boolean/number/string, even if they are valid "json".
-    const msg = 'There was a problem converting the data set to JSON. The JSON was not an object. Please try again without --json';
     debug.debugFn('typeof data=', typeof data);
     if (typeof data !== 'object' && data) {
       debug.debugFn('data:\n', data);
     }
+
+    // We should not allow the json value to be "null", or a boolean/number/string,
+    // even if they are valid "json".
+    const message = 'There was a problem converting the data set to JSON. The JSON was not an object. Please try again without --json';
     return JSON.stringify({
       ok: false,
       message: 'Unable to serialize JSON',
-      data: msg
+      data: message
     }).trim() + '\n';
   }
   try {
     return JSON.stringify(data, null, 2).trim() + '\n';
   } catch (e) {
-    debug.debugFn('Unexpected error:\n', e);
+    debug.debugFn('catch: unexpected\n', e);
     process.exitCode = 1;
+
     // This could be caused by circular references, which is an "us" problem
-    const msg = 'There was a problem converting the data set to JSON. Please try again without --json';
-    logger.logger.fail(msg);
+    const message = 'There was a problem converting the data set to JSON. Please try again without --json';
+    logger.logger.fail(message);
     return JSON.stringify({
       ok: false,
       message: 'Unable to serialize JSON',
-      data: msg
+      data: message
     }).trim() + '\n';
   }
 }
@@ -1462,7 +1469,7 @@ function findNpmPathSync(npmBinPath) {
   }
 }
 async function getPackageFilesForScan(cwd, inputPaths, supportedFiles, config) {
-  debug.debugFn(`Resolving ${inputPaths.length} paths:\n`, inputPaths);
+  debug.debugFn(`resolve: ${inputPaths.length} paths`, inputPaths);
 
   // Lazily access constants.spinner.
   const {
@@ -1483,7 +1490,7 @@ async function getPackageFilesForScan(cwd, inputPaths, supportedFiles, config) {
   }
   const packageFiles = await filterGlobResultToSupportedFiles(entries, supportedFiles);
   spinner.successAndStop(`Found ${packageFiles.length} local ${words.pluralize('file', packageFiles.length)}`);
-  debug.debugFn('Absolute paths:\n', packageFiles);
+  debug.debugFn('paths: absolute', packageFiles);
   return packageFiles;
 }
 
@@ -2266,8 +2273,7 @@ function getCveInfoFromAlertsMap(alertsMap, options_) {
             error = e;
           }
         }
-        debug.debugFn('Unexpected condition: Invalid SocketPackageAlert.');
-        debug.debugDir(alert);
+        debug.debugFn('fail: invalid SocketPackageAlert\n', alert);
         if (error) {
           // Explicitly use debugLog here.
           debug.debugLog(error);
@@ -2660,57 +2666,6 @@ const {
 } = constants;
 const AGENTS = [BUN, NPM, PNPM, YARN_BERRY, YARN_CLASSIC, VLT];
 const binByAgent = new Map([[BUN, BUN], [NPM, NPM], [PNPM, PNPM], [YARN_BERRY, YARN], [YARN_CLASSIC, YARN], [VLT, VLT]]);
-async function getAgentExecPath(agent) {
-  const binName = binByAgent.get(agent);
-  if (binName === NPM) {
-    // Lazily access constants.npmExecPath.
-    return constants.npmExecPath;
-  }
-  return (await vendor.libExports$1(binName, {
-    nothrow: true
-  })) ?? binName;
-}
-async function getAgentVersion(agentExecPath, cwd) {
-  let result;
-  try {
-    result =
-    // Coerce version output into a valid semver version by passing it through
-    // semver.coerce which strips leading v's, carets (^), comparators (<,<=,>,>=,=),
-    // and tildes (~).
-    vendor.semverExports.coerce(
-    // All package managers support the "--version" flag.
-    (await spawn.spawn(agentExecPath, ['--version'], {
-      cwd,
-      // Lazily access constants.WIN32.
-      shell: constants.WIN32
-    })).stdout.trim()) ?? undefined;
-  } catch (e) {
-    debug.debugFn('Unexpected error:\n', e);
-  }
-  return result;
-}
-
-// The order of LOCKS properties IS significant as it affects iteration order.
-const LOCKS = {
-  [`bun${LOCK_EXT}`]: BUN,
-  [`bun${BINARY_LOCK_EXT}`]: BUN,
-  // If both package-lock.json and npm-shrinkwrap.json are present in the root
-  // of a project, npm-shrinkwrap.json will take precedence and package-lock.json
-  // will be ignored.
-  // https://docs.npmjs.com/cli/v10/configuring-npm/package-lock-json#package-lockjson-vs-npm-shrinkwrapjson
-  'npm-shrinkwrap.json': NPM,
-  'package-lock.json': NPM,
-  'pnpm-lock.yaml': PNPM,
-  'pnpm-lock.yml': PNPM,
-  [`yarn${LOCK_EXT}`]: YARN_CLASSIC,
-  'vlt-lock.json': VLT,
-  // Lastly, look for a hidden lock file which is present if .npmrc has package-lock=false:
-  // https://docs.npmjs.com/cli/v10/configuring-npm/package-lock-json#hidden-lockfiles
-  //
-  // Unlike the other LOCKS keys this key contains a directory AND filename so
-  // it has to be handled differently.
-  'node_modules/.package-lock.json': NPM
-};
 const readLockFileByAgent = (() => {
   function wrapReader(reader) {
     return async (...args) => {
@@ -2746,6 +2701,57 @@ const readLockFileByAgent = (() => {
     return undefined;
   })], [NPM, defaultReader], [PNPM, defaultReader], [VLT, defaultReader], [YARN_BERRY, defaultReader], [YARN_CLASSIC, defaultReader]]);
 })();
+
+// The order of LOCKS properties IS significant as it affects iteration order.
+const LOCKS = {
+  [`bun${LOCK_EXT}`]: BUN,
+  [`bun${BINARY_LOCK_EXT}`]: BUN,
+  // If both package-lock.json and npm-shrinkwrap.json are present in the root
+  // of a project, npm-shrinkwrap.json will take precedence and package-lock.json
+  // will be ignored.
+  // https://docs.npmjs.com/cli/v10/configuring-npm/package-lock-json#package-lockjson-vs-npm-shrinkwrapjson
+  'npm-shrinkwrap.json': NPM,
+  'package-lock.json': NPM,
+  'pnpm-lock.yaml': PNPM,
+  'pnpm-lock.yml': PNPM,
+  [`yarn${LOCK_EXT}`]: YARN_CLASSIC,
+  'vlt-lock.json': VLT,
+  // Lastly, look for a hidden lock file which is present if .npmrc has package-lock=false:
+  // https://docs.npmjs.com/cli/v10/configuring-npm/package-lock-json#hidden-lockfiles
+  //
+  // Unlike the other LOCKS keys this key contains a directory AND filename so
+  // it has to be handled differently.
+  'node_modules/.package-lock.json': NPM
+};
+async function getAgentExecPath(agent) {
+  const binName = binByAgent.get(agent);
+  if (binName === NPM) {
+    // Lazily access constants.npmExecPath.
+    return constants.npmExecPath;
+  }
+  return (await vendor.libExports$1(binName, {
+    nothrow: true
+  })) ?? binName;
+}
+async function getAgentVersion(agentExecPath, cwd) {
+  let result;
+  try {
+    result =
+    // Coerce version output into a valid semver version by passing it through
+    // semver.coerce which strips leading v's, carets (^), comparators (<,<=,>,>=,=),
+    // and tildes (~).
+    vendor.semverExports.coerce(
+    // All package managers support the "--version" flag.
+    (await spawn.spawn(agentExecPath, ['--version'], {
+      cwd,
+      // Lazily access constants.WIN32.
+      shell: constants.WIN32
+    })).stdout.trim()) ?? undefined;
+  } catch (e) {
+    debug.debugFn('catch: unexpected\n', e);
+  }
+  return result;
+}
 async function detectPackageEnvironment({
   cwd = process.cwd(),
   onUnknown
@@ -2902,38 +2908,62 @@ async function detectAndValidatePackageEnvironment(cwd, options) {
   const agentVersion = details.agentVersion ?? 'unknown';
   if (!details.agentSupported) {
     const minVersion = constants.minimumVersionByAgent.get(agent);
-    logger?.fail(cmdPrefixMessage(cmdName, `Requires ${agent} >=${minVersion}. Current version: ${agentVersion}.`));
-    return;
+    return {
+      ok: false,
+      message: 'Version Mismatch',
+      cause: cmdPrefixMessage(cmdName, `Requires ${agent} >=${minVersion}. Current version: ${agentVersion}.`)
+    };
   }
   if (!details.nodeSupported) {
     const minVersion = constants.maintainedNodeVersions.last;
-    logger?.fail(cmdPrefixMessage(cmdName, `Requires Node >=${minVersion}. Current version: ${nodeVersion}.`));
-    return;
+    return {
+      ok: false,
+      message: 'Version Mismatch',
+      cause: cmdPrefixMessage(cmdName, `Requires Node >=${minVersion}. Current version: ${nodeVersion}.`)
+    };
   }
   if (!details.pkgSupports.agent) {
-    logger?.fail(cmdPrefixMessage(cmdName, `Package engine "${agent}" requires ${pkgRequirements.agent}. Current version: ${agentVersion}`));
-    return;
+    return {
+      ok: false,
+      message: 'Engine Mismatch',
+      cause: cmdPrefixMessage(cmdName, `Package engine "${agent}" requires ${pkgRequirements.agent}. Current version: ${agentVersion}`)
+    };
   }
   if (!details.pkgSupports.node) {
-    logger?.fail(cmdPrefixMessage(cmdName, `Package engine "node" requires ${pkgRequirements.node}. Current version: ${nodeVersion}`));
-    return;
+    return {
+      ok: false,
+      message: 'Version Mismatch',
+      cause: cmdPrefixMessage(cmdName, `Package engine "node" requires ${pkgRequirements.node}. Current version: ${nodeVersion}`)
+    };
   }
   const lockName = details.lockName ?? 'lock file';
   if (details.lockName === undefined || details.lockSrc === undefined) {
-    logger?.fail(cmdPrefixMessage(cmdName, `No ${lockName} found`));
-    return;
+    return {
+      ok: false,
+      message: 'Missing Lock File',
+      cause: cmdPrefixMessage(cmdName, `No ${lockName} found`)
+    };
   }
   if (details.lockSrc.trim() === '') {
-    logger?.fail(cmdPrefixMessage(cmdName, `${lockName} is empty`));
-    return;
+    return {
+      ok: false,
+      message: 'Empty Lock File',
+      cause: cmdPrefixMessage(cmdName, `${lockName} is empty`)
+    };
   }
   if (details.pkgPath === undefined) {
-    logger?.fail(cmdPrefixMessage(cmdName, `No ${PACKAGE_JSON} found`));
-    return;
+    return {
+      ok: false,
+      message: 'Missing package.json',
+      cause: cmdPrefixMessage(cmdName, `No ${PACKAGE_JSON} found`)
+    };
   }
   if (prod && (agent === BUN || agent === YARN_BERRY)) {
-    logger?.fail(cmdPrefixMessage(cmdName, `--prod not supported for ${agent}${agentVersion ? `@${agentVersion}` : ''}`));
-    return;
+    return {
+      ok: false,
+      message: 'Bad input',
+      cause: cmdPrefixMessage(cmdName, `--prod not supported for ${agent}${agentVersion ? `@${agentVersion}` : ''}`)
+    };
   }
   if (details.lockPath && path.relative(cwd, details.lockPath).startsWith('.')) {
     // Note: In tests we return <redacted> because otherwise snapshots will fail.
@@ -2944,7 +2974,10 @@ async function detectAndValidatePackageEnvironment(cwd, options) {
     const redacting = constants.ENV.VITEST;
     logger?.warn(cmdPrefixMessage(cmdName, `Package ${lockName} found at ${redacting ? REDACTED : details.lockPath}`));
   }
-  return details;
+  return {
+    ok: true,
+    data: details
+  };
 }
 
 const COMPLETION_CMD_PREFIX = 'complete -F _socket_completion';
@@ -3086,5 +3119,5 @@ exports.updateConfigValue = updateConfigValue;
 exports.validationFlags = validationFlags;
 exports.walkNestedMap = walkNestedMap;
 exports.writeSocketJson = writeSocketJson;
-//# debugId=ec929ce8-d2ad-4474-bc64-e03115717674
+//# debugId=b1554986-4b7c-4c24-bcf5-3821d9e3eb87
 //# sourceMappingURL=utils.js.map