Files
OmniRoute/bin/cli/runtime/magicBytes.mjs
diegosouzapw 8f915b18b0 feat(runtime): dynamic SQLite runtime installer with 5-step fallback chain
Adds bin/cli/runtime/sqliteRuntime.mjs that resolves better-sqlite3 from:
(1) bundled optionalDependency, (2) ~/.omniroute/runtime/ install,
(3) lazy npm install into runtime dir, (4) node:sqlite stdlib (Node >=22.5),
(5) bundled sql.js WASM. Each native binary is validated against expected
platform magic bytes (ELF/Mach-O/PE) before load.

Adds bin/cli/runtime/magicBytes.mjs with validateBinaryMagic() helper
(9 tests). Adds bin/cli/runtime/index.mjs as warmUpRuntimes() orchestrator.

Adds scripts/postinstall.mjs warm-up hook (non-fatal, skipped in CI).
Integrates it as the last step of scripts/build/postinstall.mjs.

Extends src/lib/db/core.ts with ensureDbInitialized() (async, idempotent)
and getDriverInfo() so the startup orchestrator can await the resolver
before any DB access, enabling graceful degradation without crashing the
process on missing better-sqlite3.

Solves Windows EBUSY error on 'npm install -g omniroute@latest' while the
previous version is still running, and works in environments without C++
build tools or with unreachable npm registry.

Documents OMNIROUTE_SKIP_POSTINSTALL in .env.example and ENVIRONMENT.md.

Ref: 9router/cli/hooks/sqliteRuntime.js (pattern origin).
2026-05-15 00:05:49 -03:00

49 lines
1.7 KiB
JavaScript

import { readFileSync, existsSync } from "node:fs";
/**
* Validates that a file starts with a known native-binary magic number.
* Returns the platform label ("elf" | "macho" | "macho-le" | "macho-fat" | "pe")
* or null if unrecognized / missing / unreadable.
*
* Ref: 9router/cli/hooks/sqliteRuntime.js (algorithm origin).
*/
export function validateBinaryMagic(path) {
if (!existsSync(path)) return null;
let buf;
try {
buf = readFileSync(path, { encoding: null }).subarray(0, 16);
} catch {
return null;
}
if (buf.length < 4) return null;
// ELF: 7F 45 4C 46
if (buf[0] === 0x7f && buf[1] === 0x45 && buf[2] === 0x4c && buf[3] === 0x46) return "elf";
// Mach-O big-endian: FE ED FA CF (64-bit) / FE ED FA CE (32-bit)
if (buf[0] === 0xfe && buf[1] === 0xed && buf[2] === 0xfa && buf[3] === 0xcf) return "macho";
if (buf[0] === 0xfe && buf[1] === 0xed && buf[2] === 0xfa && buf[3] === 0xce) return "macho";
// Mach-O little-endian: CF FA ED FE (64-bit) / CE FA ED FE (32-bit)
if (buf[0] === 0xcf && buf[1] === 0xfa && buf[2] === 0xed && buf[3] === 0xfe) return "macho-le";
if (buf[0] === 0xce && buf[1] === 0xfa && buf[2] === 0xed && buf[3] === 0xfe) return "macho-le";
// Mach-O fat (universal binary): CA FE BA BE
if (buf[0] === 0xca && buf[1] === 0xfe && buf[2] === 0xba && buf[3] === 0xbe) return "macho-fat";
// PE (Windows .node — DLL): MZ at offset 0
if (buf[0] === 0x4d && buf[1] === 0x5a) return "pe";
return null;
}
/**
* Returns the expected magic label for the current platform.
* Used to validate that a runtime-installed binary matches this OS.
*/
export function platformBinaryLabel() {
if (process.platform === "win32") return "pe";
if (process.platform === "darwin") return "macho";
return "elf";
}