Files
hyperframes/packages/cli/src/commands/render/sourceFailureHint.ts
T
wonjangandClaude Fable 5.2 72cb2bd9b6 fix(cli): a render that failed on a video file says to check the file, not to try Docker (#8083)
The generic "Try --docker for containerized rendering" hint was printed
under every failed render. When the failure is a video source FFmpeg could
not read, a missing file or a 404 URL, a container reads the same source
and fails the same way. Those three now get a hint about the file.

Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-18 16:11:41 +00:00

34 lines
1.5 KiB
TypeScript

/**
* What to do when the render stopped on a video source it could not use. The generic hint is
* "Try --docker", which cannot help: a container reads the same file.
*/
const SOURCE_HINTS: Readonly<Record<string, string>> = {
invalid_media:
"FFmpeg could not read the file as a video. Check it with `ffprobe <file>`: a file that is still being written, or was cut short, fails this way. Render again once it is complete.",
source_missing:
"The video file is not there. Check the `src` of the <video> against the project folder.",
download_not_found:
"The video URL answered 404 or 410. Check the `src` of the <video>, or download the file into the project.",
};
function failureKinds(error: unknown): string[] | null {
let seen: unknown = error;
for (let depth = 0; depth < 5 && seen instanceof Error; depth++) {
const { code, failures } = seen as { code?: unknown; failures?: unknown };
if (code === "VIDEO_SOURCE_UNRENDERABLE" && Array.isArray(failures)) {
return failures.map((failure: { kind?: unknown }) => String(failure?.kind));
}
seen = seen.cause;
}
return null;
}
/** The hint for a source failure, or null when the failure is not one this can explain. */
export function sourceFailureHint(error: unknown): string | null {
const kinds = failureKinds(error);
if (!kinds || kinds.length === 0) return null;
const hints = [...new Set(kinds.map((kind) => SOURCE_HINTS[kind]))];
if (hints.some((hint) => hint === undefined)) return null;
return hints.join(" ");
}