chore(deps): update electron/rebuild to resolve node-gyp dependency issue (#9285)

Author: mmaietta

.changeset/serious-rings-build.md

@@ -0,0 +1,5 @@
+---
+"app-builder-lib": patch
+---
+
+chore(deps): update electron/rebuild to resolve node-gyp dependency issue

packages/app-builder-lib/helpers/remote-rebuild.js

@@ -0,0 +1,38 @@
+if (!process.send) {
+  console.error("The remote rebuilder expects to be spawned with an IPC channel")
+  process.exit(1)
+}
+
+const rebuilder = (rebuilder) => {
+  rebuilder.lifecycle.on("module-found", (moduleName) => process.send?.({ msg: "module-found", moduleName }))
+  rebuilder.lifecycle.on("module-done", (moduleName) => process.send?.({ msg: "module-done", moduleName }))
+  rebuilder.lifecycle.on("module-skip", (moduleName) => process.send?.({ msg: "module-skip", moduleName }))
+
+  return rebuilder
+    .then(() => {
+      process.send?.({ msg: "rebuild-done" })
+      return process.exit(0)
+    })
+    .catch((err) => {
+      process.send?.({
+        msg: "rebuild-error",
+        err: {
+          message: err.message,
+          stack: err.stack,
+        },
+      })
+      process.exit(0)
+    })
+}
+
+const main = () => {
+  const options = JSON.parse(process.argv[2])
+
+  const dynamicImport = require("./dynamic-import").dynamicImportMaybe
+  return dynamicImport("@electron/rebuild").then((module) => {
+    const { rebuild } = module
+    return rebuilder(rebuild(options))
+  })
+}
+
+main()

packages/app-builder-lib/package.json

@@ -52,7 +52,7 @@
     "@electron/fuses": "^1.8.0",
     "@electron/notarize": "2.5.0",
     "@electron/osx-sign": "1.3.3",
-    "@electron/rebuild": "3.7.2",
+    "@electron/rebuild": "4.0.1",
     "@electron/universal": "2.0.3",
     "@malept/flatpak-bundler": "^0.4.0",
     "@types/fs-extra": "9.0.13",

packages/app-builder-lib/src/electron/electronVersion.ts

@@ -1,5 +1,3 @@
-import { getProjectRootPath } from "@electron/rebuild/lib/search-module"
-
 import { httpExecutor, InvalidConfigurationError, log } from "builder-util"
 import { parseXml } from "builder-util-runtime"
 import { readJson } from "fs-extra"
@@ -9,6 +7,7 @@ import * as semver from "semver"
 import { Configuration } from "../configuration"
 import { getConfig } from "../util/config/config"
 import { orNullIfFileNotExist } from "../util/config/load"
+import { getProjectRootPath } from "./search-module"
 
 export type MetadataValue = Lazy<Record<string, any> | null>
 

packages/app-builder-lib/src/electron/search-module.ts

@@ -0,0 +1,82 @@
+import * as fs from "fs-extra"
+import * as path from "node:path"
+
+async function shouldContinueSearch(traversedPath: string, rootPath?: string, stopAtPackageJSON?: boolean): Promise<boolean> {
+  if (rootPath) {
+    return Promise.resolve(traversedPath !== path.dirname(rootPath))
+  } else if (stopAtPackageJSON) {
+    return fs.existsSync(path.join(traversedPath, "package.json"))
+  } else {
+    return true
+  }
+}
+
+type PathGeneratorFunction = (traversedPath: string) => string
+
+async function traverseAncestorDirectories(
+  cwd: string,
+  pathGenerator: PathGeneratorFunction,
+  rootPath?: string,
+  maxItems?: number,
+  stopAtPackageJSON?: boolean
+): Promise<string[]> {
+  const paths: string[] = []
+  let traversedPath = path.resolve(cwd)
+
+  while (await shouldContinueSearch(traversedPath, rootPath, stopAtPackageJSON)) {
+    const generatedPath = pathGenerator(traversedPath)
+    if (fs.existsSync(generatedPath)) {
+      paths.push(generatedPath)
+    }
+
+    const parentPath = path.dirname(traversedPath)
+    if (parentPath === traversedPath || (maxItems && paths.length >= maxItems)) {
+      break
+    }
+    traversedPath = parentPath
+  }
+
+  return paths
+}
+
+/**
+ * Find all instances of a given module in node_modules subdirectories while traversing up
+ * ancestor directories.
+ *
+ * @param cwd the initial directory to traverse
+ * @param moduleName the Node module name (should work for scoped modules as well)
+ * @param rootPath the project's root path. If provided, the traversal will stop at this path.
+ */
+export async function searchForModule(cwd: string, moduleName: string, rootPath?: string): Promise<string[]> {
+  const pathGenerator: PathGeneratorFunction = traversedPath => path.join(traversedPath, "node_modules", moduleName)
+  return traverseAncestorDirectories(cwd, pathGenerator, rootPath, undefined, true)
+}
+
+/**
+ * Find all instances of node_modules subdirectories while traversing up ancestor directories.
+ *
+ * @param cwd the initial directory to traverse
+ * @param rootPath the project's root path. If provided, the traversal will stop at this path.
+ */
+export async function searchForNodeModules(cwd: string, rootPath?: string): Promise<string[]> {
+  const pathGenerator: PathGeneratorFunction = traversedPath => path.join(traversedPath, "node_modules")
+  return traverseAncestorDirectories(cwd, pathGenerator, rootPath, undefined, true)
+}
+
+/**
+ * Determine the root directory of a given project, by looking for a directory with an
+ * NPM or yarn lockfile or pnpm lockfile.
+ *
+ * @param cwd the initial directory to traverse
+ */
+export async function getProjectRootPath(cwd: string): Promise<string> {
+  for (const lockFilename of ["yarn.lock", "package-lock.json", "pnpm-lock.yaml"]) {
+    const pathGenerator: PathGeneratorFunction = traversedPath => path.join(traversedPath, lockFilename)
+    const lockPaths = await traverseAncestorDirectories(cwd, pathGenerator, undefined, 1)
+    if (lockPaths.length > 0) {
+      return path.dirname(lockPaths[0])
+    }
+  }
+
+  return cwd
+}

packages/app-builder-lib/src/util/rebuild/rebuild.ts renamed to packages/app-builder-lib/src/util/rebuild.ts

@@ -7,7 +7,7 @@ export const rebuild = async (options: RebuildOptions): Promise<void> => {
   const { arch } = options
   log.info({ arch }, `installing native dependencies`)
 
-  const child = cp.fork(path.resolve(__dirname, "remote-rebuild.js"), [JSON.stringify(options)], {
+  const child = cp.fork(path.resolve(__dirname, "../../helpers/remote-rebuild.js"), [JSON.stringify(options)], {
     stdio: ["pipe", "pipe", "pipe", "ipc"],
   })
 

packages/app-builder-lib/src/util/rebuild/remote-rebuild.ts

@@ -1,5 +1,3 @@
-import * as electronRebuild from "@electron/rebuild"
-import { RebuildMode } from "@electron/rebuild/lib/types"
 import { asArray, log, spawn } from "builder-util"
 import { pathExists } from "fs-extra"
 import { Lazy } from "lazy-val"
@@ -9,8 +7,9 @@ import { Configuration } from "../configuration"
 import { executeAppBuilderAndWriteJson } from "./appBuilder"
 import { PM, detectPackageManager, getPackageManagerCommand } from "../node-module-collector"
 import { NodeModuleDirInfo } from "./packageDependencies"
-import { rebuild as remoteRebuild } from "./rebuild/rebuild"
+import { rebuild as remoteRebuild } from "./rebuild"
 import * as which from "which"
+import { RebuildOptions as ElectronRebuildOptions } from "@electron/rebuild"
 
 export async function installOrRebuild(config: Configuration, { appDir, projectDir }: DirectoryPaths, options: RebuildOptions, forceInstall = false) {
   const effectiveOptions: RebuildOptions = {
@@ -176,14 +175,14 @@ export async function rebuild(config: Configuration, { appDir, projectDir }: Dir
   }
   log.info(logInfo, "executing @electron/rebuild")
 
-  const rebuildOptions: electronRebuild.RebuildOptions = {
+  const rebuildOptions: ElectronRebuildOptions = {
     buildPath: appDir,
     electronVersion,
     arch,
     platform,
     buildFromSource,
     projectRootPath: projectDir,
-    mode: (config.nativeRebuilder as RebuildMode) || "sequential",
+    mode: config.nativeRebuilder || "sequential",
     disablePreGypCopy: true,
   }
   return remoteRebuild(rebuildOptions)