Files
hyperframes/packages/studio/src/hooks/useElementLifecycleOps.test.tsx
T
Ular KimsanovandMiguel Angel Simon Sierra 89db718899 feat(studio): mirror canvas z-order actions into timeline lanes (track order = default paint order) (#2380)
* feat(studio): mirror canvas z-order actions into timeline lanes, badge z overrides

Track order = default paint order; authored z = advanced override.

- timelineZMirror.ts: pure resolver mapping a successful z-menu action to a
  timeline lane move — closest track in the action's direction that is free
  over the clip's whole span, else a new lane adjacent to the crossed
  neighbor; temporal-overlap scope (default pending product sign-off, see
  module doc); visual zone only; same-file reference scoping; persistTrack
  via the shared authored-space rules. null for non-clips (menu stays
  z-only) and at-extreme/no-overlap cases.
- useCanvasZOrderTimelineMirror.ts: after the z commit resolves, the mirror
  persists the lane move through the same machinery as a timeline lane drag
  (optimistic store update, authoredTrack refresh, rollback); inserts reuse
  commitTrackInsert's renumber via a shared buildTrackInsertEdits core. Both
  writes share one coalesce key (zReorderCoalesceKey) and fold into ONE undo
  entry (test proves it over the real history reducer). The mirror never
  triggers the lane->z stacking sync, so it cannot fight the z values the
  action just set.
- timelineZOverride.ts + TimelineClip badge: clips whose paint order
  contradicts lane order among temporally-overlapping same-context visual
  neighbors (laneIsAbove XOR paintsAbove, the stacking-sync predicates) show
  a 'z' badge — authored z overrides are surfaced instead of silently
  disagreeing with the timeline.
- Timeline.tsx track derivations extracted to useTimelineTrackDerivations
  (600-line cap).

* fix(studio): fold mirrored z-order gestures into one undo entry across slow persists

Live verification caught the z write and the mirrored lane write splitting
into two undo entries: the mirror runs after the z persist's server round
trip, which exceeds editHistory's default 300ms coalesce window under real
latency (the unit test's deterministic clock sat inside it).

zReorderCoalesceKey now mints a per-gesture-unique key (monotonic seq, the
laneChangeGestureSeq precedent) and both records carry coalesceMs Infinity —
distinct gestures can never merge, and one gesture always folds regardless
of write latency. coalesceMs threaded through the persist chain alongside
coalesceKey. Also hardens the existing lane-drag move->z fold, which had the
same latent split. Fold test now simulates a 400ms gap (failed before the
fix, passes after); a two-separate-gestures test asserts two entries.

* feat(studio): flashless lane mirror, z-order menu icons, close-gap track menu

- Track-only batch moves (the z-mirror's lane hop and the insert renumber)
  skip the GSAP fallback round-trip and the preview reload entirely — the
  renderer never reads data-track-index, and the live DOM patch + optimistic
  store update cover the UI. Mixed batches keep current behavior. Kills the
  canvas blink on mirrored Bring/Send actions (live-verified: an
  iframe-scoped marker survives the whole gesture).
- The four z-order menu items get 16px stroke icons (single layer diamond +
  directional arrow for Forward/Backward; pierced two-layer stack for
  Front/Back); labels unchanged — they are the industry-standard names.
- New track context menu on empty lane space: 'Close gap' (shifts the next
  clip and every clip after it on that lane left by the clicked gap's width;
  leading gaps count, so a single clip with empty space before it compacts
  to 0) and 'Close all gaps' (whole lane contiguous from 0). Pure gap math
  in timelineGaps.ts; persists through the drag path's atomic batch move
  (one undo per action); refuses when a clip that must shift is locked;
  items disable when there is nothing to close.

* fix(studio): rebind-only preview sync for unmutated timing edits, classical z-menu order

Timing edits that rewrote NO GSAP positions (gap closes and moves of
selector-addressed caption clips, zero-delta batches, comps without a
rewritable script) full-reloaded the preview — and the rerun-current-scripts
attempt was wrong for real compositions: re-executing init-style scripts
(three.js scenes, caption engines) is exactly the unsafe case, verified live
by doubled init warnings and a fallback reload anyway.

The correct observation: when mutated === false the existing __timelines are
still valid — only the runtime's clip visibility windows are stale, and the
live DOM timing attributes were already patched. So the no-mutation path now
runs applySoftReloadFinalization only (seek + __hfForceTimelineRebind +
manual-edits reapply), extracted from the soft-reload machinery — zero
script execution. This also un-blinks comps with no GSAP script at all,
which previously always remounted. Rewritten-script soft reloads,
cannot-soft-reload, otherFileChanged, and mutation failures keep their
existing behavior. gsapSoftReload's undo/redo restore section moved verbatim
to gsapUndoRestore.ts for the 600-line cap.

Also: z-order menu items reordered to the classical arrangement (Bring to
Front, Bring Forward, Send Backward, Send to Back).

Live-verified on a three.js-heavy composition: Close-all-gaps shifted 4
caption clips with correct cumulative amounts, the preview iframe was never
remounted (marker survived), and one undo reverted everything.

* fix(studio): bound forward/backward mirror to a one-element step

User-specified semantic: Bring Forward / Send Backward move the clip past
EXACTLY ONE element. The mirror's lane target is now bounded by the next
temporally-overlapping element beyond the crossed neighbor: a free lane
strictly between the two is taken (closest to the neighbor), and when they
are back-to-back a new track is inserted immediately beyond the crossed
element — never past the second one. Previously the resolver took the
closest free lane anywhere beyond the neighbor, which could carry the track
past a second element while the z action only stepped past one — a
track/paint contradiction our own zOverride badge would flag. Front/back
keep whole-set semantics (past everything; back stays above the audio
zone). End-to-end test pins the 3-stacked case through commitZMirrorLaneMove
to the persisted renumbered tracks.

* feat(studio): permanent gap-menu rows with hover and click-select gap highlights

- TrackGapContextMenu always renders both rows; an inapplicable action dims
  with a tooltip ("No gap here" / lock reason / "No gaps on this track")
  instead of vanishing into a one-item menu. Width badge only when a gap
  exists under the pointer.
- Hovering an ACTIONABLE row highlights the strip(s) it would close in the
  timeline: the single gap for Close gap, every current gap (leading included)
  for Close all gaps. New resolveAllGapIntervals in timelineGaps.ts reports
  present-state intervals (epsilon-tolerant, overlap-safe), distinct from
  resolveAllTrackGaps' post-compaction starts.
- Click-selecting a single clip paints a quieter tint over its lane's gaps
  (suppressed for marquee multi-selection and during drags; the gap-menu hover
  wins on its own lane). Derivation lives in useTimelineGapHighlights with the
  pure buildTimelineGapStrips exported and unit-tested.
- Strips render in TimelineCanvas with the drop-placeholder geometry (row top
  + clip inset), dashed accent for hover, faint tint for selection.
- Timeline.tsx stayed under the 600-line cap by extracting the scroll-viewport
  plumbing (ResizeObserver width + shortcut-hint sync) into
  useTimelineScrollViewport, behavior unchanged.

* feat(studio): stronger capcut-style timeline zoom steps

One button press / pinch gesture now moves the zoom meaningfully: step
factors 1.25x/0.8x -> 1.5x/(2/3) (kept reciprocal so in+out round-trips) and
pinch sensitivity 0.0035 -> 0.007. Addresses "zooming several times to get
anywhere" feedback; cursor anchoring unchanged.

* feat(studio): three-way z sync — layers drags mirror timeline lanes, panel tracks live z edits

Completes the layers/canvas/timeline sync triangle: the Layers panel was the
one surface whose reorders never reached the timeline, and the one that went
stale when the other two wrote z flashlessly.

- Layers drag -> minimal z + equal-jump lane mirror. handleReorder now uses
  the canvas menu's realization core via resolveZOrderReposition (one
  between-z write when a strict gap exists, band-safe scoped renumber
  otherwise) instead of computeReorderZValues' all-sibling stamp — that
  helper is deleted, completing the #2347 unification follow-up. The drop
  then mirrors into a timeline lane move through the same machinery as the
  canvas menu (new resolveRepositionLaneMove: the clip lands on a free lane
  strictly between its NEW paint neighbors' lanes — nearest clip siblings in
  the desired render order, decorations skipped — else a track insert at
  that boundary; audio zone never crossed). Both writes share one
  per-gesture zReorderCoalesceKey with an unbounded fold window, so a drag
  is exactly ONE undo entry; useCanvasZOrderTimelineMirror's plumbing is
  factored into useMirrorLaneMoveCommit and reused by the new
  useLayerReorderTimelineMirror. A same-slot drop is a hard no-op (new
  order-equality guard in resolveZOrderReposition).
- Panel staleness fix: flashless z commits (skipReload) reload nothing and
  bump no refreshKey, so the panel's z-sorted order went stale while paused.
  handleDomZIndexReorderCommit now bumps a store zEditVersion on apply AND
  rollback; the panel re-collects on it. Verified live: the panel re-sorts
  the instant a drag commits and again on undo.
- Layer click reveal (useLayerRevealOverride): clicking a layer that stays
  hidden at the current frame (animation-parked opacity, non-clip
  display/visibility hides, hidden ancestors) temporarily forces the chain
  visible with live inline styles — exact priors restored on deselect, on
  another reveal, on play, and on unmount; never persisted (file diff == 0
  verified live). Clips keep the existing seek-into-window behavior; the
  override applies on a short defer so a seek-revealed clip needs none.
- layerOrdering's unused hasExplicitZIndex probe (zero callers) removed.

Live-verified on a bed copy: a 2-position layers drag wrote exactly one
element (z 6->23 + data-track-index 15->2), the timeline lane moved without
a reload, and a single Cmd+Z restored the file byte-identically.

* feat(studio): full-track selection highlight, borderless gap hover strips

- Click-selecting a clip now lights the WHOLE lane minus its clips — leading
  gap, inter-clip gaps, and the open space after the last clip to the rendered
  end (new resolveLaneEmptyIntervals; displayDuration threaded into the strip
  derivation). Still click-only: any drag/resize suppresses the strips, and a
  marquee multi-select never shows them.
- The gap-menu hover strips drop the dashed border (user feedback) — fill only,
  nudged to 0.18 alpha to keep the same visual weight.

* feat(studio): selected layer paints on top via a reader-transparent z lift

Clicking a layer in the Layers tab now shows the element as if it were at the
very top of the stack while selected — whatever its authored z or panel
position — extending the reveal override (which already forced hidden chains
visible) with a temporary inline z lift:

- liftElementToTop parks the TRUE effective z in data-hf-reveal-prior-z and
  writes a far-top inline z; a static element gets a layout-preserving
  position:relative with its prior parked in data-hf-reveal-prior-pos. Only
  the RENDERER sees the lift: all three studio z readers
  (readTimelineElementZIndex, getElementZIndex, readEffectiveZIndex) return
  the parked prior while the attribute is present, so the canvas z-menu, the
  zOverride badge, the lane mirror, the stacking sync, and the panel sort
  keep reasoning on the element's real z.
- Strictly ephemeral: exact priors restored on deselect / another reveal /
  play / unmount, each property only while it still holds the value the
  override wrote (a later real edit is never clobbered). File diff == 0
  verified live across a full lift/restore cycle.
- A z-reorder commit CONSUMES an active lift (handleDomZIndexReorderCommit
  reads the parked position for its persist-position:relative static check,
  then drops the attributes) — the committed z becomes the truth and the
  later restore is a guarded no-op.

* fix(studio): flashless undo/redo — three full-reload causes in the soft-restore path

Cmd+Z blinked the canvas on essentially every undo. Three independent causes
in applyUndoRestoreToPreview, each sufficient on its own:

1. Master-view path gate: activeCompPath is NULL at the master view, so the
   'paths[0] === activeCompPath' eligibility check could never match the
   index.html restore and every default-view undo full-reloaded at the first
   gate. Normalized to the codebase-wide 'activeCompPath ?? "index.html"'.
2. Nested identity innerHTML check: the diff compared each identified
   element's innerHTML, but the composition root wraps every clip — any child
   change re-detected at the root rejected the restore. Change detection now
   compares only each element's OWN attribute surface; structure/text
   integrity is still guaranteed by the normalize-residual whole-doc pass
   (text nodes, added/removed elements, and un-identified attrs all remain
   after normalization and force the full reload).
3. id-only identity: elements addressed by data-hf-id / selector (no DOM id)
   fell outside the diff entirely. Identity is now id OR data-hf-id, with the
   live sync resolving either.

Also stop re-running an UNCHANGED GSAP script: attribute-only restores (z,
lane, timing, style — the overwhelmingly common undo) now use the rebind-only
finalization (seek + __hfForceTimelineRebind + manual reapply, zero script
execution — the same path as flashless timing edits), instead of tearing down
and rebuilding live timelines or full-reloading when the script can't be
scoped. A restore whose script text genuinely changed still re-runs it via
applySoftReload, and structural restores (split/delete) still full-reload.

Live-verified on the bed (iframe marker): gap-close undo AND redo both keep
the iframe mounted, live DOM lands on the restored values, disk restored
byte-identically.

* feat(studio): left breathing pad before t=0, double zoom sensitivity again

TRACKS_LEFT_PAD (48px) — the horizontal sibling of TRACKS_TOP_PAD: empty lane
surface between the sticky gutter and the ruler's 00:00 / the first clips,
scrolling WITH the content.

- The lanes and the ruler realize it as a plain flow spacer between the
  sticky gutter cell and the time-mapped content div, so every
  content-relative computation (clip left = t*pps, beat lines, lane-menu
  time, clip drag deltas) is untouched by construction.
- Canvas-space overlays shift by the pad: playhead (getTimelinePlayheadLeft),
  gap strips, drop placeholder, snap guide, range highlight, marquee clip
  rects, beat SVG; the insert line spans the pad.
- Every pointer->time inverse subtracts it symmetrically: seekFromX, razor,
  range/marquee anchors, asset drops, and the zoom-anchor gutter basis; fit
  pps and the display width account for the consumed viewport width.
- Live-verified: t=0 clip edge, the 00:00 tick, and the playhead line center
  all sit at GUTTER + TRACKS_LEFT_PAD, and a ruler click lands the playhead
  center exactly under the pointer.

Also doubles the timeline zoom sensitivity again (user feedback after
feel-testing the first bump): button steps 1.5x/(2/3) -> 2x/0.5, pinch
0.007 -> 0.014.

* fix(studio): left pad renders as true empty space, not lane surface

The pad before t=0 inherited each row's background and bottom border from the
row wrapper, so it read as track lanes. Lane visuals now live on the cells:
the sticky gutter keeps its own separator (header column stays delineated),
the time-mapped content div carries the row background + separator, and the
pad spacer stays transparent — bare shell background, no lines. The
new-track insertion line also starts at the pad's end instead of crossing it.

* fix(studio): no vertical line in the ruler band before 00:00

The ruler corner's right border drew the header-boundary line through the
ruler strip, so the band didn't read as starting at 00:00. Dropped it — the
boundary line belongs to the track rows below; the ruler stays completely
clean from the panel edge to the first tick, matching the empty left pad.

* refactor(studio): remove the timeline z-override badge

User decision: the "z" chip on clips never earned its place — dropped
entirely (timelineZOverride.ts + test deleted, TimelineClip badge rendering
and the zOverrideKeys derivation/threading removed). This also eliminates the
review's D2 finding at the root: the badge's cross-document comparison
(stackingContextId ?? null collides across source files in the expanded view)
produced false positives, and there is no longer a detector to mis-fire.
overlapsInTime/paintsAbove lose their export (the badge was their only
external consumer); the paint-order predicate itself is unchanged.

* fix(studio): collision-free expanded child lanes and host-window gap floors

Review findings D1 (blocker) and 4.

- D1: buildChildElements assigned expanded children synthetic display rows as
  `host.track + index` — integers that can EQUAL a real clip's lane in another
  file (host on 0 with two children puts child #2 on 1). Lane grouping merges
  purely by track number, so the collision fused clips from different source
  files into one display lane, and lane-scoped actions (the gap menu) then
  batch-persisted a foreign file's clip. Children now take FRACTIONS strictly
  between the host's lane and the next integer — structurally unable to
  collide with any normalized lane, while still rendering as ordered rows
  under the host. Regression test pins the reviewer's exact two-file scenario.
- Finding 4: gap math compacted toward absolute 0, but an expanded child's
  display time is host-anchored — close/compact could drag it before its host
  window and persist a wrong (even negative) local time. All gap functions
  now take a lane FLOOR (laneGapFloor: 0 for ordinary lanes, the children's
  expandedParentStart for child lanes — single-origin per lane post-D1),
  threaded through the menu model, hover highlights, selected-lane strips,
  and both commits. Close-gap shifts clamp at the gap's own left edge.

* fix(studio): scope mirror references, insert writes, and crossed-neighbor identity

Review findings 1, 2, and 3.

- Finding 1: buildTrackInsertEdits normalized the FULL display set and
  persisted every shifted clip — writing host-lane numbers into OTHER
  composition files when expanded children were showing. The renumber write
  set is now the edited element's own source file (the sanctioned multi-write
  converges one FILE to lane space, never neighbors' files); foreign clips
  keep their authored tracks and re-derive display lanes. The locked-clip
  refusal scopes the same way. Expanded-origin elements refuse the insert
  outright (a new lane is a host-space renumber, meaningless in the child's
  file), and the mirrors restrict an expanded child's lane candidates to its
  own siblings' lanes — a sub-comp child still mirrors WITHIN its sub-comp
  (persisting the sibling's authored track) but can never land on a host lane
  with no same-file occupant. authoredTrackForLane's offset fallback rounds:
  fractional synthetic rows must never leak fractions into data-track-index.
- Finding 2: the mirror comparison sets required only sameSourceFile, but a
  file can contain several CSS stacking contexts and leaf z is only
  comparable within one. Both resolvers now scope by samePaintScope — same
  source file AND same stackingContextId (the file check also stops null root
  contexts of different files from comparing equal in the expanded view).
- Finding 3: the crossed-neighbor key was derived without selectorIndex, so
  duplicate class selectors (.sub) resolved to occurrence 0 — a different
  clip. The key now carries getSelectorIndex, matching how z-reorder entries
  derive theirs.

* fix(studio): z-to-lane gestures are one serialized transaction gated on durable persists

Review findings 5 and 7.

- Finding 5: commitDomEditPatchBatches resolved successfully even when the
  server matched NO patch target — the z write never reached disk (the
  preview reloads to reconverge) yet the lane mirror still ran, desyncing
  track order from what actually paints. The commit now resolves a durability
  report ({allMatched, changed}; the save queue and commit types are generic
  over the result), and the mirror phase is skipped on allMatched === false.
- Finding 7: the z persist rides the DOM-edit save queue while the lane move
  rides the timeline/SDK path — two queues, so a second rapid gesture's z
  write could land BETWEEN the first gesture's z and lane phases. Every
  z-to-lane gesture (canvas z-order menu AND Layers-panel drag) now runs
  through runZLaneGesture: a single module-level tail that serializes the
  COMPLETE two-phase transaction, with unit tests for ordering, the
  durability gate, and queue resilience to failed gestures. The timeline
  lane-drag's inverse (move-then-z-sync) shares its phases' await ordering
  already; cross-gesture serialization for that path is noted as follow-up.
- LayersPanel's pure sort helpers moved to layersPanelSort.ts (600-line cap).

* fix(studio): multi-clip GSAP batch mutations roll back on late failure

Review finding 6. finishGroupTimingGsapFallback mutates files sequentially
per clip; a late per-clip failure left the earlier rewrites on disk with no
aggregate history entry — unreachable by undo. foldGsapMutationIntoHistory
already snapshots every touched path before mutating; on a mutation failure
it now restores each path whose disk content changed (all-or-nothing batch),
reports restore errors without masking the original failure, and rethrows.
Regression test drives a two-clip batch whose second rewrite fails and
asserts the first clip's write is restored byte-identically.

* fix(studio): scope mirror inserts to their lane zone

* fix(studio): unify source-scoped clip identity

* fix(studio): isolate track insert topology

* fix(studio): harden timeline paint synchronization

---------

Co-authored-by: Miguel Angel Simon Sierra <miguel.sierra@heygen.com>
2026-07-14 14:31:58 -04:00

790 lines
26 KiB
TypeScript

// @vitest-environment happy-dom
import React, { act } from "react";
import { afterEach, describe, expect, it, vi } from "vitest";
import { usePlayerStore } from "../player";
import {
LAYER_REVEAL_PRIOR_POSITION_ATTR,
LAYER_REVEAL_PRIOR_Z_ATTR,
} from "../player/lib/timelineElementHelpers";
import {
LAYER_REVEAL_LIFT_Z,
LAYER_REVEAL_PENDING_COMMIT_ATTR,
liftElementToTop,
restoreLiftedElement,
useLayerRevealOverride,
} from "../components/editor/useLayerRevealOverride";
import type { DomEditPatchBatch, DomEditPatchBatchesResult } from "./domEditCommitTypes";
import { useElementLifecycleOps } from "./useElementLifecycleOps";
import { makeLifecycleOpsParams } from "./elementLifecycleOpsTestUtils";
import { mountReactHarness } from "./domSelectionTestHarness";
import { runZLaneGesture } from "../components/nle/zLaneGesture";
(globalThis as unknown as { IS_REACT_ACT_ENVIRONMENT: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
afterEach(() => {
document.body.innerHTML = "";
usePlayerStore.getState().setElements([]);
vi.unstubAllGlobals();
vi.useRealTimers();
});
interface BatchOptions {
label: string;
coalesceKey: string;
coalesceMs?: number;
skipReload?: boolean;
}
interface CapturedBatchCall {
batches: DomEditPatchBatch[];
options: BatchOptions;
}
type ReorderCommit = (
entries: Array<{
element: HTMLElement;
zIndex: number;
id?: string;
selector?: string;
selectorIndex?: number;
sourceFile: string;
key?: string;
}>,
coalesceKeyOverride?: string,
actionKind?: string,
) => Promise<DomEditPatchBatchesResult | undefined | void>;
function renderReorderHook(
capturedCalls: CapturedBatchCall[],
onReady: (commit: ReorderCommit) => void,
) {
function Harness() {
const { handleDomZIndexReorderCommit } = useElementLifecycleOps(
makeLifecycleOpsParams({
commitDomEditPatchBatches: async (batches, options) => {
capturedCalls.push({ batches, options });
return { durable: true, allMatched: true, changed: true };
},
}),
);
onReady(handleDomZIndexReorderCommit);
return null;
}
return mountReactHarness(<Harness />);
}
/** Append the element, mount the reorder hook, and run one commit through act. */
async function runReorderCommit(el: HTMLElement, entries: Parameters<ReorderCommit>[0]) {
document.body.appendChild(el);
const captured: CapturedBatchCall[] = [];
let commit: ReorderCommit | undefined;
const root = renderReorderHook(captured, (fn) => (commit = fn));
await act(async () => {
commit!(entries);
});
return { captured, root };
}
describe("useElementLifecycleOps — z-index reorder payload", () => {
// Regression: an id-less canvas element (e.g. a caption `.sub` div, which
// carries only data-hf-id + class) once had its absent id coerced to `null`
// (`entry.id ?? null`). The DOM-patch guard rejects a null `body.target.id`,
// so "move to back" toasted "unsafe values" and nothing persisted. The target
// id must be `undefined` (dropped on the wire), letting hfId / selector match.
it("never sends a null target id for an id-less element", async () => {
const el = document.createElement("div");
el.className = "sub clip";
el.setAttribute("data-hf-id", "hf-card");
const { captured, root } = await runReorderCommit(el, [
{
element: el,
zIndex: 0,
// id intentionally absent — the id-less element case.
selector: ".sub.clip",
selectorIndex: 3,
sourceFile: "index.html",
},
]);
const target = captured[0]?.batches[0]?.patches[0]?.target;
expect(captured).toHaveLength(1);
expect(target?.id).toBeUndefined();
expect(target?.id).not.toBeNull();
// The element stays addressable via hfId (and selector) instead.
expect(target?.hfId).toBe("hf-card");
act(() => root.unmount());
});
it("requests skipReload on every z-reorder persist (live DOM already final)", async () => {
// The commit applies the z-index (and any injected position) to the live
// iframe DOM and the store synchronously, so the persisted style-only patch
// adds nothing the preview doesn't already show — the batch commit is asked
// to skip the iframe remount. commitDomEditPatchBatches still falls back to
// reloading when the server can't confirm every patch target matched.
const el = document.createElement("div");
el.id = "clip-z";
const { captured, root } = await runReorderCommit(el, [
{ element: el, zIndex: 4, id: "clip-z", sourceFile: "index.html" },
]);
expect(captured).toHaveLength(1);
expect(captured[0]?.options.skipReload).toBe(true);
act(() => root.unmount());
});
it("preserves a real id when the element has one", async () => {
const el = document.createElement("video");
el.id = "v-hero";
el.setAttribute("data-hf-id", "hf-ezl2");
const { captured, root } = await runReorderCommit(el, [
{ element: el, zIndex: 2, id: "v-hero", selector: "#v-hero", sourceFile: "index.html" },
]);
expect(captured).toHaveLength(1);
expect(captured[0]?.batches[0]?.patches[0]?.target.id).toBe("v-hero");
act(() => root.unmount());
});
it("threads the lane gesture key into z-index persistence", async () => {
const el = document.createElement("div");
el.id = "clip-a";
document.body.appendChild(el);
const captured: CapturedBatchCall[] = [];
let commit: ReorderCommit | undefined;
const root = renderReorderHook(captured, (fn) => (commit = fn));
await act(async () => {
await commit!(
[{ element: el, zIndex: 4, id: "clip-a", sourceFile: "index.html" }],
"clip-lane-move:7",
);
});
expect(captured).toHaveLength(1);
expect(captured[0]?.options.coalesceKey).toBe("clip-lane-move:7");
act(() => root.unmount());
});
it("creates one batch per source file in a multi-file reorder", async () => {
const elements = ["clip-a", "clip-b", "clip-c"].map((id) => {
const element = document.createElement("div");
element.id = id;
document.body.appendChild(element);
return element;
});
const captured: CapturedBatchCall[] = [];
let commit: ReorderCommit | undefined;
const root = renderReorderHook(captured, (fn) => (commit = fn));
await act(async () => {
await commit!(
elements.map((element, index) => ({
element,
zIndex: index + 1,
id: element.id,
sourceFile: index < 2 ? "index.html" : "compositions/scene.html",
})),
);
});
expect(captured).toHaveLength(1);
expect(
captured[0]?.batches.map(({ sourceFile, patches }) => [sourceFile, patches.length]),
).toEqual([
["index.html", 2],
["compositions/scene.html", 1],
]);
act(() => root.unmount());
});
it("keeps distinct actions in distinct default coalesce keys", async () => {
const el = document.createElement("div");
el.id = "clip-a";
document.body.appendChild(el);
const captured: CapturedBatchCall[] = [];
let commit: ReorderCommit | undefined;
const root = renderReorderHook(captured, (fn) => (commit = fn));
await act(async () => {
await commit!(
[{ element: el, zIndex: 1, id: "clip-a", sourceFile: "index.html" }],
undefined,
"bring-forward",
);
await commit!(
[{ element: el, zIndex: 0, id: "clip-a", sourceFile: "index.html" }],
undefined,
"send-backward",
);
});
// Same element set, different actions — the keys must differ so the two
// edits never coalesce into one undo step. Each key also carries a fresh
// gesture sequence, which is what makes the commit's unbounded per-gesture
// coalesce window safe (see zReorderCoalesceKey).
expect(captured).toHaveLength(2);
expect(captured[0]?.options.coalesceKey).toMatch(/^z-reorder:bring-forward:clip-a:g\d+$/);
expect(captured[1]?.options.coalesceKey).toMatch(/^z-reorder:send-backward:clip-a:g\d+$/);
expect(captured[0]?.options.coalesceKey).not.toBe(captured[1]?.options.coalesceKey);
// The two-phase gesture fold rides an unbounded window on both records.
expect(captured[0]?.options.coalesceMs).toBe(Number.POSITIVE_INFINITY);
act(() => root.unmount());
});
it("updates the store zIndex synchronously for entries that carry a store key", async () => {
const el = document.createElement("div");
el.id = "clip-a";
document.body.appendChild(el);
usePlayerStore.getState().setElements([
{
id: "clip-a",
key: "index.html#clip-a",
tag: "div",
start: 0,
duration: 1,
track: 0,
zIndex: 0,
hasExplicitZIndex: false,
},
]);
let commit: ReorderCommit | undefined;
let resolveBatch: (() => void) | undefined;
const batchResult = { durable: true, allMatched: true, changed: true };
function Harness() {
const { handleDomZIndexReorderCommit } = useElementLifecycleOps(
makeLifecycleOpsParams({
// Persist stays pending so the assertion below can only be satisfied
// by the SYNCHRONOUS store update (the lane-sync path's requirement).
commitDomEditPatchBatches: () =>
new Promise((resolve) => (resolveBatch = () => resolve(batchResult))),
}),
);
commit = handleDomZIndexReorderCommit;
return null;
}
const root = mountReactHarness(<Harness />);
let pending: Promise<unknown> | undefined;
act(() => {
pending = commit!([
{
element: el,
zIndex: 5,
id: "clip-a",
sourceFile: "index.html",
key: "index.html#clip-a",
},
]);
});
expect(usePlayerStore.getState().elements[0]).toMatchObject({
zIndex: 5,
hasExplicitZIndex: true,
});
resolveBatch?.();
await act(async () => pending);
act(() => root.unmount());
});
// The canvas context-menu path: the menu no longer pre-applies styles, so the
// hook sees the PRISTINE element — prior styles are captured before any
// mutation and a failed persist restores them exactly (previously the menu's
// optimistic write made the "rollback" restore the already-mutated values,
// and the never-persisted position patch silently reverted on reload).
it("rolls back a static, inline-style-free element to pristine styles on failure", async () => {
const el = document.createElement("div");
el.id = "clip-a";
el.style.position = "static"; // happy-dom computes "" for unset position
document.body.appendChild(el);
const failure = new Error("persist failed");
let commit: ReorderCommit | undefined;
function Harness() {
const { handleDomZIndexReorderCommit } = useElementLifecycleOps(
makeLifecycleOpsParams({
commitDomEditPatchBatches: vi.fn(async () => {
// The live styles were applied by the hook before persist ran.
expect(el.style.zIndex).toBe("2");
expect(el.style.position).toBe("relative");
throw failure;
}),
}),
);
commit = handleDomZIndexReorderCommit;
return null;
}
const root = mountReactHarness(<Harness />);
let rejection: unknown;
await act(async () => {
try {
await commit!(
[{ element: el, zIndex: 2, id: "clip-a", sourceFile: "index.html" }],
undefined,
"bring-forward",
);
} catch (error) {
rejection = error;
}
});
expect(rejection).toBe(failure);
expect(el.style.zIndex).toBe("");
expect(el.style.position).toBe("static");
act(() => root.unmount());
});
it("returns an active reveal lift and its original styles to their owner on failure", async () => {
const el = document.createElement("div");
el.id = "clip-a";
el.style.zIndex = "4";
el.style.position = "static";
document.body.appendChild(el);
const lift = liftElementToTop(el)!;
const failure = new Error("persist failed");
expect(el.style.zIndex).toBe(LAYER_REVEAL_LIFT_Z);
expect(el.style.position).toBe("relative");
expect(el.getAttribute(LAYER_REVEAL_PRIOR_Z_ATTR)).toBe("4");
expect(el.getAttribute(LAYER_REVEAL_PRIOR_POSITION_ATTR)).toBe("static");
expect(el.hasAttribute(LAYER_REVEAL_PENDING_COMMIT_ATTR)).toBe(false);
let commit: ReorderCommit | undefined;
function Harness() {
const { handleDomZIndexReorderCommit } = useElementLifecycleOps(
makeLifecycleOpsParams({
commitDomEditPatchBatches: vi.fn(async () => {
expect(el.style.zIndex).toBe("8");
expect(el.hasAttribute(LAYER_REVEAL_PRIOR_Z_ATTR)).toBe(false);
expect(el.hasAttribute(LAYER_REVEAL_PRIOR_POSITION_ATTR)).toBe(false);
throw failure;
}),
}),
);
commit = handleDomZIndexReorderCommit;
return null;
}
const root = mountReactHarness(<Harness />);
let rejection: unknown;
await act(async () => {
try {
await commit!([{ element: el, zIndex: 8, id: "clip-a", sourceFile: "index.html" }]);
} catch (error) {
rejection = error;
}
});
expect(rejection).toBe(failure);
// The failed optimistic commit must put the still-active lift back exactly
// as it found it, including the metadata that lets reveal cleanup restore
// the authored z/position rather than abandoning the temporary lift.
expect(el.style.zIndex).toBe(LAYER_REVEAL_LIFT_Z);
expect(el.style.position).toBe("relative");
expect(el.getAttribute(LAYER_REVEAL_PRIOR_Z_ATTR)).toBe("4");
expect(el.getAttribute(LAYER_REVEAL_PRIOR_POSITION_ATTR)).toBe("static");
expect(el.hasAttribute(LAYER_REVEAL_PENDING_COMMIT_ATTR)).toBe(false);
restoreLiftedElement(el, lift);
expect(el.style.zIndex).toBe("4");
expect(el.style.position).toBe("static");
act(() => root.unmount());
});
it("reconciles live, store, and reveal state when no patch target matched", async () => {
const el = document.createElement("div");
el.id = "clip-a";
el.style.zIndex = "4";
el.style.position = "static";
document.body.appendChild(el);
usePlayerStore.getState().setElements([
{
id: "clip-a",
tag: "div",
start: 0,
duration: 1,
track: 0,
zIndex: 4,
hasExplicitZIndex: true,
},
]);
const lift = liftElementToTop(el)!;
const unmatched = { durable: false, allMatched: false, changed: false };
let commit: ReorderCommit | undefined;
function Harness() {
({ handleDomZIndexReorderCommit: commit } = useElementLifecycleOps(
makeLifecycleOpsParams({
commitDomEditPatchBatches: vi.fn(async () => unmatched),
}),
));
return null;
}
const root = mountReactHarness(<Harness />);
let result: unknown;
await act(async () => {
result = await commit!([
{
element: el,
zIndex: 8,
id: "clip-a",
sourceFile: "index.html",
key: "clip-a",
},
]);
});
expect(result).toEqual(unmatched);
expect(el.style.zIndex).toBe(LAYER_REVEAL_LIFT_Z);
expect(el.style.position).toBe("relative");
expect(el.getAttribute(LAYER_REVEAL_PRIOR_Z_ATTR)).toBe("4");
expect(el.getAttribute(LAYER_REVEAL_PRIOR_POSITION_ATTR)).toBe("static");
expect(el.hasAttribute(LAYER_REVEAL_PENDING_COMMIT_ATTR)).toBe(false);
expect(usePlayerStore.getState().elements[0]).toMatchObject({
zIndex: 4,
hasExplicitZIndex: true,
});
restoreLiftedElement(el, lift);
expect(el.style.zIndex).toBe("4");
expect(el.style.position).toBe("static");
act(() => root.unmount());
});
it.each(["rejection", "unmatched"] as const)(
"defers a delayed reveal until a pending z commit finishes with %s",
async (outcome) => {
vi.useFakeTimers();
const el = document.createElement("div");
el.id = "clip-a";
el.style.zIndex = "4";
el.style.position = "absolute";
document.body.appendChild(el);
usePlayerStore.getState().setElements([
{
id: "clip-a",
tag: "div",
start: 0,
duration: 1,
track: 0,
zIndex: 4,
hasExplicitZIndex: true,
},
]);
let resolvePersist: ((result: DomEditPatchBatchesResult) => void) | undefined;
let rejectPersist: ((error: Error) => void) | undefined;
const persist = vi.fn(
() =>
new Promise<DomEditPatchBatchesResult>((resolve, reject) => {
resolvePersist = resolve;
rejectPersist = reject;
}),
);
let commit: ReorderCommit | undefined;
let scheduleReveal: ((element: HTMLElement, delayMs: number) => void) | undefined;
function Harness() {
({ scheduleReveal } = useLayerRevealOverride({
isPlaying: false,
selectedElement: el,
}));
({ handleDomZIndexReorderCommit: commit } = useElementLifecycleOps(
makeLifecycleOpsParams({ commitDomEditPatchBatches: persist }),
));
return null;
}
const root = mountReactHarness(<Harness />);
let pending: Promise<unknown> | undefined;
act(() => {
scheduleReveal!(el, 10);
pending = commit!([
{ element: el, zIndex: 8, id: "clip-a", sourceFile: "index.html", key: "clip-a" },
]);
vi.advanceTimersByTime(10);
});
// The timer elapsed, but it must not capture optimistic z=8 as authored.
expect(el.style.zIndex).toBe("8");
expect(el.hasAttribute(LAYER_REVEAL_PRIOR_Z_ATTR)).toBe(false);
let rejection: unknown;
await act(async () => {
if (outcome === "rejection") rejectPersist!(new Error("save failed"));
else resolvePersist!({ durable: false, allMatched: false, changed: false });
try {
await pending;
} catch (error) {
rejection = error;
}
});
if (outcome === "rejection") expect(rejection).toBeInstanceOf(Error);
act(() => vi.advanceTimersByTime(16));
expect(el.style.zIndex).toBe(LAYER_REVEAL_LIFT_Z);
expect(el.getAttribute(LAYER_REVEAL_PRIOR_Z_ATTR)).toBe("4");
expect(usePlayerStore.getState().elements[0]?.zIndex).toBe(4);
act(() => root.unmount());
},
);
it("serializes overlapping commits through the shared gesture owner", async () => {
const el = document.createElement("div");
el.id = "clip-a";
el.style.zIndex = "1";
document.body.appendChild(el);
usePlayerStore.getState().setElements([
{
id: "clip-a",
tag: "div",
start: 0,
duration: 1,
track: 0,
zIndex: 1,
hasExplicitZIndex: true,
},
]);
const firstFailure = new Error("first persist failed");
let rejectFirst: ((error: Error) => void) | undefined;
let resolveSecond: (() => void) | undefined;
const persist = vi
.fn()
.mockImplementationOnce(
() =>
new Promise<never>((_resolve, reject) => {
rejectFirst = reject;
}),
)
.mockImplementationOnce(
() =>
new Promise((resolve) => {
resolveSecond = () => resolve({ durable: true, allMatched: true, changed: true });
}),
);
let commit: ReorderCommit | undefined;
function Harness() {
({ handleDomZIndexReorderCommit: commit } = useElementLifecycleOps(
makeLifecycleOpsParams({ commitDomEditPatchBatches: persist }),
));
return null;
}
const root = mountReactHarness(<Harness />);
let firstPending: Promise<unknown> | undefined;
let secondPending: Promise<unknown> | undefined;
act(() => {
firstPending = runZLaneGesture({
commitZ: () =>
commit!([
{ element: el, zIndex: 2, id: "clip-a", sourceFile: "index.html", key: "clip-a" },
]),
mirror: async () => true,
});
secondPending = runZLaneGesture({
commitZ: () =>
commit!([
{ element: el, zIndex: 3, id: "clip-a", sourceFile: "index.html", key: "clip-a" },
]),
mirror: async () => true,
});
});
expect(persist).toHaveBeenCalledTimes(1);
expect(el.style.zIndex).toBe("2");
expect(usePlayerStore.getState().elements[0]?.zIndex).toBe(2);
let rejection: unknown;
await act(async () => {
rejectFirst!(firstFailure);
try {
await firstPending;
} catch (error) {
rejection = error;
}
await Promise.resolve();
});
expect(rejection).toBe(firstFailure);
expect(persist).toHaveBeenCalledTimes(2);
expect(el.style.zIndex).toBe("3");
expect(usePlayerStore.getState().elements[0]?.zIndex).toBe(3);
await act(async () => {
resolveSecond!();
await secondPending;
});
expect(el.style.zIndex).toBe("3");
expect(usePlayerStore.getState().elements[0]?.zIndex).toBe(3);
act(() => root.unmount());
});
it.each(["deselection", "playback"] as const)(
"does not resurrect a reveal released by %s while persistence is pending",
async (releaseBy) => {
vi.useFakeTimers();
const el = document.createElement("div");
el.id = "clip-a";
el.style.zIndex = "4";
el.style.position = "static";
const other = document.createElement("div");
document.body.append(el, other);
const failure = new Error("persist failed");
let rejectPersist: ((error: Error) => void) | undefined;
const persist = vi.fn(
() =>
new Promise<never>((_resolve, reject) => {
rejectPersist = reject;
}),
);
let commit: ReorderCommit | undefined;
let scheduleReveal: ((element: HTMLElement, delayMs: number) => void) | undefined;
function Harness({
selectedElement,
isPlaying,
}: {
selectedElement: HTMLElement | null;
isPlaying: boolean;
}) {
({ scheduleReveal } = useLayerRevealOverride({ isPlaying, selectedElement }));
({ handleDomZIndexReorderCommit: commit } = useElementLifecycleOps(
makeLifecycleOpsParams({ commitDomEditPatchBatches: persist }),
));
return null;
}
const root = mountReactHarness(<Harness selectedElement={el} isPlaying={false} />);
act(() => {
scheduleReveal!(el, 0);
vi.advanceTimersByTime(0);
});
expect(el.style.zIndex).toBe(LAYER_REVEAL_LIFT_Z);
let pending: Promise<unknown> | undefined;
act(() => {
pending = commit!([{ element: el, zIndex: 8, id: el.id, sourceFile: "index.html" }]);
});
expect(el.style.zIndex).toBe("8");
expect(el.hasAttribute(LAYER_REVEAL_PENDING_COMMIT_ATTR)).toBe(true);
act(() => {
root.render(
<Harness
selectedElement={releaseBy === "deselection" ? other : el}
isPlaying={releaseBy === "playback"}
/>,
);
});
let rejection: unknown;
await act(async () => {
rejectPersist!(failure);
try {
await pending;
} catch (error) {
rejection = error;
}
});
expect(rejection).toBe(failure);
expect(el.style.zIndex).toBe("4");
expect(el.style.position).toBe("static");
expect(el.hasAttribute(LAYER_REVEAL_PRIOR_Z_ATTR)).toBe(false);
expect(el.hasAttribute(LAYER_REVEAL_PRIOR_POSITION_ATTR)).toBe(false);
expect(el.hasAttribute(LAYER_REVEAL_PENDING_COMMIT_ATTR)).toBe(false);
act(() => root.unmount());
},
);
it("rolls back only live and store state after an atomic reorder failure", async () => {
const writeProjectFile = vi.fn(async () => {});
const recordEdit = vi.fn(async () => {});
const forceReloadSdkSession = vi.fn();
const originalError = new Error("second patch failed");
const elements = ["clip-a", "clip-b", "clip-c"].map((id, index) => {
const element = document.createElement("div");
element.id = id;
element.style.zIndex = String(index + 10);
document.body.appendChild(element);
return element;
});
usePlayerStore.getState().setElements(
elements.map((element, index) => ({
id: element.id,
tag: "div",
start: 0,
duration: 1,
track: index,
zIndex: index + 10,
hasExplicitZIndex: false,
})),
);
let commit: ReorderCommit | undefined;
function Harness() {
const { handleDomZIndexReorderCommit } = useElementLifecycleOps(
makeLifecycleOpsParams({
writeProjectFile,
editHistory: { recordEdit },
projectIdRef: { current: "demo" },
forceReloadSdkSession,
commitDomEditPatchBatches: vi.fn(async () => {
throw originalError;
}),
}),
);
commit = handleDomZIndexReorderCommit;
return null;
}
const root = mountReactHarness(<Harness />);
let rejection: unknown;
await act(async () => {
try {
await commit!(
elements.map((element, index) => ({
element,
zIndex: 3 - index,
id: element.id,
sourceFile: "index.html",
key: element.id,
})),
"clip-lane-move:failure",
);
} catch (error) {
rejection = error;
}
});
expect(rejection).toBe(originalError);
expect(elements.map((element) => element.style.zIndex)).toEqual(["10", "11", "12"]);
expect(
usePlayerStore
.getState()
.elements.map(({ zIndex, hasExplicitZIndex }) => ({ zIndex, hasExplicitZIndex })),
).toEqual([
{ zIndex: 10, hasExplicitZIndex: false },
{ zIndex: 11, hasExplicitZIndex: false },
{ zIndex: 12, hasExplicitZIndex: false },
]);
expect(writeProjectFile).not.toHaveBeenCalled();
expect(recordEdit).not.toHaveBeenCalled();
expect(forceReloadSdkSession).not.toHaveBeenCalled();
act(() => root.unmount());
});
});