* build: typecheck the test suites Tests were in no TypeScript program: no tsconfig included tests/** or packages/*/tests/**, and bun strips types without checking them, so a fixture could drop a required field and keep passing until something read it. @types/bun moves to the root because it was installed per package only, and #cli-tests/* joins the paths the root config already carries. * test: fix the type errors the test suites were hiding Typechecking the tests turned up 1123 errors. Most were ordinary strictness, but some were real: `NodeChange` bound to Figma's plugin typings rather than the Kiwi codec in thirteen .fig tests, materializeInstance was called with six arguments against five so the blobs and source children were dropped, CanvasKit pixels were written to a plain object that never reached WASM, and assertions were made through accessors that do not exist, so they asserted nothing. Fixtures that had quietly lost a required field now carry it, nullable results are narrowed through the existing expectDefined helper rather than assumed, and stand-ins for CanvasKit and the editor go through one named helper instead of an unexplained cast at each site. No test was deleted, skipped, or weakened, and no `any`, non-null assertion, or ts-expect-error was introduced. * docs: record what typechecking the tests established Pins the app program's global types with an assertion rather than a note, since an unpinned types list lets any root @types package decide which platform src/** is judged against. The two environment faults that look like code regressions — Vite's dependency pre-bundle outliving a package rebuild, and heavy .fig suites failing under load — go to the development docs, where an explanation belongs. * fix: align @types/bun and keep node types resolvable when extended The root manifest declared a newer @types/bun than every package, which check:monorepo rejects, and pinning the app program's types left them unresolvable from a config that extends this one out of tree. * fix: fail the test typecheck when the compiler itself fails The gate matched diagnostics by substring, so a compiler or config failure that named no test file printed a pass while having checked nothing. Diagnostics are now split by whether they name a file: an unscoped one is the run failing and stops the gate, a test file's is a finding, and a source file's stays out by design. Also drops the parameter planComponentConstruction never read, and makes the inner-shadow verification script exit non-zero when it renders no image instead of logging and succeeding. * chore: merge master into tests-typecheck
227 lines
7.2 KiB
TypeScript
227 lines
7.2 KiB
TypeScript
import { describe, expect, test } from 'bun:test'
|
|
|
|
import { DEFAULT_FONT_FAMILY, FigmaAPI, fontManager } from '@open-pencil/core'
|
|
|
|
import { expectDefined } from '#tests/helpers/assert'
|
|
import { getTool, setupToolTest, type ALL_TOOLS, type ToolResult } from '#tests/helpers/tools'
|
|
|
|
/** The `list_pages` tool answers with the document's pages. */
|
|
interface ListPagesResult extends ToolResult {
|
|
pages: Array<{ id: string; name: string }>
|
|
}
|
|
|
|
describe('find_nodes', () => {
|
|
test('finds by name', () => {
|
|
const { figma } = setupToolTest()
|
|
const rect = figma.createRectangle()
|
|
rect.name = 'Button Primary'
|
|
const text = figma.createText()
|
|
text.name = 'Label'
|
|
|
|
const tool = getTool('find_nodes')
|
|
const result = tool.execute(figma, { name: 'button' }) as ToolResult
|
|
expect(result.count).toBe(1)
|
|
expect(expectDefined(result.nodes, 'found nodes')[0].name).toBe('Button Primary')
|
|
})
|
|
|
|
test('finds by type', () => {
|
|
const { figma } = setupToolTest()
|
|
figma.createRectangle()
|
|
figma.createRectangle()
|
|
figma.createText()
|
|
|
|
const tool = getTool('find_nodes')
|
|
const result = tool.execute(figma, { type: 'RECTANGLE' }) as ToolResult
|
|
expect(result.count).toBe(2)
|
|
})
|
|
})
|
|
|
|
describe('query_nodes', () => {
|
|
test('finds all frames with //FRAME', async () => {
|
|
const { figma } = setupToolTest()
|
|
const f1 = figma.createFrame()
|
|
f1.resize(200, 200)
|
|
f1.name = 'Frame A'
|
|
const f2 = figma.createFrame()
|
|
f2.resize(300, 300)
|
|
f2.name = 'Frame B'
|
|
figma.createRectangle()
|
|
|
|
const tool = getTool('query_nodes')
|
|
const result = (await tool.execute(figma, { selector: '//FRAME' })) as ToolResult
|
|
expect(result.count).toBe(2)
|
|
expect(result.nodes?.every((n) => n.type === 'FRAME')).toBe(true)
|
|
})
|
|
|
|
test('finds by attribute //RECTANGLE[@width < 200]', async () => {
|
|
const { figma } = setupToolTest()
|
|
const small = figma.createRectangle()
|
|
small.resize(100, 50)
|
|
small.name = 'Small'
|
|
const big = figma.createRectangle()
|
|
big.resize(400, 400)
|
|
big.name = 'Big'
|
|
|
|
const tool = getTool('query_nodes')
|
|
const result = (await tool.execute(figma, {
|
|
selector: '//RECTANGLE[@width < 200]'
|
|
})) as ToolResult
|
|
expect(result.count).toBe(1)
|
|
expect(expectDefined(result.nodes, 'queried nodes')[0].name).toBe('Small')
|
|
})
|
|
|
|
test('finds by name with contains', async () => {
|
|
const { figma } = setupToolTest()
|
|
const t1 = figma.createText()
|
|
t1.name = 'Label Primary'
|
|
const t2 = figma.createText()
|
|
t2.name = 'Title'
|
|
const t3 = figma.createText()
|
|
t3.name = 'Label Secondary'
|
|
|
|
const tool = getTool('query_nodes')
|
|
const result = (await tool.execute(figma, {
|
|
selector: '//TEXT[contains(@name, "Label")]'
|
|
})) as ToolResult
|
|
expect(result.count).toBe(2)
|
|
expect(result.nodes?.every((n) => n.name.includes('Label'))).toBe(true)
|
|
})
|
|
|
|
test('returns error for invalid xpath', async () => {
|
|
const { figma } = setupToolTest()
|
|
const tool = getTool('query_nodes')
|
|
const result = (await tool.execute(figma, { selector: '///invalid[[[[' })) as ToolResult
|
|
expect(result.error).toBeTruthy()
|
|
expect(result.error).toContain('XPath error')
|
|
})
|
|
|
|
test('respects limit param', async () => {
|
|
const { figma } = setupToolTest()
|
|
for (let i = 0; i < 10; i++) {
|
|
const r = figma.createRectangle()
|
|
r.name = `Rect ${i}`
|
|
}
|
|
|
|
const tool = getTool('query_nodes')
|
|
const result = (await tool.execute(figma, { selector: '//RECTANGLE', limit: 3 })) as ToolResult
|
|
expect(result.count).toBe(3)
|
|
})
|
|
|
|
test('returns empty array when nothing matches', async () => {
|
|
const { figma } = setupToolTest()
|
|
figma.createRectangle()
|
|
|
|
const tool = getTool('query_nodes')
|
|
const result = (await tool.execute(figma, { selector: '//ELLIPSE' })) as ToolResult
|
|
expect(result.count).toBe(0)
|
|
expect(result.nodes).toEqual([])
|
|
})
|
|
})
|
|
|
|
describe('get_font_status', () => {
|
|
test('returns font fidelity diagnostics for agents', () => {
|
|
const { figma } = setupToolTest()
|
|
const text = figma.createText()
|
|
text.name = 'Missing label'
|
|
text.fontName = { family: 'Unavailable Sans', style: 'Regular' }
|
|
|
|
const tool = getTool('get_font_status')
|
|
const result = tool.execute(figma, {}) as {
|
|
faithful: boolean
|
|
issues: Array<{
|
|
family: string
|
|
style: string
|
|
status: string
|
|
nodeIds: string[]
|
|
}>
|
|
}
|
|
|
|
// The tool reads the process-wide font manager. A missing family is
|
|
// 'unresolved' in a pristine process and 'substituted' by the default font
|
|
// once any earlier suite in the shard has loaded it; both are issues.
|
|
const defaultLoaded = fontManager.loadedFontSource(DEFAULT_FONT_FAMILY, 'Regular') !== null
|
|
|
|
expect(result.faithful).toBe(false)
|
|
expect(result.issues).toEqual([
|
|
expect.objectContaining({
|
|
family: 'Unavailable Sans',
|
|
style: 'Regular',
|
|
status: defaultLoaded ? 'substituted' : 'unresolved',
|
|
substituteFamily: defaultLoaded ? DEFAULT_FONT_FAMILY : null,
|
|
nodeIds: [text.id]
|
|
})
|
|
])
|
|
})
|
|
})
|
|
|
|
describe('get_node', () => {
|
|
test('returns node details', () => {
|
|
const { figma } = setupToolTest()
|
|
const rect = figma.createRectangle()
|
|
rect.name = 'Test Rect'
|
|
rect.resize(100, 50)
|
|
|
|
const tool = getTool('get_node')
|
|
const result = tool.execute(figma, { id: rect.id }) as ToolResult
|
|
expect(result.name).toBe('Test Rect')
|
|
expect(result.width).toBe(100)
|
|
expect(result.height).toBe(50)
|
|
})
|
|
})
|
|
|
|
describe('page tools', () => {
|
|
test('list_pages returns pages', () => {
|
|
const { figma } = setupToolTest()
|
|
const tool = getTool('list_pages')
|
|
const result = tool.execute(figma, {}) as ListPagesResult
|
|
expect(result.pages.length).toBeGreaterThanOrEqual(1)
|
|
})
|
|
|
|
test('switch_page changes page', () => {
|
|
const { figma } = setupToolTest()
|
|
const page2 = figma.createPage()
|
|
page2.name = 'Page 2'
|
|
|
|
const tool = getTool('switch_page')
|
|
tool.execute(figma, { page: 'Page 2' })
|
|
|
|
expect(figma.currentPage.name).toBe('Page 2')
|
|
})
|
|
|
|
test('switch_page persists across separate FigmaAPI instances (RPC simulation)', () => {
|
|
const { graph } = setupToolTest()
|
|
const switchPage = getTool('switch_page')
|
|
const getCurrentPage = getTool('get_current_page')
|
|
const createPage = getTool('create_page')
|
|
|
|
let currentPageId = graph.getPages()[0].id
|
|
|
|
function rpcCall(tool: (typeof ALL_TOOLS)[number], args: Record<string, unknown>) {
|
|
const figma = new FigmaAPI(graph)
|
|
figma.currentPage = figma.wrapNode(currentPageId)
|
|
const result = tool.execute(figma, args)
|
|
if (figma.currentPageId !== currentPageId) {
|
|
currentPageId = figma.currentPageId
|
|
}
|
|
return result
|
|
}
|
|
|
|
rpcCall(createPage, { name: 'Second' })
|
|
rpcCall(switchPage, { page: 'Second' })
|
|
const result = rpcCall(getCurrentPage, {}) as { id: string; name: string }
|
|
|
|
expect(result.name).toBe('Second')
|
|
})
|
|
})
|
|
|
|
describe('eval', () => {
|
|
test('executes code with figma api', async () => {
|
|
const { figma } = setupToolTest()
|
|
const tool = getTool('eval')
|
|
const result = await tool.execute(figma, {
|
|
code: 'const r = figma.createRectangle(); r.name = "FromEval"; return r.name;'
|
|
})
|
|
expect(result).toBe('FromEval')
|
|
})
|
|
})
|