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: Network controller race condition after state update #5122

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix: Network controller race condition after state update #5122

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c3ebf62
rix race
bergeron Jan 9, 2025
ee9ffa9
remove .only
bergeron Jan 9, 2025
4b650b8
update test
bergeron Jan 13, 2025
8a52867
Merge branch 'main' into brian/network-controller-race-condition
bergeron Jan 13, 2025
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
21 changes: 6 additions & 15 deletions packages/network-controller/src/NetworkController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import type { Hex } from '@metamask/utils';
import { hasProperty, isPlainObject, isStrictHexString } from '@metamask/utils';
import deepEqual from 'fast-deep-equal';
import type { Draft } from 'immer';
import { cloneDeep } from 'lodash';
import type { Logger } from 'loglevel';
import { createSelector } from 'reselect';
import * as URI from 'uri-js';
Expand Down Expand Up @@ -1636,11 +1637,6 @@ export class NetworkController extends BaseController<
});
});

this.#networkConfigurationsByNetworkClientId =
buildNetworkConfigurationsByNetworkClientId(
this.state.networkConfigurationsByChainId,
);

this.messagingSystem.publish(
`${controllerName}:networkAdded`,
newNetworkConfiguration,
Expand Down Expand Up @@ -1919,11 +1915,6 @@ export class NetworkController extends BaseController<
});
}

this.#networkConfigurationsByNetworkClientId =
buildNetworkConfigurationsByNetworkClientId(
this.state.networkConfigurationsByChainId,
);

this.#unregisterNetworkClientsAsNeeded({
networkClientOperations,
autoManagedNetworkClientRegistry,
Expand Down Expand Up @@ -1983,11 +1974,6 @@ export class NetworkController extends BaseController<
});
});

this.#networkConfigurationsByNetworkClientId =
buildNetworkConfigurationsByNetworkClientId(
this.state.networkConfigurationsByChainId,
);

this.messagingSystem.publish(
'NetworkController:networkRemoved',
existingNetworkConfiguration,
Expand Down Expand Up @@ -2500,6 +2486,11 @@ export class NetworkController extends BaseController<
state.networkConfigurationsByChainId[args.networkFields.chainId] =
args.networkConfigurationToPersist;
}

this.#networkConfigurationsByNetworkClientId =
buildNetworkConfigurationsByNetworkClientId(
cloneDeep(state.networkConfigurationsByChainId),
);
}

/**
Expand Down
58 changes: 58 additions & 0 deletions packages/network-controller/tests/NetworkController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11338,6 +11338,64 @@ describe('NetworkController', () => {
});
});
});

it('allows calling `getNetworkConfigurationByNetworkClientId` when subscribing to state changes containing new endpoints', async () => {
const network = buildCustomNetworkConfiguration({
chainId: '0x1' as Hex,
name: 'mainnet',
nativeCurrency: 'ETH',
blockExplorerUrls: [],
defaultRpcEndpointIndex: 0,
rpcEndpoints: [
{
type: RpcEndpointType.Custom,
url: 'https://test.endpoint/1',
networkClientId: 'client1',
},
],
});

await withController(
{
state: {
selectedNetworkClientId: 'client1',
networkConfigurationsByChainId: { '0x1': network },
},
},
async ({ controller, messenger }) => {
// Verify we can call `getNetworkConfigurationByNetworkClientId` with the new endpoint
const stateChangePromise = new Promise<void>((resolve, reject) => {
messenger.subscribe('NetworkController:stateChange', (state) => {
const { networkClientId } =
state.networkConfigurationsByChainId['0x1'].rpcEndpoints[1];

const networkConfiguration =
controller.getNetworkConfigurationByNetworkClientId(
networkClientId,
);

networkConfiguration
? resolve()
: reject(`networkClient ${networkClientId} not found`);
});
bergeron marked this conversation as resolved.
Show resolved Hide resolved
});

// Add a new endpoint
await controller.updateNetwork('0x1', {
...network,
rpcEndpoints: [
...network.rpcEndpoints,
{
type: RpcEndpointType.Custom,
url: 'https://test.endpoint/2',
},
],
});

await stateChangePromise;
},
);
});
});

describe('removeNetwork', () => {
Expand Down
Loading