@socketsecurity/cli-with-sentry 0.14.68 → 0.14.69

package/dist/module-sync/config.d.ts

@@ -9,7 +9,16 @@ interface LocalConfig {
 }
 declare const supportedConfigKeys: Map<keyof LocalConfig, string>
 declare const sensitiveConfigKeys: Set<keyof LocalConfig>
-declare function overrideCachedConfig(config: object): void
+declare function overrideCachedConfig(jsonConfig: unknown):
+  | {
+      ok: true
+      message: undefined
+    }
+  | {
+      ok: false
+      message: string
+    }
+declare function overrideConfigApiToken(apiToken: unknown): void
 declare function findSocketYmlSync(dir?: string): {
   path: string
   parsed: config.SocketYml
@@ -17,6 +26,7 @@ declare function findSocketYmlSync(dir?: string): {
 declare function getConfigValue<Key extends keyof LocalConfig>(
   key: Key
 ): LocalConfig[Key]
+declare function isReadOnlyConfig(): boolean
 declare function updateConfigValue<Key extends keyof LocalConfig>(
   key: keyof LocalConfig,
   value: LocalConfig[Key]
@@ -26,7 +36,9 @@ export {
   supportedConfigKeys,
   sensitiveConfigKeys,
   overrideCachedConfig,
+  overrideConfigApiToken,
   findSocketYmlSync,
   getConfigValue,
+  isReadOnlyConfig,
   updateConfigValue
 }

package/dist/module-sync/shadow-npm-inject.js

@@ -112,7 +112,7 @@ const supportedConfigKeys = new Map([
   ['apiToken', 'The API token required to access most API endpoints'],
   [
     'defaultOrg',
-    'The default org slug to use when appropriate; usually the org your API token has access to. When set, all orgSlug arguments are implied to be this value.'
+    'The default org slug to use; usually the org your API token has access to. When set, all orgSlug arguments are implied to be this value.'
   ],
   [
     'enforcedOrgs',
@@ -121,18 +121,55 @@ const supportedConfigKeys = new Map([
 ])
 const sensitiveConfigKeys = new Set(['apiToken'])
 let _cachedConfig
-// When using --config or SOCKET_CLI_CONFIG_OVERRIDE, do not persist the config.
+// When using --config or SOCKET_CLI_CONFIG, do not persist the config.
 let _readOnlyConfig = false
-function overrideCachedConfig(config) {
-  _cachedConfig = {
-    ...config
+function overrideCachedConfig(jsonConfig) {
+  let config
+  try {
+    config = JSON.parse(String(jsonConfig))
+    if (!config || typeof config !== 'object') {
+      // Just throw to reuse the error message. `null` is valid json,
+      // so are primitive values. They're not valid config objects :)
+      throw new Error()
+    }
+  } catch {
+    return {
+      ok: false,
+      message:
+        "Could not JSON parse the config override. Make sure it's a proper JSON object (double-quoted keys and strings, no unquoted `undefined`) and try again."
+    }
   }
+
+  // @ts-ignore if you want to override an illegal object, so be it?
+  _cachedConfig = config
   _readOnlyConfig = true
+
   // Normalize apiKey to apiToken.
   if (_cachedConfig['apiKey']) {
+    if (_cachedConfig['apiToken']) {
+      logger.logger.warn(
+        'Note: The config override had both apiToken and apiKey. Using the apiToken value. Remove the apiKey to get rid of this message.'
+      )
+    }
     _cachedConfig['apiToken'] = _cachedConfig['apiKey']
     delete _cachedConfig['apiKey']
   }
+  return {
+    ok: true,
+    message: undefined
+  }
+}
+function overrideConfigApiToken(apiToken) {
+  // Set token to the local cached config and mark it read-only so it doesn't persist
+  _cachedConfig = {
+    ...config,
+    ...(apiToken === undefined
+      ? {}
+      : {
+          apiToken: String(apiToken)
+        })
+  }
+  _readOnlyConfig = true
 }
 function getConfigValues() {
   if (_cachedConfig === undefined) {
@@ -245,6 +282,9 @@ function getConfigValue(key) {
   const localConfig = getConfigValues()
   return localConfig[normalizeConfigKey(key)]
 }
+function isReadOnlyConfig() {
+  return _readOnlyConfig
+}
 let _pendingSave = false
 function updateConfigValue(key, value) {
   const localConfig = getConfigValues()
@@ -290,7 +330,7 @@ function captureExceptionSync(exception, hint) {
   if (!Sentry) {
     return ''
   }
-  debug.debugLog('captureException: Sending exception to Sentry.')
+  debug.debugLog('captureException: Sending exception to Sentry')
   return Sentry.captureException(exception, hint)
 }
 
@@ -366,7 +406,7 @@ async function setupSdk(
       // The '@rollup/plugin-replace' will replace "process.env['INLINED_SOCKET_CLI_NAME']".
       name: '@socketsecurity/cli',
       // The '@rollup/plugin-replace' will replace "process.env['INLINED_SOCKET_CLI_VERSION']".
-      version: '0.14.68',
+      version: '0.14.69',
       // The '@rollup/plugin-replace' will replace "process.env['INLINED_SOCKET_CLI_HOMEPAGE']".
       homepage: 'https://github.com/SocketDev/socket-cli'
     })
@@ -1732,7 +1772,7 @@ function getDetailsFromDiff(diff_, options) {
             existing = oldNode
           }
         } else {
-          debug.debugLog('SKIPPING META CHANGE ON', diff)
+          debug.debugLog('SKIPPING META CHANGE ON\n', diff)
         }
       } else {
         keep = action !== DiffAction.remove
@@ -1829,10 +1869,12 @@ function findPackageNodes(tree, packageName) {
   }
   return matches
 }
-async function getAlertsMapFromArborist(arb, options) {
-  const { include: _include, spinner } = {
+async function getAlertsMapFromArborist(arb, options_) {
+  const options = {
     __proto__: null,
-    ...options
+    consolidate: false,
+    nothrow: false,
+    ...options_
   }
   const include = {
     __proto__: null,
@@ -1842,8 +1884,9 @@ async function getAlertsMapFromArborist(arb, options) {
     existing: false,
     unfixable: true,
     upgradable: false,
-    ..._include
+    ...options.include
   }
+  const { spinner } = options
   const needInfoOn = getDetailsFromDiff(arb.diff, {
     include: {
       unchanged: include.existing
@@ -1872,11 +1915,12 @@ async function getAlertsMapFromArborist(arb, options) {
   }
   const sockSdk = await setupSdk(getPublicToken())
   const toAlertsMapOptions = {
-    ...options,
+    overrides,
+    consolidate: options.consolidate,
     include,
-    overrides
+    spinner
   }
-  for await (const batchPackageFetchResult of sockSdk.batchPackageStream(
+  for await (const batchResult of sockSdk.batchPackageStream(
     {
       alerts: 'true',
       compact: 'true',
@@ -1888,12 +1932,18 @@ async function getAlertsMapFromArborist(arb, options) {
       }))
     }
   )) {
-    if (batchPackageFetchResult.success) {
+    if (batchResult.success) {
       await addArtifactToAlertsMap(
-        batchPackageFetchResult.data,
+        batchResult.data,
         alertsByPkgId,
         toAlertsMapOptions
       )
+    } else if (!options.nothrow) {
+      const statusCode = batchResult.status ?? 'unknown'
+      const statusMessage = batchResult.error ?? 'No status message'
+      throw new Error(
+        `Socket API server error (${statusCode}): ${statusMessage}`
+      )
     }
     remaining -= 1
     if (spinner && remaining > 0) {
@@ -2143,7 +2193,9 @@ exports.getPublicToken = getPublicToken
 exports.getSeverityCount = getSeverityCount
 exports.getSocketDevAlertUrl = getSocketDevAlertUrl
 exports.getSocketDevPackageOverviewUrl = getSocketDevPackageOverviewUrl
+exports.isReadOnlyConfig = isReadOnlyConfig
 exports.overrideCachedConfig = overrideCachedConfig
+exports.overrideConfigApiToken = overrideConfigApiToken
 exports.readFileBinary = readFileBinary
 exports.readFileUtf8 = readFileUtf8
 exports.safeReadFile = safeReadFile
@@ -2152,5 +2204,5 @@ exports.setupSdk = setupSdk
 exports.supportedConfigKeys = supportedConfigKeys
 exports.updateConfigValue = updateConfigValue
 exports.updateNode = updateNode
-//# debugId=c4cc0383-a1f3-4096-bddd-173589820ed1
+//# debugId=cdcd5c63-68c6-42dc-b74c-fbaa59735aeb
 //# sourceMappingURL=shadow-npm-inject.js.map