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.
TypeScript accessibilityalternativecloudflarecloudflare-workersdesignfreefrontendopen-sourceradix-uireactremixweb-developmentwebflowwebsite-builderwebsite-developmentwebsiteswebstudio
fix: Improve MCP preview verification reliability (#6084)
Oleg Isonen63fcc9c5a68d
diff --git a/packages/cli/src/commands/mcp-preview.test.ts b/packages/cli/src/commands/mcp-preview.test.tsindex d538c173a2..0530bf027b 100644--- a/packages/cli/src/commands/mcp-preview.test.ts+++ b/packages/cli/src/commands/mcp-preview.test.ts@@ -400,6 +400,7 @@ test("passes explicit preview source to preview preparation", async () => {{preserveGeneratedProject: false,prepareForIncrementalGeneration: true,+ reportProgress: expect.any(Function),});expect(prepareSessionDataFile).toHaveBeenCalledOnce();diff --git a/packages/cli/src/commands/mcp-preview.ts b/packages/cli/src/commands/mcp-preview.tsindex 4d4d0b70f1..3746591202 100644--- a/packages/cli/src/commands/mcp-preview.ts+++ b/packages/cli/src/commands/mcp-preview.ts@@ -69,6 +69,17 @@ type McpToolProgress = {report: (message: string) => void;};+const getPreparationProgress = (+ progress: McpToolProgress | undefined,+ tool: "screenshot" | "preview.start"+) =>+ progress === undefined+ ? {}+ : {+ reportProgress: (message: string) =>+ progress.report(`tool ${tool} ${message}`),+ };+export const createPreviewFreshness = () => {let revision = 0;let freshRevision = -1;@@ -255,9 +266,11 @@ const prepareDefaultPreviewProject = ({preserveGeneratedProject = false,prepareForIncrementalGeneration = false,+ reportProgress,}: {preserveGeneratedProject?: boolean;prepareForIncrementalGeneration?: boolean;+ reportProgress?: (message: string) => void;} = {}) =>preparePreviewProject({@@ -271,6 +284,7 @@ const prepareDefaultPreviewProject = (prepareSessionDataFile,preserveGeneratedProject,prepareForIncrementalGeneration,+ reportProgress,});export const createMcpPreviewHandlers = ({@@ -430,6 +444,7 @@ export const createMcpPreviewHandlers = ({{preserveGeneratedProject: canReusePreview && mode === "iterative",prepareForIncrementalGeneration: mode === "iterative",+ ...getPreparationProgress(progress, "screenshot"),});const projectVersion = getProjectVersion();@@ -525,6 +540,7 @@ export const createMcpPreviewHandlers = ({{preserveGeneratedProject: canReusePreview && mode === "iterative",prepareForIncrementalGeneration: mode === "iterative",+ ...getPreparationProgress(progress, "preview.start"),});const projectVersion = getProjectVersion();diff --git a/packages/cli/src/commands/preview.test.ts b/packages/cli/src/commands/preview.test.tsindex 18a8ef9727..6bed0dfd6a 100644--- a/packages/cli/src/commands/preview.test.ts+++ b/packages/cli/src/commands/preview.test.ts@@ -455,7 +455,10 @@ test("installs isolated generated dependencies when the cli does not ship them",expect(execFile).toHaveBeenCalledWith("npm",expect.arrayContaining(["install", "--legacy-peer-deps"]),- expect.objectContaining({ cwd: "/tmp/project/.webstudio/preview" })+ expect.objectContaining({+ cwd: "/tmp/project/.webstudio/preview",+ timeout: 120_000,+ }));expect(writeFile).toHaveBeenCalledWith("/tmp/project/.webstudio/preview/node_modules/.webstudio-preview-dependencies",@@ -533,7 +536,11 @@ test("uses npm-cli from an npx launcher and forwards a writable npm cache", asyn"C:\\Program Files\\nodejs\\node_modules\\npm\\bin\\npm-cli.js","install",]),- { cwd: "C:/project/.webstudio/preview", env }+ {+ cwd: "C:/project/.webstudio/preview",+ env,+ timeout: 120_000,+ });});@@ -608,6 +615,7 @@ test("materializes session data before previewing from session source", async ()const previousDirectory = cwd();const projectDir = join(tmpdir(), `webstudio-preview-test-${randomUUID()}`);let expectedPreviewProjectDir = "";+ const progress: string[] = [];const prepareSessionDataFile = vi.fn(async () => {await mkdir(join(projectDir, ".webstudio"), { recursive: true });await writeFile(join(projectDir, ".webstudio", "data.json"), "{}");@@ -630,6 +638,7 @@ test("materializes session data before previewing from session source", async ()prepareSessionDataFile,prebuildProject,ensureDependencies: vi.fn(async () => undefined),+ reportProgress: (message) => progress.push(message),})).resolves.toEqual({cwd: expectedPreviewProjectDir,@@ -647,6 +656,12 @@ test("materializes session data before previewing from session source", async ()previewIdentity: true,sourceAssetsDirectory: join(expectedPreviewProjectDir, "..", "assets"),});+ expect(progress).toEqual([+ "materializing session project data",+ "generating preview files",+ "checking or installing generated preview dependencies (2 minute timeout)",+ "generated preview project is ready",+ ]);});test("refreshes an iterative generated project without replacing its directory", async () => {diff --git a/packages/cli/src/commands/preview.ts b/packages/cli/src/commands/preview.tsindex 03ac549a1a..b852f012a4 100644--- a/packages/cli/src/commands/preview.ts+++ b/packages/cli/src/commands/preview.ts@@ -158,12 +158,17 @@ const cliNodeModulesCandidates = getNodeModulesSearchPaths(import.meta.url);const execFileAsync = promisify(execFile);const dependencyMarker = ".webstudio-preview-dependencies";const developmentCliVersion = "0.0.0-webstudio-version";+const previewDependencyInstallTimeout = 2 * 60_000;type PreviewDependencyOperations = {access: (path: string) => Promise<void>;execFile: (file: string,args: string[],- options: { cwd: string; env: NodeJS.ProcessEnv }+ options: {+ cwd: string;+ env: NodeJS.ProcessEnv;+ timeout: number;+ }) => Promise<unknown>;lstat: (path: string) => Promise<{ isSymbolicLink: () => boolean }>;readFile: (path: string, encoding: "utf8") => Promise<string>;@@ -300,6 +305,7 @@ export const ensurePreviewDependencies = async (await operations.execFile(invocation.command, invocation.args, {cwd: previewProjectDir,env: operations.env,+ timeout: previewDependencyInstallTimeout,});} catch (error) {throw new Error(@@ -465,6 +471,7 @@ export const preparePreviewProject = async ({includeDraftPages = false,preserveGeneratedProject = false,prepareForIncrementalGeneration = false,+ reportProgress,prepareSessionDataFile = async () => {const connection = await resolveApiConnection();const session = createCliProjectSession({ connection });@@ -490,6 +497,7 @@ export const preparePreviewProject = async ({includeDraftPages?: boolean;preserveGeneratedProject?: boolean;prepareForIncrementalGeneration?: boolean;+ reportProgress?: (message: string) => void;prepareSessionDataFile?: () => Promise<void>;}): Promise<{cwd: string;@@ -498,6 +506,7 @@ export const preparePreviewProject = async ({}> => {const projectDir = cwd();if (source === "session") {+ reportProgress?.("materializing session project data");await prepareSessionDataFile();}try {@@ -527,6 +536,13 @@ export const preparePreviewProject = async ({if (generate === false) {return { cwd: projectDir };}+ const prepareDependencies = async () => {+ reportProgress?.(+ `checking or installing generated preview dependencies (${previewDependencyInstallTimeout / 60_000} minute timeout)`+ );+ await ensureDependencies(previewProjectDir);+ reportProgress?.("generated preview project is ready");+ };const buildCacheKey = await getBuildCacheKey({projectDir,@@ -544,33 +560,32 @@ export const preparePreviewProject = async ({"utf8").catch(() => undefined);if (cachedBuildKey === buildCacheKey && canReuseCachedProject) {- await ensureDependencies(previewProjectDir);+ await prepareDependencies();return { cwd: previewProjectDir, buildCacheKey, buildRequired: false };}}- if (generate) {- await runExclusive(async () => {- const reuseGeneratedProject =- preserveGeneratedProject && hasIncrementalInputs;- await preparePreviewDirectory(projectDir, reuseGeneratedProject);- await runInDirectory(previewProjectDir, async () => {- await prebuildProject({- assets,- template: getPreviewTemplates(template),- previewIdentity: true,- sourceAssetsDirectory: join(projectDir, LOCAL_ASSETS_DIR),- ...(silent ? { silent: true } : {}),- ...(includeDraftPages ? { includeDraftPages: true } : {}),- ...(reuseGeneratedProject ? { incremental: true } : {}),- ...(prepareForIncrementalGeneration- ? { preserveRouteTemplates: true }- : {}),- });+ await runExclusive(async () => {+ const reuseGeneratedProject =+ preserveGeneratedProject && hasIncrementalInputs;+ await preparePreviewDirectory(projectDir, reuseGeneratedProject);+ await runInDirectory(previewProjectDir, async () => {+ reportProgress?.("generating preview files");+ await prebuildProject({+ assets,+ template: getPreviewTemplates(template),+ previewIdentity: true,+ sourceAssetsDirectory: join(projectDir, LOCAL_ASSETS_DIR),+ ...(silent ? { silent: true } : {}),+ ...(includeDraftPages ? { includeDraftPages: true } : {}),+ ...(reuseGeneratedProject ? { incremental: true } : {}),+ ...(prepareForIncrementalGeneration+ ? { preserveRouteTemplates: true }+ : {}),});- await ensureDependencies(previewProjectDir);});- }+ await prepareDependencies();+ });return {cwd: previewProjectDir,diff --git a/packages/cli/src/prebuild.test.ts b/packages/cli/src/prebuild.test.tsindex 215e609729..dbf4648ab3 100644--- a/packages/cli/src/prebuild.test.ts+++ b/packages/cli/src/prebuild.test.ts@@ -1374,6 +1374,50 @@ describe("prebuild", () => {await expectGeneratedRedirectFallback("app/routes/$.tsx");});+ test("preserves an authored catch-all page when redirects are configured", async () => {+ await writeSiteData(+ createSiteData({+ pages: [+ {+ id: "home",+ name: "Home",+ title: "Home",+ path: "",+ rootInstanceId: "root",+ meta: {},+ },+ {+ id: "not-found",+ name: "Not found",+ title: "Not found",+ path: "/*",+ rootInstanceId: "root",+ meta: { status: "404" },+ },+ ],+ })+ );++ await prebuild({+ assets: false,+ template: ["react-router"],+ preserveRouteTemplates: true,+ });+ await prebuild({+ assets: false,+ template: ["react-router"],+ incremental: true,+ });++ const route = await readFile("app/routes/$.tsx", "utf8");+ expect(route).toContain("../__generated__/$");+ expect(route).toContain("../__generated__/$.server");+ expect(route).not.toContain('new Response("Not Found"');+ await expect(+ readFile("app/__generated__/$.server.tsx", "utf8")+ ).resolves.toContain("status: 404");+ });+test("ignores the catch-all fallback when generating an SSG site", async () => {await writeSiteData(createSiteData({diff --git a/packages/cli/src/prebuild.ts b/packages/cli/src/prebuild.tsindex 31b307d34f..2754c25ab7 100644--- a/packages/cli/src/prebuild.ts+++ b/packages/cli/src/prebuild.ts@@ -1500,9 +1500,14 @@ export const prebuild = async (options: {generateRedirectsModule(pages.redirects));- if (pages.redirects !== undefined && pages.redirects.length > 0) {+ const redirectFallbackPath = join(routesDir, "$.tsx");+ if (+ pages.redirects !== undefined &&+ pages.redirects.length > 0 &&+ generatedFiles.has(normalize(redirectFallbackPath)) === false+ ) {await writeGeneratedFile(- join(routesDir, "$.tsx"),+ redirectFallbackPath,generateRedirectFallbackRoute(options.template.includes("react-router") ? "react-router" : "remix")diff --git a/packages/cli/src/screenshot.test.ts b/packages/cli/src/screenshot.test.tsindex 0a31aaa607..b30fd3b785 100644--- a/packages/cli/src/screenshot.test.ts+++ b/packages/cli/src/screenshot.test.ts@@ -1,5 +1,6 @@import { describe, expect, test, vi } from "vitest";import { constants } from "node:fs";+import { Buffer } from "node:buffer";import { mkdir, mkdtemp, rm } from "node:fs/promises";import { tmpdir } from "node:os";import { join } from "node:path";@@ -33,7 +34,7 @@ const createDependencies = (kill: vi.fn(),once: vi.fn(),})),- readFile: vi.fn(),+ readFile: vi.fn(async () => Buffer.from("image")) as never,writeFile: vi.fn(),mkdtemp: vi.fn(async () => "/tmp/webstudio-browser"@@ -43,6 +44,7 @@ const createDependencies = (createWebSocket: vi.fn(),captureBrowserScreenshot: vi.fn(async () => undefined),installCommand: vi.fn(async () => undefined),+ readArtifactByte: vi.fn(async () => 1),getuid: vi.fn(() => 1000),now: vi.fn(() => 123),...overrides,@@ -466,6 +468,37 @@ describe("captureScreenshot", () => {recursive: true,});});++ test("rejects an empty screenshot artifact", async () => {+ const dependencies = createDependencies({+ which: vi.fn(async (command) =>+ command === "chromium" ? "/usr/bin/chromium" : undefined+ ),+ readArtifactByte: vi.fn(async () => 0),+ captureBrowserScreenshot: vi.fn(async () => ({+ viewportWidth: 1440,+ viewportHeight: 900,+ contentWidth: 1440,+ contentHeight: 900,+ horizontalOverflow: false,+ images: [],+ resources: [],+ })),+ });++ await expect(+ captureScreenshot(+ {+ url: "https://example.com",+ output: "empty.png",+ width: 1440,+ height: 900,+ browser: "auto",+ },+ dependencies+ )+ ).rejects.toThrow("Screenshot artifact is empty");+ });});test("resets a reusable capture session after browser startup rejects", async () => {diff --git a/packages/cli/src/screenshot.ts b/packages/cli/src/screenshot.tsindex 3175c20911..1dcc7cba57 100644--- a/packages/cli/src/screenshot.ts+++ b/packages/cli/src/screenshot.ts@@ -1,5 +1,5 @@import { constants } from "node:fs";-import { access, mkdir, readdir } from "node:fs/promises";+import { access, mkdir, open, readdir } from "node:fs/promises";import { homedir, tmpdir } from "node:os";import { dirname, join, resolve } from "node:path";import { spawn } from "node:child_process";@@ -64,6 +64,7 @@ export type ScreenshotDependencies = {options: BrowserScreenshotOptions) => Promise<BrowserScreenshotLayout | undefined>;installCommand: (file: string, args: readonly string[]) => Promise<void>;+ readArtifactByte: (path: string) => Promise<number>;getuid: () => number | undefined;now: () => number;};@@ -97,6 +98,15 @@ export const defaultScreenshotDependencies: ScreenshotDependencies = {});});},+ async readArtifactByte(path) {+ const file = await open(path, "r");+ try {+ const { bytesRead } = await file.read(new Uint8Array(1), 0, 1, 0);+ return bytesRead;+ } finally {+ await file.close();+ }+ },getuid: () => process.getuid?.(),now: () => Date.now(),};@@ -622,6 +632,26 @@ const getBrowserScreenshotOptions = (scale: options.scale,});+const validateScreenshotArtifact = async (+ output: string,+ dependencies: ScreenshotDependencies+) => {+ let bytesRead: number;+ try {+ bytesRead = await dependencies.readArtifactByte(output);+ } catch (cause) {+ throw Object.assign(+ new Error(`Screenshot artifact is unreadable: ${output}`),+ { code: "SCREENSHOT_ARTIFACT_UNREADABLE", cause }+ );+ }+ if (bytesRead === 0) {+ throw Object.assign(new Error(`Screenshot artifact is empty: ${output}`), {+ code: "SCREENSHOT_ARTIFACT_EMPTY",+ });+ }+};+const captureResolvedScreenshot = async (options: CaptureScreenshotOptions,browser: BrowserCandidate,@@ -650,6 +680,7 @@ const captureResolvedScreenshot = async (browserScreenshotOptions,dependencies);+ await validateScreenshotArtifact(output, dependencies);return {output,browser,@@ -781,6 +812,11 @@ export const createScreenshotCaptureSession = (const layouts = await activeBrowserSession.capturePage(captures.map((capture) => capture.browserOptions));+ await Promise.all(+ captures.map(({ output }) =>+ validateScreenshotArtifact(output, dependencies)+ )+ );return captures.map(({ options, output }, index) => {const layout = layouts[index];if (layout === undefined) {