openrig/packages/cli/test/check-abi.test.ts

import { describe, it, expect } from "vitest";
import { checkAbi, openInChildProcess } from "../scripts/check-abi.mjs";

describe("postinstall ABI check", () => {
  it("passes on supported even-numbered LTS with working native addon", () => {
    const result = checkAbi({
      nodeVersion: "v22.22.1",
      loadNativeAddon: () => {},
    });
    expect(result.ok).toBe(true);
  });

  it("refuses Node 20 before loading the native addon", () => {
    let addonCalled = false;
    const result = checkAbi({
      nodeVersion: "v20.20.2",
      loadNativeAddon: () => { addonCalled = true; },
    });
    expect(result.ok).toBe(false);
    expect(addonCalled).toBe(false);
    if (result.ok) return;
    expect(result.message).toContain("requires Node.js 22 or 24");
    expect(result.message).toContain("Node 20 is no longer supported");
    expect(result.message).toContain("v20.20.2");
    expect(result.message).toContain("nvm install 22");
  });

  it("passes on Node 24 LTS", () => {
    const result = checkAbi({
      nodeVersion: "v24.0.0",
      loadNativeAddon: () => {},
    });
    expect(result.ok).toBe(true);
  });

  it("fails on odd-numbered Node 25 with honest error + fix command", () => {
    const result = checkAbi({
      nodeVersion: "v25.8.0",
      loadNativeAddon: () => {},
    });
    expect(result.ok).toBe(false);
    expect(result.message).toContain("odd-numbered");
    expect(result.message).toContain("v25.8.0");
    expect(result.message).toContain("nvm install 22");
  });

  it("fails on odd-numbered Node 23 with honest error", () => {
    const result = checkAbi({
      nodeVersion: "v23.5.0",
      loadNativeAddon: () => {},
    });
    expect(result.ok).toBe(false);
    expect(result.message).toContain("odd-numbered");
  });

  it("fails on Node below 22 with version-too-low error", () => {
    const result = checkAbi({
      nodeVersion: "v18.20.0",
      loadNativeAddon: () => {},
    });
    expect(result.ok).toBe(false);
    expect(result.message).toContain("requires Node.js 22 or 24");
    expect(result.message).toContain("nvm install 22");
  });

  it("fails with ABI mismatch error when native addon throws on supported version", () => {
    const result = checkAbi({
      nodeVersion: "v22.22.1",
      loadNativeAddon: () => {
        throw new Error(
          "The module was compiled against a different Node.js version using NODE_MODULE_VERSION 127. " +
          "This version of Node.js requires NODE_MODULE_VERSION 131."
        );
      },
    });
    expect(result.ok).toBe(false);
    expect(result.message).toContain("native binary does not match");
    expect(result.message).toContain("npm rebuild better-sqlite3");
    expect(result.message).toContain("NODE_MODULE_VERSION");
  });

  it("reports generic native-load-failure for MODULE_NOT_FOUND (not ABI-mismatch text)", () => {
    const result = checkAbi({
      nodeVersion: "v22.22.1",
      loadNativeAddon: () => {
        const err = new Error("Cannot find module 'better-sqlite3'");
        (err as NodeJS.ErrnoException).code = "MODULE_NOT_FOUND";
        throw err;
      },
    });
    expect(result.ok).toBe(false);
    // Should NOT say "native binary does not match" — that's ABI-specific
    expect(result.message).not.toContain("native binary does not match");
    // Should say generic addon-load-failure
    expect(result.message).toContain("native addon failed to load");
    expect(result.message).toContain("Cannot find module");
    expect(result.message).toContain("npm rebuild better-sqlite3");
  });

  it("reports generic native-load-failure for filesystem permission errors", () => {
    const result = checkAbi({
      nodeVersion: "v22.22.1",
      loadNativeAddon: () => {
        throw new Error("EACCES: permission denied, open '/usr/local/lib/better_sqlite3.node'");
      },
    });
    expect(result.ok).toBe(false);
    expect(result.message).not.toContain("native binary does not match");
    expect(result.message).toContain("native addon failed to load");
    expect(result.message).toContain("EACCES");
  });

  it("skips native addon check entirely for odd versions (fast path)", () => {
    let addonCalled = false;
    const result = checkAbi({
      nodeVersion: "v25.8.0",
      loadNativeAddon: () => { addonCalled = true; },
    });
    expect(result.ok).toBe(false);
    // Version check short-circuits before trying to load the addon
    expect(addonCalled).toBe(false);
  });

  it("warns but passes on an untested even major above 24 when the database opens", () => {
    const result = checkAbi({
      nodeVersion: "v26.1.0",
      loadNativeAddon: () => {},
      openNativeDatabase: () => ({ ok: true }),
    });
    expect(result.ok).toBe(true);
    if (!result.ok) return;
    expect(result.warning).toContain("Node 26 is untested");
    expect(result.warning).toContain("Supported: Node.js 22 and 24");
  });

  it("does not warn on supported majors", () => {
    const result = checkAbi({
      nodeVersion: "v24.21.0",
      loadNativeAddon: () => {},
      openNativeDatabase: () => ({ ok: true }),
    });
    expect(result).toEqual({ ok: true });
  });

  it("fails when the addon loads but a database cannot be opened", () => {
    const result = checkAbi({
      nodeVersion: "v22.22.1",
      loadNativeAddon: () => {},
      openNativeDatabase: () => ({ ok: false, detail: "database open was killed by SIGSEGV" }),
    });
    expect(result.ok).toBe(false);
    if (result.ok) return;
    expect(result.message).toContain("could not open a database");
    expect(result.message).toContain("SIGSEGV");
    expect(result.message).toContain("npm rebuild better-sqlite3");
  });

  it("does not open a database when the addon fails to load", () => {
    let opened = false;
    const result = checkAbi({
      nodeVersion: "v22.22.1",
      loadNativeAddon: () => { throw new Error("dlopen failed"); },
      openNativeDatabase: () => { opened = true; return { ok: true }; },
    });
    expect(result.ok).toBe(false);
    expect(opened).toBe(false);
  });
});

describe("openInChildProcess", () => {
  const fake = (r: Record<string, unknown>) => () => ({ status: null, signal: null, stderr: "", ...r });

  it("reports a native crash signal instead of dying", () => {
    const out = openInChildProcess("/x/better-sqlite3", fake({ signal: "SIGSEGV" }));
    expect(out).toEqual({ ok: false, detail: "database open was killed by SIGSEGV" });
  });

  it("reports a non-zero exit with the tail of stderr", () => {
    const out = openInChildProcess("/x/better-sqlite3", fake({ status: 1, stderr: "a\nb\nError: boom" }));
    expect(out.ok).toBe(false);
    if (out.ok) return;
    expect(out.detail).toContain("exited 1");
    expect(out.detail).toContain("Error: boom");
  });

  it("passes the resolved addon path to a fresh Node process", () => {
    let argv: string[] = [];
    const out = openInChildProcess("/abs/better-sqlite3/lib/index.js", (_cmd: string, args: string[]) => {
      argv = args;
      return { status: 0, signal: null, stderr: "" };
    });
    expect(out).toEqual({ ok: true });
    expect(argv[0]).toBe("-e");
    expect(argv[1]).toContain('require("/abs/better-sqlite3/lib/index.js")');
    expect(argv[1]).toContain('new Database(":memory:")');
  });
});