Skip to content

Commit 2d9b72b

Browse files
committed
fix(studio): publish the viewport when a zoom anchor lands
1 parent f0ba5aa commit 2d9b72b

3 files changed

Lines changed: 78 additions & 5 deletions

File tree

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

Lines changed: 72 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
11
// @vitest-environment happy-dom
22

3-
import { act, useRef } from "react";
3+
import { act, useLayoutEffect, useRef } from "react";
44
import { createRoot, type Root } from "react-dom/client";
55
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
66
import { liveTime, usePlayerStore, type ZoomMode } from "../store/playerStore";
77
import { useTimelinePlayhead } from "./useTimelinePlayhead";
8+
import { useTimelineScrollViewport } from "./useTimelineScrollViewport";
9+
import { useTimelineClipRenderWindow } from "./useTimelineClipRenderWindow";
10+
import { requestTimelineZoom, settleTimelineZoom } from "./timelineZoomInput";
811

912
Object.assign(globalThis, { IS_REACT_ACT_ENVIRONMENT: true });
1013

1114
const ORIGIN = 32;
1215

13-
function scrollBox(scrollLeft: number) {
16+
function scrollBox(scrollLeft: number, clientWidth = 800) {
1417
const el = document.createElement("div");
1518
let left = scrollLeft;
1619
Object.defineProperties(el, {
17-
clientWidth: { value: 800 },
20+
clientWidth: { value: clientWidth },
1821
scrollWidth: { value: 20_000 },
1922
scrollLeft: { get: () => left, set: (v: number) => (left = v) },
2023
});
@@ -27,16 +30,24 @@ interface HarnessProps {
2730
scroll: HTMLDivElement;
2831
dragging?: boolean;
2932
zoomMode?: ZoomMode;
33+
syncScrollViewport?: (scroll: HTMLDivElement) => void;
3034
}
3135

32-
function Harness({ pps: fixedPps, scroll, dragging = false, zoomMode = "manual" }: HarnessProps) {
36+
function Harness({
37+
pps: fixedPps,
38+
scroll,
39+
dragging = false,
40+
zoomMode = "manual",
41+
syncScrollViewport = () => {},
42+
}: HarnessProps) {
3343
const storePps = usePlayerStore((s) => s.timelinePps);
3444
const pps = fixedPps ?? storePps;
3545
const scrollRef = useRef(scroll);
3646
const durationRef = useRef(60);
3747
useTimelinePlayhead({
3848
playheadRef: { current: document.createElement("div") },
3949
scrollRef,
50+
syncScrollViewport,
4051
ppsRef: { current: pps },
4152
durationRef,
4253
isDragging: { current: dragging },
@@ -238,6 +249,63 @@ describe("useTimelinePlayhead follow while paused", () => {
238249
});
239250
});
240251

252+
describe("useTimelinePlayhead committed viewport", () => {
253+
it("keeps the visible 59-second clip mounted when a pointer zoom commits", () => {
254+
vi.stubGlobal(
255+
"ResizeObserver",
256+
class {
257+
observe() {}
258+
disconnect() {}
259+
},
260+
);
261+
usePlayerStore.setState({
262+
zoomMode: "manual",
263+
manualZoomPercent: 1000,
264+
timelineFitPps: 10,
265+
timelinePps: 100,
266+
});
267+
const scroll = scrollBox(5000, 1080);
268+
const container = document.createElement("div");
269+
function Probe() {
270+
const pps = usePlayerStore((s) => s.timelinePps);
271+
const { viewport, setScrollRef, syncScrollViewport } = useTimelineScrollViewport(
272+
useRef(scroll),
273+
[],
274+
);
275+
useLayoutEffect(() => setScrollRef(scroll), [setScrollRef]);
276+
const { renderTimeRange } = useTimelineClipRenderWindow({
277+
tracks: [],
278+
viewport,
279+
pixelsPerSecond: pps,
280+
contentOrigin: ORIGIN,
281+
duration: 100,
282+
});
283+
return (
284+
<>
285+
<Harness scroll={scroll} syncScrollViewport={syncScrollViewport} />
286+
{renderTimeRange.start <= 59 && renderTimeRange.end >= 59 && <span data-clip="59" />}
287+
<output>{viewport.scrollLeft}</output>
288+
</>
289+
);
290+
}
291+
const root = createRoot(container);
292+
roots.push(root);
293+
try {
294+
act(() => root.render(<Probe />));
295+
expect(container.querySelector('[data-clip="59"]')).not.toBeNull();
296+
act(() => {
297+
requestTimelineZoom(1090, { time: 55.24, x: 556 });
298+
settleTimelineZoom();
299+
});
300+
expect(scroll.scrollLeft).toBeCloseTo(5497.16);
301+
expect(container.querySelector('[data-clip="59"]')).not.toBeNull();
302+
expect(Number(container.querySelector("output")?.textContent)).toBeCloseTo(5497.16);
303+
} finally {
304+
vi.unstubAllGlobals();
305+
}
306+
});
307+
});
308+
241309
describe("useTimelinePlayhead wheel zoom", () => {
242310
beforeEach(() => {
243311
vi.useFakeTimers({

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ function revealPlayheadScrollLeft(
4242
interface UseTimelinePlayheadInput {
4343
playheadRef: React.RefObject<HTMLDivElement | null>;
4444
scrollRef: React.RefObject<HTMLDivElement | null>;
45+
syncScrollViewport: (scroll: HTMLDivElement) => void;
4546
ppsRef: React.RefObject<number>;
4647
durationRef: React.RefObject<number>;
4748
isDragging: React.RefObject<boolean>;
@@ -61,6 +62,7 @@ interface UseTimelinePlayheadInput {
6162
export function useTimelinePlayhead({
6263
playheadRef,
6364
scrollRef,
65+
syncScrollViewport,
6466
ppsRef,
6567
durationRef,
6668
isDragging,
@@ -100,6 +102,7 @@ export function useTimelinePlayhead({
100102
const maxScrollLeft = Math.max(0, scroll.scrollWidth - scroll.clientWidth);
101103
const left = anchor.time * pps + contentOrigin - anchor.x;
102104
scroll.scrollLeft = Math.max(0, Math.min(maxScrollLeft, left));
105+
syncScrollViewport(scroll);
103106
return;
104107
}
105108
const zoomed = userZoomCount !== prevZoomCount;
@@ -121,7 +124,8 @@ export function useTimelinePlayhead({
121124
scroll.scrollLeft = zoomed
122125
? revealPlayheadScrollLeft(scroll, contentOrigin + time * pps, contentOrigin, anchored)
123126
: anchored;
124-
}, [pps, userZoomCount, scrollRef, durationRef, contentOrigin]);
127+
syncScrollViewport(scroll);
128+
}, [pps, userZoomCount, scrollRef, durationRef, contentOrigin, syncScrollViewport]);
125129

126130
const syncPlayheadPosition = useCallback(
127131
(time: number) => {

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,7 @@ export function useTimelineProviderState({
336336
const { seekFromX, autoScrollDuringDrag, dragScrollRaf } = useTimelinePlayhead({
337337
playheadRef,
338338
scrollRef,
339+
syncScrollViewport,
339340
ppsRef,
340341
durationRef,
341342
isDragging,

0 commit comments

Comments
 (0)