Skip to content

Commit 5a18571

Browse files
committed
fix(server): a session keeps at most one unanswered preview screenshot
1 parent 06e137b commit 5a18571

2 files changed

Lines changed: 47 additions & 4 deletions

File tree

‎apps/server/src/preview/ServerBrowserPage.test.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -413,4 +413,37 @@ describe("server browser capture", () => {
413413
vi.useRealTimers();
414414
}
415415
});
416+
417+
it("sends no new screenshot while an earlier one is unanswered", async () => {
418+
vi.useFakeTimers();
419+
try {
420+
const firstAnswer = Promise.withResolvers<{ data: string }>();
421+
const send = vi
422+
.fn()
423+
.mockReturnValueOnce(firstAnswer.promise)
424+
.mockResolvedValue({ data: "second" });
425+
const cdp = { send } as unknown as CDPSession;
426+
const outcome = (capture: Promise<string>) =>
427+
capture.then(
428+
(data) => data,
429+
(error: unknown) => error,
430+
);
431+
432+
const first = outcome(ServerBrowserPage.captureViewport(cdp, { format: "jpeg" }));
433+
await vi.advanceTimersByTimeAsync(5_000);
434+
expect(await first).toMatchObject({ tag: "PreviewAutomationTimeoutError" });
435+
436+
const blocked = outcome(ServerBrowserPage.captureViewport(cdp, { format: "jpeg" }));
437+
await vi.advanceTimersByTimeAsync(5_000);
438+
expect(await blocked).toMatchObject({ tag: "PreviewAutomationTimeoutError" });
439+
expect(send).toHaveBeenCalledTimes(1);
440+
441+
firstAnswer.resolve({ data: "first" });
442+
await vi.advanceTimersByTimeAsync(0);
443+
expect(await ServerBrowserPage.captureViewport(cdp, { format: "jpeg" })).toBe("second");
444+
expect(send).toHaveBeenCalledTimes(2);
445+
} finally {
446+
vi.useRealTimers();
447+
}
448+
});
416449
});

‎apps/server/src/preview/ServerBrowserPage.ts‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -452,6 +452,9 @@ const readPageMetrics = async (cdp: CDPSession) => {
452452
);
453453
};
454454

455+
// CDP cannot cancel a screenshot, so a session keeps at most one unanswered.
456+
const unansweredCaptures = new WeakMap<CDPSession, Promise<void>>();
457+
455458
// Never pass a clip scale: Chromium mirrors the top-left of the page into a `backdrop-filter`
456459
// in any capture it shrinks.
457460
export const captureViewport = async (
@@ -462,11 +465,18 @@ export const captureViewport = async (
462465
const expired = new Promise<never>((_, reject) => {
463466
timer = setTimeout(() => reject(noFrame()), CAPTURE_TIMEOUT_MS);
464467
});
465-
const captured = cdp.send("Page.captureScreenshot", {
466-
format: options.format,
467-
...(options.quality === undefined ? {} : { quality: options.quality }),
468-
});
469468
try {
469+
const unanswered = unansweredCaptures.get(cdp);
470+
if (unanswered) await Promise.race([unanswered, expired]);
471+
const captured = cdp.send("Page.captureScreenshot", {
472+
format: options.format,
473+
...(options.quality === undefined ? {} : { quality: options.quality }),
474+
});
475+
const settled = captured.then(constVoid, constVoid);
476+
unansweredCaptures.set(cdp, settled);
477+
void settled.then(() => {
478+
if (unansweredCaptures.get(cdp) === settled) unansweredCaptures.delete(cdp);
479+
});
470480
return (await Promise.race([captured, expired])).data;
471481
} finally {
472482
clearTimeout(timer);

0 commit comments

Comments
 (0)