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>
320 lines
8.6 KiB
JavaScript
320 lines
8.6 KiB
JavaScript
import { v4 } from 'uuid';
|
|
import { migrate, version } from './083';
|
|
|
|
const sentryCaptureExceptionMock = jest.fn();
|
|
|
|
global.sentry = {
|
|
captureException: sentryCaptureExceptionMock,
|
|
};
|
|
|
|
jest.mock('uuid', () => {
|
|
const actual = jest.requireActual('uuid');
|
|
|
|
return {
|
|
...actual,
|
|
v4: jest.fn(),
|
|
};
|
|
});
|
|
|
|
describe('migration #83', () => {
|
|
beforeEach(() => {
|
|
v4.mockImplementationOnce(() => 'network-configuration-id-1')
|
|
.mockImplementationOnce(() => 'network-configuration-id-2')
|
|
.mockImplementationOnce(() => 'network-configuration-id-3')
|
|
.mockImplementationOnce(() => 'network-configuration-id-4');
|
|
});
|
|
|
|
afterEach(() => {
|
|
jest.resetAllMocks();
|
|
});
|
|
it('should update the version metadata', async () => {
|
|
const oldStorage = {
|
|
meta: {
|
|
version: 82,
|
|
},
|
|
data: {},
|
|
};
|
|
|
|
const newStorage = await migrate(oldStorage);
|
|
expect(newStorage.meta).toStrictEqual({
|
|
version,
|
|
});
|
|
});
|
|
|
|
it('should use the key of the networkConfigurations object to set the id of each network configuration', async () => {
|
|
const oldStorage = {
|
|
meta: {
|
|
version,
|
|
},
|
|
data: {
|
|
NetworkController: {
|
|
networkConfigurations: {
|
|
'network-configuration-id-1': {
|
|
chainId: '0x539',
|
|
nickname: 'Localhost 8545',
|
|
rpcPrefs: {},
|
|
rpcUrl: 'http://localhost:8545',
|
|
ticker: 'ETH',
|
|
},
|
|
'network-configuration-id-2': {
|
|
chainId: '0xa4b1',
|
|
nickname: 'Arbitrum One',
|
|
rpcPrefs: {
|
|
blockExplorerUrl: 'https://explorer.arbitrum.io',
|
|
},
|
|
rpcUrl:
|
|
'https://arbitrum-mainnet.infura.io/v3/373266a93aab4acda48f89d4fe77c748',
|
|
ticker: 'ETH',
|
|
},
|
|
'network-configuration-id-3': {
|
|
chainId: '0x4e454152',
|
|
nickname: 'Aurora Mainnet',
|
|
rpcPrefs: {
|
|
blockExplorerUrl: 'https://aurorascan.dev/',
|
|
},
|
|
rpcUrl:
|
|
'https://aurora-mainnet.infura.io/v3/373266a93aab4acda48f89d4fe77c748',
|
|
ticker: 'Aurora ETH',
|
|
},
|
|
'network-configuration-id-4': {
|
|
chainId: '0x38',
|
|
nickname:
|
|
'BNB Smart Chain (previously Binance Smart Chain Mainnet)',
|
|
rpcPrefs: {
|
|
blockExplorerUrl: 'https://bscscan.com/',
|
|
},
|
|
rpcUrl: 'https://bsc-dataseed.binance.org/',
|
|
ticker: 'BNB',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
};
|
|
|
|
const newStorage = await migrate(oldStorage);
|
|
|
|
const expectedNewStorage = {
|
|
meta: {
|
|
version,
|
|
},
|
|
data: {
|
|
NetworkController: {
|
|
networkConfigurations: {
|
|
'network-configuration-id-1': {
|
|
chainId: '0x539',
|
|
nickname: 'Localhost 8545',
|
|
rpcPrefs: {},
|
|
rpcUrl: 'http://localhost:8545',
|
|
ticker: 'ETH',
|
|
id: 'network-configuration-id-1',
|
|
},
|
|
'network-configuration-id-2': {
|
|
chainId: '0xa4b1',
|
|
nickname: 'Arbitrum One',
|
|
rpcPrefs: {
|
|
blockExplorerUrl: 'https://explorer.arbitrum.io',
|
|
},
|
|
rpcUrl:
|
|
'https://arbitrum-mainnet.infura.io/v3/373266a93aab4acda48f89d4fe77c748',
|
|
ticker: 'ETH',
|
|
id: 'network-configuration-id-2',
|
|
},
|
|
'network-configuration-id-3': {
|
|
chainId: '0x4e454152',
|
|
nickname: 'Aurora Mainnet',
|
|
rpcPrefs: {
|
|
blockExplorerUrl: 'https://aurorascan.dev/',
|
|
},
|
|
rpcUrl:
|
|
'https://aurora-mainnet.infura.io/v3/373266a93aab4acda48f89d4fe77c748',
|
|
ticker: 'Aurora ETH',
|
|
id: 'network-configuration-id-3',
|
|
},
|
|
'network-configuration-id-4': {
|
|
chainId: '0x38',
|
|
nickname:
|
|
'BNB Smart Chain (previously Binance Smart Chain Mainnet)',
|
|
rpcPrefs: {
|
|
blockExplorerUrl: 'https://bscscan.com/',
|
|
},
|
|
rpcUrl: 'https://bsc-dataseed.binance.org/',
|
|
ticker: 'BNB',
|
|
id: 'network-configuration-id-4',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
};
|
|
expect(newStorage).toStrictEqual(expectedNewStorage);
|
|
});
|
|
|
|
it('should not modify state if state.NetworkController is undefined', async () => {
|
|
const oldStorage = {
|
|
meta: {
|
|
version,
|
|
},
|
|
data: {
|
|
testProperty: 'testValue',
|
|
},
|
|
};
|
|
|
|
const newStorage = await migrate(oldStorage);
|
|
|
|
const expectedNewStorage = {
|
|
meta: {
|
|
version,
|
|
},
|
|
data: {
|
|
testProperty: 'testValue',
|
|
},
|
|
};
|
|
expect(newStorage).toStrictEqual(expectedNewStorage);
|
|
});
|
|
|
|
it('should capture an exception if state.NetworkController is undefined', async () => {
|
|
const oldStorage = {
|
|
meta: {
|
|
version,
|
|
},
|
|
data: {
|
|
testProperty: 'testValue',
|
|
},
|
|
};
|
|
|
|
await migrate(oldStorage);
|
|
|
|
expect(sentryCaptureExceptionMock).toHaveBeenCalledTimes(1);
|
|
expect(sentryCaptureExceptionMock).toHaveBeenCalledWith(
|
|
new Error(`typeof state.NetworkController is undefined`),
|
|
);
|
|
});
|
|
|
|
it('should not modify state if state.NetworkController is not an object', async () => {
|
|
const oldStorage = {
|
|
meta: {
|
|
version,
|
|
},
|
|
data: {
|
|
NetworkController: false,
|
|
testProperty: 'testValue',
|
|
},
|
|
};
|
|
|
|
const newStorage = await migrate(oldStorage);
|
|
|
|
const expectedNewStorage = {
|
|
meta: {
|
|
version,
|
|
},
|
|
data: {
|
|
NetworkController: false,
|
|
testProperty: 'testValue',
|
|
},
|
|
};
|
|
expect(newStorage).toStrictEqual(expectedNewStorage);
|
|
});
|
|
|
|
it('should capture an exception if state.NetworkController is not an object', async () => {
|
|
const oldStorage = {
|
|
meta: {
|
|
version,
|
|
},
|
|
data: {
|
|
NetworkController: false,
|
|
testProperty: 'testValue',
|
|
},
|
|
};
|
|
|
|
await migrate(oldStorage);
|
|
|
|
expect(sentryCaptureExceptionMock).toHaveBeenCalledTimes(1);
|
|
expect(sentryCaptureExceptionMock).toHaveBeenCalledWith(
|
|
new Error(`typeof state.NetworkController is boolean`),
|
|
);
|
|
});
|
|
|
|
it('should not modify state if state.NetworkController.networkConfigurations is undefined', async () => {
|
|
const oldStorage = {
|
|
meta: {
|
|
version,
|
|
},
|
|
data: {
|
|
NetworkController: {
|
|
testNetworkControllerProperty: 'testNetworkControllerValue',
|
|
networkConfigurations: undefined,
|
|
},
|
|
testProperty: 'testValue',
|
|
},
|
|
};
|
|
|
|
const newStorage = await migrate(oldStorage);
|
|
|
|
const expectedNewStorage = {
|
|
meta: {
|
|
version,
|
|
},
|
|
data: {
|
|
NetworkController: {
|
|
testNetworkControllerProperty: 'testNetworkControllerValue',
|
|
networkConfigurations: undefined,
|
|
},
|
|
testProperty: 'testValue',
|
|
},
|
|
};
|
|
expect(newStorage).toStrictEqual(expectedNewStorage);
|
|
});
|
|
|
|
it('should capture an exception if state.NetworkController.networkConfigurations is undefined', async () => {
|
|
const oldStorage = {
|
|
meta: {
|
|
version,
|
|
},
|
|
data: {
|
|
NetworkController: {
|
|
testNetworkControllerProperty: 'testNetworkControllerValue',
|
|
networkConfigurations: undefined,
|
|
},
|
|
testProperty: 'testValue',
|
|
},
|
|
};
|
|
|
|
await migrate(oldStorage);
|
|
|
|
expect(sentryCaptureExceptionMock).toHaveBeenCalledTimes(1);
|
|
expect(sentryCaptureExceptionMock).toHaveBeenCalledWith(
|
|
new Error(`typeof NetworkController.networkConfigurations is undefined`),
|
|
);
|
|
});
|
|
|
|
it('should not modify state if state.NetworkController.networkConfigurations is an empty object', async () => {
|
|
const oldStorage = {
|
|
meta: {
|
|
version,
|
|
},
|
|
data: {
|
|
NetworkController: {
|
|
testNetworkControllerProperty: 'testNetworkControllerValue',
|
|
networkConfigurations: {},
|
|
},
|
|
testProperty: 'testValue',
|
|
},
|
|
};
|
|
|
|
const newStorage = await migrate(oldStorage);
|
|
|
|
const expectedNewStorage = {
|
|
meta: {
|
|
version,
|
|
},
|
|
data: {
|
|
NetworkController: {
|
|
testNetworkControllerProperty: 'testNetworkControllerValue',
|
|
networkConfigurations: {},
|
|
},
|
|
testProperty: 'testValue',
|
|
},
|
|
};
|
|
expect(newStorage).toStrictEqual(expectedNewStorage);
|
|
});
|
|
});
|