Better naming of things

Author: jdalton

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

@@ -15,23 +15,21 @@ import { Spinner } from '@socketsecurity/registry/lib/spinner'
 import { kCtorArgs, kRiskyReify } from './index'
 import { walk } from './walk'
 import constants from '../../../../constants'
-import { uxLookup } from '../../../../utils/alert/rules'
 import {
   batchScan,
-  isAlertFixable,
-  isAlertFixableCve
-} from '../../../../utils/alert/scan'
+  isArtifactAlertCveFixable,
+  isArtifactAlertFixable
+} from '../../../../utils/alert/artifact'
+import { uxLookup } from '../../../../utils/alert/rules'
 import { ColorOrMarkdown } from '../../../../utils/color-or-markdown'
 import { debugLog } from '../../../../utils/debug'
 import { getSocketDevPackageOverviewUrl } from '../../../../utils/socket-url'
 import { pacotePath } from '../../../npm-paths'
 import { Edge, SafeEdge } from '../edge'
 
 import type { ArboristClass, AuditAdvisory, SafeArborist } from './index'
-import type {
-  InstallEffect,
-  SocketScanArtifact
-} from '../../../../utils/alert/scan'
+import type { InstallEffect } from './walk'
+import type { SocketArtifact } from '../../../../utils/alert/artifact'
 import type { SafeNode } from '../node'
 import type { Writable } from 'node:stream'
 
@@ -151,7 +149,7 @@ async function getPackagesAlerts(
           displayWarning = true
         }
         if (ux.block || ux.display) {
-          const isFixable = isAlertFixable(alert)
+          const isFixable = isArtifactAlertFixable(alert)
           if (!fixable || isFixable) {
             alerts.push({
               name,
@@ -171,7 +169,7 @@ async function getPackagesAlerts(
               p.existing?.startsWith(`${name}@`)
             )?.existing
             if (existing) {
-              const oldArtifact: SocketScanArtifact | undefined =
+              const oldArtifact: SocketArtifact | undefined =
                 // eslint-disable-next-line no-await-in-loop
                 (await batchScan([existing]).next()).value
               if (oldArtifact?.alerts?.length) {
@@ -254,7 +252,7 @@ function getTranslations() {
 function packageAlertsToReport(alerts: SocketPackageAlert[]) {
   let report: { [dependency: string]: AuditAdvisory[] } | null = null
   for (const alert of alerts) {
-    if (!isAlertFixableCve(alert.raw)) {
+    if (!isArtifactAlertCveFixable(alert.raw)) {
       continue
     }
     const { name } = alert

src/utils/alert/scan.ts renamed to src/utils/alert/artifact.ts

@@ -5,15 +5,7 @@ import rl from 'node:readline'
 import constants from '../../constants'
 import { getPublicToken } from '../sdk'
 
-import type { SafeNode } from '../../shadow/arborist/lib/node'
-
-export type InstallEffect = {
-  pkgid: SafeNode['pkgid']
-  repository_url: string
-  existing?: SafeNode['pkgid'] | undefined
-}
-
-export type SocketScanArtifactAlert = {
+export type SocketArtifactAlert = {
   key: string
   type: string
   severity: string
@@ -26,7 +18,7 @@ export type SocketScanArtifactAlert = {
   end?: number
 }
 
-export type SocketScanArtifact = {
+export type SocketArtifact = {
   type: string
   namespace?: string
   name?: string
@@ -59,7 +51,7 @@ export type SocketScanArtifact = {
     license: number
     overall: number
   }
-  alerts?: SocketScanArtifactAlert[]
+  alerts?: SocketArtifactAlert[]
   size?: number
   batchIndex?: number
 }
@@ -68,7 +60,7 @@ const { API_V0_URL, abortSignal } = constants
 
 export async function* batchScan(
   pkgIds: string[]
-): AsyncGenerator<SocketScanArtifact> {
+): AsyncGenerator<SocketArtifact> {
   const req = https
     .request(`${API_V0_URL}/purl?alerts=true`, {
       method: 'POST',
@@ -93,11 +85,7 @@ export async function* batchScan(
   }
 }
 
-export function isAlertFixable(alert: SocketScanArtifactAlert): boolean {
-  return alert.type === 'socketUpgradeAvailable' || isAlertFixableCve(alert)
-}
-
-export function isAlertFixableCve(alert: SocketScanArtifactAlert): boolean {
+export function isArtifactAlertCveFixable(alert: SocketArtifactAlert): boolean {
   const { type } = alert
   return (
     (type === 'cve' ||
@@ -107,3 +95,9 @@ export function isAlertFixableCve(alert: SocketScanArtifactAlert): boolean {
     !!alert.props?.['firstPatchedVersionIdentifier']
   )
 }
+
+export function isArtifactAlertFixable(alert: SocketArtifactAlert): boolean {
+  return (
+    alert.type === 'socketUpgradeAvailable' || isArtifactAlertCveFixable(alert)
+  )
+}