Files
hyperframes/packages/core/src/runtime/captionOverrides.test.ts
T
Vance Ingalls 8d83d4f132 fix: make caption overrides refresh-safe (#609)
## Summary

This stacked PR makes caption overrides refresh-safe.

Caption edits are still saved to `caption-overrides.json`, but override targets are now stable across preview refreshes and regenerated caption HTML.

## Architecture

- **Stable word identity**: generated caption HTML preserves optional transcript word IDs in the `TRANSCRIPT` array and emits those IDs on word spans.
- **Parser continuity**: the caption parser preserves existing transcript word `id` fields instead of regenerating index-only identity.
- **Override loading**: Studio loads saved overrides by `wordId` first, with the existing `wordIndex` fallback kept for older overrides.
- **Idempotent runtime wrapping**: transform overrides reuse an existing `data-caption-wrapper="true"` wrapper instead of nesting wrappers on every refresh.
- **Animation compatibility**: overrides still wrap the word so inner word-level GSAP animation can continue to target the original span.

## User Impact

Users can edit caption word position, scale, rotation, color, opacity, font size, font weight, and font family, then refresh without overrides drifting to the wrong word or accumulating nested wrappers.

## Main Files

- `packages/core/src/runtime/captionOverrides.ts`
- `packages/studio/src/captions/generator.ts`
- `packages/studio/src/captions/parser.ts`
- `packages/studio/src/captions/hooks/useCaptionSync.ts`

## Test Plan

```bash
volta run --node 22.20.0 bun run --filter @hyperframes/core test -- src/runtime/captionOverrides.test.ts
volta run --node 22.20.0 packages/studio/node_modules/.bin/vitest run --root packages/studio --config /dev/null src/captions/parser.test.ts src/captions/generator.test.ts
volta run --node 22.20.0 bun run --filter @hyperframes/core typecheck
volta run --node 22.20.0 bun run --filter @hyperframes/studio typecheck
volta run --node 22.20.0 bunx oxlint <changed files>
volta run --node 22.20.0 bunx oxfmt --check <changed files>
git diff --check
```
2026-05-03 23:29:16 -07:00

125 lines
3.7 KiB
TypeScript

// @vitest-environment jsdom
import { afterEach, describe, expect, it, vi } from "vitest";
import { applyCaptionOverrides } from "./captionOverrides";
function installCaptionOverrideFetch(overrides: unknown[]) {
vi.stubGlobal("fetch", async () => ({
ok: true,
async json() {
return overrides;
},
}));
}
function installGsapMock() {
const setCalls: Array<{ target: Element; vars: Record<string, unknown> }> = [];
const gsap = {
set(target: Element, vars: Record<string, unknown>) {
setCalls.push({ target, vars });
for (const [key, value] of Object.entries(vars)) {
if (key === "fontSize" && typeof value === "string" && target instanceof HTMLElement) {
target.style.fontSize = value;
}
}
},
killTweensOf() {},
getTweensOf() {
return [];
},
};
Object.defineProperty(window, "gsap", {
configurable: true,
value: gsap,
});
return { setCalls };
}
async function flushCaptionOverrides() {
for (let i = 0; i < 4; i++) {
await Promise.resolve();
}
}
afterEach(() => {
vi.unstubAllGlobals();
document.body.innerHTML = "";
Reflect.deleteProperty(window, "gsap");
});
describe("applyCaptionOverrides", () => {
it("reuses existing caption wrappers when overrides are applied more than once", async () => {
const { setCalls } = installGsapMock();
installCaptionOverrideFetch([{ wordIndex: 0, x: 12, y: -4, scale: 1.2 }]);
document.body.innerHTML = `
<div class="caption-group">
<span id="w0">Hello</span>
</div>
`;
applyCaptionOverrides();
await flushCaptionOverrides();
applyCaptionOverrides();
await flushCaptionOverrides();
const group = document.querySelector(".caption-group");
const word = document.getElementById("w0");
const wrappers = group?.querySelectorAll('[data-caption-wrapper="true"]');
const wrapper = wrappers?.item(0);
if (!group || !word || !wrapper) throw new Error("Expected wrapped caption word");
expect(wrappers).toHaveLength(1);
expect(wrapper.parentElement).toBe(group);
expect(word.parentElement).toBe(wrapper);
expect(setCalls.map((call) => call.target)).toEqual([wrapper, wrapper]);
});
it("treats a pre-wrapped word as the wordIndex target, not as another word", async () => {
installGsapMock();
installCaptionOverrideFetch([{ wordIndex: 0, fontSize: 72 }]);
document.body.innerHTML = `
<div class="caption-group">
<span data-caption-wrapper="true">
<span id="w0">Hello</span>
</span>
</div>
`;
applyCaptionOverrides();
await flushCaptionOverrides();
const word = document.getElementById("w0");
const wrapper = word?.parentElement;
if (!(word instanceof HTMLElement) || !wrapper) {
throw new Error("Expected pre-wrapped caption word");
}
expect(word.style.fontSize).toBe("72px");
expect(wrapper.getAttribute("style") ?? "").not.toContain("font-size");
});
it("resolves wordId overrides against the inner word of an existing wrapper", async () => {
const { setCalls } = installGsapMock();
installCaptionOverrideFetch([{ wordId: "w0", x: 16 }]);
document.body.innerHTML = `
<div class="caption-group">
<span data-caption-wrapper="true">
<span id="w0">Hello</span>
</span>
</div>
`;
applyCaptionOverrides();
await flushCaptionOverrides();
const word = document.getElementById("w0");
const wrapper = word?.parentElement;
if (!(word instanceof HTMLElement) || !wrapper) {
throw new Error("Expected pre-wrapped caption word");
}
expect(setCalls).toHaveLength(1);
expect(setCalls[0]?.target).toBe(wrapper);
expect(setCalls[0]?.vars).toEqual({ x: 16 });
});
});