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(cli): persist MCP failure diagnostics for issue reports (#6502)
Oleg Isonen6350169f1269
diff --git a/packages/cli/src/commands/mcp.test.ts b/packages/cli/src/commands/mcp.test.tsindex 0ab592ddd2..d017141683 100644--- a/packages/cli/src/commands/mcp.test.ts+++ b/packages/cli/src/commands/mcp.test.ts@@ -17,6 +17,7 @@ import {import { publicApiOperations } from "@webstudio-is/protocol";import { contentEngineLimits } from "@webstudio-is/content-engine/limits";import { updatePersistedMcpCheckpoint } from "./mcp-checkpoint";+import { createIssueReportFailureTracker } from "../project-session";import {__testing__,mcpOptions,@@ -26,6 +27,9 @@ import {const {getMcpDownloadAsset,+ getIssueReportFailureFile,+ persistIssueReportFailure,+ restoreIssueReportFailure,assertSingleOpCallToolSupported,applyMcpRunOptions,createMcpResourceErrorPayload,@@ -234,6 +238,53 @@ afterEach(async () => {);});+test("persists sanitized issue-report failure diagnostics for the next CLI process", async () => {+ const projectRoot = await mkdtemp(+ path.join(tmpdir(), "webstudio-mcp-issue-report-")+ );+ tempDirs.push(projectRoot);+ const filePath = getIssueReportFailureFile(projectRoot, "project-1");+ const firstProcess = createIssueReportFailureTracker();+ firstProcess.record(+ "update-text",+ new Error("Unable to transform response from server"),+ 125,+ { instanceId: "instance-1", text: "private customer content" }+ );++ await persistIssueReportFailure(filePath, firstProcess.snapshot());++ const secondProcess = createIssueReportFailureTracker();+ await restoreIssueReportFailure(filePath, secondProcess);+ expect(secondProcess.get()).toMatchObject({+ tool: "update-text",+ elapsedMs: 125,+ entityIds: [{ field: "instanceId", id: "instance-1" }],+ });+ expect(await readFile(filePath, "utf8")).not.toContain(+ "private customer content"+ );++ await persistIssueReportFailure(filePath, undefined);+ const clearedProcess = createIssueReportFailureTracker();+ await restoreIssueReportFailure(filePath, clearedProcess);+ expect(clearedProcess.get()).toBeUndefined();++ await writeFile(+ filePath,+ JSON.stringify({+ at: Date.now(),+ failure: { tool: "update-text", code: "MCP_TOOL_FAILED", private: true },+ })+ );+ const malformedProcess = createIssueReportFailureTracker();+ await restoreIssueReportFailure(filePath, malformedProcess);+ expect(malformedProcess.get()).toBeUndefined();+ await expect(readFile(filePath, "utf8")).rejects.toMatchObject({+ code: "ENOENT",+ });+});+const getArraySchemasWithoutItems = (schema: unknown): unknown[] => {if (schema === null || typeof schema !== "object") {return [];diff --git a/packages/cli/src/commands/mcp.ts b/packages/cli/src/commands/mcp.tsindex 846dc61805..96ab6cc885 100644--- a/packages/cli/src/commands/mcp.ts+++ b/packages/cli/src/commands/mcp.ts@@ -1,9 +1,11 @@import { cwd, stdin, stdout, stderr } from "node:process";+import { randomUUID } from "node:crypto";import {copyFile,mkdir,mkdtemp,readFile,+ rename,rm,writeFile,} from "node:fs/promises";@@ -27,6 +29,8 @@ import { diffPngFiles } from "@webstudio-is/vision/diff";import {publicApiOperationRequiresServerSupport,publicApiOperations,+ issueReportRecentFailureSchema,+ type IssueReportRecentFailure,} from "@webstudio-is/protocol";import * as httpClient from "@webstudio-is/http-client";import packageJson from "../../package.json" with { type: "json" };@@ -96,7 +100,7 @@ import { printJson } from "../json-output";import { isPlainRecord } from "../type-utils";import { withTimeout } from "../async-utils";import { checkForCliUpdate, type CliUpdate } from "../cli-update";-import { LOCAL_DATA_FILE } from "../config";+import { getLocalProjectStateDirectory, LOCAL_DATA_FILE } from "../config";import {assertMcpBatchMutationApproved,isMcpProjectsManifest,@@ -1836,6 +1840,61 @@ const getMcpDownloadAsset = async (return asset;};+const getIssueReportFailureFile = (projectRoot: string, projectId?: string) =>+ path.join(+ getLocalProjectStateDirectory(projectRoot, projectId),+ "issue-report-failure.json"+ );++const persistIssueReportFailure = async (+ filePath: string,+ snapshot: { failure: IssueReportRecentFailure; at: number } | undefined+) => {+ if (snapshot === undefined) {+ await rm(filePath, { force: true }).catch(() => undefined);+ return;+ }+ const temporaryPath = `${filePath}.${randomUUID()}.tmp`;+ try {+ await mkdir(path.dirname(filePath), { recursive: true });+ await writeFile(temporaryPath, JSON.stringify(snapshot), "utf8");+ await rename(temporaryPath, filePath);+ } catch {+ await rm(temporaryPath, { force: true }).catch(() => undefined);+ }+};++const restoreIssueReportFailure = async (+ filePath: string,+ failureTracker: ReturnType<typeof createIssueReportFailureTracker>+) => {+ try {+ const value: unknown = JSON.parse(await readFile(filePath, "utf8"));+ if (+ isPlainRecord(value) &&+ typeof value.at === "number" &&+ Number.isSafeInteger(value.at)+ ) {+ const failure = issueReportRecentFailureSchema.safeParse(value.failure);+ if (failure.success) {+ failureTracker.restore(failure.data, value.at);+ }+ if (+ failure.success === false ||+ failureTracker.snapshot() === undefined+ ) {+ await rm(filePath, { force: true }).catch(() => undefined);+ }+ } else {+ await rm(filePath, { force: true }).catch(() => undefined);+ }+ } catch {+ // Issue reporting is best effort; absent or malformed local diagnostics+ // must not prevent a project session from starting.+ await rm(filePath, { force: true }).catch(() => undefined);+ }+};+const createCliMcpHost = async ({projectRoot = cwd(),projectId,@@ -1867,6 +1926,11 @@ const createCliMcpHost = async ({const apiContract = await getCliServerApiContract(apiConnection);const operations = getSupportedPublicApiOperations(apiContract);const failureTracker = createIssueReportFailureTracker();+ const issueReportFailureFile = getIssueReportFailureFile(+ projectRoot,+ connection.projectId+ );+ await restoreIssueReportFailure(issueReportFailureFile, failureTracker);const session = createCliProjectSession({connection: apiConnection,projectRoot,@@ -2189,7 +2253,7 @@ const createCliMcpHost = async ({host,apiContract,toolCount: operations.length,- recordToolFailure(+ async recordToolFailure(canonicalTool: string,error: unknown,elapsedMs: number,@@ -2197,10 +2261,17 @@ const createCliMcpHost = async ({) {if (canonicalTool !== "report-issue") {failureTracker.record(canonicalTool, error, elapsedMs, input);+ await persistIssueReportFailure(+ issueReportFailureFile,+ failureTracker.snapshot()+ );}},- recordToolSuccess(canonicalTool: string) {+ async recordToolSuccess(canonicalTool: string) {failureTracker.succeed(canonicalTool);+ if (canonicalTool === "report-issue") {+ await persistIssueReportFailure(issueReportFailureFile, undefined);+ }},reportLog(message: string) {if (message.startsWith("ready with ")) {@@ -2331,7 +2402,13 @@ export const mcpSingleOpCall = async (options: McpSingleOpCallOptions) => {}return mcpHost;},- async ({ host, apiContract, scope }) => {+ async ({+ host,+ apiContract,+ scope,+ recordToolFailure,+ recordToolSuccess,+ }) => {assertMcpToolServerSupport(tool, apiContract);const core = createCliMcpCore(host);const persistedCheckpoint =@@ -2355,15 +2432,33 @@ export const mcpSingleOpCall = async (options: McpSingleOpCallOptions) => {throw new HandledCliError();}}- const result = await core.callTool({- name: tool,- input,- dryRun: options.dryRun,- });+ const callStartedAt = Date.now();+ let result: Awaited<ReturnType<typeof core.callTool>>;+ try {+ result = await core.callTool({+ name: tool,+ input,+ dryRun: options.dryRun,+ });+ } catch (error) {+ await recordToolFailure(+ tool,+ error,+ Date.now() - callStartedAt,+ input+ );+ throw error;+ }if (didTerminate) {throw new HandledCliError();}if (isMcpToolCallFailure(result)) {+ await recordToolFailure(+ tool,+ getMcpToolCallError(result),+ Date.now() - callStartedAt,+ input+ );activeCall = undefined;stderr.write(`${formatMcpStatusLine(@@ -2373,6 +2468,7 @@ export const mcpSingleOpCall = async (options: McpSingleOpCallOptions) => {printJson(result.structuredContent);throw new HandledCliError();}+ await recordToolSuccess(tool);if (tool === "checkpoint.ack" &&persistedCheckpoint?.nextCommand !== undefined &&@@ -2464,7 +2560,7 @@ const runMcpProjectsBatch = async ({);await withMcpHost(() => createCliMcpHost({ projectRoot: project.root }),- async ({ host, apiContract }) => {+ async ({ host, apiContract, recordToolFailure, recordToolSuccess }) => {const core = createCliMcpCore(host);const tools = new Map(core.listTools().map((tool) => [tool.name, tool])@@ -2482,16 +2578,29 @@ const runMcpProjectsBatch = async ({for (let index = startCall; index < project.calls.length; index++) {const call = project.calls[index]!;const tool = tools.get(call.tool);+ const callStartedAt = Date.now();await callStarted(index,call.dryRun || tool?.annotations.method !== "mutation");- const { checkpoint } = await executeMcpRunCall({- core,- call,- scope: { projectRoot: project.root },- });+ let checkpoint: PersistedMcpCheckpoint | undefined;+ try {+ ({ checkpoint } = await executeMcpRunCall({+ core,+ call,+ scope: { projectRoot: project.root },+ }));+ } catch (error) {+ await recordToolFailure(+ call.tool,+ error,+ Date.now() - callStartedAt,+ call.input+ );+ throw error;+ }await callSucceeded(index + 1);+ await recordToolSuccess(call.tool);const nextTool = project.calls[index + 1]?.tool;if (checkpoint !== undefined &&@@ -2574,6 +2683,15 @@ export const mcpRun = async (options: McpRunOptions) => {const results: unknown[] = [];let core: ReturnType<typeof createProjectSessionMcpCore<PublicApiCommand>>;let scope: McpProjectScope = {};+ let recordToolFailure:+ | ((+ tool: string,+ error: unknown,+ elapsedMs: number,+ input: unknown+ ) => Promise<void>)+ | undefined;+ let recordToolSuccess: ((tool: string) => Promise<void>) | undefined;let disposeHost: () => Promise<void> = async () => undefined;try {const mcpHost = await createCliMcpHost({@@ -2581,6 +2699,8 @@ export const mcpRun = async (options: McpRunOptions) => {managePreviewProcessSignals: false,});const { host, apiContract } = mcpHost;+ recordToolFailure = mcpHost.recordToolFailure;+ recordToolSuccess = mcpHost.recordToolSuccess;disposeHost = mcpHost.dispose;scope = mcpHost.scope;for (const call of calls) {@@ -2607,6 +2727,7 @@ export const mcpRun = async (options: McpRunOptions) => {try {for (const [index, call] of calls.entries()) {const callNumber = index + 1;+ const callStartedAt = Date.now();activeCall = { number: callNumber, tool: call.tool };stderr.write(`${formatMcpStatusLine(@@ -2620,6 +2741,7 @@ export const mcpRun = async (options: McpRunOptions) => {scope,});const session = result.structuredContent.meta.session;+ await recordToolSuccess?.(call.tool);const committed =session === undefined ? "" : `; committed=${session.committed}`;stderr.write(@@ -2661,6 +2783,12 @@ export const mcpRun = async (options: McpRunOptions) => {if (error instanceof McpRunCheckpointStop) {throw new HandledCliError();}+ await recordToolFailure?.(+ call.tool,+ error,+ Date.now() - callStartedAt,+ call.input+ );const structuredError = getMcpRunError(error);results.push({tool: call.tool,@@ -2822,6 +2950,9 @@ export const mcp = async (export const __testing__ = {getMcpDownloadAsset,+ getIssueReportFailureFile,+ persistIssueReportFailure,+ restoreIssueReportFailure,getCliUpdateInstructions,createMcpStatusReporter,formatMcpStatusLine,diff --git a/packages/cli/src/project-session.test.ts b/packages/cli/src/project-session.test.tsindex a965ca5189..f8a2c82551 100644--- a/packages/cli/src/project-session.test.ts+++ b/packages/cli/src/project-session.test.ts@@ -238,6 +238,15 @@ test("keeps a failed mutation available after a successful diagnostic read", ()tracker.record("screenshot", new Error("Browser failed"), 120);tracker.succeed("report-issue");expect(tracker.get()).toBeUndefined();++ const restored = createIssueReportFailureTracker(() => now);+ restored.restore({ tool: "update-text", code: "MCP_TOOL_FAILED" }, now + 1);+ expect(restored.get()).toBeUndefined();+ restored.restore(+ { tool: "update-text", code: "MCP_TOOL_FAILED" },+ now - 10 * 60_000 - 1+ );+ expect(restored.get()).toBeUndefined();});test("reports only the shape of an untransformable server response", () => {diff --git a/packages/cli/src/project-session.ts b/packages/cli/src/project-session.tsindex 9c0dc066ef..88f1bb34f2 100644--- a/packages/cli/src/project-session.ts+++ b/packages/cli/src/project-session.ts@@ -450,6 +450,13 @@ export const createIssueReportFailure = (export const createIssueReportFailureTracker = (now = Date.now) => {let recent: { failure: IssueReportRecentFailure; at: number } | undefined;+ const getRecent = () => {+ if (recent === undefined) {+ return;+ }+ const age = now() - recent.at;+ return age >= 0 && age <= 10 * 60_000 ? recent : undefined;+ };return {record(tool: string, error: unknown, elapsedMs?: number, input?: unknown) {recent = {@@ -458,9 +465,16 @@ export const createIssueReportFailureTracker = (now = Date.now) => {};},get() {- return recent !== undefined && now() - recent.at <= 10 * 60_000- ? recent.failure- : undefined;+ return getRecent()?.failure;+ },+ restore(failure: IssueReportRecentFailure, at: number) {+ const age = now() - at;+ if (age >= 0 && age <= 10 * 60_000) {+ recent = { failure, at };+ }+ },+ snapshot() {+ return getRecent();},succeed(tool: string) {if (tool === "report-issue") {diff --git a/packages/project-build/src/mcp.test.ts b/packages/project-build/src/mcp.test.tsindex bcabdb510c..e6a45ef96c 100644--- a/packages/project-build/src/mcp.test.ts+++ b/packages/project-build/src/mcp.test.ts@@ -8972,6 +8972,47 @@ describe("project session mcp adapter", () => {}});+ test("waits for failure diagnostics persistence before returning the tool error", async () => {+ const error = new Error("operation failed");+ let finishPersistence: () => void = () => undefined;+ let callbackStarted = false;+ let callbackFinished = false;+ const persistence = new Promise<void>((resolve) => {+ finishPersistence = resolve;+ });+ const server = await createProjectSessionMcpServer({+ operations: publicMcpOperations,+ createProjectSession: createSessionFactory(),+ executeOperation: createExecuteOperation(async () => {+ throw error;+ }),+ onToolFailure: async () => {+ callbackStarted = true;+ await persistence;+ callbackFinished = true;+ },+ });+ const { client, close } = await createConnectedClient(server);++ try {+ let callFinished = false;+ const call = client+ .callTool({ name: "list-pages", arguments: {} })+ .finally(() => {+ callFinished = true;+ });+ await vi.waitFor(() => expect(callbackStarted).toBe(true));+ expect(callbackFinished).toBe(false);+ expect(callFinished).toBe(false);+ finishPersistence();+ await call;+ expect(callbackFinished).toBe(true);+ } finally {+ finishPersistence();+ await close();+ }+ });+test("returns expected input examples for SDK zod tool errors", async () => {const inputSchema = z.object({email: z.email(),diff --git a/packages/project-build/src/mcp.ts b/packages/project-build/src/mcp.tsindex 46c8cb9422..5cb1cfb32b 100644--- a/packages/project-build/src/mcp.ts+++ b/packages/project-build/src/mcp.ts@@ -9325,8 +9325,8 @@ export const createProjectSessionMcpServer = async <error: unknown,elapsedMs: number,input: unknown- ) => void;- onToolSuccess?: (canonicalTool: string) => void;+ ) => void | Promise<void>;+ onToolSuccess?: (canonicalTool: string) => void | Promise<void>;}) => {const server = new Server({ name: "webstudio", version: "0.0.0" },@@ -9466,12 +9466,17 @@ export const createProjectSessionMcpServer = async <signal: extra.signal,});const elapsedMs = Date.now() - startedAt;- onToolSuccess?.(canonicalName ?? "unknown");+ await onToolSuccess?.(canonicalName ?? "unknown");sendLog("info", `tool ${name} succeeded in ${elapsedMs}ms`);return result;} catch (error) {const elapsedMs = Date.now() - startedAt;- onToolFailure?.(canonicalName ?? "unknown", error, elapsedMs, input);+ await onToolFailure?.(+ canonicalName ?? "unknown",+ error,+ elapsedMs,+ input+ );sendLog("error",`tool ${name} failed in ${elapsedMs}ms: ${diff --git a/packages/protocol/src/issue-report.ts b/packages/protocol/src/issue-report.tsindex c620590fe0..7a6ba7be12 100644--- a/packages/protocol/src/issue-report.ts+++ b/packages/protocol/src/issue-report.ts@@ -94,7 +94,7 @@ export const issueReportEntityId = z.object({ field: issueReportEntityIdField, id: issueReportId }).strict();-const issueReportRecentFailure = z+export const issueReportRecentFailureSchema = z.object({tool: z.string().trim().min(1).max(160),code: z.string().trim().min(1).max(160),@@ -148,7 +148,7 @@ const issueReportRuntime = zapiContractVersion: z.string().trim().min(1).max(100),bundleVersion: z.string().trim().min(1).max(100).optional(),projectId: issueReportId.optional(),- recentFailure: issueReportRecentFailure.optional(),+ recentFailure: issueReportRecentFailureSchema.optional(),session: issueReportSession.optional(),preview: issueReportPreview.optional(),})@@ -205,4 +205,6 @@ export const issueReportResult = zexport type IssueReportInput = z.infer<typeof issueReportInput>;export type IssueReportResult = z.infer<typeof issueReportResult>;export type IssueReportRuntime = z.infer<typeof issueReportRuntime>;-export type IssueReportRecentFailure = z.infer<typeof issueReportRecentFailure>;+export type IssueReportRecentFailure = z.infer<+ typeof issueReportRecentFailureSchema+>;