feat(minor): customize postinstall behavior

Author: giladgd

docs/guide/troubleshooting.md

@@ -164,3 +164,26 @@ Ensure you're not using the `Administrator` user for `npm install` nor to run th
 To do that, go to `Settings > Update & Security > For developers` and enable `Developer mode`.
 
 After that, delete the `.cache` folder under your user directory and try building the app again.
+
+## Customizing `postinstall` Behavior {#postinstall-behavior}
+When installing `node-llama-cpp`, its `postinstall` script checks whether the prebuilt binaries
+are compatible with current machine (which they almost always are, at least the CPU-only ones which are the last resort fallback),
+and when not, attempts [building the native bindings from source](./building-from-source.md).
+
+When attempting to [build from source](./building-from-source.md), if the machine lacks the required build tools,
+the build will fail and indicative error messages will direct you to the specific commands you need to run
+or packages you need to install in order for the build process to succeed.
+
+If you want to customize the `postinstall` behavior, you can do so using any of the following methods:
+* Passing the `--node-llama-cpp-postinstall=<behavior>` flag to the `npm install` command.
+* Setting the `NODE_LLAMA_CPP_POSTINSTALL` environment variable to `<behavior>` before running `npm install`.
+* Configuring `config.nodeLlamaCppPostinstall` on your project's `package.json` to `<behavior>`.
+
+Where `<behavior>` can be one of the following options:
+* **`auto` (default)**: the default behavior explained above.
+* **`ignoreFailedBuild`**: same as the default behavior,
+    but a failed build will not throw an error and will be ignored, which means the installation will succeed.
+    Using [`getLlama`](../api/functions/getLlama.md) for the first time will attempt building from source again by default.
+* **`skip`**: skip the entire `postinstall` script.
+    If the prebuilt binaries are incompatible with the current machine,
+    using [`getLlama`](../api/functions/getLlama.md) for the first time will attempt building from source by default.

src/cli/commands/OnPostInstallCommand.ts

@@ -1,10 +1,16 @@
+import path from "path";
+import {fileURLToPath} from "url";
 import {CommandModule} from "yargs";
 import chalk from "chalk";
-import {defaultSkipDownload, documentationPageUrls} from "../../config.js";
+import {defaultSkipDownload, documentationPageUrls, defaultNodeLlamaCppPostinstall} from "../../config.js";
 import {getLlamaForOptions} from "../../bindings/getLlama.js";
 import {setForceShowConsoleLogPrefix} from "../../state.js";
 import {isRunningUnderRosetta} from "../utils/isRunningUnderRosetta.js";
 import {getConsoleLogPrefix} from "../../utils/getConsoleLogPrefix.js";
+import {parsePackageJsonConfig, resolvePackageJsonConfig} from "../utils/packageJsonConfig.js";
+import {detectCurrentPackageManager} from "../utils/packageManager.js";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 type OnPostInstallCommand = null;
 
@@ -13,7 +19,22 @@ export const OnPostInstallCommand: CommandModule<object, OnPostInstallCommand> =
     describe: false,
     async handler() {
         if (defaultSkipDownload)
-            return;
+            return void process.exit(0);
+
+        const nlcConfig = parsePackageJsonConfig(await resolvePackageJsonConfig(__dirname));
+        const postinstallConfig = (defaultNodeLlamaCppPostinstall == null || defaultNodeLlamaCppPostinstall === "auto")
+            ? nlcConfig.nodeLlamaCppPostinstall ?? defaultNodeLlamaCppPostinstall
+            : defaultNodeLlamaCppPostinstall;
+
+        // set via a `--node-llama-cpp-postinstall=skip` flag on an `npm install` command
+        //  (prefer `--node-llama-cpp-postinstall=ignoreFailedBuild` if you really need it)
+        if (postinstallConfig === "skip") {
+            console.info(
+                getConsoleLogPrefix(false, false),
+                "Skipping node-llama-cpp postinstall due to a 'skip' configuration"
+            );
+            return void process.exit(0);
+        }
 
         setForceShowConsoleLogPrefix(true);
 
@@ -34,7 +55,10 @@ export const OnPostInstallCommand: CommandModule<object, OnPostInstallCommand> =
                 "troubleshooting: " + documentationPageUrls.troubleshooting.RosettaIllegalHardwareInstruction
             );
 
-            process.exit(1);
+            if (postinstallConfig === "ignoreFailedBuild")
+                process.exit(0);
+            else
+                process.exit(1);
         }
 
         try {
@@ -47,7 +71,25 @@ export const OnPostInstallCommand: CommandModule<object, OnPostInstallCommand> =
             process.exit(0);
         } catch (err) {
             console.error(err);
-            process.exit(1);
+
+            const packageManager = detectCurrentPackageManager();
+            if (postinstallConfig === "auto" && packageManager === "npm")
+                console.info(
+                    getConsoleLogPrefix(false, false),
+                    "To disable node-llama-cpp's postinstall for this 'npm install', use the '--node-llama-cpp-postinstall=skip' flag when running 'npm install' command"
+                );
+
+            if (postinstallConfig === "auto")
+                console.info(
+                    getConsoleLogPrefix(false, false),
+                    "To customize node-llama-cpp's postinstall behavior, see the troubleshooting guide: " +
+                    documentationPageUrls.troubleshooting.PostinstallBehavior
+                );
+
+            if (postinstallConfig === "ignoreFailedBuild")
+                process.exit(0);
+            else
+                process.exit(1);
         }
     }
 };

src/cli/utils/packageJsonConfig.ts

