Merge pull request #1610 from appwrite/fix/cli-keyring-bun-compile-binding

Fix CLI crash in compiled binaries from @napi-rs/keyring native binding

Author: ChiragAgg5k

.github/workflows/validation.yml

@@ -297,6 +297,15 @@ jobs:
         working-directory: examples/cli
         run: python3 ../../scripts/verify-darwin-signatures.py
 
+      - name: Test compiled CLI binary
+        if: matrix.sdk == 'cli'
+        working-directory: examples/cli
+        run: |
+          BIN=build/appwrite-cli-linux-x64
+          "./$BIN" --version
+          "./$BIN" --help | grep -q "Usage:"
+          SHELL=bash "./$BIN" completion bash >/dev/null
+
       - name: Verify npm package entry points
         if: matrix.sdk == 'web' || matrix.sdk == 'node' || matrix.sdk == 'react-native' || matrix.sdk == 'cli'
         working-directory: examples/${{ matrix.sdk }}

templates/cli/lib/auth/refresh-token.ts

@@ -1,4 +1,3 @@
-import { Entry } from "@napi-rs/keyring";
 import { globalConfig } from "../config.js";
 import { EXECUTABLE_NAME } from "../constants.js";
 import type { SessionData } from "../types.js";
@@ -11,10 +10,65 @@ interface KeyringEntry {
   deletePassword(): boolean;
 }
 
+type KeyringEntryConstructor = new (
+  service: string,
+  account: string,
+) => KeyringEntry;
+
 type KeyringEntryFactory = (service: string, account: string) => KeyringEntry;
 
-let keyringEntryFactory: KeyringEntryFactory = (service, account) =>
-  new Entry(service, account);
+// undefined = unresolved; null = resolved but no native binding (use fallback).
+let cachedEntry: KeyringEntryConstructor | null | undefined;
+
+// Resolve @napi-rs/keyring lazily via a literal per-platform require: a top-level
+// import would crash the `bun --compile` binaries ("Cannot find native binding"),
+// whereas a literal specifier lets bun embed the matching .node per --target so
+// secure storage still works. Anything unresolved falls back to config storage.
+/* eslint-disable @typescript-eslint/no-require-imports */
+const loadEntry = (): KeyringEntryConstructor | null => {
+  if (cachedEntry !== undefined) {
+    return cachedEntry;
+  }
+
+  cachedEntry = null;
+  if (typeof require !== "function") {
+    return cachedEntry;
+  }
+
+  try {
+    let mod: { Entry: KeyringEntryConstructor } | undefined;
+    if (process.platform === "darwin" && process.arch === "arm64") {
+      mod = require("@napi-rs/keyring-darwin-arm64");
+    } else if (process.platform === "darwin" && process.arch === "x64") {
+      mod = require("@napi-rs/keyring-darwin-x64");
+    } else if (process.platform === "linux" && process.arch === "x64") {
+      mod = require("@napi-rs/keyring-linux-x64-gnu");
+    } else if (process.platform === "linux" && process.arch === "arm64") {
+      mod = require("@napi-rs/keyring-linux-arm64-gnu");
+    } else if (process.platform === "win32" && process.arch === "x64") {
+      mod = require("@napi-rs/keyring-win32-x64-msvc");
+    } else if (process.platform === "win32" && process.arch === "arm64") {
+      mod = require("@napi-rs/keyring-win32-arm64-msvc");
+    }
+
+    mod ??= require("@napi-rs/keyring");
+    cachedEntry = mod.Entry;
+  } catch {
+    cachedEntry = null;
+  }
+
+  return cachedEntry;
+};
+/* eslint-enable @typescript-eslint/no-require-imports */
+
+let keyringEntryFactory: KeyringEntryFactory = (service, account) => {
+  const Entry = loadEntry();
+  if (!Entry) {
+    throw new Error("Secure credential storage is unavailable in this build.");
+  }
+
+  return new Entry(service, account);
+};
 
 const getSessionData = (sessionId: string): SessionData | undefined =>
   globalConfig.get(sessionId) as SessionData | undefined;

templates/cli/package.json.twig

@@ -35,9 +35,9 @@
     "build:types": "tsc -p tsconfig.json --emitDeclarationOnly",
     "build:runtime": "npm run build:lib:runtime && npm run build:cli",
     "build:lib:runtime": "npm run build:lib:esm && npm run build:lib:cjs",
-    "build:lib:esm": "esbuild index.ts --bundle --platform=node --target=node18 --format=esm --loader:.hbs=text --external:@napi-rs/keyring --external:terminal-image --outfile=dist/index.js",
-    "build:lib:cjs": "esbuild index.ts --bundle --platform=node --target=node18 --format=cjs --loader:.hbs=text --external:@napi-rs/keyring --external:terminal-image --outfile=dist/index.cjs",
-    "build:cli": "esbuild cli.ts --bundle --platform=node --target=node18 --format=cjs --loader:.hbs=text --external:@napi-rs/keyring --external:fsevents --external:terminal-image --outfile=dist/cli.cjs",
+    "build:lib:esm": "esbuild index.ts --bundle --platform=node --target=node18 --format=esm --loader:.hbs=text --external:@napi-rs/keyring --external:@napi-rs/keyring-* --external:terminal-image --outfile=dist/index.js",
+    "build:lib:cjs": "esbuild index.ts --bundle --platform=node --target=node18 --format=cjs --loader:.hbs=text --external:@napi-rs/keyring --external:@napi-rs/keyring-* --external:terminal-image --outfile=dist/index.cjs",
+    "build:cli": "esbuild cli.ts --bundle --platform=node --target=node18 --format=cjs --loader:.hbs=text --external:@napi-rs/keyring --external:@napi-rs/keyring-* --external:fsevents --external:terminal-image --outfile=dist/cli.cjs",
     "lint": "eslint .",
     "format": "prettier --write \"**/*.{js,ts,json,md}\"",
     "generate": "tsx scripts/generate-commands.ts",