Fix pre-initialization UI error state capture #20529
Merged
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
Gudahtt
commented
Aug 18, 2023
| @@ -31,7 +31,6 @@ export default class ReadOnlyNetworkStore { | |||
| const response = await fetchWithTimeout(FIXTURE_SERVER_URL); | |||
| if (response.ok) { | |||
| this._state = await response.json(); | |||
| this.mostRecentRetrievedState = this._state; | |||
There was a problem hiding this comment.
This is why the test had passed earlier when it should have failed: this property was set too early, before the first read. In production it's only set upon read.
Gudahtt
force-pushed
the
fix-ui-pre-initialization-errors
branch
from
90e2751 to
37c93da
Compare
Gudahtt
commented
Aug 18, 2023
| @@ -100,6 +94,9 @@ const openMetamaskTabsIDs = {}; | |||
| const requestAccountTabIds = {}; | |||
| let controller; | |||
|
|
|||
| // state persistence | |||
In the case where an error is thrown in the UI before initialization has finished, we aren't capturing the application state correctly for Sentry errors. We had a test case for this, but the test case was broken due to a mistake in how the `network-store` was setup (it was not matching the behavior of the real `local-tstore` module). The pre-initialization state capture logic was updated to rely solely upon the `localStore` instance used by Sentry to determine whether the user had opted-in to metrics or not. This simplifies the logic a great deal, removing the need for the `getMostRecentPersistedState` state hook. It also ensures that state is captured corretly pre- initialization in both the background and UI.
Gudahtt
force-pushed
the
fix-ui-pre-initialization-errors
branch
from
37c93da to
185ab6d
Compare
Gudahtt
added
release-blocker
danjm
reviewed
Aug 18, 2023
Codecov Report
@@ Coverage Diff @@
## develop #20529 +/- ##
========================================
Coverage 68.66% 68.66%
========================================
Files 991 991
Lines 38467 38465 -2
Branches 10333 10333
========================================
Hits 26411 26411
+ Misses 12056 12054 -2
|
Builds ready [185ab6d]
Page Load Metrics (2122 ± 124 ms)
Bundle size diffs [🚀 Bundle size reduced!]
|
darkwing
approved these changes
Aug 18, 2023
metamaskbot
added
the
release-10.36.0
Gudahtt
added
release-10.34.5
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Explanation
In the case where an error is thrown in the UI before initialization has finished, we aren't capturing the application state correctly for Sentry errors. We had a test case for this, but the test case was broken due to a mistake in how the
network-storewas setup (it was not matching the behavior of the reallocal-tstoremodule).The pre-initialization state capture logic was updated to rely solely upon the
localStoreinstance used by Sentry to determine whether the user had opted-in to metrics or not. This simplifies the logic a great deal, removing the need for thegetMostRecentPersistedStatestate hook. It also ensures that state is captured corretly pre- initialization in both the background and UI.Manual Testing Steps
Update
ui/index.jsto throw an error during initialization (but after thegetMostRecentPersistedStatehook was setup, if testing ondevelop). Ondevelop, you'll see that the resulting error doesn't include Sentry state, even though it was meant to. On this PR it will include the state in the error report.Alternatively you could do what the e2e test does and wait until after initialization, but "emulate" a pre-initialization state by deleting the
getSentryAppStatestate hook. Then you can more easily trigger an error by callingwindow.stateHooks.throwTestError(). Again, you should see the same result (ondevelopthe state will be missing, but on this PR it will be present).Pre-merge author checklist
Pre-merge reviewer checklist
If further QA is required (e.g. new feature, complex testing steps, large refactor), add the
Extension QA Boardlabel.In this case, a QA Engineer approval will be be required.