mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-23 01:39:44 +01:00
b874a301f5
* capture exception for sentry when invariant conditions are met in migration 82 * Code cleanup * Capture exceptions in invariant conditions for migrations 83,84,85,86,89,91,93,94 * Update app/scripts/migrations/082.test.js Co-authored-by: Mark Stacey <markjstacey@gmail.com> * Code cleanup * Fix SentryObject type declaration * Stop throwing error if preferences controller is undefined * Refactor 084 and 086 to remove double negative * Capture exceptions for invariant states in in migrations 87,88,90 and 92 * lint fix * log warning in migration 82 when preferences controller is undefined --------- Co-authored-by: Mark Stacey <markjstacey@gmail.com>
120 lines
3.6 KiB
TypeScript
120 lines
3.6 KiB
TypeScript
import { cloneDeep } from 'lodash';
|
|
import { hasProperty, isObject } from '@metamask/utils';
|
|
import { v4 } from 'uuid';
|
|
import log from 'loglevel';
|
|
|
|
export const version = 82;
|
|
|
|
/**
|
|
* Migrate the frequentRpcListDetail from the PreferencesController to the NetworkController, convert it from an array to an object
|
|
* keyed by random uuids.
|
|
*
|
|
* @param originalVersionedData - Versioned MetaMask extension state, exactly what we persist to dist.
|
|
* @param originalVersionedData.meta - State metadata.
|
|
* @param originalVersionedData.meta.version - The current state version.
|
|
* @param originalVersionedData.data - The persisted MetaMask state, keyed by controller.
|
|
* @returns Updated versioned MetaMask extension state.
|
|
*/
|
|
export async function migrate(originalVersionedData: {
|
|
meta: { version: number };
|
|
data: Record<string, unknown>;
|
|
}) {
|
|
const versionedData = cloneDeep(originalVersionedData);
|
|
versionedData.meta.version = version;
|
|
versionedData.data = transformState(versionedData.data);
|
|
return versionedData;
|
|
}
|
|
|
|
function transformState(state: Record<string, unknown>) {
|
|
if (!hasProperty(state, 'PreferencesController')) {
|
|
log.warn(`state.PreferencesController is undefined`);
|
|
return state;
|
|
}
|
|
if (!isObject(state.PreferencesController)) {
|
|
global.sentry?.captureException?.(
|
|
new Error(
|
|
`typeof state.PreferencesController is ${typeof state.PreferencesController}`,
|
|
),
|
|
);
|
|
return state;
|
|
}
|
|
if (
|
|
!hasProperty(state, 'NetworkController') ||
|
|
!isObject(state.NetworkController)
|
|
) {
|
|
global.sentry?.captureException?.(
|
|
new Error(
|
|
`typeof state.NetworkController is ${typeof state.NetworkController}`,
|
|
),
|
|
);
|
|
return state;
|
|
}
|
|
if (
|
|
!hasProperty(state.PreferencesController, 'frequentRpcListDetail') ||
|
|
!Array.isArray(state.PreferencesController.frequentRpcListDetail)
|
|
) {
|
|
const inPost077SupplementFor082State =
|
|
state.NetworkController.networkConfigurations &&
|
|
state.PreferencesController.frequentRpcListDetail === undefined;
|
|
if (!inPost077SupplementFor082State) {
|
|
global.sentry?.captureException?.(
|
|
new Error(
|
|
`typeof state.PreferencesController.frequentRpcListDetail is ${typeof state
|
|
.PreferencesController.frequentRpcListDetail}`,
|
|
),
|
|
);
|
|
}
|
|
return state;
|
|
}
|
|
if (!state.PreferencesController.frequentRpcListDetail.every(isObject)) {
|
|
const erroneousElement =
|
|
state.PreferencesController.frequentRpcListDetail.find(
|
|
(element) => !isObject(element),
|
|
);
|
|
global.sentry?.captureException?.(
|
|
new Error(
|
|
`state.PreferencesController.frequentRpcListDetail contains an element of type ${typeof erroneousElement}`,
|
|
),
|
|
);
|
|
return state;
|
|
}
|
|
const { PreferencesController, NetworkController } = state;
|
|
const { frequentRpcListDetail } = PreferencesController;
|
|
if (!Array.isArray(frequentRpcListDetail)) {
|
|
return state;
|
|
}
|
|
|
|
const networkConfigurations = frequentRpcListDetail.reduce(
|
|
(
|
|
networkConfigurationsAcc,
|
|
{ rpcUrl, chainId, ticker, nickname, rpcPrefs },
|
|
) => {
|
|
const networkConfigurationId = v4();
|
|
return {
|
|
...networkConfigurationsAcc,
|
|
[networkConfigurationId]: {
|
|
rpcUrl,
|
|
chainId,
|
|
ticker,
|
|
rpcPrefs,
|
|
nickname,
|
|
},
|
|
};
|
|
},
|
|
{},
|
|
);
|
|
|
|
delete PreferencesController.frequentRpcListDetail;
|
|
|
|
return {
|
|
...state,
|
|
NetworkController: {
|
|
...NetworkController,
|
|
networkConfigurations,
|
|
},
|
|
PreferencesController: {
|
|
...PreferencesController,
|
|
},
|
|
};
|
|
}
|