Skip to content

Commit 559a3c6

Browse files
Wesley SmitsWesley Smits
authored andcommitted
fix(server): streamed desktop previews receive viewport dimensions
1 parent 0712398 commit 559a3c6

3 files changed

Lines changed: 53 additions & 11 deletions

File tree

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

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,9 @@ const PNG_HEADER = (() => {
8585

8686
function makeSession(frame?: ReturnType<typeof makeFrame>) {
8787
const events = new NodeEvents.EventEmitter();
88+
const metrics = { ratio: 2, width: 1280, height: 800 };
8889
return {
90+
metrics,
8991
on: vi.fn((name: string, listener: () => void) => events.on(name, listener)),
9092
emit: (name: string) => events.emit(name),
9193
detach: vi.fn(async () => {}),
@@ -100,13 +102,18 @@ function makeSession(frame?: ReturnType<typeof makeFrame>) {
100102
if (method === "Runtime.callFunctionOn") return { result: { value: PNG_HEADER } };
101103
if (method === "Page.getFrameTree") return { frameTree: { frame: { id: "main" } } };
102104
if (method === "Page.createIsolatedWorld") {
105+
const worldName = (input as { worldName?: string }).worldName;
103106
return {
104-
executionContextId: (input as { worldName?: string }).worldName === "t3-preview" ? 1 : 7,
107+
executionContextId:
108+
worldName === "t3-preview" ? 1 : worldName === "t3-preview-metrics" ? 9 : 7,
105109
};
106110
}
107111
if (method === "Runtime.evaluate" && (input as { contextId?: number }).contextId === 1) {
108112
return { result: { value: [] } };
109113
}
114+
if (method === "Runtime.evaluate" && (input as { contextId?: number }).contextId === 9) {
115+
return { result: { value: metrics } };
116+
}
110117
if (method === "Page.addScriptToEvaluateOnNewDocument") frame?.recording.resolve();
111118
if (method === "Input.dispatchKeyEvent" && (input as { commands?: unknown }).commands) {
112119
if (focusedFrame) focusedFrame.copy = keyCopy || focusedFrame.copy;
@@ -159,7 +166,7 @@ function makeContext(onClose?: (context: BrowserContext) => void) {
159166
frames: () => [page],
160167
url: () => url,
161168
title: vi.fn(async () => "test page"),
162-
viewportSize: () => viewport,
169+
viewportSize: vi.fn<Page["viewportSize"]>(() => viewport),
163170
setViewportSize: vi.fn(async (size: typeof viewport) => {
164171
viewport = size;
165172
}),
@@ -627,6 +634,33 @@ it.live("enforces provider ownership and explicit targets when a session has mul
627634
).pipe(Effect.provide(layer)),
628635
);
629636

637+
it.live("sends desktop viewport dimensions when Playwright has no emulated viewport", () =>
638+
Effect.scoped(
639+
Effect.gen(function* () {
640+
desktopRendersNext = true;
641+
const { browser, tabId } = yield* ready;
642+
const { page } = desktopConnections[0]!.context;
643+
page.viewportSize.mockReturnValue(null);
644+
page.setViewportSize.mockClear();
645+
646+
const viewer = yield* browser.attachViewer(viewerInput(tabId, true));
647+
const outputs = yield* Queue.takeAll(viewer.output);
648+
expect(outputs).toContainEqual({ _tag: "viewport", width: 1280, height: 800 });
649+
650+
const session = desktopConnections[0]!.context.sessions[0]!;
651+
session.metrics.width = 960;
652+
session.metrics.height = 600;
653+
session.emit("Page.frameResized");
654+
expect(yield* Queue.take(viewer.output)).toEqual({
655+
_tag: "viewport",
656+
width: 960,
657+
height: 600,
658+
});
659+
expect(page.setViewportSize).not.toHaveBeenCalled();
660+
}),
661+
).pipe(Effect.provide(layer)),
662+
);
663+
630664
it.live("streams to a read-only viewer without allowing takeover, input, or viewport changes", () =>
631665
Effect.scoped(
632666
Effect.gen(function* () {

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

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -617,9 +617,12 @@ const make = Effect.gen(function* () {
617617
});
618618
};
619619

620-
const broadcastViewport = (tab: ServerTab) => {
621-
const size = layoutSize(tab);
622-
if (!size) return;
620+
const broadcastViewport = async (tab: ServerTab) => {
621+
let size = layoutSize(tab);
622+
if (!size) {
623+
const { width, height } = await ServerBrowserPage.readPageMetrics(tab.cdp);
624+
size = { width, height };
625+
}
623626
for (const viewer of tab.viewers) viewer.push({ _tag: "viewport", ...size });
624627
};
625628

@@ -636,7 +639,7 @@ const make = Effect.gen(function* () {
636639
UNATTACHED_FILL_VIEWPORT;
637640
await tab.page.setViewportSize({ width: size.width, height: size.height });
638641
await applyZoom(tab);
639-
broadcastViewport(tab);
642+
await broadcastViewport(tab);
640643
};
641644

642645
const applyRendering = async (tab: ServerTab, snapshot: PreviewSessionSnapshot) => {
@@ -649,7 +652,7 @@ const make = Effect.gen(function* () {
649652
if (zoomFactor !== tab.zoomFactor && !tab.desktop) {
650653
tab.zoomFactor = zoomFactor;
651654
await applyZoom(tab);
652-
broadcastViewport(tab);
655+
await broadcastViewport(tab);
653656
}
654657
};
655658

@@ -777,7 +780,12 @@ const make = Effect.gen(function* () {
777780
captureLock: Promise.resolve(),
778781
capturing: 0,
779782
};
780-
if (!desktop) {
783+
if (desktop) {
784+
cdp.on("Page.frameResized", () => {
785+
if (tab.viewers.size > 0) void broadcastViewport(tab).catch(constVoid);
786+
});
787+
await cdp.send("Page.enable");
788+
} else {
781789
await page.setViewportSize(fixedViewportSize(tab.setting) ?? UNATTACHED_FILL_VIEWPORT);
782790
}
783791
await applyRendering(tab, snapshot);
@@ -2191,7 +2199,7 @@ const make = Effect.gen(function* () {
21912199
const current = tab.page.viewportSize();
21922200
if (current?.width === width && current.height === height) return;
21932201
await tab.page.setViewportSize({ width, height });
2194-
broadcastViewport(tab);
2202+
await broadcastViewport(tab);
21952203
return;
21962204
}
21972205
case "viewport": {
@@ -2388,7 +2396,7 @@ const make = Effect.gen(function* () {
23882396
),
23892397
});
23902398
});
2391-
broadcastViewport(tab);
2399+
yield* Effect.promise(() => broadcastViewport(tab));
23922400
yield* Effect.promise(() => startScreencast(1));
23932401
// An idle page does not repaint for a new screencast, so the viewer
23942402
// starts from a still unless a live frame beat it.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ const pngSize = (base64: string) => {
414414
* A page's display ratio and CSS viewport, read in an isolated world since page script can
415415
* reassign `devicePixelRatio`, `innerWidth`, and `innerHeight` in its own, and its page zoom.
416416
*/
417-
const readPageMetrics = async (cdp: CDPSession) => {
417+
export const readPageMetrics = async (cdp: CDPSession) => {
418418
const { frameTree } = await cdp.send("Page.getFrameTree");
419419
const { executionContextId } = await cdp.send("Page.createIsolatedWorld", {
420420
frameId: frameTree.frame.id,

0 commit comments

Comments
 (0)