mirror of
https://github.com/DayuanJiang/next-ai-draw-io.git
synced 2026-10-12 20:49:53 +08:00
* refactor(canvas): decouple the canvas from the chat engine
The canvas components will be reused by the MCP server's browser shell,
which has no chat and no Next.js. They now read everything they need
from small contexts and the canvas store instead of the chat engine:
- components/canvas/versions-context.tsx: VersionsProvider and
useVersionsContext give the version cards, the strip and the compare
dialog a VersionsSource (versions, onCanvasId, undoneId, isBusy,
canUndo, canRedo, restore, undo, redo). The chat fills it from the
versions store and the engine in components/chat/chat-versions.tsx.
- stores/canvas-store.ts: isBusy and busyReason; the chat engine sets
them while a turn runs, SelectionAsk and the version UI read them.
- components/canvas/version-card.tsx: the visual version card and the
thumbnail, out of tool-activity.tsx; the chat's card composes it and
adds its "Show XML" link and code panel.
- compare-dialog.tsx and version-strip.tsx move to components/canvas;
the strip takes the minimum number of versions to show as a prop, the
chat panel computes it from the cards it has.
- components/canvas/locale-context.tsx: LocaleProvider and useLocale,
fed by the [lang] layout; CanvasStage no longer uses next/navigation.
The overlay (SelectionAsk) is a slot and the wait for the saved
language is a prop, so the shell can leave both out.
- lib/version-text.ts: describeChanges is now describeChangeSummary, so
it can be imported next to the MCP core's describeChanges.
* test(unit): canvas import boundary and the shared version card
The boundary test scans the canvas modules' imports and bundles the canvas components with esbuild; both fail on anything from components/chat, the tool handlers, next/navigation, next/font, next/script, next/headers or a server-only module. The card test renders VersionCard and VersionStrip on a fake VersionsSource.
* refactor(scripts): pin the draw.io release in one json file and share the zip reader
* feat(mcp-server): bundle a trimmed draw.io into dist/drawio at build time
scripts/fetch-drawio.mjs downloads the pinned draw.war into a cache
(DRAWIO_WAR_CACHE, or DRAWIO_WAR for a local file), checks its SHA-256
and extracts the files named in drawio-files.txt plus a LICENSE with the
Apache-2.0 text. scripts/check-drawio-files.mjs drives the embedded
editor in headless Chromium from a full copy, records every requested
file and checks or rewrites (--update) the list.
* feat(mcp-server): serve the bundled draw.io same-origin behind an api token
GET /drawio/<path> serves dist/drawio with a MIME table, a day of
caching and nosniff; paths are normalized and never reach WEB-INF or
META-INF. The preview embeds /drawio/index.html when the copy exists and
DRAWIO_BASE_URL is unset, else the external draw.io as before (and
start_session says so). Every /api request must carry the per-process
X-Drawio-Token the page gets in its HTML; pages send
frame-ancestors 'self' and nosniff.
* build(mcp-server): require the bundled draw.io in the package and cap the tarball at 40 MB
* fix(mcp-server): review fixes for the preview token and the draw.io static files
- The preview page fetches a fresh copy of itself and retries once when an
API request is refused with 403: another MCP process, with its own token,
now answers on this port, and the recovery logic (recoverState) needs its
polls to go through. The page is sent with Cache-Control: no-store.
- draw.io files are served with an ETag and Cache-Control: no-cache instead
of a 24 hour max-age: their names do not change between versions, so a
package upgrade must reach the browser on the next preview. HEAD and
If-None-Match (304) are answered.
- The file read stream goes through stream.pipeline, so a read error no
longer ends the MCP process and a client that leaves mid-download no
longer leaks the file handle.
* fix(mcp-server): review fixes for the draw.io file list and its guard
- The list now ships the templates of Insert > Template, the PlantUML
parser of Insert > Advanced and the template dialog's icon: the menu
items were shown but failed with 404s. 15.1 MB packed; the tarball cap
goes from 40 MB to 20 MB, where it still catches a list that grew by a
whole js/ directory.
- The guard drives both features, fails when the copy it runs against
lacks files the editor asked for or when an export does not answer,
checks that the copy is the pinned draw.io version, and runs in CI
(npm run check-drawio, one E2E shard) so a list regression cannot reach
a release.
* docs: review fixes for the draw.io version pointer and the preview's embedding
- The offline deployment guides point at packages/mcp-server/src/
drawio-version.json for the draw.war version; scripts/fetch-drawio.mjs
no longer names it.
- The MCP README says what the bundled draw.io copy includes, and that the
preview page cannot be shown inside an editor's built-in browser since it
is served with frame-ancestors 'self'.
* refactor(canvas): review fixes for the busy flag, the comparison note and the bundle size check
- busyReason had no reader: the chat engine sets isBusy through the store's
generic set, like every other flag.
- The isSameDocument comment says the two "same document" rules disagree
in both directions, so neither is a subset of the other.
- The import boundary test bundles minified with one pako (the MCP core
resolves its own copy) and caps the canvas core at 160 KB (134 KB now).
* fix(mcp-server): name exports at random and stamp the draw.io version into ETags
- Export requests carried a per-process counter. The preview page retries a
result refused with 403 against the process that took over the port, so a
late result of the old process's export could be taken for the new
process's export with the same number. The id is a random UUID now.
- The ETag of a bundled draw.io file now starts with the version the fetch
script stamps into dist/drawio/.version. An install that keeps the
archive's dates (npm does not) would otherwise answer 304 for a changed
file of the same size after an upgrade.
* docs(mcp-server): mermaid is in the bundled draw.io, which has no image proxy
- Mermaid's converter is in js/extensions.min.js, which the editor loads at
startup, so the README no longer lists it as left out; the org chart
layout (js/orgchart.min.js) is the example of a feature that is.
- Note that the bundled copy, like the web app's, has no /drawio/proxy:
images from other websites, including those in some templates, are left
out of exports and thumbnails. The guard's comment names this as a known
limitation it does not cover.
* refactor(canvas): getDrawioSrc takes the editor's source, and CanvasStage can be given one
* feat(mcp-server): canvas shell bundled from the web app's canvas with esbuild
The shell (packages/mcp-server/shell) renders DrawioFrame inside the
shared providers without the chat: its config comes from
window.__MCP_CONFIG__, the four dictionaries ship in the bundle, the
theme is kept under an mcp: localStorage key, and system fonts stand in
for the web fonts. scripts/build-shell.mjs bundles it into dist/shell
with the root's esbuild and Tailwind; check-package caps shell.js at
1.5 MB and shell.css at 300 KB.
* feat(mcp-server): serve the canvas shell at /shell/ behind DRAWIO_PREVIEW_UI
GET /shell/ fills the page template's {{CONFIG_JSON}} with the session,
the API token, where draw.io comes from and the host's editor settings,
with the classic page's security headers; /shell/<file> serves the built
files like the draw.io copy. start_session opens the shell when
DRAWIO_PREVIEW_UI=shell; the classic page stays the default.
* test(mcp-server): open the built shell with playwright
npm run test:e2e starts dist/index.js over the MCP SDK with
DRAWIO_PREVIEW_UI=shell, opens the URL start_session returns in headless
Chromium, and checks that the bundled draw.io loads without console
errors and that the theme toggle switches draw.io in place.
* ci: install the root dependencies before building the mcp package
The shell build needs the root's esbuild, Tailwind and React.
* feat(canvas): DiagramProvider exports with options and shows a transient document
requestExport(request, timeoutMs) runs one draw.io export with the
request's own parameters (a PNG's pageId and width) and resolves with its
answer (data, or xml for format "xml"); null when draw.io does not answer.
showTransient(xml) puts a document on the canvas for an export only: it is
not recorded, its autosaves are ignored, and the next loadDiagram brings
the user back to the page they were on. The MCP's canvas shell answers the
server's export requests with both.
* feat(mcp-server): the shell syncs with the server like the classic page
shell/mcp-sync-core.ts ports preview.js's protocol without the page or
React: polling GET /api/state every 2 s with the state id and version,
pushes of the user's edits with their base version and state, 409 and 413
handling, recovery of a recreated session (the tab's copy goes to History),
the token refresh after a 403, sync and export requests (PNG by page id,
SVG of another page through a transient one-page projection with autosave
ignored, the 600 ms wait for icons), thumbnails for History, and History
reads and restores that name the state the list belongs to.
A server write goes on the canvas as one undo step (loadDiagram commit,
with the change marked) when decideLoad finds it changes only the page on
screen, keeps the file variables and needs no load-only setting; the other
pages are compared with the MCP core's contentFingerprint. draw.io's own
re-serialized copy of such a write is recognized with isSameDocument and
not pushed back as an edit.
shell/use-mcp-sync.ts mounts the sync once inside DiagramProvider, reads
draw.io's autosave and load messages, and reports the connection state,
which the shell's status bar shows; notices come as toasts from the
dictionaries.
* test(mcp-server): port the preview protocol tests to the sync core
The recovery, thumbnail, size limit and History cases of
tests/unit/mcp-preview-recovery.test.ts, driven against mcp-sync-core.ts
with a stubbed server and canvas, plus the stale 409 recovery, an export
request answered once, a projection that ignores edits and restores the
document, the thumbnail of a write loaded before draw.io was ready, writes
taken in place as commits (draw.io's own copy is not pushed), and the
commit-or-load decision table of decideLoad.
* test(mcp-server): e2e of the shell's sync with the server
The shell connects, shows what create_new_diagram draws, marks an
edit_diagram change and takes it back with one Ctrl+Z (which get_diagram
then reflects), pushes a shape inserted in the editor, serves
screenshot_diagram, and shows another page only for its SVG export before
the user's page comes back.
* fix(mcp-server): review fixes for the shell's sync core
A recovery loads the server's diagram in full and waits for draw.io's
load report, as the classic page does: whether the canvas takes a write
in place is decided inside DiagramProvider, and an autosave of the
canvas being replaced went to the server as an edit when the decision
was wrong. A paper size change alone is pushed again: autosaves are
compared as documents only for draw.io's own copy of a committed write.
A projection stays on screen until draw.io reports the restore load
(5 s at most), the whole export ends in 15 s even when its result POST
hangs, and an export in flight is dropped when draw.io starts over. A
refused poll shows the tab offline. With several pages and the page on
screen unknown, a write loads in full. hasLoadOnlySettings and the
highlight of an AI change are shared with the editor bridge.
* fix(mcp-server): review fixes for the preview URL and the theme menu
The stalled-tab note names the page start_session opened (the shell
with DRAWIO_PREVIEW_UI=shell) instead of the classic page. With the
shell not built, start_session opens the classic page and the server
says so at startup, as it does for a missing dist/drawio. BROWSER=none
skips the system browser, as Vite and CRA dev servers do: the e2e tests
set it. Without a fixed DRAWIO_UI, the shell's draw.io URL carries
themes=1 so Extras > Theme is offered, as on the classic page.
* fix(mcp-server): review fixes for the shell's build
tsc -p shell checked nothing: the inherited exclude dropped every shell
file; the shell's tsconfig now excludes node_modules only. Tailwind scans
app-toaster.tsx too, so the sync notices look like the web app's toasts.
The bundle keeps its dependencies' license comments (esbuild appends them
at the end). postcss, which build-shell.mjs loads from the root, is a
declared devDependency.
* ci: run the shell's browser tests on the packed tarball, publish on shared code changes
The e2e job's first shard builds the MCP package, packs it, installs the
tarball in an empty directory and runs packages/mcp-server/tests/e2e
against the installed dist/index.js (MCP_SERVER_ENTRY), so a shell that
builds but fails in the browser, or a tarball missing a runtime
dependency, fails the PR. Its traces go with the Playwright report. The
publish workflow also triggers on the web app code the shell is bundled
from (components, contexts, hooks, lib, stores, globals.css) and the
root lockfile.
* fix(canvas): ignore autosaves of the document a pending full load replaces
An autosave that arrives after loadDiagram sent a full load, and before draw.io reports it, is of the canvas being replaced (draw.io reports each load, in order). Until now it overwrote chartXMLRef: in the MCP shell, a late autosave of a one-page projection replaced the cached document, and a remount of an external draw.io then put the projection on the canvas as the whole document.
* fix(mcp-server): review fixes for the shell's commits and export timeout
A write taken in place that leaves the canvas as it is gets no autosave from draw.io, so the marker for its copy stayed armed and ate the user's next paper-size edit: arm it only when the write changed the document. The 15 s export timeout now retires the export's sequence number, so a result POST that answers late no longer restores the document a second time.
* ci: create the tarball directory before npm pack
npm pack does not create its --pack-destination; on a fresh runner the step failed with ENOENT before the packed shell tests ran.
* feat(mcp-server): history entries name their maker, and /api/history the entry on the canvas
Each History entry records who made it (a user edit, a recovering tab's
copy, a restored copy; none for the AI's writes), when, and its page
count. GET /api/history now also returns each entry's XML, the first entry
with the same content (a restore adds a copy of an older one), the state
the ids belong to, and the entry whose content the canvas shows, by the
rule restore_version uses. The shell's version cards read these; the
classic page keeps using index, id and svg.
* feat(mcp-server): version cards in the shell from the server's History
The shell's VersionsSource (shell/node-versions-source.ts) reads GET
/api/history through the sync and shows one version per distinct content
(a restore's copy folds into the entry it copies; the blank page is none),
numbered as they first appeared, with what changed since the one before.
The entry the server says is on the canvas marks the version; undo and
redo of the newest version restore the one before it, or it again, through
POST /api/restore, so hand edits stay as versions of their own. The cards
sit in a panel beside the canvas (toggle in the header); the strip and
Compare come from the shared canvas components. The sync tells listeners
once per server version, and when History changed without one, so the
list is read again only then.
* test(mcp-server): e2e of the shell's version cards
In a session of its own: three writes give three cards; undoing the newest
restores the one before on the server too, redo brings it back, a hand edit
turns the undo into a restore, and restoring the first version keeps that
edit as a version of its own, which restore_version also finds.
* feat(mcp-server): get_selection reads the cells the user selected in the shell
The server asks the preview tab for the selection the way it asks for an export (a random request id in GET /api/state, the answer in a POST with that id, 10 s to answer). The shell answers through the editor bridge with each cell's id, label, an edge's ends, a shape's geometry and the page on screen; without a same-origin editor it says so, and the tool names the external draw.io. The classic page cannot answer, so the tool says that at once. screenshot_diagram's description now says a page selector renders that page without changing the page on screen (PNG exports by pageId already did).
* test(mcp-server): selection requests, get_selection texts, and page screenshots that leave the view alone
Unit tests for the request plumbing (random id, one answer, timeout), the tool's texts (cells, nothing selected, external draw.io) and the shell's side (one answer per request, after draw.io is up, never during a projection); the wiring test starts a session with BROWSER=none to see the no-tab message. Shell e2e: cells selected in the editor reach get_selection; a PNG of another page differs from the page on screen, which stays.
* feat(mcp-server): the canvas shell is the default preview, the classic page behind DRAWIO_PREVIEW_UI=classic
* docs: the MCP preview is the web app's canvas; get_selection, DRAWIO_BASE_URL and the classic page
* chore(mcp-server): version 0.4.0; check-package requires the draw.io version stamp
* ci: an mcp-shell job builds the package, runs its tests, the draw.io file guard and the shell e2e
* fix(mcp-server): review fixes for the version cards and History
The shell's version cards (shell/node-versions-source.ts):
- a version's change and undo target are the state it replaced, the
History entry right before its first copy, not the card before it: after
a restore those differ, and undo went to the wrong version (and not
where restore_version steps_back=1 goes)
- a card restores the newest copy of its content, as restore_version
does, so page settings the user changed (a "user" copy) are kept
- a blank page after a drawing is a clear of the canvas, a version of its
own; only the blank page before any drawing is hidden
- numbers and changes are keyed by content, not by the first copy's id,
so a version keeps them when its first copy drops out of the server's
20-entry buffer; the caches start over for another server state (the
process restarted: entry ids name other content)
The server's History (src/history.ts):
- firstCopyIds compares each entry with the first of every group only: a
bare model matches any page name, so "same content" is not transitive,
and a card could show one document and restore another
- the time and pages fields had no reader; pages parsed every XML once
more on every write
Reading History (src/http-server.ts, shell/mcp-sync-core.ts):
- GET /api/state and a push's answer carry a History key (entry count,
newest id, the entry on the canvas); the shell reads History again only
when it changes, so a hand edit no longer downloads every entry's XML and
thumbnail
- a failed History read is told again at the next poll
- a History list from a state the poll has not seen yet is dropped
* fix(mcp-server): review fixes for get_selection
Server (src/http-server.ts, src/index.ts, src/selection.ts,
src/new-diagram.ts):
- overlapping get_selection calls take turns (readSelection, one slot per
session as the export slot) instead of replacing each other's request,
which left one of them with a false "tab not in front" timeout
- an answer is taken only while a request is pending (both ids undefined
compared equal)
- the tool sees the page start_session actually opens: with dist/shell
missing the classic page is in use, which never answers, so the tool
says so instead of timing out
- the result lists at most 100 cells and counts the rest: a whole large
diagram selected would fill the model's context
- every <diagram> the model sends without an id gets one, so the page id
the shell reports exists in the server's document
Shell (shell/mcp-sync-core.ts, shell/use-mcp-sync.ts,
contexts/diagram-context.tsx, lib/drawio/editor-bridge.ts):
- an answer whose POST failed is sent again at the next poll
- no answer while a full load has yet to reach the editor: it still shows
the previous document, whose cells and pages the answer would name
- a hidden tab (the same session open twice) answers a poll later, so the
tab in front answers first; alone, it still answers within the timeout
- a cell's container is reported by the model's isLayer, not by comparing
with the default parent, which is the group the user entered
* fix(mcp-server): review fixes for the shell page
- a download button in the header opens the web app's export dialog
(.drawio, .png, .svg, .drawio.svg), which the classic page had and the
shell lacked when it became the default
- the shell asks draw.io for the custom library menu (libraries=1), as
the classic page did; the web app keeps libraries=0
- the newest card no longer shows "Rendering preview" for good: the sync
takes the thumbnail of a diagram the server recovered from its file
(saved without pictures) while the canvas kept it, and of a write whose
picture was skipped because an edit came first, once the canvas shows
the write again
- e2e: the get_selection test covers a shape in a container the user
entered; a download test saves a .drawio file
* ci: the version bump reminder watches every path publish-mcp.yml does, and compares the version field
The reminder step left out the root lockfile and scripts/, which change
what is bundled into the shell and trigger the publish workflow; and it
took any change of packages/mcp-server/package.json (a dependency bump)
for a version bump. It now compares the version field between the two
commits.
* fix(mcp-server): get_selection lists every selected id, with detail for the first 100
* fix(mcp-server): a hidden tab's delayed selection answer checks the canvas again first
* fix(mcp-server): the version cards keep only the current History in memory, picture the newest copy, and keep a clear the buffer scrolled to
* fix(mcp-server): save who made each History entry with it, so the cards look the same after a restart
* fix(mcp-server): the download waits for a page export's projection to end, and the dialog's styles are bundled
* fix(mcp-server): bundle open.html and js/open.js, the picker of Open Library from > Browser
* fix(mcp-server): the shell shows the versions once, in the side panel
* test(mcp-server): get_selection wiring test expects the classic page's answer when the shell is not built
534 lines
18 KiB
JavaScript
534 lines
18 KiB
JavaScript
#!/usr/bin/env node
|
|
import {
|
|
existsSync,
|
|
readdirSync,
|
|
readFileSync,
|
|
statSync,
|
|
writeFileSync,
|
|
} from "node:fs"
|
|
/**
|
|
* Guard for drawio-files.txt: opens the embedded editor from a FULL draw.io
|
|
* copy in headless Chromium, uses it the way the preview page does (every
|
|
* theme the user can switch to, diagrams with shapes from the icon libraries,
|
|
* the format panel, the shape sidebar, the menus, the page tabs, the export
|
|
* and edit dialogs, exports) and records every file the editor requests.
|
|
*
|
|
* node scripts/check-drawio-files.mjs [--drawio <dir>] [--update]
|
|
*
|
|
* The full copy is --drawio, else the web app's public/drawio. Without
|
|
* --update it fails when the editor requested a file the list does not
|
|
* have; with --update it rewrites the requested section of the list.
|
|
* Needs Playwright from the repository root (npm ci at the root).
|
|
*/
|
|
import http from "node:http"
|
|
import path from "node:path"
|
|
import { fileURLToPath, pathToFileURL } from "node:url"
|
|
import { readDrawioVersion } from "../../../scripts/drawio-zip.mjs"
|
|
import {
|
|
formatFileList,
|
|
parseFileList,
|
|
readFileList,
|
|
} from "./drawio-file-list.mjs"
|
|
|
|
const PKG = path.join(path.dirname(fileURLToPath(import.meta.url)), "..")
|
|
const LIST = path.join(PKG, "drawio-files.txt")
|
|
const args = process.argv.slice(2)
|
|
const update = args.includes("--update")
|
|
const drawioDir = path.resolve(
|
|
args.includes("--drawio")
|
|
? args[args.indexOf("--drawio") + 1]
|
|
: path.join(PKG, "../../public/drawio"),
|
|
)
|
|
if (!existsSync(path.join(drawioDir, "index.html"))) {
|
|
console.error(
|
|
`No draw.io copy at ${drawioDir}. Run "npm run dev" once at the repository root (it downloads one into public/drawio), or pass --drawio <dir>.`,
|
|
)
|
|
process.exit(2)
|
|
}
|
|
// The list is for the pinned release; the fetch scripts stamp the copy
|
|
const { version } = readDrawioVersion()
|
|
const stampFile = path.join(drawioDir, ".version")
|
|
const stamp = existsSync(stampFile)
|
|
? readFileSync(stampFile, "utf8").trim()
|
|
: null
|
|
if (stamp !== version) {
|
|
console.error(
|
|
`${drawioDir} is draw.io ${stamp ?? "(no .version stamp)"}; the package pins ${version}. Delete it and run "npm run dev" at the repository root again, or pass --drawio <dir>.`,
|
|
)
|
|
process.exit(2)
|
|
}
|
|
const playwrightEntry = path.join(
|
|
PKG,
|
|
"../../node_modules/playwright/index.mjs",
|
|
)
|
|
if (!existsSync(playwrightEntry)) {
|
|
console.error("Playwright is missing: run npm ci at the repository root.")
|
|
process.exit(2)
|
|
}
|
|
const { chromium } = await import(pathToFileURL(playwrightEntry).href)
|
|
|
|
// The themes a user can switch to under Extras > Theme (themes=1)
|
|
const THEMES = ["kennedy", "min", "atlas", "dark", "sketch", "simple"]
|
|
|
|
const MIME = {
|
|
".html": "text/html",
|
|
".js": "text/javascript",
|
|
".css": "text/css",
|
|
".svg": "image/svg+xml",
|
|
".png": "image/png",
|
|
".gif": "image/gif",
|
|
".json": "application/json",
|
|
".xml": "text/xml",
|
|
".txt": "text/plain",
|
|
".woff": "font/woff",
|
|
".woff2": "font/woff2",
|
|
".ttf": "font/ttf",
|
|
".ico": "image/x-icon",
|
|
}
|
|
|
|
// The page that embeds the editor, with the preview page's iframe query
|
|
const parentPage = (ui) => `<!doctype html><html><body style="margin:0">
|
|
<iframe id="f" style="width:1280px;height:860px;border:0" src="/drawio/index.html?embed=1&proto=json&configure=1&spin=1&libraries=1&noSaveBtn=1&noExitBtn=1&saveAndExit=0&themes=1&dark=0&ui=${ui}"></iframe>
|
|
<script>
|
|
const f = document.getElementById('f')
|
|
window.exports = 0
|
|
window.addEventListener('message', (e) => {
|
|
let m; try { m = JSON.parse(e.data) } catch { return }
|
|
if (m.event === 'configure') f.contentWindow.postMessage(JSON.stringify({ action: 'configure', config: {} }), '*')
|
|
if (m.event === 'init') window.ready = true
|
|
if (m.event === 'export') window.exports++
|
|
})
|
|
window.send = (msg) => f.contentWindow.postMessage(JSON.stringify(msg), '*')
|
|
</script></body></html>`
|
|
|
|
// Every path the editor asked for, in order; and the ones the full copy lacks
|
|
const requested = []
|
|
const notFound = new Set()
|
|
const server = http.createServer((req, res) => {
|
|
const url = new URL(req.url, "http://localhost")
|
|
if (url.pathname === "/") {
|
|
res.writeHead(200, { "Content-Type": "text/html" })
|
|
res.end(parentPage(url.searchParams.get("ui") || "kennedy"))
|
|
return
|
|
}
|
|
const rel = path.posix.normalize(
|
|
decodeURIComponent(url.pathname.replace(/^\/drawio\//, "")),
|
|
)
|
|
const file = path.join(drawioDir, rel)
|
|
let stat
|
|
try {
|
|
stat = statSync(file)
|
|
} catch {
|
|
notFound.add(rel)
|
|
res.writeHead(404)
|
|
res.end()
|
|
return
|
|
}
|
|
if (!requested.includes(rel)) requested.push(rel)
|
|
res.writeHead(200, {
|
|
"Content-Type": MIME[path.extname(file)] || "application/octet-stream",
|
|
"Content-Length": stat.size,
|
|
})
|
|
res.end(readFileSync(file))
|
|
})
|
|
await new Promise((r) => server.listen(0, "127.0.0.1", r))
|
|
const port = server.address().port
|
|
|
|
const mb = (n) => (n / 1048576).toFixed(2)
|
|
let seen = 0
|
|
function report(step) {
|
|
const added = requested.slice(seen)
|
|
seen = requested.length
|
|
if (added.length === 0) return
|
|
const bytes = added.reduce(
|
|
(n, f) => n + statSync(path.join(drawioDir, f)).size,
|
|
0,
|
|
)
|
|
const names =
|
|
added.slice(0, 5).join(", ") + (added.length > 5 ? ", ..." : "")
|
|
console.log(
|
|
` ${step}: +${added.length} files, +${mb(bytes)} MB [${names}]`,
|
|
)
|
|
}
|
|
|
|
// Diagrams: a plain shape, one shape from each icon library, and the styles
|
|
// that make draw.io load code on demand (hand-drawn look, math)
|
|
const cell = (id, style, x) =>
|
|
`<mxCell id="${id}" value="${id}" style="${style}" vertex="1" parent="1"><mxGeometry x="${x}" y="40" width="60" height="60" as="geometry"/></mxCell>`
|
|
const doc = (cells, attrs = "") =>
|
|
`<mxfile><diagram id="p" name="P"><mxGraphModel ${attrs}><root><mxCell id="0"/><mxCell id="1" parent="0"/>${cells}</root></mxGraphModel></diagram></mxfile>`
|
|
const LIBS = {
|
|
plain: "rounded=1;whiteSpace=wrap;html=1;",
|
|
aws4: "shape=mxgraph.aws4.resourceIcon;resIcon=mxgraph.aws4.a1_instance;fillColor=#ED7100;strokeColor=#ffffff;",
|
|
gcp2: "shape=mxgraph.gcp2.a7_power;fillColor=#4285F4;strokeColor=none;",
|
|
kubernetes:
|
|
"shape=mxgraph.kubernetes.icon;prIcon=api;fillColor=#326CE5;strokeColor=none;",
|
|
cisco19:
|
|
"shape=mxgraph.cisco19.rect;prIcon=aci;fillColor=#00bceb;strokeColor=none;",
|
|
flowchart:
|
|
"shape=mxgraph.flowchart.annotation_1;fillColor=#d5e8d4;strokeColor=#82b366;",
|
|
webicons:
|
|
"shape=mxgraph.webicons.adfty;fillColor=#3b5998;strokeColor=none;",
|
|
bpmn: "shape=mxgraph.bpmn.shape;symbol=message;outline=throwing;",
|
|
networks:
|
|
"shape=mxgraph.networks.server;fillColor=#29AAE1;strokeColor=none;",
|
|
azure2_image:
|
|
"image;aspect=fixed;image=img/lib/azure2/compute/Virtual_Machine.svg;",
|
|
sketch: "rounded=1;whiteSpace=wrap;html=1;sketch=1;",
|
|
}
|
|
const MATH_DOC = doc(
|
|
cell("math", "rounded=1;whiteSpace=wrap;html=1;", 40).replace(
|
|
'value="math"',
|
|
'value="$$x^2$$"',
|
|
),
|
|
'math="1"',
|
|
)
|
|
|
|
// Dialogs and toggles, by draw.io action name (Actions.js); each is closed
|
|
// again right after it opened. Insert > Template and Insert > Advanced >
|
|
// PlantUML, which load files when used, are driven below. Mermaid needs no
|
|
// extra files: its converter is in js/extensions.min.js, which the editor
|
|
// loads at startup. Left out on purpose, to keep the package small: the org
|
|
// chart layout (it loads js/orgchart.min.js). Not covered either: images
|
|
// from other websites in some templates (Org Chart avatars, Arista icons)
|
|
// and the /drawio/proxy requests draw.io makes for them when exporting;
|
|
// the copy has no proxy, a known limitation (see the README).
|
|
const ACTIONS = [
|
|
"editData",
|
|
"editDiagram",
|
|
"editStyle",
|
|
"editGeometry",
|
|
"editTooltip",
|
|
"editLink",
|
|
"insertImage",
|
|
"exportPng",
|
|
"exportSvg",
|
|
"exportJpg",
|
|
"exportWebp",
|
|
"exportPdf",
|
|
"exportXml",
|
|
"exportHtml",
|
|
"exportVsdx",
|
|
"embedHtml",
|
|
"embedImage",
|
|
"embedSvg",
|
|
"embedIframe",
|
|
"about",
|
|
"pageSetup",
|
|
"print",
|
|
"findReplace",
|
|
"tags",
|
|
"layers",
|
|
"outline",
|
|
"shapes",
|
|
"scratchpad",
|
|
"plugins",
|
|
"properties",
|
|
"fromText",
|
|
"csv",
|
|
"runLayout",
|
|
"insertFreehand",
|
|
"comments",
|
|
"customZoom",
|
|
"renamePage",
|
|
"format",
|
|
"format",
|
|
"toggleShapes",
|
|
"toggleShapes",
|
|
"darkMode",
|
|
"lightMode",
|
|
"autoMode",
|
|
"highContrast",
|
|
"highContrast",
|
|
"mathematicalTypesetting",
|
|
"mathematicalTypesetting",
|
|
"keyboardShortcuts",
|
|
]
|
|
// Enough for the other themes, whose dialogs are the same code
|
|
const LIGHT_ACTIONS = ["editData", "exportPng", "shapes", "format", "format"]
|
|
|
|
const wait = (page, ms) => page.waitForTimeout(ms)
|
|
|
|
/**
|
|
* Open the editor in one theme and use it. The default theme gets the full
|
|
* tour; the others the parts that differ by theme (chrome, menus, panels).
|
|
*/
|
|
async function drive(browser, ui, full) {
|
|
console.log(`theme ${ui}${full ? "" : " (light)"}`)
|
|
const page = await browser.newPage({
|
|
viewport: { width: 1300, height: 900 },
|
|
})
|
|
page.on("popup", (p) => p.close().catch(() => {}))
|
|
await page.goto(`http://localhost:${port}/?ui=${ui}`)
|
|
await page.waitForFunction(() => window.ready === true, null, {
|
|
timeout: 60000,
|
|
})
|
|
await wait(page, 2000)
|
|
report("editor ready")
|
|
|
|
const load = (xml) =>
|
|
page.evaluate(
|
|
(x) => window.send({ action: "load", xml: x, autosave: 1 }),
|
|
xml,
|
|
)
|
|
let x = 40
|
|
for (const [name, style] of Object.entries(LIBS)) {
|
|
await load(doc(cell(name, style, (x += 100))))
|
|
await wait(page, full ? 1500 : 500)
|
|
report(`load ${name}`)
|
|
if (!full) break
|
|
}
|
|
if (full) {
|
|
await load(MATH_DOC)
|
|
await wait(page, 2500)
|
|
report("load math")
|
|
}
|
|
|
|
// The editor instance: in embed mode draw.io calls a plugin callback
|
|
// registered after startup right away
|
|
const frame = page.frames().find((f) => f.url().includes("/drawio/"))
|
|
await frame.evaluate(() => {
|
|
window.Draw.loadPlugin((u) => {
|
|
window.__ui = u
|
|
})
|
|
window.__ui.editor.graph.selectAll()
|
|
})
|
|
const closeAll = async () => {
|
|
await frame.evaluate(() => {
|
|
const ui = window.__ui
|
|
while (ui.dialogs && ui.dialogs.length > 0) ui.hideDialog()
|
|
ui.hideCurrentMenu?.()
|
|
})
|
|
await page.keyboard.press("Escape")
|
|
await wait(page, 100)
|
|
}
|
|
|
|
let opened = 0
|
|
const actions = full ? ACTIONS : LIGHT_ACTIONS
|
|
for (const name of actions) {
|
|
const result = await frame.evaluate((n) => {
|
|
const ui = window.__ui
|
|
const action = ui.actions.get(n)
|
|
if (!action) return "missing"
|
|
try {
|
|
action.funct()
|
|
} catch (e) {
|
|
return `failed: ${e.message}`
|
|
}
|
|
return ui.dialog || ui.dialogs?.length ? "dialog" : "ok"
|
|
}, name)
|
|
if (result === "dialog") opened++
|
|
if (result !== "ok" && result !== "dialog") {
|
|
console.log(` action ${name}: ${result}`)
|
|
}
|
|
await wait(page, 400)
|
|
report(`action ${name}`)
|
|
await closeAll()
|
|
}
|
|
console.log(` ${opened} of ${actions.length} actions opened a dialog`)
|
|
|
|
// File > Open Library from > Browser (libraries=1): the picker is an
|
|
// iframe on open.html, which loads js/open.js
|
|
await frame.evaluate(() => window.__ui.pickLibrary(window.App.MODE_BROWSER))
|
|
await wait(page, 1000)
|
|
report("library picker")
|
|
await closeAll()
|
|
|
|
// Menus: the visible menubar items, the toolbar buttons that open a menu
|
|
// in the other themes, and every menu rendered with its submenus
|
|
const menubarItems = frame.locator(".geMenubar .geItem:visible")
|
|
const menubarCount = await menubarItems.count()
|
|
for (let i = 0; i < menubarCount; i++) {
|
|
await menubarItems
|
|
.nth(i)
|
|
.click({ timeout: 2000 })
|
|
.catch(() => {})
|
|
await wait(page, 300)
|
|
await closeAll()
|
|
}
|
|
let toolbarCount = 0
|
|
for (const title of [
|
|
"Diagram",
|
|
"Insert",
|
|
"Shapes",
|
|
"Pages",
|
|
"View",
|
|
"Table",
|
|
"Layout",
|
|
]) {
|
|
const button = frame.locator(`a[title="${title}"]:visible`).first()
|
|
if ((await button.count()) === 0) continue
|
|
toolbarCount++
|
|
await button.click({ timeout: 2000 }).catch(() => {})
|
|
await wait(page, 300)
|
|
await closeAll()
|
|
}
|
|
const failed = await frame.evaluate(() => {
|
|
const ui = window.__ui
|
|
const failed = []
|
|
for (const name of Object.keys(ui.menus.menus)) {
|
|
const menu = new window.mxPopupMenu()
|
|
menu.init()
|
|
document.body.appendChild(menu.div)
|
|
try {
|
|
ui.menus.get(name).funct(menu, null)
|
|
} catch {
|
|
failed.push(name)
|
|
}
|
|
menu.destroy()
|
|
}
|
|
return failed
|
|
})
|
|
await wait(page, 500)
|
|
console.log(
|
|
` menus: ${menubarCount} menubar items, ${toolbarCount} toolbar menus clicked` +
|
|
(failed.length ? `; not rendered: ${failed.join(", ")}` : ""),
|
|
)
|
|
report("menus")
|
|
|
|
// Format panel tabs, with a shape selected
|
|
await frame.evaluate(() => window.__ui.editor.graph.selectAll())
|
|
for (const tab of ["Style", "Text", "Arrange", "Diagram"]) {
|
|
const el = frame
|
|
.locator(`.geFormatContainer div:text-is("${tab}")`)
|
|
.first()
|
|
if ((await el.count()) > 0)
|
|
await el.click({ timeout: 2000 }).catch(() => {})
|
|
await wait(page, 200)
|
|
}
|
|
report("format panel tabs")
|
|
|
|
// Shape sidebar: open every palette, then search
|
|
await frame.evaluate(() => {
|
|
const ui = window.__ui
|
|
for (const title of document.querySelectorAll(
|
|
".geSidebarContainer .geTitle",
|
|
)) {
|
|
title.click()
|
|
}
|
|
ui.sidebar.searchShapes?.("server")
|
|
})
|
|
await wait(page, full ? 2500 : 1000)
|
|
report("sidebar palettes and search")
|
|
|
|
// Pages: insert, switch, duplicate, remove, and the tab bar
|
|
for (const name of [
|
|
"insertPage",
|
|
"nextPage",
|
|
"previousPage",
|
|
"duplicatePage",
|
|
"removePage",
|
|
]) {
|
|
await frame.evaluate((n) => window.__ui.actions.get(n)?.funct(), name)
|
|
await wait(page, 150)
|
|
await closeAll()
|
|
}
|
|
for (const title of ["Insert Page", "Pages"]) {
|
|
const el = frame.locator(`a[title="${title}"]:visible`).first()
|
|
if ((await el.count()) > 0)
|
|
await el.click({ timeout: 2000 }).catch(() => {})
|
|
await wait(page, 300)
|
|
await closeAll()
|
|
}
|
|
report("page tabs")
|
|
|
|
if (full) {
|
|
// Insert > Advanced > PlantUML: the parser is loaded on first use
|
|
await frame.evaluate(() => window.__ui.actions.get("plantUml").funct())
|
|
await frame
|
|
.locator(".geDialog textarea")
|
|
.first()
|
|
.fill("@startuml\nA -> B\n@enduml")
|
|
await frame
|
|
.locator('.geDialog button:text-is("Insert")')
|
|
.first()
|
|
.click()
|
|
await wait(page, 3000)
|
|
report("plantUml insert")
|
|
await closeAll()
|
|
|
|
// Insert > Template: the index and the previews on screen
|
|
await frame.evaluate(() =>
|
|
window.__ui.actions.get("insertTemplate").funct(),
|
|
)
|
|
await wait(page, 2000)
|
|
report("template dialog")
|
|
await closeAll()
|
|
|
|
const formats = ["png", "svg", "xmlsvg", "xml"]
|
|
for (const [i, format] of formats.entries()) {
|
|
await page.evaluate(
|
|
(f) => window.send({ action: "export", format: f, scale: 2 }),
|
|
format,
|
|
)
|
|
await page
|
|
.waitForFunction((n) => window.exports >= n, i + 1, {
|
|
timeout: 10000,
|
|
})
|
|
.catch(() => {})
|
|
report(`export ${format}`)
|
|
}
|
|
const exports = await page.evaluate(() => window.exports)
|
|
if (exports < formats.length) {
|
|
console.error(
|
|
` only ${exports} of ${formats.length} exports answered`,
|
|
)
|
|
process.exitCode = 1
|
|
}
|
|
}
|
|
await page.close()
|
|
}
|
|
|
|
const browser = await chromium.launch()
|
|
try {
|
|
for (const ui of THEMES) await drive(browser, ui, ui === THEMES[0])
|
|
} finally {
|
|
await browser.close()
|
|
server.close()
|
|
}
|
|
|
|
// A full copy has every file the editor asks for; 404s mean this is not one
|
|
if (notFound.size > 0) {
|
|
console.error(
|
|
`\nThe editor requested ${notFound.size} files that ${drawioDir} does not have (not a full draw.io copy?):\n ${[...notFound].join("\n ")}`,
|
|
)
|
|
process.exit(1)
|
|
}
|
|
|
|
// Compare with the list
|
|
const list = readFileList(LIST)
|
|
const missing = requested.filter((f) => !list.matches(f)).sort()
|
|
|
|
function* walk(dir) {
|
|
for (const entry of readdirSync(dir, { withFileTypes: true })) {
|
|
const full = path.join(dir, entry.name)
|
|
if (entry.isDirectory()) yield* walk(full)
|
|
else yield path.relative(drawioDir, full).split(path.sep).join("/")
|
|
}
|
|
}
|
|
const summarize = (fileList) => {
|
|
let count = 0
|
|
let bytes = 0
|
|
for (const rel of walk(drawioDir)) {
|
|
if (!fileList.matches(rel)) continue
|
|
count++
|
|
bytes += statSync(path.join(drawioDir, rel)).size
|
|
}
|
|
return `${count} files, ${mb(bytes)} MB unpacked`
|
|
}
|
|
|
|
if (update) {
|
|
// Only the head decides what is already covered by "always include"
|
|
const always = parseFileList(list.head)
|
|
const kept = requested.filter((f) => !always.matches(f))
|
|
writeFileSync(LIST, formatFileList(list.head, kept))
|
|
console.log(`\nWrote ${LIST}: ${summarize(readFileList(LIST))}`)
|
|
} else if (missing.length > 0) {
|
|
console.error(
|
|
`\nThe editor requested ${missing.length} files that drawio-files.txt does not list:\n ${missing.join("\n ")}\nRun with --update to add them.`,
|
|
)
|
|
process.exit(1)
|
|
} else {
|
|
console.log(`\ndrawio-files.txt is complete: ${summarize(list)}`)
|
|
}
|