@nativedesktop/cli 0.4.45 → 0.4.46

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nativedesktop/cli",
-  "version": "0.4.45",
+  "version": "0.4.46",
   "description": "The nd CLI: dev-runs, builds, and packages NativeDesktop apps",
   "type": "module",
   "license": "MIT",
@@ -25,6 +25,6 @@
     "./config": "./src/config.ts"
   },
   "dependencies": {
-    "@nativedesktop/host": "0.4.45"
+    "@nativedesktop/host": "0.4.46"
   }
 }

package/src/package/doctor.test.ts

@@ -5,7 +5,7 @@ import { mkdirSync, mkdtempSync, writeFileSync } from "node:fs";
 import { tmpdir } from "node:os";
 import { join } from "node:path";
 import type { NativeDesktopConfig } from "../config.ts";
-import { builtBundles, type Check, webviewChecks } from "./doctor.ts";
+import { builtBundles, type Check, nixosHostChecks, webviewChecks } from "./doctor.ts";
 
 const FRAMEWORK = "Chromium Embedded Framework.framework";
 const target = process.platform === "darwin" ? "mac" : "linux";
@@ -82,3 +82,46 @@ describe("webviewChecks", () => {
     expect(find(webviewChecks(config, empty), "cef-bytes")[0]!.status).toBe("error");
   });
 });
+
+describe("nixosHostChecks", () => {
+  const gtk = "/nix/store/a-gtk4/lib";
+  const adw = "/nix/store/a-libadwaita/lib";
+  const gstPin = "/nix/store/a-gstreamer/lib";
+  const gstOther = "/nix/store/b-gstreamer/lib";
+  const files = new Set([
+    "/etc/NIXOS",
+    "/lib64/ld-linux-x86-64.so.2",
+    `${gtk}/libgtk-4.so.1`,
+    `${adw}/libadwaita-1.so.0`,
+    `${gstPin}/libgstreamer-1.0.so.0`,
+    `${gstOther}/libgstreamer-1.0.so.0`,
+  ]);
+  const exists = (p: string) => files.has(p);
+
+  test("says nothing off NixOS", () => {
+    expect(nixosHostChecks({}, () => false)).toEqual([]);
+  });
+
+  test("without nix-ld the generic loader is missing", () => {
+    const checks = nixosHostChecks({}, (p) => p === "/etc/NIXOS");
+    expect(checks[0]!.status).toBe("error");
+    expect(checks[0]!.detail).toContain("programs.nix-ld.enable");
+  });
+
+  test("outside the dev shell nix-ld has no GTK to hand the host", () => {
+    const checks = nixosHostChecks({ NIX_LD_LIBRARY_PATH: "/run/current-system/sw/share/nix-ld/lib" }, exists);
+    expect(checks[0]!.status).toBe("error");
+    expect(checks[0]!.detail).toContain("nix develop");
+  });
+
+  test("GStreamer from another nixpkgs than GTK is the missing-symbol failure", () => {
+    const checks = nixosHostChecks({ NIX_LD_LIBRARY_PATH: `${gtk}:${adw}:${gstOther}`, LD_LIBRARY_PATH: gstPin }, exists);
+    expect(checks[0]!.status).toBe("error");
+    expect(checks[0]!.detail).toContain(gstPin);
+  });
+
+  test("one pin for both is fine", () => {
+    const checks = nixosHostChecks({ NIX_LD_LIBRARY_PATH: `${gtk}:${adw}:${gstPin}`, LD_LIBRARY_PATH: gstPin }, exists);
+    expect(checks).toEqual([{ name: "nixos", status: "ok", detail: `prebuilt host runs through nix-ld with GTK from ${gtk}` }]);
+  });
+});

package/src/package/doctor.ts

@@ -74,6 +74,43 @@ export function builtBundles(config: NativeDesktopConfig, cwd: string): string[]
  * bundle carrying Chromium bytes breaks the framework's central claim about the
  * default path, so it fails rather than warns.
  */
+const GENERIC_LOADER = "/lib64/ld-linux-x86-64.so.2";
+
+function libDirWith(path: string | undefined, soname: string, exists: (p: string) => boolean): string | undefined {
+  return path?.split(":").find((dir) => dir && exists(join(dir, soname)));
+}
+
+/** The published Linux host is a generic-distro binary: on NixOS it only runs
+ * through nix-ld, and only correctly when GTK (NIX_LD_LIBRARY_PATH) and the
+ * GStreamer the dev shell puts on LD_LIBRARY_PATH come from one nixpkgs. */
+export function nixosHostChecks(
+  env: Record<string, string | undefined>,
+  exists: (path: string) => boolean = existsSync,
+): Check[] {
+  if (!exists("/etc/NIXOS")) return [];
+  const shell = "run nd inside the framework dev shell (`nix develop <NativeDesktop checkout>`)";
+  if (!exists(GENERIC_LOADER)) {
+    return [{
+      name: "nixos",
+      status: "error",
+      detail: `the prebuilt host needs ${GENERIC_LOADER}, which NixOS only provides with nix-ld: set programs.nix-ld.enable = true, then ${shell}`,
+    }];
+  }
+  const gtk = libDirWith(env.NIX_LD_LIBRARY_PATH, "libgtk-4.so.1", exists);
+  if (!gtk || !libDirWith(env.NIX_LD_LIBRARY_PATH, "libadwaita-1.so.0", exists)) {
+    return [{ name: "nixos", status: "error", detail: `NIX_LD_LIBRARY_PATH has no GTK 4 / libadwaita for the prebuilt host: ${shell}` }];
+  }
+  const gst = libDirWith(env.LD_LIBRARY_PATH, "libgstreamer-1.0.so.0", exists);
+  if (gst && !env.NIX_LD_LIBRARY_PATH!.split(":").includes(gst)) {
+    return [{
+      name: "nixos",
+      status: "error",
+      detail: `GStreamer on LD_LIBRARY_PATH (${gst}) is not the one GTK on NIX_LD_LIBRARY_PATH was built against, so GTK fails on a missing symbol: update the NativeDesktop checkout whose dev shell this is`,
+    }];
+  }
+  return [{ name: "nixos", status: "ok", detail: `prebuilt host runs through nix-ld with GTK from ${gtk}` }];
+}
+
 export function webviewChecks(config: NativeDesktopConfig, cwd: string): Check[] {
   const target = engineTargetFor();
   if (!target) return [];
@@ -181,7 +218,8 @@ export async function collectChecks(cwd: string): Promise<Check[]> {
     // ND_HOST_BINARY is what `nd dev` will actually run, so report that rather
     // than the prebuilt it overrides.
     const explicit = process.env.ND_HOST_BINARY;
-    const found = explicit || prebuiltHostBinary(backend) || fresh.find(existsSync);
+    const prebuilt = prebuiltHostBinary(backend);
+    const found = explicit || prebuilt || fresh.find(existsSync);
     if (explicit && !existsSync(explicit)) {
       checks.push({ name: "host", status: "error", detail: `ND_HOST_BINARY points at ${explicit}, which does not exist` });
     } else {
@@ -189,6 +227,7 @@ export async function collectChecks(cwd: string): Promise<Check[]> {
         ? { name: "host", status: "ok", detail: explicit ? `${found} (ND_HOST_BINARY)` : found }
         : { name: "host", status: "warn", detail: `no ${backend} host binary built yet (nd dev / nd package builds it on first run in a source checkout)` });
     }
+    if (process.platform === "linux" && !explicit && prebuilt && found === prebuilt) checks.push(...nixosHostChecks(process.env));
   } catch (err) {
     checks.push({ name: "host", status: "error", detail: String(err) });
   }