mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-01 19:42:03 +00:00
Closes #1219 ## Problem On 8GB RAM machines, renders time out at 5% with `Runtime.callFunctionOn timed out` during the duration probe. User-set timeout env vars (`PRODUCER_PUPPETEER_PROTOCOL_TIMEOUT_MS`) are silently ignored by the calibration path, and there are no CLI flags to control timeouts directly. ## Root causes 1. **Calibration timeout cap overrides user settings** — `createCaptureCalibrationConfig` used `Math.min(cfg.protocolTimeout, 30_000)`, meaning even if the user set 300s, calibration still capped at 30s. On slow hardware this causes unnecessary timeouts. 2. **8GB systems get no low-memory treatment** — `getLowMemoryFlags()`, `getGpuMemBudgetMb()`, `memoryAdaptiveCacheLimit()`, and `memoryAdaptiveCacheBytesMb()` all used `< 8192` as the threshold. Systems reporting exactly 8192 MB (common for 8GB machines) fell through to the "plenty of memory" path, getting no Chrome heap reduction or cache limits. 3. **No CLI flags for key timeouts** — Users had to discover the correct env var names (`PRODUCER_PUPPETEER_PROTOCOL_TIMEOUT_MS`, `PRODUCER_PLAYER_READY_TIMEOUT_MS`) by reading source. The non-existent `PUPPETEER_PROTOCOL_TIMEOUT` and `--browser-timeout` were common guesses that did nothing. ## Changes - `captureCost.ts`: `Math.min` → `Math.max` so the 30s calibration default is a floor, not a ceiling. User-set higher timeouts are now respected. - `browserManager.ts`: `>= 8192` → `> 8192` in `getLowMemoryFlags()` and `<= 8192` in `getGpuMemBudgetMb()` so 8GB systems get reduced Chrome heap and GPU memory budget. - `config.ts`: `< 8192` → `<= 8192` in `memoryAdaptiveCacheLimit()` and `memoryAdaptiveCacheBytesMb()` so 8GB systems get reduced frame cache limits. - `render.ts`: Added `--protocol-timeout <ms>` and `--player-ready-timeout <ms>` CLI flags, wired through `resolveConfig` overrides. - Updated calibration tests to match the new floor-not-ceiling behavior. - Added fallow suppressions for pre-existing unused exports in `captureCost.ts`. ## Test plan - [x] Engine config tests pass (`vitest run src/config.test.ts`) - [x] Browser manager tests pass (`vitest run src/services/browserManager.test.ts`) - [x] Calibration safeguard tests pass (4/4 in `renderOrchestrator.test.ts`) - [x] TypeScript compiles cleanly for engine and cli packages - [ ] CI pipeline
134 lines
4.1 KiB
TypeScript
134 lines
4.1 KiB
TypeScript
import assert from "node:assert/strict";
|
|
import { createGsapAdapter } from "../src/runtime/adapters/gsap";
|
|
import { createRuntimePlayer } from "../src/runtime/player";
|
|
import type { RuntimeTimelineLike } from "../src/runtime/types";
|
|
|
|
type Call = {
|
|
method: "pause" | "seek" | "totalTime";
|
|
time?: number;
|
|
suppressEvents?: boolean;
|
|
};
|
|
|
|
function createTimeline(withTotalTime: boolean): { calls: Call[]; timeline: RuntimeTimelineLike } {
|
|
const calls: Call[] = [];
|
|
const timeline: RuntimeTimelineLike = {
|
|
play: () => undefined,
|
|
pause: () => {
|
|
calls.push({ method: "pause" });
|
|
},
|
|
seek: (timeSeconds: number, suppressEvents?: boolean) => {
|
|
calls.push({ method: "seek", time: timeSeconds, suppressEvents });
|
|
},
|
|
time: () => 0,
|
|
duration: () => 12,
|
|
add: () => undefined,
|
|
paused: () => undefined,
|
|
set: () => undefined,
|
|
};
|
|
if (withTotalTime) {
|
|
timeline.totalTime = (timeSeconds: number, suppressEvents?: boolean) => {
|
|
calls.push({ method: "totalTime", time: timeSeconds, suppressEvents });
|
|
};
|
|
}
|
|
return { calls, timeline };
|
|
}
|
|
|
|
function createPlayer(timeline: RuntimeTimelineLike) {
|
|
const deterministicSeekCalls: number[] = [];
|
|
const syncMediaCalls: number[] = [];
|
|
const renderFrameSeekCalls: number[] = [];
|
|
const player = createRuntimePlayer({
|
|
getTimeline: () => timeline,
|
|
setTimeline: () => undefined,
|
|
getIsPlaying: () => false,
|
|
setIsPlaying: () => undefined,
|
|
getPlaybackRate: () => 1,
|
|
setPlaybackRate: () => undefined,
|
|
getCanonicalFps: () => 30,
|
|
onSyncMedia: (timeSeconds) => {
|
|
syncMediaCalls.push(timeSeconds);
|
|
},
|
|
onStatePost: () => undefined,
|
|
onDeterministicSeek: (timeSeconds) => {
|
|
deterministicSeekCalls.push(timeSeconds);
|
|
},
|
|
onDeterministicPause: () => undefined,
|
|
onDeterministicPlay: () => undefined,
|
|
onRenderFrameSeek: (timeSeconds) => {
|
|
renderFrameSeekCalls.push(timeSeconds);
|
|
},
|
|
onShowNativeVideos: () => undefined,
|
|
getSafeDuration: () => 12,
|
|
});
|
|
return { player, deterministicSeekCalls, syncMediaCalls, renderFrameSeekCalls };
|
|
}
|
|
|
|
function testSeekUsesDeterministicGsapPath(): void {
|
|
const { calls, timeline } = createTimeline(true);
|
|
const { player, deterministicSeekCalls, syncMediaCalls, renderFrameSeekCalls } =
|
|
createPlayer(timeline);
|
|
const quantizedTime = 2;
|
|
|
|
player.seek(2.017);
|
|
|
|
assert.deepEqual(
|
|
calls,
|
|
[{ method: "pause" }, { method: "totalTime", time: quantizedTime, suppressEvents: false }],
|
|
"player.seek() should use quantized totalTime() when available",
|
|
);
|
|
assert.deepEqual(
|
|
deterministicSeekCalls,
|
|
[quantizedTime],
|
|
"player.seek() should notify adapters with the quantized time",
|
|
);
|
|
assert.deepEqual(syncMediaCalls, [quantizedTime], "media sync should use quantized time");
|
|
assert.deepEqual(
|
|
renderFrameSeekCalls,
|
|
[quantizedTime],
|
|
"render frame seek should use quantized time",
|
|
);
|
|
}
|
|
|
|
function testGsapAdapterPreservesTotalTime(): void {
|
|
const { calls, timeline } = createTimeline(true);
|
|
const adapter = createGsapAdapter({ getTimeline: () => timeline });
|
|
|
|
const seekTime = 2.033333333333333;
|
|
adapter.seek({ time: seekTime });
|
|
|
|
assert.deepEqual(
|
|
calls,
|
|
[
|
|
{ method: "pause" },
|
|
// Nudge to force GSAP 3.x dirty state before the real seek
|
|
{ method: "totalTime", time: seekTime + 0.001, suppressEvents: true },
|
|
{ method: "totalTime", time: seekTime, suppressEvents: false },
|
|
],
|
|
"GSAP adapter should nudge then seek via totalTime() (not downgrade to seek())",
|
|
);
|
|
}
|
|
|
|
function testGsapAdapterFallsBackToSeek(): void {
|
|
const { calls, timeline } = createTimeline(false);
|
|
const adapter = createGsapAdapter({ getTimeline: () => timeline });
|
|
|
|
adapter.seek({ time: 1.5 });
|
|
|
|
assert.deepEqual(
|
|
calls,
|
|
[{ method: "pause" }, { method: "seek", time: 1.5, suppressEvents: false }],
|
|
"GSAP adapter should keep working with timelines that only expose seek()",
|
|
);
|
|
}
|
|
|
|
testSeekUsesDeterministicGsapPath();
|
|
testGsapAdapterPreservesTotalTime();
|
|
testGsapAdapterFallsBackToSeek();
|
|
|
|
console.log(
|
|
JSON.stringify({
|
|
event: "hyperframe_runtime_seek_verified",
|
|
assertions: 3,
|
|
}),
|
|
);
|