openpencil/tests/helpers/fig/fixtures.ts
Danila Poyarkov cff091bc6a
test: resolve repository files without climbing directories (#946)
* test: resolve repository files without climbing directories

Twelve tests and helpers reached shared fixtures, package assets, and workers with ../.. paths from import.meta, which the import rule does not see. They now go through repoPath and testPath, a workspaceRoot() that finds the root by its lockfile, the core package's own root, or the #core alias through import.meta.resolve. The root finder derives its folder from import.meta.url, so Playwright specs running under Node can use the helpers too. open-pencil/no-deep-parent-relative-paths rejects climbing two levels in new URL(…, import.meta.url) and in path calls that start from import.meta.

* fix(lint): catch Windows separators and wrapped import.meta paths, and stop at template expressions

The path rule missed '..\..' and a base such as dirname(fileURLToPath(import.meta.url)), and read `../${folder}` followed by '..' as climbing two levels.
2026-10-07 12:35:39 +00:00

123 lines
3.6 KiB
TypeScript

import { existsSync, readFileSync } from 'node:fs'
import { resolve } from 'node:path'
import * as v from 'valibot'
import {
parseFigFile,
type ParseFigFileOptions,
type SceneGraph,
type SceneNode
} from '@open-pencil/core'
import { testPath } from '../paths'
import { collectAllNodes } from './traversal'
export const FIXTURES = testPath('fixtures')
export const VALID_NODE_TYPES = new Set<string>([
'CANVAS',
'FRAME',
'RECTANGLE',
'ROUNDED_RECTANGLE',
'ELLIPSE',
'TEXT',
'LINE',
'STAR',
'POLYGON',
'VECTOR',
'GROUP',
'SECTION',
'COMPONENT',
'COMPONENT_SET',
'INSTANCE',
'BOOLEAN_OPERATION',
'CONNECTOR',
'SHAPE_WITH_TEXT'
])
const FixtureObjectJSON = v.pipe(v.string(), v.parseJson(), v.record(v.string(), v.unknown()))
/** Read a shared JSON fixture object. */
export function readFixtureObject(name: string): Record<string, unknown> {
return v.parse(FixtureObjectJSON, readFileSync(resolve(FIXTURES, name), 'utf8'))
}
export function readFixtureBytes(name: string): Uint8Array {
return readFileSync(resolve(FIXTURES, name))
}
export function uint8ArrayToArrayBuffer(bytes: Uint8Array): ArrayBuffer {
const buffer = bytes.buffer
if (buffer instanceof ArrayBuffer) {
return buffer.slice(bytes.byteOffset, bytes.byteOffset + bytes.byteLength)
}
const copy = new Uint8Array(bytes.byteLength)
copy.set(bytes)
return copy.buffer
}
export function readFixtureArrayBuffer(name: string): ArrayBuffer {
return uint8ArrayToArrayBuffer(readFixtureBytes(name))
}
export async function parseFixture(
name: string,
options?: ParseFigFileOptions
): Promise<SceneGraph> {
return parseFigFile(readFixtureArrayBuffer(name), options)
}
export async function parseGoldPreviewFixture(): Promise<{
graph: SceneGraph
allNodes: SceneNode[]
}> {
const graph = await parseFixture('gold-preview.fig')
return { graph, allNodes: collectAllNodes(graph) }
}
let sharedGoldPreview: ReturnType<typeof parseGoldPreviewFixture> | null = null
/**
* The fully populated `gold-preview.fig` graph, parsed once per process.
*
* Populating its ~38k instance children costs about 3 s and 700 MB, and a
* shard runs every file in one Bun process, so read-only suites share the
* result instead of paying that per file. Treat the graph as immutable: a
* test that creates, updates, deletes or lays out nodes must call
* `parseGoldPreviewFixture()` for its own copy.
*/
export function sharedGoldPreviewFixture(): ReturnType<typeof parseGoldPreviewFixture> {
sharedGoldPreview ??= parseGoldPreviewFixture()
return sharedGoldPreview
}
const LFS_POINTER_PREFIX = 'version https://git-lfs'
/**
* Read a `.fig` fixture by absolute path, or `null` when it is absent OR an
* un-fetched Git LFS pointer. `tests/fixtures/*.fig` are LFS-tracked, so on a
* shallow/LFS-less checkout `existsSync` passes but the bytes are a tiny ASCII
* pointer stub — parsing it would throw. Optional-local tests skip on `null`.
* (Contrast `readFixtureBytes`/`parseFixture`, which take a name and assume the
* fixture is present.)
*/
export function readFigFixture(path: string): ArrayBuffer | null {
if (!existsSync(path)) return null
const bytes = readFileSync(path)
if (
bytes.length < 1024 &&
bytes.toString('utf8', 0, LFS_POINTER_PREFIX.length) === LFS_POINTER_PREFIX
) {
return null
}
return bytes.buffer.slice(bytes.byteOffset, bytes.byteOffset + bytes.byteLength)
}
/** Parse a `.fig` fixture by path into a SceneGraph, or `null` when unavailable (see readFigFixture). */
export async function loadFigFixture(path: string): Promise<SceneGraph | null> {
const ab = readFigFixture(path)
return ab ? parseFigFile(ab) : null
}