Rename walk to getPackagesToQueryFromDiff

Author: jdalton

src/shadow/arborist/lib/arborist/walk.ts src/shadow/arborist/lib/arborist/diff.tssrc/shadow/arborist/lib/arborist/walk.ts renamed to src/shadow/arborist/lib/arborist/diff.ts

@@ -12,29 +12,29 @@ function toRepoUrl(resolved: string): string {
   return ''
 }
 
-export type InstallEffect = {
+export type PackageDetail = {
   pkgid: SafeNode['pkgid']
   repository_url: string
   existing?: SafeNode['pkgid'] | undefined
 }
 
-export type WalkOptions = { fix?: boolean }
+type GetPackagesToQueryFromDiffOptions = { includeUnchanged?: boolean }
 
-export function walk(
+export function getPackagesToQueryFromDiff(
   diff_: Diff | null,
-  options?: WalkOptions
-): InstallEffect[] {
+  options?: GetPackagesToQueryFromDiffOptions
+): PackageDetail[] {
   const {
     // Lazily access constants.IPC.
-    fix = constants.IPC[SOCKET_CLI_FIX_PACKAGE_LOCK_FILE]
-  } = <WalkOptions>{
+    includeUnchanged = constants.IPC[SOCKET_CLI_FIX_PACKAGE_LOCK_FILE]
+  } = <GetPackagesToQueryFromDiffOptions>{
     __proto__: null,
     ...options
   }
-  const needInfoOn: InstallEffect[] = []
+  const details: PackageDetail[] = []
   // `diff_` is `null` when `npm install --package-lock-only` is passed.
   if (!diff_) {
-    return needInfoOn
+    return details
   }
   const queue: Diff[] = [...diff_.children]
   let pos = 0
@@ -70,7 +70,7 @@ export function walk(
         keep = action !== 'REMOVE'
       }
       if (keep && pkgNode?.resolved && (!oldNode || oldNode.resolved)) {
-        needInfoOn.push({
+        details.push({
           existing,
           pkgid: pkgNode.pkgid,
           repository_url: toRepoUrl(pkgNode.resolved)
@@ -81,16 +81,16 @@ export function walk(
       queue[queueLength++] = child
     }
   }
-  if (fix) {
+  if (includeUnchanged) {
     const { unchanged } = diff_!
     for (let i = 0, { length } = unchanged; i < length; i += 1) {
       const pkgNode = unchanged[i]!
-      needInfoOn.push({
+      details.push({
         existing: pkgNode.pkgid,
         pkgid: pkgNode.pkgid,
         repository_url: toRepoUrl(pkgNode.resolved!)
       })
     }
   }
-  return needInfoOn
+  return details
 }

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

@@ -13,7 +13,7 @@ import { confirm } from '@socketsecurity/registry/lib/prompts'
 import { Spinner } from '@socketsecurity/registry/lib/spinner'
 
 import { kCtorArgs, kRiskyReify } from './index'
-import { walk } from './walk'
+import { getPackagesToQueryFromDiff } from './diff'
 import constants from '../../../../constants'
 import {
   batchScan,
@@ -370,7 +370,7 @@ export async function reify(
   this: SafeArborist,
   ...args: Parameters<InstanceType<ArboristClass>['reify']>
 ): Promise<SafeNode> {
-  const needInfoOn = walk(this.diff)
+  const needInfoOn = getPackagesToQueryFromDiff(this.diff)
   if (
     !needInfoOn.length ||
     needInfoOn.findIndex(c => c.repository_url === NPM_REGISTRY_URL) === -1
@@ -427,9 +427,13 @@ export async function reify(
         ret = await this[kRiskyReify](...args)
         await this.loadActual()
         await this.buildIdealTree()
-        alerts = await getPackagesAlerts(this, walk(this.diff, { fix: true }), {
-          fixable: true
-        })
+        alerts = await getPackagesAlerts(
+          this,
+          getPackagesToQueryFromDiff(this.diff, { includeUnchanged: true }),
+          {
+            fixable: true
+          }
+        )
         alerts = alerts.filter(a => {
           const { key } = a
           if (prev.has(key)) {