Handle unexpected errors from the runChromaticBuild method (cli misconfigured, missing build commmand, etc) #132
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
…led by the onCompleteOrError method reports failure, but try-catch needed to handle gracefully
AP-3753 Storybook Server Crashes if there was an error running the CLI
When chromatic is misconfigured and a user attempts to run a build, when it fails it crashes the storybook-server. It properly displays a toast notification in the storybook ui, and it also logs the error from the cli, but the thrown error isn't caught, which causes the crash. A user reported this issue in the ext-visual-tests-addon channel. https://chromaticqa.slack.com/archives/C05LRPYU649/p1697204966240229 |
weeksling
commented
Oct 13, 2023
thafryer
approved these changes
Oct 13, 2023
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.
This is a quick fix to handle unexpected errors from the cli run method. The UI portion of the failure is handled by the onBuildProgressOrError, but the try-catch is necessary to prevent the server from crashing. Added a console.error to log the error that was caught, however this error is not as useful as the actual CLI logs. I felt it would be useful to keep in case an error occurs that the cli doesn't properly log for.