mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-03 12:54:29 +00:00
* fix(cli): purge stale/partial browser installs instead of wedging retries Two independent reports of the same failure: a `chrome-headless-shell` zip extraction gets interrupted (Windows AV lock, sleep/wake, ctrl-C) and leaves only the alphabetically-early files (ABOUT/LICENSE) in the target directory, no executable. Every subsequent `browser ensure` (or implicit re-download from `findBrowser`/`ensureBrowser`) sees the directory already exists and hands it straight to @puppeteer/browsers' install(), which throws "folder exists but the executable is missing" without re-extracting -- permanently wedging the machine until someone manually deletes the directory. `--force` didn't help because it was a phantom flag: `browser.ts` never declared it, so it silently did nothing (mentioned only in an error-message string). Root cause: `findFromCache()` already detects this exact case (dir exists, exe missing) and returns it as `staleHyperframesCachePath`, but `findBrowser()`/`ensureBrowser()` fed that straight into a re-download without ever deleting the stale directory first, so install() hit the same "exists" branch every time. Fix: - `findFromCache()` also returns `staleInstallPath` (InstalledBrowser's `.path` -- the actual install-folder root, not the missing executablePath) for the stale case. - Both `findBrowser()` and `ensureBrowser()` now purge that directory (`rmSync`, inside the existing `withInstallLock` mutex from #1866 so a purge can't race a concurrent installer) before retrying, so install() actually re-extracts instead of erroring. - Wired up a real `--force` flag on `hyperframes browser ensure`: it purges the whole HF-managed cache (reusing the already-tested `clearBrowser()`) and skips every cache/system shortcut, so it always gets a fresh download regardless of what's currently on disk -- matching what the existing (previously false) help text already claimed it did. Not fixed here (separate root cause, flagged for later): neither report's machine had a usable auto-detected system Chrome fallback on Windows -- `SYSTEM_CHROME_PATHS` only lists macOS/Linux paths, so `findFromSystem()` can never succeed on win32. Both reporters worked around this manually via HYPERFRAMES_BROWSER_PATH, which still works fine; adding real Windows system-Chrome detection is a distinct, larger change. Test: extended manager.test.ts's existing stale-cache-redownload test to include a populated stale install directory and assert it's gone before the mocked install() is called (was previously only asserting the redownload happened, not that the fix's purge step ran). Added a new test for `ensureBrowser({force: true})` purging the cache and bypassing a healthy cache/system-Chrome shortcut. Also fixed the shared fs mock's `rmSync` to actually simulate recursive deletion (drop nested tracked paths too), which the new tests need and the old ones never exercised. Full CLI suite (1222 tests) passes. * fix(cli): serialize force browser cache purge
196 lines
6.7 KiB
TypeScript
196 lines
6.7 KiB
TypeScript
import { defineCommand } from "citty";
|
|
import type { Example } from "./_examples.js";
|
|
import * as clack from "@clack/prompts";
|
|
import { c } from "../ui/colors.js";
|
|
|
|
export const examples: Example[] = [
|
|
["Find or download Chrome for rendering", "hyperframes browser ensure"],
|
|
["Purge a stale/partial download and re-download", "hyperframes browser ensure --force"],
|
|
["Print the Chrome executable path", "hyperframes browser path"],
|
|
["Remove cached Chrome download", "hyperframes browser clear"],
|
|
];
|
|
import { formatBytes } from "../ui/format.js";
|
|
import {
|
|
ensureBrowser,
|
|
findBrowser,
|
|
clearBrowser,
|
|
CHROME_VERSION,
|
|
CACHE_DIR,
|
|
isLinuxArm,
|
|
} from "../browser/manager.js";
|
|
import { trackBrowserInstall, trackCommandFailure } from "../telemetry/events.js";
|
|
|
|
async function runEnsure(options?: { force?: boolean }): Promise<void> {
|
|
clack.intro(c.bold("hyperframes browser ensure"));
|
|
|
|
// ARM64 Linux: Chrome headless shell is not available (apt-get/system-only
|
|
// install flow, no download cache to force a purge of) — --force is a no-op here.
|
|
if (isLinuxArm()) {
|
|
const s = clack.spinner();
|
|
s.start("Linux ARM64 detected — looking for system Chromium...");
|
|
const existing = await findBrowser();
|
|
if (existing) {
|
|
s.stop(c.success("System Chromium found"));
|
|
console.log();
|
|
console.log(` ${c.dim("Source:")} ${c.bold(existing.source)}`);
|
|
console.log(` ${c.dim("Path:")} ${c.bold(existing.executablePath)}`);
|
|
console.log();
|
|
clack.outro(c.success("Ready to render."));
|
|
return;
|
|
}
|
|
|
|
s.stop(c.warn("No Chromium found — attempting auto-install via apt-get..."));
|
|
console.log();
|
|
|
|
// Delegate to ensureBrowser which handles the full ARM64 install flow.
|
|
try {
|
|
const result = await ensureBrowser();
|
|
console.log();
|
|
console.log(` ${c.dim("Source:")} ${c.bold(result.source)}`);
|
|
console.log(` ${c.dim("Path:")} ${c.bold(result.executablePath)}`);
|
|
console.log();
|
|
clack.outro(c.success("Chromium ready. You can now render on ARM64."));
|
|
} catch (err) {
|
|
// The ARM64 auto-install failed: the browser is NOT ready, so this is a
|
|
// real failure (exit 1), not a success. Report it and stop swallowing.
|
|
trackCommandFailure("browser", err);
|
|
clack.log.error(err instanceof Error ? err.message : String(err));
|
|
clack.outro(c.warn("Manual setup required (see instructions above)."));
|
|
process.exit(1);
|
|
}
|
|
return;
|
|
}
|
|
|
|
const s = clack.spinner();
|
|
if (!options?.force) {
|
|
s.start("Looking for an existing browser...");
|
|
|
|
const existing = await findBrowser();
|
|
if (existing) {
|
|
s.stop(c.success("Browser found"));
|
|
console.log();
|
|
console.log(` ${c.dim("Source:")} ${c.bold(existing.source)}`);
|
|
console.log(` ${c.dim("Path:")} ${c.bold(existing.executablePath)}`);
|
|
console.log();
|
|
clack.outro(c.success("Ready to render."));
|
|
return;
|
|
}
|
|
|
|
s.stop("No browser found — downloading");
|
|
} else {
|
|
s.start("Purging cached download and re-downloading...");
|
|
}
|
|
|
|
const downloadSpinner = clack.spinner();
|
|
downloadSpinner.start(`Downloading Chrome Headless Shell ${c.dim("v" + CHROME_VERSION)}...`);
|
|
|
|
let lastPct = -1;
|
|
const result = await ensureBrowser({
|
|
force: options?.force,
|
|
onProgress: (downloaded, total) => {
|
|
if (total <= 0) return;
|
|
const pct = Math.floor((downloaded / total) * 100);
|
|
if (pct > lastPct) {
|
|
lastPct = pct;
|
|
downloadSpinner.message(
|
|
`Downloading Chrome Headless Shell ${c.dim("v" + CHROME_VERSION)} — ${c.progress(pct + "%")} ${c.dim("(" + formatBytes(downloaded) + " / " + formatBytes(total) + ")")}`,
|
|
);
|
|
}
|
|
},
|
|
});
|
|
|
|
downloadSpinner.stop(c.success("Download complete"));
|
|
trackBrowserInstall();
|
|
|
|
console.log();
|
|
console.log(` ${c.dim("Source:")} ${c.bold(result.source)}`);
|
|
console.log(` ${c.dim("Path:")} ${c.bold(result.executablePath)}`);
|
|
console.log();
|
|
|
|
clack.outro(c.success("Ready to render."));
|
|
}
|
|
|
|
async function runPath(): Promise<void> {
|
|
const result = await findBrowser();
|
|
if (!result) {
|
|
// Try a full ensure (which includes download) but write only the path
|
|
try {
|
|
const ensured = await ensureBrowser();
|
|
process.stdout.write(ensured.executablePath + "\n");
|
|
} catch (err: unknown) {
|
|
trackCommandFailure("browser", err);
|
|
console.error(err instanceof Error ? err.message : "Failed to find browser");
|
|
process.exit(1);
|
|
}
|
|
return;
|
|
}
|
|
process.stdout.write(result.executablePath + "\n");
|
|
}
|
|
|
|
function runClear(): void {
|
|
clack.intro(c.bold("hyperframes browser clear"));
|
|
|
|
const removed = clearBrowser();
|
|
if (removed) {
|
|
clack.outro(c.success("Removed cached browser from ") + c.dim(CACHE_DIR));
|
|
} else {
|
|
clack.outro(c.dim("No cached browser to remove."));
|
|
}
|
|
}
|
|
|
|
export default defineCommand({
|
|
meta: { name: "browser", description: "Manage the Chrome browser used for rendering" },
|
|
args: {
|
|
subcommand: {
|
|
type: "positional",
|
|
description:
|
|
"ensure = find or download Chrome, path = print executable path, clear = remove cached download",
|
|
required: false,
|
|
},
|
|
force: {
|
|
type: "boolean",
|
|
description:
|
|
"ensure only: purge any cached download (including a stale/partial one) and re-download from scratch",
|
|
default: false,
|
|
},
|
|
},
|
|
async run({ args }) {
|
|
const subcommand = args.subcommand;
|
|
|
|
if (!subcommand || subcommand === "") {
|
|
console.log(`
|
|
${c.bold("hyperframes browser")} ${c.dim("<subcommand>")}
|
|
|
|
Manage the Chrome browser used for rendering.
|
|
|
|
${c.bold("SUBCOMMANDS:")}
|
|
${c.accent("ensure")} ${c.dim("Find or download Chrome for rendering")}
|
|
${c.accent("path")} ${c.dim("Print browser executable path (for scripting)")}
|
|
${c.accent("clear")} ${c.dim("Remove cached Chrome download")}
|
|
|
|
${c.bold("EXAMPLES:")}
|
|
${c.accent("npx hyperframes browser ensure")} ${c.dim("Download Chrome if needed")}
|
|
${c.accent("npx hyperframes browser ensure --force")} ${c.dim("Purge a stale/partial download and re-download")}
|
|
${c.accent("npx hyperframes browser path")} ${c.dim("Print path for scripts")}
|
|
${c.accent("npx hyperframes browser clear")} ${c.dim("Remove cached browser")}
|
|
`);
|
|
return;
|
|
}
|
|
|
|
switch (subcommand) {
|
|
case "ensure":
|
|
return runEnsure({ force: args.force });
|
|
case "path":
|
|
return runPath();
|
|
case "clear":
|
|
return runClear();
|
|
default:
|
|
trackCommandFailure("browser", `Unknown subcommand: ${subcommand}`);
|
|
console.error(
|
|
`${c.error("Unknown subcommand:")} ${subcommand}\n\nRun ${c.accent("hyperframes browser --help")} for usage.`,
|
|
);
|
|
process.exit(1);
|
|
}
|
|
},
|
|
});
|