mirror of
https://github.com/DayuanJiang/next-ai-draw-io.git
synced 2026-09-01 17:10:24 +08:00
feat(diagram-engine): layout + XML renderer, verified end to end in draw.io
Completes the tree → coordinates → XML direction, so the model can declare nesting and never write a coordinate or an mxCell again. layout.ts — measure bottom-up, place top-down, the same shape as flexbox. A container sums its children along the flow axis and adds padding, so "child spills out of its frame" and "siblings overlap" cannot happen by construction rather than being caught afterwards. Slack from sibling equalisation is shared between children instead of left as dead margin, capped at one gap so a stretched frame reads as spaced rather than sparse. render.ts — writes the mxCells, stamping container=1 and the dai_* markers so parse.ts can read the structure back. Edges carry no waypoints: draw.io's own router recomputes the route on every edit, so a user who moves a node never has to re-link an arrow. Cells the parser could not interpret are re-emitted verbatim, so a re-layout never deletes a user's annotations. Phantoms are gone (task #5). The reference project's layout-only wrapper emits no cell, which makes the round-trip lossy by construction — measured on its own build_vpc.mjs, a phantom erased a container's "col" direction for good. An unlabelled frame here emits a real cell with fillColor/strokeColor=none instead: invisible, but present in the XML and therefore recoverable. Two bugs the round-trip test caught, both real: - An icon's cell was being emitted at its measured slot size, which includes room for the label underneath. Parsing read that width back as the glyph size, so the icon grew on every round-trip. The cell is now the glyph square and the label renders outside it via verticalLabelPosition, as the reference does. - An Azure or GCP icon is an embedded base64 image whose style contains no name anywhere, so the catalog name was unrecoverable. Added a dai_name marker. Verified in a real browser (3 Playwright tests, not mocks): engine output renders in draw.io; dragging a shape into a frame makes draw.io rewrite its parent and the engine reads the new structure back; re-laying out from that structure PRESERVES the user's move instead of undoing it, and leaves untouched nodes alone; and the re-laid-out XML still renders. That last point is the whole design: there is no second copy of the state, so a manual edit is an input to the next layout rather than a conflict to reconcile. 304 unit tests + 3 e2e.
This commit is contained in:
dayuan.jiang
279
lib/diagram-engine/layout.ts
Normal file
279
lib/diagram-engine/layout.ts
Normal file
@@ -0,0 +1,279 @@
|
||||
/**
|
||||
* Layout: tree → coordinates.
|
||||
*
|
||||
* Two passes, the same shape as a flexbox implementation:
|
||||
*
|
||||
* measure — bottom-up. A leaf reports its intrinsic size; a container sums its
|
||||
* children along the flow axis, takes the maximum across it, and adds
|
||||
* padding and its title strip. A container therefore always ends up big
|
||||
* enough to hold what is inside it, which is why "child spills out of its
|
||||
* frame" cannot happen by construction.
|
||||
*
|
||||
* place — top-down. Each container distributes its now-known interior among its
|
||||
* children.
|
||||
*
|
||||
* The model never supplies a coordinate. It declares nesting, direction and gap; every
|
||||
* x/y/width/height comes from here.
|
||||
*
|
||||
* Ported from drawio-ai-kit (MIT) — see NOTICE.
|
||||
*/
|
||||
|
||||
import type { ContainerNode, DiagramNode, Rect } from "./types"
|
||||
import { isContainer } from "./types"
|
||||
|
||||
/** Default glyph size for a catalog icon. */
|
||||
export const ICON_SIZE = 48
|
||||
/** Interior padding of a container. */
|
||||
const PAD = 24
|
||||
/** Height of a container's title strip. Zero when it has no label — an empty strip
|
||||
* reads as a dead band at the top of the frame. */
|
||||
const HEADER = 36
|
||||
/** Approximate width of one label character at the engine's font size. */
|
||||
const CHAR_W = 6.6
|
||||
|
||||
/** A node with its computed box. Layout works on this, leaving the tree untouched. */
|
||||
export interface Placed {
|
||||
node: DiagramNode
|
||||
rect: Rect
|
||||
children: Placed[]
|
||||
}
|
||||
|
||||
/** Intrinsic size of a text box: widest wrapped line by line count. */
|
||||
export function autoBoxSize(label: string): { w: number; h: number } {
|
||||
const lines = String(label ?? "").split("\n")
|
||||
const longest = Math.max(1, ...lines.map((l) => l.length))
|
||||
return {
|
||||
w: Math.min(260, Math.max(120, Math.round(longest * CHAR_W + 28))),
|
||||
h: Math.max(44, lines.length * 18 + 26),
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Intrinsic size of an icon cell: the glyph, plus room for the label underneath, and
|
||||
* wide enough that a long label does not overflow the cell it is centred in.
|
||||
*/
|
||||
function iconSize(label: string, glyph: number): { w: number; h: number } {
|
||||
return {
|
||||
w: Math.max(96, glyph + 20, Math.min(200, label.length * 7 + 24)),
|
||||
h: glyph + 34,
|
||||
}
|
||||
}
|
||||
|
||||
/** A container is never narrower than its own title. */
|
||||
function titleFloor(label: string, pad: number): number {
|
||||
return label ? Math.ceil(label.length * CHAR_W) + pad * 2 : 0
|
||||
}
|
||||
|
||||
function headerFor(n: ContainerNode): number {
|
||||
return n.label ? HEADER : 0
|
||||
}
|
||||
|
||||
/**
|
||||
* measure: give every node a size, bottom-up.
|
||||
*
|
||||
* Siblings are equalised across the cross axis — frames in a row share a bottom edge,
|
||||
* frames in a column share left and right edges. Only containers stretch; a leaf keeps
|
||||
* its natural size, because stretching an icon would distort the glyph.
|
||||
*/
|
||||
function measure(n: DiagramNode, defaultGlyph: number): Placed {
|
||||
if (n.kind === "icon") {
|
||||
const glyph = n.size ?? defaultGlyph
|
||||
const s = iconSize(n.label, glyph)
|
||||
return { node: n, rect: { x: 0, y: 0, ...s }, children: [] }
|
||||
}
|
||||
if (n.kind === "box") {
|
||||
const auto = autoBoxSize(n.label)
|
||||
return {
|
||||
node: n,
|
||||
rect: { x: 0, y: 0, w: n.w ?? auto.w, h: n.h ?? auto.h },
|
||||
children: [],
|
||||
}
|
||||
}
|
||||
if (n.kind === "title") {
|
||||
return { node: n, rect: { x: 0, y: 0, w: 0, h: 30 }, children: [] }
|
||||
}
|
||||
|
||||
const kids = n.children.map((c) => measure(c, defaultGlyph))
|
||||
const head = headerFor(n)
|
||||
const gap = n.gap
|
||||
|
||||
if (n.kind === "grid") {
|
||||
const cols = Math.max(1, n.cols)
|
||||
const rows = Math.ceil(kids.length / cols) || 1
|
||||
const cellW = Math.max(0, ...kids.map((k) => k.rect.w))
|
||||
const cellH = Math.max(0, ...kids.map((k) => k.rect.h))
|
||||
const w = PAD * 2 + cols * cellW + gap * (cols - 1)
|
||||
const h = head + PAD * 2 + rows * cellH + gap * (rows - 1)
|
||||
return {
|
||||
node: n,
|
||||
rect: {
|
||||
x: 0,
|
||||
y: 0,
|
||||
w: Math.max(w, titleFloor(n.label, PAD)),
|
||||
h,
|
||||
},
|
||||
children: kids,
|
||||
}
|
||||
}
|
||||
|
||||
// group: row or col
|
||||
if (n.dir === "row") {
|
||||
const tallest = Math.max(0, ...kids.map((k) => k.rect.h))
|
||||
for (const k of kids)
|
||||
if (isContainer(k.node)) k.rect.h = Math.max(k.rect.h, tallest)
|
||||
const w =
|
||||
PAD * 2 +
|
||||
kids.reduce((s, k) => s + k.rect.w, 0) +
|
||||
gap * Math.max(0, kids.length - 1)
|
||||
const h = head + PAD * 2 + Math.max(0, ...kids.map((k) => k.rect.h))
|
||||
return {
|
||||
node: n,
|
||||
rect: { x: 0, y: 0, w: Math.max(w, titleFloor(n.label, PAD)), h },
|
||||
children: kids,
|
||||
}
|
||||
}
|
||||
|
||||
const widest = Math.max(0, ...kids.map((k) => k.rect.w))
|
||||
// Only groups stretch: a grid computes its own interior, so forcing it wider would
|
||||
// leave a gap inside it rather than filling the space.
|
||||
for (const k of kids)
|
||||
if (k.node.kind === "group") k.rect.w = Math.max(k.rect.w, widest)
|
||||
const w = PAD * 2 + Math.max(0, ...kids.map((k) => k.rect.w))
|
||||
const h =
|
||||
head +
|
||||
PAD * 2 +
|
||||
kids.reduce((s, k) => s + k.rect.h, 0) +
|
||||
gap * Math.max(0, kids.length - 1)
|
||||
return {
|
||||
node: n,
|
||||
rect: { x: 0, y: 0, w: Math.max(w, titleFloor(n.label, PAD)), h },
|
||||
children: kids,
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* place: assign absolute positions, top-down.
|
||||
*
|
||||
* When a container ended up larger than its content — because a sibling forced it
|
||||
* wider, or its own title did — the slack is shared between the children rather than
|
||||
* left as dead margin on one side. The extra spacing is capped at one base gap so a
|
||||
* stretched frame reads as deliberately spaced instead of sparse, and the resulting
|
||||
* cluster is centred.
|
||||
*/
|
||||
function place(p: Placed, x: number, y: number): void {
|
||||
p.rect.x = Math.round(x)
|
||||
p.rect.y = Math.round(y)
|
||||
const n = p.node
|
||||
if (!isContainer(n)) return
|
||||
|
||||
const head = headerFor(n)
|
||||
const innerX = p.rect.x + PAD
|
||||
const innerTop = p.rect.y + head + PAD
|
||||
const innerW = p.rect.w - PAD * 2
|
||||
const innerH = p.rect.h - head - PAD * 2
|
||||
const kids = p.children
|
||||
|
||||
if (n.kind === "grid") {
|
||||
const cols = Math.max(1, n.cols)
|
||||
const cellW = Math.max(0, ...kids.map((k) => k.rect.w))
|
||||
const cellH = Math.max(0, ...kids.map((k) => k.rect.h))
|
||||
kids.forEach((k, i) => {
|
||||
const r = Math.floor(i / cols)
|
||||
const c = i % cols
|
||||
const cx = innerX + c * (cellW + n.gap)
|
||||
const cy = innerTop + r * (cellH + n.gap)
|
||||
// centre each child in its cell so a short label does not sit off-axis
|
||||
place(k, cx + (cellW - k.rect.w) / 2, cy + (cellH - k.rect.h) / 2)
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
const alongRow = n.dir === "row"
|
||||
const sizes = kids.map((k) => (alongRow ? k.rect.w : k.rect.h))
|
||||
const content = sizes.reduce((s, v) => s + v, 0)
|
||||
const extent = alongRow ? innerW : innerH
|
||||
const k = kids.length
|
||||
const slack = Math.max(0, extent - content - n.gap * (k - 1))
|
||||
const gap = k > 1 ? n.gap + Math.min(n.gap, slack / (k - 1)) : n.gap
|
||||
const span = content + gap * Math.max(0, k - 1)
|
||||
let cur = (alongRow ? innerX : innerTop) + Math.max(0, (extent - span) / 2)
|
||||
|
||||
for (const kid of kids) {
|
||||
if (alongRow) {
|
||||
place(kid, cur, innerTop + (innerH - kid.rect.h) / 2)
|
||||
cur += kid.rect.w + gap
|
||||
} else {
|
||||
place(kid, innerX + (innerW - kid.rect.w) / 2, cur)
|
||||
cur += kid.rect.h + gap
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export interface LayoutResult {
|
||||
/** Placed roots, in the order given. */
|
||||
roots: Placed[]
|
||||
/** Page size that fits everything, with a margin. */
|
||||
page: { w: number; h: number }
|
||||
}
|
||||
|
||||
/** Where the tree starts on the page. Leaves room for a title above it. */
|
||||
const ORIGIN = { x: 40, y: 90 }
|
||||
const MARGIN = { right: 40, bottom: 50 }
|
||||
|
||||
/**
|
||||
* Lay out a forest of roots side by side and report the page size that fits them.
|
||||
*
|
||||
* A pinned node keeps the position it already had: the user moved it deliberately, and
|
||||
* the whole point of the pin is that a re-layout does not undo that.
|
||||
*/
|
||||
export function layoutForest(
|
||||
roots: DiagramNode[],
|
||||
opts: { iconSize?: number; gap?: number } = {},
|
||||
): LayoutResult {
|
||||
const glyph = opts.iconSize ?? ICON_SIZE
|
||||
const gap = opts.gap ?? 70
|
||||
const placed = roots.map((r) => measure(r, glyph))
|
||||
|
||||
let cur = ORIGIN.x
|
||||
for (const p of placed) {
|
||||
const n = p.node
|
||||
const held =
|
||||
n.kind === "title" ? null : n.pinned ? (n.rect ?? null) : null
|
||||
if (held) {
|
||||
place(p, held.x, held.y)
|
||||
} else {
|
||||
place(p, cur, ORIGIN.y)
|
||||
cur += p.rect.w + gap
|
||||
}
|
||||
}
|
||||
|
||||
let maxX = 0
|
||||
let maxY = 0
|
||||
const visit = (p: Placed) => {
|
||||
maxX = Math.max(maxX, p.rect.x + p.rect.w)
|
||||
maxY = Math.max(maxY, p.rect.y + p.rect.h)
|
||||
p.children.forEach(visit)
|
||||
}
|
||||
placed.forEach(visit)
|
||||
|
||||
return {
|
||||
roots: placed,
|
||||
page: {
|
||||
w: Math.round(maxX + MARGIN.right),
|
||||
h: Math.round(maxY + MARGIN.bottom),
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
/** Flatten a placed forest into (node, rect, parentId) triples in document order. */
|
||||
export function flatten(
|
||||
roots: Placed[],
|
||||
): { node: DiagramNode; rect: Rect; parent: string }[] {
|
||||
const out: { node: DiagramNode; rect: Rect; parent: string }[] = []
|
||||
const walk = (p: Placed, parent: string) => {
|
||||
out.push({ node: p.node, rect: p.rect, parent })
|
||||
for (const c of p.children) walk(c, p.node.id)
|
||||
}
|
||||
for (const r of roots) walk(r, "1")
|
||||
return out
|
||||
}
|
||||
@@ -36,6 +36,11 @@ export const MARKER = {
|
||||
cols: "dai_cols",
|
||||
/** Set by the user to freeze a node's position across re-layouts. */
|
||||
pin: "dai_pin",
|
||||
/**
|
||||
* A catalog icon's name. Needed because an Azure or GCP icon's style is an embedded
|
||||
* base64 image with no name anywhere in it, so the style alone cannot identify it.
|
||||
*/
|
||||
name: "dai_name",
|
||||
} as const
|
||||
|
||||
export type NodeKind = "group" | "grid" | "icon" | "box" | "title"
|
||||
@@ -54,6 +59,22 @@ export type Direction = "row" | "col" | "grid"
|
||||
const CONTAINER_TOKENS =
|
||||
"container=1;pointerEvents=0;collapsible=0;recursiveResize=0;"
|
||||
|
||||
/**
|
||||
* A container that groups children for layout but should not be visible.
|
||||
*
|
||||
* The reference project solves this with a "phantom": a wrapper that participates in
|
||||
* layout and then emits NO cell, reparenting its children onto the nearest visible
|
||||
* ancestor. That makes the round-trip lossy by construction — the wrapper's direction
|
||||
* and grouping are simply absent from the XML, so re-deriving the tree cannot recover
|
||||
* them. Measured on the reference project's own build_vpc.mjs: a phantom erased a
|
||||
* container's "col" direction, leaving children in a 2-D arrangement that can only be
|
||||
* read back as a grid.
|
||||
*
|
||||
* So we emit a real cell and make it invisible instead. One extra cell per wrapper,
|
||||
* in exchange for structure that survives being read back.
|
||||
*/
|
||||
const INVISIBLE_TOKENS = "fillColor=none;strokeColor=none;"
|
||||
|
||||
/** Read a marker's raw value out of a style string. Last occurrence wins, as draw.io does. */
|
||||
export function readMarker(style: string, key: string): string | null {
|
||||
// Scan all matches and keep the last, mirroring draw.io's duplicate-key resolution.
|
||||
@@ -127,10 +148,13 @@ export function stampContainer(
|
||||
dir: Direction
|
||||
gap: number
|
||||
cols?: number
|
||||
/** Layout-only wrapper: emit a real cell, but draw nothing. */
|
||||
invisible?: boolean
|
||||
},
|
||||
): string {
|
||||
let s = style.endsWith(";") || style === "" ? style : `${style};`
|
||||
s += CONTAINER_TOKENS
|
||||
if (opts.invisible) s += INVISIBLE_TOKENS
|
||||
s = append(s, MARKER.kind, opts.kind)
|
||||
s = append(s, MARKER.dir, opts.dir)
|
||||
s = append(s, MARKER.gap, Math.round(opts.gap))
|
||||
@@ -139,12 +163,30 @@ export function stampContainer(
|
||||
return s
|
||||
}
|
||||
|
||||
/** Stamp a leaf (icon or box) with its kind, so the parser need not infer it. */
|
||||
/**
|
||||
* Is this an invisible layout wrapper? Both colours set to `none` and no group
|
||||
* stencil — a visible frame always has a stroke or a stencil.
|
||||
*/
|
||||
export function isInvisible(style: string): boolean {
|
||||
if (/grIcon=/.test(style)) return false
|
||||
const fill = readMarker(style, "fillColor")
|
||||
const stroke = readMarker(style, "strokeColor")
|
||||
return fill === "none" && stroke === "none"
|
||||
}
|
||||
|
||||
/**
|
||||
* Stamp a leaf with its kind, so the parser need not infer it.
|
||||
*
|
||||
* For an icon, also record the catalog name: an Azure or GCP icon's style is an embedded
|
||||
* base64 image with no name in it, so the style alone cannot identify which icon it is.
|
||||
*/
|
||||
export function stampLeaf(
|
||||
style: string,
|
||||
kind: "icon" | "box" | "title",
|
||||
opts: { name?: string } = {},
|
||||
): string {
|
||||
return append(style, MARKER.kind, kind)
|
||||
const s = append(style, MARKER.kind, kind)
|
||||
return opts.name ? append(s, MARKER.name, opts.name) : s
|
||||
}
|
||||
|
||||
/** Strip every `dai_*` marker — for exporting a clean file, or comparing styles. */
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
254
lib/diagram-engine/render.ts
Normal file
254
lib/diagram-engine/render.ts
Normal file
@@ -0,0 +1,254 @@
|
||||
/**
|
||||
* tree → XML. Takes a laid-out forest and writes the mxCell elements draw.io reads.
|
||||
*
|
||||
* Every cell it emits carries `container=1` on containers and `dai_*` markers recording
|
||||
* the layout parameters, so parse.ts can read the structure back. That round-trip is
|
||||
* what lets the canvas stay the single source of truth.
|
||||
*
|
||||
* Ported from drawio-ai-kit (MIT) — see NOTICE.
|
||||
*/
|
||||
|
||||
import { flatten, ICON_SIZE, layoutForest, type Placed } from "./layout"
|
||||
import { stampContainer, stampLeaf } from "./markers"
|
||||
import type { DiagramNode, DiagramTree, LinkSpec, Rect } from "./types"
|
||||
|
||||
/** Escape the five characters that would break an XML attribute. */
|
||||
export function esc(s: string): string {
|
||||
return String(s ?? "")
|
||||
.replace(/&/g, "&")
|
||||
.replace(/</g, "<")
|
||||
.replace(/>/g, ">")
|
||||
.replace(/"/g, """)
|
||||
.replace(/'/g, "'")
|
||||
}
|
||||
|
||||
/** Resolve a catalog name to a style. Injected so the engine does not own the catalog. */
|
||||
export type StyleResolver = (
|
||||
name: string,
|
||||
kind: "icon" | "group",
|
||||
) => string | null
|
||||
|
||||
const FALLBACK_BOX =
|
||||
"rounded=0;whiteSpace=wrap;html=1;fillColor=#FFFFFF;strokeColor=#5A6B7B;fontColor=#1A1A1A;fontSize=11;verticalAlign=middle;"
|
||||
const FALLBACK_FRAME =
|
||||
"rounded=0;whiteSpace=wrap;html=1;fillColor=#FFFFFF;strokeColor=#999999;fontColor=#1A1A1A;fontSize=12;fontStyle=1;verticalAlign=top;align=left;spacingLeft=8;spacingTop=4;"
|
||||
const TITLE_STYLE =
|
||||
"text;html=1;align=center;fontStyle=1;fontSize=14;fontColor=light-dark(#232F3E,#E8E8E8);"
|
||||
const EDGE_STYLE =
|
||||
"edgeStyle=orthogonalEdgeStyle;html=1;rounded=0;jettySize=auto;orthogonalLoop=1;fontSize=10;fontColor=light-dark(#1B2733,#CFE0F0);strokeColor=light-dark(#1A1A1A,#E0E0E0);strokeWidth=1;"
|
||||
|
||||
export interface RenderOptions {
|
||||
/** Resolves a catalog icon/group name to its verbatim draw.io style. */
|
||||
resolveStyle?: StyleResolver
|
||||
/** Diagram-wide glyph size. */
|
||||
iconSize?: number
|
||||
/** Gap between top-level roots. */
|
||||
rootGap?: number
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the style for one node.
|
||||
*
|
||||
* A style recovered from XML is preferred over re-resolving the catalog name: it is
|
||||
* what is already on the canvas, including any colour the user changed by hand. We only
|
||||
* re-stamp the markers on top, so layout parameters stay current.
|
||||
*/
|
||||
function styleFor(n: DiagramNode, resolve: StyleResolver | undefined): string {
|
||||
if (n.kind === "title") return TITLE_STYLE
|
||||
|
||||
if (n.kind === "icon") {
|
||||
const base =
|
||||
n.style ??
|
||||
(n.name ? resolve?.(n.name, "icon") : null) ??
|
||||
FALLBACK_BOX
|
||||
return stampLeaf(base, "icon", { name: n.name })
|
||||
}
|
||||
|
||||
if (n.kind === "box") {
|
||||
let base = n.style ?? FALLBACK_BOX
|
||||
if (!n.style) {
|
||||
if (n.fill) base += `fillColor=${n.fill};`
|
||||
if (n.stroke) base += `strokeColor=${n.stroke};`
|
||||
if (n.bold) base += "fontStyle=1;"
|
||||
}
|
||||
return stampLeaf(base, "box")
|
||||
}
|
||||
|
||||
// container
|
||||
const fromCatalog = n.gname ? resolve?.(n.gname, "group") : null
|
||||
// An unlabelled frame with no stencil is a layout-only wrapper: emit a real cell so
|
||||
// the structure survives a round-trip, but draw nothing. This replaces the
|
||||
// reference project's "phantom", which emitted no cell and therefore lost the
|
||||
// wrapper's direction and grouping on the way back.
|
||||
const invisible = !n.gname && !n.label && !n.fill && !n.stroke
|
||||
let base = n.style ?? fromCatalog ?? FALLBACK_FRAME
|
||||
if (!n.style && !fromCatalog) {
|
||||
if (n.fill) base += `fillColor=${n.fill};`
|
||||
if (n.stroke) base += `strokeColor=${n.stroke};`
|
||||
}
|
||||
return stampContainer(base, {
|
||||
kind: n.kind,
|
||||
dir: n.kind === "grid" ? "grid" : n.dir,
|
||||
gap: n.gap,
|
||||
cols: n.kind === "grid" ? n.cols : undefined,
|
||||
invisible,
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* One `<mxCell>` for a vertex, with geometry relative to its parent.
|
||||
*
|
||||
* An icon's cell is the glyph square, not the measured slot. Layout reserves a wider,
|
||||
* taller slot so the label underneath has room, but the cell itself must stay square:
|
||||
* the stencil scales to the cell, and `verticalLabelPosition=bottom` renders the label
|
||||
* outside it. Emitting the padded slot would both stretch the glyph and — because the
|
||||
* padding depends on the label length — make the size grow on every round-trip.
|
||||
*/
|
||||
function vertexXml(
|
||||
n: DiagramNode,
|
||||
rect: Rect,
|
||||
parent: string,
|
||||
parentRect: Rect | null,
|
||||
resolve: StyleResolver | undefined,
|
||||
defaultGlyph: number,
|
||||
): string {
|
||||
const ox = parentRect?.x ?? 0
|
||||
const oy = parentRect?.y ?? 0
|
||||
let box = rect
|
||||
if (n.kind === "icon") {
|
||||
const glyph = n.size ?? defaultGlyph
|
||||
box = {
|
||||
x: Math.round(rect.x + (rect.w - glyph) / 2),
|
||||
y: rect.y,
|
||||
w: glyph,
|
||||
h: glyph,
|
||||
}
|
||||
}
|
||||
return (
|
||||
`<mxCell id="${esc(n.id)}" value="${esc("label" in n ? n.label : "")}"` +
|
||||
` style="${styleFor(n, resolve)}" vertex="1" parent="${esc(parent)}">` +
|
||||
`<mxGeometry x="${box.x - ox}" y="${box.y - oy}" width="${box.w}" height="${box.h}" as="geometry"/>` +
|
||||
`</mxCell>`
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* One `<mxCell>` for an edge.
|
||||
*
|
||||
* No waypoints: draw.io's own orthogonal router recomputes the route from the terminals
|
||||
* on every edit, so a user who moves a node never has to re-link an arrow. Freezing a
|
||||
* pre-computed route would look better on first open and then deform the moment anyone
|
||||
* touched the diagram — the wrong trade for an editor.
|
||||
*/
|
||||
function edgeXml(l: LinkSpec, index: number): string {
|
||||
const label =
|
||||
l.step != null
|
||||
? l.label
|
||||
? `${l.step}. ${l.label}`
|
||||
: `${l.step}.`
|
||||
: (l.label ?? "")
|
||||
let style = l.style ?? EDGE_STYLE
|
||||
if (!l.style) {
|
||||
if (l.dashed) style += "dashed=1;"
|
||||
if (label) style += "labelBackgroundColor=light-dark(#FFFFFF,#0B0F14);"
|
||||
}
|
||||
const id = l.id ?? `ed${index + 1}`
|
||||
return (
|
||||
`<mxCell id="${esc(id)}" value="${esc(label)}" style="${style}" edge="1" parent="1"` +
|
||||
` source="${esc(l.source)}" target="${esc(l.target)}">` +
|
||||
`<mxGeometry relative="1" as="geometry"/>` +
|
||||
`</mxCell>`
|
||||
)
|
||||
}
|
||||
|
||||
export interface RenderResult {
|
||||
/** A complete `<mxfile>` document, ready for the editor. */
|
||||
xml: string
|
||||
page: { w: number; h: number }
|
||||
/** Ids the links referenced that no node provides — these edges were dropped. */
|
||||
danglingLinks: string[]
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a tree to a complete draw.io document.
|
||||
*
|
||||
* Links whose endpoints do not exist are dropped rather than emitted: draw.io renders a
|
||||
* dangling edge as an arrow floating in space, which looks like a bug in the diagram.
|
||||
* The dropped ids are reported so the caller can tell the model what happened.
|
||||
*/
|
||||
export function renderDiagram(
|
||||
tree: DiagramTree,
|
||||
opts: RenderOptions = {},
|
||||
): RenderResult {
|
||||
const { roots, page } = layoutForest(tree.roots, {
|
||||
iconSize: opts.iconSize,
|
||||
gap: opts.rootGap,
|
||||
})
|
||||
|
||||
const flat = flatten(roots)
|
||||
const rectById = new Map<string, Rect>()
|
||||
for (const f of flat) rectById.set(f.node.id, f.rect)
|
||||
|
||||
const cells: string[] = []
|
||||
|
||||
// Title spans the page width, above the content.
|
||||
if (tree.title)
|
||||
cells.push(
|
||||
`<mxCell id="__title" value="${esc(tree.title)}" style="${TITLE_STYLE}" vertex="1" parent="1">` +
|
||||
`<mxGeometry x="0" y="24" width="${page.w}" height="30" as="geometry"/></mxCell>`,
|
||||
)
|
||||
|
||||
// Parents come before children (flatten guarantees it), which draw.io requires.
|
||||
const glyph = opts.iconSize ?? ICON_SIZE
|
||||
for (const f of flat) {
|
||||
const parentRect =
|
||||
f.parent === "1" ? null : (rectById.get(f.parent) ?? null)
|
||||
cells.push(
|
||||
vertexXml(
|
||||
f.node,
|
||||
f.rect,
|
||||
f.parent,
|
||||
parentRect,
|
||||
opts.resolveStyle,
|
||||
glyph,
|
||||
),
|
||||
)
|
||||
}
|
||||
|
||||
// Cells the parser could not interpret — user annotations, imported shapes — go back
|
||||
// verbatim. A re-layout must not delete work the engine does not understand.
|
||||
const foreignLayer = tree.foreign.some((c) => c.parent === "boundaries")
|
||||
if (foreignLayer)
|
||||
cells.push(
|
||||
`<mxCell id="boundaries" value="Boundaries (locked)" parent="0" style="locked=1;"/>`,
|
||||
)
|
||||
for (const c of tree.foreign) cells.push(c.xml)
|
||||
|
||||
const known = new Set(flat.map((f) => f.node.id))
|
||||
for (const c of tree.foreign) known.add(c.id)
|
||||
const dangling: string[] = []
|
||||
let emitted = 0
|
||||
for (const l of tree.links) {
|
||||
if (!known.has(l.source) || !known.has(l.target)) {
|
||||
if (!known.has(l.source)) dangling.push(l.source)
|
||||
if (!known.has(l.target)) dangling.push(l.target)
|
||||
continue
|
||||
}
|
||||
cells.push(edgeXml(l, emitted++))
|
||||
}
|
||||
|
||||
const model =
|
||||
`<mxGraphModel dx="1400" dy="900" grid="0" gridSize="10" guides="1" tooltips="1"` +
|
||||
` connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="${page.w}"` +
|
||||
` pageHeight="${page.h}" math="0" shadow="0"><root><mxCell id="0"/>` +
|
||||
`<mxCell id="1" parent="0"/>${cells.join("")}</root></mxGraphModel>`
|
||||
|
||||
return {
|
||||
xml: `<mxfile host="app.diagrams.net"><diagram name="Page-1" id="page-1">${model}</diagram></mxfile>`,
|
||||
page,
|
||||
danglingLinks: [...new Set(dangling)],
|
||||
}
|
||||
}
|
||||
|
||||
/** Re-export so callers can lay out without rendering. */
|
||||
export type { Placed }
|
||||
208
tests/e2e/diagram-engine-roundtrip.spec.ts
Normal file
208
tests/e2e/diagram-engine-roundtrip.spec.ts
Normal file
@@ -0,0 +1,208 @@
|
||||
/**
|
||||
* The closed loop, in a real browser: engine → draw.io → user drags something → engine
|
||||
* reads the structure back.
|
||||
*
|
||||
* The unit tests prove render and parse agree with each other. This proves they agree
|
||||
* with the actual editor: that the XML the engine writes renders, that a frame really
|
||||
* accepts a drop, and that the structure recovered afterwards matches what the user did
|
||||
* on screen.
|
||||
*
|
||||
* The engine runs in the test process (Playwright transpiles the spec, so the TypeScript
|
||||
* imports resolve); only XML strings cross into the page.
|
||||
*/
|
||||
import { expect, test } from "@playwright/test"
|
||||
import { parseDiagram } from "../../lib/diagram-engine/parse"
|
||||
import { renderDiagram } from "../../lib/diagram-engine/render"
|
||||
import { type DiagramTree, findParent } from "../../lib/diagram-engine/types"
|
||||
|
||||
/** Two frames side by side; MOVER starts in the left one. */
|
||||
function twoFrames(extraLeft: string[] = []): DiagramTree {
|
||||
return {
|
||||
roots: [
|
||||
{
|
||||
kind: "group",
|
||||
id: "root",
|
||||
gname: null,
|
||||
label: "Root",
|
||||
dir: "row",
|
||||
gap: 60,
|
||||
children: [
|
||||
{
|
||||
kind: "group",
|
||||
id: "left",
|
||||
gname: null,
|
||||
label: "Left",
|
||||
dir: "col",
|
||||
gap: 20,
|
||||
children: [
|
||||
{ kind: "box", id: "mover", label: "MOVER" },
|
||||
...extraLeft.map((id) => ({
|
||||
kind: "box" as const,
|
||||
id,
|
||||
label: id.toUpperCase(),
|
||||
})),
|
||||
],
|
||||
},
|
||||
{
|
||||
kind: "group",
|
||||
id: "right",
|
||||
gname: null,
|
||||
label: "Right",
|
||||
dir: "col",
|
||||
gap: 20,
|
||||
children: [
|
||||
{ kind: "box", id: "anchor", label: "ANCHOR" },
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
links: [],
|
||||
foreign: [],
|
||||
}
|
||||
}
|
||||
|
||||
async function loadAndWatch(
|
||||
page: import("@playwright/test").Page,
|
||||
xml: string,
|
||||
) {
|
||||
await page.evaluate(() => {
|
||||
const w = window as unknown as { __xml?: string[] }
|
||||
w.__xml = []
|
||||
window.addEventListener("message", (e: MessageEvent) => {
|
||||
if (typeof e.data !== "string") return
|
||||
try {
|
||||
const m = JSON.parse(e.data)
|
||||
if ((m.event === "autosave" || m.event === "save") && m.xml)
|
||||
w.__xml?.push(m.xml)
|
||||
} catch {
|
||||
/* not our message */
|
||||
}
|
||||
})
|
||||
})
|
||||
await page.evaluate((x) => {
|
||||
const iframe = document.querySelector("iframe") as HTMLIFrameElement
|
||||
iframe.contentWindow?.postMessage(
|
||||
JSON.stringify({ action: "load", xml: x, autosave: 1 }),
|
||||
"*",
|
||||
)
|
||||
}, xml)
|
||||
await page.waitForTimeout(4000)
|
||||
}
|
||||
|
||||
const lastXml = (page: import("@playwright/test").Page) =>
|
||||
page.evaluate(() => {
|
||||
const w = window as unknown as { __xml?: string[] }
|
||||
const a = w.__xml ?? []
|
||||
return a.length ? a[a.length - 1] : null
|
||||
})
|
||||
|
||||
const parentAttr = (xml: string, id: string) =>
|
||||
xml
|
||||
.match(new RegExp(`<mxCell[^>]*\\bid="${id}"[^>]*>`))?.[0]
|
||||
.match(/\bparent="([^"]*)"/)?.[1] ?? null
|
||||
|
||||
/** Drag the cell labelled `from` into the frame that holds the cell labelled `into`. */
|
||||
async function dragInto(
|
||||
page: import("@playwright/test").Page,
|
||||
from: string,
|
||||
into: string,
|
||||
) {
|
||||
const canvas = page.frameLocator("iframe")
|
||||
const src = canvas.getByText(from, { exact: true }).first()
|
||||
await src.waitFor({ state: "visible", timeout: 30000 })
|
||||
const dst = canvas.getByText(into, { exact: true }).first()
|
||||
await dst.waitFor({ state: "visible", timeout: 30000 })
|
||||
const sb = await src.boundingBox()
|
||||
const db = await dst.boundingBox()
|
||||
if (!sb || !db) throw new Error("cells not rendered")
|
||||
|
||||
// Drop below the anchor: inside the target frame, but not on top of the anchor.
|
||||
await page.mouse.move(sb.x + sb.width / 2, sb.y + sb.height / 2)
|
||||
await page.mouse.down()
|
||||
await page.mouse.move(sb.x + sb.width / 2 + 20, sb.y + 10, { steps: 8 })
|
||||
await page.mouse.move(db.x + db.width / 2, db.y + db.height + 30, {
|
||||
steps: 30,
|
||||
})
|
||||
await page.waitForTimeout(800)
|
||||
await page.mouse.up()
|
||||
await page.waitForTimeout(3000)
|
||||
}
|
||||
|
||||
test.describe("diagram engine, end to end", () => {
|
||||
test.beforeEach(async ({ page }) => {
|
||||
await page.goto("/", { waitUntil: "networkidle" })
|
||||
await page
|
||||
.locator("iframe")
|
||||
.waitFor({ state: "visible", timeout: 60000 })
|
||||
await page.waitForTimeout(6000)
|
||||
})
|
||||
|
||||
test("engine output renders, and a drop into a frame becomes structure", async ({
|
||||
page,
|
||||
}) => {
|
||||
test.setTimeout(180000)
|
||||
|
||||
const { xml } = renderDiagram(twoFrames())
|
||||
expect(xml).toContain("container=1")
|
||||
await loadAndWatch(page, xml)
|
||||
|
||||
await dragInto(page, "MOVER", "ANCHOR")
|
||||
|
||||
const after = await lastXml(page)
|
||||
expect(after, "editor emitted no autosave after the drag").toBeTruthy()
|
||||
if (!after) return
|
||||
|
||||
// draw.io reparented it, because the frame carries container=1.
|
||||
expect(parentAttr(after, "mover")).toBe("right")
|
||||
|
||||
// ...and the engine reads the user's change back as structure. There is no
|
||||
// second copy of the state, so nothing to reconcile.
|
||||
const { tree, needsAdoption } = parseDiagram(after)
|
||||
expect(findParent(tree, "mover")?.id).toBe("right")
|
||||
expect(findParent(tree, "anchor")?.id).toBe("right")
|
||||
expect(needsAdoption).toBe(false) // markers survived the editor
|
||||
})
|
||||
|
||||
test("a re-layout after the drag keeps the node in its new frame", async ({
|
||||
page,
|
||||
}) => {
|
||||
test.setTimeout(180000)
|
||||
|
||||
const { xml } = renderDiagram(twoFrames(["stay"]))
|
||||
await loadAndWatch(page, xml)
|
||||
await dragInto(page, "MOVER", "ANCHOR")
|
||||
|
||||
const after = await lastXml(page)
|
||||
expect(after).toBeTruthy()
|
||||
if (!after) return
|
||||
|
||||
const afterDrag = parseDiagram(after).tree
|
||||
expect(findParent(afterDrag, "mover")?.id).toBe("right")
|
||||
|
||||
// Re-lay-out from what the canvas says, then read it back: the user's move is
|
||||
// preserved rather than undone, and the node they did not touch stays put.
|
||||
const relaid = parseDiagram(renderDiagram(afterDrag).xml).tree
|
||||
expect(findParent(relaid, "mover")?.id).toBe("right")
|
||||
expect(findParent(relaid, "stay")?.id).toBe("left")
|
||||
})
|
||||
|
||||
test("the re-laid-out diagram still renders in the editor", async ({
|
||||
page,
|
||||
}) => {
|
||||
test.setTimeout(180000)
|
||||
|
||||
// Guards against the engine emitting XML that parses fine but the editor
|
||||
// rejects — geometry the wrong side of a parent, a forward reference, and so on.
|
||||
const first = renderDiagram(twoFrames(["stay"]))
|
||||
const relaid = renderDiagram(parseDiagram(first.xml).tree)
|
||||
|
||||
await loadAndWatch(page, relaid.xml)
|
||||
const canvas = page.frameLocator("iframe")
|
||||
for (const label of ["MOVER", "STAY", "ANCHOR", "Left", "Right"]) {
|
||||
await expect(
|
||||
canvas.getByText(label, { exact: true }).first(),
|
||||
).toBeVisible({ timeout: 20000 })
|
||||
}
|
||||
})
|
||||
})
|
||||
466
tests/unit/diagram-engine-layout.test.ts
Normal file
466
tests/unit/diagram-engine-layout.test.ts
Normal file
@@ -0,0 +1,466 @@
|
||||
import { describe, expect, it } from "vitest"
|
||||
import {
|
||||
autoBoxSize,
|
||||
flatten,
|
||||
layoutForest,
|
||||
type Placed,
|
||||
} from "@/lib/diagram-engine/layout"
|
||||
import type {
|
||||
BoxNode,
|
||||
DiagramNode,
|
||||
GridNode,
|
||||
GroupNode,
|
||||
IconNode,
|
||||
Rect,
|
||||
} from "@/lib/diagram-engine/types"
|
||||
|
||||
const icon = (id: string, label = "", size?: number): IconNode => ({
|
||||
kind: "icon",
|
||||
id,
|
||||
name: "ec2",
|
||||
label,
|
||||
size,
|
||||
})
|
||||
const box = (id: string, label = "", w?: number, h?: number): BoxNode => ({
|
||||
kind: "box",
|
||||
id,
|
||||
label,
|
||||
w,
|
||||
h,
|
||||
})
|
||||
const group = (
|
||||
id: string,
|
||||
dir: "row" | "col",
|
||||
children: DiagramNode[],
|
||||
label = "",
|
||||
gap = 20,
|
||||
): GroupNode => ({ kind: "group", id, gname: null, label, dir, gap, children })
|
||||
const grid = (
|
||||
id: string,
|
||||
cols: number,
|
||||
children: DiagramNode[],
|
||||
label = "",
|
||||
gap = 20,
|
||||
): GridNode => ({ kind: "grid", id, gname: null, label, cols, gap, children })
|
||||
|
||||
/** Look a rect up by node id in a placed forest. */
|
||||
function rects(roots: Placed[]): Map<string, Rect> {
|
||||
const m = new Map<string, Rect>()
|
||||
for (const f of flatten(roots)) m.set(f.node.id, f.rect)
|
||||
return m
|
||||
}
|
||||
const contains = (outer: Rect, inner: Rect) =>
|
||||
inner.x >= outer.x &&
|
||||
inner.y >= outer.y &&
|
||||
inner.x + inner.w <= outer.x + outer.w &&
|
||||
inner.y + inner.h <= outer.y + outer.h
|
||||
const overlaps = (a: Rect, b: Rect) =>
|
||||
Math.min(a.x + a.w, b.x + b.w) - Math.max(a.x, b.x) > 0 &&
|
||||
Math.min(a.y + a.h, b.y + b.h) - Math.max(a.y, b.y) > 0
|
||||
|
||||
describe("autoBoxSize", () => {
|
||||
it("widens with the label but stops at a maximum", () => {
|
||||
expect(autoBoxSize("hi").w).toBe(120) // floor
|
||||
expect(autoBoxSize("x".repeat(200)).w).toBe(260) // ceiling
|
||||
expect(autoBoxSize("a medium length label").w).toBeGreaterThan(120)
|
||||
})
|
||||
|
||||
it("grows taller with each line", () => {
|
||||
expect(autoBoxSize("one\ntwo\nthree").h).toBeGreaterThan(
|
||||
autoBoxSize("one").h,
|
||||
)
|
||||
})
|
||||
|
||||
it("never returns a degenerate size for an empty label", () => {
|
||||
const s = autoBoxSize("")
|
||||
expect(s.w).toBeGreaterThan(0)
|
||||
expect(s.h).toBeGreaterThan(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("containers always fit their children", () => {
|
||||
it("holds a row of icons", () => {
|
||||
const tree = group(
|
||||
"f",
|
||||
"row",
|
||||
[icon("a"), icon("b"), icon("c")],
|
||||
"Frame",
|
||||
)
|
||||
const r = rects(layoutForest([tree]).roots)
|
||||
const frame = r.get("f") as Rect
|
||||
for (const id of ["a", "b", "c"])
|
||||
expect(contains(frame, r.get(id) as Rect)).toBe(true)
|
||||
})
|
||||
|
||||
it("holds a column of icons", () => {
|
||||
const tree = group("f", "col", [icon("a"), icon("b")], "Frame")
|
||||
const r = rects(layoutForest([tree]).roots)
|
||||
for (const id of ["a", "b"])
|
||||
expect(contains(r.get("f") as Rect, r.get(id) as Rect)).toBe(true)
|
||||
})
|
||||
|
||||
it("holds a grid", () => {
|
||||
const tree = grid(
|
||||
"g",
|
||||
3,
|
||||
[icon("a"), icon("b"), icon("c"), icon("d")],
|
||||
"G",
|
||||
)
|
||||
const r = rects(layoutForest([tree]).roots)
|
||||
for (const id of ["a", "b", "c", "d"])
|
||||
expect(contains(r.get("g") as Rect, r.get(id) as Rect)).toBe(true)
|
||||
})
|
||||
|
||||
it("holds a deeply nested structure at every level", () => {
|
||||
// Region → VPC → AZ → Subnet → icon, the shape of a real cloud diagram
|
||||
const tree = group(
|
||||
"region",
|
||||
"row",
|
||||
[
|
||||
group(
|
||||
"vpc",
|
||||
"col",
|
||||
[
|
||||
group(
|
||||
"az",
|
||||
"col",
|
||||
[group("subnet", "col", [icon("ec2")], "Subnet")],
|
||||
"AZ",
|
||||
),
|
||||
],
|
||||
"VPC",
|
||||
),
|
||||
],
|
||||
"Region",
|
||||
)
|
||||
const r = rects(layoutForest([tree]).roots)
|
||||
const chain = ["region", "vpc", "az", "subnet", "ec2"]
|
||||
for (let i = 1; i < chain.length; i++)
|
||||
expect(
|
||||
contains(r.get(chain[i - 1]) as Rect, r.get(chain[i]) as Rect),
|
||||
).toBe(true)
|
||||
})
|
||||
|
||||
it("holds a child whose label is far wider than the frame's own", () => {
|
||||
const tree = group(
|
||||
"f",
|
||||
"col",
|
||||
[box("wide", "a considerably longer label than the frame title")],
|
||||
"F",
|
||||
)
|
||||
const r = rects(layoutForest([tree]).roots)
|
||||
expect(contains(r.get("f") as Rect, r.get("wide") as Rect)).toBe(true)
|
||||
})
|
||||
})
|
||||
|
||||
describe("siblings never overlap", () => {
|
||||
it("keeps a row of icons apart", () => {
|
||||
const tree = group("f", "row", [icon("a"), icon("b"), icon("c")])
|
||||
const r = rects(layoutForest([tree]).roots)
|
||||
expect(overlaps(r.get("a") as Rect, r.get("b") as Rect)).toBe(false)
|
||||
expect(overlaps(r.get("b") as Rect, r.get("c") as Rect)).toBe(false)
|
||||
})
|
||||
|
||||
it("keeps a column of frames apart", () => {
|
||||
const tree = group("f", "col", [
|
||||
group("s1", "row", [icon("a")], "Public"),
|
||||
group("s2", "row", [icon("b")], "Private"),
|
||||
group("s3", "row", [icon("c")], "Data"),
|
||||
])
|
||||
const r = rects(layoutForest([tree]).roots)
|
||||
expect(overlaps(r.get("s1") as Rect, r.get("s2") as Rect)).toBe(false)
|
||||
expect(overlaps(r.get("s2") as Rect, r.get("s3") as Rect)).toBe(false)
|
||||
})
|
||||
|
||||
it("keeps grid cells apart", () => {
|
||||
const tree = grid("g", 2, [icon("a"), icon("b"), icon("c"), icon("d")])
|
||||
const r = rects(layoutForest([tree]).roots)
|
||||
const ids = ["a", "b", "c", "d"]
|
||||
for (let i = 0; i < ids.length; i++)
|
||||
for (let j = i + 1; j < ids.length; j++)
|
||||
expect(
|
||||
overlaps(r.get(ids[i]) as Rect, r.get(ids[j]) as Rect),
|
||||
).toBe(false)
|
||||
})
|
||||
|
||||
it("keeps separate roots apart", () => {
|
||||
const r = rects(
|
||||
layoutForest([
|
||||
box("users", "Users"),
|
||||
group("region", "row", [icon("a")]),
|
||||
]).roots,
|
||||
)
|
||||
expect(overlaps(r.get("users") as Rect, r.get("region") as Rect)).toBe(
|
||||
false,
|
||||
)
|
||||
})
|
||||
|
||||
it("keeps 30 siblings apart — no accumulation error", () => {
|
||||
const kids = Array.from({ length: 30 }, (_, i) =>
|
||||
icon(`i${i}`, `n${i}`),
|
||||
)
|
||||
const r = rects(layoutForest([group("f", "row", kids)]).roots)
|
||||
for (let i = 1; i < 30; i++) {
|
||||
const prev = r.get(`i${i - 1}`) as Rect
|
||||
const cur = r.get(`i${i}`) as Rect
|
||||
expect(cur.x).toBeGreaterThanOrEqual(prev.x + prev.w)
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
describe("direction", () => {
|
||||
it("advances along x in a row and keeps y aligned", () => {
|
||||
const r = rects(
|
||||
layoutForest([group("f", "row", [icon("a"), icon("b")])]).roots,
|
||||
)
|
||||
const a = r.get("a") as Rect
|
||||
const b = r.get("b") as Rect
|
||||
expect(b.x).toBeGreaterThan(a.x)
|
||||
expect(b.y).toBe(a.y)
|
||||
})
|
||||
|
||||
it("advances along y in a column and keeps x aligned", () => {
|
||||
const r = rects(
|
||||
layoutForest([group("f", "col", [icon("a"), icon("b")])]).roots,
|
||||
)
|
||||
const a = r.get("a") as Rect
|
||||
const b = r.get("b") as Rect
|
||||
expect(b.y).toBeGreaterThan(a.y)
|
||||
expect(b.x).toBe(a.x)
|
||||
})
|
||||
|
||||
it("wraps a grid at the column count", () => {
|
||||
const r = rects(
|
||||
layoutForest([
|
||||
grid("g", 2, [icon("a"), icon("b"), icon("c"), icon("d")]),
|
||||
]).roots,
|
||||
)
|
||||
const a = r.get("a") as Rect
|
||||
const b = r.get("b") as Rect
|
||||
const c = r.get("c") as Rect
|
||||
expect(b.y).toBe(a.y) // same row
|
||||
expect(c.y).toBeGreaterThan(a.y) // wrapped
|
||||
expect(c.x).toBe(a.x) // back to the first column
|
||||
})
|
||||
})
|
||||
|
||||
describe("sibling equalisation", () => {
|
||||
it("gives frames in a row a shared height", () => {
|
||||
const tree = group("f", "row", [
|
||||
group("tall", "col", [icon("a"), icon("b"), icon("c")], "Tall"),
|
||||
group("short", "col", [icon("d")], "Short"),
|
||||
])
|
||||
const r = rects(layoutForest([tree]).roots)
|
||||
expect((r.get("short") as Rect).h).toBe((r.get("tall") as Rect).h)
|
||||
})
|
||||
|
||||
it("gives frames in a column a shared width", () => {
|
||||
const tree = group("f", "col", [
|
||||
group("wide", "row", [icon("a"), icon("b"), icon("c")], "Wide"),
|
||||
group("narrow", "row", [icon("d")], "Narrow"),
|
||||
])
|
||||
const r = rects(layoutForest([tree]).roots)
|
||||
expect((r.get("narrow") as Rect).w).toBe((r.get("wide") as Rect).w)
|
||||
})
|
||||
|
||||
it("does not stretch a leaf icon — that would distort the glyph", () => {
|
||||
const tree = group("f", "row", [
|
||||
group("tall", "col", [icon("a"), icon("b"), icon("c")], "Tall"),
|
||||
icon("lone", "Lone"),
|
||||
])
|
||||
const r = rects(layoutForest([tree]).roots)
|
||||
expect((r.get("lone") as Rect).h).toBeLessThan(
|
||||
(r.get("tall") as Rect).h,
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
describe("title strip", () => {
|
||||
it("reserves space above the children when a container is labelled", () => {
|
||||
const withLabel = rects(
|
||||
layoutForest([group("f", "row", [icon("a")], "Titled")]).roots,
|
||||
)
|
||||
const withoutLabel = rects(
|
||||
layoutForest([group("f", "row", [icon("a")], "")]).roots,
|
||||
)
|
||||
expect((withLabel.get("f") as Rect).h).toBeGreaterThan(
|
||||
(withoutLabel.get("f") as Rect).h,
|
||||
)
|
||||
})
|
||||
|
||||
it("pushes children below the strip so the label is not covered", () => {
|
||||
const r = rects(
|
||||
layoutForest([group("f", "col", [icon("a")], "Titled")]).roots,
|
||||
)
|
||||
const f = r.get("f") as Rect
|
||||
const a = r.get("a") as Rect
|
||||
expect(a.y).toBeGreaterThanOrEqual(f.y + 36)
|
||||
})
|
||||
|
||||
it("widens a frame whose title is longer than its contents", () => {
|
||||
const longTitle =
|
||||
"A Very Long Container Title That Exceeds Its Single Child"
|
||||
const r = rects(
|
||||
layoutForest([group("f", "row", [icon("a")], longTitle)]).roots,
|
||||
)
|
||||
expect((r.get("f") as Rect).w).toBeGreaterThan(longTitle.length * 5)
|
||||
})
|
||||
})
|
||||
|
||||
describe("page size", () => {
|
||||
it("covers every node plus a margin", () => {
|
||||
const { roots, page } = layoutForest([
|
||||
group("f", "row", [icon("a"), icon("b")], "F"),
|
||||
])
|
||||
const all = flatten(roots)
|
||||
const maxX = Math.max(...all.map((n) => n.rect.x + n.rect.w))
|
||||
const maxY = Math.max(...all.map((n) => n.rect.y + n.rect.h))
|
||||
expect(page.w).toBeGreaterThan(maxX)
|
||||
expect(page.h).toBeGreaterThan(maxY)
|
||||
})
|
||||
|
||||
it("grows with the content", () => {
|
||||
const small = layoutForest([group("f", "row", [icon("a")])]).page
|
||||
const big = layoutForest([
|
||||
group(
|
||||
"f",
|
||||
"row",
|
||||
Array.from({ length: 10 }, (_, i) => icon(`i${i}`)),
|
||||
),
|
||||
]).page
|
||||
expect(big.w).toBeGreaterThan(small.w)
|
||||
})
|
||||
})
|
||||
|
||||
describe("pinned nodes", () => {
|
||||
it("keeps a pinned root where the user left it", () => {
|
||||
const pinned: GroupNode = {
|
||||
...group("f", "row", [icon("a")], "F"),
|
||||
pinned: true,
|
||||
rect: { x: 777, y: 555, w: 100, h: 100 },
|
||||
}
|
||||
const r = rects(layoutForest([pinned]).roots)
|
||||
expect((r.get("f") as Rect).x).toBe(777)
|
||||
expect((r.get("f") as Rect).y).toBe(555)
|
||||
})
|
||||
|
||||
it("still lays the pinned node's children out inside it", () => {
|
||||
const pinned: GroupNode = {
|
||||
...group("f", "row", [icon("a")], "F"),
|
||||
pinned: true,
|
||||
rect: { x: 300, y: 300, w: 100, h: 100 },
|
||||
}
|
||||
const r = rects(layoutForest([pinned]).roots)
|
||||
expect(contains(r.get("f") as Rect, r.get("a") as Rect)).toBe(true)
|
||||
})
|
||||
|
||||
it("does not let a pinned root consume flow space from the others", () => {
|
||||
const pinned: BoxNode = {
|
||||
...box("pin", "Pinned"),
|
||||
pinned: true,
|
||||
rect: { x: 900, y: 900, w: 120, h: 60 },
|
||||
}
|
||||
const r = rects(layoutForest([pinned, box("flow", "Flow")]).roots)
|
||||
// the un-pinned root starts at the normal origin, not offset past the pinned one
|
||||
expect((r.get("flow") as Rect).x).toBe(40)
|
||||
})
|
||||
})
|
||||
|
||||
describe("icon sizing", () => {
|
||||
it("applies the diagram-wide glyph size", () => {
|
||||
const small = rects(layoutForest([icon("a")], { iconSize: 48 }).roots)
|
||||
const large = rects(layoutForest([icon("a")], { iconSize: 96 }).roots)
|
||||
expect((large.get("a") as Rect).h).toBeGreaterThan(
|
||||
(small.get("a") as Rect).h,
|
||||
)
|
||||
})
|
||||
|
||||
it("lets a per-icon size override the diagram default", () => {
|
||||
const r = rects(
|
||||
layoutForest([group("f", "row", [icon("a"), icon("b", "", 96)])], {
|
||||
iconSize: 48,
|
||||
}).roots,
|
||||
)
|
||||
expect((r.get("b") as Rect).h).toBeGreaterThan((r.get("a") as Rect).h)
|
||||
})
|
||||
|
||||
it("widens the cell for a long label so it does not overflow", () => {
|
||||
const r = rects(
|
||||
layoutForest([
|
||||
group("f", "row", [
|
||||
icon("a", "x"),
|
||||
icon("b", "a much longer label"),
|
||||
]),
|
||||
]).roots,
|
||||
)
|
||||
expect((r.get("b") as Rect).w).toBeGreaterThan((r.get("a") as Rect).w)
|
||||
})
|
||||
})
|
||||
|
||||
describe("degenerate input", () => {
|
||||
it("handles an empty forest", () => {
|
||||
const { roots, page } = layoutForest([])
|
||||
expect(roots).toEqual([])
|
||||
expect(page.w).toBeGreaterThan(0)
|
||||
})
|
||||
|
||||
it("handles an empty container without producing a negative size", () => {
|
||||
const r = rects(layoutForest([group("f", "row", [], "Empty")]).roots)
|
||||
const f = r.get("f") as Rect
|
||||
expect(f.w).toBeGreaterThan(0)
|
||||
expect(f.h).toBeGreaterThan(0)
|
||||
})
|
||||
|
||||
it("handles a grid with fewer children than columns", () => {
|
||||
const r = rects(layoutForest([grid("g", 5, [icon("a")], "G")]).roots)
|
||||
expect(contains(r.get("g") as Rect, r.get("a") as Rect)).toBe(true)
|
||||
})
|
||||
|
||||
it("rounds every coordinate to an integer — draw.io renders half-pixels blurry", () => {
|
||||
const tree = group("f", "row", [
|
||||
group("a", "col", [icon("x"), icon("y"), icon("z")], "A"),
|
||||
icon("b"),
|
||||
])
|
||||
for (const f of flatten(layoutForest([tree]).roots)) {
|
||||
expect(Number.isInteger(f.rect.x)).toBe(true)
|
||||
expect(Number.isInteger(f.rect.y)).toBe(true)
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
describe("determinism", () => {
|
||||
it("produces identical geometry for the same tree twice", () => {
|
||||
const build = () =>
|
||||
group("f", "row", [
|
||||
group("a", "col", [icon("x"), icon("y")], "A"),
|
||||
grid("g", 2, [icon("p"), icon("q"), icon("r")], "G"),
|
||||
])
|
||||
const first = flatten(layoutForest([build()]).roots).map((n) => [
|
||||
n.node.id,
|
||||
n.rect,
|
||||
])
|
||||
const second = flatten(layoutForest([build()]).roots).map((n) => [
|
||||
n.node.id,
|
||||
n.rect,
|
||||
])
|
||||
expect(second).toEqual(first)
|
||||
})
|
||||
})
|
||||
|
||||
describe("flatten", () => {
|
||||
it("reports the real parent id for a nested node and the layer for a root", () => {
|
||||
const tree = group("f", "row", [group("inner", "row", [icon("leaf")])])
|
||||
const flat = flatten(layoutForest([tree]).roots)
|
||||
const by = new Map(flat.map((n) => [n.node.id, n.parent]))
|
||||
expect(by.get("f")).toBe("1")
|
||||
expect(by.get("inner")).toBe("f")
|
||||
expect(by.get("leaf")).toBe("inner")
|
||||
})
|
||||
|
||||
it("emits a parent before its children, so XML order is valid", () => {
|
||||
const tree = group("f", "row", [group("inner", "row", [icon("leaf")])])
|
||||
const ids = flatten(layoutForest([tree]).roots).map((n) => n.node.id)
|
||||
expect(ids.indexOf("f")).toBeLessThan(ids.indexOf("inner"))
|
||||
expect(ids.indexOf("inner")).toBeLessThan(ids.indexOf("leaf"))
|
||||
})
|
||||
})
|
||||
@@ -135,9 +135,17 @@ describe("parseDiagram on real engine output", () => {
|
||||
//
|
||||
// This is why our engine must not have phantoms: a wrapper that emits no cell
|
||||
// makes the round-trip lossy by construction. See task #5.
|
||||
expect(findNode(tree, "vpc")?.kind).toBe("grid")
|
||||
//
|
||||
// The parser does not guess a direction here. It keeps the container and warns
|
||||
// that the arrangement is two-dimensional, so the caller knows a re-layout will
|
||||
// move these children rather than discovering it afterwards.
|
||||
expect(findParent(tree, "az_a")?.id).toBe("vpc")
|
||||
expect(findNode(tree, "azs")).toBeNull()
|
||||
expect(
|
||||
warnings.some(
|
||||
(w) => w.includes("vpc") && w.includes("two dimensions"),
|
||||
),
|
||||
).toBe(true)
|
||||
})
|
||||
|
||||
it("classifies resourceIcon cells as icons and recovers their catalog name", () => {
|
||||
@@ -186,8 +194,11 @@ describe("parseDiagram on real engine output", () => {
|
||||
expect(needsAdoption).toBe(true)
|
||||
})
|
||||
|
||||
it("parses without warnings on a well-formed single page", () => {
|
||||
expect(warnings).toEqual([])
|
||||
it("warns only about the phantom-flattened container, nothing else", () => {
|
||||
// The single warning is the 2-D arrangement the phantom left behind; a
|
||||
// well-formed page produces no other complaint.
|
||||
expect(warnings).toHaveLength(1)
|
||||
expect(warnings[0]).toContain("two dimensions")
|
||||
})
|
||||
|
||||
it("assigns every cell exactly once — no duplicates, nothing lost", () => {
|
||||
|
||||
541
tests/unit/diagram-engine-roundtrip.test.ts
Normal file
541
tests/unit/diagram-engine-roundtrip.test.ts
Normal file
@@ -0,0 +1,541 @@
|
||||
/**
|
||||
* Round-trip: tree → XML → tree.
|
||||
*
|
||||
* This is the test the whole design rests on. If structure does not survive a trip
|
||||
* through draw.io XML, then the canvas cannot be the single source of truth and we are
|
||||
* back to keeping a second copy of the state in sync.
|
||||
*/
|
||||
import { describe, expect, it } from "vitest"
|
||||
import { parseDiagram } from "@/lib/diagram-engine/parse"
|
||||
import { renderDiagram } from "@/lib/diagram-engine/render"
|
||||
import {
|
||||
type BoxNode,
|
||||
type ContainerNode,
|
||||
type DiagramNode,
|
||||
type DiagramTree,
|
||||
findNode,
|
||||
findParent,
|
||||
type GridNode,
|
||||
type GroupNode,
|
||||
type IconNode,
|
||||
isContainer,
|
||||
walkTree,
|
||||
} from "@/lib/diagram-engine/types"
|
||||
|
||||
const icon = (id: string, name = "ec2", label = ""): IconNode => ({
|
||||
kind: "icon",
|
||||
id,
|
||||
name,
|
||||
label,
|
||||
})
|
||||
const box = (id: string, label = ""): BoxNode => ({ kind: "box", id, label })
|
||||
const group = (
|
||||
id: string,
|
||||
dir: "row" | "col",
|
||||
children: DiagramNode[],
|
||||
label = "",
|
||||
gname: string | null = null,
|
||||
gap = 20,
|
||||
): GroupNode => ({ kind: "group", id, gname, label, dir, gap, children })
|
||||
const grid = (
|
||||
id: string,
|
||||
cols: number,
|
||||
children: DiagramNode[],
|
||||
label = "",
|
||||
gap = 14,
|
||||
): GridNode => ({ kind: "grid", id, gname: null, label, cols, gap, children })
|
||||
|
||||
const tree = (
|
||||
roots: DiagramNode[],
|
||||
extra: Partial<DiagramTree> = {},
|
||||
): DiagramTree => ({
|
||||
roots,
|
||||
links: [],
|
||||
foreign: [],
|
||||
...extra,
|
||||
})
|
||||
|
||||
/** Structural signature: nesting, kinds, directions and order — everything but coordinates. */
|
||||
function signature(t: DiagramTree): string {
|
||||
const line = (n: DiagramNode, depth: number): string[] => {
|
||||
const pad = " ".repeat(depth)
|
||||
if (!isContainer(n)) return [`${pad}${n.kind} ${n.id}`]
|
||||
const meta = n.kind === "grid" ? `cols=${n.cols}` : `dir=${n.dir}`
|
||||
return [
|
||||
`${pad}${n.kind} ${n.id} ${meta} gap=${n.gap}`,
|
||||
...n.children.flatMap((c) => line(c, depth + 1)),
|
||||
]
|
||||
}
|
||||
return t.roots.flatMap((r) => line(r, 0)).join("\n")
|
||||
}
|
||||
|
||||
/** Render then parse, returning the recovered tree. */
|
||||
function roundTrip(t: DiagramTree) {
|
||||
const { xml } = renderDiagram(t)
|
||||
return { xml, ...parseDiagram(xml) }
|
||||
}
|
||||
|
||||
describe("structure survives a round-trip", () => {
|
||||
it("recovers a flat row", () => {
|
||||
const t = tree([group("f", "row", [icon("a"), icon("b")], "Frame")])
|
||||
expect(signature(roundTrip(t).tree)).toBe(signature(t))
|
||||
})
|
||||
|
||||
it("recovers a column", () => {
|
||||
const t = tree([group("f", "col", [icon("a"), icon("b")], "Frame")])
|
||||
expect(signature(roundTrip(t).tree)).toBe(signature(t))
|
||||
})
|
||||
|
||||
it("recovers a grid with its column count", () => {
|
||||
const t = tree([
|
||||
grid("g", 3, [icon("a"), icon("b"), icon("c"), icon("d")], "G"),
|
||||
])
|
||||
expect(signature(roundTrip(t).tree)).toBe(signature(t))
|
||||
})
|
||||
|
||||
it("recovers a deep cloud-architecture nesting", () => {
|
||||
const t = tree([
|
||||
group(
|
||||
"region",
|
||||
"row",
|
||||
[
|
||||
group(
|
||||
"vpc",
|
||||
"col",
|
||||
[
|
||||
icon("igw", "internet_gateway", "IGW"),
|
||||
group(
|
||||
"az_a",
|
||||
"col",
|
||||
[
|
||||
group(
|
||||
"pub_a",
|
||||
"col",
|
||||
[icon("nat_a", "nat_gateway", "NAT")],
|
||||
"Public Subnet",
|
||||
"group_subnet",
|
||||
),
|
||||
group(
|
||||
"app_a",
|
||||
"col",
|
||||
[icon("ec2_a", "ec2", "EC2")],
|
||||
"Private Subnet",
|
||||
"group_subnet",
|
||||
),
|
||||
],
|
||||
"AZ-a",
|
||||
"group_availability_zone",
|
||||
),
|
||||
],
|
||||
"VPC",
|
||||
"group_vpc",
|
||||
),
|
||||
],
|
||||
"Region",
|
||||
"group_region",
|
||||
),
|
||||
])
|
||||
expect(signature(roundTrip(t).tree)).toBe(signature(t))
|
||||
})
|
||||
|
||||
it("recovers several roots in order", () => {
|
||||
const t = tree([
|
||||
box("users", "Users"),
|
||||
group("cloud", "row", [icon("a")], "Cloud"),
|
||||
box("consumers", "Consumers"),
|
||||
])
|
||||
const back = roundTrip(t).tree
|
||||
expect(back.roots.map((r) => r.id)).toEqual([
|
||||
"users",
|
||||
"cloud",
|
||||
"consumers",
|
||||
])
|
||||
})
|
||||
|
||||
it("recovers the direction of an UNLABELLED wrapper — the phantom problem, fixed", () => {
|
||||
// The reference project would use a phantom here, which emits no cell: its two
|
||||
// children would be reparented onto vpc, and the wrapper's "row" direction would
|
||||
// be gone from the XML for good. We emit a real but invisible cell instead.
|
||||
const t = tree([
|
||||
group(
|
||||
"vpc",
|
||||
"col",
|
||||
[
|
||||
icon("igw", "internet_gateway", "IGW"),
|
||||
group(
|
||||
"azs",
|
||||
"row",
|
||||
[
|
||||
group("az_a", "col", [icon("ec2_a")], "AZ-a"),
|
||||
group("az_b", "col", [icon("ec2_b")], "AZ-b"),
|
||||
],
|
||||
"", // no label — a layout-only wrapper
|
||||
),
|
||||
],
|
||||
"VPC",
|
||||
"group_vpc",
|
||||
),
|
||||
])
|
||||
const back = roundTrip(t).tree
|
||||
// the wrapper is still there, still a row, still holding both AZs
|
||||
const azs = findNode(back, "azs")
|
||||
expect(azs).not.toBeNull()
|
||||
expect((azs as GroupNode).dir).toBe("row")
|
||||
expect(findParent(back, "az_a")?.id).toBe("azs")
|
||||
expect(findParent(back, "azs")?.id).toBe("vpc")
|
||||
// and vpc kept its own direction instead of collapsing into a grid
|
||||
expect((findNode(back, "vpc") as GroupNode).dir).toBe("col")
|
||||
expect(signature(back)).toBe(signature(t))
|
||||
})
|
||||
|
||||
it("keeps the wrapper invisible", () => {
|
||||
const t = tree([
|
||||
group("w", "row", [icon("a"), icon("b")], ""), // unlabelled → invisible
|
||||
])
|
||||
const { xml } = renderDiagram(t)
|
||||
const cell = xml.match(/<mxCell id="w"[^>]*style="([^"]*)"/)?.[1] ?? ""
|
||||
expect(cell).toContain("fillColor=none")
|
||||
expect(cell).toContain("strokeColor=none")
|
||||
// ...but it is still a real container, so draw.io reparents into it
|
||||
expect(cell).toContain("container=1")
|
||||
})
|
||||
|
||||
it("keeps a labelled frame visible", () => {
|
||||
const t = tree([group("f", "row", [icon("a")], "Visible")])
|
||||
const { xml } = renderDiagram(t)
|
||||
const style = xml.match(/<mxCell id="f"[^>]*style="([^"]*)"/)?.[1] ?? ""
|
||||
expect(style).not.toContain("strokeColor=none")
|
||||
})
|
||||
|
||||
it("survives repeated round-trips without drift", () => {
|
||||
const t = tree([
|
||||
group(
|
||||
"outer",
|
||||
"row",
|
||||
[
|
||||
group("a", "col", [icon("x"), icon("y")], "A"),
|
||||
grid("g", 2, [icon("p"), icon("q"), icon("r")], "G"),
|
||||
],
|
||||
"Outer",
|
||||
),
|
||||
])
|
||||
const once = roundTrip(t).tree
|
||||
const twice = roundTrip(once).tree
|
||||
const thrice = roundTrip(twice).tree
|
||||
expect(signature(twice)).toBe(signature(once))
|
||||
expect(signature(thrice)).toBe(signature(once))
|
||||
})
|
||||
|
||||
it("keeps geometry stable across repeated round-trips", () => {
|
||||
const t = tree([group("f", "row", [icon("a"), icon("b")], "F")])
|
||||
const first = renderDiagram(t)
|
||||
const second = renderDiagram(parseDiagram(first.xml).tree)
|
||||
expect(second.page).toEqual(first.page)
|
||||
})
|
||||
})
|
||||
|
||||
describe("labels and content survive", () => {
|
||||
it("recovers labels on containers and leaves", () => {
|
||||
const t = tree([
|
||||
group(
|
||||
"f",
|
||||
"row",
|
||||
[icon("a", "s3", "My Bucket"), box("b", "A Box")],
|
||||
"My Frame",
|
||||
),
|
||||
])
|
||||
const back = roundTrip(t).tree
|
||||
expect((findNode(back, "f") as ContainerNode).label).toBe("My Frame")
|
||||
expect((findNode(back, "a") as IconNode).label).toBe("My Bucket")
|
||||
expect((findNode(back, "b") as BoxNode).label).toBe("A Box")
|
||||
})
|
||||
|
||||
it("recovers a label containing XML metacharacters", () => {
|
||||
const nasty = "A & B <tag> \"quoted\" 'apostrophe'"
|
||||
const t = tree([group("f", "row", [box("b", nasty)], nasty)])
|
||||
const back = roundTrip(t).tree
|
||||
expect((findNode(back, "b") as BoxNode).label).toBe(nasty)
|
||||
expect((findNode(back, "f") as ContainerNode).label).toBe(nasty)
|
||||
})
|
||||
|
||||
it("recovers the page title", () => {
|
||||
const t = tree([group("f", "row", [icon("a")], "F")], {
|
||||
title: "My Architecture",
|
||||
})
|
||||
expect(roundTrip(t).tree.title).toBe("My Architecture")
|
||||
})
|
||||
|
||||
it("recovers a gap that is not the default", () => {
|
||||
const t = tree([
|
||||
group("f", "row", [icon("a"), icon("b")], "F", null, 47),
|
||||
])
|
||||
expect((findNode(roundTrip(t).tree, "f") as GroupNode).gap).toBe(47)
|
||||
})
|
||||
|
||||
it("recovers an icon's catalog name", () => {
|
||||
const t = tree([
|
||||
group(
|
||||
"f",
|
||||
"row",
|
||||
[icon("a", "nat_gateway"), icon("b", "rds")],
|
||||
"F",
|
||||
),
|
||||
])
|
||||
const back = roundTrip(t).tree
|
||||
expect((findNode(back, "a") as IconNode).name).toBe("nat_gateway")
|
||||
expect((findNode(back, "b") as IconNode).name).toBe("rds")
|
||||
})
|
||||
|
||||
it("recovers a group stencil name", () => {
|
||||
const t = tree([group("v", "col", [icon("a")], "VPC", "group_vpc")])
|
||||
const { xml } = renderDiagram(t, {
|
||||
resolveStyle: (name, kind) =>
|
||||
kind === "group"
|
||||
? `shape=mxgraph.aws4.group;grIcon=mxgraph.aws4.${name};fillColor=none;strokeColor=#8C4FFF;verticalAlign=top;align=left;`
|
||||
: null,
|
||||
})
|
||||
expect(
|
||||
(findNode(parseDiagram(xml).tree, "v") as ContainerNode).gname,
|
||||
).toBe("group_vpc")
|
||||
})
|
||||
})
|
||||
|
||||
describe("edges survive", () => {
|
||||
it("recovers source, target and label", () => {
|
||||
const t = tree([group("f", "row", [icon("a"), icon("b")], "F")], {
|
||||
links: [{ source: "a", target: "b", label: "flows to" }],
|
||||
})
|
||||
const back = roundTrip(t).tree
|
||||
expect(back.links).toHaveLength(1)
|
||||
expect(back.links[0].source).toBe("a")
|
||||
expect(back.links[0].target).toBe("b")
|
||||
expect(back.links[0].label).toBe("flows to")
|
||||
})
|
||||
|
||||
it("recovers a step number and keeps it out of the label", () => {
|
||||
const t = tree([group("f", "row", [icon("a"), icon("b")], "F")], {
|
||||
links: [{ source: "a", target: "b", label: "HTTPS", step: 1 }],
|
||||
})
|
||||
const back = roundTrip(t).tree
|
||||
expect(back.links[0].step).toBe(1)
|
||||
expect(back.links[0].label).toBe("HTTPS")
|
||||
})
|
||||
|
||||
it("recovers a dashed edge", () => {
|
||||
const t = tree([group("f", "row", [icon("a"), icon("b")], "F")], {
|
||||
links: [{ source: "a", target: "b", dashed: true }],
|
||||
})
|
||||
expect(roundTrip(t).tree.links[0].dashed).toBe(true)
|
||||
})
|
||||
|
||||
it("drops an edge with a missing endpoint and reports it", () => {
|
||||
const t = tree([group("f", "row", [icon("a")], "F")], {
|
||||
links: [{ source: "a", target: "ghost" }],
|
||||
})
|
||||
const r = renderDiagram(t)
|
||||
expect(r.danglingLinks).toEqual(["ghost"])
|
||||
expect(r.xml).not.toContain('target="ghost"')
|
||||
})
|
||||
|
||||
it("emits no waypoints, so draw.io re-routes when the user moves a node", () => {
|
||||
const t = tree([group("f", "row", [icon("a"), icon("b")], "F")], {
|
||||
links: [{ source: "a", target: "b", label: "x" }],
|
||||
})
|
||||
expect(renderDiagram(t).xml).not.toContain('as="points"')
|
||||
})
|
||||
})
|
||||
|
||||
describe("foreign cells survive", () => {
|
||||
it("re-emits an unrecognised cell verbatim", () => {
|
||||
const custom =
|
||||
'<mxCell id="note" value="hand-written note" style="shape=note;whiteSpace=wrap;html=1;fillColor=#FFF2CC;" vertex="1" parent="1"><mxGeometry x="900" y="40" width="160" height="80" as="geometry"/></mxCell>'
|
||||
const t = tree([group("f", "row", [icon("a")], "F")], {
|
||||
foreign: [{ id: "note", xml: custom, parent: "1" }],
|
||||
})
|
||||
expect(renderDiagram(t).xml).toContain(custom)
|
||||
})
|
||||
|
||||
it("re-creates the boundaries layer when a foreign cell needs it", () => {
|
||||
const t = tree([group("f", "row", [icon("a")], "F")], {
|
||||
foreign: [
|
||||
{
|
||||
id: "cluster",
|
||||
xml: '<mxCell id="cluster" value="EKS" style="dashed=1;fillColor=none;" vertex="1" parent="boundaries"><mxGeometry x="0" y="0" width="100" height="50" as="geometry"/></mxCell>',
|
||||
parent: "boundaries",
|
||||
},
|
||||
],
|
||||
})
|
||||
const { xml } = renderDiagram(t)
|
||||
expect(xml).toContain('<mxCell id="boundaries"')
|
||||
expect(xml.indexOf('id="boundaries"')).toBeLessThan(
|
||||
xml.indexOf('parent="boundaries"'),
|
||||
)
|
||||
})
|
||||
|
||||
it("lets an edge anchor to a foreign cell", () => {
|
||||
const t = tree([group("f", "row", [icon("a")], "F")], {
|
||||
foreign: [
|
||||
{
|
||||
id: "legend",
|
||||
xml: '<mxCell id="legend" value="L" style="rounded=0;" vertex="1" parent="1"><mxGeometry x="0" y="0" width="50" height="50" as="geometry"/></mxCell>',
|
||||
parent: "1",
|
||||
},
|
||||
],
|
||||
links: [{ source: "a", target: "legend" }],
|
||||
})
|
||||
const r = renderDiagram(t)
|
||||
expect(r.danglingLinks).toEqual([])
|
||||
expect(r.xml).toContain('target="legend"')
|
||||
})
|
||||
})
|
||||
|
||||
describe("the emitted XML is well formed for draw.io", () => {
|
||||
const t = tree(
|
||||
[
|
||||
group(
|
||||
"region",
|
||||
"row",
|
||||
[
|
||||
group(
|
||||
"vpc",
|
||||
"col",
|
||||
[icon("a"), icon("b")],
|
||||
"VPC",
|
||||
"group_vpc",
|
||||
),
|
||||
],
|
||||
"Region",
|
||||
"group_region",
|
||||
),
|
||||
],
|
||||
{ title: "T", links: [{ source: "a", target: "b" }] },
|
||||
)
|
||||
const { xml } = renderDiagram(t)
|
||||
|
||||
it("wraps the model in mxfile/diagram", () => {
|
||||
expect(xml.startsWith("<mxfile")).toBe(true)
|
||||
expect(xml).toContain("<diagram")
|
||||
expect(xml).toContain("<mxGraphModel")
|
||||
})
|
||||
|
||||
it("includes the two root cells draw.io requires", () => {
|
||||
expect(xml).toContain('<mxCell id="0"/>')
|
||||
expect(xml).toContain('<mxCell id="1" parent="0"/>')
|
||||
})
|
||||
|
||||
it("declares a parent before any cell that references it", () => {
|
||||
expect(xml.indexOf('id="region"')).toBeLessThan(
|
||||
xml.indexOf('parent="region"'),
|
||||
)
|
||||
expect(xml.indexOf('id="vpc"')).toBeLessThan(
|
||||
xml.indexOf('parent="vpc"'),
|
||||
)
|
||||
})
|
||||
|
||||
it("gives every cell a unique id", () => {
|
||||
const ids = [...xml.matchAll(/<mxCell id="([^"]+)"/g)].map((m) => m[1])
|
||||
expect(new Set(ids).size).toBe(ids.length)
|
||||
})
|
||||
|
||||
it("sets the page size from the content", () => {
|
||||
const w = Number(xml.match(/pageWidth="(\d+)"/)?.[1])
|
||||
const h = Number(xml.match(/pageHeight="(\d+)"/)?.[1])
|
||||
expect(w).toBeGreaterThan(0)
|
||||
expect(h).toBeGreaterThan(0)
|
||||
})
|
||||
|
||||
it("writes nested geometry relative to the parent, as draw.io expects", () => {
|
||||
// vpc sits inside region, so its x must be small — an absolute x would push it
|
||||
// outside the frame when draw.io adds the parent offset.
|
||||
const vpcGeo = xml.match(
|
||||
/<mxCell id="vpc"[^>]*>\s*<mxGeometry x="(-?\d+)"/,
|
||||
)?.[1]
|
||||
expect(Number(vpcGeo)).toBeLessThan(100)
|
||||
})
|
||||
|
||||
it("stamps container=1 on containers so drag-and-drop reparents correctly", () => {
|
||||
// Verified in-browser: without this, a shape dragged into the frame keeps
|
||||
// parent="1" and the nesting is lost.
|
||||
const regionStyle =
|
||||
xml.match(/<mxCell id="region"[^>]*style="([^"]*)"/)?.[1] ?? ""
|
||||
expect(regionStyle).toContain("container=1")
|
||||
})
|
||||
|
||||
it("does not stamp container=1 on a leaf", () => {
|
||||
const iconStyle =
|
||||
xml.match(/<mxCell id="a"[^>]*style="([^"]*)"/)?.[1] ?? ""
|
||||
expect(iconStyle).not.toContain("container=1")
|
||||
})
|
||||
})
|
||||
|
||||
describe("user edits are inputs, not conflicts", () => {
|
||||
it("keeps a hand-changed fill through a re-layout", () => {
|
||||
// The user recoloured a box in draw.io. Re-deriving the tree picks up the style
|
||||
// verbatim, so re-rendering preserves the colour rather than resetting it.
|
||||
const t = tree([group("f", "row", [icon("a"), box("b", "Box")], "F")])
|
||||
const first = renderDiagram(t).xml
|
||||
const edited = first.replace(
|
||||
/(<mxCell id="b"[^>]*style=")([^"]*)"/,
|
||||
'$1$2fillColor=#FF0000;"',
|
||||
)
|
||||
const back = parseDiagram(edited).tree
|
||||
expect(renderDiagram(back).xml).toContain("fillColor=#FF0000")
|
||||
})
|
||||
|
||||
it("re-lays-out around a node the user dragged into a different frame", () => {
|
||||
// Two frames; the user moves icon "b" from f1 into f2. draw.io rewrites the
|
||||
// parent attribute (container=1 is in place), so the next layout puts it inside
|
||||
// f2 — no reconciliation step, the canvas simply says where things are.
|
||||
const t = tree([
|
||||
group(
|
||||
"root",
|
||||
"row",
|
||||
[
|
||||
group("f1", "col", [icon("a"), icon("b")], "F1"),
|
||||
group("f2", "col", [icon("c")], "F2"),
|
||||
],
|
||||
"Root",
|
||||
),
|
||||
])
|
||||
const first = renderDiagram(t).xml
|
||||
const moved = first.replace(
|
||||
/(<mxCell id="b"[^>]*)parent="f1"/,
|
||||
'$1parent="f2"',
|
||||
)
|
||||
const back = parseDiagram(moved).tree
|
||||
expect(findParent(back, "b")?.id).toBe("f2")
|
||||
// and the re-render keeps it there, sized to fit
|
||||
const again = parseDiagram(renderDiagram(back).xml).tree
|
||||
expect(findParent(again, "b")?.id).toBe("f2")
|
||||
})
|
||||
|
||||
it("honours a pin the user added by hand in Edit Style", () => {
|
||||
const t = tree([box("pin", "Pinned"), box("flow", "Flow")])
|
||||
const first = renderDiagram(t).xml
|
||||
const pinned = first.replace(
|
||||
/(<mxCell id="pin"[^>]*style="[^"]*)"/,
|
||||
'$1dai_pin=1;"',
|
||||
)
|
||||
const back = parseDiagram(pinned).tree
|
||||
const node = findNode(back, "pin") as BoxNode
|
||||
expect(node.pinned).toBe(true)
|
||||
const pos = node.rect
|
||||
// re-rendering leaves the pinned node exactly where it was
|
||||
const again = parseDiagram(renderDiagram(back).xml).tree
|
||||
expect((findNode(again, "pin") as BoxNode).rect).toEqual(pos)
|
||||
})
|
||||
|
||||
it("does not lose a cell the user added by hand", () => {
|
||||
const t = tree([group("f", "row", [icon("a")], "F")])
|
||||
const first = renderDiagram(t).xml
|
||||
// user drops a new shape on the canvas
|
||||
const withNew = first.replace(
|
||||
"</root>",
|
||||
'<mxCell id="userbox" value="Mine" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1"><mxGeometry x="800" y="400" width="120" height="60" as="geometry"/></mxCell></root>',
|
||||
)
|
||||
const back = parseDiagram(withNew).tree
|
||||
const ids = [...walkTree(back)].map((n) => n.id)
|
||||
expect(ids).toContain("userbox")
|
||||
expect(renderDiagram(back).xml).toContain('id="userbox"')
|
||||
})
|
||||
})
|
||||
Reference in New Issue
Block a user