mirror of
https://github.com/DayuanJiang/next-ai-draw-io.git
synced 2026-10-12 20:49:53 +08:00
## Problem
Two audits of the repository (a workflow of finder, dedup and per-file verifier agents, run on 2026-10-11 against 1f4141e and again against 07f3e3c after a first round of refactoring) found dead code and features that were more machinery than the app needs: an Electron configuration-preset system with its own settings window, three copies of the about page, a hand-written `.env` parser, an "extended" system prompt nobody selected, two data migrations for formats from 2025-12 and 2026-01, a server-side example cache, type-to-confirm provider deletion, 81 unused dictionary keys, wrapper components around single call sites, and a long tail of unused exports, props, options and tests.
## Change
Every item below was either approved one by one or covered by "fix all of the others".
- **Electron:** the configuration-preset system is gone (settings window, preload, IPC, menu entry, dev watcher); `config-manager.ts` keeps only `userLocale`; `.env` files are parsed with `dotenv`. Entitlements file and a duplicate CI workflow removed; `test.yml` gets a type check and concurrency.
- **Server:** no extended prompt, no example cache, no `ENABLE_HISTORY_XML_REPLACE`, no message metadata or `hasConfig`; the connection test is one shared helper; EdgeOne loses its mock branch and model aliases; `DEBUG_LLM_PAYLOAD` logs message structure instead of payloads; Langfuse scoring helper; `apiKeyEnv` arrays kept and documented in `env.example` and the provider docs.
- **Pages:** one about page per language from a single component (old `/cn` and `/ja` URLs redirect with 308); layout uses `hasLocale`; the GitHub icon is a local component instead of `react-icons`; Cloudflare deploys without an R2 cache by default.
- **Chat and canvas:** the legacy `diagramHistory` conversion, the localStorage chat migration and the templates storage are gone; `chat-engine` reads the diagram through the context's refs; the diagram context has one tagged export path (`requestTaggedExport` / `fetchDiagramXml`); the screenshot check uses fetch + JSON and `generateText` with `Output.object`; `load-diagram` accepts `<svg:svg>` and strips the XML prolog.
- **Settings UI:** `model-selector` inlines its Dialog, Command and Tooltip; `ai-elements/model-selector`, `button-with-tooltip`, `error-toast` removed; no type-to-confirm, no footer, no `bedrockApiKey`; `use-model-config` loses the old-format migration; one reasoning component; the shimmer is CSS (no `motion`, no `@radix-ui/react-use-controllable-state`); 81 dictionary keys removed in all four languages.
- **MCP server:** `registerTool` / `ok` / `fail` replace per-tool try/catch; `syncFromBrowser`, `commitDocument`, `describePages`; the hand-written XML syntax check, unused result fields, `pickPageSelector`, `expandStyles` and the `host` attribute handling are gone; tests get a shared `setup.ts` and drive the server through the SDK client.
- **Prompt:** the web app's style rules come from the MCP drawing guide (`styleRules`), byte-identical to before.
- **Tests:** shared e2e helpers (`openApp`, `sse`, `toolCallEvents`, `chunkedReplies`); placeholder specs dropped; `settings-review-fixes` split by topic; unit tests use `vi.stubEnv`.
- **Dependencies removed:** `@xmldom/xmldom`, `remark-gfm`, `@anthropic-ai/tokenizer`, `@testing-library/user-event`, `concurrently`, `wait-on`, `eslint`, `eslint-config-next`, `@vitest/coverage-v8`, `shx`, `motion`, `@radix-ui/react-use-controllable-state`, `react-icons`.
Source lines: 74,983 before, 67,418 after (excluding lockfiles).
The last commit merges #984 (the canvas shell). Where the shell, the classic page or their tests depend on a wire format or signature this branch had changed, main's version wins (export fields of the poll response, `addHistory` signature); where main only extended code this branch restructured, main's change is carried into the new structure (`start_session`, `get_selection`, `prepareNewDiagram`, the diagram context's `requestExport`).
## Testing
- `tsc --noEmit` for the web app, `packages/mcp-server`, its shell and `electron`: clean
- `biome ci`: 0 errors (37 pre-existing warnings)
- Root `vitest run`: 719 passed; `packages/mcp-server` `vitest run`: 372 passed
- `next build`: clean
- Playwright, whole web suite on the dev server (4 workers): 280 tests, 279 passed; `language.spec.ts` "a stale offer to switch without saving does nothing once a message is being sent" failed under parallel load and passed alone, as it does on main
94 lines
3.4 KiB
TypeScript
94 lines
3.4 KiB
TypeScript
/**
|
|
* Tests for the user's instructions.md appended to the drawing guide
|
|
* (src/custom-instructions.ts).
|
|
*/
|
|
|
|
import { mkdirSync, mkdtempSync, writeFileSync } from "node:fs"
|
|
import { homedir, tmpdir } from "node:os"
|
|
import { join } from "node:path"
|
|
import { describe, expect, it, vi } from "vitest"
|
|
import {
|
|
CUSTOM_INSTRUCTIONS_FILE,
|
|
customInstructionsDir,
|
|
guideWithCustomInstructions,
|
|
readCustomInstructions,
|
|
} from "../src/custom-instructions.ts"
|
|
import { DRAWING_GUIDE } from "../src/drawing-guide.ts"
|
|
|
|
const GUIDE = "# Drawing guide\n\nKeep edges orthogonal."
|
|
const tempDir = () => mkdtempSync(join(tmpdir(), "mcp-instructions-"))
|
|
const writeRules = (dir: string, text: string) =>
|
|
writeFileSync(join(dir, CUSTOM_INSTRUCTIONS_FILE), text)
|
|
|
|
describe("readCustomInstructions", () => {
|
|
it("gives an empty string when there is no file", () => {
|
|
const dir = tempDir()
|
|
expect(readCustomInstructions(dir)).toBe("")
|
|
expect(guideWithCustomInstructions(GUIDE, dir)).toBe(GUIDE)
|
|
})
|
|
|
|
it("appends the file's content under its own heading", () => {
|
|
const dir = tempDir()
|
|
writeRules(dir, "\nAlways draw in minimal style.\n\n")
|
|
expect(readCustomInstructions(dir)).toBe(
|
|
"Always draw in minimal style.",
|
|
)
|
|
expect(guideWithCustomInstructions(GUIDE, dir)).toBe(
|
|
`${GUIDE}\n\n## Custom Instructions\nAlways draw in minimal style.`,
|
|
)
|
|
})
|
|
|
|
it("cuts the content at 5000 characters", () => {
|
|
const dir = tempDir()
|
|
writeRules(dir, "x".repeat(6000))
|
|
expect(readCustomInstructions(dir)).toBe("x".repeat(5000))
|
|
})
|
|
|
|
it("gives an empty string when the file cannot be read", () => {
|
|
const dir = tempDir()
|
|
// A folder in place of the file: readFileSync fails with EISDIR
|
|
mkdirSync(join(dir, CUSTOM_INSTRUCTIONS_FILE))
|
|
expect(readCustomInstructions(dir)).toBe("")
|
|
expect(guideWithCustomInstructions(GUIDE, dir)).toBe(GUIDE)
|
|
})
|
|
|
|
it("reads the file again on every call", () => {
|
|
const dir = tempDir()
|
|
writeRules(dir, "First rule.")
|
|
expect(readCustomInstructions(dir)).toBe("First rule.")
|
|
writeRules(dir, "Second rule.")
|
|
expect(readCustomInstructions(dir)).toBe("Second rule.")
|
|
})
|
|
})
|
|
|
|
describe("customInstructionsDir", () => {
|
|
it("honours DRAWIO_DATA_DIR", () => {
|
|
const dir = tempDir()
|
|
writeRules(dir, "Use blue fill #dae8fc.")
|
|
vi.stubEnv("DRAWIO_DATA_DIR", dir)
|
|
expect(customInstructionsDir()).toBe(dir)
|
|
expect(guideWithCustomInstructions(GUIDE)).toBe(
|
|
`${GUIDE}\n\n## Custom Instructions\nUse blue fill #dae8fc.`,
|
|
)
|
|
})
|
|
|
|
it("expands ~, which JSON configs pass on as it is", () => {
|
|
vi.stubEnv("DRAWIO_DATA_DIR", "~/drawio-saves")
|
|
expect(customInstructionsDir()).toBe(join(homedir(), "drawio-saves"))
|
|
})
|
|
|
|
it("falls back to the home folder when DRAWIO_DATA_DIR is off or unset", () => {
|
|
const home = join(homedir(), ".next-ai-drawio")
|
|
vi.stubEnv("DRAWIO_DATA_DIR", "off")
|
|
expect(customInstructionsDir()).toBe(home)
|
|
vi.stubEnv("DRAWIO_DATA_DIR", undefined)
|
|
expect(customInstructionsDir()).toBe(home)
|
|
})
|
|
})
|
|
|
|
describe("DRAWING_GUIDE", () => {
|
|
it("stays within its own budget; instructions.md adds up to 5000 more", () => {
|
|
expect(DRAWING_GUIDE.length).toBeLessThanOrEqual(15000)
|
|
})
|
|
})
|