mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-29 15:50:28 +01:00
80746e67b5
* Improve Sentry state pre-initialization Previously the masked state snapshot sent to Sentry would be blank for errors that occured during initialization. Instead we'll now include some basic information in all cases, and a masked copy of the persisted state if it happens after the first time the persisted state is read. * Add test * Fix crash when persisted state not yet fetched * Add descriptions for initial state hooks * Update comments to reflect recent changes * Re-order imports to follow conventions * Move initial state hooks back to module-level The initial state hooks are now setup at the top-level of their module. This ensures that they're setup prior to later imports. Calling a function to setup these hooks in the entrypoint module wouldn't accomplish this even if it was run "before" the imports because ES6 imports always get hoisted to the top of the file. The `localStore` instance wasn't available statically, so a new state hook was introduced for retrieving the most recent retrieved persisted state. * Fix error e2e tests
62 lines
1.8 KiB
JavaScript
62 lines
1.8 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();
|
|
const localStore = 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 localStore.get();
|
|
};
|
|
|
|
const persistedStateMask = {
|
|
data: SENTRY_BACKGROUND_STATE,
|
|
meta: {
|
|
version: true,
|
|
},
|
|
};
|
|
|
|
/**
|
|
* Get a state snapshot to include with Sentry error reports. 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 (globalThis.stateHooks.getSentryAppState) {
|
|
return {
|
|
...sentryState,
|
|
state: globalThis.stateHooks.getSentryAppState(),
|
|
};
|
|
} else if (globalThis.stateHooks.getMostRecentPersistedState) {
|
|
const persistedState = globalThis.stateHooks.getMostRecentPersistedState();
|
|
if (persistedState) {
|
|
return {
|
|
...sentryState,
|
|
persistedState: maskObject(
|
|
// `getMostRecentPersistedState` is used here instead of
|
|
// `getPersistedState` to avoid making this an asynchronous function.
|
|
globalThis.stateHooks.getMostRecentPersistedState(),
|
|
persistedStateMask,
|
|
),
|
|
};
|
|
}
|
|
return sentryState;
|
|
}
|
|
return sentryState;
|
|
};
|