fix(engine): real back-pressure in StreamingEncoder.writeFrame (#1372)

writeFrame returned the stdin.write boolean synchronously; when FFmpeg
encoded slower than workers captured, Node's writable buffer grew without
bound (multi-worker worst case ~80GB over a 1h render) until the kernel
OOM-killed the process. writeFrame is now async: a buffered write awaits
the drain event before resolving, so back-pressure propagates through the
frame reorder buffer to the capture loops and in-flight frames stay
bounded. Inactivity-timer semantics are preserved: no reset before drain,
so a hung FFmpeg still trips SIGTERM.

The drain wait races one-shot drain/close listeners (aborted in a
finally) rather than chaining onto the shared exit promise — V8 retains
reaction-list entries on unsettled promises, so per-frame .then chains
would accumulate ~108K closures over a 1h back-pressured render. An
exit-status re-check after listener attachment closes the
close-before-attach hang window. All five writeFrame call sites
(streaming stage and HDR loops) check the result via a shared
ensureFrameWritten guard and stop the render with a frame-indexed error
when the encoder is gone instead of discarding the boolean.

The MULTI_WORKER_MAX_DURATION_SECONDS cap can be relaxed in a follow-up
now that buffering is bounded.

Fixes #1353
This commit is contained in:
Miguel Ángel
2026-06-12 12:21:39 -04:00
committed by GitHub
parent 5917c0382d
commit c609850b41
6 changed files with 247 additions and 31 deletions
@@ -418,6 +418,20 @@ const baseOptions: StreamingEncoderOptions = {
useGpu: false, useGpu: false,
}; };
async function resolveWithin<T>(promise: Promise<T>, ms = 100): Promise<T | "timeout"> {
let timeout: ReturnType<typeof setTimeout> | undefined;
try {
return await Promise.race([
promise,
new Promise<"timeout">((resolve) => {
timeout = setTimeout(() => resolve("timeout"), ms);
}),
]);
} finally {
if (timeout) clearTimeout(timeout);
}
}
describe("spawnStreamingEncoder lifecycle and cleanup", () => { describe("spawnStreamingEncoder lifecycle and cleanup", () => {
afterEach(() => { afterEach(() => {
vi.resetModules(); vi.resetModules();
@@ -556,7 +570,7 @@ describe("spawnStreamingEncoder lifecycle and cleanup", () => {
const dir = mkdtempSync(join(tmpdir(), "se-writefail-")); const dir = mkdtempSync(join(tmpdir(), "se-writefail-"));
const encoder = await spawnStreamingEncoder(join(dir, "out.mp4"), baseOptions); const encoder = await spawnStreamingEncoder(join(dir, "out.mp4"), baseOptions);
expect(encoder.writeFrame(Buffer.from([0]))).toBe(true); expect(await encoder.writeFrame(Buffer.from([0]))).toBe(true);
const proc = calls[0]!.proc; const proc = calls[0]!.proc;
await new Promise<void>((resolve) => { await new Promise<void>((resolve) => {
@@ -566,7 +580,136 @@ describe("spawnStreamingEncoder lifecycle and cleanup", () => {
}); });
}); });
expect(encoder.writeFrame(Buffer.from([0]))).toBe(false); expect(await encoder.writeFrame(Buffer.from([0]))).toBe(false);
});
it("writeFrame waits for stdin drain when FFmpeg applies back-pressure", async () => {
const { spawn, calls } = createSpawnSpy();
vi.resetModules();
vi.doMock("child_process", () => ({ spawn }));
const { spawnStreamingEncoder } = await import("./streamingEncoder.js");
const dir = mkdtempSync(join(tmpdir(), "se-drain-"));
const encoder = await spawnStreamingEncoder(join(dir, "out.mp4"), baseOptions);
const proc = calls[0]!.proc;
proc.stdin.write = (_chunk: Buffer): boolean => false;
const writeResult = encoder.writeFrame(Buffer.from([1])) as unknown;
expect(writeResult).toBeInstanceOf(Promise);
const writePromise = writeResult as Promise<boolean>;
let settled = false;
void writePromise.then(() => {
settled = true;
});
await Promise.resolve();
expect(settled).toBe(false);
expect(proc.stdin.listenerCount("drain")).toBe(1);
proc.stdin.emit("drain");
await expect(writePromise).resolves.toBe(true);
expect(settled).toBe(true);
expect(proc.stdin.listenerCount("drain")).toBe(0);
process.nextTick(() => proc.emit("close", 0));
await encoder.close();
});
it("does not accumulate process close listeners across repeated back-pressured writes", async () => {
const { spawn, calls } = createSpawnSpy();
vi.resetModules();
vi.doMock("child_process", () => ({ spawn }));
const { spawnStreamingEncoder } = await import("./streamingEncoder.js");
const dir = mkdtempSync(join(tmpdir(), "se-drain-listeners-"));
const encoder = await spawnStreamingEncoder(join(dir, "out.mp4"), baseOptions);
const proc = calls[0]!.proc;
const baselineCloseListeners = proc.listenerCount("close");
const baselineDrainListeners = proc.stdin.listenerCount("drain");
proc.stdin.write = (_chunk: Buffer): boolean => false;
for (let i = 0; i < 12; i++) {
const writePromise = encoder.writeFrame(Buffer.from([i]));
await Promise.resolve();
expect(proc.stdin.listenerCount("drain")).toBe(baselineDrainListeners + 1);
expect(proc.listenerCount("close")).toBe(baselineCloseListeners + 1);
proc.stdin.emit("drain");
await expect(writePromise).resolves.toBe(true);
expect(proc.stdin.listenerCount("drain")).toBe(baselineDrainListeners);
expect(proc.listenerCount("close")).toBe(baselineCloseListeners);
}
process.nextTick(() => proc.emit("close", 0));
await encoder.close();
});
it("writeFrame resolves false instead of hanging when FFmpeg exits before drain", async () => {
const { spawn, calls } = createSpawnSpy();
vi.resetModules();
vi.doMock("child_process", () => ({ spawn }));
const { spawnStreamingEncoder } = await import("./streamingEncoder.js");
const dir = mkdtempSync(join(tmpdir(), "se-drain-exit-"));
const encoder = await spawnStreamingEncoder(join(dir, "out.mp4"), baseOptions);
const proc = calls[0]!.proc;
proc.stdin.write = (_chunk: Buffer): boolean => false;
const writeResult = encoder.writeFrame(Buffer.from([1])) as unknown;
expect(writeResult).toBeInstanceOf(Promise);
const writePromise = writeResult as Promise<boolean>;
let settled = false;
void writePromise.then(() => {
settled = true;
});
await Promise.resolve();
expect(settled).toBe(false);
expect(proc.stdin.listenerCount("drain")).toBe(1);
proc.emit("close", 1);
await expect(writePromise).resolves.toBe(false);
expect(settled).toBe(true);
expect(proc.stdin.listenerCount("drain")).toBe(0);
const result = await encoder.close();
expect(result.success).toBe(false);
});
it("writeFrame resolves false when close fires after write returns false before await attaches listeners", async () => {
const { spawn, calls } = createSpawnSpy();
vi.resetModules();
vi.doMock("child_process", () => ({ spawn }));
const { spawnStreamingEncoder } = await import("./streamingEncoder.js");
const dir = mkdtempSync(join(tmpdir(), "se-drain-already-closed-"));
const encoder = await spawnStreamingEncoder(join(dir, "out.mp4"), baseOptions);
const proc = calls[0]!.proc;
const baselineCloseListeners = proc.listenerCount("close");
proc.stdin.write = (_chunk: Buffer): boolean => {
proc.emit("close", 1);
return false;
};
const writePromise = encoder.writeFrame(Buffer.from([1]));
await expect(resolveWithin(writePromise)).resolves.toBe(false);
expect(encoder.getExitStatus()).toBe("error");
expect(proc.stdin.listenerCount("drain")).toBe(0);
expect(proc.listenerCount("close")).toBe(baselineCloseListeners);
const result = await encoder.close();
expect(result.success).toBe(false);
}); });
it("close() removes the abort listener so a post-close abort does not re-kill ffmpeg", async () => { it("close() removes the abort listener so a post-close abort does not re-kill ffmpeg", async () => {
@@ -613,7 +756,7 @@ describe("spawnStreamingEncoder lifecycle and cleanup", () => {
// progressing" capture the encoder must still be alive. The old total- // progressing" capture the encoder must still be alive. The old total-
// render timeout would have fired SIGTERM at ~1000ms. // render timeout would have fired SIGTERM at ~1000ms.
for (let i = 0; i < 9; i++) { for (let i = 0; i < 9; i++) {
encoder.writeFrame(Buffer.from([i])); await encoder.writeFrame(Buffer.from([i]));
vi.advanceTimersByTime(900); vi.advanceTimersByTime(900);
} }
expect(proc.kill).not.toHaveBeenCalled(); expect(proc.kill).not.toHaveBeenCalled();
@@ -647,14 +790,17 @@ describe("spawnStreamingEncoder lifecycle and cleanup", () => {
const proc = calls[0]!.proc; const proc = calls[0]!.proc;
proc.stdin.write = (_chunk: Buffer) => false; proc.stdin.write = (_chunk: Buffer) => false;
// Pump 9 frames at 900ms intervals — all returning false. The reset // A buffered write should remain pending and must NOT reset the timer.
// should NOT fire (every write was buffered, not accepted), so the // The 1000ms timer (last reset on spawn) therefore elapses while the
// 1000ms timer (last reset on spawn) elapses near the start. // caller is correctly back-pressured on the first frame.
for (let i = 0; i < 9; i++) { const writePromise = encoder.writeFrame(Buffer.from([0]));
encoder.writeFrame(Buffer.from([i])); await Promise.resolve();
vi.advanceTimersByTime(900);
} vi.advanceTimersByTime(1100);
expect(proc.kill).toHaveBeenCalledWith("SIGTERM"); expect(proc.kill).toHaveBeenCalledWith("SIGTERM");
proc.emit("close", null);
await expect(writePromise).resolves.toBe(false);
} finally { } finally {
vi.useRealTimers(); vi.useRealTimers();
} }
@@ -10,10 +10,11 @@
* 1. Frame reorder buffer ensures out-of-order parallel workers feed * 1. Frame reorder buffer ensures out-of-order parallel workers feed
* frames to FFmpeg stdin in sequential order. * frames to FFmpeg stdin in sequential order.
* 2. Streaming FFmpeg encoder spawns FFmpeg with `-f image2pipe` and * 2. Streaming FFmpeg encoder spawns FFmpeg with `-f image2pipe` and
* exposes a `writeFrame(buffer)` + `close()` API. * exposes an async `writeFrame(buffer)` + `close()` API.
*/ */
import { spawn, type ChildProcess } from "child_process"; import { spawn, type ChildProcess } from "child_process";
import { once } from "events";
import { trackChildProcess } from "../utils/processTracker.js"; import { trackChildProcess } from "../utils/processTracker.js";
import { existsSync, mkdirSync, statSync } from "fs"; import { existsSync, mkdirSync, statSync } from "fs";
import { dirname } from "path"; import { dirname } from "path";
@@ -126,7 +127,14 @@ export interface StreamingEncoderResult {
} }
export interface StreamingEncoder { export interface StreamingEncoder {
writeFrame: (buffer: Buffer) => boolean; /**
* Write one frame to FFmpeg stdin, awaiting `drain` when the pipe is full
* so back-pressure propagates to the caller. Resolves `false` when FFmpeg
* is already gone. Callers must serialize calls — one in-flight writeFrame
* per encoder (the frame reorder buffer provides this ordering); concurrent
* calls would interleave frame bytes on the pipe and race the drain wait.
*/
writeFrame: (buffer: Buffer) => Promise<boolean>;
close: () => Promise<StreamingEncoderResult>; close: () => Promise<StreamingEncoderResult>;
getExitStatus: () => "running" | "success" | "error"; getExitStatus: () => "running" | "success" | "error";
} }
@@ -448,9 +456,45 @@ export async function spawnStreamingEncoder(
}; };
resetTimer(); resetTimer();
const waitForDrainOrExit = async (
stdin: NonNullable<ChildProcess["stdin"]>,
): Promise<"drain" | "exit"> => {
// Back-pressure can hit once per frame. Do not race `exitPromise.then(...)`
// here: V8 retains `.then` reaction-list entries on an unsettled promise,
// so a one-hour 30fps render under steady back-pressure can accumulate
// ~108K closures + AbortControllers. Use one-shot listeners for this write
// instead, then abort them in finally. `close` is the event that flips
// `exitStatus`; re-check after listener attachment so a close emitted
// between `stdin.write(false)` and this await cannot hang forever.
const abortController = new AbortController();
try {
const drainPromise = once(stdin, "drain", { signal: abortController.signal }).then(
() => "drain" as const,
);
const closePromise = once(ffmpeg, "close", { signal: abortController.signal }).then(
() => "exit" as const,
);
const racePromise = Promise.race([drainPromise, closePromise]).catch((err: unknown) => {
if (err instanceof Error && err.name === "AbortError") {
return "exit" as const;
}
throw err;
});
if (exitStatus !== "running") {
return "exit";
}
return await racePromise;
} finally {
abortController.abort();
}
};
const encoder: StreamingEncoder = { const encoder: StreamingEncoder = {
writeFrame: (buffer: Buffer): boolean => { writeFrame: async (buffer: Buffer): Promise<boolean> => {
if (exitStatus !== "running" || !ffmpeg.stdin || ffmpeg.stdin.destroyed) { const stdin = ffmpeg.stdin;
if (exitStatus !== "running" || !stdin || stdin.destroyed) {
return false; return false;
} }
// Copy the buffer before writing — Node streams hold a reference to the // Copy the buffer before writing — Node streams hold a reference to the
@@ -459,18 +503,28 @@ export async function spawnStreamingEncoder(
// so without this copy the pipe would read partially-overwritten data // so without this copy the pipe would read partially-overwritten data
// and flicker. // and flicker.
const copy = Buffer.from(buffer); const copy = Buffer.from(buffer);
const accepted = ffmpeg.stdin.write(copy); const accepted = stdin.write(copy);
// Reset inactivity timer ONLY on `accepted === true`. `true` means the // Reset inactivity timer immediately ONLY on `accepted === true`. `true`
// write went through to the kernel pipe without buffering in Node — // means the write went through to the kernel pipe without buffering in
// proof FFmpeg is actually consuming. `false` means Node's writable // Node — proof FFmpeg is actually consuming. `false` means Node's writable
// stream had to buffer (FFmpeg hasn't drained the pipe yet); we deliberately // stream had to buffer (FFmpeg hasn't drained the pipe yet); we await
// don't reset on `false` so a hung FFmpeg with a still-producing Chrome // `drain` before letting callers produce the next frame, and only reset
// can't keep us alive forever while Node's stdin buffer grows to OOM. In // after drain proves consumption. We deliberately don't reset before
// steady state with a slower-but-alive FFmpeg, writes alternate between // drain so a hung FFmpeg with a still-producing Chrome can't keep us
// true and false as the buffer drains and refills; the trues are enough // alive forever while Node's stdin buffer grows to OOM. If FFmpeg exits
// to keep the heartbeat ticking. // before draining, waitForDrainOrExit returns "exit", removes its
if (accepted) resetTimer(); // one-shot listeners, and callers see `false` instead of hanging.
return accepted; if (accepted) {
resetTimer();
return true;
}
const drainResult = await waitForDrainOrExit(stdin);
if (drainResult !== "drain" || exitStatus !== "running") {
return false;
}
resetTimer();
return true;
}, },
close: async (): Promise<StreamingEncoderResult> => { close: async (): Promise<StreamingEncoderResult> => {
@@ -301,6 +301,19 @@ export async function captureTransitionFrameOnWorker(
} }
} }
// ─── Streaming-encoder write guard ──────────────────────────────────────────
/**
* Streaming-encoder writes report `false` when FFmpeg is already gone.
* Continuing to capture into a dead encoder wastes the rest of the render,
* so every frame loop stops with a frame-indexed error instead.
*/
export function ensureFrameWritten(frameWritten: boolean, frameIndex: number): void {
if (!frameWritten) {
throw new Error(`Streaming encoder exited before frame ${frameIndex} was written`);
}
}
// ─── HDR video raw-frame cleanup (sequential path only) ──────────────────── // ─── HDR video raw-frame cleanup (sequential path only) ────────────────────
export function cleanupEndedHdrVideos(args: { export function cleanupEndedHdrVideos(args: {
@@ -54,6 +54,7 @@ import {
type LayeredTransitionBuffers, type LayeredTransitionBuffers,
captureTransitionFrameOnWorker, captureTransitionFrameOnWorker,
distributeLayeredHybridFrameRanges, distributeLayeredHybridFrameRanges,
ensureFrameWritten,
partitionTransitionFrames, partitionTransitionFrames,
} from "./captureHdrFrameShared.js"; } from "./captureHdrFrameShared.js";
import { updateJobStatus } from "../shared.js"; import { updateJobStatus } from "../shared.js";
@@ -185,7 +186,7 @@ export async function runHybridLayeredFrameLoop(input: HybridLoopInput): Promise
const writeEncoded = async (frameIdx: number, buf: Buffer): Promise<void> => { const writeEncoded = async (frameIdx: number, buf: Buffer): Promise<void> => {
await reorderBuffer.waitForFrame(frameIdx); await reorderBuffer.waitForFrame(frameIdx);
const writeStart = Date.now(); const writeStart = Date.now();
hdrEncoder.writeFrame(buf); ensureFrameWritten(await hdrEncoder.writeFrame(buf), frameIdx);
addHdrTiming(hdrPerf, "encoderWriteMs", writeStart); addHdrTiming(hdrPerf, "encoderWriteMs", writeStart);
reorderBuffer.advanceTo(frameIdx + 1); reorderBuffer.advanceTo(frameIdx + 1);
framesWritten += 1; framesWritten += 1;
@@ -34,6 +34,7 @@ import { writeFileExclusiveSync } from "../shared.js";
import { import {
captureSceneIntoBuffer, captureSceneIntoBuffer,
cleanupEndedHdrVideos, cleanupEndedHdrVideos,
ensureFrameWritten,
type LayeredTransitionBuffers, type LayeredTransitionBuffers,
} from "./captureHdrFrameShared.js"; } from "./captureHdrFrameShared.js";
import { updateJobStatus } from "../shared.js"; import { updateJobStatus } from "../shared.js";
@@ -189,7 +190,7 @@ export async function runSequentialLayeredFrameLoop(input: SequentialLoopInput):
); );
addHdrTiming(hdrPerf, "transitionCompositeMs", transitionTimingStart); addHdrTiming(hdrPerf, "transitionCompositeMs", transitionTimingStart);
timingStart = Date.now(); timingStart = Date.now();
hdrEncoder.writeFrame(transitionBuffers.output); ensureFrameWritten(await hdrEncoder.writeFrame(transitionBuffers.output), i);
addHdrTiming(hdrPerf, "encoderWriteMs", timingStart); addHdrTiming(hdrPerf, "encoderWriteMs", timingStart);
} else { } else {
if (hdrPerf) hdrPerf.normalFrames += 1; if (hdrPerf) hdrPerf.normalFrames += 1;
@@ -206,7 +207,7 @@ export async function runSequentialLayeredFrameLoop(input: SequentialLoopInput):
); );
} }
timingStart = Date.now(); timingStart = Date.now();
hdrEncoder.writeFrame(normalCanvas); ensureFrameWritten(await hdrEncoder.writeFrame(normalCanvas), i);
addHdrTiming(hdrPerf, "encoderWriteMs", timingStart); addHdrTiming(hdrPerf, "encoderWriteMs", timingStart);
} }
@@ -60,6 +60,7 @@ import type { FileServerHandle } from "../../fileServer.js";
import type { ProducerLogger } from "../../../logger.js"; import type { ProducerLogger } from "../../../logger.js";
import type { ProgressCallback, RenderJob } from "../../renderOrchestrator.js"; import type { ProgressCallback, RenderJob } from "../../renderOrchestrator.js";
import { wrapCaptureStageError } from "../captureStageError.js"; import { wrapCaptureStageError } from "../captureStageError.js";
import { ensureFrameWritten } from "./captureHdrFrameShared.js";
import { updateJobStatus } from "../shared.js"; import { updateJobStatus } from "../shared.js";
/** /**
@@ -195,7 +196,7 @@ export async function runCaptureStreamingStage(
const onFrameBuffer = async (frameIndex: number, buffer: Buffer): Promise<void> => { const onFrameBuffer = async (frameIndex: number, buffer: Buffer): Promise<void> => {
await reorderBuffer.waitForFrame(frameIndex); await reorderBuffer.waitForFrame(frameIndex);
currentEncoder.writeFrame(buffer); ensureFrameWritten(await currentEncoder.writeFrame(buffer), frameIndex);
reorderBuffer.advanceTo(frameIndex + 1); reorderBuffer.advanceTo(frameIndex + 1);
}; };
@@ -263,7 +264,7 @@ export async function runCaptureStreamingStage(
const time = (i * job.config.fps.den) / job.config.fps.num; const time = (i * job.config.fps.den) / job.config.fps.num;
const { buffer } = await captureFrameToBuffer(session, i, time); const { buffer } = await captureFrameToBuffer(session, i, time);
await reorderBuffer.waitForFrame(i); await reorderBuffer.waitForFrame(i);
currentEncoder.writeFrame(buffer); ensureFrameWritten(await currentEncoder.writeFrame(buffer), i);
reorderBuffer.advanceTo(i + 1); reorderBuffer.advanceTo(i + 1);
job.framesRendered = i + 1; job.framesRendered = i + 1;