* refactor(core): decompose editor factory and action modules Split the monolithic editor factory and large action modules into focused domain helpers: - create.ts assembles context through bridge modules (clipboard, components, structure, undo) and delegates to graph-reads, graph-events, layout-runner, component-sync, and state factory - structure.ts delegates to group, container-wrap, auto-layout-wrap, reorder, and state-toggle helpers - selection.ts delegates to hit-test, overlays, container navigation, and read helpers - clipboard.ts delegates to subtree-history, images, export, copy, fonts, and placement helpers - shapes.ts delegates to pen actions and section-adopt - components.ts delegates to focus and instances helpers - alignment.ts delegates to flip-rotate helper - text.ts uses explicit TextEditSession for snapshot comparison New focused modules: nudge, variable-bindings, layout-mode, page-viewports, tool-registry, color-space Undo: history/position and history/snapshot helpers, hardened batch/rollback with nested batch support and configurable limit * refactor(core): split tool definitions by domain Split the monolithic tool registry into domain-specific modules: - read/ — selection, find, pages, fonts, components, nodes, query, jsx - create/ — basic shapes, components, vector, JSX render - modify/ — paint, effects, geometry, layout, state, text, update - structure/ — basic, arrange, batch, hierarchy, replace, tree - variables/ — bindings, collections, read, values - vector/ — boolean, path, export, viewport - analyze/ — colors, typography, spacing, clusters, diff, eval - describe/ — summaries, tree, roles, layout-issues - stock-photo/ — providers, requests, apply - codegen/ — component-map, tokens Split registry into core/extended tiers; refine schema and AI adapter * refactor(core): restructure kiwi codec and instance overrides Reorganize the Kiwi .fig codec into domain subdirectories: - binary/ — codec, schema, protocol - fig/ — file, import, parse (core, worker, transfer) - node-change/ — convert, export-node, serialize, plugin-data - instance-overrides/ — constraints, dsd, populate, props, resolve, symbol-overrides, symbol-props, sync, types Vendored kiwi-schema/ left isolated * refactor(core): split profiler, icons, IO, and add subpath exports Profiler: speedscope-export, capture-session, hud-controller Icons: api, svg, types, render, create-icons tool IO: format registry and subpath exports Canvas/color/text/vector: targeted cleanup Add deliberate subpath exports: random, xpath, vector, color, canvas, scene-graph, kiwi, design-jsx, io, tools, editor, layout, canvaskit, profiler, text, lint, rpc, figma-api, constants * refactor(vue): decompose canvas input, surface lifecycle, and controls Canvas surface: gl-surface, kit-loader, render-loop, resize-observer Canvas input handlers: - move: drop-target, move-snap, duplicate-drag - select: select-move, select-hover, select-hit - resize: resize-rect, resize-vector, resize-start - transform: rotation, marquee, pan, text-selection - text-edit: navigation, clipboard, textarea lifecycle - Shared: click-count, space-key, pan, pan-zoom, draw, raf-scheduler Editor composition: - commands split: actions, context, metadata, edit, selection, view - menu-model split: command-groups, builders, types - Gradient stop composable reuse in primitive root Controls: fill, layout, typography, appearance, effects, stroke, okhcl, prop-scrub, node-props, undo-batch, color-variable-binding Variables/i18n/document/export helpers Organize canvas, primitives, controls, editor, and variables into cohesive module directories with package-local import aliases Expose MenuActionNode/MenuSeparatorNode from public API * refactor(app): split document IO, editor session, and automation bridge Document IO: source-state, naming, writer, reload-source, reload-state, imported-document, watch-targets, save-targets Editor session: create, modules, types, accessors, computed, refs Editor canvas: loader-overlay, collaboration-awareness, context-selection, menu-actions, menu-model Automation bridge: eval, tools, exports, files, selection, RPC fallback AI/ACP: transport, map-update, permission, debug, chat effects/storage Collab: awareness, graph-bindings, yjs-sync, follow, session, types Shell keyboard: actions, bindings, clipboard, focus, nudging, raw-events, registry, reserved, shortcuts, space-tool Shell menu: app-menu, document-name, entry, files Demo: colors, effects, helpers, section builders (components, app-preview, effects, standalone, variables) — document.ts reduced from 981 to 32 lines as pure orchestrator Move app modules under src/app/ with organized domain structure: editor, document, ai, collab, shell, automation, demo, tabs * refactor(app): decompose UI components with provide/inject context Split monolithic components using Reka UI-inspired namespace folders with scoped provide/inject context — no prop drilling: - CollabPanel/ — context, avatars, share, connected, join - ColorPickerPanel/ — context, area, format, field groups, sliders - MobileHud/ — context, action toast, tool badge, file menu, presence - ProviderSettings/ — context, API key/type, endpoint, tokens, photos - Toolbar/ — actions, types, desktop, mobile, tool button, flyout - LayoutSection/ — types, auto-layout, flex, grid, padding, size, clip Properties helpers: fill-okhcl adapter, fill-label, color-style-row Menu: entry helpers, document-name rename, stale type removal * refactor(mcp): split server into focused modules - browser-rpc — WebSocket client management - mcp-sessions — session lifecycle - tool-output — response formatting - tool-schema — Zod schema generation from ToolDefs - jsx-preprocess — JSX source transformation - result — result helpers - tool-registration — MCP tool wiring - auth — API key validation - http-options — CORS/request handling - stdio-bridge — stdio transport adapter * refactor(cli): split analyze subcommands and shared helpers - Analyze subcommands: clusters, colors, spacing, typography - RPC data loading helper - Migrate imports to targeted core subpath exports * refactor(docs): split VitePress config and shared table component Config helpers: sdk-sidebar, seo, labels, sidebars, locale-theme, root-theme, locales Shared SdkDataTable component replaces duplicated table markup in SdkPropsTable, SdkEventsTable, and SdkSlotsTable Update contributing and testing docs * refactor(tauri): decompose desktop entrypoint Split lib.rs into focused service modules: - fig_container.rs — .fig archive/compression commands - fonts.rs — font cache and system font enumeration - menu.rs — native menu construction - menu_events.rs — menu event dispatch and devtools toggle - window.rs — main window show/focus lifecycle * test: share domain test factories and migrate fixtures New shared helpers: - tests/helpers/scene.ts — makeSceneGraph factory - tests/helpers/vector-network.ts — vertex/segment/network builders - tests/helpers/fig-traversal.ts — all-node collection, type counts - tests/helpers/undo.ts — undo test utilities - tests/helpers/editor-history.ts — editor history test helpers Migrate render, vector, fig-roundtrip, and undo tests to use shared factories instead of inline fixture construction * build: add structural lint rules, split vite config, update docs Structural lint (oxlint.structure.json + lint/plugin.js): - 20+ custom rules enforcing package boundaries, lifecycle patterns, naming conventions, and import discipline Vite config split: raw-markdown, canvaskit-assets, pwa, server, aliases, automation plugins Remove legacy shims and utils superseded by SDK/core modules Update AGENTS.md, CONTRIBUTING.md, eval-command docs, tsconfig * fix(vue): normalize canvas directory casing and remove duplicate export - Rename Canvas/ to canvas/ in git index to match #vue/canvas/* imports (PascalCase was correct for component primitives but canvas/ is a non-component domain directory) - Remove duplicate ./random subpath export in core package.json * fix: add #vue and #core Vite resolve aliases for dev server * refactor(core): reduce remaining large modules Split the remaining large core hotspots into cohesive domain modules while preserving public facades and behavior. - Extract scene graph types, variables, node defaults, and vector-network helpers - Decompose canvas renderer orchestration, state, paints, colors, lifecycle, labels, and delegated domain methods into renderer/ and labels/ subfolders - Split Kiwi node-change, binary variable binding, layout, RPC, vector, JSX export, clipboard, design JSX, and Figma proxy helpers - Replace collision-driven *Fn import aliases with namespace imports and enforce the pattern in lint Validation: - bun run check - bun --filter @open-pencil/vue build - bun run test:dupes * fix(app): forward color input attrs * fix(app): cover section drawing errors * fix(editor): undo option-drag duplicates * docs: document domain subfolder convention * fix(app): handle undo redo on keydown * refactor(app): dispatch shortcuts from keydown * refactor: group prefixed domain modules * refactor(app): use tinykeys for shortcuts * refactor(core): group symbol override modules * refactor(core): group fig kiwi container helper * refactor(canvas): split overlay rendering modules * refactor(vue): remove unused internal barrels * fix(app): lay out demo components before instancing * fix(app): restore demo badge spacing * perf(canvas): split scene and overlay rendering * refactor(vue): wrap wheel gesture lifecycle * fix(canvas): wait for fonts before hiding loader * docs: update unreleased changelog
305 lines
10 KiB
TypeScript
305 lines
10 KiB
TypeScript
import { describe, expect, test, beforeEach, afterEach } from 'bun:test'
|
|
|
|
import { Client } from '@modelcontextprotocol/sdk/client/index.js'
|
|
import { StreamableHTTPClientTransport } from '@modelcontextprotocol/sdk/client/streamableHttp.js'
|
|
import WebSocket from 'ws'
|
|
|
|
import { startServer, paramToZod } from '#mcp/server'
|
|
import {
|
|
ALL_TOOLS,
|
|
FigmaAPI,
|
|
SceneGraph,
|
|
computeAllLayouts,
|
|
executeRpcCommand
|
|
} from '@open-pencil/core'
|
|
import { serve } from '@hono/node-server'
|
|
|
|
import type { AddressInfo } from 'node:net'
|
|
|
|
interface MockBrowser {
|
|
ws: WebSocket
|
|
graph: SceneGraph
|
|
close: () => void
|
|
}
|
|
|
|
function connectMockBrowser(port: number, graph: SceneGraph): Promise<MockBrowser> {
|
|
return new Promise((resolve, reject) => {
|
|
const ws = new WebSocket(`ws://127.0.0.1:${port}`)
|
|
const token = 'test-token-' + Date.now()
|
|
|
|
ws.on('open', () => {
|
|
ws.send(JSON.stringify({ type: 'register', token }))
|
|
|
|
ws.on('message', async (raw) => {
|
|
const msg = JSON.parse(raw.toString()) as {
|
|
type: string
|
|
id: string
|
|
command: string
|
|
args?: unknown
|
|
}
|
|
if (msg.type !== 'request') return
|
|
|
|
try {
|
|
const command = msg.command
|
|
const args = msg.args as { name?: string; args?: Record<string, unknown> } | undefined
|
|
|
|
let result: unknown
|
|
if (command === 'tool' && args?.name) {
|
|
const def = ALL_TOOLS.find((t) => t.name === args.name)
|
|
if (!def) throw new Error(`Unknown tool: ${args.name}`)
|
|
const api = new FigmaAPI(graph)
|
|
api.currentPage = api.wrapNode(graph.getPages()[0].id)
|
|
result = await def.execute(api, args.args ?? {})
|
|
if (def.mutates) computeAllLayouts(graph)
|
|
} else {
|
|
result = executeRpcCommand(graph, command, args ?? {})
|
|
}
|
|
|
|
ws.send(JSON.stringify({ type: 'response', id: msg.id, ok: true, result }))
|
|
} catch (e) {
|
|
ws.send(JSON.stringify({
|
|
type: 'response',
|
|
id: msg.id,
|
|
ok: false,
|
|
error: e instanceof Error ? e.message : String(e)
|
|
}))
|
|
}
|
|
})
|
|
|
|
resolve({ ws, graph, close: () => ws.close() })
|
|
})
|
|
|
|
ws.on('error', reject)
|
|
})
|
|
}
|
|
|
|
function waitForWsListening(wss: InstanceType<typeof WebSocket.Server>): Promise<number> {
|
|
return new Promise((resolve) => {
|
|
if (wss.address()) {
|
|
resolve((wss.address() as AddressInfo).port)
|
|
return
|
|
}
|
|
wss.on('listening', () => resolve((wss.address() as AddressInfo).port))
|
|
})
|
|
}
|
|
|
|
async function createTestClient() {
|
|
const { app, wss, close: closeServer } = startServer({ httpPort: 0, wsPort: 0 })
|
|
const httpServer = serve({ fetch: app.fetch, port: 0, hostname: '127.0.0.1' })
|
|
const actualHttpPort = (httpServer.address() as AddressInfo).port
|
|
const actualWsPort = await waitForWsListening(wss)
|
|
|
|
const graph = new SceneGraph()
|
|
const browser = await connectMockBrowser(actualWsPort, graph)
|
|
|
|
const client = new Client({ name: 'test-client', version: '0.0.0' })
|
|
const transport = new StreamableHTTPClientTransport(
|
|
new URL(`http://127.0.0.1:${actualHttpPort}/mcp`)
|
|
)
|
|
await client.connect(transport)
|
|
|
|
return {
|
|
client,
|
|
graph,
|
|
close: async () => {
|
|
await client.close()
|
|
browser.close()
|
|
closeServer()
|
|
httpServer.close()
|
|
}
|
|
}
|
|
}
|
|
|
|
function parseResult(result: { content: { type: string; text?: string }[] }): unknown {
|
|
const textContent = result.content.find((c) => c.type === 'text')
|
|
return textContent?.text ? JSON.parse(textContent.text) : null
|
|
}
|
|
|
|
describe('MCP server', () => {
|
|
let client: Client
|
|
let graph: SceneGraph
|
|
let cleanup: () => Promise<void>
|
|
|
|
beforeEach(async () => {
|
|
const ctx = await createTestClient()
|
|
client = ctx.client
|
|
graph = ctx.graph
|
|
cleanup = ctx.close
|
|
})
|
|
|
|
afterEach(async () => {
|
|
await cleanup()
|
|
})
|
|
|
|
test('lists all registered tools', async () => {
|
|
const { tools } = await client.listTools()
|
|
const names = tools.map((t) => t.name)
|
|
expect(names).toContain('create_shape')
|
|
expect(names).toContain('set_fill')
|
|
expect(names).toContain('get_page_tree')
|
|
expect(names).toContain('render')
|
|
expect(names).toContain('get_codegen_prompt')
|
|
expect(tools.length).toBeGreaterThan(30)
|
|
})
|
|
|
|
test('tools have descriptions and input schemas', async () => {
|
|
const { tools } = await client.listTools()
|
|
for (const tool of tools) {
|
|
expect(tool.description).toBeTruthy()
|
|
expect(tool.inputSchema).toBeDefined()
|
|
}
|
|
})
|
|
|
|
test('create_shape creates a node on the live canvas', async () => {
|
|
const result = await client.callTool({
|
|
name: 'create_shape',
|
|
arguments: { type: 'FRAME', x: 0, y: 0, width: 200, height: 100, name: 'Test' }
|
|
})
|
|
expect(result.isError).not.toBe(true)
|
|
const data = parseResult(result) as { id: string; name: string; type: string }
|
|
expect(data.type).toBe('FRAME')
|
|
expect(data.name).toBe('Test')
|
|
|
|
const node = graph.getNode(data.id)
|
|
expect(node).toBeDefined()
|
|
expect(node?.name).toBe('Test')
|
|
})
|
|
|
|
test('set_fill validates and applies color', async () => {
|
|
const create = await client.callTool({
|
|
name: 'create_shape',
|
|
arguments: { type: 'RECTANGLE', x: 0, y: 0, width: 50, height: 50 }
|
|
})
|
|
const { id } = parseResult(create) as { id: string }
|
|
|
|
const fill = await client.callTool({
|
|
name: 'set_fill',
|
|
arguments: { id, color: '#00ff00' }
|
|
})
|
|
expect(fill.isError).not.toBe(true)
|
|
})
|
|
|
|
test('get_page_tree returns page structure', async () => {
|
|
await client.callTool({
|
|
name: 'create_shape',
|
|
arguments: { type: 'FRAME', x: 0, y: 0, width: 100, height: 100, name: 'F1' }
|
|
})
|
|
const result = await client.callTool({ name: 'get_page_tree', arguments: {} })
|
|
expect(result.isError).not.toBe(true)
|
|
const data = parseResult(result) as { children: { name: string }[] }
|
|
expect(data.children.some((c) => c.name === 'F1')).toBe(true)
|
|
})
|
|
|
|
test('delete_node removes a node', async () => {
|
|
const create = await client.callTool({
|
|
name: 'create_shape',
|
|
arguments: { type: 'RECTANGLE', x: 0, y: 0, width: 50, height: 50 }
|
|
})
|
|
const { id } = parseResult(create) as { id: string }
|
|
|
|
await client.callTool({ name: 'delete_node', arguments: { id } })
|
|
|
|
const get = await client.callTool({ name: 'get_node', arguments: { id } })
|
|
const data = parseResult(get) as { error?: string }
|
|
expect(data.error).toContain('not found')
|
|
})
|
|
|
|
test('find_nodes filters by type', async () => {
|
|
await client.callTool({
|
|
name: 'create_shape',
|
|
arguments: { type: 'FRAME', x: 0, y: 0, width: 100, height: 100 }
|
|
})
|
|
await client.callTool({
|
|
name: 'create_shape',
|
|
arguments: { type: 'RECTANGLE', x: 0, y: 0, width: 50, height: 50 }
|
|
})
|
|
await client.callTool({
|
|
name: 'create_shape',
|
|
arguments: { type: 'FRAME', x: 0, y: 0, width: 100, height: 100 }
|
|
})
|
|
const result = await client.callTool({ name: 'find_nodes', arguments: { type: 'FRAME' } })
|
|
const data = parseResult(result) as { count: number }
|
|
expect(data.count).toBe(2)
|
|
})
|
|
|
|
test('get_codegen_prompt returns prompt text', async () => {
|
|
const result = await client.callTool({ name: 'get_codegen_prompt', arguments: {} })
|
|
expect(result.isError).not.toBe(true)
|
|
const data = parseResult(result) as { prompt: string }
|
|
expect(data.prompt.length).toBeGreaterThan(100)
|
|
})
|
|
})
|
|
|
|
describe('MCP server with mcpRoot', () => {
|
|
test('registers open_file and new_document tools when mcpRoot is set', async () => {
|
|
const { app, wss, close: closeServer } = startServer({ httpPort: 0, wsPort: 0, mcpRoot: '/tmp' })
|
|
const httpServer = serve({ fetch: app.fetch, port: 0, hostname: '127.0.0.1' })
|
|
const actualWsPort = await waitForWsListening(wss)
|
|
|
|
const graph = new SceneGraph()
|
|
const browser = await connectMockBrowser(actualWsPort, graph)
|
|
|
|
const client = new Client({ name: 'test-root', version: '0.0.0' })
|
|
const transport = new StreamableHTTPClientTransport(
|
|
new URL(`http://127.0.0.1:${(httpServer.address() as AddressInfo).port}/mcp`)
|
|
)
|
|
await client.connect(transport)
|
|
|
|
const { tools } = await client.listTools()
|
|
const names = tools.map((t) => t.name)
|
|
expect(names).toContain('open_file')
|
|
expect(names).toContain('new_document')
|
|
|
|
await client.close()
|
|
browser.close()
|
|
closeServer()
|
|
httpServer.close()
|
|
})
|
|
|
|
test('does not register open_file when mcpRoot is null', async () => {
|
|
const { app, wss, close: closeServer } = startServer({ httpPort: 0, wsPort: 0 })
|
|
const httpServer = serve({ fetch: app.fetch, port: 0, hostname: '127.0.0.1' })
|
|
const actualWsPort = await waitForWsListening(wss)
|
|
|
|
const graph = new SceneGraph()
|
|
const browser = await connectMockBrowser(actualWsPort, graph)
|
|
|
|
const client = new Client({ name: 'test-no-root', version: '0.0.0' })
|
|
const transport = new StreamableHTTPClientTransport(
|
|
new URL(`http://127.0.0.1:${(httpServer.address() as AddressInfo).port}/mcp`)
|
|
)
|
|
await client.connect(transport)
|
|
|
|
const { tools } = await client.listTools()
|
|
const names = tools.map((t) => t.name)
|
|
expect(names).not.toContain('open_file')
|
|
expect(names).not.toContain('new_document')
|
|
|
|
await client.close()
|
|
browser.close()
|
|
closeServer()
|
|
httpServer.close()
|
|
})
|
|
})
|
|
|
|
describe('paramToZod coercion', () => {
|
|
test('number param accepts numeric strings', () => {
|
|
const schema = paramToZod({ type: 'number', description: 'x', required: true })
|
|
expect(schema.parse('42')).toBe(42)
|
|
expect(schema.parse(42)).toBe(42)
|
|
expect(schema.parse('3.14')).toBeCloseTo(3.14)
|
|
})
|
|
|
|
test('number param rejects non-numeric strings', () => {
|
|
const schema = paramToZod({ type: 'number', description: 'x', required: true })
|
|
expect(() => schema.parse('abc')).toThrow()
|
|
})
|
|
|
|
test('number param respects min/max after coercion', () => {
|
|
const schema = paramToZod({ type: 'number', description: 'x', required: true, min: 0, max: 100 })
|
|
expect(schema.parse('50')).toBe(50)
|
|
expect(() => schema.parse('200')).toThrow()
|
|
expect(() => schema.parse('-1')).toThrow()
|
|
})
|
|
})
|