Files
webstudio/apps/builder/app/shared/sync/sync-client.test.ts
T
Oleg IsonenandClaude Fable 5 071a4d9a85 feat: MCP update 3 (#5864)
## Summary

This update adds new MCP and CLI capabilities for project auditing,
structured data, project-specific agent instructions, focused project
search, safer bulk editing, image descriptions, font discovery, visual
verification, and external registry inspection.

## New Capabilities

### Audit projects

- Run a single `audit` command across accessibility, SEO, security,
assets, styles, and performance.
- Limit an audit to selected scopes, pages, or severity levels.
- Receive stable findings with locations and suggested fixes.
- Run rendered audits across desktop, mobile, and Builder breakpoint
widths.
- Detect horizontal overflow, broken images, oversized images, eager
below-fold images, render-blocking resources, and legacy font formats.
- Identify unused assets, tokens, CSS variables, local styles, and
breakpoints.
- Identify duplicate token declarations.
- Detect accessibility issues involving names, labels, headings,
landmarks, IDs, keyboard focus, ARIA, iframes, and autoplaying media.
- Detect SEO issues involving titles, descriptions, language, social
images, and structured data.
- Detect unsafe new-tab links and write resources exposed during page
rendering.

### Search an entire project

- Search project text, labels, props, resources, assets, and styles
through `search-project`.
- Find relevant records without downloading and reparsing the full
project snapshot.
- Scope searches to the relevant project-data areas.

### Add validated JSON-LD

- Add structured data with a dedicated JSON-LD component.
- Place JSON-LD inside the page Head Slot.
- Edit JSON in a purpose-built code editor.
- Prevent structurally invalid JSON-LD from being saved.
- Validate Schema.org types, properties, and values.
- Find invalid, missing, unknown, deprecated, or incompatible structured
data through the SEO audit.
- Let agents discover the correct JSON-LD workflow without using page
custom metadata or a generic HTML embed.

### Configure project-specific agent instructions

- Add AI-agent instructions from the new **Agents** section in Project
Settings.
- Synchronize those instructions into a managed root `AGENTS.md`.
- Update or remove the managed file automatically during project sync.
- Protect existing user-owned `AGENTS.md` files from being overwritten.
- Share the instructions with authenticated CLI and MCP agents.
- Keep agent instructions out of publicly readable production bundles.

### Generate and manage image descriptions

- Audit image assets for missing descriptions.
- Let a vision-capable agent inspect each image in its rendered context.
- Save generated descriptions to multiple image assets in one operation.
- Mark images as intentionally decorative.
- Reuse the saved asset description wherever the image is used.
- Re-run the audit to verify that missing-description findings are
resolved.

### Perform bounded bulk replacements

- Replace matching literal text across selected pages with
`replace-text`.
- Replace matching fixed prop text with `replace-prop-text`.
- Replace matching resource names or URLs with `replace-resource-text`.
- Restrict replacements by page, instance, prop, resource, field, match
mode, and maximum change count.
- Leave dynamic expressions unchanged.

### Inspect element ancestry

- Return an element’s direct parent in instance listings.
- Request the complete ancestor chain when inspecting an element.
- Understand tree placement without rebuilding the instance hierarchy
from raw project data.

### Discover available fonts

- List uploaded font families through `list-fonts`.
- Discover available system font stacks.
- Inspect font family, style, weight, format, and associated asset
information before applying typography.

### Inspect external component registries

- Inspect a local or remote shadcn-style registry item.
- Read its description, files, dependencies, targets, and documentation.
- Receive an explicit Webstudio compatibility report.
- Inspect registry metadata without installing or executing external
code.

### Capture generated project routes directly

- Run `webstudio screenshot --path /route` against the configured
project.
- Generate a temporary production-style preview automatically.
- Capture the requested route.
- Stop the temporary preview after capture.
- Avoid manually building and starting a preview for a single
screenshot.

### Assert visual changes

- Add expected text to screenshot comparisons.
- Set maximum pixel mismatch limits.
- Set minimum or maximum changed-region counts.
- Assert whether overall brightness or a color channel moved in the
expected direction.
- Use these assertions as pass/fail evidence for visual changes.

### Require compatible CLI versions

- Send the project-bundle contract version with CLI synchronization
requests.
- Stop incompatible CLI versions before they receive incomplete project
data.
- Tell users exactly how to update the CLI or run the latest version
once.
- Prevent older clients from silently dropping project settings.

## Upgrade Note

This branch introduces a new synchronized project-bundle contract. Older
CLI versions must update before synchronizing against the new API.

```sh
npm install -g webstudio@latest
```

Or run the latest version once:

```sh
npx webstudio@latest <command>
```

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-12 11:27:58 +02:00

91 lines
2.9 KiB
TypeScript

import { describe, expect, test } from "vitest";
import { __testing__ } from "./sync-client";
import type { LoadedBuilderData } from "~/shared/builder-data";
import { serverSyncStoreNames } from "./sync-stores";
const { getServerSyncState, resolveMultiplayerRelayUrl } = __testing__;
describe("getServerSyncState", () => {
test("keeps only server-synchronized builder data", () => {
const data = {
id: "build-1",
version: 1,
projectId: "project-1",
project: { id: "project-1" },
publisherHost: "example.com",
pages: "pages",
breakpoints: "breakpoints",
instances: "instances",
styles: "styles",
styleSources: "styleSources",
styleSourceSelections: "styleSourceSelections",
props: "props",
dataSources: "dataSources",
resources: "resources",
assets: "assets",
marketplaceProduct: "marketplaceProduct",
projectSettings: "projectSettings",
} as unknown as LoadedBuilderData;
const serverSyncState = getServerSyncState(data);
expect([...serverSyncState.keys()]).toEqual([...serverSyncStoreNames]);
expect(serverSyncState).toEqual(
new Map<string, unknown>([
["pages", "pages"],
["breakpoints", "breakpoints"],
["instances", "instances"],
["styles", "styles"],
["styleSources", "styleSources"],
["styleSourceSelections", "styleSourceSelections"],
["props", "props"],
["dataSources", "dataSources"],
["resources", "resources"],
["assets", "assets"],
["projectSettings", "projectSettings"],
["marketplaceProduct", "marketplaceProduct"],
])
);
expect([...serverSyncState.keys()]).not.toContain("project");
expect([...serverSyncState.keys()]).not.toContain("publisherHost");
});
});
describe("resolveMultiplayerRelayUrl", () => {
test("keeps configured absolute URL outside local wstd.dev", () => {
expect(
resolveMultiplayerRelayUrl(
"https://apps.webstudio.is/collab-relay",
"https://builder.webstudio.is/builder/project-id"
)
).toBe("https://apps.webstudio.is/collab-relay");
});
test("keeps configured absolute URL on local wstd.dev", () => {
expect(
resolveMultiplayerRelayUrl(
"https://apps.webstudio.is/collab-relay",
"https://p-project-id.wstd.dev:5173/builder/project-id"
)
).toBe("https://apps.webstudio.is/collab-relay");
});
test("proxies relative relay URLs through the local wstd.dev dev server", () => {
expect(
resolveMultiplayerRelayUrl(
"/collab-relay",
"https://p-project-id.wstd.dev:5173/builder/project-id"
)
).toBe("https://p-project-id.wstd.dev:5173/collab-relay");
});
test("supports relative relay URLs", () => {
expect(
resolveMultiplayerRelayUrl(
"/collab-relay",
"https://builder.webstudio.is/builder/project-id"
)
).toBe("https://builder.webstudio.is/collab-relay");
});
});