Addon-Interactions: Use ansi-to-html for colored test errors #29110
Conversation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit e693dcd. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
5 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings
| @@ -135,7 +136,7 @@ export const Exception = ({ exception }: { exception: Call['exception'] }) => { | |||
| const more = paragraphs.length > 1; | |||
| return ( | |||
| <RowMessage> | |||
| <pre>{paragraphs[0]}</pre> | |||
| <pre dangerouslySetInnerHTML={{ __html: filter.toHtml(paragraphs[0]) }}></pre> | |||
There was a problem hiding this comment.
style: Consider wrapping this in a try/catch block to handle potential errors from filter.toHtml
| <span | ||
| key={line + index} | ||
| dangerouslySetInnerHTML={{ __html: filter.toHtml(line) }} | ||
| ></span>, |
There was a problem hiding this comment.
logic: Using dangerouslySetInnerHTML could pose XSS risks. Ensure input is properly sanitized
| export function createAnsiToHtmlFilter(theme: StorybookTheme) { | ||
| return new Filter({ | ||
| fg: theme.color.defaultText, | ||
| bg: theme.background.content, | ||
| }); |
There was a problem hiding this comment.
style: Ensure this function is memoized if called frequently to avoid unnecessary Filter instance creation
| export function useAnsiToHtmlFilter() { | ||
| const theme = useTheme(); | ||
| return createAnsiToHtmlFilter(theme); | ||
| } |
There was a problem hiding this comment.
style: Consider memoizing this hook to prevent unnecessary re-renders
kasperpeulen
added
the
patch:yes
Closes #
What I did
Use ansi-to-html for colored test errors
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>Greptile Summary
This PR introduces ANSI to HTML conversion for colored test errors in the Storybook Interactions addon, enhancing the readability of error messages and test outputs.
code/addons/interactions/package.jsonuseAnsiToHtmlFilterutility function incode/addons/interactions/src/utils.tsInteraction,InteractionsPanel, andMatcherResultcomponentsdangerouslySetInnerHTMLinMatcherResult.tsx