Rename issue to alert

Author: jdalton

.config/rollup.test.config.mjs

@@ -18,8 +18,8 @@ const {
 
 export default () =>
   baseConfig({
-    input: ['alert-rules', 'errors', 'path-resolve'].reduce((o, k) => {
-      o[k] = `${rootSrcPath}/utils/${k}.ts`
+    input: ['alert/rules', 'errors', 'path-resolve'].reduce((o, k) => {
+      o[k.replaceAll('/', '-')] = `${rootSrcPath}/utils/${k}.ts`
       return o
     }, {}),
     output: [

src/commands/info.ts

@@ -7,20 +7,20 @@ import constants from '@socketsecurity/registry/lib/constants'
 import { Spinner } from '@socketsecurity/registry/lib/spinner'
 
 import { commonFlags, outputFlags, validationFlags } from '../flags'
+import { formatSeverityCount, getSeverityCount } from '../utils/alert/severity'
 import { handleApiCall, handleUnsuccessfulApiResponse } from '../utils/api'
 import { ColorOrMarkdown } from '../utils/color-or-markdown'
 import { InputError } from '../utils/errors'
 import { objectSome } from '../utils/objects'
 import { getFlagListOutput } from '../utils/output-formatting'
 import { getPublicToken, setupSdk } from '../utils/sdk'
-import { formatSeverityCount, getSeverityCount } from '../utils/sdk-issues'
 import {
   getSocketDevAlertUrl,
   getSocketDevPackageOverviewUrl
 } from '../utils/socket-url'
 
+import type { SocketAlert } from '../utils/alert/severity'
 import type { CliSubcommand } from '../utils/meow-with-subcommands'
-import type { SocketIssue } from '../utils/sdk-issues'
 import type { SocketSdkReturnType } from '@socketsecurity/sdk'
 
 const { NPM } = constants
@@ -129,7 +129,7 @@ function setupCommand(
 
 interface PackageData {
   data: SocketSdkReturnType<'getIssuesByNPMPackage'>['data']
-  severityCount: Record<SocketIssue['severity'], number>
+  severityCount: Record<SocketAlert['severity'], number>
   score: SocketSdkReturnType<'getScoreByNPMPackage'>['data']
 }
 

src/commands/optimize.ts

@@ -1,4 +1,3 @@
-import fs from 'node:fs/promises'
 import path from 'node:path'
 import process from 'node:process'
 
@@ -28,7 +27,7 @@ import { pluralize } from '@socketsecurity/registry/lib/words'
 
 import constants from '../constants'
 import { commonFlags } from '../flags'
-import { existsSync } from '../utils/fs'
+import { safeReadFile } from '../utils/fs'
 import { getFlagListOutput } from '../utils/output-formatting'
 import { detect } from '../utils/package-manager-detector'
 import { shadowNpmInstall } from '../utils/shadow-npm'
@@ -541,12 +540,11 @@ async function getWorkspaceGlobs(
       path.join(pkgPath!, `${PNPM_WORKSPACE}.yaml`),
       path.join(pkgPath!, `${PNPM_WORKSPACE}.yml`)
     ]) {
-      if (existsSync(workspacePath)) {
+      // eslint-disable-next-line no-await-in-loop
+      const yml = <string | undefined>await safeReadFile(workspacePath, 'utf8')
+      if (yml) {
         try {
-          workspacePatterns = yamlParse(
-            // eslint-disable-next-line no-await-in-loop
-            await fs.readFile(workspacePath, 'utf8')
-          )?.packages
+          workspacePatterns = yamlParse(yml)?.packages
         } catch {}
         if (workspacePatterns) {
           break

src/commands/report/view.ts

@@ -7,12 +7,15 @@ import colors from 'yoctocolors-cjs'
 import { Spinner } from '@socketsecurity/registry/lib/spinner'
 
 import { commonFlags, outputFlags, validationFlags } from '../../flags'
+import {
+  formatSeverityCount,
+  getSeverityCount
+} from '../../utils/alert/severity'
 import { handleApiCall, handleUnsuccessfulApiResponse } from '../../utils/api'
 import { ColorOrMarkdown } from '../../utils/color-or-markdown'
 import { InputError } from '../../utils/errors'
 import { getFlagListOutput } from '../../utils/output-formatting'
 import { setupSdk } from '../../utils/sdk'
-import { formatSeverityCount, getSeverityCount } from '../../utils/sdk-issues'
 
 import type { CliSubcommand } from '../../utils/meow-with-subcommands'
 import type {

src/shadow/arborist/lib/arborist/reify.ts

@@ -15,7 +15,7 @@ import { Spinner } from '@socketsecurity/registry/lib/spinner'
 import { batchScan, isAlertFixable, isAlertFixableCve, walk } from './alerts'
 import { kCtorArgs, kRiskyReify } from './index'
 import constants from '../../../../constants'
-import { uxLookup } from '../../../../utils/alert-rules'
+import { uxLookup } from '../../../../utils/alert/rules'
 import { ColorOrMarkdown } from '../../../../utils/color-or-markdown'
 import { debugLog } from '../../../../utils/debug'
 import { getSocketDevPackageOverviewUrl } from '../../../../utils/socket-url'
@@ -400,9 +400,7 @@ export async function reify(
       )
     })())
   if (proceed) {
-    const fix =
-      !!alerts?.length &&
-      bypassConfirms /*||
+    const fix = !!alerts?.length && bypassConfirms /*||
         (await confirm(
           {
             message: 'Try to fix alerts?',

src/utils/alert-rules.ts renamed to src/utils/alert/rules.ts

@@ -1,15 +1,11 @@
-import { readFileSync } from 'node:fs'
-import path from 'node:path'
-import process from 'node:process'
 import { setTimeout as wait } from 'node:timers/promises'
 
-import config from '@socketsecurity/config'
 import { isObject } from '@socketsecurity/registry/lib/objects'
 
-import { isErrnoException } from './errors'
-import { getPublicToken, setupSdk } from './sdk'
-import { getSetting } from './settings'
-import constants from '../constants'
+import constants from '../../constants'
+import { isErrnoException } from '../errors'
+import { getPublicToken, setupSdk } from '../sdk'
+import { findSocketYmlSync, getSetting } from '../settings'
 
 import type { SocketSdkResultType } from '@socketsecurity/sdk'
 
@@ -60,39 +56,6 @@ const WARN_UX: RuleActionUX = {
   display: true
 }
 
-function findSocketYmlSync() {
-  let prevDir = null
-  let dir = process.cwd()
-  while (dir !== prevDir) {
-    let ymlPath = path.join(dir, 'socket.yml')
-    let yml = maybeReadfileSync(ymlPath)
-    if (yml === undefined) {
-      ymlPath = path.join(dir, 'socket.yaml')
-      yml = maybeReadfileSync(ymlPath)
-    }
-    if (typeof yml === 'string') {
-      try {
-        return {
-          path: ymlPath,
-          parsed: config.parseSocketConfig(yml)
-        }
-      } catch {
-        throw new Error(`Found file but was unable to parse ${ymlPath}`)
-      }
-    }
-    prevDir = dir
-    dir = path.join(dir, '..')
-  }
-  return null
-}
-
-function maybeReadfileSync(filepath: string): string | undefined {
-  try {
-    return readFileSync(filepath, 'utf8')
-  } catch {}
-  return undefined
-}
-
 // Iterates over all entries with ordered issue rule for deferral.  Iterates over
 // all issue rules and finds the first defined value that does not defer otherwise
 // uses the defaultValue. Takes the value and converts into a UX workflow.

src/utils/sdk-issues.ts renamed to src/utils/alert/severity.ts

@@ -1,27 +1,28 @@
-import { pick } from './objects'
-import { stringJoinWithSeparateFinalSeparator } from './strings'
+import { pick } from '../objects'
+import { stringJoinWithSeparateFinalSeparator } from '../strings'
 
 import type { SocketSdkReturnType } from '@socketsecurity/sdk'
 
-type SocketIssueList = SocketSdkReturnType<'getIssuesByNPMPackage'>['data']
+type SocketAlertList = SocketSdkReturnType<'getIssuesByNPMPackage'>['data']
 
-export type SocketIssue = SocketIssueList[number]['value'] extends
+export type SocketAlert = SocketAlertList[number]['value'] extends
   | infer U
   | undefined
   ? U
   : never
 
-const SEVERITIES_BY_ORDER: SocketIssue['severity'][] = [
+// Ordered from most severe to least.
+const SEVERITIES_BY_ORDER: SocketAlert['severity'][] = [
   'critical',
   'high',
   'middle',
   'low'
 ]
 
 function getDesiredSeverities(
-  lowestToInclude: SocketIssue['severity'] | undefined
-): SocketIssue['severity'][] {
-  const result: SocketIssue['severity'][] = []
+  lowestToInclude: SocketAlert['severity'] | undefined
+): SocketAlert['severity'][] {
+  const result: SocketAlert['severity'][] = []
   for (const severity of SEVERITIES_BY_ORDER) {
     result.push(severity)
     if (severity === lowestToInclude) {
@@ -32,7 +33,7 @@ function getDesiredSeverities(
 }
 
 export function formatSeverityCount(
-  severityCount: Record<SocketIssue['severity'], number>
+  severityCount: Record<SocketAlert['severity'], number>
 ): string {
   const summary: string[] = []
   for (const severity of SEVERITIES_BY_ORDER) {
@@ -44,13 +45,13 @@ export function formatSeverityCount(
 }
 
 export function getSeverityCount(
-  issues: SocketIssueList,
-  lowestToInclude: SocketIssue['severity'] | undefined
-): Record<SocketIssue['severity'], number> {
+  issues: SocketAlertList,
+  lowestToInclude: SocketAlert['severity'] | undefined
+): Record<SocketAlert['severity'], number> {
   const severityCount = pick(
     { low: 0, middle: 0, high: 0, critical: 0 },
     getDesiredSeverities(lowestToInclude)
-  ) as Record<SocketIssue['severity'], number>
+  ) as Record<SocketAlert['severity'], number>
 
   for (const issue of issues) {
     const { value } = issue

src/utils/fs.ts

@@ -1,18 +1,15 @@
-import { existsSync as existsSync_, promises as fs } from 'node:fs'
+import {
+  promises as fs,
+  existsSync as fsExistsSync,
+  readFileSync as fsReadFileSync
+} from 'node:fs'
 import path from 'node:path'
 import process from 'node:process'
 
 import type { Abortable } from 'node:events'
 import type { ObjectEncodingOptions, OpenMode, PathLike } from 'node:fs'
 import type { FileHandle } from 'node:fs/promises'
 
-export function existsSync(filepath: any): filepath is PathLike {
-  try {
-    return filepath ? existsSync_(filepath) : false
-  } catch {}
-  return false
-}
-
 export async function findUp(
   name: string | string[],
   { cwd = process.cwd() }: { cwd: string | undefined }
@@ -60,3 +57,28 @@ export async function readFileUtf8(
     encoding: 'utf8'
   })
 }
+
+export function safeExistsSync(filepath: PathLike | undefined): boolean {
+  try {
+    return filepath ? fsExistsSync(filepath) : false
+  } catch {}
+  return false
+}
+
+export function safeReadFile(
+  ...args: Parameters<typeof fs.readFile>
+): ReturnType<typeof fs.readFile> | undefined {
+  try {
+    return fs.readFile(...args)
+  } catch {}
+  return undefined
+}
+
+export function safeReadFileSync(
+  ...args: Parameters<typeof fsReadFileSync>
+): ReturnType<typeof fsReadFileSync> | undefined {
+  try {
+    return fsReadFileSync(...args)
+  } catch {}
+  return undefined
+}

src/utils/package-manager-detector.ts

@@ -11,7 +11,7 @@ import { isObjectObject } from '@socketsecurity/registry/lib/objects'
 import { readPackageJson } from '@socketsecurity/registry/lib/packages'
 import { isNonEmptyString } from '@socketsecurity/registry/lib/strings'
 
-import { existsSync, findUp, readFileBinary, readFileUtf8 } from './fs'
+import { findUp, readFileBinary, readFileUtf8, safeExistsSync } from './fs'
 import constants from '../constants'
 
 import type { EditablePackageJson } from '@socketsecurity/registry/lib/packages'
@@ -173,8 +173,8 @@ export async function detect({
   const pkgJsonPath = lockPath
     ? path.resolve(lockPath, `${isHiddenLockFile ? '../' : ''}../package.json`)
     : await findUp('package.json', { cwd })
-  const pkgPath = existsSync(pkgJsonPath)
-    ? path.dirname(pkgJsonPath)
+  const pkgPath = safeExistsSync(pkgJsonPath)
+    ? path.dirname(pkgJsonPath!)
     : undefined
   const editablePkgJson = pkgPath
     ? await readPackageJson(pkgPath, { editable: true })

src/utils/settings.ts

@@ -1,8 +1,11 @@
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs'
+import { mkdirSync, writeFileSync } from 'node:fs'
 import os from 'node:os'
 import path from 'node:path'
 import process from 'node:process'
 
+import config from '@socketsecurity/config'
+
+import { safeReadFileSync } from './fs'
 import { logger } from './logging'
 import constants from '../constants'
 
@@ -21,8 +24,8 @@ function getSettings(): Settings {
     _settings = <Settings>{}
     const settingsPath = getSettingsPath()
     if (settingsPath) {
-      if (existsSync(settingsPath)) {
-        const raw = readFileSync(settingsPath, 'utf8')
+      const raw = <string | undefined>safeReadFileSync(settingsPath, 'utf8')
+      if (raw) {
         try {
           Object.assign(
             _settings,
@@ -70,6 +73,32 @@ function getSettingsPath(): string | undefined {
   return _settingsPath
 }
 
+export function findSocketYmlSync() {
+  let prevDir = null
+  let dir = process.cwd()
+  while (dir !== prevDir) {
+    let ymlPath = path.join(dir, 'socket.yml')
+    let yml = <string | undefined>safeReadFileSync(ymlPath, 'utf8')
+    if (yml === undefined) {
+      ymlPath = path.join(dir, 'socket.yaml')
+      yml = <string | undefined>safeReadFileSync(ymlPath, 'utf8')
+    }
+    if (typeof yml === 'string') {
+      try {
+        return {
+          path: ymlPath,
+          parsed: config.parseSocketConfig(yml)
+        }
+      } catch {
+        throw new Error(`Found file but was unable to parse ${ymlPath}`)
+      }
+    }
+    prevDir = dir
+    dir = path.join(dir, '..')
+  }
+  return null
+}
+
 export function getSetting<Key extends keyof Settings>(
   key: Key
 ): Settings[Key] {