Skip to content

Commit 4b03b02

Browse files
committed
fix(web): PDF previews keep their page when the agent responds
A PDF open in the file preview jumped back to page 1 after every agent command, and whenever its URL was renewed. The preview keyed the PDF on a URL that carries the workspace revision, which changes after every command. The server now reports a file revision for files inside the project too, and a PDF preview stays loaded until that revision changes. An edited PDF still reloads. HTML previews keep following every workspace change because they load sibling files, and servers without a file revision behave as before. Fixes #23632
1 parent f460ddb commit 4b03b02

5 files changed

Lines changed: 105 additions & 12 deletions

File tree

‎apps/server/src/assets/AssetAccess.test.ts‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -640,6 +640,37 @@ describe("AssetAccess", () => {
640640
}).pipe(Effect.provide(layerTest)),
641641
);
642642

643+
it.effect("versions a workspace PDF by its file changes rather than by re-signing", () =>
644+
Effect.gen(function* () {
645+
const fs = yield* FileSystem.FileSystem;
646+
const path = yield* Path.Path;
647+
const root = yield* fs.makeTempDirectoryScoped({ prefix: "t3-workspace-revision-" });
648+
const filePath = path.join(root, "paper.pdf");
649+
yield* fs.writeFileString(filePath, "%PDF-original");
650+
yield* Effect.promise(() => NodeFSP.utimes(filePath, 1_000, 1_000));
651+
const input = {
652+
resource: {
653+
_tag: "workspace-file" as const,
654+
threadId: ThreadId.make("thread-1"),
655+
path: filePath,
656+
},
657+
workspaceRoot: root,
658+
};
659+
const original = yield* issueAssetUrl(input);
660+
expect(original.fileRevision).toEqual(expect.any(String));
661+
662+
yield* TestClock.adjust("1 minute");
663+
const renewed = yield* issueAssetUrl(input);
664+
expect(renewed.relativeUrl).not.toBe(original.relativeUrl);
665+
expect(renewed.fileRevision).toBe(original.fileRevision);
666+
667+
yield* fs.writeFileString(filePath, "%PDF-modified");
668+
yield* Effect.promise(() => NodeFSP.utimes(filePath, 2_000, 2_000));
669+
const edited = yield* issueAssetUrl(input);
670+
expect(edited.fileRevision).not.toBe(original.fileRevision);
671+
}).pipe(Effect.provide(layerTest)),
672+
);
673+
643674
it.effect("keeps in-place edits readable but requires a new URL after atomic replacement", () =>
644675
Effect.gen(function* () {
645676
const fs = yield* FileSystem.FileSystem;

‎apps/server/src/assets/AssetAccess.ts‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,6 +335,18 @@ const readImageDimensionsFromOpenFile = (filePath: string, file: OpenMediaFile)
335335
Effect.orElseSucceed((): ImageDimensions | null => null),
336336
);
337337

338+
/** Changes whenever the file's bytes may have, so a client can keep an unchanged file loaded. */
339+
const fileRevisionOf = (file: OpenMediaFile) =>
340+
`${file.info.dev}:${file.info.ino}:${file.info.size}:${file.info.mtimeNs}:${file.info.ctimeNs}`;
341+
342+
/** Opens through `openMediaFile` for the same reason as `readImageDimensionsFromHeader`. */
343+
const readFileRevision = (filePath: string) =>
344+
openMediaFile(filePath).pipe(
345+
Effect.map((file) => (file === null ? undefined : fileRevisionOf(file))),
346+
Effect.scoped,
347+
Effect.orElseSucceed((): string | undefined => undefined),
348+
);
349+
338350
/**
339351
* Opens through `openMediaFile` so a path swapped for a FIFO cannot block the
340352
* request; a regular open would wait for a writer that never comes.
@@ -396,7 +408,7 @@ const finalizeAbsoluteMediaFileAsset = Effect.fn("AssetAccess.finalizeAbsoluteMe
396408
: Effect.succeed(null),
397409
(dimensions) => ({
398410
identity: { device: file.info.dev.toString(), inode: file.info.ino.toString() },
399-
fileRevision: `${file.info.dev}:${file.info.ino}:${file.info.size}:${file.info.mtimeNs}:${file.info.ctimeNs}`,
411+
fileRevision: fileRevisionOf(file),
400412
dimensions,
401413
}),
402414
),
@@ -487,6 +499,7 @@ const finalizeWorkspaceFileAsset = Effect.fn("AssetAccess.finalizeWorkspaceFileA
487499
)
488500
? yield* readImageDimensionsFromHeader(canonicalFile)
489501
: null;
502+
const fileRevision = yield* readFileRevision(canonicalFile);
490503
return {
491504
claims: isWorkspaceImagePreviewPath(resolved.relativePath)
492505
? {
@@ -505,6 +518,7 @@ const finalizeWorkspaceFileAsset = Effect.fn("AssetAccess.finalizeWorkspaceFileA
505518
},
506519
fileName: path.basename(resolved.relativePath),
507520
imageDimensions,
521+
fileRevision,
508522
};
509523
},
510524
);
@@ -579,6 +593,7 @@ export const issueAssetUrl = Effect.fn("AssetAccess.issueAssetUrl")(function* (i
579593
claims = finalized.claims;
580594
fileName = finalized.fileName;
581595
imageDimensions = finalized.imageDimensions;
596+
fileRevision = finalized.fileRevision;
582597
break;
583598
}
584599
case "draft-workspace-file": {
@@ -617,6 +632,7 @@ export const issueAssetUrl = Effect.fn("AssetAccess.issueAssetUrl")(function* (i
617632
claims = finalized.claims;
618633
fileName = finalized.fileName;
619634
imageDimensions = finalized.imageDimensions;
635+
fileRevision = finalized.fileRevision;
620636
break;
621637
}
622638
case "attachment": {
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
import { expect, it } from "vite-plus/test";
2+
3+
import { render } from "../../../test/render";
4+
import { BrowserDocumentFrame } from "./BrowserDocumentFrame";
5+
6+
const pdf = (src: string, documentKey: string) => (
7+
<BrowserDocumentFrame src={src} documentKey={documentKey} title="paper.pdf" pdf />
8+
);
9+
10+
it("keeps a PDF open across URL renewals until its document changes", async () => {
11+
await using screen = await render(pdf("/asset/first/paper.pdf?file-revision=a", "paper:a"));
12+
const embed = () => screen.container.querySelector("embed");
13+
const opened = embed();
14+
expect(opened?.getAttribute("src")).toBe("/asset/first/paper.pdf?file-revision=a");
15+
16+
// Another command re-signs the URL, but the file is unchanged.
17+
await screen.rerender(pdf("/asset/second/paper.pdf?file-revision=a", "paper:a"));
18+
expect(embed()).toBe(opened);
19+
expect(embed()?.getAttribute("src")).toBe("/asset/first/paper.pdf?file-revision=a");
20+
21+
await screen.rerender(pdf("/asset/third/paper.pdf?file-revision=b", "paper:b"));
22+
expect(embed()).not.toBe(opened);
23+
expect(embed()?.getAttribute("src")).toBe("/asset/third/paper.pdf?file-revision=b");
24+
});

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

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,7 @@ export function BrowserDocumentFrame(props: {
7676
}) {
7777
const key = props.documentKey ?? props.src;
7878
return props.pdf ? (
79-
<embed
80-
key={props.src}
81-
src={props.src}
82-
type="application/pdf"
83-
title={props.title}
84-
className="min-h-0 w-full flex-1 border-0"
85-
/>
79+
<PdfDocument key={key} src={props.src} title={props.title} />
8680
) : props.htmlRender ? (
8781
<HtmlRenderDocument
8882
key={key}
@@ -96,6 +90,19 @@ export function BrowserDocumentFrame(props: {
9690
);
9791
}
9892

93+
// A renewed URL would reopen the PDF at page 1; a new key loads the changed file.
94+
function PdfDocument(props: { readonly src: string; readonly title: string }) {
95+
const [src] = useState(props.src);
96+
return (
97+
<embed
98+
src={src}
99+
type="application/pdf"
100+
title={props.title}
101+
className="min-h-0 w-full flex-1 border-0"
102+
/>
103+
);
104+
}
105+
99106
// URL renewals must not discard form input or scroll; a new key mounts a fresh document.
100107
function FileDocument(props: { readonly src: string; readonly title: string }) {
101108
const [src] = useState(props.src);

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

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -235,10 +235,25 @@ function WorkspaceBrowserPreview(props: {
235235
absolutePath: props.absolutePath,
236236
});
237237
const assetUrl = useAssetUrlState(props.environmentId, resource);
238+
const pdf = isPdfPreviewFile(props.absolutePath);
239+
const refreshAssetUrl = useAssetUrlRefresh(props.environmentId, resource);
240+
// A PDF is one file, so its own revision says whether it changed and an agent's other
241+
// commands leave the reader's page alone. HTML loads its siblings, so it follows every
242+
// workspace mutation, as do PDFs from servers that do not report a revision.
243+
useWorkspaceMutationRefresh({
244+
enabled: pdf,
245+
mutationId: props.workspaceMutationId,
246+
resourceKey: JSON.stringify([props.environmentId, resource]),
247+
refresh: () => {
248+
void refreshAssetUrl().catch(() => undefined);
249+
},
250+
});
251+
const fileRevision = pdf && assetUrl._tag === "Success" ? assetUrl.fileRevision : undefined;
252+
const revision = fileRevision ?? props.workspaceMutationId;
238253
const revisionSuffix =
239-
props.workspaceMutationId === null
254+
revision === null
240255
? ""
241-
: `${assetUrl._tag === "Success" && assetUrl.url.includes("?") ? "&" : "?"}workspace-revision=${encodeURIComponent(props.workspaceMutationId)}`;
256+
: `${assetUrl._tag === "Success" && assetUrl.url.includes("?") ? "&" : "?"}${fileRevision !== undefined ? "file" : "workspace"}-revision=${encodeURIComponent(revision)}`;
242257

243258
if (assetUrl._tag === "Failure") {
244259
return (
@@ -257,9 +272,9 @@ function WorkspaceBrowserPreview(props: {
257272
return (
258273
<BrowserDocumentFrame
259274
src={`${assetUrl.url}${revisionSuffix}`}
260-
documentKey={`${props.environmentId}:${resource._tag}:${props.threadRef.threadId}:${props.absolutePath}:${props.workspaceMutationId}`}
275+
documentKey={`${props.environmentId}:${resource._tag}:${props.threadRef.threadId}:${props.absolutePath}:${revision}`}
261276
title={props.title}
262-
pdf={isPdfPreviewFile(props.absolutePath)}
277+
pdf={pdf}
263278
/>
264279
);
265280
}

0 commit comments

Comments
 (0)