markdown.spec.tsx 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475
  1. // @vitest-environment jsdom
  2. import { cleanup, fireEvent, render, screen } from '@testing-library/react'
  3. import { afterEach, describe, expect, it } from 'vitest'
  4. import { JsonBlock, MarkdownText, MessageText } from '@deepseek-ai/dsh-client-ui-primitives'
  5. import { cjkFriendlyStrong } from '../src/markdown/cjkFriendlyStrong.ts'
  6. import { mathCompatibility } from '../src/markdown/mathCompatibility.ts'
  7. afterEach(cleanup)
  8. describe('MessageText', () => {
  9. it('renders the text verbatim', () => {
  10. const { container } = render(<MessageText text={'# line1\n`line2`'} />)
  11. expect(container.textContent).toBe('# line1\n`line2`')
  12. expect(container.querySelector('h1')).toBeNull()
  13. })
  14. })
  15. describe('MarkdownText', () => {
  16. it('renders CommonMark and GFM elements as semantic DOM', () => {
  17. const markdown = [
  18. '# Heading',
  19. '',
  20. 'Paragraph with **strong**, *emphasis*, ~~deleted~~, `inline`, and [safe](https://example.com). ',
  21. 'Hard break.',
  22. '',
  23. '> Quote',
  24. '',
  25. '- parent',
  26. ' - child',
  27. '',
  28. '1. first',
  29. '2. second',
  30. '',
  31. '- [x] done',
  32. '- [ ] pending',
  33. '',
  34. '| Name | Value |',
  35. '| --- | --- |',
  36. '| alpha | beta |',
  37. '',
  38. '---',
  39. '',
  40. '```ts',
  41. 'const answer = 42',
  42. '```',
  43. '',
  44. '<https://deepseek.com>',
  45. ].join('\n')
  46. const { container } = render(<MarkdownText text={markdown} />)
  47. expect(screen.getByRole('heading', { level: 1, name: 'Heading' })).toBeTruthy()
  48. expect(container.querySelector('strong')?.textContent).toBe('strong')
  49. expect(container.querySelector('em')?.textContent).toBe('emphasis')
  50. expect(container.querySelector('del')?.textContent).toBe('deleted')
  51. expect(container.querySelector('blockquote')?.textContent?.trim()).toBe('Quote')
  52. expect(container.querySelectorAll('ul')).toHaveLength(3)
  53. expect(container.querySelector('ol')).not.toBeNull()
  54. expect(container.querySelectorAll('input[type="checkbox"]')).toHaveLength(2)
  55. expect(container.querySelector('table')?.textContent).toContain('alphabeta')
  56. expect(container.querySelector('hr')).not.toBeNull()
  57. expect(container.querySelector('pre code')?.textContent).toContain('const answer = 42')
  58. // The ts fence routed through the shared CodeBlock: shiki token spans + banner.
  59. expect(container.querySelector('pre.shiki')).not.toBeNull()
  60. expect(screen.getByText('ts')).toBeTruthy()
  61. expect(screen.getByRole('button', { name: '复制' })).toBeTruthy()
  62. expect(container.querySelector('br')).not.toBeNull()
  63. expect(screen.getByRole('link', { name: 'safe' }).getAttribute('target')).toBe('_blank')
  64. expect(screen.getByRole('link', { name: 'https://deepseek.com' })).toBeTruthy()
  65. })
  66. it('closes punctuation-terminated strong emphasis before adjacent CJK text', () => {
  67. const cases = [
  68. ['**注意:**内容', '注意:'],
  69. ['**Notice:**内容', 'Notice:'],
  70. ['**事件中间件(waterfall)**实现', '事件中间件(waterfall)'],
  71. ['**事件中间件(waterfall)**实现', '事件中间件(waterfall)'],
  72. ['**句号。**后续', '句号。'],
  73. ['**Period.**后续', 'Period.'],
  74. ['**提醒!**继续', '提醒!'],
  75. ['**Warning!**继续', 'Warning!'],
  76. ] as const
  77. const source = cases.map(([markdown]) => markdown).join('\n\n')
  78. for (const streaming of [false, true]) {
  79. const rendered = render(<MarkdownText text={source} streaming={streaming} />)
  80. expect([...rendered.container.querySelectorAll('strong')].map(node => node.textContent))
  81. .toEqual(cases.map(([, strong]) => strong))
  82. rendered.unmount()
  83. }
  84. })
  85. it('keeps the CJK strong extension out of escaped, code, math, and ASCII contexts', () => {
  86. const source = [
  87. String.raw`\**注意:**内容`,
  88. '`**注意:**内容`',
  89. '**Notice:**text',
  90. '*提醒!*继续',
  91. '$**注意:**内容$',
  92. '```md',
  93. '**注意:**内容',
  94. '```',
  95. '**普通**内容',
  96. '*普通*内容',
  97. ].join('\n\n')
  98. const { container } = render(<MarkdownText text={source} />)
  99. expect([...container.querySelectorAll('strong')].map(node => node.textContent)).toEqual(['普通'])
  100. expect([...container.querySelectorAll('em')].map(node => node.textContent)).toEqual(['普通'])
  101. expect(container.querySelector('code')?.textContent).toBe('**注意:**内容')
  102. expect(container.querySelector('.katex annotation')?.textContent).toBe('**注意:**内容')
  103. expect(container.querySelector('pre code')?.textContent).toContain('**注意:**内容')
  104. expect(container.textContent).toContain('**Notice:**text')
  105. expect(container.textContent).toContain('*提醒!*继续')
  106. expect(container.textContent).toContain('**注意:**内容')
  107. })
  108. it('links complete HTTP(S) inline code without promoting commands, unsafe schemes, or fences', () => {
  109. const localUrl = 'http://127.0.0.1:3199/?demo=1'
  110. const remoteUrl = 'https://example.com/preview?q=one%20two#result'
  111. const source = [
  112. `\`${localUrl}\``,
  113. `\`${remoteUrl}\``,
  114. '`curl http://127.0.0.1:3199/?demo=1`',
  115. '`javascript:alert(1)`',
  116. '`mailto:dev@example.com`',
  117. `\` ${localUrl} \``,
  118. '```',
  119. localUrl,
  120. '```',
  121. ].join('\n\n')
  122. const { container } = render(<MarkdownText text={source} />)
  123. const links = screen.getAllByRole('link')
  124. expect(links.map(link => link.getAttribute('href'))).toEqual([localUrl, remoteUrl])
  125. for (const link of links) {
  126. expect(link.closest('code')).not.toBeNull()
  127. expect(link.getAttribute('target')).toBe('_blank')
  128. expect(link.getAttribute('rel')).toBe('noopener noreferrer')
  129. }
  130. links[0]?.focus()
  131. expect(document.activeElement).toBe(links[0])
  132. expect(screen.getByText('curl http://127.0.0.1:3199/?demo=1').closest('a')).toBeNull()
  133. expect(screen.getByText('javascript:alert(1)').closest('a')).toBeNull()
  134. expect(screen.getByText('mailto:dev@example.com').closest('a')).toBeNull()
  135. const paddedCode = [...container.querySelectorAll('code')]
  136. .find(code => code.textContent === ` ${localUrl} `)
  137. expect(paddedCode?.querySelector('a')).toBeNull()
  138. expect(container.querySelector('pre code a')).toBeNull()
  139. })
  140. it('exposes the CJK strong syntax as a micromark extension needing CommonMark attention markers', () => {
  141. const extension = cjkFriendlyStrong()
  142. expect(cjkFriendlyStrong()).toBe(extension)
  143. const construct = extension.text?.[42]
  144. const tokenizer = Array.isArray(construct) ? construct[0]?.tokenize : construct?.tokenize
  145. expect(tokenizer).toBeTypeOf('function')
  146. expect(() => tokenizer?.call({
  147. parser: { constructs: { attentionMarkers: {} } },
  148. previous: null,
  149. } as never, {} as never, () => undefined, () => undefined)).toThrow(
  150. 'micromark CommonMark attention markers are unavailable',
  151. )
  152. })
  153. it('a fence labeled with an inherited object key renders plain, never crashing shiki', () => {
  154. for (const label of ['constructor', '__proto__', 'toString', 'hasOwnProperty']) {
  155. const { container, unmount } = render(<MarkdownText text={'```' + label + '\ncode body\n```'} />)
  156. expect(container.querySelector('pre.shiki')).toBeNull()
  157. expect(container.querySelector('pre code')?.textContent).toContain('code body')
  158. unmount()
  159. }
  160. })
  161. it('an empty fence keeps the stock pre; a language-less fence renders the plain CodeBlock arm', () => {
  162. const empty = render(<MarkdownText text={'```\n```'} />)
  163. expect(empty.container.querySelector('pre')?.outerHTML).toBe('<pre><code></code></pre>')
  164. const plain = render(<MarkdownText text={'```\nno language here\n```'} />)
  165. expect(plain.container.querySelector('pre.shiki')).toBeNull()
  166. expect(plain.container.querySelector('pre code')?.textContent).toContain('no language here')
  167. })
  168. it('streaming renders fences plain; the finalize swap highlights them', () => {
  169. const fence = '```ts\nconst answer = 42\n```'
  170. const live = render(<MarkdownText text={fence} streaming />)
  171. expect(live.container.querySelector('pre.shiki')).toBeNull()
  172. expect(live.container.querySelector('pre code')?.textContent).toContain('const answer = 42')
  173. live.unmount()
  174. const done = render(<MarkdownText text={fence} />)
  175. expect(done.container.querySelector('pre.shiki')).not.toBeNull()
  176. })
  177. it('forwards localized labels to fenced code blocks', () => {
  178. render(<MarkdownText text={'```ts\nconst answer = 42\n```'} codeLabels={{ copyLabel: 'Copy code', copiedLabel: 'Copied' }} />)
  179. expect(screen.getByRole('button', { name: 'Copy code' })).toBeTruthy()
  180. })
  181. it('renders absolute HTTP(S) images with bounded presentation', () => {
  182. const markdown = [
  183. '![secure diagram](https://example.com/secure.png)',
  184. '![plain diagram](http://example.com/plain.png)',
  185. ].join('\n\n')
  186. const { container } = render(<MarkdownText text={markdown} />)
  187. const images = [...container.querySelectorAll('img')]
  188. expect(images.map(image => image.getAttribute('src'))).toEqual([
  189. 'https://example.com/secure.png',
  190. 'http://example.com/plain.png',
  191. ])
  192. for (const image of images) {
  193. expect(image.getAttribute('loading')).toBe('lazy')
  194. expect(image.getAttribute('decoding')).toBe('async')
  195. expect(image.getAttribute('referrerpolicy')).toBe('no-referrer')
  196. }
  197. })
  198. it('neutralizes raw HTML, unsafe or relative links, and unsupported images', () => {
  199. const markdown = [
  200. '<script>globalThis.compromised = true</script>',
  201. '<img src="x" onerror="globalThis.compromised = true">',
  202. '[script](javascript:alert(1)) [relative](/settings)',
  203. '[mail](mailto:dev@example.com) [web](http://example.com) [upper](HTTPS://example.com)',
  204. '![relative diagram](private.png)',
  205. '![absolute diagram](/workspace/private.png)',
  206. '![file diagram](file:///workspace/private.png)',
  207. '![script diagram](javascript:alert(1))',
  208. '![mail diagram](mailto:dev@example.com)',
  209. ].join('\n\n')
  210. const { container } = render(<MarkdownText text={markdown} />)
  211. expect(container.querySelector('script')).toBeNull()
  212. expect(container.querySelector('img')).toBeNull()
  213. const neutralized = [...container.querySelectorAll('p')]
  214. .find(paragraph => paragraph.textContent === 'script relative')
  215. expect(neutralized?.querySelector('a')).toBeNull()
  216. expect(screen.getByRole('link', { name: 'mail' }).getAttribute('target')).toBeNull()
  217. expect(screen.getByRole('link', { name: 'web' }).getAttribute('rel')).toBe('noopener noreferrer')
  218. expect(screen.getByRole('link', { name: 'upper' }).getAttribute('target')).toBe('_blank')
  219. expect(screen.getByText('relative diagram')).toBeTruthy()
  220. expect(screen.getByText('absolute diagram')).toBeTruthy()
  221. expect(screen.getByText('file diagram')).toBeTruthy()
  222. expect(screen.getByText('script diagram')).toBeTruthy()
  223. expect(screen.getByText('mail diagram')).toBeTruthy()
  224. })
  225. it('keeps incomplete streaming Markdown renderable', () => {
  226. const { container } = render(<MarkdownText text={'## Streaming\n\n- first\n- **unfinished'} />)
  227. expect(screen.getByRole('heading', { level: 2, name: 'Streaming' })).toBeTruthy()
  228. expect(container.querySelectorAll('li')).toHaveLength(2)
  229. expect(screen.getByText('**unfinished')).toBeTruthy()
  230. })
  231. it('renders inline and display TeX through KaTeX without enabling trusted commands', () => {
  232. const source = [
  233. 'Einstein wrote $E = mc^2$.',
  234. '',
  235. '$$',
  236. '\\frac{\\partial \\mathbf{u}}{\\partial t} + (\\mathbf{u} \\cdot \\nabla)\\mathbf{u} = -\\frac{1}{\\rho}\\nabla p',
  237. '$$',
  238. '',
  239. '$\\href{javascript:alert(1)}{unsafe}$',
  240. ].join('\n')
  241. const { container } = render(<MarkdownText text={source} />)
  242. expect(container.querySelectorAll('.katex')).toHaveLength(3)
  243. expect(container.querySelectorAll('.katex-display')).toHaveLength(1)
  244. expect(container.querySelector('.katex-display annotation')?.textContent).toContain('\\frac{\\partial \\mathbf{u}}')
  245. expect(container.querySelector('a')).toBeNull()
  246. })
  247. it('renders common TeX delimiters and same-line tagged display blocks after the reply settles', () => {
  248. const source = [
  249. 'Inline dollar $\\theta$ and backslash \\(\\frac{1}{5}\\).',
  250. '',
  251. '\\[\\frac{\\pi}{4} < \\theta < \\frac{\\pi}{2}\\]',
  252. '',
  253. '$$\\theta \\in \\left(\\frac{\\pi}{4}, \\frac{\\pi}{2}\\right). \\tag{1}$$',
  254. '',
  255. '| Symbol | Value |',
  256. '| --- | --- |',
  257. '| $\\theta$ | \\(\\frac{1}{5}\\) |',
  258. ].join('\n')
  259. const { container } = render(<MarkdownText text={source} />)
  260. expect(container.querySelectorAll('.katex')).toHaveLength(6)
  261. expect(container.querySelectorAll('.katex-display')).toHaveLength(2)
  262. expect(container.querySelector('.katex-display annotation')?.textContent).toContain('\\frac{\\pi}{4}')
  263. expect([...container.querySelectorAll('.katex-display')].at(-1)?.querySelector('annotation')?.textContent)
  264. .toContain('\\tag{1}')
  265. expect(container.querySelector('.katex-error')).toBeNull()
  266. expect(container.querySelector('table .katex')).not.toBeNull()
  267. })
  268. it('keeps backslash delimiters correct across Markdown boundaries and malformed candidates', () => {
  269. const cases = [
  270. {
  271. source: '\\(\\alpha \\, \\beta\\)',
  272. math: 1,
  273. display: 0,
  274. },
  275. {
  276. source: String.raw`\\\(x\)`,
  277. math: 1,
  278. display: 0,
  279. value: 'x',
  280. },
  281. {
  282. source: '\\(\\frac{1}{5}\n+\\frac{1}{7}\\)',
  283. math: 1,
  284. display: 0,
  285. value: '\\frac{1}{5}\n+\\frac{1}{7}',
  286. },
  287. {
  288. source: '\\[a\\\\\nb\\]',
  289. math: 1,
  290. display: 1,
  291. value: 'a\\\\\nb',
  292. },
  293. {
  294. source: '> \\[\n> \\frac{1}{5}\n> \\]',
  295. math: 1,
  296. display: 1,
  297. },
  298. {
  299. source: '- \\[\n \\frac{1}{5}\n \\]',
  300. math: 1,
  301. display: 1,
  302. },
  303. ]
  304. for (const item of cases) {
  305. const rendered = render(<MarkdownText text={item.source} />)
  306. expect(rendered.container.querySelectorAll('.katex')).toHaveLength(item.math)
  307. expect(rendered.container.querySelectorAll('.katex-display')).toHaveLength(item.display)
  308. expect(rendered.container.querySelector('.katex-error')).toBeNull()
  309. if ('value' in item) {
  310. expect(rendered.container.querySelector('annotation')?.textContent).toBe(item.value)
  311. }
  312. rendered.unmount()
  313. }
  314. const literal = render(<MarkdownText text={'\\\\(x\\)\n\n\\[x'} />)
  315. expect(literal.container.querySelectorAll('.katex')).toHaveLength(0)
  316. expect(literal.container.querySelector('.katex-display')).toBeNull()
  317. expect(literal.container.textContent).toContain('[x')
  318. })
  319. it('keeps ordinary dollar blocks and incomplete delimiter candidates parseable', () => {
  320. const cases = [
  321. { source: '$$\n\\theta\n$$', math: 1, display: 1 },
  322. { source: '$$$\\theta$$$', math: 1, display: 0 },
  323. { source: '$$a$b\nc', math: 0, display: 0 },
  324. { source: ' \\[\n \\theta\n \\]', math: 1, display: 1 },
  325. { source: '\\(\\theta', math: 0, display: 0 },
  326. { source: String.raw`\(a\\)`, math: 0, display: 0 },
  327. { source: '\\[\n\\[', math: 0, display: 0 },
  328. { source: '> \\[\nnot a quoted continuation\n\\]', math: 0, display: 0 },
  329. ]
  330. for (const item of cases) {
  331. const rendered = render(<MarkdownText text={item.source} />)
  332. expect(rendered.container.querySelectorAll('.katex')).toHaveLength(item.math)
  333. expect(rendered.container.querySelectorAll('.katex-display')).toHaveLength(item.display)
  334. expect(rendered.container.querySelector('.katex-error')).toBeNull()
  335. rendered.unmount()
  336. }
  337. })
  338. it('lets display math interrupt an open paragraph', () => {
  339. for (const source of ['Prose line\n\\[x\\]', 'Prose line\n$$x$$']) {
  340. const rendered = render(<MarkdownText text={source} />)
  341. expect(rendered.container.querySelectorAll('p')).toHaveLength(1)
  342. expect(rendered.container.querySelectorAll('.katex-display')).toHaveLength(1)
  343. rendered.unmount()
  344. }
  345. })
  346. it('leaves a dollar block with trailing text to upstream inline math', () => {
  347. const { container } = render(<MarkdownText text="$$x$$ trailing" />)
  348. expect(container.querySelectorAll('.katex')).toHaveLength(1)
  349. expect(container.querySelector('.katex-display')).toBeNull()
  350. expect(container.querySelector('annotation')?.textContent).toBe('x')
  351. expect(container.textContent).toContain('trailing')
  352. })
  353. it('renders escaped dollars and even backslash pairs before closing fences', () => {
  354. const source = [
  355. String.raw`$$100\$$$`,
  356. '',
  357. String.raw`\(a\\\)`,
  358. '',
  359. String.raw`\[b\\\]`,
  360. ].join('\n')
  361. const { container } = render(<MarkdownText text={source} />)
  362. const values = [...container.querySelectorAll('annotation')].map(node => node.textContent)
  363. expect(values).toEqual([String.raw`100\$`, String.raw`a\\`, String.raw`b\\`])
  364. expect(container.querySelector('.katex-error')).toBeNull()
  365. })
  366. it('bounds fallback work for repeated unclosed backslash delimiters', () => {
  367. const startedAt = performance.now()
  368. const { container } = render(<MarkdownText text={'\\(x '.repeat(6_400)} />)
  369. expect(performance.now() - startedAt).toBeLessThan(1_000)
  370. expect(container.querySelector('.katex')).toBeNull()
  371. })
  372. it('leaves TeX-looking fenced code literal', () => {
  373. const source = '```tex\n\\[\\frac{1}{5}\\]\n$$x \\tag{1}$$\n```'
  374. const { container } = render(<MarkdownText text={source} />)
  375. expect(container.querySelector('.katex')).toBeNull()
  376. expect(container.querySelector('pre code')?.textContent).toContain('\\[\\frac{1}{5}\\]')
  377. expect(container.querySelector('pre code')?.textContent).toContain('$$x \\tag{1}$$')
  378. })
  379. it('exposes the compatibility syntax as a micromark extension', () => {
  380. const extension = mathCompatibility()
  381. expect(Object.keys(extension)).toEqual(['flow', 'text'])
  382. expect(mathCompatibility()).toBe(extension)
  383. })
  384. it('defers TeX rendering while streaming so incomplete formulas never flash KaTeX errors', () => {
  385. const partial = '$$\n\\frac{\\partial \\mathbf{u}}{\\partial'
  386. const complete = '$$\n\\frac{\\partial \\mathbf{u}}{\\partial t}\n$$'
  387. const live = render(<MarkdownText text={partial} streaming />)
  388. expect(live.container.querySelector('.katex')).toBeNull()
  389. expect(live.container.querySelector('.katex-error')).toBeNull()
  390. expect(live.container.textContent).toContain('\\frac{\\partial \\mathbf{u}}{\\partial')
  391. live.rerender(<MarkdownText text={complete} />)
  392. expect(live.container.querySelectorAll('.katex')).toHaveLength(1)
  393. expect(live.container.querySelectorAll('.katex-display')).toHaveLength(1)
  394. expect(live.container.querySelector('.katex-error')).toBeNull()
  395. })
  396. })
  397. describe('JsonBlock', () => {
  398. it('collapsed by default; toggle reveals pretty-printed payload', () => {
  399. render(<JsonBlock label="args" payload={{ a: 1 }} />)
  400. expect(screen.queryByText(/"a": 1/)).toBeNull()
  401. fireEvent.click(screen.getByRole('button', { name: /args/ }))
  402. expect(screen.getByText(/"a": 1/)).toBeDefined()
  403. fireEvent.click(screen.getByRole('button', { name: /args/ }))
  404. expect(screen.queryByText(/"a": 1/)).toBeNull()
  405. })
  406. it('defaultOpen renders the body immediately', () => {
  407. const { container } = render(<JsonBlock label="args" payload={[1, 2]} defaultOpen />)
  408. expect(container.querySelector('pre')?.textContent).toContain('1')
  409. })
  410. it('stringifies undefined payloads via String()', () => {
  411. const { container } = render(<JsonBlock label="x" payload={undefined} defaultOpen />)
  412. expect(container.querySelector('pre')?.textContent).toBe('undefined')
  413. })
  414. it('falls back to String() for circular payloads', () => {
  415. const circular: { self?: unknown } = {}
  416. circular.self = circular
  417. const { container } = render(<JsonBlock label="x" payload={circular} defaultOpen />)
  418. expect(container.querySelector('pre')?.textContent).toBe('[object Object]')
  419. })
  420. it('truncates beyond the size cap with a suffix note', () => {
  421. const big = 'x'.repeat(30_000)
  422. const { container } = render(<JsonBlock label="x" payload={big} defaultOpen />)
  423. const body = container.querySelector('pre')!.textContent
  424. expect(body.length).toBeLessThan(30_000)
  425. expect(body).toContain('截断')
  426. })
  427. })