Skip to content

Commit da8e240

Browse files
committed
fix(web): keep unchanged file previews loaded during agent commands
1 parent 5522180 commit da8e240

4 files changed

Lines changed: 159 additions & 47 deletions

File tree

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

Lines changed: 37 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -807,41 +807,43 @@ describe("AssetAccess", () => {
807807
}).pipe(Effect.provide(layerTest)),
808808
);
809809

810-
it.effect("versions media by file changes rather than by re-signing", () =>
811-
Effect.gen(function* () {
812-
const fs = yield* FileSystem.FileSystem;
813-
const path = yield* Path.Path;
814-
const root = yield* fs.makeTempDirectoryScoped({ prefix: "t3-media-revision-" });
815-
const filePath = path.join(root, "recording.mp4");
816-
yield* fs.writeFileString(filePath, "original");
817-
yield* Effect.promise(() => NodeFSP.utimes(filePath, 1_000, 1_000));
818-
const input = {
819-
resource: {
820-
_tag: "media-file" as const,
821-
threadId: ThreadId.make("thread-1"),
822-
path: filePath,
823-
},
824-
};
825-
const original = yield* issueAssetUrl(input);
826-
expect(original.fileRevision).toEqual(expect.any(String));
827-
828-
yield* TestClock.adjust("1 minute");
829-
const renewed = yield* issueAssetUrl(input);
830-
expect(renewed.relativeUrl).not.toBe(original.relativeUrl);
831-
expect(renewed.fileRevision).toBe(original.fileRevision);
832-
833-
yield* fs.writeFileString(filePath, "modified");
834-
yield* Effect.promise(() => NodeFSP.utimes(filePath, 2_000, 2_000));
835-
const edited = yield* issueAssetUrl(input);
836-
expect(edited.fileRevision).not.toBe(original.fileRevision);
837-
838-
const replacement = path.join(root, "replacement.mp4");
839-
yield* fs.writeFileString(replacement, "modified");
840-
yield* Effect.promise(() => NodeFSP.utimes(replacement, 2_000, 2_000));
841-
yield* fs.rename(replacement, filePath);
842-
const replaced = yield* issueAssetUrl(input);
843-
expect(replaced.fileRevision).not.toBe(edited.fileRevision);
844-
}).pipe(Effect.provide(layerTest)),
810+
it.effect.each(["media-file", "workspace-file", "draft-workspace-file"] as const)(
811+
"versions %s by file changes rather than by re-signing",
812+
(kind) =>
813+
Effect.gen(function* () {
814+
const fs = yield* FileSystem.FileSystem;
815+
const path = yield* Path.Path;
816+
const root = yield* fs.makeTempDirectoryScoped({ prefix: "t3-media-revision-" });
817+
const filePath = path.join(root, "report.html");
818+
yield* fs.writeFileString(filePath, "original");
819+
yield* Effect.promise(() => NodeFSP.utimes(filePath, 1_000, 1_000));
820+
const input = {
821+
resource:
822+
kind === "draft-workspace-file"
823+
? { _tag: kind, cwd: root, path: "report.html" }
824+
: { _tag: kind, threadId: ThreadId.make("thread-1"), path: filePath },
825+
workspaceRoot: root,
826+
};
827+
const original = yield* issueAssetUrl(input);
828+
expect(original.fileRevision).toEqual(expect.any(String));
829+
830+
yield* TestClock.adjust("1 minute");
831+
const renewed = yield* issueAssetUrl(input);
832+
expect(renewed.relativeUrl).not.toBe(original.relativeUrl);
833+
expect(renewed.fileRevision).toBe(original.fileRevision);
834+
835+
yield* fs.writeFileString(filePath, "modified");
836+
yield* Effect.promise(() => NodeFSP.utimes(filePath, 2_000, 2_000));
837+
const edited = yield* issueAssetUrl(input);
838+
expect(edited.fileRevision).not.toBe(original.fileRevision);
839+
840+
const replacement = path.join(root, "replacement.html");
841+
yield* fs.writeFileString(replacement, "modified");
842+
yield* Effect.promise(() => NodeFSP.utimes(replacement, 2_000, 2_000));
843+
yield* fs.rename(replacement, filePath);
844+
const replaced = yield* issueAssetUrl(input);
845+
expect(replaced.fileRevision).not.toBe(edited.fileRevision);
846+
}).pipe(Effect.provide(layerTest)),
845847
);
846848

847849
it.effect("keeps in-place edits readable but requires a new URL after atomic replacement", () =>

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

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -508,11 +508,26 @@ const finalizeWorkspaceFileAsset = Effect.fn("AssetAccess.finalizeWorkspaceFileA
508508
}),
509509
),
510510
);
511-
const imageDimensions = HEADER_IMAGE_EXTENSIONS.has(
512-
path.extname(resolved.relativePath).toLowerCase(),
513-
)
514-
? yield* readImageDimensionsFromHeader(canonicalFile)
515-
: null;
511+
const opened = yield* Effect.gen(function* () {
512+
const file = yield* openMediaFile(canonicalFile);
513+
if (file === null) return null;
514+
return {
515+
fileRevision: `${file.info.dev}:${file.info.ino}:${file.info.size}:${file.info.mtimeNs}:${file.info.ctimeNs}`,
516+
imageDimensions: HEADER_IMAGE_EXTENSIONS.has(
517+
path.extname(resolved.relativePath).toLowerCase(),
518+
)
519+
? yield* readImageDimensionsFromOpenFile(canonicalFile, file)
520+
: null,
521+
};
522+
}).pipe(
523+
Effect.scoped,
524+
Effect.mapError(
525+
(cause) => new AssetWorkspaceAssetInspectionError({ resource: input.resource, cause }),
526+
),
527+
);
528+
if (opened === null) {
529+
return yield* new AssetWorkspaceAssetNotFoundError({ resource: input.resource });
530+
}
516531
return {
517532
claims: !/\.html?$/i.test(resolved.relativePath)
518533
? {
@@ -530,8 +545,8 @@ const finalizeWorkspaceFileAsset = Effect.fn("AssetAccess.finalizeWorkspaceFileA
530545
expiresAt: input.expiresAt,
531546
},
532547
fileName: path.basename(resolved.relativePath),
533-
imageDimensions,
534-
fileRevision: undefined,
548+
imageDimensions: opened.imageDimensions,
549+
fileRevision: opened.fileRevision,
535550
};
536551
},
537552
);
@@ -606,6 +621,7 @@ export const issueAssetUrl = Effect.fn("AssetAccess.issueAssetUrl")(function* (i
606621
claims = finalized.claims;
607622
fileName = finalized.fileName;
608623
imageDimensions = finalized.imageDimensions;
624+
fileRevision = finalized.fileRevision;
609625
break;
610626
}
611627
case "draft-workspace-file": {

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

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -456,6 +456,98 @@ describe("bounded binary previews", () => {
456456
});
457457
import { OFFICE_PREVIEW_MAX_COLUMNS, type OfficeWorkerResult } from "./officePreviewProtocol";
458458

459+
describe("workspace browser preview", () => {
460+
it("keeps scroll and form input through unrelated commands and reloads changed files", async () => {
461+
refresh.mockReset();
462+
assetUrlState.mockReset();
463+
const { WorkspaceBrowserPreview } = await import("./FilePreviewPanel");
464+
const url = URL.createObjectURL(
465+
new Blob(
466+
[
467+
`<input id="note"><div style="height:4000px"></div><script>
468+
addEventListener("message", (event) => {
469+
if (event.data === "edit") {
470+
document.getElementById("note").value = "Keep my place";
471+
scrollTo(0, 800);
472+
}
473+
parent.postMessage({ value: document.getElementById("note").value, scrollTop: scrollY }, "*");
474+
});
475+
parent.postMessage("preview-ready", "*");
476+
</script>`,
477+
],
478+
{ type: "text/html" },
479+
),
480+
);
481+
const ready = vi.fn();
482+
const onMessage = (event: MessageEvent) => {
483+
if (event.data === "preview-ready") ready();
484+
};
485+
window.addEventListener("message", onMessage);
486+
using _fixture = {
487+
[Symbol.dispose]() {
488+
window.removeEventListener("message", onMessage);
489+
URL.revokeObjectURL(url);
490+
},
491+
};
492+
const state = (suffix: string, fileRevision?: string) =>
493+
assetUrlState.mockReturnValue({
494+
_tag: "Success",
495+
url: `${url}#${suffix}`,
496+
expiresAt: 3_600_000,
497+
...(fileRevision === undefined ? {} : { fileRevision }),
498+
});
499+
const preview = (mutation: string | null) => (
500+
<div style={{ display: "flex", flexDirection: "column", height: 400, width: 600 }}>
501+
<WorkspaceBrowserPreview
502+
environmentId={EnvironmentId.make("test")}
503+
threadRef={{ environmentId: EnvironmentId.make("test"), threadId: ThreadId.make("test") }}
504+
draft={false}
505+
absolutePath="/repo/report.html"
506+
workspaceRoot="/repo"
507+
title="report.html"
508+
workspaceMutationId={mutation}
509+
/>
510+
</div>
511+
);
512+
const readState = (frame: HTMLIFrameElement, command = "read") =>
513+
new Promise<{ value: string; scrollTop: number }>((resolve) => {
514+
const receive = (event: MessageEvent) => {
515+
if (event.source !== frame.contentWindow || typeof event.data !== "object") return;
516+
window.removeEventListener("message", receive);
517+
resolve(event.data);
518+
};
519+
window.addEventListener("message", receive);
520+
frame.contentWindow!.postMessage(command, "*");
521+
});
522+
523+
state("initial", "one");
524+
await using screen = await render(preview(null));
525+
await vi.waitFor(() => expect(ready).toHaveBeenCalledTimes(1));
526+
const frame = screen.container.querySelector("iframe")!;
527+
expect(await readState(frame, "edit")).toEqual({ value: "Keep my place", scrollTop: 800 });
528+
529+
for (const mutation of ["first-command", "next-command"]) {
530+
state(mutation, "one");
531+
await screen.rerender(preview(mutation));
532+
expect(screen.container.querySelector("iframe")).toBe(frame);
533+
expect(await readState(frame)).toEqual({ value: "Keep my place", scrollTop: 800 });
534+
}
535+
536+
state("next-command", "two");
537+
await screen.rerender(preview("file-edit"));
538+
await vi.waitFor(() => expect(ready).toHaveBeenCalledTimes(2));
539+
const edited = screen.container.querySelector("iframe")!;
540+
expect(edited).not.toBe(frame);
541+
expect(await readState(edited)).toEqual({ value: "", scrollTop: 0 });
542+
543+
state("legacy");
544+
await screen.rerender(preview("legacy-command"));
545+
await vi.waitFor(() => expect(ready).toHaveBeenCalledTimes(3));
546+
await screen.rerender(preview("legacy-edit"));
547+
await vi.waitFor(() => expect(ready).toHaveBeenCalledTimes(4));
548+
});
549+
});
550+
459551
describe("large text preview recovery", () => {
460552
it("retains the workspace viewer across URL renewals and reloads revisions and manual refreshes", async () => {
461553
const { WorkspaceLargeTextPreview } = await import("./FilePreviewPanel");

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ function WorkspaceImagePreview(props: {
221221
);
222222
}
223223

224-
function WorkspaceBrowserPreview(props: {
224+
export function WorkspaceBrowserPreview(props: {
225225
readonly environmentId: EnvironmentId;
226226
readonly threadRef: ScopedThreadRef;
227227
readonly draft: boolean;
@@ -237,11 +237,13 @@ function WorkspaceBrowserPreview(props: {
237237
workspaceRoot: props.workspaceRoot,
238238
absolutePath: props.absolutePath,
239239
});
240-
const assetUrl = useAssetUrlState(props.environmentId, resource);
240+
const assetUrl = useAssetUrlState(props.environmentId, resource, props.workspaceMutationId);
241+
const fileRevision = assetUrl._tag === "Success" ? assetUrl.fileRevision : undefined;
242+
const revision = fileRevision ?? props.workspaceMutationId;
241243
const revisionSuffix =
242-
props.workspaceMutationId === null
244+
revision === null
243245
? ""
244-
: `${assetUrl._tag === "Success" && assetUrl.url.includes("?") ? "&" : "?"}workspace-revision=${encodeURIComponent(props.workspaceMutationId)}`;
246+
: `${assetUrl._tag === "Success" && assetUrl.url.includes("?") ? "&" : "?"}${fileRevision !== undefined ? "file" : "workspace"}-revision=${encodeURIComponent(revision)}`;
245247

246248
if (assetUrl._tag === "Failure") {
247249
return (
@@ -260,7 +262,7 @@ function WorkspaceBrowserPreview(props: {
260262
return (
261263
<BrowserDocumentFrame
262264
src={`${assetUrl.url}${revisionSuffix}`}
263-
documentKey={`${props.environmentId}:${resource._tag}:${props.threadRef.threadId}:${props.absolutePath}:${props.workspaceMutationId}`}
265+
documentKey={JSON.stringify([props.environmentId, resource, revision])}
264266
title={props.title}
265267
pdf={isPdfPreviewFile(props.absolutePath)}
266268
/>

0 commit comments

Comments
 (0)