fix: missing ms package when pruning non-prod dependencies (#8851)

Author: beyondkmp

.changeset/many-lemons-press.md

@@ -0,0 +1,5 @@
+---
+"app-builder-lib": patch
+---
+
+Fix the issue of the missing ms package

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

@@ -7,6 +7,7 @@ import { exec, log } from "builder-util"
 export abstract class NodeModulesCollector {
   private nodeModules: NodeModuleInfo[]
   protected dependencyPathMap: Map<string, string>
+  protected allDependencies: Map<string, DependencyTree> = new Map()
 
   constructor(private readonly rootDir: string) {
     this.dependencyPathMap = new Map()
@@ -47,7 +48,7 @@ export abstract class NodeModulesCollector {
     }
   }
 
-  public convertToDependencyGraph(tree: DependencyTree): DependencyGraph {
+  private convertToDependencyGraph(tree: DependencyTree): DependencyGraph {
     const result: DependencyGraph = { ".": {} }
 
     const flatten = (node: DependencyTree, parentKey = ".") => {
@@ -73,6 +74,16 @@ export abstract class NodeModulesCollector {
     return result
   }
 
+  getAllDependencies(tree: DependencyTree) {
+    const dependencies = tree.dependencies || {}
+    for (const [key, value] of Object.entries(dependencies)) {
+      if (value.dependencies && Object.keys(value.dependencies).length > 0) {
+        this.allDependencies.set(`${key}@${value.version}`, value)
+        this.getAllDependencies(value)
+      }
+    }
+  }
+
   abstract getCommand(): string
   abstract getArgs(): string[]
   abstract removeNonProductionDependencie(tree: DependencyTree): void
@@ -139,6 +150,7 @@ export abstract class NodeModulesCollector {
   public async getNodeModules(): Promise<NodeModuleInfo[]> {
     const tree = await this.getDependenciesTree()
     const realTree = this.getTreeFromWorkspaces(tree)
+    this.getAllDependencies(realTree)
     this.removeNonProductionDependencie(realTree)
     const dependencyGraph = this.convertToDependencyGraph(realTree)
     const hoisterResult = hoist(this.transToHoisterTree(dependencyGraph), { check: true })

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

@@ -17,8 +17,12 @@ export class NpmNodeModulesCollector extends NodeModulesCollector {
   removeNonProductionDependencie(tree: DependencyTree) {
     const dependencies = tree.dependencies || {}
     const _dependencies = tree._dependencies || {}
+    if (dependencies && Object.keys(dependencies).length === 0) {
+      tree.dependencies = this.allDependencies.get(`${tree.name}@${tree.version}`)?.dependencies || {}
+    }
+
     for (const [key, value] of Object.entries(dependencies)) {
-      if (!_dependencies[key]) {
+      if (!_dependencies[key] || Object.keys(value).length === 0) {
         delete dependencies[key]
         continue
       }

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

@@ -11,7 +11,7 @@ export interface DependencyTree {
   readonly from?: string
   readonly workspaces?: string[]
   readonly path: string
-  dependencies: {
+  dependencies?: {
     [packageName: string]: DependencyTree
   }
   // for npm list --json

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

@@ -17,8 +17,12 @@ export class YarnNodeModulesCollector extends NodeModulesCollector {
   removeNonProductionDependencie(tree: DependencyTree) {
     const dependencies = tree.dependencies || {}
     const _dependencies = tree._dependencies || {}
+    if (dependencies && Object.keys(dependencies).length === 0) {
+      tree.dependencies = this.allDependencies.get(`${tree.name}@${tree.version}`)?.dependencies || {}
+    }
+
     for (const [key, value] of Object.entries(dependencies)) {
-      if (!_dependencies[key]) {
+      if (!_dependencies[key] || Object.keys(value).length === 0) {
         delete dependencies[key]
         continue
       }

test/snapshots/HoistedNodeModuleTest.js.snap

@@ -457,6 +457,41 @@ exports[`yarn electron-clear-data 2`] = `
 }
 `;
 
+exports[`yarn ms 1`] = `
+{
+  "linux": [],
+}
+`;
+
+exports[`yarn ms 2`] = `
+{
+  "description": "Tiny millisecond conversion utility",
+  "devDependencies": {
+    "eslint": "4.18.2",
+    "expect.js": "0.3.1",
+    "husky": "0.14.3",
+    "lint-staged": "5.0.0",
+    "mocha": "4.0.1",
+    "prettier": "2.0.5",
+  },
+  "files": [
+    "index.js",
+  ],
+  "license": "MIT",
+  "lint-staged": {
+    "*.js": [
+      "npm run lint",
+      "prettier --single-quote --write",
+      "git add",
+    ],
+  },
+  "main": "./index",
+  "name": "ms",
+  "repository": "vercel/ms",
+  "version": "2.1.3",
+}
+`;
+
 exports[`yarn parse-asn1 1`] = `
 {
   "linux": [],

test/src/HoistedNodeModuleTest.ts

@@ -198,6 +198,36 @@ test.ifAll("yarn some module add by manual instead of install", () =>
   )
 )
 
+//github.com/electron-userland/electron-builder/issues/8842
+test.ifAll("yarn ms", () =>
+  assertPack(
+    "test-app-hoisted",
+    {
+      targets: linuxDirTarget,
+    },
+    {
+      isInstallDepsBefore: true,
+      projectDirCreated: projectDir => {
+        return Promise.all([
+          modifyPackageJson(projectDir, data => {
+            data.dependencies = {
+              "@sentry/electron": "5.11.0",
+              "electron-clear-data": "^1.0.5",
+            }
+            data.devDependencies = {
+              electron: "34.0.2",
+            }
+          }),
+          outputFile(path.join(projectDir, "yarn.lock"), ""),
+        ])
+      },
+      packed: async context => {
+        expect(await readAsarJson(path.join(context.getResources(Platform.LINUX), "app.asar"), "node_modules/ms/package.json")).toMatchSnapshot()
+      },
+    }
+  )
+)
+
 //github.com/electron-userland/electron-builder/issues/8426
 test.ifAll("yarn parse-asn1", () =>
   assertPack(