69dba7002f
* fix: validate parsed JSON at untrusted boundaries with Valibot Clipboard HTML, library revisions from shared storage, MCP and automation WebSocket messages, the MCP discovery file, sidecar output and AI/MCP tool arguments were JSON.parse'd and cast to their expected types, so a malformed payload reached the document or crashed paste. They now go through v.pipe(v.string(), v.parseJson(), Schema), which reports bad JSON and a wrong shape as the same validation failure. The path_set tool rejects an invalid VectorNetwork and shares its parser with create_vector. The CLI library catalog validates its files and runs revisions through the same size, identity and content-hash checks as the app; reading image bytes as index-keyed records also stops them coming back empty. Hand-rolled typeof readers for plugin data, document metadata, caches and preferences become schemas with their behaviour preserved, and readCacheJSON takes a schema for its payload. open-pencil/no-unvalidated-json-parse rejects type assertions on JSON.parse results other than `as unknown` in src and packages/*/src. * refactor: validate parsed JSON in tests and tooling Extend open-pencil/no-unvalidated-json-parse beyond source: tests, helpers and repo tooling now parse JSON through Valibot schemas instead of asserting a type. The shared fixture reader returns a validated object; its old array annotation never matched the fixtures. * refactor: define OpenPencil plugin data in one typed registry Every plugin-data key OpenPencil writes is now a field of OPEN_PENCIL_PLUGIN_DATA in scene-graph, with the Valibot schema that reads it; readPluginData and withPluginData replace per-key constants, JSON.parse and hand-matched pluginId/key filters across fig, core, and vue. Moving OkHCL onto it fixes picking a colour rewriting the layer's other plugin data as OkHCL entries.
113 lines
3.5 KiB
TypeScript
113 lines
3.5 KiB
TypeScript
import { describe, expect, test } from 'bun:test'
|
|
|
|
import {
|
|
extractBoundVariables,
|
|
extractExportSettings,
|
|
extractLibrarySource,
|
|
extractTextPathBox
|
|
} from '#fig/node-change/plugin-data'
|
|
|
|
import type { NodeChange } from '@open-pencil/kiwi/fig/codec'
|
|
import {
|
|
clampExportScale,
|
|
OPEN_PENCIL_PLUGIN_DATA,
|
|
OPEN_PENCIL_PLUGIN_ID
|
|
} from '@open-pencil/scene-graph'
|
|
|
|
function withPluginValue(key: string, value: string, extra: NodeChange = {}): NodeChange {
|
|
return { ...extra, pluginData: [{ pluginID: OPEN_PENCIL_PLUGIN_ID, key, value }] }
|
|
}
|
|
|
|
describe('OpenPencil plugin data readers', () => {
|
|
test('textPathBox requires finite numbers and a positive size', () => {
|
|
const box = { x: 1, y: 2, width: 30, height: 40 }
|
|
expect(
|
|
extractTextPathBox(
|
|
withPluginValue(OPEN_PENCIL_PLUGIN_DATA.textPathBox.key, JSON.stringify(box))
|
|
)
|
|
).toEqual(box)
|
|
for (const value of [
|
|
'{not json',
|
|
'null',
|
|
JSON.stringify({ ...box, width: 0 }),
|
|
JSON.stringify({ ...box, x: '1' })
|
|
]) {
|
|
expect(
|
|
extractTextPathBox(withPluginValue(OPEN_PENCIL_PLUGIN_DATA.textPathBox.key, value))
|
|
).toBeNull()
|
|
}
|
|
})
|
|
|
|
test('bound variables keep string entries and drop the rest', () => {
|
|
const value = JSON.stringify({ opacity: 'VariableID:1:2', width: 3 })
|
|
expect(
|
|
extractBoundVariables(withPluginValue(OPEN_PENCIL_PLUGIN_DATA.boundVariables.key, value))
|
|
).toEqual({
|
|
opacity: 'VariableID:1:2'
|
|
})
|
|
for (const malformed of ['{not json', '["VariableID:1:2"]', '"VariableID:1:2"']) {
|
|
expect(
|
|
extractBoundVariables(
|
|
withPluginValue(OPEN_PENCIL_PLUGIN_DATA.boundVariables.key, malformed)
|
|
)
|
|
).toEqual({})
|
|
}
|
|
})
|
|
|
|
test('export settings clamp scales and fall back to native settings when any entry is invalid', () => {
|
|
const native: NodeChange = {
|
|
exportSettings: [{ imageType: 'SVG', constraint: { type: 'CONTENT_SCALE', value: 1 } }]
|
|
}
|
|
expect(
|
|
extractExportSettings(
|
|
withPluginValue(
|
|
OPEN_PENCIL_PLUGIN_DATA.exportSettings.key,
|
|
JSON.stringify([{ scale: 1000, format: 'png' }])
|
|
)
|
|
)
|
|
).toEqual([{ scale: clampExportScale(1000), format: 'png' }])
|
|
for (const value of [
|
|
'{not json',
|
|
JSON.stringify({ scale: 1, format: 'png' }),
|
|
JSON.stringify([
|
|
{ scale: 2, format: 'png' },
|
|
{ scale: 1, format: 'gif' }
|
|
])
|
|
]) {
|
|
expect(
|
|
extractExportSettings(
|
|
withPluginValue(OPEN_PENCIL_PLUGIN_DATA.exportSettings.key, value, native)
|
|
)
|
|
).toEqual([{ scale: 1, format: 'svg' }])
|
|
}
|
|
})
|
|
|
|
test('library source defaults its optional fields and rejects a malformed identity', () => {
|
|
const identity = { libraryId: 'lib', assetKey: 'button', revisionId: 'r1' }
|
|
expect(
|
|
extractLibrarySource(
|
|
withPluginValue(
|
|
OPEN_PENCIL_PLUGIN_DATA.librarySource.key,
|
|
JSON.stringify({ identity, readOnly: 'yes' })
|
|
)
|
|
)
|
|
).toEqual({ identity, sourceNodeId: null, readOnly: false })
|
|
expect(
|
|
extractLibrarySource(
|
|
withPluginValue(
|
|
OPEN_PENCIL_PLUGIN_DATA.librarySource.key,
|
|
JSON.stringify({ identity, sourceNodeId: '1:2', readOnly: true })
|
|
)
|
|
)
|
|
).toEqual({ identity, sourceNodeId: '1:2', readOnly: true })
|
|
for (const value of [
|
|
'{not json',
|
|
JSON.stringify({ identity: { ...identity, revisionId: 1 } })
|
|
]) {
|
|
expect(
|
|
extractLibrarySource(withPluginValue(OPEN_PENCIL_PLUGIN_DATA.librarySource.key, value))
|
|
).toBeNull()
|
|
}
|
|
})
|
|
})
|