Addon-Interactions: Use ansi-to-html for colored test errors #29110
Conversation
This file contains 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
☁️ 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
Comment on lines
+137
to
+140
| <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
Comment on lines
+29
to
+33
| 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
Comment on lines
+36
to
+39
| 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
21 tasks
kasperpeulen
added
the
patch:yes
storybook-bot
pushed a commit
that referenced
this pull request
Sep 25, 2024
Addon-Interactions: Use ansi-to-html for colored test errors (cherry picked from commit 1d27f37)
Merged
4 tasks
storybook-bot
pushed a commit
that referenced
this pull request
Sep 25, 2024
Addon-Interactions: Use ansi-to-html for colored test errors (cherry picked from commit 1d27f37)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 26, 2024
Addon-Interactions: Use ansi-to-html for colored test errors (cherry picked from commit 1d27f37)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 26, 2024
Addon-Interactions: Use ansi-to-html for colored test errors (cherry picked from commit 1d27f37)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 27, 2024
Addon-Interactions: Use ansi-to-html for colored test errors (cherry picked from commit 1d27f37)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 27, 2024
Addon-Interactions: Use ansi-to-html for colored test errors (cherry picked from commit 1d27f37)
github-actions
bot
added
the
patch:done
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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