mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-19 00:18:27 +00:00
* docs(cli): map the pinned Sherpa runtime loading contract * fix(cli): use a healthy pinned Sherpa copy beside the CLI * chore(cli): keep runtime loader comments within the ratchet * docs(cli): wrap the runtime contract palette declarations * chore(cli): keep the Sherpa contract note out of the repo
261 lines
9.1 KiB
TypeScript
261 lines
9.1 KiB
TypeScript
import { spawn } from "node:child_process";
|
|
import { randomUUID } from "node:crypto";
|
|
import {
|
|
existsSync,
|
|
mkdirSync,
|
|
readdirSync,
|
|
readFileSync,
|
|
realpathSync,
|
|
renameSync,
|
|
rmSync,
|
|
statSync,
|
|
writeFileSync,
|
|
} from "node:fs";
|
|
import { createRequire } from "node:module";
|
|
import { homedir } from "node:os";
|
|
import { basename, dirname, join, sep } from "node:path";
|
|
import { buildNpmCommand } from "./npxCommand.js";
|
|
|
|
/** Module type of each optional package; the keys are the only names the loader accepts. */
|
|
export interface OptionalPackageModules {
|
|
"onnxruntime-node": typeof import("onnxruntime-node");
|
|
"@google/genai": typeof import("@google/genai");
|
|
}
|
|
|
|
export type OptionalPackage = keyof OptionalPackageModules;
|
|
|
|
/** Installed on first use instead of with the CLI: their dependency trees carry deprecated packages. */
|
|
export const OPTIONAL_PACKAGES = {
|
|
"onnxruntime-node": "1.21.1",
|
|
"@google/genai": "1.52.0",
|
|
} as const satisfies Record<OptionalPackage, string>;
|
|
|
|
export const PINNED_PACKAGES = {
|
|
...OPTIONAL_PACKAGES,
|
|
"sherpa-onnx-node": "1.13.8",
|
|
} as const;
|
|
|
|
type PinnedPackage = keyof typeof PINNED_PACKAGES;
|
|
|
|
export const CACHE_DIR = join(homedir(), ".cache", "hyperframes", "optional");
|
|
|
|
export interface OptionalPackageDeps {
|
|
cacheDir: string;
|
|
loadBesideCli(name: OptionalPackage): unknown | null;
|
|
/** The package's exports when already installed in `dir`, else null. */
|
|
loadInstalled(dir: string, name: string): unknown | null;
|
|
/** Install `name@version` into `dir`; rejects with npm's output on failure. */
|
|
install(dir: string, name: string, version: string): Promise<void>;
|
|
log(line: string): void;
|
|
}
|
|
|
|
/** One directory per package and version, so a version bump never reads a stale install. */
|
|
export function optionalPackageDir(name: OptionalPackage, cacheDir = CACHE_DIR): string {
|
|
return join(cacheDir, `${name.replace("/", "__")}@${OPTIONAL_PACKAGES[name]}`);
|
|
}
|
|
|
|
/** Installed version, or null. Reads the manifest only, so it never loads a native binding. */
|
|
export function installedOptionalPackageVersion(
|
|
name: OptionalPackage,
|
|
cacheDir = CACHE_DIR,
|
|
cliUrl = import.meta.url,
|
|
): string | null {
|
|
if (pinnedPackageBesideCli(name, cliUrl)?.resolution === "entry") return OPTIONAL_PACKAGES[name];
|
|
const dir = optionalPackageDir(name, cacheDir);
|
|
if (!isInstalled(dir, name)) return null;
|
|
return (JSON.parse(readFileSync(manifestPath(dir, name), "utf-8")) as { version: string })
|
|
.version;
|
|
}
|
|
|
|
export function loadInstalledOptionalPackage<N extends OptionalPackage>(
|
|
name: N,
|
|
deps: OptionalPackageDeps = defaultDeps,
|
|
): OptionalPackageModules[N] | null {
|
|
const found =
|
|
deps.loadBesideCli(name) ?? deps.loadInstalled(optionalPackageDir(name, deps.cacheDir), name);
|
|
return found as OptionalPackageModules[N] | null;
|
|
}
|
|
|
|
/**
|
|
* Load an optional package, installing it once on first use. No prompt: agents run headless.
|
|
* Throws an error that names the manual command when the install cannot complete.
|
|
*/
|
|
export async function loadOptionalPackage<N extends OptionalPackage>(
|
|
name: N,
|
|
feature: string,
|
|
deps: OptionalPackageDeps = defaultDeps,
|
|
): Promise<OptionalPackageModules[N]> {
|
|
const present = loadInstalledOptionalPackage(name, deps);
|
|
if (present !== null) return present;
|
|
const dir = optionalPackageDir(name, deps.cacheDir);
|
|
|
|
const version = OPTIONAL_PACKAGES[name];
|
|
deps.log(`installing ${name} for ${feature}, once`);
|
|
try {
|
|
await deps.install(dir, name, version);
|
|
} catch (err) {
|
|
const output = (err as Error).message.trim();
|
|
const advice = NETWORK_FAILURE.test(output)
|
|
? "Check your network connection, then retry"
|
|
: "Retry";
|
|
throw new Error(
|
|
`${feature} needs ${name}, and installing it failed (${output.split("\n")[0]}). ` +
|
|
`${advice}, or install it yourself: npm install ${name}@${version} --prefix "${dir}"`,
|
|
);
|
|
}
|
|
const loaded = deps.loadInstalled(dir, name);
|
|
if (loaded === null) {
|
|
throw new Error(`${name}@${version} installed into ${dir} but could not be loaded.`);
|
|
}
|
|
return loaded as OptionalPackageModules[N];
|
|
}
|
|
|
|
const NETWORK_FAILURE = /ENOTFOUND|ETIMEDOUT|EAI_AGAIN|ECONNRESET|ECONNREFUSED|network/i;
|
|
|
|
function manifestPath(dir: string, name: string): string {
|
|
return join(dir, "node_modules", name, "package.json");
|
|
}
|
|
|
|
export function isInstalled(dir: string, name: string): boolean {
|
|
return existsSync(manifestPath(dir, name));
|
|
}
|
|
|
|
export function installedPackagePath(dir: string, name: string): string | null {
|
|
if (!isInstalled(dir, name)) return null;
|
|
return createRequire(join(dir, "package.json")).resolve(name);
|
|
}
|
|
|
|
function loadInstalled(dir: string, name: string): unknown | null {
|
|
const entry = installedPackagePath(dir, name);
|
|
return entry === null ? null : createRequire(join(dir, "package.json"))(entry);
|
|
}
|
|
|
|
export function pinnedPackageBesideCli(
|
|
name: PinnedPackage,
|
|
cliUrl = import.meta.url,
|
|
): { resolution: "entry" | "package"; path: string } | null {
|
|
const req = createRequire(cliUrl);
|
|
try {
|
|
let entry: string;
|
|
try {
|
|
entry = realpathSync(req.resolve(name));
|
|
} catch {
|
|
const copy = (req.resolve.paths(name) ?? [])
|
|
.map((dir) => join(dir, name))
|
|
.find((dir) => existsSync(join(dir, "package.json")));
|
|
return copy && hasPinnedVersion(copy, name)
|
|
? { resolution: "package", path: realpathSync(copy) }
|
|
: null;
|
|
}
|
|
const copy = (req.resolve.paths(name) ?? [])
|
|
.map((dir) => join(dir, name))
|
|
.find((dir) => existsSync(dir) && entry.startsWith(realpathSync(dir) + sep));
|
|
if (!copy) return null;
|
|
return hasPinnedVersion(copy, name) ? { resolution: "entry", path: entry } : null;
|
|
} catch {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
function hasPinnedVersion(copy: string, name: PinnedPackage): boolean {
|
|
const manifest = readFileSync(join(copy, "package.json"), "utf-8");
|
|
return (JSON.parse(manifest) as { version?: string }).version === PINNED_PACKAGES[name];
|
|
}
|
|
|
|
export function loadBesideCli(name: PinnedPackage, cliUrl = import.meta.url): unknown | null {
|
|
const copy = pinnedPackageBesideCli(name, cliUrl);
|
|
return copy?.resolution === "entry" ? createRequire(cliUrl)(copy.path) : null;
|
|
}
|
|
|
|
export function runNpm(args: string[], signal?: AbortSignal): Promise<void> {
|
|
const npm = buildNpmCommand(args);
|
|
const child = spawn(npm.command, npm.args, { stdio: ["ignore", "pipe", "pipe"], signal });
|
|
return new Promise((resolve, reject) => {
|
|
let output = "";
|
|
child.stdout.on("data", (chunk) => (output += chunk));
|
|
child.stderr.on("data", (chunk) => (output += chunk));
|
|
child.on("error", reject);
|
|
child.on("close", (code) =>
|
|
code === 0 ? resolve() : reject(new Error(output || `npm exited with code ${code}`)),
|
|
);
|
|
});
|
|
}
|
|
|
|
function isProcessAlive(pid: number): boolean {
|
|
try {
|
|
process.kill(pid, 0);
|
|
return true;
|
|
} catch (err) {
|
|
return (err as NodeJS.ErrnoException).code !== "ESRCH";
|
|
}
|
|
}
|
|
|
|
const STAGING_PID_TRUSTED_FOR_MS = 6 * 60 * 60 * 1000;
|
|
|
|
/** Removes staging dirs whose pid is dead (killed install), or too old to trust a live pid (reuse). */
|
|
export function sweepStaleStaging(dir: string): void {
|
|
const prefix = `${basename(dir)}.tmp-`;
|
|
const parent = dirname(dir);
|
|
if (!existsSync(parent)) return;
|
|
for (const entry of readdirSync(parent)) {
|
|
if (!entry.startsWith(prefix)) continue;
|
|
const pid = /^(\d+)(?:-|$)/.exec(entry.slice(prefix.length))?.[1];
|
|
if (pid === undefined) continue;
|
|
const stale = join(parent, entry);
|
|
const age = Date.now() - (statSync(stale, { throwIfNoEntry: false })?.mtimeMs ?? Date.now());
|
|
if (isProcessAlive(Number(pid)) && age < STAGING_PID_TRUSTED_FOR_MS) continue;
|
|
try {
|
|
rmSync(stale, { recursive: true, force: true });
|
|
} catch (err) {
|
|
// Best effort: a locked stale dir must not block a viable install, but it stays visible.
|
|
console.error(`could not remove stale install dir ${stale}: ${(err as Error).message}`);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Installs into a sibling staging dir, then renames, so `dir` only ever holds a complete install.
|
|
* No cross-process lock: two first runs both download and the loser discards its copy.
|
|
*/
|
|
export async function install(
|
|
dir: string,
|
|
name: string,
|
|
version: string,
|
|
run: (args: string[]) => Promise<void> = runNpm,
|
|
): Promise<void> {
|
|
sweepStaleStaging(dir);
|
|
const staging = `${dir}.tmp-${process.pid}-${randomUUID().slice(0, 8)}`;
|
|
mkdirSync(staging, { recursive: true });
|
|
writeFileSync(join(staging, "package.json"), "{}");
|
|
try {
|
|
await run([
|
|
"install",
|
|
`${name}@${version}`,
|
|
"--prefix",
|
|
staging,
|
|
"--no-audit",
|
|
"--no-fund",
|
|
"--loglevel=error",
|
|
// A first-use install is interactive, not a CI resolve: fail fast and name the
|
|
// manual command instead of sitting through npm's default multi-minute backoff.
|
|
"--fetch-retries=0",
|
|
"--fetch-timeout=20000",
|
|
]);
|
|
if (isInstalled(dir, name)) return;
|
|
rmSync(dir, { recursive: true, force: true });
|
|
renameSync(staging, dir);
|
|
} catch (err) {
|
|
if (!isInstalled(dir, name)) throw err;
|
|
} finally {
|
|
rmSync(staging, { recursive: true, force: true });
|
|
}
|
|
}
|
|
|
|
const defaultDeps: OptionalPackageDeps = {
|
|
cacheDir: CACHE_DIR,
|
|
loadBesideCli: (name) => loadBesideCli(name),
|
|
loadInstalled,
|
|
install,
|
|
log: (line) => console.error(line),
|
|
};
|