Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

fix(web): lazy-load markdown chart and music renderers (#42840)

Stephen Zhoud3d3248e3be5
diff --git a/web/app/components/base/markdown-blocks/__tests__/code-block-load-error.spec.tsx b/web/app/components/base/markdown-blocks/__tests__/code-block-load-error.spec.tsx
new file mode 100644
index 00000000000..01983e05a76
--- /dev/null
+++ b/web/app/components/base/markdown-blocks/__tests__/code-block-load-error.spec.tsx
@@ -0,0 +1,24 @@
+import { render, screen } from '@testing-library/react'
+import { Theme } from '@/types/app'
+import { CodeBlock } from '../code-block'
+
+vi.mock('@/hooks/use-theme', () => ({ default: () => ({ theme: Theme.light }) }))
+vi.mock('echarts-for-react', () => {
+ throw new Error('Chart chunk unavailable')
+})
+vi.mock('../music', () => {
+ throw new Error('Music chunk unavailable')
+})
+
+it.each([
+ ['echarts', '{"series":[]}'],
+ ['abc', 'X:1\nK:C\nC D E F|'],
+])('contains a failed %s chunk within the code-block error boundary', async (language, content) => {
+ const consoleError = vi.spyOn(console, 'error').mockImplementation(() => {})
+ try {
+ render(<CodeBlock className={`language-${language}`}>{content}</CodeBlock>)
+ expect(await screen.findByText(/Oops! An error occurred/)).toBeInTheDocument()
+ } finally {
+ consoleError.mockRestore()
+ }
+})
diff --git a/web/app/components/base/markdown-blocks/__tests__/code-block-loading.spec.tsx b/web/app/components/base/markdown-blocks/__tests__/code-block-loading.spec.tsx
new file mode 100644
index 00000000000..ff3bebf4865
--- /dev/null
+++ b/web/app/components/base/markdown-blocks/__tests__/code-block-loading.spec.tsx
@@ -0,0 +1,86 @@
+import { act, render, screen, waitFor } from '@testing-library/react'
+import { Theme } from '@/types/app'
+import { CodeBlock } from '../code-block'
+
+const runtime = vi.hoisted(() => {
+ let resolve = () => undefined as void
+ const promise = new Promise<void>((done) => {
+ resolve = done
+ })
+ return {
+ chartLoaded: false,
+ musicLoaded: false,
+ renderMusic: vi.fn(() => [{}]),
+ loadControls: vi.fn(),
+ setTune: vi.fn(),
+ musicReady: { promise, resolve },
+ }
+})
+
+vi.mock('@/hooks/use-theme', () => ({ default: () => ({ theme: Theme.light }) }))
+vi.mock('../shiki-highlight', () => ({
+ highlightCode: async ({ code }: { code: string }) => <pre>{code}</pre>,
+}))
+vi.mock('echarts-for-react', () => {
+ runtime.chartLoaded = true
+ return {
+ default: ({ option }: { option: unknown }) => (
+ <div data-testid="chart">{JSON.stringify(option)}</div>
+ ),
+ }
+})
+vi.mock('abcjs', async () => {
+ runtime.musicLoaded = true
+ await runtime.musicReady.promise
+ return {
+ default: {
+ renderAbc: runtime.renderMusic,
+ synth: {
+ SynthController: class {
+ load = runtime.loadControls
+ setTune = runtime.setTune
+ },
+ CreateSynth: class {
+ init = () => Promise.resolve()
+ },
+ },
+ },
+ }
+})
+
+it('loads chart and music runtimes only when their code-block language is rendered', async () => {
+ const { rerender } = render(
+ <CodeBlock className="language-typescript">const answer = 42</CodeBlock>,
+ )
+ await waitFor(() => expect(screen.getByText('const answer = 42')).toBeInTheDocument())
+ expect(runtime.chartLoaded).toBe(false)
+ expect(runtime.musicLoaded).toBe(false)
+
+ rerender(<CodeBlock className="language-echarts">{'{"series":[]}'}</CodeBlock>)
+ expect(await screen.findByTestId('chart')).toHaveTextContent('{"series":[]}')
+ expect(runtime.chartLoaded).toBe(true)
+ expect(runtime.musicLoaded).toBe(false)
+
+ const score = 'X:1\nK:C\nC D E F|'
+ rerender(<CodeBlock className="language-abc">{score}</CodeBlock>)
+ await waitFor(() => expect(runtime.musicLoaded).toBe(true))
+ expect(runtime.renderMusic).not.toHaveBeenCalled()
+ // Streaming can continue while the renderer chunk is still loading.
+ const completeScore = `${score}\nG A B c|`
+ rerender(<CodeBlock className="language-abc">{completeScore}</CodeBlock>)
+ await act(async () => runtime.musicReady.resolve())
+ await waitFor(() =>
+ expect(runtime.renderMusic).toHaveBeenCalledWith(
+ expect.any(HTMLDivElement),
+ completeScore,
+ expect.objectContaining({ responsive: 'resize' }),
+ ),
+ )
+ expect(runtime.musicLoaded).toBe(true)
+ expect(runtime.loadControls).toHaveBeenCalledWith(
+ expect.any(HTMLDivElement),
+ {},
+ { displayPlay: true },
+ )
+ await waitFor(() => expect(runtime.setTune).toHaveBeenCalled())
+})
diff --git a/web/app/components/base/markdown-blocks/code-block.stories.tsx b/web/app/components/base/markdown-blocks/code-block.stories.tsx
index bcc763220e7..e6de236084e 100644
--- a/web/app/components/base/markdown-blocks/code-block.stories.tsx
+++ b/web/app/components/base/markdown-blocks/code-block.stories.tsx
@@ -44,6 +44,30 @@ type Story = StoryObj<typeof meta>
export const Playground: Story = {}
+export const ECharts: Story = {
+ render: () => (
+ <div className="w-xl">
+ <CodeBlock className="language-echarts">
+ {JSON.stringify({
+ xAxis: { type: 'category', data: ['A', 'B', 'C'] },
+ yAxis: { type: 'value' },
+ series: [{ type: 'bar', data: [12, 20, 15] }],
+ })}
+ </CodeBlock>
+ </div>
+ ),
+}
+
+export const Music: Story = {
+ render: () => (
+ <div className="w-xl">
+ <CodeBlock className="language-abc">
+ {'X:1\nT:Scale\nM:4/4\nL:1/4\nK:C\nC D E F|G A B c|'}
+ </CodeBlock>
+ </div>
+ ),
+}
+
export const Mermaid: Story = {
args: {
language: 'mermaid',
diff --git a/web/app/components/base/markdown-blocks/code-block.tsx b/web/app/components/base/markdown-blocks/code-block.tsx
index 273a178a3de..520267c74c0 100644
--- a/web/app/components/base/markdown-blocks/code-block.tsx
+++ b/web/app/components/base/markdown-blocks/code-block.tsx
@@ -2,10 +2,18 @@ import type { JSX } from 'react'
import type { BundledTheme } from 'shiki/bundle/web'
import { IconButton } from '@langgenius/dify-ui/icon-button'
import { Toggle } from '@langgenius/dify-ui/toggle'
-import ReactEcharts from 'echarts-for-react'
-import { memo, useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react'
+import {
+ lazy,
+ memo,
+ Suspense,
+ useCallback,
+ useEffect,
+ useLayoutEffect,
+ useMemo,
+ useRef,
+ useState,
+} from 'react'
import CopyIcon from '@/app/components/base/copy-icon'
-import MarkdownMusic from '@/app/components/base/markdown-blocks/music'
import ErrorBoundary from '@/app/components/base/markdown/error-boundary'
import useTheme from '@/hooks/use-theme'
import dynamic from '@/next/dynamic'
@@ -14,6 +22,9 @@ import SVGRenderer from '../svg-gallery' // Assumes svg-gallery.tsx is in /base
import { highlightCode } from './shiki-highlight'
const Flowchart = dynamic(() => import('@/app/components/base/mermaid'), { ssr: false })
+// React.lazy preserves the chart adapter's ref and loads each runtime only when rendered.
+const ReactEcharts = lazy(() => import('echarts-for-react'))
+const MarkdownMusic = lazy(() => import('./music'))
const capitalizationLanguageNameMap: Record<string, string> = {
sql: 'SQL',
@@ -561,7 +572,17 @@ export const CodeBlock: any = memo(({ inline, className, children = '', ...props
<CopyIcon content={String(children).replace(/\n$/, '')} />
</div>
</div>
- {renderCodeContent}
+ <Suspense
+ fallback={
+ <div
+ aria-busy="true"
+ className="animate-pulse rounded-b-[10px] bg-components-input-bg-normal"
+ style={{ minHeight: language === 'echarts' ? 350 : 96 }}
+ />
+ }
+ >
+ {renderCodeContent}
+ </Suspense>
</div>
)
})