Skip to content

Commit e71656b

Browse files
committed
perf(studio): a long timeline no longer lays itself out on every render while it settles
1 parent a6dec07 commit e71656b

5 files changed

Lines changed: 112 additions & 4 deletions

File tree

‎packages/studio/src/player/components/timelineViewportGeometry.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,18 @@ export function getTimelineVisibleTimeRange(
3636
return { start: Math.min(start, duration), end };
3737
}
3838

39+
/** Whether two geometries place every row at the same top: a new geometry with the same rows moves nothing, so no
40+
* scroll position needs reading (each read forces a layout of the whole timeline). */
41+
export function sameTimelineRowTops(a: TimelineRowGeometry, b: TimelineRowGeometry): boolean {
42+
return (
43+
a.rowKeys.length === b.rowKeys.length &&
44+
a.rowKeys.every((key, row) => key === b.rowKeys[row]) &&
45+
a.rowOffsets.length === b.rowOffsets.length &&
46+
a.rowOffsets.every((top, row) => top === b.rowOffsets[row]) &&
47+
a.padding.top === b.padding.top
48+
);
49+
}
50+
3951
export function getTimelineScrollTopForGeometryChange(
4052
previous: TimelineRowGeometry,
4153
next: TimelineRowGeometry,
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
// @vitest-environment happy-dom
2+
import React, { act } from "react";
3+
import { createRoot } from "react-dom/client";
4+
import { expect, it, vi } from "vitest";
5+
import { useSettledScrollLeft } from "./useSettledScrollLeft";
6+
import { TIMELINE_SCROLL_SETTLE_MS } from "./useTimelineScrollViewport";
7+
8+
Object.assign(globalThis, { IS_REACT_ACT_ENVIRONMENT: true });
9+
10+
// The ruler's label read scrollLeft on every commit while a long project settled, each read a layout of the whole
11+
// timeline.
12+
it("reads scrollLeft when a scroll settles, never on a render", () => {
13+
vi.useFakeTimers();
14+
const scroll = document.createElement("div");
15+
let reads = 0;
16+
let left = 120;
17+
Object.defineProperty(scroll, "scrollLeft", { get: () => (reads++, left) });
18+
const scrollRef = { current: scroll };
19+
const seen: (number | null)[] = [];
20+
function Probe({ tick }: { tick: number }) {
21+
seen.push(useSettledScrollLeft(scrollRef));
22+
return <i data-tick={tick} />;
23+
}
24+
const root = createRoot(document.createElement("div"));
25+
try {
26+
act(() => root.render(<Probe tick={0} />));
27+
expect(seen.at(-1)).toBe(120);
28+
reads = 0;
29+
for (let tick = 1; tick <= 3; tick += 1) act(() => root.render(<Probe tick={tick} />));
30+
expect(reads, "no layout read on a render").toBe(0);
31+
left = 300;
32+
act(() => void scroll.dispatchEvent(new Event("scroll")));
33+
expect(seen.at(-1)).toBeNull();
34+
act(() => void vi.advanceTimersByTime(TIMELINE_SCROLL_SETTLE_MS + 1));
35+
expect(seen.at(-1)).toBe(300);
36+
expect(reads, "one read when the scroll settles").toBe(1);
37+
} finally {
38+
act(() => root.unmount());
39+
vi.useRealTimers();
40+
}
41+
});

‎packages/studio/src/player/components/useSettledScrollLeft.ts‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@ import { TIMELINE_SCROLL_SETTLE_MS } from "./useTimelineScrollViewport";
33

44
// The timeline viewport's scrollLeft once a scroll settles, or null while it is scrolling. Readers
55
// re-render twice per gesture, never per frame: per-frame work cost 2-3x the viewport gate's budget
6-
// on a large unvirtualized timeline.
6+
// on a large unvirtualized timeline. The settled value is read when a scroll settles, never in the
7+
// snapshot: React calls that after every commit, and each read forced a layout of the timeline.
78
export function useSettledScrollLeft(scrollRef: RefObject<HTMLDivElement | null>): number | null {
89
const scrollingRef = useRef(false);
10+
const settledRef = useRef(0);
911
const subscribe = useCallback(
1012
(onChange: () => void) => {
1113
const el = scrollRef.current;
14+
settledRef.current = el?.scrollLeft ?? 0;
15+
onChange(); // the first render read before the element was there
1216
let settle: ReturnType<typeof setTimeout> | undefined;
1317
const onScroll = () => {
1418
if (!scrollingRef.current) {
@@ -18,6 +22,7 @@ export function useSettledScrollLeft(scrollRef: RefObject<HTMLDivElement | null>
1822
clearTimeout(settle);
1923
settle = setTimeout(() => {
2024
scrollingRef.current = false;
25+
settledRef.current = el?.scrollLeft ?? 0;
2126
onChange();
2227
}, TIMELINE_SCROLL_SETTLE_MS);
2328
};
@@ -32,7 +37,7 @@ export function useSettledScrollLeft(scrollRef: RefObject<HTMLDivElement | null>
3237
);
3338
return useSyncExternalStore(
3439
subscribe,
35-
() => (scrollingRef.current ? null : (scrollRef.current?.scrollLeft ?? 0)),
40+
() => (scrollingRef.current ? null : settledRef.current),
3641
() => null,
3742
);
3843
}

‎packages/studio/src/player/components/useTimelineRowVirtualization.test.tsx‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,46 @@ it("leaves the viewport still when a live preview lane is removed before the com
5454
expect(scroll.scrollTop).toBe(160);
5555
act(() => root.unmount());
5656
});
57+
58+
// A long project settling hands the rows a new geometry with the same rows on many commits; each scrollTop read
59+
// forced a layout of every clip.
60+
it("reads no scroll position for a new geometry that places every row where it was", () => {
61+
const scroll = document.createElement("div");
62+
let reads = 0;
63+
let top = 160;
64+
Object.defineProperty(scroll, "scrollTop", {
65+
get: () => (reads++, top),
66+
set: (value: number) => void (top = value),
67+
});
68+
const scrollRef = { current: scroll };
69+
const root = createRoot(document.createElement("div"));
70+
function Probe({ geometry }: { geometry: TimelineRowGeometry }) {
71+
useTimelineRowVirtualization({
72+
scrollRef,
73+
rowGeometry: geometry,
74+
sessionEpoch: 0,
75+
viewport: {
76+
scrollTop: 160,
77+
scrollLeft: 0,
78+
clientWidth: 800,
79+
clientHeight: 200,
80+
scrollWidth: 800,
81+
scrollHeight: 600,
82+
isScrolling: false,
83+
},
84+
elements: [],
85+
selectedElementId: null,
86+
lastScrollLeftRef: { current: 0 },
87+
syncScrollViewport: () => {},
88+
});
89+
return null;
90+
}
91+
const rows = () => createTimelineRowGeometry([0, 1, 2], [48, 48, 48]);
92+
act(() => root.render(<Probe geometry={rows()} />));
93+
reads = 0;
94+
for (let i = 0; i < 3; i += 1) act(() => root.render(<Probe geometry={rows()} />));
95+
expect(reads, "no layout read for the same rows").toBe(0);
96+
act(() => root.render(<Probe geometry={createTimelineRowGeometry([0, 9, 1, 2], [48, 48, 48, 48])} />));
97+
expect(reads, "a row added still keeps the view anchored").toBeGreaterThan(0);
98+
act(() => root.unmount());
99+
});

‎packages/studio/src/player/components/useTimelineRowVirtualization.ts‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ import {
99
} from "react";
1010
import type { TimelineElement } from "../store/playerStore";
1111
import { resolveTimelineFocusIdentity } from "./timelineFocusIdentity";
12-
import { getTimelineScrollTopForGeometryChange } from "./timelineViewportGeometry";
12+
import {
13+
getTimelineScrollTopForGeometryChange,
14+
sameTimelineRowTops,
15+
} from "./timelineViewportGeometry";
1316
import type { TimelineRowGeometry } from "./timelineLayout";
1417
import type { TimelineScrollViewportSnapshot } from "./useTimelineScrollViewport";
1518
import { STUDIO_TIMELINE_ROW_VIRTUALIZATION_ENABLED } from "./timelineRowVirtualizationFlag";
@@ -116,7 +119,11 @@ export function useTimelineRowVirtualization({
116119
scroll.scrollTop = 0;
117120
syncScrollViewport(scroll);
118121
}
119-
} else if (scroll && previousGeometry !== rowGeometry) {
122+
} else if (
123+
scroll &&
124+
previousGeometry !== rowGeometry &&
125+
!sameTimelineRowTops(previousGeometry, rowGeometry)
126+
) {
120127
const nextScrollTop = getTimelineScrollTopForGeometryChange(
121128
previousGeometry,
122129
rowGeometry,

0 commit comments

Comments
 (0)