|
1 | | -import { memo } from 'react'; |
| 1 | +import { memo, useMemo } from 'react'; |
2 | 2 | import ReactMarkdown from 'react-markdown'; |
| 3 | +import { ChartVariable } from '@hyperdx/common-utils/dist/types'; |
| 4 | +import { |
| 5 | + substituteVariables, |
| 6 | + validateVariableReferencesInTemplate, |
| 7 | +} from '@hyperdx/common-utils/dist/variables'; |
3 | 8 |
|
4 | 9 | import ChartContainer from './components/charts/ChartContainer'; |
| 10 | +import { |
| 11 | + hasVariableIssues, |
| 12 | + VariableIssueIndicator, |
| 13 | +} from './components/SQLEditor/variableValidation'; |
5 | 14 |
|
6 | 15 | const HDXMarkdownChart = memo( |
7 | 16 | ({ |
8 | 17 | config: { markdown }, |
9 | 18 | title, |
10 | 19 | toolbarItems, |
| 20 | + variables: referencedVariables, |
| 21 | + availableVariableNames, |
11 | 22 | }: { |
12 | 23 | title?: React.ReactNode; |
13 | 24 | toolbarItems?: React.ReactNode[]; |
14 | 25 | config: { |
15 | 26 | markdown?: string; |
16 | 27 | }; |
| 28 | + /** The variables to substitute. Limited to the ones this chart references. */ |
| 29 | + variables?: ChartVariable[]; |
| 30 | + /** Every variable name in scope, for flagging unknown references. */ |
| 31 | + availableVariableNames?: string[]; |
17 | 32 | }) => { |
| 33 | + const content = useMemo(() => { |
| 34 | + if (!markdown || referencedVariables == null) return markdown ?? ''; |
| 35 | + try { |
| 36 | + return substituteVariables(markdown, { |
| 37 | + variables: referencedVariables, |
| 38 | + inputLanguage: 'markdown', |
| 39 | + }); |
| 40 | + } catch { |
| 41 | + // An unknown `${name:format}` throws; show the markdown as written. |
| 42 | + return markdown; |
| 43 | + } |
| 44 | + }, [markdown, referencedVariables]); |
| 45 | + |
| 46 | + const toolbar = useMemo(() => { |
| 47 | + const names = |
| 48 | + availableVariableNames ?? |
| 49 | + referencedVariables?.map(variable => variable.name); |
| 50 | + |
| 51 | + // Without variables in scope nothing is substituted, so a `$word` is prose. |
| 52 | + if (!markdown || !names?.length) return toolbarItems; |
| 53 | + |
| 54 | + // Only names are checked for markdown, so the selections don't matter. |
| 55 | + const allVariables = names.map(name => ({ name, values: [] })); |
| 56 | + const issues = validateVariableReferencesInTemplate( |
| 57 | + markdown, |
| 58 | + allVariables, |
| 59 | + { |
| 60 | + subject: 'Markdown', |
| 61 | + language: 'markdown', |
| 62 | + }, |
| 63 | + ); |
| 64 | + if (!hasVariableIssues(issues)) return toolbarItems; |
| 65 | + |
| 66 | + return [ |
| 67 | + <VariableIssueIndicator key="variable-issues" issues={issues} />, |
| 68 | + ...(toolbarItems ?? []), |
| 69 | + ]; |
| 70 | + }, [markdown, availableVariableNames, referencedVariables, toolbarItems]); |
| 71 | + |
18 | 72 | return ( |
19 | 73 | <ChartContainer |
20 | 74 | title={title} |
21 | | - toolbarItems={toolbarItems} |
| 75 | + toolbarItems={toolbar} |
22 | 76 | disableReactiveContainer |
23 | 77 | > |
24 | 78 | <div className="hdx-markdown"> |
25 | | - <ReactMarkdown>{markdown ?? ''}</ReactMarkdown> |
| 79 | + <ReactMarkdown>{content}</ReactMarkdown> |
26 | 80 | </div> |
27 | 81 | </ChartContainer> |
28 | 82 | ); |
|
0 commit comments