Repository navigation
feat: Substitute variables in markdown tiles #3246
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
354145d
feat: Substitute variables in markdown tiles
pulpdrew 00c6d45
feat: Show warning when markdown tile references unknown variable
pulpdrew 36f6c0d
chore: Add markdown variables to MCP
pulpdrew a903a5a
feat: Exclude irrelevant variable format from completions
pulpdrew d961e96
review: Review feedback
pulpdrew 30ceb88
Merge branch 'main' into drew/variables-markdown-mcp
kodiakhq[bot] 832e069
Merge branch 'main' into drew/variables-markdown-mcp
kodiakhq[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| '@hyperdx/common-utils': patch | ||
| '@hyperdx/app': patch | ||
| '@hyperdx/api': patch | ||
| --- | ||
|
|
||
| feat: Substitute dashboard variables in markdown tiles |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| import React from 'react'; | ||
| import { screen } from '@testing-library/react'; | ||
|
|
||
| import HDXMarkdownChart from '@/HDXMarkdownChart'; | ||
|
|
||
| const service = { name: 'service', values: ['api', 'web'] }; | ||
|
|
||
| describe('HDXMarkdownChart', () => { | ||
| it('substitutes variable references', () => { | ||
| renderWithMantine( | ||
| <HDXMarkdownChart | ||
| config={{ markdown: '# Services: $service' }} | ||
| variables={[service]} | ||
| />, | ||
| ); | ||
| expect(screen.getByText('# Services: api, web')).toBeInTheDocument(); | ||
|
pulpdrew marked this conversation as resolved.
Resolved
|
||
| }); | ||
|
|
||
| it('renders the markdown as written without variables', () => { | ||
| renderWithMantine( | ||
| <HDXMarkdownChart config={{ markdown: '# Services: $service' }} />, | ||
| ); | ||
| expect(screen.getByText('# Services: $service')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('renders the markdown as written when a format is unknown', () => { | ||
| renderWithMantine( | ||
| <HDXMarkdownChart | ||
| config={{ markdown: '${service:nope}' }} | ||
| variables={[service]} | ||
| />, | ||
| ); | ||
| expect(screen.getByText('${service:nope}')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('flags a reference to an unknown variable', () => { | ||
| renderWithMantine( | ||
| <HDXMarkdownChart | ||
| config={{ markdown: '$service $nope' }} | ||
| variables={[service]} | ||
| />, | ||
| ); | ||
| expect(screen.getByTestId('variable-validation')).toHaveAccessibleName( | ||
| 'Markdown references unknown variable $nope. Available variables: service.', | ||
| ); | ||
| }); | ||
|
|
||
| it('checks references against the available names when given', () => { | ||
| renderWithMantine( | ||
| <HDXMarkdownChart | ||
| config={{ markdown: '$service $env' }} | ||
| variables={[service]} | ||
| availableVariableNames={['service', 'env']} | ||
| />, | ||
| ); | ||
| expect(screen.queryByTestId('variable-validation')).not.toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('flags nothing when every reference is known', () => { | ||
| renderWithMantine( | ||
| <HDXMarkdownChart | ||
| config={{ markdown: '$service' }} | ||
| variables={[service]} | ||
| />, | ||
| ); | ||
| expect(screen.queryByTestId('variable-validation')).not.toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('flags nothing without variables', () => { | ||
| renderWithMantine(<HDXMarkdownChart config={{ markdown: '$nope' }} />); | ||
| expect(screen.queryByTestId('variable-validation')).not.toBeInTheDocument(); | ||
| }); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔵 minor — MCP warns about
$wordprose in markdown even when the dashboard has no variablesHDXMarkdownChartdeliberately skips validation when!variables?.length, because nothing is substituted and$HOMEor$PATHin a runbook note is just prose.getTileVariableWarningsstill validates against[], so every markdown tile with a$wordgets 'unknown variable … Available variables: (none)'. Skip the markdown validation whenvariables.length === 0so it matches the UI.Advisory. Fix if it is a small defect in code this PR changes; otherwise reply in the thread. Do not widen the PR or touch files it did not already change. How to respond