diff --git a/.fallowrc.jsonc b/.fallowrc.jsonc index 0c09507e34..32a6d5bc85 100644 --- a/.fallowrc.jsonc +++ b/.fallowrc.jsonc @@ -22,6 +22,9 @@ // Built as standalone IIFE for the browser-side sandbox runtime; // referenced by file path (not import) in build-hyperframes-runtime-artifact.ts. "packages/core/src/runtime/entry.ts", + // Bundled as a standalone IIFE by the position-edits render artifact + // generator; referenced by file path rather than imported by TypeScript. + "packages/core/stubs/position-edits-render-entry.ts", // In-page audit scripts read as raw strings and injected via // page.addScriptTag (see layout.ts / validate.ts) — referenced by file // path, never imported, so they have no import-graph referrer. diff --git a/.gitignore b/.gitignore index 211ff22fbd..21053dc046 100644 --- a/.gitignore +++ b/.gitignore @@ -72,7 +72,9 @@ tmp/ .tmp/ # Generated files -packages/core/src/generated/ +packages/core/src/generated/* +!packages/core/src/generated/position-edits-render-inline.ts +!packages/core/src/generated/position-edits-render-inline.test.ts packages/producer/src/services/fontData.generated.ts # Plan documents (working artifacts, not committed) diff --git a/packages/core/package.json b/packages/core/package.json index ea3e5cbac5..ffe9d29576 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -119,6 +119,12 @@ "import": "./src/runtime/positionEdits.ts", "types": "./src/runtime/positionEdits.ts" }, + "./runtime/position-edits-render": { + "bun": "./src/generated/position-edits-render-inline.ts", + "node": "./dist/generated/position-edits-render-inline.js", + "import": "./src/generated/position-edits-render-inline.ts", + "types": "./src/generated/position-edits-render-inline.ts" + }, "./runtime/lottie-readiness": { "bun": "./src/lottieReadiness.ts", "node": "./dist/lottieReadiness.js", @@ -309,6 +315,10 @@ "import": "./dist/runtime/positionEdits.js", "types": "./dist/runtime/positionEdits.d.ts" }, + "./runtime/position-edits-render": { + "import": "./dist/generated/position-edits-render-inline.js", + "types": "./dist/generated/position-edits-render-inline.d.ts" + }, "./runtime/lottie-readiness": { "import": "./dist/lottieReadiness.js", "types": "./dist/lottieReadiness.d.ts" @@ -388,13 +398,15 @@ "types": "./dist/index.d.ts" }, "scripts": { - "build": "bun run build:hyperframes-runtime && tsc && tsx scripts/rewrite-esm-extensions.ts", - "test": "vitest run", + "build": "bun run build:hyperframes-runtime && bun run build:position-edits-render && tsc && tsx scripts/rewrite-esm-extensions.ts", + "test": "bun run check:position-edits-render && vitest run", "test:watch": "vitest", "test:coverage": "vitest run --coverage", "typecheck": "tsc --noEmit", "lint:runtime-preview-guards": "tsx scripts/lint-runtime-preview-guards.ts", "build:hyperframes-runtime": "tsx scripts/build-hyperframes-runtime-artifact.ts", + "build:position-edits-render": "tsx scripts/build-position-edits-render.ts", + "check:position-edits-render": "bun run build:position-edits-render && git diff --exit-code -- src/generated/position-edits-render-inline.ts", "build:hyperframes-runtime:modular": "SANDBOX_RUNTIME_VARIANT=modular tsx scripts/build-hyperframes-runtime-artifact.ts", "build:hyperframe-runtime": "tsx scripts/build-hyperframes-runtime-artifact.ts", "test:hyperframe-runtime-contract": "tsx scripts/test-hyperframe-runtime-contract.ts", diff --git a/packages/core/scripts/build-position-edits-render.ts b/packages/core/scripts/build-position-edits-render.ts new file mode 100644 index 0000000000..e4ed0ef981 --- /dev/null +++ b/packages/core/scripts/build-position-edits-render.ts @@ -0,0 +1,52 @@ +/** Build the injectable position-edits render artifact from the canonical runtime. */ + +import { mkdirSync, writeFileSync } from "node:fs"; +import { dirname, resolve } from "node:path"; +import { fileURLToPath } from "node:url"; +import { buildSync } from "esbuild"; +import { execFileSync } from "node:child_process"; + +const thisDir = dirname(fileURLToPath(import.meta.url)); +const repoRoot = resolve(thisDir, ".."); +const entry = resolve(repoRoot, "stubs/position-edits-render-entry.ts"); +const generatedDir = resolve(repoRoot, "src/generated"); +const outPath = resolve(generatedDir, "position-edits-render-inline.ts"); + +const result = buildSync({ + entryPoints: [entry], + bundle: true, + write: false, + platform: "browser", + format: "iife", + target: ["es2020"], + minify: true, + legalComments: "none", +}); +const iife = result.outputFiles[0]?.text ?? ""; +if (!iife) throw new Error("esbuild produced no output for position-edits-render-entry.ts"); + +mkdirSync(generatedDir, { recursive: true }); +writeFileSync( + outPath, + [ + "// AUTO-GENERATED by scripts/build-position-edits-render.ts - do not edit", + `const POSITION_EDITS_RENDER_IIFE: string = ${JSON.stringify(iife)};`, + "", + "/** Returns the pre-built position-edits render IIFE as a string constant. */", + "export function getPositionEditsRenderScript(): string {", + " return POSITION_EDITS_RENDER_IIFE;", + "}", + "", + ].join("\n"), + "utf8", +); + +try { + execFileSync("bun", ["x", "oxfmt", outPath], { stdio: "ignore" }); +} catch { + // Formatting is best effort when the generator runs in a minimal environment. +} + +console.log( + JSON.stringify({ event: "position_edits_render_generated", outPath, bytes: iife.length }), +); diff --git a/packages/core/src/generated/position-edits-render-inline.test.ts b/packages/core/src/generated/position-edits-render-inline.test.ts new file mode 100644 index 0000000000..bd09b90f55 --- /dev/null +++ b/packages/core/src/generated/position-edits-render-inline.test.ts @@ -0,0 +1,23 @@ +import { describe, expect, it } from "vitest"; +import { getPositionEditsRenderScript } from "./position-edits-render-inline"; + +describe("getPositionEditsRenderScript", () => { + it("returns a non-empty IIFE string built from the real algorithm", () => { + const script = getPositionEditsRenderScript(); + expect(script.length).toBeGreaterThan(0); + expect(script).toContain("data-hf-edit-base-x"); + }); + + it("is a safe no-op without position-edit markers", () => { + document.body.innerHTML = "

