mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-26 12:29:06 +01:00
ddeaeb5ba5
Sentry breadcrumb collection during initialization was broken in #20529 because we failed to consider that the `getSentryState` check was also used for an opt-in check in the `beforeBreadcrumb` hook. I had assumed that `getSentryState` was only used to get state to add additional context to an error report. But the function has a second purpose: to get state for the purposes of checking whether the user has opted into MetaMetrics. In this second case, `mostRecentRetrievedState` is sometimes unset (which violates an assumption made in #20529) The `getMostRecentPersistedState` hook removed in #20529 has been restored, ensuring that the `getSentryState` function returns Sentry state after loading state for the first time, but before the first error has occurred. This mistake didn't cause e2e tests to fail because multiple errors are currently thrown in the background upon initialization on `develop` (relating to Snow scuttling). These errors were early enough that they happened before the console logs that our breadcrumb test was testing for. When #20529 was ported onto the v10.34.5 RC, these errors were not present so the test failed correctly.
77 lines
2.6 KiB
JavaScript
77 lines
2.6 KiB
JavaScript
import { maskObject } from '../../../shared/modules/object.utils';
|
|
import ExtensionPlatform from '../platforms/extension';
|
|
import LocalStore from './local-store';
|
|
import ReadOnlyNetworkStore from './network-store';
|
|
import { SENTRY_BACKGROUND_STATE } from './setupSentry';
|
|
|
|
const platform = new ExtensionPlatform();
|
|
|
|
// This instance of `localStore` is used by Sentry to get the persisted state
|
|
const sentryLocalStore = process.env.IN_TEST
|
|
? new ReadOnlyNetworkStore()
|
|
: new LocalStore();
|
|
|
|
/**
|
|
* Get the persisted wallet state.
|
|
*
|
|
* @returns The persisted wallet state.
|
|
*/
|
|
globalThis.stateHooks.getPersistedState = async function () {
|
|
return await sentryLocalStore.get();
|
|
};
|
|
|
|
const persistedStateMask = {
|
|
data: SENTRY_BACKGROUND_STATE,
|
|
meta: {
|
|
version: true,
|
|
},
|
|
};
|
|
|
|
/**
|
|
* Get a state snapshot for Sentry. This is used to add additional context to
|
|
* error reports, and it's used when processing errors and breadcrumbs to
|
|
* determine whether the user has opted into Metametrics.
|
|
*
|
|
* This uses the persisted state pre-initialization, and the in-memory state
|
|
* post-initialization. In both cases the state is anonymized.
|
|
*
|
|
* @returns A Sentry state snapshot.
|
|
*/
|
|
globalThis.stateHooks.getSentryState = function () {
|
|
const sentryState = {
|
|
browser: window.navigator.userAgent,
|
|
version: platform.getVersion(),
|
|
};
|
|
// If `getSentryAppState` is set, it implies that initialization has completed
|
|
if (globalThis.stateHooks.getSentryAppState) {
|
|
return {
|
|
...sentryState,
|
|
state: globalThis.stateHooks.getSentryAppState(),
|
|
};
|
|
} else if (
|
|
// This is truthy if Sentry has retrieved state at least once already. This
|
|
// should always be true when getting context for an error report, but can
|
|
// be unset when Sentry is performing the opt-in check.
|
|
sentryLocalStore.mostRecentRetrievedState ||
|
|
// This is only set in the background process.
|
|
globalThis.stateHooks.getMostRecentPersistedState
|
|
) {
|
|
const persistedState =
|
|
sentryLocalStore.mostRecentRetrievedState ||
|
|
globalThis.stateHooks.getMostRecentPersistedState();
|
|
// This can be unset when this method is called in the background for an
|
|
// opt-in check, but the state hasn't been loaded yet.
|
|
if (persistedState) {
|
|
return {
|
|
...sentryState,
|
|
persistedState: maskObject(persistedState, persistedStateMask),
|
|
};
|
|
}
|
|
}
|
|
// This branch means that local storage has not yet been read, so we have
|
|
// no choice but to omit the application state.
|
|
// This should be unreachable when getting context for an error report, but
|
|
// can be false when Sentry is performing the opt-in check.
|
|
return sentryState;
|
|
};
|