The open source coding agent.
TypeScript
fix(ui): keep partial markdown readable while responses stream (#19403)
Shoubhit Dashd3414996845b
diff --git a/bun.lock b/bun.lockindex 6052633505d..54e1c768d0a 100644--- a/bun.lock+++ b/bun.lock@@ -516,6 +516,7 @@"motion-dom": "12.34.3","motion-utils": "12.29.2","remeda": "catalog:",+ "remend": "catalog:","shiki": "catalog:","solid-js": "catalog:","solid-list": "catalog:",@@ -631,6 +632,7 @@"marked": "17.0.1","marked-shiki": "1.2.1","remeda": "2.26.0",+ "remend": "1.3.0","shiki": "3.20.0","solid-js": "1.9.10","solid-list": "0.3.0",@@ -4107,6 +4109,8 @@"remeda": ["[email protected]", "", { "dependencies": { "type-fest": "^4.41.0" } }, "sha512-lmNNwtaC6Co4m0WTTNoZ/JlpjEqAjPZO0+czC9YVRQUpkbS4x8Hmh+Mn9HPfJfiXqUQ5IXXgSXSOB2pBKAytdA=="],+ "remend": ["[email protected]", "", {}, "sha512-iIhggPkhW3hFImKtB10w0dz4EZbs28mV/dmbcYVonWEJ6UGHHpP+bFZnTh6GNWJONg5m+U56JrL+8IxZRdgWjw=="],+"request-light": ["[email protected]", "", {}, "sha512-lMbBMrDoxgsyO+yB3sDcrDuX85yYt7sS8BfQd11jtbW/z5ZWgLZRcEGLsLoYw7I0WSUGQBs8CC8ScIxkTX1+6Q=="],"require-directory": ["[email protected]", "", {}, "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q=="],diff --git a/package.json b/package.jsonindex dfc9840c2a8..40ab8ceaf67 100644--- a/package.json+++ b/package.json@@ -53,6 +53,7 @@"luxon": "3.6.1","marked": "17.0.1","marked-shiki": "1.2.1",+ "remend": "1.3.0","@playwright/test": "1.51.0","typescript": "5.8.2","@typescript/native-preview": "7.0.0-dev.20251207.1",diff --git a/packages/ui/package.json b/packages/ui/package.jsonindex d4e7505bf59..8214a7a1d30 100644--- a/packages/ui/package.json+++ b/packages/ui/package.json@@ -64,6 +64,7 @@"motion-dom": "12.34.3","motion-utils": "12.29.2","remeda": "catalog:",+ "remend": "catalog:","shiki": "catalog:","solid-js": "catalog:","solid-list": "catalog:",diff --git a/packages/ui/src/components/markdown-stream.test.ts b/packages/ui/src/components/markdown-stream.test.tsnew file mode 100644index 00000000000..1ee63fc62e4--- /dev/null+++ b/packages/ui/src/components/markdown-stream.test.ts@@ -0,0 +1,32 @@+import { describe, expect, test } from "bun:test"+import { stream } from "./markdown-stream"++describe("markdown stream", () => {+ test("heals incomplete emphasis while streaming", () => {+ expect(stream("hello **world", true)).toEqual([{ raw: "hello **world", src: "hello **world**", mode: "live" }])+ expect(stream("say `code", true)).toEqual([{ raw: "say `code", src: "say `code`", mode: "live" }])+ })++ test("keeps incomplete links non-clickable until they finish", () => {+ expect(stream("see [docs](https://example.com/gu", true)).toEqual([+ { raw: "see [docs](https://example.com/gu", src: "see docs", mode: "live" },+ ])+ })++ test("splits an unfinished trailing code fence from stable content", () => {+ expect(stream("before\n\n```ts\nconst x = 1", true)).toEqual([+ { raw: "before\n\n", src: "before\n\n", mode: "live" },+ { raw: "```ts\nconst x = 1", src: "```ts\nconst x = 1", mode: "live" },+ ])+ })++ test("keeps reference-style markdown as one block", () => {+ expect(stream("[docs][1]\n\n[1]: https://example.com", true)).toEqual([+ {+ raw: "[docs][1]\n\n[1]: https://example.com",+ src: "[docs][1]\n\n[1]: https://example.com",+ mode: "live",+ },+ ])+ })+})diff --git a/packages/ui/src/components/markdown-stream.ts b/packages/ui/src/components/markdown-stream.tsnew file mode 100644index 00000000000..ea35b0c140d--- /dev/null+++ b/packages/ui/src/components/markdown-stream.ts@@ -0,0 +1,49 @@+import { marked, type Tokens } from "marked"+import remend from "remend"++export type Block = {+ raw: string+ src: string+ mode: "full" | "live"+}++function refs(text: string) {+ return /^\[[^\]]+\]:\s+\S+/m.test(text) || /^\[\^[^\]]+\]:\s+/m.test(text)+}++function open(raw: string) {+ const match = raw.match(/^[ \t]{0,3}(`{3,}|~{3,})/)+ if (!match) return false+ const mark = match[1]+ if (!mark) return false+ const char = mark[0]+ const size = mark.length+ const last = raw.trimEnd().split("\n").at(-1)?.trim() ?? ""+ return !new RegExp(`^[\\t ]{0,3}${char}{${size},}[\\t ]*$`).test(last)+}++function heal(text: string) {+ return remend(text, { linkMode: "text-only" })+}++export function stream(text: string, live: boolean) {+ if (!live) return [{ raw: text, src: text, mode: "full" }] satisfies Block[]+ const src = heal(text)+ if (refs(text)) return [{ raw: text, src, mode: "live" }] satisfies Block[]+ const tokens = marked.lexer(text)+ const tail = tokens.findLastIndex((token) => token.type !== "space")+ if (tail < 0) return [{ raw: text, src, mode: "live" }] satisfies Block[]+ const last = tokens[tail]+ if (!last || last.type !== "code") return [{ raw: text, src, mode: "live" }] satisfies Block[]+ const code = last as Tokens.Code+ if (!open(code.raw)) return [{ raw: text, src, mode: "live" }] satisfies Block[]+ const head = tokens+ .slice(0, tail)+ .map((token) => token.raw)+ .join("")+ if (!head) return [{ raw: code.raw, src: code.raw, mode: "live" }] satisfies Block[]+ return [+ { raw: head, src: heal(head), mode: "live" },+ { raw: code.raw, src: code.raw, mode: "live" },+ ] satisfies Block[]+}diff --git a/packages/ui/src/components/markdown.tsx b/packages/ui/src/components/markdown.tsxindex ce6bdb7e0d8..ceab10df98a 100644--- a/packages/ui/src/components/markdown.tsx+++ b/packages/ui/src/components/markdown.tsx@@ -2,10 +2,10 @@ import { useMarked } from "../context/marked"import { useI18n } from "../context/i18n"import DOMPurify from "dompurify"import morphdom from "morphdom"-import { marked, type Tokens } from "marked"import { checksum } from "@opencode-ai/util/encode"import { ComponentProps, createEffect, createResource, createSignal, onCleanup, splitProps } from "solid-js"import { isServer } from "solid-js/web"+import { stream } from "./markdown-stream"type Entry = {hash: string@@ -58,47 +58,6 @@ function fallback(markdown: string) {return escape(markdown).replace(/\r\n?/g, "\n").replace(/\n/g, "<br>")}-type Block = {- raw: string- mode: "full" | "live"-}--function references(markdown: string) {- return /^\[[^\]]+\]:\s+\S+/m.test(markdown) || /^\[\^[^\]]+\]:\s+/m.test(markdown)-}--function incomplete(raw: string) {- const open = raw.match(/^[ \t]{0,3}(`{3,}|~{3,})/)- if (!open) return false- const mark = open[1]- if (!mark) return false- const char = mark[0]- const size = mark.length- const last = raw.trimEnd().split("\n").at(-1)?.trim() ?? ""- return !new RegExp(`^[\\t ]{0,3}${char}{${size},}[\\t ]*$`).test(last)-}--function blocks(markdown: string, streaming: boolean) {- if (!streaming || references(markdown)) return [{ raw: markdown, mode: "full" }] satisfies Block[]- const tokens = marked.lexer(markdown)- const last = tokens.findLast((token) => token.type !== "space")- if (!last || last.type !== "code") return [{ raw: markdown, mode: "full" }] satisfies Block[]- const code = last as Tokens.Code- if (!incomplete(code.raw)) return [{ raw: markdown, mode: "full" }] satisfies Block[]- const head = tokens- .slice(- 0,- tokens.findLastIndex((token) => token.type !== "space"),- )- .map((token) => token.raw)- .join("")- if (!head) return [{ raw: code.raw, mode: "live" }] satisfies Block[]- return [- { raw: head, mode: "full" },- { raw: code.raw, mode: "live" },- ] satisfies Block[]-}-type CopyLabels = {copy: stringcopied: string@@ -251,8 +210,6 @@ function setupCodeCopy(root: HTMLDivElement, getLabels: () => CopyLabels) {timeouts.set(button, timeout)}- decorate(root, getLabels())-const buttons = Array.from(root.querySelectorAll('[data-slot="markdown-copy-button"]'))for (const button of buttons) {if (button instanceof HTMLButtonElement) updateLabel(button)@@ -304,7 +261,7 @@ export function Markdown(const base = src.key ?? checksum(src.text)return Promise.all(- blocks(src.text, src.streaming).map(async (block, index) => {+ stream(src.text, src.streaming).map(async (block, index) => {const hash = checksum(block.raw)const key = base ? `${base}:${index}:${block.mode}` : hash@@ -316,7 +273,7 @@ export function Markdown(}}- const next = await Promise.resolve(marked.parse(block.raw))+ const next = await Promise.resolve(marked.parse(block.src))const safe = sanitize(next)if (key && hash) touch(key, { hash, html: safe })return safe