Files
OmniRoute/tests/unit/cli-runtime.test.ts
Diego Rodrigues de Sa e Souza a62141210b fix(cli): verify better-sqlite3 native binary is actually loadable (#7105)
* fix(cli): verify better-sqlite3 native binary is actually loadable (port from 9router#2493)

isBetterSqliteBinaryValid() only checked the .node file's magic bytes (ELF/Mach-O/PE header), never whether the binary was built for the ABI (NODE_MODULE_VERSION) of the Node runtime that loads it. A stale or foreign-ABI binary passed the check and then segfaulted the process on the first database call instead of triggering a rebuild via npmInstallRuntime(). The fix adds a real load probe (require() in a throwaway subprocess) after the magic-byte check, so an incompatible binary is now correctly reported as invalid and the runtime self-heal reinstalls it.

Reported-by: Manikandan (@mrprohack) (https://github.com/decolua/9router/issues/2493)

* chore(changelog): move #2493 entry to changelog.d fragment

Consistency with the repo's canonical changelog.d/fixes/ workflow (avoids
merge-storm re-conflicts from editing CHANGELOG.md directly).
2026-07-16 14:13:33 -03:00

135 lines
5.7 KiB
TypeScript

import test from "node:test";
import assert from "node:assert/strict";
import { mkdtempSync, rmSync, writeFileSync, mkdirSync } from "node:fs";
import { join } from "node:path";
import { tmpdir } from "node:os";
let tmpDir: string;
let origDataDir: string | undefined;
test.before(() => {
tmpDir = mkdtempSync(join(tmpdir(), "omniroute-runtime-test-"));
origDataDir = process.env.DATA_DIR;
process.env.DATA_DIR = tmpDir;
});
test.after(() => {
if (origDataDir === undefined) delete process.env.DATA_DIR;
else process.env.DATA_DIR = origDataDir;
try {
rmSync(tmpDir, { recursive: true, force: true });
} catch {}
});
test("nativeDeps.mjs pode ser importado sem erro", async () => {
const mod = await import("../../bin/cli/runtime/nativeDeps.mjs");
assert.equal(typeof mod.ensureRuntimeDir, "function");
assert.equal(typeof mod.getRuntimeNodeModules, "function");
assert.equal(typeof mod.hasModule, "function");
assert.equal(typeof mod.isBetterSqliteBinaryValid, "function");
assert.equal(typeof mod.npmInstallRuntime, "function");
assert.equal(typeof mod.ensureBetterSqliteRuntime, "function");
assert.equal(typeof mod.buildEnvWithRuntime, "function");
});
test("ensureRuntimeDir cria diretório e package.json", async () => {
const { ensureRuntimeDir } = await import("../../bin/cli/runtime/nativeDeps.mjs");
const dir = ensureRuntimeDir();
const { existsSync } = await import("node:fs");
assert.ok(existsSync(dir), "runtime dir deve existir");
assert.ok(existsSync(join(dir, "package.json")), "package.json deve existir");
});
test("getRuntimeNodeModules retorna caminho dentro do DATA_DIR", async () => {
const { getRuntimeNodeModules } = await import("../../bin/cli/runtime/nativeDeps.mjs");
const nm = getRuntimeNodeModules();
assert.ok(nm.startsWith(tmpDir), "node_modules deve estar dentro do tmpDir");
assert.ok(nm.endsWith("node_modules"), "path deve terminar com node_modules");
});
test("hasModule retorna false para módulo inexistente", async () => {
const { hasModule } = await import("../../bin/cli/runtime/nativeDeps.mjs");
assert.equal(hasModule("definitely-not-installed-xyz"), false);
});
test("isBetterSqliteBinaryValid retorna false quando binário não existe", async () => {
const { isBetterSqliteBinaryValid } = await import("../../bin/cli/runtime/nativeDeps.mjs");
assert.equal(isBetterSqliteBinaryValid(), false);
});
test("buildEnvWithRuntime extende NODE_PATH com runtime node_modules", async () => {
const { buildEnvWithRuntime, getRuntimeNodeModules } =
await import("../../bin/cli/runtime/nativeDeps.mjs");
const nm = getRuntimeNodeModules();
const env = buildEnvWithRuntime({});
assert.ok(env.NODE_PATH.includes(nm), "NODE_PATH deve conter runtime node_modules");
});
test("buildEnvWithRuntime preserva NODE_PATH existente", async () => {
const { buildEnvWithRuntime } = await import("../../bin/cli/runtime/nativeDeps.mjs");
const env = buildEnvWithRuntime({ NODE_PATH: "/existing/path" });
assert.ok(env.NODE_PATH.includes("/existing/path"), "NODE_PATH original deve ser preservado");
});
test("isBetterSqliteBinaryValid rejeita binário com magic bytes válidos mas ABI incompatível (regressão #2493)", async () => {
// Regression for upstream 9router#2493: a binary that only "looks" native (correct ELF/Mach-O/PE
// header) but was built for a different Node ABI (NODE_MODULE_VERSION) must NOT be reported as
// valid — loading it crashes the process (segfault) instead of triggering a rebuild.
const { getRuntimeNodeModules, isBetterSqliteBinaryValid } =
await import("../../bin/cli/runtime/nativeDeps.mjs");
const nm = getRuntimeNodeModules();
const buildDir = join(nm, "better-sqlite3", "build", "Release");
mkdirSync(buildDir, { recursive: true });
const binary = join(buildDir, "better_sqlite3.node");
const { platform } = await import("node:os");
const os = platform();
// Correct file-format magic bytes for the current OS, but not a real, loadable native addon —
// this is exactly what the old magic-bytes-only check let through.
const magicByPlatform = {
linux: [0x7f, 0x45, 0x4c, 0x46],
darwin: [0xcf, 0xfa, 0xed, 0xfe],
win32: [0x4d, 0x5a],
};
const magic = magicByPlatform[os] ?? magicByPlatform.linux;
const buf = Buffer.concat([Buffer.from(magic), Buffer.alloc(64, 0)]);
writeFileSync(binary, buf);
const result = isBetterSqliteBinaryValid();
assert.equal(
result,
false,
"binário com header válido mas ABI/conteúdo incompatível deve ser inválido"
);
rmSync(join(nm, "better-sqlite3"), { recursive: true, force: true });
});
test("isBetterSqliteBinaryValid aceita um binário nativo real e carregável", async () => {
const { getRuntimeNodeModules, isBetterSqliteBinaryValid } =
await import("../../bin/cli/runtime/nativeDeps.mjs");
const { existsSync, copyFileSync } = await import("node:fs");
const realBinary = join(
process.cwd(),
"node_modules",
"better-sqlite3",
"build",
"Release",
"better_sqlite3.node"
);
if (!existsSync(realBinary)) {
// Ambient runtime without a compiled better-sqlite3 binary — nothing to assert here.
return;
}
const nm = getRuntimeNodeModules();
const buildDir = join(nm, "better-sqlite3", "build", "Release");
mkdirSync(buildDir, { recursive: true });
const binary = join(buildDir, "better_sqlite3.node");
copyFileSync(realBinary, binary);
const result = isBetterSqliteBinaryValid();
assert.equal(result, true, "um binário real, compatível com o Node atual, deve ser válido");
rmSync(join(nm, "better-sqlite3"), { recursive: true, force: true });
});
test("commands/runtime.mjs pode ser importado sem erro", async () => {
const mod = await import("../../bin/cli/commands/runtime.mjs");
assert.equal(typeof mod.registerRuntime, "function");
});