Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Remove invalid providerConfig id #26310

Merged
merged 3 commits into from
Aug 2, 2024
Merged

fix: Remove invalid providerConfig id #26310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e15952f
fix: Remove invalid providerConfig ids
Gudahtt Aug 2, 2024
4ce3bc9
Use optional chain operator for global Sentry access
Gudahtt Aug 2, 2024
90c5763
Add undefined providerConfig check
Gudahtt Aug 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
173 changes: 172 additions & 1 deletion app/scripts/migrations/120.2.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,9 +250,105 @@ describe('migration #120.2', () => {
);
});

it('does nothing if obsolete properties are not set', async () => {
it('captures an error and leaves state unchanged if providerConfig state is corrupted', async () => {
const oldState = {
NetworkController: {
providerConfig: 'invalid',
},
};

const transformedState = await migrate({
meta: { version: oldVersion },
data: cloneDeep(oldState),
});

expect(transformedState.data).toEqual(oldState);
expect(sentryCaptureExceptionMock).toHaveBeenCalledWith(
new Error(
`Migration ${version}: Invalid NetworkController providerConfig state of type 'string'`,
),
);
});

it('captures an error and leaves state unchanged if networkConfigurations state is corrupted', async () => {
const oldState = {
NetworkController: {
networkConfigurations: 'invalid',
providerConfig: {},
},
};

const transformedState = await migrate({
meta: { version: oldVersion },
data: cloneDeep(oldState),
});

expect(transformedState.data).toEqual(oldState);
expect(sentryCaptureExceptionMock).toHaveBeenCalledWith(
new Error(
`Migration ${version}: Invalid NetworkController networkConfigurations state of type 'string'`,
),
);
});

it('does nothing if obsolete properties and providerConfig are not set', async () => {
const oldState = {
NetworkController: {
selectedNetworkClientId: 'example',
},
};

const transformedState = await migrate({
meta: { version: oldVersion },
data: cloneDeep(oldState),
});

expect(transformedState.data).toEqual(oldState);
});

it('does nothing if obsolete properties are not set and providerConfig is set to undefined', async () => {
const oldState = {
NetworkController: {
// This should be impossible because `undefined` cannot be returned from persisted state,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I discovered this when investigating this test failure: https://github.com/MetaMask/metamask-extension/actions/runs/10216054639/job/28266703200

// it's not valid JSON. But a bug in migration 14 ends up setting this to `undefined`.
providerConfig: undefined,
selectedNetworkClientId: 'example',
},
};

const transformedState = await migrate({
meta: { version: oldVersion },
data: cloneDeep(oldState),
});

expect(transformedState.data).toEqual(oldState);
});

it('does nothing if obsolete properties and providerConfig id are not set', async () => {
const oldState = {
NetworkController: {
providerConfig: {},
selectedNetworkClientId: 'example',
},
};

const transformedState = await migrate({
meta: { version: oldVersion },
data: cloneDeep(oldState),
});

expect(transformedState.data).toEqual(oldState);
});

it('does not remove a valid providerConfig id', async () => {
const oldState = {
NetworkController: {
networkConfigurations: {
'valid-id': {},
},
providerConfig: {
id: 'valid-id',
},
selectedNetworkClientId: 'example',
},
};
Expand Down Expand Up @@ -289,6 +385,81 @@ describe('migration #120.2', () => {
});
});

it('removes providerConfig id if network configuration is missing', async () => {
const oldState = {
NetworkController: {
providerConfig: {
id: 'invalid-id',
},
selectedNetworkClientId: 'example',
},
};

const transformedState = await migrate({
meta: { version: oldVersion },
data: cloneDeep(oldState),
});

expect(transformedState.data.NetworkController).toEqual({
providerConfig: {},
selectedNetworkClientId: 'example',
});
});

it('removes providerConfig id that does not match any network configuration', async () => {
const oldState = {
NetworkController: {
networkConfigurations: {
'valid-id': {},
},
providerConfig: {
id: 'invalid-id',
},
selectedNetworkClientId: 'example',
},
};

const transformedState = await migrate({
meta: { version: oldVersion },
data: cloneDeep(oldState),
});

expect(transformedState.data.NetworkController).toEqual({
networkConfigurations: {
'valid-id': {},
},
providerConfig: {},
selectedNetworkClientId: 'example',
});
});

it('removes providerConfig id with an invalid type', async () => {
const oldState = {
NetworkController: {
networkConfigurations: {
'123': {},
},
providerConfig: {
id: 123,
},
selectedNetworkClientId: 'example',
},
};

const transformedState = await migrate({
meta: { version: oldVersion },
data: cloneDeep(oldState),
});

expect(transformedState.data.NetworkController).toEqual({
networkConfigurations: {
'123': {},
},
providerConfig: {},
selectedNetworkClientId: 'example',
});
});

it('still migrates NetworkController state if other controllers have invalid state', async () => {
const oldState = {
NetworkController: {
Expand Down
52 changes: 50 additions & 2 deletions app/scripts/migrations/120.2.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { cloneDeep } from 'lodash';
import { hasProperty, isObject } from '@metamask/utils';
import log from 'loglevel';

type VersionedData = {
meta: { version: number };
Expand Down Expand Up @@ -40,7 +41,7 @@ function removeObsoleteSnapControllerState(
if (!hasProperty(state, 'SnapController')) {
return;
} else if (!isObject(state.SnapController)) {
global.sentry.captureException(
global.sentry?.captureException?.(
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updating these to follow the convention in other migrations of not assuming this global is set. It should always be set in production, but one of the migrator tests doesn't set it and can blow up here.

Discovered while investigating this test failure:
https://github.com/MetaMask/metamask-extension/actions/runs/10216054639/job/28266703200

new Error(
`Migration ${version}: Invalid SnapController state of type '${typeof state.SnapController}'`,
),
Expand Down Expand Up @@ -93,7 +94,7 @@ function removeObsoleteNetworkControllerState(
if (!hasProperty(state, 'NetworkController')) {
return;
} else if (!isObject(state.NetworkController)) {
global.sentry.captureException(
global.sentry?.captureException?.(
new Error(
`Migration ${version}: Invalid NetworkController state of type '${typeof state.NetworkController}'`,
),
Expand All @@ -103,6 +104,53 @@ function removeObsoleteNetworkControllerState(

const networkControllerState = state.NetworkController;

// Check for invalid `providerConfig.id`, and remove if found
if (
hasProperty(networkControllerState, 'providerConfig') &&
// This should be impossible because `undefined` cannot be returned from persisted state,
// it's not valid JSON. But a bug in migration 14 ends up setting this to `undefined`.
networkControllerState.providerConfig !== undefined
) {
if (!isObject(networkControllerState.providerConfig)) {
global.sentry?.captureException?.(
new Error(
`Migration ${version}: Invalid NetworkController providerConfig state of type '${typeof state
.NetworkController.providerConfig}'`,
),
);
return;
}
const { providerConfig } = networkControllerState;

const validNetworkConfigurationIds = [];
if (hasProperty(networkControllerState, 'networkConfigurations')) {
if (!isObject(networkControllerState.networkConfigurations)) {
global.sentry?.captureException?.(
new Error(
`Migration ${version}: Invalid NetworkController networkConfigurations state of type '${typeof networkControllerState.networkConfigurations}'`,
),
);
return;
}

validNetworkConfigurationIds.push(
...Object.keys(networkControllerState.networkConfigurations),
);
}

if (hasProperty(providerConfig, 'id')) {
if (
typeof providerConfig.id !== 'string' ||
!validNetworkConfigurationIds.includes(providerConfig.id)
) {
log.warn(
`Migration ${version}: Removing invalid provider id ${providerConfig.id}`,
);
delete providerConfig.id;
}
}
}

delete networkControllerState.networkDetails;
delete networkControllerState.networkId;
delete networkControllerState.networkStatus;
Expand Down