chore: extract TraversalNodeModuleCollector for fallback project parsing

.changeset/some-taxis-double.md

@@ -0,0 +1,5 @@
+---
+"app-builder-lib": patch
+---
+
+chore: move the manual node module traversal to the separate class. Add `env: { COREPACK_ENABLE_STRICT: "0", ...process.env },` to allow `npm list` to work across environments.

packages/app-builder-lib/scheme.json

@@ -7731,6 +7731,27 @@
         }
       ]
     },
+    "packageManager": {
+      "anyOf": [
+        {
+          "enum": [
+            "auto",
+            "bun",
+            "npm",
+            "pnpm",
+            "traversal",
+            "yarn",
+            "yarn-berry"
+          ],
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": "auto",
+      "description": "The package manager to use for installing dependencies and node module collections."
+    },
     "pacman": {
       "anyOf": [
         {

packages/app-builder-lib/src/configuration.ts

@@ -16,6 +16,7 @@ import { BuildResult } from "./packager"
 import { ArtifactBuildStarted, ArtifactCreated } from "./packagerApi"
 import { PlatformPackager } from "./platformPackager"
 import { NsisOptions, NsisWebOptions, PortableOptions } from "./targets/nsis/nsisOptions"
+import { PM } from "./node-module-collector"
 
 // duplicate appId here because it is important
 /**
@@ -134,6 +135,12 @@ export interface CommonConfiguration {
    */
   readonly nativeRebuilder?: "legacy" | "sequential" | "parallel" | null
 
+  /**
+   * The package manager to use for installing dependencies and node module collections.
+   * @default auto
+   */
+  readonly packageManager?: "auto" | PM | null
+
   /**
    * The build number. Maps to the `--iteration` flag for builds using FPM on Linux.
    * If not defined, then it will fallback to `BUILD_NUMBER` or `TRAVIS_BUILD_NUMBER` or `APPVEYOR_BUILD_NUMBER` or `CIRCLE_BUILD_NUM` or `BUILD_BUILDNUMBER` or `CI_PIPELINE_IID` env.

packages/app-builder-lib/src/index.ts

@@ -49,7 +49,7 @@ export { WindowsAzureSigningConfiguration, WindowsConfiguration, WindowsSigntool
 export { BuildResult, Packager } from "./packager"
 export { ArtifactBuildStarted, ArtifactCreated, PackagerOptions } from "./packagerApi"
 export { CommonNsisOptions, CustomNsisBinary, NsisOptions, NsisWebOptions, PortableOptions } from "./targets/nsis/nsisOptions"
-
+export { PM } from "./node-module-collector/packageManager"
 export { CancellationToken, ProgressInfo } from "builder-util-runtime"
 export { PublishOptions, UploadTask } from "electron-publish"
 export { WindowsSignOptions } from "./codeSign/windowsCodeSign"

packages/app-builder-lib/src/node-module-collector/bunNodeModulesCollector.ts

@@ -1,17 +1,13 @@
 import { log } from "builder-util"
-import { NpmNodeModulesCollector } from "./npmNodeModulesCollector"
 import { PM } from "./packageManager"
 import { NpmDependency } from "./types"
+import { TraversalNodeModulesCollector } from "./traversalNodeModulesCollector"
 
-export class BunNodeModulesCollector extends NpmNodeModulesCollector {
+export class BunNodeModulesCollector extends TraversalNodeModulesCollector {
   public readonly installOptions = { manager: PM.BUN, lockfile: "bun.lock" }
 
   protected async getDependenciesTree(_pm: PM): Promise<NpmDependency> {
-    log.info(null, "bun does not support any CLI for dependency tree extraction, falling back to NPM node module collector")
+    log.info(null, "note: bun does not support any CLI for dependency tree extraction, utilizing NPM node module collector instead")
     return super.getDependenciesTree(PM.NPM)
   }
-
-  protected isProdDependency(packageName: string, tree: NpmDependency): boolean {
-    return tree.dependencies?.[packageName] != null || tree.optionalDependencies?.[packageName] != null
-  }
 }

packages/app-builder-lib/src/node-module-collector/index.ts

@@ -11,21 +11,26 @@ import { Lazy } from "lazy-val"
 import { spawn, log, exists } from "builder-util"
 import * as fs from "fs-extra"
 import * as path from "path"
+import { TraversalNodeModulesCollector } from "./traversalNodeModulesCollector"
+import { Configuration } from "../configuration"
 
 export { getPackageManagerCommand, PM }
 
-export function getCollectorByPackageManager(pm: PM, rootDir: string, tempDirManager: TmpDir) {
+export function getCollectorByPackageManager(pm: PM, rootDir: string, tempDirManager: TmpDir, cancellationToken: CancellationToken) {
   switch (pm) {
     case PM.PNPM:
-      return new PnpmNodeModulesCollector(rootDir, tempDirManager)
+      return new PnpmNodeModulesCollector(rootDir, tempDirManager, cancellationToken)
     case PM.YARN:
-      return new YarnNodeModulesCollector(rootDir, tempDirManager)
+      return new YarnNodeModulesCollector(rootDir, tempDirManager, cancellationToken)
     case PM.YARN_BERRY:
-      return new YarnBerryNodeModulesCollector(rootDir, tempDirManager)
+      return new YarnBerryNodeModulesCollector(rootDir, tempDirManager, cancellationToken)
     case PM.BUN:
-      return new BunNodeModulesCollector(rootDir, tempDirManager)
+      return new BunNodeModulesCollector(rootDir, tempDirManager, cancellationToken)
     case PM.NPM:
-      return new NpmNodeModulesCollector(rootDir, tempDirManager)
+      return new NpmNodeModulesCollector(rootDir, tempDirManager, cancellationToken)
+    // should never access this case (as it's internally a fallback), but TS needs a default and we need to satisfy it
+    case PM.TRAVERSAL:
+      return new TraversalNodeModulesCollector(rootDir, tempDirManager, cancellationToken)
   }
 }
 
@@ -43,14 +48,28 @@ export function getNodeModules(
     packageName: string
   }
 ): Promise<NodeModuleInfo[]> {
-  const collector = getCollectorByPackageManager(pm, rootDir, tempDirManager)
-  return collector.getNodeModules({ cancellationToken, packageName })
+  const collector = getCollectorByPackageManager(pm, rootDir, tempDirManager, cancellationToken)
+  return collector.getNodeModules({ packageName })
 }
 
-export const determinePackageManagerEnv = ({ projectDir, appDir, workspaceRoot }: { projectDir: string; appDir: string; workspaceRoot: string | Nullish }) =>
+export const determinePackageManagerEnv = ({
+  projectDir,
+  appDir,
+  workspaceRoot,
+  packageManagerOverride,
+}: {
+  projectDir: string
+  appDir: string
+  workspaceRoot: string | Nullish
+  packageManagerOverride: Configuration["packageManager"]
+}) =>
   new Lazy(async () => {
     const availableDirs = [projectDir, appDir, workspaceRoot].filter((it): it is string => it != null)
-    const pm = await detectPackageManager(availableDirs)
+    const override =
+      packageManagerOverride != null && packageManagerOverride !== "auto"
+        ? { pm: packageManagerOverride, resolvedDirectory: availableDirs[0], corepackConfig: undefined, detectionMethod: "override" }
+        : null
+    const pm = override ?? (await detectPackageManager(availableDirs))
     const root = await findWorkspaceRoot(pm.pm, projectDir)
     if (root != null) {
       // re-detect package manager from workspace root, this seems particularly necessary for pnpm workspaces
@@ -93,7 +112,11 @@ async function findWorkspaceRoot(pm: PM, cwd: string): Promise<string | undefine
       break
   }
 
-  const output = await spawn(command.command, command.args, { cwd, stdio: ["ignore", "pipe", "ignore"] })
+  const output = await spawn(command.command, command.args, {
+    cwd,
+    env: { COREPACK_ENABLE_STRICT: "0", ...process.env }, // allow `process.env` overrides
+    stdio: ["ignore", "pipe", "ignore"],
+  })
     .then(async it => {
       const out: string | undefined = it?.trim()
       if (!out) {