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
232 lines
7.9 KiB
TypeScript
232 lines
7.9 KiB
TypeScript
import { act, renderHook, waitFor } from "@testing-library/react"
|
|
import { beforeEach, describe, expect, it, vi } from "vitest"
|
|
|
|
const stored = new Map<string, any>()
|
|
// Each write waits for the test to let it finish
|
|
let pendingWrites: (() => void)[] = []
|
|
// Reads wait for this
|
|
let readGate: Promise<void> = Promise.resolve()
|
|
|
|
vi.mock("@/hooks/use-dictionary", () => ({
|
|
useDictionary: () => ({ errors: { sessionSaveFailed: "Not saved" } }),
|
|
}))
|
|
|
|
vi.mock("@/lib/session-storage", async (importActual) => {
|
|
const actual = await importActual<typeof import("@/lib/session-storage")>()
|
|
return {
|
|
createEmptySession: actual.createEmptySession,
|
|
extractTitle: actual.extractTitle,
|
|
isIndexedDBAvailable: () => true,
|
|
readSessionCount: async () => stored.size,
|
|
enforceSessionLimit: async () => {},
|
|
getSession: async (id: string) => {
|
|
await readGate
|
|
return stored.get(id) ?? null
|
|
},
|
|
deleteSession: async (id: string) => {
|
|
stored.delete(id)
|
|
},
|
|
getAllSessionMetadata: async () =>
|
|
[...stored.values()].map((s) => ({ id: s.id, title: s.title })),
|
|
saveSession: vi.fn(
|
|
(session: any) =>
|
|
new Promise<boolean>((resolve) => {
|
|
pendingWrites.push(() => {
|
|
stored.set(session.id, session)
|
|
resolve(true)
|
|
})
|
|
}),
|
|
),
|
|
}
|
|
})
|
|
|
|
import { useSessionManager } from "@/hooks/use-session-manager"
|
|
|
|
const data = {
|
|
messages: [
|
|
{
|
|
id: "m1",
|
|
role: "user" as const,
|
|
parts: [{ type: "text", text: "Draw a cat" }],
|
|
},
|
|
],
|
|
xmlSnapshots: [] as [number, string][],
|
|
diagramXml: "",
|
|
}
|
|
|
|
// Let every write waiting now (and those it leads to) finish
|
|
async function finishWrites() {
|
|
for (let i = 0; i < 10; i++) {
|
|
await act(async () => {
|
|
const writes = pendingWrites
|
|
pendingWrites = []
|
|
for (const finish of writes) finish()
|
|
await new Promise((r) => setTimeout(r, 0))
|
|
})
|
|
}
|
|
}
|
|
|
|
async function setup() {
|
|
const hook = renderHook(() => useSessionManager())
|
|
await waitFor(() => expect(hook.result.current.isLoading).toBe(false))
|
|
return hook
|
|
}
|
|
|
|
describe("saving the chat on screen", () => {
|
|
beforeEach(() => {
|
|
stored.clear()
|
|
pendingWrites = []
|
|
})
|
|
|
|
it("creates one session when two saves of a new chat overlap", async () => {
|
|
const { result } = await setup()
|
|
let saves!: Promise<boolean[]>
|
|
act(() => {
|
|
saves = Promise.all([
|
|
result.current.saveCurrentSession(data),
|
|
result.current.saveCurrentSession(data),
|
|
])
|
|
})
|
|
await finishWrites()
|
|
expect(await saves).toEqual([true, true])
|
|
expect(stored.size).toBe(1)
|
|
expect(result.current.currentSessionId).toBe([...stored.keys()][0])
|
|
})
|
|
|
|
it("drops a save scheduled before New Chat", async () => {
|
|
const { result } = await setup()
|
|
const scheduled = result.current.getSaveTicket()
|
|
act(() => result.current.clearCurrentSession())
|
|
let save!: Promise<boolean>
|
|
act(() => {
|
|
save = result.current.saveCurrentSession(data, scheduled)
|
|
})
|
|
await finishWrites()
|
|
expect(await save).toBe(true)
|
|
expect(stored.size).toBe(0)
|
|
})
|
|
|
|
it("drops a save of the old chat waiting behind New Chat's save", async () => {
|
|
const { result } = await setup()
|
|
// The auto-save is scheduled, then New Chat saves and clears
|
|
const scheduled = result.current.getSaveTicket()
|
|
let newChatSave!: Promise<boolean>
|
|
let autoSave!: Promise<boolean>
|
|
act(() => {
|
|
newChatSave = result.current.saveCurrentSession(data)
|
|
autoSave = result.current.saveCurrentSession(data, scheduled)
|
|
})
|
|
await act(async () => {
|
|
await waitFor(() => expect(pendingWrites).toHaveLength(1))
|
|
pendingWrites.shift()?.()
|
|
await newChatSave
|
|
result.current.clearCurrentSession()
|
|
})
|
|
await finishWrites()
|
|
await autoSave
|
|
expect(stored.size).toBe(1)
|
|
expect(result.current.currentSessionId).toBeNull()
|
|
})
|
|
|
|
it("keeps the new blank chat when a save of the old one ends later", async () => {
|
|
const { result } = await setup()
|
|
let save!: Promise<boolean>
|
|
act(() => {
|
|
save = result.current.saveCurrentSession(data)
|
|
})
|
|
await waitFor(() => expect(pendingWrites).toHaveLength(1))
|
|
// New Chat while the write runs
|
|
act(() => result.current.clearCurrentSession())
|
|
await finishWrites()
|
|
await save
|
|
expect(stored.size).toBe(1)
|
|
expect(result.current.currentSessionId).toBeNull()
|
|
expect(result.current.currentSession).toBeNull()
|
|
})
|
|
|
|
it("keeps New Chat when the URL's chat finishes loading after it", async () => {
|
|
stored.set("s1", { id: "s1", title: "Old", messages: [] })
|
|
const hook = renderHook(
|
|
({ id }: { id: string | null }) =>
|
|
useSessionManager({ initialSessionId: id }),
|
|
{ initialProps: { id: null as string | null } },
|
|
)
|
|
await waitFor(() => expect(hook.result.current.isLoading).toBe(false))
|
|
// The new chat's id reaches the URL; reading it takes a moment
|
|
let release!: () => void
|
|
readGate = new Promise((r) => {
|
|
release = r
|
|
})
|
|
hook.rerender({ id: "s1" })
|
|
act(() => hook.result.current.clearCurrentSession())
|
|
await act(async () => {
|
|
release()
|
|
await new Promise((r) => setTimeout(r, 0))
|
|
})
|
|
readGate = Promise.resolve()
|
|
expect(hook.result.current.currentSessionId).toBeNull()
|
|
})
|
|
})
|
|
|
|
describe("save tickets", () => {
|
|
beforeEach(() => {
|
|
stored.clear()
|
|
pendingWrites = []
|
|
})
|
|
const textOf = (session: any) => session?.messages[0].parts[0].text
|
|
const said = (text: string) => ({
|
|
...data,
|
|
messages: [{ ...data.messages[0], parts: [{ type: "text", text }] }],
|
|
})
|
|
|
|
it("never put an older copy of a chat over a newer one", async () => {
|
|
const { result } = await setup()
|
|
let first!: Promise<boolean>
|
|
act(() => {
|
|
first = result.current.saveCurrentSession(said("first"))
|
|
})
|
|
await finishWrites()
|
|
await first
|
|
// An auto-save read its data, then waits for its thumbnail; a save
|
|
// without a thumbnail reads newer data and is done first
|
|
const older = result.current.getSaveTicket()
|
|
const newer = result.current.getSaveTicket()
|
|
let saves!: Promise<boolean[]>
|
|
act(() => {
|
|
saves = Promise.all([
|
|
result.current.saveCurrentSession(said("newer"), newer),
|
|
result.current.saveCurrentSession(said("older"), older),
|
|
])
|
|
})
|
|
await finishWrites()
|
|
await saves
|
|
expect(textOf([...stored.values()][0])).toBe("newer")
|
|
})
|
|
|
|
it("keep a chat read before a switch out of the chat switched to", async () => {
|
|
stored.set("other", {
|
|
...said("other chat"),
|
|
id: "other",
|
|
title: "Other",
|
|
})
|
|
const { result } = await setup()
|
|
// New Chat reads this chat, then waits for its thumbnail
|
|
const ticket = result.current.getSaveTicket()
|
|
// Meanwhile the user opens the other chat
|
|
let open!: Promise<unknown>
|
|
act(() => {
|
|
open = result.current.switchSession("other")
|
|
})
|
|
await finishWrites()
|
|
await open
|
|
let late!: Promise<boolean>
|
|
act(() => {
|
|
late = result.current.saveCurrentSession(said("this chat"), ticket)
|
|
})
|
|
await finishWrites()
|
|
await late
|
|
expect(textOf(stored.get("other"))).toBe("other chat")
|
|
expect(stored.size).toBe(1)
|
|
})
|
|
})
|