fix windows native module staging in before-pack

Author: charlesvien

apps/code/runtime-dependencies.test.ts

@@ -0,0 +1,60 @@
+import { describe, expect, it } from "vitest";
+import {
+  asarUnpackGlobs,
+  buildExternals,
+  macOnlyNativeModules,
+  packagedFileGlobs,
+  requiredNativeModules,
+  runtimeNativeModules,
+  watcherPackageFor,
+} from "./runtime-dependencies";
+
+describe("watcherPackageFor", () => {
+  it.each([
+    ["mac", 1, "@parcel/watcher-darwin-x64"],
+    ["mac", 3, "@parcel/watcher-darwin-arm64"],
+    ["windows", 1, "@parcel/watcher-win32-x64"],
+    ["windows", 3, "@parcel/watcher-win32-arm64"],
+    ["linux", 1, "@parcel/watcher-linux-x64-glibc"],
+    ["linux", 3, "@parcel/watcher-linux-arm64-glibc"],
+  ])("maps platform=%s arch=%i to %s", (platform, arch, expected) => {
+    expect(watcherPackageFor(platform, arch as number)).toBe(expected);
+  });
+
+  it("returns null for an unrecognized platform name", () => {
+    // electron-builder passes "windows", never "win"; matching "win" was the
+    // bug that left the Windows watcher binary unstaged.
+    expect(watcherPackageFor("win", 1)).toBeNull();
+    expect(watcherPackageFor("darwin", 1)).toBeNull();
+  });
+});
+
+describe("native module globs", () => {
+  it("collapses the @parcel scope to a single glob", () => {
+    expect(packagedFileGlobs).toContain("node_modules/@parcel/**/*");
+    expect(asarUnpackGlobs).toContain("node_modules/@parcel/**");
+    expect(packagedFileGlobs).not.toContain(
+      "node_modules/@parcel/watcher/**/*",
+    );
+  });
+
+  it("emits a per-package glob for unscoped modules", () => {
+    expect(packagedFileGlobs).toContain("node_modules/node-pty/**/*");
+    expect(packagedFileGlobs).toContain("node_modules/better-sqlite3/**/*");
+  });
+});
+
+describe("native module list invariants", () => {
+  it("only marks modules that are actually staged as required", () => {
+    for (const mod of requiredNativeModules) {
+      expect(runtimeNativeModules).toContain(mod);
+    }
+  });
+
+  it("externalizes only modules staged on some platform", () => {
+    const staged = new Set([...runtimeNativeModules, ...macOnlyNativeModules]);
+    for (const mod of buildExternals) {
+      expect(staged.has(mod)).toBe(true);
+    }
+  });
+});

apps/code/runtime-dependencies.ts

@@ -29,6 +29,14 @@ export const runtimeNativeModules = [
   "is-number",
 ];
 
+// The base native modules that must exist when packaging; a missing one is a
+// broken build, not a warning. before-pack stages these with copyRequiredDep.
+export const requiredNativeModules = [
+  "node-pty",
+  "@parcel/watcher",
+  "better-sqlite3",
+];
+
 // file-icon (and its p-map dependency) is only used on macOS.
 export const macOnlyNativeModules = ["file-icon", "p-map"];
 
@@ -63,3 +71,34 @@ export const packagedFileGlobs = [
 export const asarUnpackGlobs = asarUnpackModules.map(
   (name) => `node_modules/${scopeOf(name)}/**`,
 );
+
+// Mirrors electron-builder's Arch enum (ia32=0, x64=1, armv7l=2, arm64=3).
+const ARCH_X64 = 1;
+const ARCH_ARM64 = 3;
+
+// The platform-specific @parcel/watcher prebuild before-pack must stage, keyed
+// by electron-builder's platform name and arch. The name is "windows", not
+// "win" (electron-builder's Platform.WINDOWS.name); matching "win" silently
+// skips staging and ships a broken Windows app. Returns null for an
+// unrecognized platform.
+export function watcherPackageFor(
+  platformName: string,
+  arch: number,
+): string | null {
+  if (platformName === "mac") {
+    return arch === ARCH_X64
+      ? "@parcel/watcher-darwin-x64"
+      : "@parcel/watcher-darwin-arm64";
+  }
+  if (platformName === "windows") {
+    return arch === ARCH_ARM64
+      ? "@parcel/watcher-win32-arm64"
+      : "@parcel/watcher-win32-x64";
+  }
+  if (platformName === "linux") {
+    return arch === ARCH_ARM64
+      ? "@parcel/watcher-linux-arm64-glibc"
+      : "@parcel/watcher-linux-x64-glibc";
+  }
+  return null;
+}

apps/code/scripts/before-pack.ts

@@ -2,12 +2,11 @@ import { cpSync, existsSync, mkdirSync, rmSync } from "node:fs";
 import path from "node:path";
 import {
   macOnlyNativeModules,
+  requiredNativeModules,
   runtimeNativeModules,
+  watcherPackageFor,
 } from "../runtime-dependencies";
 
-const ARCH_X64 = 1;
-const ARCH_ARM64 = 3;
-
 type BeforePackContext = {
   packager: { platform: { name: string } };
   arch: number;
@@ -66,30 +65,22 @@ export default async function beforePack(context: BeforePackContext) {
   console.log(`[before-pack] local node_modules: ${localNodeModules}`);
 
   for (const dep of runtimeNativeModules) {
-    copyDep(dep, rootNodeModules, localNodeModules);
+    if (requiredNativeModules.includes(dep)) {
+      copyRequiredDep(dep, rootNodeModules, localNodeModules);
+    } else {
+      copyDep(dep, rootNodeModules, localNodeModules);
+    }
   }
 
-  if (platformName === "mac") {
-    const watcherPkg =
-      arch === ARCH_X64
-        ? "@parcel/watcher-darwin-x64"
-        : "@parcel/watcher-darwin-arm64";
+  const watcherPkg = watcherPackageFor(platformName, arch);
+  if (watcherPkg) {
     copyRequiredDep(watcherPkg, rootNodeModules, localNodeModules);
+  }
+
+  if (platformName === "mac") {
     for (const dep of macOnlyNativeModules) {
       copyDep(dep, rootNodeModules, localNodeModules);
     }
-  } else if (platformName === "win") {
-    const watcherPkg =
-      arch === ARCH_ARM64
-        ? "@parcel/watcher-win32-arm64"
-        : "@parcel/watcher-win32-x64";
-    copyRequiredDep(watcherPkg, rootNodeModules, localNodeModules);
-  } else if (platformName === "linux") {
-    const watcherPkg =
-      arch === ARCH_ARM64
-        ? "@parcel/watcher-linux-arm64-glibc"
-        : "@parcel/watcher-linux-x64-glibc";
-    copyRequiredDep(watcherPkg, rootNodeModules, localNodeModules);
   }
 
   const watcherBuild = path.join(localNodeModules, "@parcel/watcher/build");