Skip to content

Commit 78f1ba8

Browse files
edemainemaria-rcks
andauthored
fix(web): preserve PDF scroll and zoom across autoreloads (#25555)
Co-authored-by: maria-rcks <[email protected]> Co-authored-by: maria-rcks <[email protected]>
1 parent cb9629e commit 78f1ba8

4 files changed

Lines changed: 308 additions & 13 deletions

File tree

‎apps/web/src/components/files/AttachmentFilePreview.browser.test.tsx‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2411,6 +2411,208 @@ it("keeps a workspace PDF open across URL renewals and reloads it when the file
24112411
URL.revokeObjectURL(edited);
24122412
}
24132413
});
2414+
function planningPdf(
2415+
titles = ["Quarterly outlook", "Delivery milestones", "Budget and risks"],
2416+
firstHeight = 140,
2417+
pageHeight = 792,
2418+
) {
2419+
const objects = [
2420+
"<< /Type /Catalog /Pages 2 0 R >>",
2421+
`<< /Type /Pages /Count ${titles.length} /Kids [${titles.map((_, index) => `${3 + index * 2} 0 R`).join(" ")}] >>`,
2422+
];
2423+
const font = 3 + titles.length * 2;
2424+
for (const [index, title] of titles.entries()) {
2425+
const text = `/GS1 gs BT /F1 24 Tf 30 ${index === 0 ? 70 : 700} Td ${index === 0 ? "(Quarter) Tj /F2 24 Tf (ly outlook) Tj" : `(${title}) Tj`} ET`;
2426+
objects.push(
2427+
`<< /Type /Page /Parent 2 0 R /MediaBox [0 0 612 ${index === 0 ? firstHeight : pageHeight}] /Rotate ${index === 2 ? 90 : 0} /Resources << /Font << /F1 ${font} 0 R /F2 ${font + 1} 0 R >> /ExtGState << /GS1 << /TR << /FunctionType 2 /Domain [0 1] /C0 [0] /C1 [1] /N 2 >> >> >> >> /Contents ${4 + index * 2} 0 R >>`,
2428+
`<< /Length ${text.length} >>\nstream\n${text}\nendstream`,
2429+
);
2430+
}
2431+
objects.push("<< /Type /Font /Subtype /Type1 /BaseFont /Helvetica >>");
2432+
objects.push("<< /Type /Font /Subtype /Type1 /BaseFont /Helvetica-Bold >>");
2433+
let source = "%PDF-1.4\n";
2434+
const offsets = [0];
2435+
for (const [index, object] of objects.entries()) {
2436+
offsets.push(source.length);
2437+
source += `${index + 1} 0 obj\n${object}\nendobj\n`;
2438+
}
2439+
const xref = source.length;
2440+
source += `xref\n0 ${objects.length + 1}\n0000000000 65535 f \n${offsets
2441+
.slice(1)
2442+
.map((offset) => `${String(offset).padStart(10, "0")} 00000 n \n`)
2443+
.join("")}trailer\n<< /Size ${objects.length + 1} /Root 1 0 R >>\nstartxref\n${xref}\n%%EOF`;
2444+
return new Blob([source], { type: "application/pdf" });
2445+
}
2446+
2447+
async function workspacePdfPreview() {
2448+
assetUrlState.mockReset();
2449+
const { WorkspaceBrowserPreview } = await import("./FilePreviewPanel");
2450+
const native = vi.spyOn(navigator, "pdfViewerEnabled", "get").mockReturnValue(false);
2451+
const urls = (() => {
2452+
const original = URL.createObjectURL(planningPdf());
2453+
const updated = URL.createObjectURL(
2454+
planningPdf(["Quarterly outlook", "Delivery milestones", "Updated budget"], 500),
2455+
);
2456+
const shorter = URL.createObjectURL(planningPdf(["Quarterly outlook", "Updated milestones"]));
2457+
const shrunk = URL.createObjectURL(
2458+
planningPdf(["Quarterly outlook", "Small page", "Budget and risks"], 500, 200),
2459+
);
2460+
const single = URL.createObjectURL(planningPdf(["Quarterly outlook"]));
2461+
return {
2462+
original,
2463+
updated,
2464+
shorter,
2465+
shrunk,
2466+
single,
2467+
[Symbol.dispose]: () =>
2468+
[original, updated, shorter, shrunk, single].forEach(URL.revokeObjectURL),
2469+
};
2470+
})();
2471+
const preview = (src: string, mutation: string, path = "/repo/planning.pdf") => {
2472+
assetUrlState.mockReturnValue({
2473+
_tag: "Success",
2474+
url: `${src}#preview`,
2475+
expiresAt: Date.now() + 3_600_000,
2476+
});
2477+
return (
2478+
<div className="flex h-[600px] w-[320px]">
2479+
<WorkspaceBrowserPreview
2480+
environmentId={EnvironmentId.make("test")}
2481+
threadRef={{ environmentId: EnvironmentId.make("test"), threadId: ThreadId.make("test") }}
2482+
draft={false}
2483+
absolutePath={path}
2484+
workspaceRoot="/repo"
2485+
title="Planning PDF"
2486+
workspaceMutationId={mutation}
2487+
/>
2488+
</div>
2489+
);
2490+
};
2491+
return {
2492+
preview,
2493+
urls,
2494+
[Symbol.dispose]() {
2495+
native.mockRestore();
2496+
urls[Symbol.dispose]();
2497+
},
2498+
};
2499+
}
2500+
2501+
function pdfScroll(screen: Screen) {
2502+
const region = () => screen.container.querySelector<HTMLElement>('[role="region"]')!;
2503+
const canvas = (page: number) =>
2504+
region().querySelector<HTMLCanvasElement>(`canvas[aria-label="Page ${page}"]`)!;
2505+
const offset = (page: number) =>
2506+
region().getBoundingClientRect().top - canvas(page).getBoundingClientRect().top;
2507+
const scrollTo = (options: ScrollToOptions) =>
2508+
act(async () => {
2509+
const node = region();
2510+
const scrolled = new Promise<void>((resolve) =>
2511+
node.addEventListener("scroll", () => resolve(), { once: true }),
2512+
);
2513+
node.scrollTo(options);
2514+
await scrolled;
2515+
});
2516+
return { region, canvas, offset, scrollTo };
2517+
}
2518+
2519+
it("keeps workspace PDF scroll and zoom after reloads", async () => {
2520+
using fixture = await workspacePdfPreview();
2521+
const { preview, urls } = fixture;
2522+
await using screen = await render(preview(urls.original, "one"));
2523+
await expect.element(screen.getByText("1 / 3 pages", { exact: true })).toBeVisible();
2524+
await screen.getByRole("button", { name: "Next page", exact: true }).click();
2525+
await vi.waitFor(() => expect(screen.container.textContent).toContain("2 / 3 pages"));
2526+
await screen.getByRole("button", { name: "Next page", exact: true }).click();
2527+
await vi.waitFor(() => expect(screen.container.textContent).toContain("3 / 3 pages"));
2528+
for (let index = 0; index < 4; index++) {
2529+
await screen.getByRole("button", { name: "Zoom in", exact: true }).click();
2530+
}
2531+
const { region, offset, scrollTo } = pdfScroll(screen);
2532+
const zoom = screen.container.textContent!.match(/\d+%/)![0];
2533+
const top = region().scrollTop;
2534+
await scrollTo({ top: top + 100, left: 80 });
2535+
await vi.waitFor(() => {
2536+
expect(region().scrollTop).toBeCloseTo(top + 100, 0);
2537+
expect(region().scrollLeft).toBe(80);
2538+
});
2539+
const savedOffset = offset(3);
2540+
await screen.rerender(preview(urls.updated, "two"));
2541+
await expect.element(screen.getByText("3 / 3 pages", { exact: true })).toBeVisible();
2542+
await vi.waitFor(() => {
2543+
expect(screen.container.querySelector('[role="region"]')?.textContent).toContain(
2544+
"Updated budget",
2545+
);
2546+
expect(screen.container.textContent).toContain(zoom);
2547+
expect(region().scrollLeft).toBe(80);
2548+
expect(offset(3)).toBeCloseTo(savedOffset, 0);
2549+
});
2550+
await screen.getByRole("button", { name: "Previous page", exact: true }).click();
2551+
await vi.waitFor(() => expect(screen.container.textContent).toContain("2 / 3 pages"));
2552+
await screen.getByRole("button", { name: "Fit width", exact: true }).click();
2553+
await scrollTo({ top: region().scrollTop + 30 });
2554+
const fitOffset = offset(2);
2555+
await screen.rerender(preview(urls.original, "fit-width"));
2556+
await expect.element(screen.getByText("2 / 3 pages", { exact: true })).toBeVisible();
2557+
await vi.waitFor(() => {
2558+
expect(screen.container.textContent).toContain("Fit width");
2559+
expect(region().scrollLeft).toBe(0);
2560+
expect(offset(2)).toBeCloseTo(fitOffset, 0);
2561+
});
2562+
await screen.getByRole("button", { name: "Previous page", exact: true }).click();
2563+
await vi.waitFor(() => expect(screen.container.textContent).toContain("1 / 3 pages"));
2564+
await screen.getByRole("button", { name: "Zoom in", exact: true }).click();
2565+
const firstPageZoom = screen.container.textContent!.match(/\d+%/)![0];
2566+
await screen.rerender(preview(urls.original, "first-page"));
2567+
await expect.element(screen.getByText("1 / 3 pages", { exact: true })).toBeVisible();
2568+
await vi.waitFor(() => expect(screen.container.textContent).toContain(firstPageZoom));
2569+
await screen.getByRole("button", { name: "Next page", exact: true }).click();
2570+
await vi.waitFor(() => expect(screen.container.textContent).toContain("2 / 3 pages"));
2571+
await screen.rerender(preview(urls.original, "one", "/repo/another.pdf"));
2572+
await expect.element(screen.getByText("1 / 3 pages", { exact: true })).toBeVisible();
2573+
await vi.waitFor(() => {
2574+
expect(screen.container.textContent).toContain("Fit width");
2575+
expect(region().scrollTop).toBe(0);
2576+
expect(region().scrollLeft).toBe(0);
2577+
});
2578+
});
2579+
2580+
it("clamps workspace PDF scroll when pages shrink or disappear", async () => {
2581+
using fixture = await workspacePdfPreview();
2582+
const { preview, urls } = fixture;
2583+
await using screen = await render(preview(urls.original, "one"));
2584+
await expect.element(screen.getByText("1 / 3 pages", { exact: true })).toBeVisible();
2585+
await screen.getByRole("button", { name: "Next page", exact: true }).click();
2586+
await expect.element(screen.getByText("2 / 3 pages", { exact: true })).toBeVisible();
2587+
for (let index = 0; index < 4; index++) {
2588+
await screen.getByRole("button", { name: "Zoom in", exact: true }).click();
2589+
}
2590+
const { region, canvas, offset, scrollTo } = pdfScroll(screen);
2591+
const zoom = screen.container.textContent!.match(/\d+%/)![0];
2592+
const secondPageTop = region().scrollTop;
2593+
await scrollTo({ top: secondPageTop + 600, left: 80 });
2594+
await vi.waitFor(() => expect(region().scrollTop).toBeCloseTo(secondPageTop + 600, 0));
2595+
await screen.rerender(preview(urls.shrunk, "smaller-page"));
2596+
await expect.element(screen.getByText("2 / 3 pages", { exact: true })).toBeVisible();
2597+
await vi.waitFor(() => {
2598+
expect(screen.container.textContent).toContain(zoom);
2599+
expect(region().scrollLeft).toBe(80);
2600+
expect(offset(2)).toBeGreaterThan(0);
2601+
expect(offset(2)).toBeLessThan(canvas(2).getBoundingClientRect().height);
2602+
});
2603+
await screen.rerender(preview(urls.shorter, "three"));
2604+
await expect.element(screen.getByText("2 / 2 pages", { exact: true })).toBeVisible();
2605+
await vi.waitFor(() => {
2606+
expect(screen.container.querySelector('[role="region"]')?.textContent).toContain(
2607+
"Updated milestones",
2608+
);
2609+
});
2610+
await screen.rerender(preview(urls.single, "four"));
2611+
await expect.element(screen.getByText("1 / 1 pages", { exact: true })).toBeVisible();
2612+
await screen.rerender(preview(urls.original, "five"));
2613+
await expect.element(screen.getByText("1 / 3 pages", { exact: true })).toBeVisible();
2614+
});
2615+
24142616
it("unwraps one text attachment without turning off the word wrap setting", async () => {
24152617
const file = new Blob(["a long line"], { type: "text/plain" });
24162618
await using screen = await render(

‎apps/web/src/components/files/BrowserDocumentFrame.tsx‎

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ import {
3333
} from "react";
3434
import { isElectron } from "~/env";
3535
import { FileSurfaceLoading } from "./fileSurfaceChrome";
36+
import type { PdfViewState } from "./PdfViewer";
3637

3738
import { useOpenLink } from "~/browser/useOpenLink";
3839
import { ExpandedImageDialog } from "~/components/chat/ExpandedImageDialog";
@@ -73,7 +74,27 @@ export const isPdfPreviewFile = (path: string): boolean =>
7374

7475
const PdfViewer = lazy(() => import("./PdfViewer"));
7576

76-
function PdfDocument(props: { src: string; title: string }) {
77+
// The document stays mounted while each revision gets a fresh PDF.js document.
78+
function PdfDocument(props: { src: string; title: string; documentKey: string }) {
79+
const [view, setView] = useState<PdfViewState>({ page: 0, offset: 0, zoom: null, left: 0 });
80+
return (
81+
<PdfDocumentRevision
82+
key={props.documentKey}
83+
src={props.src}
84+
title={props.title}
85+
initialView={view}
86+
onViewChange={setView}
87+
/>
88+
);
89+
}
90+
91+
// Keep signed URL renewals from reloading the same revision.
92+
function PdfDocumentRevision(props: {
93+
src: string;
94+
title: string;
95+
initialView: PdfViewState;
96+
onViewChange: (view: PdfViewState) => void;
97+
}) {
7798
const [src] = useState(props.src);
7899
// The Electron shell does not enable PDF plugins. WebKit embeds on iOS
79100
// expose only the first page, even when pdfViewerEnabled reports support.
@@ -91,7 +112,12 @@ function PdfDocument(props: { src: string; title: string }) {
91112
/>
92113
) : (
93114
<Suspense fallback={<FileSurfaceLoading />}>
94-
<PdfViewer src={src} title={props.title} />
115+
<PdfViewer
116+
src={src}
117+
title={props.title}
118+
initialView={props.initialView}
119+
onViewChange={props.onViewChange}
120+
/>
95121
</Suspense>
96122
);
97123
}
@@ -108,10 +134,17 @@ export function BrowserDocumentFrame(props: {
108134
readonly threadRef?: ScopedThreadRef | undefined;
109135
/** Stable resource identity and revision; defaults to src for callers that reload on URL changes. */
110136
readonly documentKey?: string | undefined;
137+
/** Resource identity without its revision, so PDF reloads can retain the reading position. */
138+
readonly documentId?: string | undefined;
111139
}) {
112140
const key = props.documentKey ?? props.src;
113141
return props.pdf ? (
114-
<PdfDocument key={key} src={props.src} title={props.title} />
142+
<PdfDocument
143+
key={props.documentId ?? key}
144+
documentKey={key}
145+
src={props.src}
146+
title={props.title}
147+
/>
115148
) : props.htmlRender ? (
116149
<HtmlRenderDocument
117150
key={key}

‎apps/web/src/components/files/FilePreviewPanel.tsx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,7 @@ export function WorkspaceBrowserPreview(props: {
272272
<BrowserDocumentFrame
273273
src={`${assetUrl.url}${revisionSuffix}`}
274274
documentKey={`${props.environmentId}:${resource._tag}:${props.threadRef.threadId}:${props.absolutePath}:${revision}`}
275+
documentId={`${props.environmentId}:${resource._tag}:${props.threadRef.threadId}:${props.absolutePath}`}
275276
title={props.title}
276277
pdf={pdf}
277278
/>

0 commit comments

Comments
 (0)