mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-07 18:26:17 +00:00
Adds a control-bar toggle (next to the Add Keyframe diamond) that, when off, makes a manual drag/resize/rotate/panel edit on an already-keyframed element shift the whole tween by the edit's delta instead of inserting or updating a keyframe at the playhead. The animation's shape is preserved, just moved. Wired into every path that can auto-record a keyframe: - canvas drag-to-move (tryGsapDragIntercept, reuses the existing Alt-drag "shift whole path" behavior) - canvas resize/rotate (tryGsapResizeIntercept, tryGsapRotationIntercept) - design-panel property edits (useAnimatedPropertyCommit) - motion-path keyframe-node dragging (MotionPathOverlay), the path a plain click-drag on a keyframed element's canvas shape actually takes, since the element renders exactly at its current keyframe's position The shared shift helper reuses synthesizeFlatTweenKeyframes for materializing a flat tween instead of hand-rolling it, and lives in its own file (gsapWholePropertyOffsetCommit.ts) to keep gsapDragCommit.ts under the 600-line cap, mirroring the existing gsapDragPositionCommit.ts split. Fixes #1808
247 lines
9.2 KiB
TypeScript
247 lines
9.2 KiB
TypeScript
import { afterEach, describe, expect, it, vi } from "vitest";
|
|
import type { GsapAnimation } from "@hyperframes/core/gsap-parser";
|
|
import type { DomEditSelection } from "../components/editor/domEditingTypes";
|
|
import { tryGsapDragIntercept } from "./gsapRuntimeBridge";
|
|
import { usePlayerStore } from "../player/store/playerStore";
|
|
|
|
/**
|
|
* Regression: `selectedGsapAnimations` (and the fetch fallback) is an async
|
|
* server-parse that LAGS a delete-all. A drag in that window would resolve a
|
|
* phantom position tween from the stale cache and re-commit it — resurrecting the
|
|
* just-deleted animation. tryGsapDragIntercept must trust the LIVE runtime: when
|
|
* the runtime has no keyframed/tweened position motion, the element is STATIC
|
|
* (single-source model), so the drag commits a position-hold `tl.set("#el",{x,y})`
|
|
* rather than re-committing the phantom tween. The stale `to` parse is ignored.
|
|
*/
|
|
|
|
// A preview iframe whose runtime timeline holds `children`, resolves the element,
|
|
// and exposes a gsap stub — so the drag can reach the commit path (the guard, not
|
|
// a missing gsap, must be what stops it).
|
|
function fakeIframe(elId: string, children: unknown[]): HTMLIFrameElement {
|
|
const timeline = { getChildren: () => children, duration: () => 14.6 };
|
|
const el = { id: elId };
|
|
return {
|
|
contentWindow: {
|
|
__timelines: { "index.html": timeline },
|
|
gsap: { getProperty: () => 0 },
|
|
},
|
|
contentDocument: { querySelector: (sel: string) => (sel === `#${elId}` ? el : null) },
|
|
} as unknown as HTMLIFrameElement;
|
|
}
|
|
|
|
// A selection whose element answers the reads commitGsapPositionFromDrag makes —
|
|
// so without the guard the drag would reach commitMutation (resurrecting the tween).
|
|
const fakeElement = {
|
|
id: "puck-b",
|
|
style: { getPropertyValue: () => "" },
|
|
getAttribute: () => null,
|
|
getBoundingClientRect: () => ({ top: 100, left: 100, width: 50, height: 50 }),
|
|
} as unknown as HTMLElement;
|
|
|
|
const selection = {
|
|
id: "puck-b",
|
|
selector: "#puck-b",
|
|
element: fakeElement,
|
|
} as unknown as DomEditSelection;
|
|
|
|
// A stale parse-cache entry: a position tween the server still reports post-delete.
|
|
const stalePositionAnim = {
|
|
id: "#puck-b-to-1000-position",
|
|
targetSelector: "#puck-b",
|
|
propertyGroup: "position",
|
|
method: "to",
|
|
properties: { x: -180, y: -60 },
|
|
position: 1,
|
|
resolvedStart: 1,
|
|
duration: 2,
|
|
} as unknown as GsapAnimation;
|
|
|
|
afterEach(() => vi.restoreAllMocks());
|
|
|
|
describe("tryGsapDragIntercept — stale-parse guard (no resurrection after delete-all)", () => {
|
|
it("commits a static set (not the stale tween) when the runtime has no live position motion", async () => {
|
|
const commitMutation = vi.fn();
|
|
// Runtime empty (tween deleted) — readRuntimeKeyframes returns null, so the
|
|
// element is treated as STATIC. The stale `to` parse must NOT be re-committed.
|
|
const iframe = fakeIframe("puck-b", []);
|
|
|
|
const handled = await tryGsapDragIntercept(
|
|
selection,
|
|
{ x: -50, y: 30 },
|
|
[stalePositionAnim],
|
|
iframe,
|
|
commitMutation,
|
|
);
|
|
|
|
expect(handled).toBe(true);
|
|
// No existing `set` for the selector → one `add` mutation with `method:"set"`.
|
|
expect(commitMutation).toHaveBeenCalledTimes(1);
|
|
const [, mutation] = commitMutation.mock.calls[0];
|
|
expect(mutation).toMatchObject({
|
|
type: "add",
|
|
method: "set",
|
|
targetSelector: "#puck-b",
|
|
position: 0,
|
|
});
|
|
// Drag delta (-50, 30) off a zero base → the committed set holds that position.
|
|
expect(mutation.properties).toEqual({ x: -50, y: 30 });
|
|
// It must NOT resurrect the stale tween via a tween/keyframe mutation.
|
|
expect(mutation.type).not.toBe("update-property");
|
|
expect(mutation.type).not.toBe("add-keyframe");
|
|
});
|
|
|
|
it("forwards instantPatch on BOTH coalesced commits when updating an existing static set", async () => {
|
|
const commitMutation = vi.fn();
|
|
const iframe = fakeIframe("puck-b", []); // runtime empty → STATIC path
|
|
// An existing position-hold `set` for the selector → update-in-place (not add).
|
|
const existingSet = {
|
|
id: "#puck-b-set",
|
|
targetSelector: "#puck-b",
|
|
method: "set",
|
|
// Tagged as a position group so resolveGroupTween returns it directly
|
|
// (no split commit), exercising the in-place update path cleanly.
|
|
propertyGroup: "position",
|
|
properties: { x: 0, y: 0 },
|
|
} as unknown as GsapAnimation;
|
|
|
|
const handled = await tryGsapDragIntercept(
|
|
selection,
|
|
{ x: -50, y: 30 },
|
|
[existingSet],
|
|
iframe,
|
|
commitMutation,
|
|
);
|
|
|
|
expect(handled).toBe(true);
|
|
// The coalesced update-property pair both carry an instantPatch so a partial
|
|
// (second-POST) failure still leaves the preview patched for what persisted:
|
|
// the x commit patches {x}, the final y commit patches the full {x,y}.
|
|
const updates = commitMutation.mock.calls.filter(([, m]) => m.type === "update-property");
|
|
expect(updates).toHaveLength(2);
|
|
expect(updates[0][2].instantPatch).toEqual({
|
|
selector: "#puck-b",
|
|
change: { kind: "set", props: { x: -50 } },
|
|
});
|
|
expect(updates[1][2].instantPatch).toEqual({
|
|
selector: "#puck-b",
|
|
change: { kind: "set", props: { x: -50, y: 30 } },
|
|
});
|
|
});
|
|
|
|
it("updates a degenerate duration:0 hold-`to` in place instead of appending a gsap.set", async () => {
|
|
const commitMutation = vi.fn();
|
|
const iframe = fakeIframe("puck-b", []); // runtime empty → STATIC path
|
|
// What remove-all-keyframes leaves behind: a zero-duration immediateRender
|
|
// `tl.to` hold. A drag must UPDATE it, not append a 2nd (gsap.set) position
|
|
// write that silently overrides it (the duplicate-position-write bug).
|
|
const degenerateHold = {
|
|
id: "#puck-b-to-0-position",
|
|
targetSelector: "#puck-b",
|
|
method: "to",
|
|
propertyGroup: "position",
|
|
properties: { x: -766, y: 314 },
|
|
position: 1.333,
|
|
resolvedStart: 1.333,
|
|
duration: 0,
|
|
} as unknown as GsapAnimation;
|
|
|
|
const handled = await tryGsapDragIntercept(
|
|
selection,
|
|
{ x: -50, y: 30 },
|
|
[degenerateHold],
|
|
iframe,
|
|
commitMutation,
|
|
);
|
|
|
|
expect(handled).toBe(true);
|
|
// In-place update (2 coalesced update-property), NOT an `add`/`add-keyframe`.
|
|
const types = commitMutation.mock.calls.map(([, m]) => m.type);
|
|
expect(types.every((t: string) => t === "update-property")).toBe(true);
|
|
expect(types).not.toContain("add");
|
|
expect(types).not.toContain("add-keyframe");
|
|
});
|
|
|
|
it("does not trip the stale-parse guard when the runtime still has the tween", async () => {
|
|
const logSpy = vi.spyOn(console, "log").mockImplementation(() => {});
|
|
const liveTween = {
|
|
targets: () => [{ id: "puck-b" }],
|
|
vars: { x: -120, y: 40, duration: 1 },
|
|
duration: () => 1,
|
|
startTime: () => 1,
|
|
};
|
|
// No fake gsap → it returns false later (at the gsapPos read), but the point
|
|
// is the stale-parse guard must NOT be the reason.
|
|
const iframe = fakeIframe("puck-b", [liveTween]);
|
|
|
|
await tryGsapDragIntercept(selection, { x: -50, y: 30 }, [stalePositionAnim], iframe, vi.fn());
|
|
|
|
const staleLogged = logSpy.mock.calls.some((c) => String(c[1] ?? "").includes("stale parse"));
|
|
expect(staleLogged).toBe(false);
|
|
});
|
|
});
|
|
|
|
// Regression (#1808): with the global auto-keyframe toggle off, dragging an
|
|
// element that already has a keyframed position tween must shift the whole
|
|
// tween (a "replace-with-keyframes" carrying every original percentage) —
|
|
// the same path Alt-drag already takes — instead of inserting a keyframe at
|
|
// the playhead.
|
|
describe("tryGsapDragIntercept — autoKeyframeEnabled toggle (#1808)", () => {
|
|
afterEach(() => {
|
|
usePlayerStore.setState({ autoKeyframeEnabled: true });
|
|
});
|
|
|
|
const keyframedPositionAnim = {
|
|
id: "#puck-b-to-position",
|
|
targetSelector: "#puck-b",
|
|
propertyGroup: "position",
|
|
method: "to",
|
|
properties: {},
|
|
position: 0,
|
|
resolvedStart: 0,
|
|
duration: 2,
|
|
keyframes: {
|
|
keyframes: [
|
|
{ percentage: 0, properties: { x: 0, y: 0 } },
|
|
{ percentage: 100, properties: { x: 100, y: 0 } },
|
|
],
|
|
},
|
|
} as unknown as GsapAnimation;
|
|
|
|
it("shifts the whole tween instead of adding a keyframe when the toggle is off", async () => {
|
|
usePlayerStore.setState({ autoKeyframeEnabled: false, currentTime: 2 }); // playhead at 100%
|
|
const commitMutation = vi.fn();
|
|
const iframe = fakeIframe("puck-b", []);
|
|
|
|
const handled = await tryGsapDragIntercept(
|
|
selection,
|
|
{ x: -50, y: 0 },
|
|
[keyframedPositionAnim],
|
|
iframe,
|
|
commitMutation,
|
|
);
|
|
|
|
expect(handled).toBe(true);
|
|
const types = commitMutation.mock.calls.map(([, m]) => m.type);
|
|
expect(types).toContain("replace-with-keyframes");
|
|
expect(types).not.toContain("add-keyframe");
|
|
});
|
|
|
|
it("still adds/updates a keyframe at the playhead when the toggle is on (default)", async () => {
|
|
usePlayerStore.setState({ autoKeyframeEnabled: true, currentTime: 2 });
|
|
const commitMutation = vi.fn();
|
|
const iframe = fakeIframe("puck-b", []);
|
|
|
|
const handled = await tryGsapDragIntercept(
|
|
selection,
|
|
{ x: -50, y: 0 },
|
|
[keyframedPositionAnim],
|
|
iframe,
|
|
commitMutation,
|
|
);
|
|
|
|
expect(handled).toBe(true);
|
|
const types = commitMutation.mock.calls.map(([, m]) => m.type);
|
|
expect(types).not.toContain("replace-with-keyframes");
|
|
});
|
|
});
|