mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-03 23:03:09 +00:00
feat(engine): browserGpuMode "auto" — probe WebGL once, fall back to software
When the host doesn't have a usable GPU (CI containers, eval rigs without
GPU passthrough, dev VMs), Chrome's hardware-mode WebGL flags
(`--use-gl=egl/metal/d3d11`) silently leave WebGL unavailable —
`getContext("webgl")` returns null, three.js' WebGLRenderer dies, the
canvas stays black. Surfaced today by Abhay's c2v-eval failing on a
docker render of an hf bundle that uses three.js + a custom fragment
shader.
The fix that's been there: `--use-gl=angle --use-angle=swiftshader` (CPU
software WebGL, ~5-50× slower but pixel-identical). The engine already
exposed `browserGpuMode: "software"` for this. The gap was discovery —
users had to know to pass `--no-browser-gpu` on no-GPU hosts.
This change adds `browserGpuMode: "auto"` (now the CLI default for local
renders): on first launch in the process, probe Chrome with hardware
args, check `canvas.getContext("webgl") !== null`, cache the result.
~1-2 s on first render, free on every subsequent render in the same
worker. Hardware GPUs keep their fast path; no-GPU hosts get SwiftShader
without ceremony.
Behaviour matrix:
- No flag, no env, local → "auto" (NEW default)
- `--browser-gpu` → "hardware" (force; errors if no GPU)
- `--no-browser-gpu` → "software" (force SwiftShader)
- `PRODUCER_BROWSER_GPU_MODE` → "hardware" / "software" / "auto" / unset
- Docker mode → forced "software" (unchanged)
Engine-config default stays "software" (conservative for embedders); the
"auto" default lives in the CLI's `resolveBrowserGpuForCli` so producer
embedders aren't surprised by a probe-on-launch.
Also adds `--enable-unsafe-swiftshader` to the software flag set —
Chrome 120+ deprecated implicit SwiftShader fallback and emits a
deprecation warning unless the flag is set explicitly. Despite the
"unsafe" name this is exactly the pre-deprecation behaviour; the rename
is about Chrome's threat model on the open web, not about the rendering
itself.
Verification:
- Engine 535/535 + CLI 256/256 (incl. new probe tests + tri-state CLI test)
- Empirical: probe on this no-GPU devbox returns "software" in 240 ms,
cached 0 ms on subsequent calls
- Format / lint / typecheck clean across all packages
Refs the Abhay/Slack thread on c2v-eval rendering without a GPU node.
This commit is contained in:
@@ -72,6 +72,25 @@ describe("renderLocal browser GPU config", () => {
|
||||
});
|
||||
});
|
||||
|
||||
it("forwards browserGpuMode='auto' into producer config (probe-then-choose)", async () => {
|
||||
const { renderLocal } = await import("./render.js");
|
||||
await renderLocal("/tmp/project", "/tmp/out.mp4", {
|
||||
fps: 30,
|
||||
quality: "standard",
|
||||
format: "mp4",
|
||||
gpu: false,
|
||||
browserGpuMode: "auto",
|
||||
hdrMode: "auto",
|
||||
quiet: true,
|
||||
});
|
||||
|
||||
expect(producerState.resolveConfigCalls).toContainEqual({ browserGpuMode: "auto" });
|
||||
expect(producerState.createdJobs[0]?.producerConfig).toMatchObject({
|
||||
browserGpuMode: "auto",
|
||||
resolved: true,
|
||||
});
|
||||
});
|
||||
|
||||
it("passes an explicit hardware override for default local browser GPU", async () => {
|
||||
const { renderLocal } = await import("./render.js");
|
||||
await renderLocal("/tmp/project", "/tmp/out.mp4", {
|
||||
@@ -94,12 +113,18 @@ describe("renderLocal browser GPU config", () => {
|
||||
it("resolves browser GPU from CLI flags, Docker mode, and env fallback", async () => {
|
||||
const { resolveBrowserGpuForCli } = await import("./render.js");
|
||||
|
||||
expect(resolveBrowserGpuForCli(false, undefined, undefined)).toBe(true);
|
||||
expect(resolveBrowserGpuForCli(false, undefined, "hardware")).toBe(true);
|
||||
expect(resolveBrowserGpuForCli(false, undefined, "software")).toBe(false);
|
||||
expect(resolveBrowserGpuForCli(false, true, "software")).toBe(true);
|
||||
expect(resolveBrowserGpuForCli(false, false, "hardware")).toBe(false);
|
||||
expect(resolveBrowserGpuForCli(true, undefined, "hardware")).toBe(false);
|
||||
// Default (no flag, no env): auto — engine probes and chooses.
|
||||
expect(resolveBrowserGpuForCli(false, undefined, undefined)).toBe("auto");
|
||||
// Env override
|
||||
expect(resolveBrowserGpuForCli(false, undefined, "hardware")).toBe("hardware");
|
||||
expect(resolveBrowserGpuForCli(false, undefined, "software")).toBe("software");
|
||||
expect(resolveBrowserGpuForCli(false, undefined, "auto")).toBe("auto");
|
||||
// Explicit CLI flag wins over env
|
||||
expect(resolveBrowserGpuForCli(false, true, "software")).toBe("hardware");
|
||||
expect(resolveBrowserGpuForCli(false, false, "hardware")).toBe("software");
|
||||
// Docker forces software regardless of flags/env
|
||||
expect(resolveBrowserGpuForCli(true, undefined, "hardware")).toBe("software");
|
||||
expect(resolveBrowserGpuForCli(true, undefined, "auto")).toBe("software");
|
||||
});
|
||||
|
||||
it("forwards parsed --variables payload to createRenderJob", async () => {
|
||||
|
||||
Reference in New Issue
Block a user