mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-17 23:47:33 +00:00
## Problem Windows renders commonly fail with environment errors before any real work starts: - `Browser was not found at the configured executablePath (...chrome-headless-shell.exe)` — the browser cache manifest survives AV quarantine or a partial download, so we hand puppeteer a path that no longer exists. - `[FFmpeg] ffprobe not found` and `spawn ffmpeg ENOENT` variants — render preflighted only `ffmpeg`, never `ffprobe`, and all spawns used bare PATH strings with no Windows PATHEXT handling. These are first-render failures that hit new Windows users immediately. ## Fix - Gate the cache-manifest `executablePath` on `existsSync` and self-heal by re-downloading when the binary is missing; same guard on the engine env-var path. - New shared environment preflight (`packages/cli/src/browser/preflight.ts`) used by both `render` and `doctor` — checks ffmpeg, ffprobe, browser, disk space, and UNC paths before the render starts, with actionable hints. - Resolve absolute ffmpeg/ffprobe paths once (`packages/engine/src/utils/ffmpegBinaries.ts`) and pass them to every engine spawn instead of relying on PATH. - Map opaque Windows ffmpeg exit codes to actionable messages. ## Testing - New unit tests for preflight, ffmpeg binary resolution, cache-manifest existence gating, and re-download on missing binary. - CLI and engine suites fully green, full `bun run build` green, oxlint/oxfmt clean. - Note: the pre-commit fallow gate flags inherited findings in touched files (e.g. `audioExtractor.ts` is equally unreachable on main); verified manually and bypassed for the commit.
90 lines
3.1 KiB
TypeScript
90 lines
3.1 KiB
TypeScript
// fallow-ignore-file code-duplication
|
|
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
|
import { parseToolVersion, runEnvironmentChecks } from "./preflight.js";
|
|
|
|
describe("runEnvironmentChecks", () => {
|
|
const originalFfmpegPath = process.env.HYPERFRAMES_FFMPEG_PATH;
|
|
const originalFfprobePath = process.env.HYPERFRAMES_FFPROBE_PATH;
|
|
|
|
beforeEach(() => {
|
|
process.env.HYPERFRAMES_FFMPEG_PATH = process.execPath;
|
|
process.env.HYPERFRAMES_FFPROBE_PATH = process.execPath;
|
|
});
|
|
|
|
afterEach(() => {
|
|
if (originalFfmpegPath === undefined) delete process.env.HYPERFRAMES_FFMPEG_PATH;
|
|
else process.env.HYPERFRAMES_FFMPEG_PATH = originalFfmpegPath;
|
|
if (originalFfprobePath === undefined) delete process.env.HYPERFRAMES_FFPROBE_PATH;
|
|
else process.env.HYPERFRAMES_FFPROBE_PATH = originalFfprobePath;
|
|
});
|
|
|
|
it("returns configured FFmpeg and FFprobe paths when checks pass", async () => {
|
|
const result = await runEnvironmentChecks();
|
|
|
|
expect(result.outcomes.find((outcome) => outcome.name === "FFmpeg")?.ok).toBe(true);
|
|
expect(result.outcomes.find((outcome) => outcome.name === "FFprobe")?.ok).toBe(true);
|
|
expect(result.ffmpegPath).toBe(process.execPath);
|
|
expect(result.ffprobePath).toBe(process.execPath);
|
|
});
|
|
|
|
it("reports ffprobe as a render-blocking error when the explicit path is missing", async () => {
|
|
process.env.HYPERFRAMES_FFPROBE_PATH = "/missing/ffprobe.exe";
|
|
|
|
const result = await runEnvironmentChecks();
|
|
|
|
expect(result.outcomes).toContainEqual(
|
|
expect.objectContaining({
|
|
name: "FFprobe",
|
|
ok: false,
|
|
level: "error",
|
|
title: "FFprobe not found",
|
|
}),
|
|
);
|
|
expect(result.ffprobePath).toBeUndefined();
|
|
});
|
|
|
|
it("fails early when an explicit FFmpeg env override points at a missing file", async () => {
|
|
process.env.HYPERFRAMES_FFMPEG_PATH = "/missing/ffmpeg.exe";
|
|
|
|
const result = await runEnvironmentChecks();
|
|
const ffmpeg = result.outcomes.find((outcome) => outcome.name === "FFmpeg");
|
|
|
|
expect(ffmpeg).toMatchObject({
|
|
ok: false,
|
|
detail: 'Configured path does not exist: HYPERFRAMES_FFMPEG_PATH="/missing/ffmpeg.exe"',
|
|
});
|
|
});
|
|
|
|
it("validates an explicit browser path without needing browser discovery", async () => {
|
|
const result = await runEnvironmentChecks({
|
|
includeBrowser: true,
|
|
browserPath: process.execPath,
|
|
});
|
|
|
|
expect(result.outcomes.find((outcome) => outcome.name === "Chrome")).toMatchObject({
|
|
ok: true,
|
|
path: process.execPath,
|
|
});
|
|
});
|
|
|
|
it("reports an explicit missing browser path before render starts", async () => {
|
|
const result = await runEnvironmentChecks({
|
|
includeBrowser: true,
|
|
browserPath: "/missing/chrome-headless-shell.exe",
|
|
});
|
|
|
|
expect(result.outcomes.find((outcome) => outcome.name === "Chrome")).toMatchObject({
|
|
ok: false,
|
|
title: "Chrome not found",
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("parseToolVersion", () => {
|
|
it("extracts ffprobe versions with Windows build suffixes", () => {
|
|
expect(parseToolVersion("ffprobe version 7.1.1-essentials_build-www.gyan.dev Copyright")).toBe(
|
|
"ffprobe 7.1.1-essentials_build-www.gyan.dev",
|
|
);
|
|
});
|
|
});
|