Files
hyperframes/packages/studio/src/components/editor/manualOffsetDrag.test.ts
T
Miguel Ángel 226a741c9d fix(studio): Enable keyframes works (and auto-tracks) on elements with a global gsap.set (#1728)
* fix(core): a global gsap.set is off-timeline, so resolvedStart is 0 not the comp end

resolveTimelinePositions walks anims in document order advancing a cursor; a
global `gsap.set(...)` carries no position arg, so it fell through to the
cursor fallback and inherited the comp-end time (every prior tween's duration
summed) as its resolvedStart. A global set is a load-time hold — its start is 0.

This silently broke 'Enable keyframes' on any element whose only animation is a
global gsap.set (e.g. a statically-positioned card): promoteSetToKeyframes bails
when `playhead <= setStart`, and setStart was the comp end, so any playhead
before the end was a no-op. Pin a global set to resolvedStart 0 in both the
recast and acorn parsers; don't let it advance the cursor/prevStart.

* fix(studio): Enable-keyframes marks the generated 0% endpoint as auto-tracking

When 'Enable keyframes' promotes a static set to a two-stop tween, the 0% (the
held start the user didn't choose) is now marked `auto: true` → serialized as the
`_auto: 1` marker. The parser's endpoint-sync then keeps it tracking the nearest
keyframe until the user edits it directly; the 100% (the real keyframe placed at
the playhead) stays fixed.

This re-wires the auto-endpoint behavior that was silently dropped in #1605 (the
sync logic stayed, but no flow produced an `_auto` endpoint anymore, so an
untouched 0% never tracked). Adds a guard test so it can't be lost again.

* chore: suppress fallow complexity findings surfaced in the touched files

The resolveTimelinePositions guard added a branch (pushes it over threshold), and
changed-file scope re-surfaces pre-existing complex functions (readElementPosition,
applyArcWaypointAtPlayhead, the useEnableKeyframes callback). Bare directives only.

* fix(studio): dragging a --hf-studio-offset element no longer flies

Dragging a static element positioned via the legacy --hf-studio-offset CSS var
(e.g. dot-a) flew off-screen — three independent failure modes, all fixed:

1. Live drag integrated: the per-move draft read its base from the live transform
   it set last frame (gsap.getProperty), so base+delta accumulated frame-over-frame.
   Fix: carry a stable baseGsap on the in-memory drag member (immune to mid-drag
   re-renders that wipe the data-hf-drag-* attrs) and use it as the fallback.

2. Commit re-added the delta: the source commit re-read the wiped attrs / live
   transform. Fix: re-stamp the stable base/initial attrs in applyManualOffsetDragCommit
   before the commit reads them.

3. Drop left it offset: the committed source was correct, but the LIVE element kept
   its --hf-studio-offset var + translate:var(...), which composed with the GSAP
   transform (rendered at dropped + offset) until a full reload. Fix: on cleanup,
   when GSAP owns the position, clearStudioPathOffset() migrates the element off the
   legacy CSS channel (leaving transform untouched) — matching the stripped source.

Adds a regression suite covering all three layers.
2026-06-25 21:31:23 -04:00

363 lines
16 KiB
TypeScript

import { Window } from "happy-dom";
import { describe, expect, it } from "vitest";
import {
applyManualOffsetDragCommit,
applyManualOffsetDragDraft,
applyManualOffsetDragMatrix,
createManualOffsetDragMember,
endManualOffsetDragMembers,
invertManualOffsetDragMatrix,
measureManualOffsetDragScreenToOffsetMatrix,
resolveManualOffsetForPointerDelta,
type ManualOffsetDragMatrix,
} from "./manualOffsetDrag";
import { STUDIO_OFFSET_X_PROP, STUDIO_OFFSET_Y_PROP } from "./manualEdits";
function expectMatrixClose(actual: ManualOffsetDragMatrix, expected: ManualOffsetDragMatrix): void {
expect(actual.a).toBeCloseTo(expected.a, 6);
expect(actual.b).toBeCloseTo(expected.b, 6);
expect(actual.c).toBeCloseTo(expected.c, 6);
expect(actual.d).toBeCloseTo(expected.d, 6);
}
describe("manual offset drag matrix helpers", () => {
it("inverts identity movement", () => {
const inverse = invertManualOffsetDragMatrix({ a: 1, b: 0, c: 0, d: 1 });
if (!inverse) throw new Error("identity matrix should be invertible");
expectMatrixClose(inverse, { a: 1, b: 0, c: 0, d: 1 });
});
it("maps screen movement through a rotated coordinate system", () => {
const screenToOffset = invertManualOffsetDragMatrix({ a: 0, b: 1, c: -1, d: 0 });
if (!screenToOffset) throw new Error("rotation matrix should be invertible");
const offsetDelta = applyManualOffsetDragMatrix(screenToOffset, { x: 0, y: 10 });
expect(offsetDelta.x).toBeCloseTo(10, 6);
expect(offsetDelta.y).toBeCloseTo(0, 6);
});
it("rejects singular movement matrices", () => {
expect(invertManualOffsetDragMatrix({ a: 1, b: 1, c: 2, d: 2 })).toBeNull();
});
it("resolves final offsets from the measured inverse matrix", () => {
const offsetToScreen = { a: 2, b: 3, c: -1, d: 4 };
const screenToOffset = invertManualOffsetDragMatrix(offsetToScreen);
if (!screenToOffset) throw new Error("fixture matrix should be invertible");
const nextOffset = resolveManualOffsetForPointerDelta({
initialOffset: { x: 5, y: -2 },
screenToOffset,
dx: 7,
dy: 11,
});
const screenDelta = applyManualOffsetDragMatrix(offsetToScreen, {
x: nextOffset.x - 5,
y: nextOffset.y + 2,
});
expect(screenDelta.x).toBeCloseTo(7, 6);
expect(screenDelta.y).toBeCloseTo(11, 6);
});
});
describe("measureManualOffsetDragScreenToOffsetMatrix", () => {
it("measures the element center response and restores probe styles", () => {
const window = new Window();
const element = window.document.createElement("div");
element.setAttribute("data-hf-studio-path-offset", "true");
window.document.body.append(element);
element.getBoundingClientRect = () => {
const offsetX = Number.parseFloat(element.style.getPropertyValue(STUDIO_OFFSET_X_PROP)) || 0;
const offsetY = Number.parseFloat(element.style.getPropertyValue(STUDIO_OFFSET_Y_PROP)) || 0;
return new window.DOMRect(10 + 2 * offsetX - offsetY, 20 + 3 * offsetX + 4 * offsetY, 12, 8);
};
const measured = measureManualOffsetDragScreenToOffsetMatrix(element, { x: 0, y: 0 });
if (!measured.ok) throw new Error(measured.reason);
const expected = invertManualOffsetDragMatrix({ a: 2, b: 3, c: -1, d: 4 });
if (!expected) throw new Error("fixture matrix should be invertible");
expectMatrixClose(measured.matrix, expected);
expect(element.style.getPropertyValue(STUDIO_OFFSET_X_PROP)).toBe("");
expect(element.style.getPropertyValue(STUDIO_OFFSET_Y_PROP)).toBe("");
expect(element.style.getPropertyValue("translate")).toBe("");
});
it("measures movement in parent viewport pixels when the element is inside a scaled iframe", () => {
const window = new Window();
const iframe = window.document.createElement("iframe");
window.document.body.append(iframe);
const iframeWindow = iframe.contentWindow;
const iframeDocument = iframe.contentDocument;
if (!iframeWindow || !iframeDocument) throw new Error("iframe fixture failed to initialize");
Object.defineProperty(iframeWindow, "frameElement", {
configurable: true,
value: iframe,
});
Object.defineProperty(iframeWindow, "innerWidth", {
configurable: true,
value: 200,
});
Object.defineProperty(iframeWindow, "innerHeight", {
configurable: true,
value: 100,
});
iframe.getBoundingClientRect = () => new window.DOMRect(50, 40, 100, 50);
const element = iframeDocument.createElement("div");
element.setAttribute("data-hf-studio-path-offset", "true");
iframeDocument.body.append(element);
element.getBoundingClientRect = () => {
const offsetX = Number.parseFloat(element.style.getPropertyValue(STUDIO_OFFSET_X_PROP)) || 0;
const offsetY = Number.parseFloat(element.style.getPropertyValue(STUDIO_OFFSET_Y_PROP)) || 0;
return new iframeWindow.DOMRect(20 + offsetX, 30 + offsetY, 40, 20);
};
const measured = measureManualOffsetDragScreenToOffsetMatrix(element, { x: 0, y: 0 });
if (!measured.ok) throw new Error(measured.reason);
expectMatrixClose(measured.matrix, { a: 2, b: -0, c: -0, d: 2 });
const nextOffset = resolveManualOffsetForPointerDelta({
initialOffset: { x: 0, y: 0 },
screenToOffset: measured.matrix,
dx: 50,
dy: 25,
});
expect(nextOffset).toEqual({ x: 100, y: 50 });
});
it("returns identity matrix for non-path-offset elements with zero initial offset", () => {
const window = new Window();
const element = window.document.createElement("div");
window.document.body.append(element);
element.getBoundingClientRect = () => new window.DOMRect(10, 20, 12, 8);
const measured = measureManualOffsetDragScreenToOffsetMatrix(element, { x: 0, y: 0 });
expect(measured.ok).toBe(true);
if (measured.ok) {
expectMatrixClose(measured.matrix, { a: 1, b: 0, c: 0, d: 1 });
}
});
it("rejects path-offset elements whose movement response cannot be measured", () => {
const window = new Window();
const element = window.document.createElement("div");
element.setAttribute("data-hf-studio-path-offset", "true");
window.document.body.append(element);
element.getBoundingClientRect = () => new window.DOMRect(10, 20, 12, 8);
const measured = measureManualOffsetDragScreenToOffsetMatrix(element, { x: 0, y: 0 });
expect(measured.ok).toBe(false);
});
});
describe("createManualOffsetDragMember uses raw CSS var offset", () => {
it("ignores GSAP transform — initialOffset comes from CSS vars only", () => {
const window = new Window();
const element = window.document.createElement("div");
window.document.body.append(element);
element.style.setProperty("transform", "translate(0px, -20px)");
element.getBoundingClientRect = () => {
const offsetX = Number.parseFloat(element.style.getPropertyValue(STUDIO_OFFSET_X_PROP)) || 0;
const offsetY = Number.parseFloat(element.style.getPropertyValue(STUDIO_OFFSET_Y_PROP)) || 0;
return new window.DOMRect(10 + offsetX, 20 + offsetY, 100, 50);
};
const result = createManualOffsetDragMember({
key: "test",
selection: { element } as never,
element,
rect: { left: 10, top: 20, width: 100, height: 50, editScaleX: 1, editScaleY: 1 },
});
expect(result.ok).toBe(true);
if (!result.ok) return;
expect(result.member.initialOffset.x).toBe(0);
expect(result.member.initialOffset.y).toBe(0);
});
it("reads only the CSS var offset, not GSAP transform", () => {
const window = new Window();
const element = window.document.createElement("div");
window.document.body.append(element);
element.style.setProperty(STUDIO_OFFSET_X_PROP, "30px");
element.style.setProperty(STUDIO_OFFSET_Y_PROP, "10px");
// Old projects bake the offset by referencing the vars in the inline
// `translate` longhand — that's what makes the offset "applied" and thus the
// valid drag base (readAppliedStudioPathOffset). A raw var with no applied
// translate is dormant and reads as zero. Assign the typed `.translate`
// accessor (happy-dom doesn't surface it via setProperty).
element.style.translate = `var(${STUDIO_OFFSET_X_PROP}, 0px) var(${STUDIO_OFFSET_Y_PROP}, 0px)`;
element.style.setProperty("transform", "translate(50px, -15px)");
element.getBoundingClientRect = () => {
const offsetX = Number.parseFloat(element.style.getPropertyValue(STUDIO_OFFSET_X_PROP)) || 0;
const offsetY = Number.parseFloat(element.style.getPropertyValue(STUDIO_OFFSET_Y_PROP)) || 0;
return new window.DOMRect(10 + offsetX, 20 + offsetY, 100, 50);
};
const result = createManualOffsetDragMember({
key: "test",
selection: { element } as never,
element,
rect: { left: 10, top: 20, width: 100, height: 50, editScaleX: 1, editScaleY: 1 },
});
expect(result.ok).toBe(true);
if (!result.ok) return;
expect(result.member.initialOffset.x).toBe(30);
expect(result.member.initialOffset.y).toBe(10);
});
it("does not accumulate drift across multiple drag cycles", () => {
const window = new Window();
const element = window.document.createElement("div");
window.document.body.append(element);
element.getBoundingClientRect = () => {
const offsetX = Number.parseFloat(element.style.getPropertyValue(STUDIO_OFFSET_X_PROP)) || 0;
const offsetY = Number.parseFloat(element.style.getPropertyValue(STUDIO_OFFSET_Y_PROP)) || 0;
return new window.DOMRect(10 + offsetX, 20 + offsetY, 100, 50);
};
// Simulate GSAP baking a translate into transform each cycle
for (let cycle = 0; cycle < 3; cycle++) {
element.style.setProperty("transform", `translate(${50 * (cycle + 1)}px, 0px)`);
// Mark the offset as APPLIED (the inline translate references the studio
// vars, the form an old project bakes) so readAppliedStudioPathOffset reads
// the var, not zero. Without this the var is dormant and reads as zero.
// Assign the typed `.translate` accessor (happy-dom doesn't surface it via
// setProperty).
element.style.translate = `var(${STUDIO_OFFSET_X_PROP}, 0px) var(${STUDIO_OFFSET_Y_PROP}, 0px)`;
const result = createManualOffsetDragMember({
key: "test",
selection: { element } as never,
element,
rect: { left: 10, top: 20, width: 100, height: 50, editScaleX: 1, editScaleY: 1 },
});
expect(result.ok).toBe(true);
if (!result.ok) return;
// initialOffset should always be the CSS var value, never inflated by GSAP transform
const currentRawX =
Number.parseFloat(element.style.getPropertyValue(STUDIO_OFFSET_X_PROP)) || 0;
expect(result.member.initialOffset.x).toBe(currentRawX);
// Simulate drag commit: apply a small offset
applyManualOffsetDragCommit(result.member, 10, 0);
endManualOffsetDragMembers([result.member]);
}
});
});
// ── GSAP-element drag: the dot-a "flies" regressions ────────────────────────
// A static element positioned via the legacy `--hf-studio-offset` CSS var, dragged
// in a GSAP composition. Three independent failure modes, each fixed:
// 1. live drag integrated off-screen (base read from the live transform)
// 2. commit re-added the delta (stamped base wiped by a mid-drag re-render)
// 3. drop left the element offset (stale --hf-studio-offset var composing with
// the committed GSAP transform until a full reload)
function makeGsapDot(offsetX = 94, offsetY = 2) {
const window = new Window();
const element = window.document.createElement("div");
element.id = "dot-a";
element.setAttribute("data-hf-studio-path-offset", "true");
element.style.setProperty(STUDIO_OFFSET_X_PROP, `${offsetX}px`);
element.style.setProperty(STUDIO_OFFSET_Y_PROP, `${offsetY}px`);
element.style.translate = `var(${STUDIO_OFFSET_X_PROP}, 0px) var(${STUDIO_OFFSET_Y_PROP}, 0px)`;
window.document.body.append(element);
// Constant rect → the screen-to-offset probe can't measure movement → member
// uses the deterministic preview-scale fallback matrix. Both branches set baseGsap.
element.getBoundingClientRect = () => new window.DOMRect(10, 20, 100, 50);
const sets: Array<Record<string, unknown>> = [];
const win = element.ownerDocument.defaultView as unknown as {
gsap?: unknown;
__timelines?: unknown;
};
win.gsap = {
set: (el: HTMLElement, vars: Record<string, unknown>) => {
sets.push({ ...vars });
if (typeof vars.x === "number") {
el.style.setProperty("transform", `translate(${vars.x}px, ${(vars.y as number) ?? 0}px)`);
}
},
// getProperty reads the LIVE transform — the exact value the old code fed back
// into `base + delta`, integrating the element off-screen.
getProperty: (el: HTMLElement, prop: string) => {
const m = /translate\(([-\d.]+)px,\s*([-\d.]+)px\)/.exec(
el.style.getPropertyValue("transform") || "",
);
if (!m) return 0;
return prop === "x" ? Number.parseFloat(m[1]!) : Number.parseFloat(m[2]!);
},
};
const member = () => {
const result = createManualOffsetDragMember({
key: "dot",
selection: { element } as never,
element,
rect: { left: 10, top: 20, width: 100, height: 50, editScaleX: 1, editScaleY: 1 },
});
if (!result.ok) throw new Error("member not created");
return result.member;
};
return { element, sets, member };
}
describe("GSAP-element drag — dot-a flies regressions", () => {
it("live draft uses the stable gesture-start base, so repeated moves don't integrate", () => {
const { element, member } = makeGsapDot();
const m = member();
// Simulate a mid-drag re-render wiping the stamped base attr → the draft must
// fall back to the in-memory member.baseGsap, NOT the live (mutating) transform.
element.removeAttribute("data-hf-drag-gsap-base-x");
element.removeAttribute("data-hf-drag-gsap-base-y");
applyManualOffsetDragDraft(m, -50, 0);
const first = element.style.getPropertyValue("transform");
applyManualOffsetDragDraft(m, -50, 0);
const second = element.style.getPropertyValue("transform");
// Same pointer delta → same committed transform. The old bug integrated (the
// second frame added the delta on top of the first frame's result).
expect(second).toBe(first);
});
it("commit re-stamps the stable base/initial attrs even after they're wiped", () => {
const { element, member } = makeGsapDot();
const m = member();
element.removeAttribute("data-hf-drag-gsap-base-x");
element.removeAttribute("data-hf-drag-initial-offset-x");
applyManualOffsetDragCommit(m, -50, 0);
expect(element.getAttribute("data-hf-drag-gsap-base-x")).toBe(String(m.baseGsap.x));
expect(element.getAttribute("data-hf-drag-initial-offset-x")).toBe(String(m.initialOffset.x));
});
it("a GSAP-committed drag migrates the element off --hf-studio-offset", () => {
const { element, member } = makeGsapDot();
expect(element.style.getPropertyValue(STUDIO_OFFSET_X_PROP)).toBe("94px");
const m = member();
applyManualOffsetDragCommit(m, -160, 0);
endManualOffsetDragMembers([m]);
// The legacy CSS-offset channel is fully cleared (single-sourced in GSAP): the
// var is removed, so any lingering `translate: var(--hf-studio-offset-x, 0px)`
// resolves to its 0px fallback and can no longer compose with the GSAP transform.
expect(element.style.getPropertyValue(STUDIO_OFFSET_X_PROP)).toBe("");
expect(element.style.getPropertyValue(STUDIO_OFFSET_Y_PROP)).toBe("");
expect(element.hasAttribute("data-hf-studio-path-offset")).toBe(false);
// ...and the position survives in the GSAP transform (no stale var to compose).
expect(element.style.getPropertyValue("transform")).toMatch(/translate\(/);
});
});