[AXON-41] Implement AtlascodeErrorBoundary #58
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
sdzh-atlassian
requested review from
bwieger-atlassian-com and
cabella-dot
as code owners
sdzh-atlassian
force-pushed
the
AXON-41-atlascode-error-boundary
branch
3 times, most recently
from
a092942 to
3865a53
Compare
* Add support to receive rendering error events from UI * Add AtlascodeErrorBoundary component * Put the new boundary to Settings page
sdzh-atlassian
force-pushed
the
AXON-41-atlascode-error-boundary
branch
from
3865a53 to
3a11fea
Compare
sdzh-atlassian
commented
Dec 24, 2024
| @@ -255,6 +256,13 @@ export async function viewScreenEvent( | |||
|
|
|||
| // UI Events | |||
|
|
|||
| export async function uiErrorEvent(errorInfo: UIErrorInfo): Promise<TrackEvent> { | |||
| const e = trackEvent('failedTest', 'ui', { | |||
There was a problem hiding this comment.
Intentionally leaving the temporary event here for now while we figure out a more permanent structure for events and metrics
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.
What is this?
This is the 1st PR in a series related to improving our observability when something goes wrong.
In React, there's a concept of an Error Boundary - a special component which is intended to address rendering errors in the tree, and which is very notably missing in our pages 😉
Further, we are already pulling @atlaskit/analytics-next as a dependency, which conveniently offers an implementation we could use.
After the changes in this PR, we can receive an event with some data on rendering errors occuring in prod:
What does this PR have, mechanically?
SendAnalyticsAtlascodeErrorBoundaryimplementation and usageWhat is notably NOT included here?
reactversionAtlascodeErrorBoundaryusage in other pages - to not overwhelm reviewers further ;DHow was this tested?
I've introduced the new error boundary to our
Settingspage, and then added a special component that fails on rendering. With that, when running our settings page, it was possible to show alternative HTML on render errors, while also receiving an event in the analityics service:(all the extra components were removed during clean-up)