mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-07 10:06:21 +00:00
Miguel Ángel
6933e8acda
* fix(snapshot): preserve exact requested times * fix(cli): fail video snapshots without FFmpeg * fix(cli): honor navigation timeout in diagnostics * fix(cli): preserve snapshot alpha and create shot dirs
285 lines
12 KiB
TypeScript
285 lines
12 KiB
TypeScript
import { existsSync, mkdtempSync, mkdirSync, writeFileSync } from "node:fs";
|
|
import { tmpdir } from "node:os";
|
|
import { join } from "node:path";
|
|
import { beforeAll, describe, expect, it } from "vitest";
|
|
import { ensureDOMParser } from "../utils/dom.js";
|
|
import { collectShotSelectors, resolveScope, surfaceComposition } from "./keyframes.js";
|
|
import { ensureShotOutputDir } from "./motionShot.js";
|
|
|
|
beforeAll(() => ensureDOMParser());
|
|
|
|
const wrap = (script: string) =>
|
|
`<!doctype html><html><body><div id="root" data-composition-id="main" data-duration="4"><div id="dot" class="clip"></div></div><script>${script}</script></body></html>`;
|
|
|
|
describe("keyframes direct composition scope", () => {
|
|
it("keeps the project root and passes the nested HTML entry to --shot", () => {
|
|
const projectDir = mkdtempSync(join(tmpdir(), "hf-keyframes-target-"));
|
|
const compositionsDir = join(projectDir, "compositions");
|
|
mkdirSync(compositionsDir);
|
|
writeFileSync(join(projectDir, "index.html"), wrap(""));
|
|
const scenePath = join(compositionsDir, "scene.html");
|
|
writeFileSync(scenePath, wrap(""));
|
|
|
|
const scope = resolveScope({ target: scenePath });
|
|
|
|
expect(scope.projectDir).toBe(projectDir);
|
|
expect(scope.entryFile).toBe("compositions/scene.html");
|
|
});
|
|
});
|
|
|
|
describe("keyframes shot output", () => {
|
|
it("creates a missing parent directory before writing --shot", () => {
|
|
const projectDir = mkdtempSync(join(tmpdir(), "hf-keyframes-shot-dir-"));
|
|
const outputDir = join(projectDir, "nested", "proofs");
|
|
ensureShotOutputDir(join(outputDir, "shot.png"));
|
|
expect(existsSync(outputDir)).toBe(true);
|
|
});
|
|
});
|
|
|
|
describe("keyframes multi-stroke traces", () => {
|
|
it("composites ≥2 position strokes on one element into a single trace", () => {
|
|
const html = wrap(`
|
|
const tl = gsap.timeline({ paused: true });
|
|
tl.to("#dot", { keyframes: { "0%": { x: -100, y: -150 }, "100%": { x: 80, y: -120 } }, duration: 1 });
|
|
tl.to("#dot", { keyframes: { "0%": { x: 80, y: 120 }, "100%": { x: 85, y: 140 } }, duration: 1 });
|
|
window.__timelines = [tl];
|
|
`);
|
|
const { traces } = surfaceComposition(html, "index.html", "index.html");
|
|
expect(traces).toHaveLength(1);
|
|
expect(traces[0]!.target).toBe("#dot");
|
|
expect(traces[0]!.strokes).toHaveLength(2);
|
|
});
|
|
|
|
it("treats a 0-duration set() between strokes as a pen-up jump, not a drawn stroke", () => {
|
|
const html = wrap(`
|
|
const tl = gsap.timeline({ paused: true });
|
|
tl.to("#dot", { keyframes: { "0%": { x: 0, y: 0 }, "100%": { x: 100, y: 0 } }, duration: 1 });
|
|
tl.set("#dot", { x: 200, y: 200 });
|
|
tl.to("#dot", { keyframes: { "0%": { x: 200, y: 200 }, "100%": { x: 250, y: 250 } }, duration: 1 });
|
|
window.__timelines = [tl];
|
|
`);
|
|
const { traces } = surfaceComposition(html, "index.html", "index.html");
|
|
expect(traces).toHaveLength(1);
|
|
// two DRAWN strokes; the set() is the pen-up gap and is excluded
|
|
expect(traces[0]!.strokes).toHaveLength(2);
|
|
});
|
|
|
|
it("leaves a single-stroke element untraced (normal per-tween output)", () => {
|
|
const html = wrap(`
|
|
const tl = gsap.timeline({ paused: true });
|
|
tl.to("#dot", { keyframes: { "0%": { x: 0, y: 0 }, "50%": { x: 200, y: -100 }, "100%": { x: 0, y: 0 } }, duration: 3 });
|
|
window.__timelines = [tl];
|
|
`);
|
|
const { traces, tweens } = surfaceComposition(html, "index.html", "index.html");
|
|
expect(traces).toHaveLength(0);
|
|
expect(tweens.length).toBeGreaterThan(0);
|
|
});
|
|
});
|
|
|
|
describe("keyframes composed-ancestor surfacing (nested elements)", () => {
|
|
const nested = (script: string) =>
|
|
`<!doctype html><html><body><div id="root" data-composition-id="main" data-duration="4"><div id="stage"><div id="hero"><div id="core" class="clip"></div></div></div></div><script>${script}</script></body></html>`;
|
|
|
|
it("annotates a child tween with its animated ANCESTOR's motion", () => {
|
|
const html = nested(`
|
|
const tl = gsap.timeline({ paused: true });
|
|
tl.to("#hero", { keyframes: { "0%": { x: -300, y: 0 }, "100%": { x: 300, y: 0 } }, duration: 4 }, 0);
|
|
tl.to("#core", { keyframes: { "0%": { scale: 1 }, "100%": { scale: 1.5 } }, duration: 4 }, 0);
|
|
window.__timelines = [tl];
|
|
`);
|
|
const { tweens } = surfaceComposition(html, "index.html", "index.html");
|
|
const core = tweens.find((t) => t.target === "#core");
|
|
expect(core?.composedWith?.map((a) => a.selector)).toContain("#hero");
|
|
// and the ancestor's path EXTENT is summarised (range, not endpoints — so a
|
|
// closed loop still reveals its travel)
|
|
expect(core?.composedWith?.[0]!.summary).toMatch(/x -300\.\.300/);
|
|
});
|
|
|
|
it("does not annotate when the parent isn't animated", () => {
|
|
const html = nested(`
|
|
const tl = gsap.timeline({ paused: true });
|
|
tl.to("#core", { keyframes: { "0%": { scale: 1 }, "100%": { scale: 1.5 } }, duration: 4 }, 0);
|
|
window.__timelines = [tl];
|
|
`);
|
|
const { tweens } = surfaceComposition(html, "index.html", "index.html");
|
|
expect(tweens.find((t) => t.target === "#core")?.composedWith).toBeUndefined();
|
|
});
|
|
});
|
|
|
|
describe("keyframes runtime surfacing", () => {
|
|
it("surfaces CSS @keyframes and their animated selectors", () => {
|
|
const html = `<!doctype html><html><head><style>
|
|
.dot { animation: rise 1200ms ease-out both; }
|
|
@keyframes rise {
|
|
0% { opacity: 0; transform: translateY(40px); }
|
|
100% { opacity: 1; transform: translateY(0); }
|
|
}
|
|
</style></head><body><div class="dot"></div></body></html>`;
|
|
const { cssKeyframes } = surfaceComposition(html, "index.html", "index.html");
|
|
expect(cssKeyframes).toHaveLength(1);
|
|
expect(cssKeyframes[0]!.name).toBe("rise");
|
|
expect(cssKeyframes[0]!.selectors).toContain(".dot");
|
|
expect(cssKeyframes[0]!.keyframes.map((kf) => kf.selector)).toEqual(["0%", "100%"]);
|
|
});
|
|
|
|
it("does not let a CSS comment before @keyframes leak into the next rule's selector", () => {
|
|
const html = `<!doctype html><html><head><style>
|
|
/* Grain animation */
|
|
@keyframes rise { 0% { opacity: 0; } 100% { opacity: 1; } }
|
|
.dot { animation: rise 1s both; }
|
|
</style></head><body><div class="dot"></div></body></html>`;
|
|
const { cssKeyframes } = surfaceComposition(html, "index.html", "index.html");
|
|
expect(cssKeyframes[0]!.selectors).toEqual([".dot"]);
|
|
});
|
|
|
|
it("surfaces Anime.js calls and explicit HyperFrames registration", () => {
|
|
const html = wrap(`
|
|
const tl = anime.createTimeline({ autoplay: false });
|
|
tl.add(".chip", { translateX: [0, 240], duration: 900 });
|
|
window.__hfAnime = window.__hfAnime || [];
|
|
window.__hfAnime.push(tl);
|
|
`);
|
|
const { anime } = surfaceComposition(html, "index.html", "index.html");
|
|
expect(anime).toHaveLength(1);
|
|
expect(anime[0]!.kind).toBe("timeline");
|
|
expect(anime[0]!.registered).toBe(true);
|
|
expect(anime[0]!.targets).toContain(".chip");
|
|
expect(anime[0]!.durations).toContain(900);
|
|
});
|
|
|
|
it("uses CSS and Anime targets as onion-shot candidates", () => {
|
|
const cssHtml = `<!doctype html><html><head><style>
|
|
.dot { animation: rise 1200ms ease-out both; }
|
|
@keyframes rise {
|
|
0% { transform: translateY(40px); }
|
|
100% { transform: translateY(0); }
|
|
}
|
|
</style></head><body><div class="dot"></div></body></html>`;
|
|
const animeHtml = wrap(`
|
|
const tl = anime.createTimeline({ autoplay: false });
|
|
tl.add(".chip", { translateX: [0, 240], duration: 900 });
|
|
window.__hfAnime = window.__hfAnime || [];
|
|
window.__hfAnime.push(tl);
|
|
`);
|
|
|
|
const selectors = collectShotSelectors([
|
|
surfaceComposition(cssHtml, "css.html", "css.html"),
|
|
surfaceComposition(animeHtml, "anime.html", "anime.html"),
|
|
]).map((item) => item.selector);
|
|
|
|
expect(selectors).toEqual(expect.arrayContaining([".dot", ".chip"]));
|
|
});
|
|
});
|
|
|
|
describe("keyframes template-wrapped sub-compositions", () => {
|
|
// Sub-compositions are REQUIRED to put markup + script + style inside <template>.
|
|
// Template content is an inert DocumentFragment that document-level
|
|
// querySelectorAll does not traverse, so extraction must walk template.content
|
|
// too — otherwise every spec-conformant sub-composition surfaces zero motion.
|
|
const templateWrapped = `<template>
|
|
<style>
|
|
#hero { opacity: 0; }
|
|
@keyframes rise {
|
|
0% { transform: translateY(40px); }
|
|
100% { transform: translateY(0); }
|
|
}
|
|
</style>
|
|
<div id="root" data-composition-id="beat" data-duration="4">
|
|
<div id="hero" class="clip"></div>
|
|
</div>
|
|
<script>
|
|
const tl = gsap.timeline({ paused: true });
|
|
tl.fromTo("#hero", { y: 34, opacity: 0 }, { y: 0, opacity: 1, duration: 0.75 }, 0.5);
|
|
window.__timelines = { beat: tl };
|
|
</script>
|
|
</template>`;
|
|
|
|
it("surfaces GSAP tweens from a script inside <template>", () => {
|
|
const { tweens } = surfaceComposition(templateWrapped, "beat.html", "beat.html");
|
|
expect(tweens).toHaveLength(1);
|
|
expect(tweens[0]!.target).toBe("#hero");
|
|
});
|
|
|
|
it("surfaces @keyframes from a style inside <template>", () => {
|
|
const { cssKeyframes } = surfaceComposition(templateWrapped, "beat.html", "beat.html");
|
|
expect(cssKeyframes.map((k) => k.name)).toContain("rise");
|
|
});
|
|
|
|
it("aggregates extraction across multiple <template> blocks in one document", () => {
|
|
// Pins the every-template-fragment walk: styles from BOTH templates must
|
|
// surface, and a script in a NON-FIRST template must surface. (Two GSAP
|
|
// timelines in one file is a separate parser limitation — the static parser
|
|
// follows a single __timelines registration — so scripts are split so that
|
|
// the tween lives in the second template.)
|
|
const twoTemplates = `<template>
|
|
<style>
|
|
@keyframes rise { 0% { opacity: 0; } 100% { opacity: 1; } }
|
|
</style>
|
|
<div id="a" class="clip"></div>
|
|
</template>
|
|
<template>
|
|
<style>
|
|
@keyframes spin { 0% { transform: rotate(0); } 100% { transform: rotate(360deg); } }
|
|
</style>
|
|
<div id="b" class="clip"></div>
|
|
<script>
|
|
const tl = gsap.timeline({ paused: true });
|
|
tl.to("#b", { y: 50, duration: 1 });
|
|
window.__timelines = { multi: tl };
|
|
</script>
|
|
</template>`;
|
|
const { tweens, cssKeyframes } = surfaceComposition(twoTemplates, "multi.html", "multi.html");
|
|
expect(cssKeyframes.map((k) => k.name)).toEqual(expect.arrayContaining(["rise", "spin"]));
|
|
expect(tweens.map((t) => t.target)).toContain("#b");
|
|
});
|
|
|
|
it("reaches a <template> nested inside another template's fragment", () => {
|
|
const nested = `<template>
|
|
<div id="outer" class="clip"></div>
|
|
<template>
|
|
<style>
|
|
@keyframes inner-spin { 0% { transform: rotate(0); } 100% { transform: rotate(360deg); } }
|
|
</style>
|
|
<div id="inner" class="clip"></div>
|
|
<script>
|
|
const tl = gsap.timeline({ paused: true });
|
|
tl.to("#inner", { rotation: 360, duration: 1 });
|
|
window.__timelines = { nested: tl };
|
|
</script>
|
|
</template>
|
|
</template>`;
|
|
const { tweens, cssKeyframes } = surfaceComposition(nested, "nested.html", "nested.html");
|
|
expect(tweens.map((t) => t.target)).toContain("#inner");
|
|
expect(cssKeyframes.map((k) => k.name)).toContain("inner-spin");
|
|
});
|
|
|
|
it("parses mixed top-level + template scripts (join is not source order)", () => {
|
|
// A top-level script precedes the template script in the joined text even
|
|
// though extraction order differs from source order — the join must still
|
|
// parse and the template timeline must still surface.
|
|
const mixed = `<!doctype html><html><body>
|
|
<script>const themeUtil = { accent: "#7c3aed" };</script>
|
|
<template>
|
|
<div id="hero" class="clip"></div>
|
|
<script>
|
|
const tl = gsap.timeline({ paused: true });
|
|
tl.to("#hero", { x: 120, duration: 1 });
|
|
window.__timelines = { mixed: tl };
|
|
</script>
|
|
</template>
|
|
</body></html>`;
|
|
const { tweens } = surfaceComposition(mixed, "mixed.html", "mixed.html");
|
|
expect(tweens.map((t) => t.target)).toContain("#hero");
|
|
});
|
|
|
|
it("still surfaces top-level scripts outside any template", () => {
|
|
const topLevel = `<!doctype html><html><body><div id="dot" class="clip"></div><script>
|
|
const tl = gsap.timeline({ paused: true });
|
|
tl.to("#dot", { x: 100, duration: 1 });
|
|
window.__timelines = [tl];
|
|
</script></body></html>`;
|
|
const { tweens } = surfaceComposition(topLevel, "index.html", "index.html");
|
|
expect(tweens.length).toBeGreaterThan(0);
|
|
});
|
|
});
|