no edits

"; + expect(() => new Function(getPositionEditsRenderScript())()).not.toThrow(); + expect(document.querySelector("h1")?.style.getPropertyValue("translate")).toBe(""); + }); + + it("applies the translate delta when markers are present", () => { + document.body.innerHTML = + '

hi

'; + new Function(getPositionEditsRenderScript())(); + expect(document.querySelector("h1")?.style.getPropertyValue("translate")).toBe("10px 0px"); + }); +}); diff --git a/packages/core/src/generated/position-edits-render-inline.ts b/packages/core/src/generated/position-edits-render-inline.ts new file mode 100644 index 0000000000..9e2daf7fce --- /dev/null +++ b/packages/core/src/generated/position-edits-render-inline.ts @@ -0,0 +1,8 @@ +// AUTO-GENERATED by scripts/build-position-edits-render.ts - do not edit +const POSITION_EDITS_RENDER_IIFE: string = + '"use strict";(()=>{function v(){return globalThis}function A(e,t){if(typeof window>"u")return;let o=v(),r=o.__hf?.onSwallowed;if(r)try{r({label:e,error:t})}catch(i){}(o.__hfDebug||o.__HYPERFRAMES_DEBUG)&&console.debug(`[hyperframes] ${e} swallowed:`,t)}var P=null;function T(e,t){if(P)try{P({source:"hf-preview",type:"analytics",event:e,properties:t??{}})}catch(o){A("runtime.analytics.site1",o)}}var w="data-hf-edit-base-x",y="data-hf-edit-base-y",_="data-hf-edit-original-translate",g=e=>{let t=parseFloat(e??"");return Number.isFinite(t)?t:0},H=e=>{let t=[],o=0,r="";for(let i of e.trim())i==="("&&(o+=1),i===")"&&(o=Math.max(0,o-1)),/\\s/.test(i)&&o===0?(r&&t.push(r),r=""):r+=i;return r&&t.push(r),t},R=/^-?(?:\\d+(?:\\.\\d+)?|\\.\\d+)px$/,b=(e,t)=>R.test(e)&&R.test(t)?`${parseFloat(e)+parseFloat(t)}px`:`calc(${e} + ${t})`,I=(e,t,o)=>{if(!e||e==="none")return`${t} ${o}`;let[r,i,a]=H(e);if(r===void 0)return`${t} ${o}`;if(i===void 0)return`${b(r,t)} ${o}`;let c=a===void 0?"":` ${a}`;return`${b(r,t)} ${b(i,o)}${c}`},O=e=>{try{e.ownerDocument.defaultView?.gsap?.getProperty?.(e,"x")}catch{}},j=e=>{let t=e.style.getPropertyValue("translate").trim();if(t)return t==="none"?"":t;try{let o=e.ownerDocument.defaultView,r=o?o.getComputedStyle(e).getPropertyValue("translate").trim():"";return r==="none"?"":r}catch{return""}},x=new WeakMap;function V(e,t){let o=x.get(e);if(!t?.force&&o!==void 0&&e.style.getPropertyValue("translate")!==o){T("position_edit_fold_skipped",{hfId:e.getAttribute("data-hf-id")});return}let r=g(e.getAttribute("data-x"))-g(e.getAttribute(w)),i=g(e.getAttribute("data-y"))-g(e.getAttribute(y));e.hasAttribute(_)||e.setAttribute(_,j(e)),o===void 0&&O(e);let a=e.getAttribute(_)??"",c=I(a,`${r}px`,`${i}px`);e.style.setProperty("translate",c),x.set(e,e.style.getPropertyValue("translate"))}function m(e){let t=e.querySelectorAll(`[${w}], [${y}]`),o=e.defaultView?.HTMLElement,r=0;for(let i=0;i{try{m(t.document)}catch{}},r=n=>typeof n=="function"&&($.has(n)||!!n[D]),i=n=>{$.add(n);try{Object.defineProperty(n,D,{value:!0})}catch{}},a=n=>{if(typeof n!="function"||r(n))return n;let s=function(...u){let d=n.apply(this,u);return o(),d};return i(s),s},c=(n,s)=>{let u=F.get(n);if(u?.has(s))return!0;let d=Object.getOwnPropertyDescriptor(n,s);if(d?.configurable===!1){let l=n[s];return typeof l=="function"&&(n[s]=a(l),o()),!1}let p=n[s],f=d?.set;return Object.defineProperty(n,s,{configurable:!0,enumerable:d?.enumerable??!0,get:()=>p,set:l=>{p=a(l),f?.call(n,l)}}),p=a(p),u??(u=new Set),u.add(s),F.set(n,u),o(),!0},k=(n,s)=>{let u=L.get(t),d=Object.getOwnPropertyDescriptor(t,n);if(!u?.has(n)){if(d?.configurable===!1){let l=t[n];return l?c(l,s):!1}let f=t[n];Object.defineProperty(t,n,{configurable:!0,enumerable:d?.enumerable??!0,get:()=>f,set:l=>{f=l,f&&c(f,s)}}),u??(u=new Set),u.add(n),L.set(t,u)}let p=t[n];return p?c(p,s):!1},E=()=>{let n=k("__hf","seek"),s=k("__player","renderSeek");return n&&s};if(E())return;let S=120,h=t.setInterval(()=>{if(E()){t.clearInterval(h);return}S-=1,S<=0&&t.clearInterval(h)},50)}function W(){document.querySelector(`[${w}], [${y}]`)&&(m(document),M(window))}document.readyState==="loading"?document.addEventListener("DOMContentLoaded",W,{once:!0}):W();})();\n'; + +/** Returns the pre-built position-edits render IIFE as a string constant. */ +export function getPositionEditsRenderScript(): string { + return POSITION_EDITS_RENDER_IIFE; +} diff --git a/packages/core/src/runtime/init.positionEdits.test.ts b/packages/core/src/runtime/init.positionEdits.test.ts new file mode 100644 index 0000000000..70b44bed52 --- /dev/null +++ b/packages/core/src/runtime/init.positionEdits.test.ts @@ -0,0 +1,24 @@ +import { describe, expect, it } from "vitest"; +import { installPositionEditsSeekReapply } from "./positionEdits"; + +describe("init.ts per-seek position-edit parity", () => { + it("recomputes the position edit after renderSeek", () => { + document.body.innerHTML = + '

hi

'; + const h1 = document.querySelector("h1"); + if (!(h1 instanceof HTMLElement)) throw new Error("test element missing"); + + // @ts-expect-error test global + window.__player = { + renderSeek: () => h1.setAttribute("data-x", "40"), + }; + installPositionEditsSeekReapply(window as Window & typeof globalThis); + // @ts-expect-error test global + window.__player.renderSeek(1); + + expect(h1.style.getPropertyValue("translate")).toBe("40px 0px"); + // @ts-expect-error test global + delete window.__player; + h1.remove(); + }); +}); diff --git a/packages/core/src/runtime/init.ts b/packages/core/src/runtime/init.ts index 618d815e2d..38f1dfc58a 100644 --- a/packages/core/src/runtime/init.ts +++ b/packages/core/src/runtime/init.ts @@ -29,7 +29,7 @@ import { createRuntimeStartTimeResolver } from "./startResolver"; import { createClipTree } from "./clipTree"; import { loadExternalCompositions, loadInlineTemplateCompositions } from "./compositionLoader"; import { applyCaptionOverrides } from "./captionOverrides"; -import { applyPositionEdits } from "./positionEdits"; +import { applyPositionEdits, installPositionEditsSeekReapply } from "./positionEdits"; import { applyVariableBindings } from "./applyVariableBindings"; import { createColorGradingRuntime, type RuntimeColorGradingApi } from "./colorGrading"; import { TransportClock } from "./clock"; @@ -2987,6 +2987,8 @@ export function initSandboxRuntimeModular(): void { } } + installPositionEditsSeekReapply(window as Window & typeof globalThis); + // Start the rAF tick loop state.transportRafId = window.requestAnimationFrame(transportTick); postTimeline(); diff --git a/packages/core/src/runtime/positionEdits.test.ts b/packages/core/src/runtime/positionEdits.test.ts index 5354a36736..4f6437cc21 100644 --- a/packages/core/src/runtime/positionEdits.test.ts +++ b/packages/core/src/runtime/positionEdits.test.ts @@ -1,4 +1,4 @@ -import { describe, expect, it } from "vitest"; +import { describe, expect, it, vi } from "vitest"; import { EDIT_BASE_X_ATTR, EDIT_BASE_Y_ATTR, @@ -6,6 +6,7 @@ import { applyPositionEditToElement, applyPositionEdits, composeTranslate, + installPositionEditsSeekReapply, } from "./positionEdits"; function makeElement(attrs: Record, style = ""): HTMLElement { @@ -174,3 +175,67 @@ describe("applyPositionEdits", () => { el.remove(); }); }); + +describe("installPositionEditsSeekReapply", () => { + it("wraps __player.renderSeek so each call reapplies position edits", () => { + const el = makeElement({ "data-x": "10", "data-y": "0", "data-hf-edit-base-x": "0" }); + const calls: number[] = []; + // @ts-expect-error test global + window.__player = { renderSeek: (time: number) => calls.push(time) }; + + installPositionEditsSeekReapply(window as Window & typeof globalThis); + // @ts-expect-error test global + window.__player.renderSeek(1.5); + + expect(calls).toEqual([1.5]); + expect(el.style.getPropertyValue("translate")).toBe("10px 0px"); + // @ts-expect-error test global + delete window.__player; + el.remove(); + }); + + it("is idempotent when installed twice", () => { + const el = makeElement({ "data-x": "5", "data-y": "0", "data-hf-edit-base-x": "0" }); + const calls: number[] = []; + // @ts-expect-error test global + window.__player = { renderSeek: (time: number) => calls.push(time) }; + + installPositionEditsSeekReapply(window as Window & typeof globalThis); + installPositionEditsSeekReapply(window as Window & typeof globalThis); + // @ts-expect-error test global + window.__player.renderSeek(2); + + expect(calls).toEqual([2]); + // @ts-expect-error test global + delete window.__player; + el.remove(); + }); + + it("wraps __hf.seek and a seek function assigned after installation", () => { + vi.useFakeTimers(); + const el = makeElement({ "data-x": "8", "data-y": "0", "data-hf-edit-base-x": "0" }); + const calls: number[] = []; + // @ts-expect-error test global + window.__hf = {}; + + installPositionEditsSeekReapply(window as Window & typeof globalThis); + // @ts-expect-error test global + window.__hf.seek = (time: number) => calls.push(time); + vi.advanceTimersByTime(50); + // @ts-expect-error test global + window.__hf.seek(3); + + expect(calls).toEqual([3]); + expect(el.style.getPropertyValue("translate")).toBe("8px 0px"); + // @ts-expect-error test global + delete window.__hf; + el.remove(); + vi.useRealTimers(); + }); + + it("does not throw when neither seek global exists", () => { + expect(() => + installPositionEditsSeekReapply(window as Window & typeof globalThis), + ).not.toThrow(); + }); +}); diff --git a/packages/core/src/runtime/positionEdits.ts b/packages/core/src/runtime/positionEdits.ts index 512fb6d257..837e8dc469 100644 --- a/packages/core/src/runtime/positionEdits.ts +++ b/packages/core/src/runtime/positionEdits.ts @@ -175,3 +175,130 @@ export function applyPositionEdits(doc: Document): number { } return applied; } + +const SEEK_REAPPLY_WRAPPED = "__hfPositionEditsSeekReapplyWrapped"; +type SeekFunction = (...args: unknown[]) => unknown; +const wrappedSeekFunctions = new WeakSet(); +const observedSeekProperties = new WeakMap>(); +const observedGlobalProperties = new WeakMap>(); + +type SeekWindow = Window & + typeof globalThis & { + __hf?: { seek?: (...args: unknown[]) => unknown }; + __player?: { renderSeek?: (...args: unknown[]) => unknown }; + }; + +/** Reapply SDK position edits after every render seek, including late-bound seeks. */ +export function installPositionEditsSeekReapply(win: Window & typeof globalThis): void { + const target = win as SeekWindow; + const reapply = (): void => { + try { + applyPositionEdits(target.document); + } catch { + // A position edit must never break the render seek path. + } + }; + + const isWrapped = (fn: unknown): fn is SeekFunction => + typeof fn === "function" && + (wrappedSeekFunctions.has(fn as SeekFunction) || + Boolean((fn as { [SEEK_REAPPLY_WRAPPED]?: boolean })[SEEK_REAPPLY_WRAPPED])); + + const markWrapped = (fn: SeekFunction): void => { + wrappedSeekFunctions.add(fn); + try { + Object.defineProperty(fn, SEEK_REAPPLY_WRAPPED, { value: true }); + } catch { + // The WeakSet keeps frozen functions from being wrapped repeatedly. + } + }; + + const wrapFunction = (fn: unknown): unknown => { + if (typeof fn !== "function" || isWrapped(fn)) return fn; + const wrapped: SeekFunction = function (this: unknown, ...args: unknown[]): unknown { + const result = fn.apply(this, args); + reapply(); + return result; + }; + markWrapped(wrapped); + return wrapped; + }; + + const observeSeekProperty = (container: object, property: string): boolean => { + let observed = observedSeekProperties.get(container); + if (observed?.has(property)) return true; + const descriptor = Object.getOwnPropertyDescriptor(container, property); + if (descriptor?.configurable === false) { + const current = (container as Record)[property]; + if (typeof current === "function") { + (container as Record)[property] = wrapFunction(current); + reapply(); + } + return false; + } + + let current = (container as Record)[property]; + const originalSetter = descriptor?.set; + Object.defineProperty(container, property, { + configurable: true, + enumerable: descriptor?.enumerable ?? true, + get: () => current, + set: (value: unknown) => { + current = wrapFunction(value); + originalSetter?.call(container, value); + }, + }); + current = wrapFunction(current); + observed ??= new Set(); + observed.add(property); + observedSeekProperties.set(container, observed); + reapply(); + return true; + }; + + const observeGlobalContainer = ( + name: "__hf" | "__player", + property: "seek" | "renderSeek", + ): boolean => { + let globals = observedGlobalProperties.get(target); + const descriptor = Object.getOwnPropertyDescriptor(target, name); + if (!globals?.has(name)) { + if (descriptor?.configurable === false) { + const current = target[name]; + return current ? observeSeekProperty(current, property) : false; + } + let value = target[name]; + Object.defineProperty(target, name, { + configurable: true, + enumerable: descriptor?.enumerable ?? true, + get: () => value, + set: (next: unknown) => { + value = next as typeof value; + if (value) observeSeekProperty(value, property); + }, + }); + globals ??= new Set(); + globals.add(name); + observedGlobalProperties.set(target, globals); + } + const current = target[name]; + return current ? observeSeekProperty(current, property) : false; + }; + + const wrapAll = (): boolean => { + const hfObserved = observeGlobalContainer("__hf", "seek"); + const playerObserved = observeGlobalContainer("__player", "renderSeek"); + return hfObserved && playerObserved; + }; + + if (wrapAll()) return; + let remaining = 120; + const interval = target.setInterval(() => { + if (wrapAll()) { + target.clearInterval(interval); + return; + } + remaining -= 1; + if (remaining <= 0) target.clearInterval(interval); + }, 50); +} diff --git a/packages/core/stubs/position-edits-render-entry.ts b/packages/core/stubs/position-edits-render-entry.ts new file mode 100644 index 0000000000..4dadc161e7 --- /dev/null +++ b/packages/core/stubs/position-edits-render-entry.ts @@ -0,0 +1,20 @@ +import { + EDIT_BASE_X_ATTR, + EDIT_BASE_Y_ATTR, + applyPositionEdits, + installPositionEditsSeekReapply, +} from "../src/runtime/positionEdits"; + +function start(): void { + if (!document.querySelector(`[${EDIT_BASE_X_ATTR}], [${EDIT_BASE_Y_ATTR}]`)) { + return; + } + applyPositionEdits(document); + installPositionEditsSeekReapply(window); +} + +if (document.readyState === "loading") { + document.addEventListener("DOMContentLoaded", start, { once: true }); +} else { + start(); +} diff --git a/packages/producer/src/services/htmlCompiler.test.ts b/packages/producer/src/services/htmlCompiler.test.ts index 5b41203a34..2fa6573ddc 100644 --- a/packages/producer/src/services/htmlCompiler.test.ts +++ b/packages/producer/src/services/htmlCompiler.test.ts @@ -7,6 +7,7 @@ import { parseHTML } from "linkedom"; import { collectExternalAssets, compileForRender, + injectSdkPositionEditsRenderScript, detectRenderModeHints, detectShaderTransitionUsage, detectThreeDTransformUsage, @@ -19,6 +20,28 @@ import { } from "./htmlCompiler.js"; import { validateNoSystemFonts } from "./render/planValidation.js"; +describe("injectSdkPositionEditsRenderScript", () => { + it("injects before when SDK position-edit markers are present", () => { + const html = + '

Hi

'; + const out = injectSdkPositionEditsRenderScript(html); + expect(out).toContain("`; + const bodyClose = html.search(/<\/body\s*>/i); + if (bodyClose < 0) return `${html}${script}`; + return `${html.slice(0, bodyClose)}${script}${html.slice(bodyClose)}`; +} + /** * Thrown by {@link assertSubCompositionsUsable} when one or more * `data-composition-src` references resolve to a missing, empty, or @@ -1730,6 +1742,7 @@ export async function compileForRender( ``, ) : assembledHtml; + const htmlWithSdkPositionScript = injectSdkPositionEditsRenderScript(htmlWithPositionScript); // Download remote