Skip to content

Commit db8ee7a

Browse files
committed
fix(core): a composition behind a wrapper takes its host's start
Fixes #4334.
1 parent dc56b3d commit db8ee7a

4 files changed

Lines changed: 129 additions & 8 deletions

File tree

‎packages/core/src/runtime/startResolver.test.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,39 @@ describe("createRuntimeStartTimeResolver", () => {
212212
expect(resolver.resolveStartForElement(wrapper)).toBe(4.619);
213213
});
214214

215+
describe.each([
216+
['data-composition-src="child.html"'],
217+
['data-composition-id="host"'],
218+
['data-composition-file="compositions/child.html"'],
219+
])("an inner root under a %s host", (marker) => {
220+
it.each([0, 1, 2])("takes the host's start through %i neutral wrappers", (wrappers) => {
221+
const open = "<section>".repeat(wrappers);
222+
const close = "</section>".repeat(wrappers);
223+
document.body.innerHTML = `
224+
<div data-composition-id="root" data-start="0">
225+
<div ${marker} data-start="5">
226+
${open}<div id="inner" data-composition-id="child"></div>${close}
227+
</div>
228+
</div>`;
229+
const inner = document.getElementById("inner")!;
230+
expect(createRuntimeStartTimeResolver({}).resolveStartForElement(inner)).toBe(5);
231+
});
232+
});
233+
234+
it("takes the nearest host, not an outer one, across a wrapper", () => {
235+
document.body.innerHTML = `
236+
<div data-composition-src="outer.html" data-start="2">
237+
<div data-composition-id="outer">
238+
<div data-composition-src="inner.html" data-start="3">
239+
<canvas><div id="inner" data-composition-id="inner"></div></canvas>
240+
</div>
241+
</div>
242+
</div>`;
243+
const inner = document.getElementById("inner")!;
244+
// The inner host's 3 s is local to the outer composition, which starts at 2 s.
245+
expect(createRuntimeStartTimeResolver({}).resolveStartForElement(inner)).toBe(5);
246+
});
247+
215248
it("keeps nested references in the host composition timeline", () => {
216249
const host = document.createElement("div");
217250
host.id = "slide-5";

‎packages/core/src/runtime/startResolver.ts‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,18 +109,17 @@ export function createRuntimeStartTimeResolver(params: {
109109
return resolved;
110110
};
111111

112+
const COMPOSITION_HOST_SELECTOR =
113+
"[data-composition-src], [data-composition-id], [data-composition-file]";
112114
const isCompositionHost = (element: Element): boolean =>
113-
element.hasAttribute("data-composition-src") ||
114-
element.hasAttribute("data-composition-id") ||
115-
element.hasAttribute("data-composition-file");
115+
element.matches(COMPOSITION_HOST_SELECTOR);
116116

117-
// A mounted composition root without its own `data-start` takes its timing from the host it was
118-
// loaded into: the host may use a different id than the file, or none (an anonymous host).
117+
// A mounted composition root without its own `data-start` takes its timing from the nearest host
118+
// above it, past any neutral wrapper; the host may use another id than the file, or none.
119119
const inheritedTimingHost = (element: Element): Element | null => {
120-
const parent = element.parentElement;
121-
if (!parent || !element.hasAttribute("data-composition-id")) return null;
120+
if (!element.hasAttribute("data-composition-id")) return null;
122121
if (parseStartExpression(element.getAttribute("data-start"))) return null;
123-
return isCompositionHost(parent) ? parent : null;
122+
return element.parentElement?.closest(COMPOSITION_HOST_SELECTOR) ?? null;
124123
};
125124

126125
const resolveCompositionOrigin = (compositionRoot: Element, fallback: number): number =>

‎packages/producer/scripts/test-classification.mjs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ const INTEGRATION_TEST_FILES = new Set([
3737
"src/services/render/motionBlurVideo.integration.test.ts",
3838
"src/services/render/renderCancel.integration.test.ts",
3939
"src/services/render/segmentedColorGrading.integration.test.ts",
40+
"src/services/render/wrappedMountTiming.integration.test.ts",
4041
"src/services/render/stages/compileStage.mediaType.test.ts",
4142
"src/services/render/stages/encodeWhileCapturing.test.ts",
4243
"src/services/render/stages/gifEncodeArgs.test.ts",
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
// A composition nested in a timed scene through a neutral wrapper plays on the scene's clock, not
2+
// the root's (#4334). Needs Chrome + ffmpeg: integration lane.
3+
4+
import { copyFileSync, mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
5+
import { tmpdir } from "node:os";
6+
import { join, resolve } from "node:path";
7+
import { afterAll, beforeAll, describe, expect, it } from "vitest";
8+
import { resolveConfig } from "@hyperframes/engine";
9+
import { createRenderJob, executeRenderJob } from "../renderOrchestrator.js";
10+
import { HAS_FFMPEG, frameLevels } from "./frameLevelsTestFixtures.js";
11+
12+
const WIDTH = 160;
13+
const HEIGHT = 90;
14+
const FPS = 30;
15+
16+
// The scene starts at 1 s; the inner composition fades its box in over its own first second.
17+
const INDEX = `<!DOCTYPE html>
18+
<html lang="en">
19+
<head>
20+
<meta charset="UTF-8" />
21+
<script src="assets/gsap.min.js"></script>
22+
<style>
23+
* { margin: 0; padding: 0; } body { overflow: hidden; background: #000; }
24+
#inner, #box { position: absolute; inset: 0; }
25+
#box { background: #fff; opacity: 0; }
26+
</style>
27+
</head>
28+
<body>
29+
<div id="root" data-composition-id="main" data-start="0" data-duration="2"
30+
data-width="${WIDTH}" data-height="${HEIGHT}" data-fps="${FPS}">
31+
<div id="scene" data-composition-id="scene" data-start="1" data-duration="1" data-track-index="0"
32+
data-width="${WIDTH}" data-height="${HEIGHT}">
33+
<section>
34+
<div id="inner" data-composition-id="inner" data-duration="1"
35+
data-width="${WIDTH}" data-height="${HEIGHT}"><div id="box"></div></div>
36+
</section>
37+
</div>
38+
</div>
39+
<script>
40+
window.__timelines["main"] = gsap.timeline({ paused: true });
41+
window.__timelines["scene"] = gsap.timeline({ paused: true }).set({}, {}, 1);
42+
window.__timelines["inner"] = gsap
43+
.timeline({ paused: true })
44+
.to("#box", { opacity: 1, duration: 1, ease: "none" });
45+
</script>
46+
</body>
47+
</html>
48+
`;
49+
50+
let root: string;
51+
52+
describe.skipIf(!HAS_FFMPEG)("a composition behind a wrapper — real render (#4334)", () => {
53+
let levels: number[];
54+
55+
beforeAll(async () => {
56+
root = mkdtempSync(join(tmpdir(), "hf-wrapped-mount-"));
57+
mkdirSync(join(root, "assets"), { recursive: true });
58+
copyFileSync(
59+
resolve(import.meta.dirname, "../../../../core/node_modules/gsap/dist/gsap.min.js"),
60+
join(root, "assets/gsap.min.js"),
61+
);
62+
writeFileSync(join(root, "index.html"), INDEX);
63+
const job = createRenderJob({
64+
fps: FPS,
65+
quality: "draft",
66+
format: "mp4",
67+
hdrMode: "force-sdr",
68+
workers: 1,
69+
producerConfig: resolveConfig({ browserGpuMode: "software" }),
70+
});
71+
const output = join(root, "out.mp4");
72+
await executeRenderJob(job, root, output);
73+
levels = frameLevels(output, WIDTH, HEIGHT);
74+
}, 120_000);
75+
76+
afterAll(() => {
77+
if (root) rmSync(root, { recursive: true, force: true });
78+
});
79+
80+
it("fades the box in over the scene's second, not the root's first", () => {
81+
expect(levels).toHaveLength(2 * FPS);
82+
expect(levels[Math.round(0.5 * FPS)]!).toBeLessThan(5);
83+
// Half way through the scene the box is half faded in (about 128 of 255).
84+
expect(levels[Math.round(1.5 * FPS)]!).toBeGreaterThan(90);
85+
expect(levels[Math.round(1.5 * FPS)]!).toBeLessThan(165);
86+
expect(levels[Math.round(1.25 * FPS)]!).toBeLessThan(levels[Math.round(1.75 * FPS)]!);
87+
});
88+
});

0 commit comments

Comments
 (0)