@@ -0,0 +1,69 @@
+import path from "path";
+import fs from "fs-extra";
+import {NodeLlamaCppPostinstallBehavior} from "../../types.js";
+
+export async function resolvePackageJsonConfig(startDir: string) {
+    const currentConfig: Record<string, any> = {};
+
+    let currentDirPath = path.resolve(startDir);
+    while (true) {
+        const packageJsonPath = path.join(currentDirPath, "package.json");
+        try {
+            if (await fs.pathExists(packageJsonPath))
+                applyConfig(currentConfig, await readPackageJsonConfig(packageJsonPath));
+        } catch (err) {
+            // do nothing
+        }
+
+        const parentDirPath = path.dirname(currentDirPath);
+        if (parentDirPath === currentDirPath)
+            break;
+
+        currentDirPath = parentDirPath;
+    }
+
+    return currentConfig;
+}
+
+export function parsePackageJsonConfig(config: Record<string, any>) {
+    const res: NlcPackageJsonConfig = {};
+
+    const castedConfig = config as NlcPackageJsonConfig;
+
+    if (castedConfig.nodeLlamaCppPostinstall === "auto" ||
+        castedConfig.nodeLlamaCppPostinstall === "ignoreFailedBuild" ||
+        castedConfig.nodeLlamaCppPostinstall === "skip"
+    )
+        res.nodeLlamaCppPostinstall = castedConfig.nodeLlamaCppPostinstall;
+    else
+        void (castedConfig.nodeLlamaCppPostinstall satisfies undefined);
+
+    return res;
+}
+
+export type NlcPackageJsonConfig = {
+    nodeLlamaCppPostinstall?: NodeLlamaCppPostinstallBehavior
+};
+
+function readPackageJsonConfig(packageJsonPath: string) {
+    try {
+        const packageJsonContent = fs.readFileSync(packageJsonPath, "utf8");
+        const packageJson = JSON.parse(packageJsonContent);
+        const config = packageJson?.config;
+        if (typeof config === "object")
+            return config;
+
+        return {};
+    } catch (err) {
+        return {};
+    }
+}
+
+function applyConfig(baseConfig: Record<string, any>, newConfig: Record<string, any>) {
+    for (const key in newConfig) {
+        if (key in baseConfig)
+            continue;
+
+        baseConfig[key] = newConfig[key];
+    }
+}

src/cli/utils/packageManager.ts

@@ -0,0 +1,16 @@
+export function detectCurrentPackageManager(): "npm" | "bun" | "pnpm" | "deno" | "yarn" | undefined {
+    const userAgent = (process.env["npm_config_user_agent"] ?? "").toLowerCase();
+
+    if (userAgent.startsWith("bun/"))
+        return "bun";
+    else if (userAgent.startsWith("pnpm/"))
+        return "pnpm";
+    else if (userAgent.startsWith("yarn/"))
+        return "yarn";
+    else if (userAgent.startsWith("deno/"))
+        return "deno";
+    else if (userAgent.startsWith("npm/"))
+        return "npm";
+
+    return undefined;
+}

src/config.ts

@@ -8,6 +8,7 @@ import {getBinariesGithubRelease} from "./bindings/utils/binariesGithubRelease.j
 import {
     nodeLlamaCppGpuOptions, LlamaLogLevel, LlamaLogLevelValues, parseNodeLlamaCppGpuOption, nodeLlamaCppGpuOffStringOptions
 } from "./bindings/types.js";
+import type {NodeLlamaCppPostinstallBehavior} from "./types.js";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
@@ -75,6 +76,15 @@ export const defaultLlamaCppDebugMode = env.get("NODE_LLAMA_CPP_DEBUG")
 export const defaultSkipDownload = env.get("NODE_LLAMA_CPP_SKIP_DOWNLOAD")
     .default("false")
     .asBool();
+
+// set via a `--node-llama-cpp-postinstall=ignoreFailedBuild` flag on an `npm install` command
+export const defaultNodeLlamaCppPostinstall = env.get("NODE_LLAMA_CPP_POSTINSTALL")
+    .default(
+        env.get("npm_config_node_llama_cpp_postinstall")
+            .default("auto")
+            .asEnum(["auto", "ignoreFailedBuild", "skip"] as const satisfies NodeLlamaCppPostinstallBehavior[])
+    )
+    .asEnum(["auto", "ignoreFailedBuild", "skip"] as const satisfies NodeLlamaCppPostinstallBehavior[]);
 export const defaultBindingTestLogLevel = env.get("NODE_LLAMA_CPP_BINDING_TEST_LOG_LEVEL")
     .default(LlamaLogLevel.error)
     .asEnum(LlamaLogLevelValues);
@@ -125,7 +135,8 @@ export const documentationPageUrls = {
         }
     },
     troubleshooting: {
-        RosettaIllegalHardwareInstruction: documentationUrl + "/guide/troubleshooting#illegal-hardware-instruction"
+        RosettaIllegalHardwareInstruction: documentationUrl + "/guide/troubleshooting#illegal-hardware-instruction",
+        PostinstallBehavior: documentationUrl + "/guide/troubleshooting#postinstall-behavior"
     }
 } as const;
 export const newGithubIssueUrl = "https://github.com/withcatai/node-llama-cpp/issues";

src/types.ts

@@ -477,3 +477,5 @@ export type LLamaContextualDryRepeatPenalty = {
      */
     sequenceBreakers?: string[]
 };
+
+export type NodeLlamaCppPostinstallBehavior = "auto" | "ignoreFailedBuild" | "skip";