Skip to content

Commit f52398c

Browse files
perf(studio): stabilize virtualized clip gestures (#2704)
1 parent cbd8a77 commit f52398c

19 files changed

Lines changed: 851 additions & 257 deletions

‎packages/studio/src/player/components/Timeline.tsx‎

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ import {
2929
import { useTimelineKeyframeHandlers } from "./useTimelineKeyframeHandlers";
3030
import { useTrackGapMenu } from "./useTrackGapMenu";
3131
import { useTimelineGapHighlights } from "./useTimelineGapHighlights";
32-
import { useStudioPlaybackContextOptional } from "../../contexts/StudioContext";
3332
import { TimelineRazorGuide, useTimelineRazorInteraction } from "./TimelineRazorInteraction";
3433
import { useTimelinePerformanceTelemetry } from "./useTimelinePerformanceTelemetry";
3534
import {
@@ -45,6 +44,7 @@ import { getTimelineElementIdentity } from "../lib/timelineElementHelpers";
4544
import { useTimelineRowVirtualization } from "./useTimelineRowVirtualization";
4645
import { useTimelineClipRenderWindow } from "./useTimelineClipRenderWindow";
4746
import { useTimelineActiveClips } from "./useTimelineActiveClips";
47+
import { useTimelineLaneMoveRefresh } from "./useTimelineLaneMoveRefresh";
4848

4949
export {
5050
shouldAutoScrollTimeline,
@@ -106,11 +106,7 @@ export const Timeline = memo(function Timeline({
106106
onSplitElement: onSplitElementOverride,
107107
});
108108
const theme = useMemo(() => ({ ...defaultTimelineTheme, ...themeOverrides }), [themeOverrides]);
109-
const playbackContext = useStudioPlaybackContextOptional();
110-
const setRefreshKey = playbackContext?.setRefreshKey;
111-
const refreshAfterLaneMove = useCallback(() => {
112-
setRefreshKey?.((key) => key + 1);
113-
}, [setRefreshKey]);
109+
const refreshAfterLaneMove = useTimelineLaneMoveRefresh();
114110
useMusicBeatAnalysis();
115111
const rawElements = usePlayerStore((s) => s.elements);
116112
const expandedElements = useExpandedTimelineElements();
@@ -129,14 +125,8 @@ export const Timeline = memo(function Timeline({
129125
const clipRevealRequest = usePlayerStore((s) => s.clipRevealRequest);
130126
const focusedEaseSegment = usePlayerStore((s) => s.focusedEaseSegment);
131127
const gsapAnimations = usePlayerStore((s) => s.gsapAnimations);
132-
const hasKeyframedClips = useMemo(
133-
() => hasKeyframedTimelineClips(gsapAnimations),
134-
[gsapAnimations],
135-
);
136-
const labelMode = hasKeyframedClips;
137-
// Without the label column the pre-t=0 breathing room is still TRACKS_LEFT_PAD
138-
// (dropping it would jam clip 0 against the gutter on every non-keyframed
139-
// composition); in label mode the 232px label column already provides it.
128+
const labelMode = useMemo(() => hasKeyframedTimelineClips(gsapAnimations), [gsapAnimations]);
129+
// The label column provides pre-t=0 space; otherwise keep TRACKS_LEFT_PAD after the gutter.
140130
const contentOrigin = labelMode ? LABEL_COL_W + GUTTER : GUTTER + TRACKS_LEFT_PAD;
141131
const contentGutter = labelMode ? GUTTER : 0;
142132
const setSelectedElementId = usePlayerStore((s) => s.setSelectedElementId);
@@ -236,7 +226,6 @@ export const Timeline = memo(function Timeline({
236226
setResizingClip,
237227
blockedClipRef,
238228
suppressClickRef,
239-
syncClipDragAutoScroll,
240229
} = useTimelineClipDrag({
241230
scrollRef,
242231
ppsRef,
@@ -253,6 +242,7 @@ export const Timeline = memo(function Timeline({
253242
readZIndex: zSyncEnabled ? readClipZIndex : undefined,
254243
onStackingPatches: zSyncEnabled ? applyStackingPatches : undefined,
255244
refreshAfterLaneMove,
245+
sessionEpoch,
256246
});
257247

258248
const { isDragOver, handleAssetDragOver, handleAssetDrop, clearDropPreview } =
@@ -269,6 +259,9 @@ export const Timeline = memo(function Timeline({
269259
onCompositionDrop: pinnedOnCompositionDrop,
270260
});
271261
const displayLayout = useTimelineDisplayLayout(draggedClip, trackOrder, rowGeometry);
262+
const resizingElementIds =
263+
resizingClip?.groupPreview?.map((change) => change.key) ??
264+
(resizingClip ? [getTimelineElementIdentity(resizingClip.element)] : undefined);
272265
const { recordTimelineScroll } = useTimelinePerformanceTelemetry({
273266
totalClipCount: expandedElements.length,
274267
totalRowCount: displayLayout.displayTrackOrder.length,
@@ -289,7 +282,7 @@ export const Timeline = memo(function Timeline({
289282
selectedElementId,
290283
revealElementId: clipRevealRequest?.elementId ?? null,
291284
draggedRowKey: draggedClip?.started ? draggedClip.previewTrack : undefined,
292-
resizingRowKey: resizingClip?.element.track,
285+
resizingElementIds,
293286
clipContextMenuRowKey: clipContextMenu?.element.track,
294287
keyframeContextMenuRowKey: kfContextMenu?.element.track,
295288
lastScrollLeftRef,
@@ -332,7 +325,7 @@ export const Timeline = memo(function Timeline({
332325
duration: displayDuration,
333326
selectedElementId: selectedElementId ?? undefined,
334327
draggedElementId: draggedClip ? getTimelineElementIdentity(draggedClip.element) : undefined,
335-
resizingElementId: resizingClip ? getTimelineElementIdentity(resizingClip.element) : undefined,
328+
resizingElementIds,
336329
revealElementId: clipRevealRequest?.elementId,
337330
focusedEaseElementId: focusedEaseSegment?.elementId,
338331
clipContextMenuElementId: clipContextMenu
@@ -468,6 +461,7 @@ export const Timeline = memo(function Timeline({
468461
>
469462
<div
470463
ref={setScrollRef}
464+
// Stable owner for gestures that must survive virtual row/clip unmounts.
471465
data-timeline-scroll-viewport
472466
data-timeline-auto-scroll-left-inset={labelMode ? LABEL_COL_W : 0}
473467
tabIndex={-1}
@@ -541,7 +535,6 @@ export const Timeline = memo(function Timeline({
541535
setResizingClip={setResizingClip}
542536
setDraggedClip={setDraggedClip}
543537
setSelectedElementId={setSelectedElementId}
544-
syncClipDragAutoScroll={syncClipDragAutoScroll}
545538
shiftClickClipRef={shiftClickClipRef}
546539
getPreviewElement={getPreviewElement}
547540
getTrackStyle={getTrackStyle}

‎packages/studio/src/player/components/TimelineCanvas.tsx‎

Lines changed: 14 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
import { memo } from "react";
22
import { TimelineRuler } from "./TimelineRuler";
33
import { PlayheadIndicator } from "./PlayheadIndicator";
4-
import { getTimelineEditCapabilities, type TimelineRangeSelection } from "./timelineEditing";
5-
import { getRenderedTimelineElement } from "./timelineTheme";
4+
import type { TimelineRangeSelection } from "./timelineEditing";
65
import {
76
RULER_H,
87
CLIP_Y,
@@ -19,13 +18,11 @@ import type { ResizingClipState } from "./useTimelineClipDrag";
1918
import { type MultiDragPreviewInput } from "./timelineMultiDragPreview";
2019
import { useTimelineEditContextOptional } from "../../contexts/TimelineEditContext";
2120
import type { Rect } from "../../utils/marqueeGeometry";
22-
import { TimelineClip } from "./TimelineClip";
2321
import { TimelineLanes } from "./TimelineLanes";
2422
import type { TimelineLaneBaseProps } from "./timelineLaneProps";
25-
import { renderClipChildren } from "./timelineClipChildren";
2623
import type { TimelineLaneGapStrips } from "./useTimelineGapHighlights";
27-
import { isTimelineClipActive } from "./useTimelineActiveClips";
2824
import { getTimelineElementIdentity } from "../lib/timelineElementHelpers";
25+
import { TimelineGestureOverlay } from "./TimelineGestureOverlay";
2926

3027
interface TimelineCanvasProps extends TimelineLaneBaseProps {
3128
major: number[];
@@ -65,15 +62,6 @@ export const TimelineCanvas = memo(function TimelineCanvas(props: TimelineCanvas
6562
const beatDragging = usePlayerStore((s) => s.beatDragging);
6663
const draggedElement = draggedClip?.element ?? null;
6764
const draggedElementIdentity = draggedElement ? getTimelineElementIdentity(draggedElement) : null;
68-
const activeDraggedElement =
69-
draggedClip?.started === true && draggedElement && draggedElementIdentity
70-
? getRenderedTimelineElement({
71-
element: draggedElement,
72-
draggedElementId: draggedElementIdentity,
73-
previewStart: draggedClip.previewStart,
74-
previewTrack: draggedClip.previewTrack,
75-
})
76-
: null;
7765
// The drag ghost follows the cursor freely (both axes) — CapCut-style. The
7866
// "magnetic" affordance is a highlight on the destination lane (draggedRowIndex),
7967
// which flips at the MAGNETIC_TRACK_THRESHOLD point; the clip drops into it.
@@ -94,22 +82,6 @@ export const TimelineCanvas = memo(function TimelineCanvas(props: TimelineCanvas
9482
selectedKeys: selectedElementIds,
9583
}
9684
: null;
97-
const activeDraggedPosition =
98-
draggedClip?.started === true && activeDraggedElement && scrollRef.current
99-
? {
100-
left:
101-
draggedClip.pointerClientX -
102-
scrollRef.current.getBoundingClientRect().left +
103-
scrollRef.current.scrollLeft -
104-
draggedClip.pointerOffsetX,
105-
top:
106-
draggedClip.pointerClientY -
107-
scrollRef.current.getBoundingClientRect().top +
108-
scrollRef.current.scrollTop -
109-
draggedClip.pointerOffsetY,
110-
}
111-
: null;
112-
11385
return (
11486
<div
11587
className="relative"
@@ -235,47 +207,18 @@ export const TimelineCanvas = memo(function TimelineCanvas(props: TimelineCanvas
235207
/>
236208
)}
237209

238-
{/* Drag ghost */}
239-
{activeDraggedElement && activeDraggedPosition && (
240-
<div
241-
className="absolute pointer-events-none"
242-
style={{
243-
top: activeDraggedPosition.top,
244-
left: activeDraggedPosition.left,
245-
width: Math.max(activeDraggedElement.duration * props.pps, 4),
246-
height: draggedClipHeight,
247-
zIndex: 40,
248-
}}
249-
>
250-
<TimelineClip
251-
el={{ ...activeDraggedElement, start: 0 }}
252-
pps={props.pps}
253-
clipY={0}
254-
isSelected={
255-
props.selectedElementId === (activeDraggedElement.key ?? activeDraggedElement.id)
256-
}
257-
isHovered={false}
258-
isDragging={true}
259-
isActive={isTimelineClipActive(activeDraggedElement, props.currentTime)}
260-
hasCustomContent={!!props.renderClipContent}
261-
capabilities={getTimelineEditCapabilities(activeDraggedElement)}
262-
theme={props.theme}
263-
isComposition={!!activeDraggedElement.compositionSrc}
264-
onHoverStart={() => {}}
265-
onHoverEnd={() => {}}
266-
onResizeStart={() => {}}
267-
onClick={() => {}}
268-
onDoubleClick={() => {}}
269-
>
270-
{renderClipChildren(
271-
activeDraggedElement,
272-
props.getTrackStyle(activeDraggedElement.tag),
273-
props.renderClipContent,
274-
props.renderClipOverlay,
275-
)}
276-
</TimelineClip>
277-
</div>
278-
)}
210+
<TimelineGestureOverlay
211+
drag={draggedClip}
212+
scrollRef={scrollRef}
213+
pixelsPerSecond={props.pps}
214+
rowHeight={draggedClipHeight}
215+
selectedElementId={props.selectedElementId}
216+
currentTime={props.currentTime}
217+
theme={props.theme}
218+
getTrackStyle={props.getTrackStyle}
219+
renderClipContent={props.renderClipContent}
220+
renderClipOverlay={props.renderClipOverlay}
221+
/>
279222

280223
{/* Marquee (rubber-band) multi-select rectangle — mirrors the canvas
281224
MarqueeOverlay look: semi-transparent accent fill + dashed border. */}

‎packages/studio/src/player/components/TimelineClip.tsx‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ interface TimelineClipProps {
1212
isSelected: boolean;
1313
isHovered: boolean;
1414
isDragging?: boolean;
15+
isGestureActor?: boolean;
1516
isActive?: boolean;
1617
hasCustomContent: boolean;
1718
capabilities: TimelineEditCapabilities;
@@ -36,6 +37,7 @@ export const TimelineClip = memo(function TimelineClip({
3637
isSelected,
3738
isHovered,
3839
isDragging = false,
40+
isGestureActor = false,
3941
isActive = false,
4042
hasCustomContent,
4143
capabilities,
@@ -85,13 +87,14 @@ export const TimelineClip = memo(function TimelineClip({
8587

8688
return (
8789
<div
88-
data-clip="true"
89-
data-el-id={el.key ?? el.id}
90+
data-clip={isGestureActor ? undefined : "true"}
91+
data-el-id={isGestureActor ? undefined : (el.key ?? el.id)}
9092
data-clip-start={el.start}
9193
data-clip-end={el.start + el.duration}
9294
data-clip-hidden={el.hidden ? "true" : undefined}
9395
data-active={isActive ? "" : undefined}
94-
tabIndex={-1}
96+
aria-hidden={isGestureActor ? "true" : undefined}
97+
tabIndex={isGestureActor ? undefined : -1}
9598
className={clipClassName}
9699
style={style}
97100
title={
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
// @vitest-environment happy-dom
2+
3+
import React, { act } from "react";
4+
import { createRoot } from "react-dom/client";
5+
import { afterEach, describe, expect, it } from "vitest";
6+
import { defaultTimelineTheme } from "./timelineTheme";
7+
import { TimelineGestureOverlay } from "./TimelineGestureOverlay";
8+
import type { DraggedClipState } from "./timelineClipDragTypes";
9+
import { getTrackStyle } from "./useTimelineTrackLayout";
10+
11+
Object.assign(globalThis, { IS_REACT_ACT_ENVIRONMENT: true });
12+
13+
const drag: DraggedClipState = {
14+
pointerId: 0,
15+
element: { id: "hero", tag: "div", start: 2, duration: 3, track: 1 },
16+
originClientX: 100,
17+
originClientY: 100,
18+
originScrollLeft: 0,
19+
originScrollTop: 0,
20+
pointerClientX: 350,
21+
pointerClientY: 240,
22+
pointerOffsetX: 20,
23+
pointerOffsetY: 10,
24+
previewStart: 4,
25+
previewTrack: 2,
26+
insertRow: null,
27+
snapTime: null,
28+
snapType: null,
29+
started: true,
30+
};
31+
32+
afterEach(() => document.body.replaceChildren());
33+
34+
describe("TimelineGestureOverlay", () => {
35+
it("keeps the drag actor mounted without a source-row node", () => {
36+
const host = document.createElement("div");
37+
document.body.append(host);
38+
const root = createRoot(host);
39+
const scroll = {
40+
scrollLeft: 500,
41+
scrollTop: 300,
42+
getBoundingClientRect: () => ({ left: 50, top: 40 }),
43+
} as HTMLDivElement;
44+
act(() => {
45+
root.render(
46+
<TimelineGestureOverlay
47+
drag={drag}
48+
scrollRef={{ current: scroll }}
49+
pixelsPerSecond={100}
50+
rowHeight={42}
51+
selectedElementId="hero"
52+
currentTime={4}
53+
theme={defaultTimelineTheme}
54+
getTrackStyle={getTrackStyle}
55+
/>,
56+
);
57+
});
58+
const actor = host.querySelector<HTMLElement>('[data-timeline-gesture-actor="hero"]');
59+
expect(actor?.style.left).toBe("780px");
60+
expect(actor?.style.top).toBe("490px");
61+
expect(actor?.querySelector(".timeline-clip")).not.toBeNull();
62+
expect(actor?.querySelector("[data-el-id]")).toBeNull();
63+
expect(actor?.querySelector("[data-clip]")).toBeNull();
64+
expect(host.querySelector("[data-source-row]")).toBeNull();
65+
act(() => root.unmount());
66+
});
67+
68+
it("keeps the stable overlay host after terminal cleanup", () => {
69+
const host = document.createElement("div");
70+
document.body.append(host);
71+
const root = createRoot(host);
72+
act(() => {
73+
root.render(
74+
<TimelineGestureOverlay
75+
drag={null}
76+
scrollRef={{ current: null }}
77+
pixelsPerSecond={100}
78+
rowHeight={42}
79+
selectedElementId={null}
80+
currentTime={0}
81+
theme={defaultTimelineTheme}
82+
getTrackStyle={getTrackStyle}
83+
/>,
84+
);
85+
});
86+
expect(host.querySelector("[data-timeline-gesture-overlay]")).not.toBeNull();
87+
expect(host.querySelector("[data-timeline-gesture-actor]")).toBeNull();
88+
act(() => root.unmount());
89+
});
90+
});

0 commit comments

Comments
 (0)