Nudge folks to file an issue for some errors

Author: jdalton

src/commands/optimize.ts

@@ -25,7 +25,10 @@ import { escapeRegExp } from '@socketsecurity/registry/lib/regexps'
 import { isNonEmptyString } from '@socketsecurity/registry/lib/strings'
 import { pluralize } from '@socketsecurity/registry/lib/words'
 
-import { distPath } from '../constants'
+import {
+  UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE,
+  distPath
+} from '../constants'
 import { commonFlags } from '../flags'
 import { printFlagList } from '../utils/formatting'
 import { existsSync } from '../utils/fs'
@@ -44,6 +47,7 @@ type PackageJson = Awaited<ReturnType<typeof readPackageJson>>
 
 const COMMAND_TITLE = 'Socket Optimize'
 const OVERRIDES_FIELD_NAME = 'overrides'
+const NPM_OVERRIDE_PR_URL = 'https://github.com/npm/cli/pull/7025'
 const PNPM_FIELD_NAME = 'pnpm'
 const PNPM_WORKSPACE = 'pnpm-workspace'
 const RESOLUTIONS_FIELD_NAME = 'resolutions'
@@ -898,7 +902,7 @@ export const optimize: CliSubcommand = {
               stdio: 'ignore',
               env: {
                 ...process.env,
-                UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE: '1'
+                [UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE]: '1'
               }
             }
           )
@@ -909,7 +913,7 @@ export const optimize: CliSubcommand = {
         spinner.stop()
         if (isNpm) {
           console.log(
-            `💡 Re-run ${COMMAND_TITLE} whenever ${lockName} changes.\n   This can be skipped once npm ships https://github.com/npm/cli/pull/7025.`
+            `💡 Re-run ${COMMAND_TITLE} whenever ${lockName} changes.\n   This can be skipped once npm ships ${NPM_OVERRIDE_PR_URL}.`
           )
         }
       } catch {

src/constants.ts

@@ -16,17 +16,23 @@ export const API_V0_URL = 'https://api.socket.dev/v0'
 
 export const DIST_TYPE = SUPPORTS_SYNC_ESM ? 'module-sync' : 'require'
 
+export const LOOP_SENTINEL = 1_000_000
+
+export const NPM_REGISTRY_URL = 'https://registry.npmjs.org'
+
+export const SOCKET_CLI_ISSUES_URL =
+  'https://github.com/SocketDev/socket-cli/issues'
+
+export const UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE =
+  'UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE'
+
 export const ENV = Object.freeze({
   // Flag set by the optimize command to bypass the packagesHaveRiskyIssues check.
-  UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE: envAsBoolean(
-    process.env['UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE']
+  [UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE]: envAsBoolean(
+    process.env[UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE]
   )
 })
 
-export const LOOP_SENTINEL = 1_000_000
-
-export const NPM_REGISTRY_URL = 'https://registry.npmjs.org'
-
 // Dynamically detect the rootPath so constants.ts can be used in tests.
 export const rootPath = (() => {
   let oldPath
@@ -50,7 +56,9 @@ export const rootPath = (() => {
     oldPath = currPath
     currPath = path.dirname(currPath)
   }
-  throw new TypeError('rootPath cannot be resolved.')
+  throw new TypeError(
+    `Socket CLI initialization error: rootPath cannot be resolved.\n\nPlease report to ${SOCKET_CLI_ISSUES_URL}.`
+  )
 })()
 export const rootDistPath = path.join(rootPath, 'dist')
 export const rootBinPath = path.join(rootPath, 'bin')

src/shadow/arborist.ts

@@ -20,6 +20,8 @@ import {
   ENV,
   LOOP_SENTINEL,
   NPM_REGISTRY_URL,
+  SOCKET_CLI_ISSUES_URL,
+  UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE,
   rootPath
 } from '../constants'
 import { ColorOrMarkdown } from '../utils/color-or-markdown'
@@ -155,8 +157,7 @@ type RequireTransformer<T extends keyof KnownModules> = (
   mod: KnownModules[T]
 ) => KnownModules[T]
 
-const POTENTIALLY_BUG_ERROR_SNIPPET =
-  'this is potentially a bug with socket-npm caused by changes to the npm cli'
+const POTENTIAL_BUG_ERROR_MESSAGE = `This is may be a bug with socket-npm related to changes to the npm CLI.\nPlease report to ${SOCKET_CLI_ISSUES_URL}.`
 
 const npmEntrypoint = realpathSync(process.argv[1]!)
 const npmRootPath = findRoot(path.dirname(npmEntrypoint))
@@ -188,9 +189,8 @@ function tryRequire<T extends keyof KnownModules>(
 
 if (npmRootPath === undefined) {
   console.error(
-    `Unable to find npm cli install directory, ${POTENTIALLY_BUG_ERROR_SNIPPET}.`
+    `Unable to find npm CLI install directory.\nSearched parent directories of ${npmEntrypoint}.\n\n${POTENTIAL_BUG_ERROR_MESSAGE}`
   )
-  console.error(`Searched parent directories of ${npmEntrypoint}`)
   process.exit(127)
 }
 
@@ -218,7 +218,7 @@ const log = tryRequire(
 
 if (log === undefined) {
   console.error(
-    `Unable to integrate with npm cli logging infrastructure, ${POTENTIALLY_BUG_ERROR_SNIPPET}.`
+    `Unable to integrate with npm CLI logging infrastructure.\n\n${POTENTIAL_BUG_ERROR_MESSAGE}.`
   )
   process.exit(127)
 }
@@ -1299,7 +1299,7 @@ export class SafeArborist extends Arborist {
     if (diff.findIndex(c => c.repository_url === NPM_REGISTRY_URL) === -1) {
       return await this[kRiskyReify](...args)
     }
-    let proceed = ENV.UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE
+    let proceed = ENV[UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE]
     if (!proceed) {
       proceed = await ttyServer.captureTTY(async (input, output) => {
         if (input && output) {