Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

fix: Reconnect responsive screenshots after preview restart (#6205)

Oleg Isonenf2cece41ee67
diff --git a/packages/cli/src/commands/mcp-preview.test.ts b/packages/cli/src/commands/mcp-preview.test.ts
index 7bad6de076..1da15f28a1 100644
--- a/packages/cli/src/commands/mcp-preview.test.ts
+++ b/packages/cli/src/commands/mcp-preview.test.ts
@@ -1,5 +1,8 @@
import { expect, test, vi } from "vitest";
-import { BrowserStartupError } from "@webstudio-is/vision/browser";
+import {
+ BrowserSessionClosedError,
+ BrowserStartupError,
+} from "@webstudio-is/vision/browser";
import {
createScreenshotCaptureSession,
defaultScreenshotDependencies,
@@ -653,6 +656,93 @@ test("reuses and closes one browser capture session for session screenshots", as
expect(preview.stop).toHaveBeenCalledOnce();
});
+test("reconnects a screenshot session after preview restart", async () => {
+ let running = false;
+ const preview = {
+ status: vi.fn(() =>
+ running
+ ? {
+ url: "http://127.0.0.1:3000/",
+ running: true as const,
+ mode: "iterative" as const,
+ }
+ : { running: false as const }
+ ),
+ startAndWait: vi.fn(async () => {
+ running = true;
+ return {
+ url: "http://127.0.0.1:3000/",
+ running: true as const,
+ mode: "iterative" as const,
+ };
+ }),
+ resolveUrl: vi.fn((path: string) => `http://127.0.0.1:3000${path}`),
+ };
+ const connectionClosed = new BrowserSessionClosedError(
+ "Browser DevTools connection closed."
+ );
+ const firstClose = vi.fn(async () => undefined);
+ const firstCapturePage = vi.fn(async () => {
+ throw connectionClosed;
+ });
+ const captureScreenshot = createCaptureScreenshotMock([]);
+ const secondCapturePage = vi.fn(
+ async (optionsList) => await Promise.all(optionsList.map(captureScreenshot))
+ );
+ const createCaptureSession = vi
+ .fn()
+ .mockReturnValueOnce({
+ capture: vi.fn(),
+ capturePage: firstCapturePage,
+ close: firstClose,
+ })
+ .mockReturnValueOnce({
+ capture: vi.fn(),
+ capturePage: secondCapturePage,
+ close: vi.fn(async () => undefined),
+ });
+ const progress: string[] = [];
+ const handlers = createMcpPreviewHandlers({
+ preview,
+ isStale: () => false,
+ preparePreview: vi.fn(async () => ({ cwd: "/tmp/preview" })),
+ createCaptureSession,
+ });
+
+ await handlers.startPreview({ source: "session", mode: "iterative" });
+ await expect(
+ handlers.capturePageScreenshots(
+ [
+ {
+ path: "/",
+ source: "session",
+ viewport: { width: 1440, height: 900 },
+ fullPage: true,
+ },
+ ],
+ { report: (message) => progress.push(message) }
+ )
+ ).resolves.toEqual([
+ expect.objectContaining({
+ viewport: { width: 1440, height: 900 },
+ }),
+ ]);
+
+ expect(preview.startAndWait).toHaveBeenCalledOnce();
+ expect(createCaptureSession).toHaveBeenCalledTimes(2);
+ expect(firstCapturePage).toHaveBeenCalledOnce();
+ expect(firstClose).toHaveBeenCalledOnce();
+ expect(secondCapturePage).toHaveBeenCalledWith([
+ expect.objectContaining({
+ url: "http://127.0.0.1:3000/",
+ width: 1440,
+ height: 900,
+ fullPage: true,
+ }),
+ ]);
+ expect(progress).toContain("tool screenshot reconnecting browser session");
+});
+
test("times out a stalled screenshot after preview start and releases its session", async () => {
let running = false;
const stop = vi.fn(async () => {
diff --git a/packages/cli/src/commands/mcp-preview.ts b/packages/cli/src/commands/mcp-preview.ts
index 2d515e02aa..f306a07507 100644
--- a/packages/cli/src/commands/mcp-preview.ts
+++ b/packages/cli/src/commands/mcp-preview.ts
@@ -11,7 +11,10 @@ import {
} from "../screenshot";
import { inspectGeneratedBuildMetrics } from "../generated-build-metrics";
import { createExclusiveAsyncRunner, withTimeout } from "../async-utils";
-import { defaultScreenshotTimeout } from "@webstudio-is/vision/browser";
+import {
+ defaultScreenshotTimeout,
+ isBrowserSessionClosedError,
+} from "@webstudio-is/vision/browser";
import {
preparePreviewProject,
previewDefaultTemplate,
@@ -355,6 +358,24 @@ export const createMcpPreviewHandlers = ({
captureSessionConfig = nextConfig;
return captureSession;
};
+ const captureWithSessionReconnect = async <Result>(
+ input: McpScreenshotInput,
+ progress: McpToolProgress | undefined,
+ capture: (
+ session: Awaited<ReturnType<typeof getCaptureSession>>
+ ) => Promise<Result>
+ ) => {
+ try {
+ return await capture(await getCaptureSession(input));
+ } catch (error) {
+ if (isBrowserSessionClosedError(error) === false) {
+ throw error;
+ }
+ progress?.report("tool screenshot reconnecting browser session");
+ await closeCaptureSession().catch(() => undefined);
+ return await capture(await getCaptureSession(input));
+ }
+ };
const isPreviewTargetCompatible = (
input: McpPreviewInput,
mode: PreviewMode,
@@ -579,21 +600,29 @@ export const createMcpPreviewHandlers = ({
const result = await captureWithTimeout(
async () => {
if (managedCapture && createCaptureSession !== undefined) {
- const captureSession = await getCaptureSession(input);
- let captureResult = await captureSession.capture(captureOptions);
- for (
- let retry = 0;
- retry < 2 &&
- captureResult.navigation?.generatedSiteRootPresent === false;
- retry += 1
- ) {
- progress?.report(
- "tool screenshot waiting for refreshed generated route"
- );
- await sleep(1000);
- captureResult = await captureSession.capture(captureOptions);
- }
- return captureResult;
+ return await captureWithSessionReconnect(
+ input,
+ progress,
+ async (captureSession) => {
+ let captureResult =
+ await captureSession.capture(captureOptions);
+ for (
+ let retry = 0;
+ retry < 2 &&
+ captureResult.navigation?.generatedSiteRootPresent ===
+ false;
+ retry += 1
+ ) {
+ progress?.report(
+ "tool screenshot waiting for refreshed generated route"
+ );
+ await sleep(1000);
+ captureResult =
+ await captureSession.capture(captureOptions);
+ }
+ return captureResult;
+ }
+ );
}
return await captureScreenshot({
...captureOptions,
@@ -656,15 +685,21 @@ export const createMcpPreviewHandlers = ({
);
const results = await captureWithTimeout(
async () => {
- const captureSession = await getCaptureSession(firstInput);
- return await captureSession.capturePage(
- inputs.map((input, index) => {
- const url = urls[index];
- if (url === undefined) {
- throw new Error("Screenshot URL resolution was incomplete.");
- }
- return getCaptureOptions(input, url);
- })
+ return await captureWithSessionReconnect(
+ firstInput,
+ progress,
+ async (captureSession) =>
+ await captureSession.capturePage(
+ inputs.map((input, index) => {
+ const url = urls[index];
+ if (url === undefined) {
+ throw new Error(
+ "Screenshot URL resolution was incomplete."
+ );
+ }
+ return getCaptureOptions(input, url);
+ })
+ )
);
},
timeout,
diff --git a/packages/vision/src/screenshot-browser-cdp.ts b/packages/vision/src/screenshot-browser-cdp.ts
index 747f855105..de454d057b 100644
--- a/packages/vision/src/screenshot-browser-cdp.ts
+++ b/packages/vision/src/screenshot-browser-cdp.ts
@@ -163,7 +163,16 @@ type CdpMessage = {
error?: { message?: string };
};
-class BrowserSessionClosedError extends Error {}
+export class BrowserSessionClosedError extends Error {
+ readonly code = "BROWSER_SESSION_CLOSED";
+}
+
+export const isBrowserSessionClosedError = (
+ error: unknown
+): error is BrowserSessionClosedError =>
+ error instanceof Error &&
+ "code" in error &&
+ error.code === "BROWSER_SESSION_CLOSED";
class CdpSession {
#nextId = 1;