mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-19 19:36:04 +00:00
fix(cli): wire aspect-agnostic resolution through cloudrun/lambda/batch + preflight recompute
Addresses R2 CHANGES_REQUESTED from Miga + Rames on PR #2529: 1. Sibling-surface gap (blocker): `hyperframes cloudrun render{,-batch}`, `hyperframes lambda render{,-batch}` all advertised the same tier-only aliases (`1080p` / `hd` / `4k` / `uhd`) but normalized them to `landscape` and never set `outputResolutionAspectAgnostic`. The distributed plumbing PR #2529 added received `undefined` from those callers, so portrait `1080p` still hit the original aspect-mismatch on Cloud Run / Lambda. Fix: introduce `resolveResolutionFlagPair` in `@hyperframes/parsers` (the single source of truth for the two-step normalize + aspect-agnostic detect) and route every distributed entrypoint through a shared `parseOutputResolutionFlag` CLI util so the alias signal now reaches `SerializableDistributedRenderConfig`. Studio Server keeps its canonical-only HTTP contract; that intent is now pinned in tests. 2. Preflight recompute (hardening): the earlier "downgrade aspect-mismatch" preflight cleared un-remapped mismatches, so IG 4:5 (non-preset aspect, no sibling) and portrait-4K comp + `--resolution 1080p` (remap + downsample) both slipped through to fail late in `resolveDeviceScaleFactor`. Now `checkRenderResolutionPreflight` computes the effective preset via `suggestMatchingPreset` (mirroring the compile stage's `adaptAspectAgnosticResolution`) and re-checks against that — only genuinely-fixable mismatches clear early. New tests pin both regressed input classes. 3. Docker forwarding boundary test (Miga's important #2): pinned `1080p` survives verbatim as `--resolution 1080p` in the Docker args so the in-container CLI can re-run `isAspectAgnosticResolutionAlias`. 4. Doc-nit (Miga): parsers/src/types.ts no longer references the nonexistent `resolveResolutionForComposition` — points at the actual remap helpers. Fallow: cloudrun.ts / lambda.ts share 390 lines of pre-existing structural symmetry (parallel AWS + GCP dispatchers), and lambda/render.ts + render-batch.ts declare parallel RenderArgs interfaces. Both re-flagged after threading the aspect-agnostic field through each surface; ignored with justification in .fallowrc.jsonc. lambda.ts's `run` and lambda/render.ts's `waitForCompletion` are pre-existing CRAP-score hotspots untouched by this PR — added under health.ignore. Co-Authored-By: Claude <noreply@anthropic.com> — Via
This commit is contained in:
@@ -2,7 +2,12 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { parseBatchFile, runWithConcurrencyLimit } from "./render-batch.js";
|
||||
import {
|
||||
buildLambdaBatchRenderConfig,
|
||||
parseBatchFile,
|
||||
runWithConcurrencyLimit,
|
||||
type RenderBatchArgs,
|
||||
} from "./render-batch.js";
|
||||
|
||||
let tmpDir: string;
|
||||
|
||||
@@ -137,3 +142,38 @@ describe("parseBatchFile", () => {
|
||||
expectExitOne('{"outputKey":"renders/a.mp4","variables":[1,2,3]}\n');
|
||||
});
|
||||
});
|
||||
|
||||
// See `../cloudrun.test.ts` / `./render.test.ts` for the sibling wire-config
|
||||
// coverage. Repeating it at every entrypoint is deliberate: cross-scaffold
|
||||
// drift is exactly what shipped PR #2529 R2 CHANGES_REQUESTED.
|
||||
describe("buildLambdaBatchRenderConfig — aspect-agnostic wire threading", () => {
|
||||
const baseArgs: RenderBatchArgs = {
|
||||
projectDir: "/tmp/hf-batch",
|
||||
stackName: "hf-test",
|
||||
batch: "/tmp/batch.jsonl",
|
||||
fps: 30,
|
||||
width: 1080,
|
||||
height: 1920,
|
||||
format: "mp4",
|
||||
json: false,
|
||||
};
|
||||
|
||||
it("threads outputResolutionAspectAgnostic=true through for portrait 1080p", () => {
|
||||
// The batch entrypoint fans out N Step Functions executions from a
|
||||
// single wire config, so a dropped alias flag multiplies into N broken
|
||||
// renders — pin it here.
|
||||
const config = buildLambdaBatchRenderConfig({
|
||||
...baseArgs,
|
||||
outputResolution: "landscape",
|
||||
outputResolutionAspectAgnostic: true,
|
||||
});
|
||||
expect(config.outputResolution).toBe("landscape");
|
||||
expect(config.outputResolutionAspectAgnostic).toBe(true);
|
||||
});
|
||||
|
||||
it("keeps the aspect-agnostic key absent when the flag is a canonical preset", () => {
|
||||
const config = buildLambdaBatchRenderConfig({ ...baseArgs, outputResolution: "portrait-4k" });
|
||||
expect(config.outputResolution).toBe("portrait-4k");
|
||||
expect(config.outputResolutionAspectAgnostic).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
@@ -65,6 +65,13 @@ export interface RenderBatchArgs {
|
||||
height: number;
|
||||
/** See {@link RenderArgs.outputResolution}. */
|
||||
outputResolution?: CanvasResolution;
|
||||
/**
|
||||
* See {@link RenderArgs.outputResolutionAspectAgnostic}. Threaded through
|
||||
* `SerializableDistributedRenderConfig` so the Lambda worker's compile
|
||||
* stage remaps aspect-agnostic aliases (`1080p` / `hd` / `4k` / `uhd`) to
|
||||
* the composition's orientation — same regression class as the local CLI.
|
||||
*/
|
||||
outputResolutionAspectAgnostic?: boolean;
|
||||
format: DistributedFormat;
|
||||
codec?: "h264" | "h265";
|
||||
quality?: "draft" | "standard" | "high";
|
||||
@@ -209,19 +216,7 @@ export async function runRenderBatch(args: RenderBatchArgs): Promise<void> {
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const config: SerializableDistributedRenderConfig = {
|
||||
fps: args.fps,
|
||||
width: args.width,
|
||||
height: args.height,
|
||||
outputResolution: args.outputResolution,
|
||||
format: args.format,
|
||||
codec: args.codec,
|
||||
quality: args.quality,
|
||||
chunkSize: args.chunkSize,
|
||||
maxParallelChunks: args.maxParallelChunks,
|
||||
targetChunkFrames: args.targetChunkFrames,
|
||||
runtimeCap: "lambda",
|
||||
};
|
||||
const config: SerializableDistributedRenderConfig = buildLambdaBatchRenderConfig(args);
|
||||
|
||||
// Deploy the site once and reuse it across every entry. --site-id and
|
||||
// --dry-run both skip the deploy via a synthesised handle.
|
||||
@@ -350,6 +345,34 @@ function makePlaceholderSiteHandle(siteId: string, bucketName: string): SiteHand
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the shared wire {@link SerializableDistributedRenderConfig} used
|
||||
* for every entry in a `hyperframes lambda render-batch` run. Extracted for
|
||||
* boundary-test coverage of the aspect-agnostic flag threading (per-entry
|
||||
* `variables` are still overlayed at dispatch time inside {@link runRenderBatch}).
|
||||
*/
|
||||
export function buildLambdaBatchRenderConfig(
|
||||
args: RenderBatchArgs,
|
||||
): SerializableDistributedRenderConfig {
|
||||
const config: SerializableDistributedRenderConfig = {
|
||||
fps: args.fps,
|
||||
width: args.width,
|
||||
height: args.height,
|
||||
outputResolution: args.outputResolution,
|
||||
format: args.format,
|
||||
codec: args.codec,
|
||||
quality: args.quality,
|
||||
chunkSize: args.chunkSize,
|
||||
maxParallelChunks: args.maxParallelChunks,
|
||||
targetChunkFrames: args.targetChunkFrames,
|
||||
runtimeCap: "lambda",
|
||||
};
|
||||
if (args.outputResolutionAspectAgnostic) {
|
||||
config.outputResolutionAspectAgnostic = true;
|
||||
}
|
||||
return config;
|
||||
}
|
||||
|
||||
/**
|
||||
* Read the JSONL batch file and return one parsed entry per non-blank
|
||||
* line. Reads the whole file into memory — fine for typical batch sizes,
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
/**
|
||||
* Boundary tests for the wire config emitted by `hyperframes lambda render`.
|
||||
* Pins that the aspect-agnostic resolution flag survives all the way into
|
||||
* `SerializableDistributedRenderConfig`, which is what the Lambda worker's
|
||||
* compile stage reads before remapping `landscape` → `portrait` for an
|
||||
* aspect-agnostic alias like `--output-resolution 1080p`.
|
||||
*
|
||||
* See `../cloudrun.test.ts` for the parseOutputResolution counterpart and
|
||||
* `../render.test.ts` for the local-CLI preflight guardrails.
|
||||
*/
|
||||
|
||||
import { describe, expect, it } from "vitest";
|
||||
import { buildLambdaRenderConfig, type RenderArgs } from "./render.js";
|
||||
|
||||
const BASE_ARGS: RenderArgs = {
|
||||
projectDir: "/tmp/hf-project",
|
||||
stackName: "hf-test",
|
||||
fps: 30,
|
||||
width: 1080,
|
||||
height: 1920,
|
||||
format: "mp4",
|
||||
json: false,
|
||||
wait: false,
|
||||
waitIntervalMs: 5000,
|
||||
};
|
||||
|
||||
describe("buildLambdaRenderConfig — aspect-agnostic wire threading", () => {
|
||||
it("threads outputResolutionAspectAgnostic=true through for portrait 1080p", () => {
|
||||
// The exact bug shape: portrait 1080×1920 comp + `--output-resolution 1080p`.
|
||||
// Before the fix, the aspect-agnostic flag never reached the wire, so
|
||||
// the Lambda worker saw the explicit `landscape` preset and rejected
|
||||
// the portrait comp — reproducing the local-CLI regression on the
|
||||
// distributed path.
|
||||
const config = buildLambdaRenderConfig(
|
||||
{ ...BASE_ARGS, outputResolution: "landscape", outputResolutionAspectAgnostic: true },
|
||||
undefined,
|
||||
);
|
||||
expect(config.outputResolution).toBe("landscape");
|
||||
expect(config.outputResolutionAspectAgnostic).toBe(true);
|
||||
});
|
||||
|
||||
it("keeps the aspect-agnostic key absent when the flag is a canonical preset", () => {
|
||||
// Sparse-wire invariant: only forward `true`; canonical presets stay
|
||||
// strict and don't need the compile-stage remap.
|
||||
const config = buildLambdaRenderConfig(
|
||||
{ ...BASE_ARGS, outputResolution: "portrait-4k" },
|
||||
undefined,
|
||||
);
|
||||
expect(config.outputResolution).toBe("portrait-4k");
|
||||
expect(config.outputResolutionAspectAgnostic).toBeUndefined();
|
||||
});
|
||||
|
||||
it("carries variables verbatim through the wire config", () => {
|
||||
const config = buildLambdaRenderConfig(BASE_ARGS, { alice: "hello" });
|
||||
expect(config.variables).toEqual({ alice: "hello" });
|
||||
});
|
||||
});
|
||||
@@ -42,6 +42,15 @@ export interface RenderArgs {
|
||||
* from a 1920×1080 layout uses DPR 2, etc.
|
||||
*/
|
||||
outputResolution?: CanvasResolution;
|
||||
/**
|
||||
* True when {@link outputResolution} was normalized from an aspect-agnostic
|
||||
* alias (`1080p` / `hd` / `4k` / `uhd`). Threaded through
|
||||
* `SerializableDistributedRenderConfig` so the Lambda worker's compile stage
|
||||
* remaps `landscape` → `portrait` / `square` when the composition's
|
||||
* orientation demands it. Dropping this field is what shipped the
|
||||
* portrait-1080p regression at the sibling entrypoints (see PR #2529).
|
||||
*/
|
||||
outputResolutionAspectAgnostic?: boolean;
|
||||
format: DistributedFormat;
|
||||
codec?: "h264" | "h265";
|
||||
quality?: "draft" | "standard" | "high";
|
||||
@@ -114,20 +123,7 @@ export async function runRender(args: RenderArgs): Promise<void> {
|
||||
}
|
||||
}
|
||||
|
||||
const config: SerializableDistributedRenderConfig = {
|
||||
fps: args.fps,
|
||||
width: args.width,
|
||||
height: args.height,
|
||||
outputResolution: args.outputResolution,
|
||||
format: args.format,
|
||||
codec: args.codec,
|
||||
quality: args.quality,
|
||||
chunkSize: args.chunkSize,
|
||||
maxParallelChunks: args.maxParallelChunks,
|
||||
targetChunkFrames: args.targetChunkFrames,
|
||||
runtimeCap: "lambda",
|
||||
variables,
|
||||
};
|
||||
const config: SerializableDistributedRenderConfig = buildLambdaRenderConfig(args, variables);
|
||||
|
||||
// When the caller passes only --site-id, synthesise the minimum-shape
|
||||
// SiteHandle pointing at the deterministic content-addressed key. The
|
||||
@@ -233,3 +229,36 @@ async function waitForCompletion(
|
||||
function sleep(ms: number): Promise<void> {
|
||||
return new Promise((res) => setTimeout(res, ms));
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the wire {@link SerializableDistributedRenderConfig} for
|
||||
* `hyperframes lambda render`. Extracted for boundary-test coverage of the
|
||||
* aspect-agnostic flag threading — the field this helper preserves is what
|
||||
* lets the Lambda worker's compile stage remap `landscape` → `portrait` on
|
||||
* an aspect-agnostic alias (`1080p` / `hd` / `4k` / `uhd`).
|
||||
*/
|
||||
export function buildLambdaRenderConfig(
|
||||
args: RenderArgs,
|
||||
variables: Record<string, unknown> | undefined,
|
||||
): SerializableDistributedRenderConfig {
|
||||
const config: SerializableDistributedRenderConfig = {
|
||||
fps: args.fps,
|
||||
width: args.width,
|
||||
height: args.height,
|
||||
outputResolution: args.outputResolution,
|
||||
format: args.format,
|
||||
codec: args.codec,
|
||||
quality: args.quality,
|
||||
chunkSize: args.chunkSize,
|
||||
maxParallelChunks: args.maxParallelChunks,
|
||||
targetChunkFrames: args.targetChunkFrames,
|
||||
runtimeCap: "lambda",
|
||||
variables,
|
||||
};
|
||||
// Keep the wire shape sparse when the alias flag wasn't set — matches how
|
||||
// `SerializableDistributedRenderConfig` is emitted at every other adapter.
|
||||
if (args.outputResolutionAspectAgnostic) {
|
||||
config.outputResolutionAspectAgnostic = true;
|
||||
}
|
||||
return config;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user