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.

perf(web): lazy-load SVG code block previews (#42951)

Stephen Zhou51940eac9c15
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
index 01983e05a76..387dde55162 100644
--- 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
@@ -10,7 +10,12 @@ vi.mock('../music', () => {
throw new Error('Music chunk unavailable')
})
+vi.mock('../../svg-gallery', () => {
+ throw new Error('SVG chunk unavailable')
+})
+
it.each([
+ ['svg', '<svg/>'],
['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) => {
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
index ff3bebf4865..8fb6ce6a854 100644
--- 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
@@ -1,4 +1,5 @@
import { act, render, screen, waitFor } from '@testing-library/react'
+import userEvent from '@testing-library/user-event'
import { Theme } from '@/types/app'
import { CodeBlock } from '../code-block'
@@ -7,7 +8,13 @@ const runtime = vi.hoisted(() => {
const promise = new Promise<void>((done) => {
resolve = done
})
+ let resolveSVG = () => undefined as void
+ const svgPromise = new Promise<void>((done) => {
+ resolveSVG = done
+ })
return {
+ svgLoaded: false,
+ svgReady: { promise: svgPromise, resolve: resolveSVG },
chartLoaded: false,
musicLoaded: false,
renderMusic: vi.fn(() => [{}]),
@@ -29,6 +36,13 @@ vi.mock('echarts-for-react', () => {
),
}
})
+vi.mock('../../svg-gallery', async () => {
+ runtime.svgLoaded = true
+ await runtime.svgReady.promise
+ return {
+ default: ({ content }: { content: string }) => <div data-testid="svg-preview">{content}</div>,
+ }
+})
vi.mock('abcjs', async () => {
runtime.musicLoaded = true
await runtime.musicReady.promise
@@ -48,11 +62,13 @@ vi.mock('abcjs', async () => {
}
})
-it('loads chart and music runtimes only when their code-block language is rendered', async () => {
- const { rerender } = render(
+it('loads chart, music, and SVG runtimes only when their code-block language is rendered', async () => {
+ const user = userEvent.setup()
+ const { rerender, container } = render(
<CodeBlock className="language-typescript">const answer = 42</CodeBlock>,
)
await waitFor(() => expect(screen.getByText('const answer = 42')).toBeInTheDocument())
+ expect(runtime.svgLoaded).toBe(false)
expect(runtime.chartLoaded).toBe(false)
expect(runtime.musicLoaded).toBe(false)
@@ -83,4 +99,22 @@ it('loads chart and music runtimes only when their code-block language is render
{ displayPlay: true },
)
await waitFor(() => expect(runtime.setTune).toHaveBeenCalled())
+ expect(runtime.svgLoaded).toBe(false)
+
+ rerender(<CodeBlock className="language-svg">{'<svg>'}</CodeBlock>)
+ await waitFor(() => expect(runtime.svgLoaded).toBe(true))
+ expect(container.querySelector('[aria-busy="true"]')).toBeInTheDocument()
+ expect(screen.queryByTestId('svg-preview')).not.toBeInTheDocument()
+
+ const svg = '<svg><circle cx="50" cy="50" r="40" /></svg>'
+ rerender(<CodeBlock className="language-svg">{svg}</CodeBlock>)
+ await act(async () => runtime.svgReady.resolve())
+ expect(await screen.findByTestId('svg-preview')).toHaveTextContent(svg)
+ expect(container.querySelector('[aria-busy="true"]')).not.toBeInTheDocument()
+
+ const toggle = screen.getByRole('button', { name: 'SVG' })
+ await user.click(toggle)
+ expect(screen.queryByTestId('svg-preview')).not.toBeInTheDocument()
+ await user.click(toggle)
+ expect(await screen.findByTestId('svg-preview')).toHaveTextContent(svg)
})
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 e6de236084e..f711972b8e5 100644
--- a/web/app/components/base/markdown-blocks/code-block.stories.tsx
+++ b/web/app/components/base/markdown-blocks/code-block.stories.tsx
@@ -84,3 +84,15 @@ export const Mermaid: Story = {
</div>
),
}
+
+export const SVG: Story = {
+ render: () => (
+ <div className="w-xl">
+ <CodeBlock className="language-svg">
+ {
+ '<svg xmlns="http://www.w3.org/2000/svg" width="200" height="120"><circle cx="100" cy="60" r="50" fill="cornflowerblue" /></svg>'
+ }
+ </CodeBlock>
+ </div>
+ ),
+}
diff --git a/web/app/components/base/markdown-blocks/code-block.tsx b/web/app/components/base/markdown-blocks/code-block.tsx
index 66dff6bf68e..59a6f2c7da1 100644
--- a/web/app/components/base/markdown-blocks/code-block.tsx
+++ b/web/app/components/base/markdown-blocks/code-block.tsx
@@ -18,13 +18,13 @@ import CopyIcon from '@/app/components/base/copy-icon'
import ErrorBoundary from '@/app/components/base/markdown/error-boundary'
import useTheme from '@/hooks/use-theme'
import { Theme } from '@/types/app'
-import SVGRenderer from '../svg-gallery' // Assumes svg-gallery.tsx is in /base directory
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 SVGRenderer = lazy(() => import('../svg-gallery'))
const capitalizationLanguageNameMap: Record<string, string> = {
sql: 'SQL',