Skip to content

Commit 1987ee2

Browse files
fix(web): keep Mermaid streaming coverage focused
1 parent f1aa4f7 commit 1987ee2

2 files changed

Lines changed: 90 additions & 41 deletions

File tree

‎apps/web/src/components/ChatMarkdown.browser.test.tsx‎

Lines changed: 88 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ vi.mock(import("../remoteOpen"), async (original) => ({
5252
const { renderDiagram } = vi.hoisted(() => ({
5353
renderDiagram: vi.fn<(source: string) => Promise<string> | undefined>(),
5454
}));
55-
// A rendered diagram is an SVG; real Mermaid layout is not what these tests exercise.
56-
// Tests that return a promise from renderDiagram control when it appears.
55+
// Control rendering latency without running Mermaid layout.
5756
vi.mock(import("./chat/MermaidDiagram"), async (original) => {
5857
const { use } = await import("react");
5958
return {
@@ -70,6 +69,7 @@ import ChatMarkdown from "./ChatMarkdown";
7069
const roots: Root[] = [];
7170

7271
beforeEach(() => {
72+
renderDiagram.mockReset();
7373
workspaceSearch.mockReset().mockResolvedValue(AsyncResult.success({ entries: [] }));
7474
filesystemMetadata.mockReset().mockResolvedValue(AsyncResult.success({ entries: [null] }));
7575
vi.stubGlobal("IS_REACT_ACT_ENVIRONMENT", true);
@@ -163,47 +163,95 @@ describe("ChatMarkdown bare anchor placeholders", () => {
163163
});
164164

165165
describe("ChatMarkdown Mermaid streaming", () => {
166-
it.each([
167-
["```mermaid\nflowchart LR\nA --> B", "\n```"],
168-
["~~~~mermaid\nflowchart LR\nA --> B\n~~~", "\n~~~~"],
169-
["> ```mermaid\n> flowchart LR\n> A --> B", "\n> ```"],
170-
["- Diagram\n\n ```mermaid\n flowchart LR\n A --> B", "\n ```"],
171-
["```mermaid\nflowchart LR\nA --> B\n ```", "\n```"],
172-
["> ```mermaid\n> flowchart LR\n> A --> B\n> ```", "\n> ```"],
173-
["- Diagram\n\n ```mermaid\n flowchart LR\n A --> B\n ```", "\n ```"],
174-
["```mermaid\r\nflowchart LR\r\nA --> B\r\n\t```", "\r\n```"],
175-
["```mermaid\r\nflowchart LR\r\nA --> B\r\n\t```\r", "\n```"],
176-
])("reveals a finished fence before the message finishes: %s", async (open, closing) => {
166+
it("reveals a completed fence while streaming and preserves it through later prose and stream end", async () => {
177167
let finishRender!: (label: string) => void;
178-
const pending = new Promise<string>((resolve) => {
179-
finishRender = resolve;
180-
});
181-
renderDiagram.mockReset().mockReturnValue(pending);
168+
renderDiagram.mockReturnValue(
169+
new Promise<string>((resolve) => {
170+
finishRender = resolve;
171+
}),
172+
);
173+
const source = "flowchart LR\nA --> B";
174+
const open = `\`\`\`mermaid\n${source}`;
175+
const closed = `${open}\n\`\`\`\n\n`;
182176
const message = (text: string, isStreaming = true) => (
183177
<ChatMarkdown cwd={undefined} text={text} isStreaming={isStreaming} />
184178
);
185-
const closed = `${open}${closing}\n\n`;
186-
try {
187-
const { container, rerender } = await render(message(open));
188-
expect(renderDiagram).not.toHaveBeenCalled();
189-
190-
await rerender(message(closed));
191-
expect(renderDiagram).toHaveBeenCalled();
192-
expect(container.querySelector('svg[role="img"]')).toBeNull();
193-
expect(container.querySelector(".chat-markdown-shiki")).toBeNull();
194-
expect(container.querySelector("pre")?.getAttribute("aria-hidden")).toBe("true");
195-
196-
await act(async () => finishRender("Completed diagram"));
197-
const diagram = container.querySelector('svg[role="img"]');
198-
expect(diagram?.getAttribute("aria-label")).toBe("Completed diagram");
199-
for (const streaming of [true, false]) {
200-
await rerender(message(`${closed}The remaining explanation.`, streaming));
201-
expect(container.querySelector('svg[role="img"]')).toBe(diagram);
202-
expect(container.textContent).toContain("The remaining explanation.");
203-
}
204-
} finally {
205-
renderDiagram.mockReset();
179+
const { container, rerender } = await render(message(open));
180+
expect(container.querySelector("pre")?.textContent).toContain(source);
181+
expect(renderDiagram).not.toHaveBeenCalled();
182+
183+
await rerender(message(closed));
184+
expect(renderDiagram).toHaveBeenCalledWith(expect.stringContaining(source));
185+
expect(container.querySelector('svg[role="img"]')).toBeNull();
186+
expect(container.querySelector(".chat-markdown-shiki")).toBeNull();
187+
const placeholder = container.querySelector("pre");
188+
expect(placeholder?.getAttribute("aria-hidden")).toBe("true");
189+
expect(placeholder?.textContent).toContain(source);
190+
191+
await act(async () => finishRender("Completed diagram"));
192+
const diagram = container.querySelector('svg[role="img"]');
193+
expect(diagram?.getAttribute("aria-label")).toBe("Completed diagram");
194+
for (const streaming of [true, false]) {
195+
await rerender(message(`${closed}The remaining explanation.`, streaming));
196+
expect(container.querySelector('svg[role="img"]')).toBe(diagram);
197+
expect(container.textContent).toContain("The remaining explanation.");
206198
}
199+
200+
await act(async () => buttonsLabelled(container, "Show code")[0]!.click());
201+
expect(container.querySelector('svg[role="img"]')).toBeNull();
202+
expect(container.querySelector("pre")?.textContent).toContain(source);
203+
await act(async () => buttonsLabelled(container, "Show diagram")[0]!.click());
204+
expect(container.querySelector('svg[role="img"]')?.getAttribute("aria-label")).toBe(
205+
"Completed diagram",
206+
);
207+
});
208+
209+
it.each([
210+
["short tilde marker", "~~~~mermaid\nflowchart LR\nA --> B\n~~~", "\n~~~~"],
211+
[
212+
"overindented blockquote marker",
213+
"> ```mermaid\n> flowchart LR\n> A --> B\n> ```",
214+
"\n> ```",
215+
],
216+
[
217+
"overindented list marker",
218+
"- Diagram\n\n ```mermaid\n flowchart LR\n A --> B\n ```",
219+
"\n ```",
220+
],
221+
])("keeps a %s in source until a real closer arrives", async (_, open, closing) => {
222+
const message = (text: string) => <ChatMarkdown cwd={undefined} text={text} isStreaming />;
223+
const { container, rerender } = await render(message(open));
224+
expect(renderDiagram).not.toHaveBeenCalled();
225+
expect(container.querySelector("pre")?.textContent).toContain("A --> B");
226+
227+
await rerender(message(`${open}${closing}`));
228+
expect(container.querySelector('svg[role="img"]')?.getAttribute("aria-label")).toBe("Diagram");
229+
});
230+
231+
it("does not mistake a CRLF stream cut after CR for a closed fence", async () => {
232+
const open = "```mermaid\r\nflowchart LR\r\nA --> B\r\n\t```";
233+
const message = (text: string) => <ChatMarkdown cwd={undefined} text={text} isStreaming />;
234+
const { container, rerender } = await render(message(open));
235+
expect(renderDiagram).not.toHaveBeenCalled();
236+
await rerender(message(`${open}\r`));
237+
expect(renderDiagram).not.toHaveBeenCalled();
238+
expect(container.querySelector("pre")?.textContent).toContain("A --> B");
239+
240+
await rerender(message(`${open}\r\n\`\`\``));
241+
expect(container.querySelector('svg[role="img"]')?.getAttribute("aria-label")).toBe("Diagram");
242+
});
243+
244+
it("falls back to source when a completed diagram fails during streaming", async () => {
245+
await getSyntaxHighlighterPromise("mermaid");
246+
renderDiagram.mockImplementation(() => {
247+
throw new Error("Invalid Mermaid diagram");
248+
});
249+
vi.spyOn(console, "error").mockImplementation(() => {});
250+
const container = await renderText("```mermaid\ninvalid diagram\n```", { isStreaming: true });
251+
expect(renderDiagram).toHaveBeenCalledWith(expect.stringContaining("invalid diagram"));
252+
expect(container.querySelector('svg[role="img"]')).toBeNull();
253+
expect(container.querySelector("pre")?.textContent).toContain("invalid diagram");
254+
expect(container.querySelector("pre")?.getAttribute("aria-hidden")).not.toBe("true");
207255
});
208256
});
209257

@@ -290,6 +338,8 @@ describe("ChatMarkdown streaming", () => {
290338
"~~~bash\necho tilde\n~~~",
291339
"> ```bash\n> echo quote\n> ```",
292340
"````bash\necho four\n````",
341+
"- Command\n\n ```bash\n echo list\n ```",
342+
"```bash\r\necho crlf\r\n```\r",
293343
]) {
294344
await rerender(message(text));
295345
expect(runButtons()).toHaveLength(1);

‎apps/web/src/components/ChatMarkdown.tsx‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -489,9 +489,8 @@ function isClosedCodeFence(
489489
closing !== undefined &&
490490
opening[0] === closing[0] &&
491491
closing.length >= opening.length &&
492-
// A real closer is excluded from the parsed code. Invalid, overindented
493-
// markers remain in it, so the source must have an extra fence line. A
494-
// stream cut inside a CRLF leaves a lone CR that is not a line of its own.
492+
// Only a real closer is omitted from parsed code. A CRLF stream cut after
493+
// CR must not count as an extra source line.
495494
source.replace(/\r$/, "").split(/\r\n|\r|\n/).length > code.split(/\r\n|\r|\n/).length
496495
);
497496
}

0 commit comments

Comments
 (0)