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

Jump to bottom

NetworkController: Remove providerConfigChange event #1329

Merged
merged 4 commits into from
May 5, 2023
Merged

NetworkController: Remove providerConfigChange event #1329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c11fb0a
NetworkController: Remove providerConfigChange event
mcmire May 4, 2023
0a9dad9
Merge branch 'main' into remove-provider-config-change-event
mcmire May 5, 2023
82797f8
Fix type error
mcmire May 5, 2023
14b3c55
Merge branch 'main' into remove-provider-config-change-event
mcmire May 5, 2023
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
7 changes: 2 additions & 5 deletions packages/assets-controllers/src/TokenDetectionController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import * as sinon from 'sinon';
import nock from 'nock';
import { BN } from 'ethereumjs-util';
import {
NetworkControllerProviderConfigChangeEvent,
NetworkControllerStateChangeEvent,
defaultState as defaultNetworkState,
NetworkState,
Expand Down Expand Up @@ -89,9 +88,7 @@ const sampleTokenB: Token = {

type MainControllerMessenger = ControllerMessenger<
GetTokenListState,
| TokenListStateChange
| NetworkControllerProviderConfigChangeEvent
| NetworkControllerStateChangeEvent
TokenListStateChange | NetworkControllerStateChangeEvent
>;

const getControllerMessenger = (): MainControllerMessenger => {
Expand All @@ -106,7 +103,7 @@ const setupTokenListController = (
allowedActions: [],
allowedEvents: [
'TokenListController:stateChange',
'NetworkController:providerConfigChange',
'NetworkController:stateChange',
],
});

Expand Down
101 changes: 70 additions & 31 deletions packages/assets-controllers/src/TokenListController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ import * as sinon from 'sinon';
import nock from 'nock';
import { ControllerMessenger } from '@metamask/base-controller';
import {
NetworkControllerProviderConfigChangeEvent,
NetworkControllerStateChangeEvent,
NetworkState,
NetworkStatus,
ProviderConfig,
} from '@metamask/network-controller';
import { NetworksChainId, NetworkType } from '@metamask/controller-utils';
Expand Down Expand Up @@ -474,7 +475,7 @@ const expiredCacheExistingState: TokenListState = {

type MainControllerMessenger = ControllerMessenger<
GetTokenListState,
TokenListStateChange | NetworkControllerProviderConfigChangeEvent
TokenListStateChange | NetworkControllerStateChangeEvent
>;

const getControllerMessenger = (): MainControllerMessenger => {
Expand All @@ -489,13 +490,35 @@ const getRestrictedMessenger = (
allowedActions: [],
allowedEvents: [
'TokenListController:stateChange',
'NetworkController:providerConfigChange',
'NetworkController:stateChange',
],
});

return messenger;
};

/**
* Builds an object that satisfies the NetworkState shape using the given
* provider config. This can be used to return a complete value for the
* `NetworkController:stateChange` event.
*
* @param providerConfig - The provider config to use.
* @returns A complete state object for NetworkController.
*/
function buildNetworkControllerStateWithProviderConfig(
providerConfig: ProviderConfig,
): NetworkState {
return {
providerConfig,
networkId: '1',
networkStatus: NetworkStatus.Available,
networkDetails: {
EIPS: {},
},
networkConfigurations: {},
};
}

describe('TokenListController', () => {
afterEach(() => {
nock.cleanAll();
Expand All @@ -519,7 +542,7 @@ describe('TokenListController', () => {

controller.destroy();
controllerMessenger.clearEventSubscriptions(
'NetworkController:providerConfigChange',
'NetworkController:stateChange',
);
});

Expand Down Expand Up @@ -568,7 +591,7 @@ describe('TokenListController', () => {

controller.destroy();
controllerMessenger.clearEventSubscriptions(
'NetworkController:providerConfigChange',
'NetworkController:stateChange',
);
});

Expand Down Expand Up @@ -613,9 +636,7 @@ describe('TokenListController', () => {

const controllerMessenger = getControllerMessenger();
const messenger = getRestrictedMessenger(controllerMessenger);
let onNetworkStateChangeCallback!: (
state: NetworkState | ProviderConfig,
) => void;
let onNetworkStateChangeCallback!: (state: NetworkState) => void;
const controller = new TokenListController({
chainId: NetworksChainId.mainnet,
onNetworkStateChange: (cb) => (onNetworkStateChangeCallback = cb),
Expand All @@ -628,10 +649,12 @@ describe('TokenListController', () => {
expect(controller.state.tokenList).toStrictEqual(
sampleSingleChainState.tokenList,
);
onNetworkStateChangeCallback({
chainId: NetworksChainId.goerli,
type: NetworkType.goerli,
});
onNetworkStateChangeCallback(
buildNetworkControllerStateWithProviderConfig({
chainId: NetworksChainId.goerli,
type: NetworkType.goerli,
}),
);
await new Promise<void>((resolve) => setTimeout(() => resolve(), 500));

expect(controller.state.tokenList).toStrictEqual({});
Expand Down Expand Up @@ -1019,10 +1042,14 @@ describe('TokenListController', () => {
sampleTwoChainState.tokensChainsCache[NetworksChainId.mainnet].data,
);

controllerMessenger.publish('NetworkController:providerConfigChange', {
type: NetworkType.goerli,
chainId: NetworksChainId.goerli,
});
controllerMessenger.publish(
'NetworkController:stateChange',
buildNetworkControllerStateWithProviderConfig({
type: NetworkType.goerli,
chainId: NetworksChainId.goerli,
}),
[],
);

await new Promise<void>((resolve) => setTimeout(() => resolve(), 500));

Expand All @@ -1033,11 +1060,15 @@ describe('TokenListController', () => {
sampleTwoChainState.tokensChainsCache[NetworksChainId.mainnet].data,
);

controllerMessenger.publish('NetworkController:providerConfigChange', {
type: NetworkType.rpc,
chainId: '56',
rpcUrl: 'http://localhost:8545',
});
controllerMessenger.publish(
'NetworkController:stateChange',
buildNetworkControllerStateWithProviderConfig({
type: NetworkType.rpc,
chainId: '56',
rpcUrl: 'http://localhost:8545',
}),
[],
);

await new Promise<void>((resolve) => setTimeout(() => resolve(), 500));
expect(controller.state.tokenList).toStrictEqual(
Expand Down Expand Up @@ -1094,10 +1125,14 @@ describe('TokenListController', () => {
interval: 100,
});
await controller.start();
controllerMessenger.publish('NetworkController:providerConfigChange', {
type: NetworkType.mainnet,
chainId: NetworksChainId.mainnet,
});
controllerMessenger.publish(
'NetworkController:stateChange',
buildNetworkControllerStateWithProviderConfig({
type: NetworkType.mainnet,
chainId: NetworksChainId.mainnet,
}),
[],
);

expect(controller.state).toStrictEqual({
tokenList: {},
Expand Down Expand Up @@ -1130,16 +1165,20 @@ describe('TokenListController', () => {
messenger.clearEventSubscriptions('TokenListController:stateChange');
controller.destroy();
controllerMessenger.clearEventSubscriptions(
'NetworkController:providerConfigChange',
'NetworkController:stateChange',
);
resolve();
});

controllerMessenger.publish('NetworkController:providerConfigChange', {
type: NetworkType.rpc,
chainId: '56',
rpcUrl: 'http://localhost:8545',
});
controllerMessenger.publish(
'NetworkController:stateChange',
buildNetworkControllerStateWithProviderConfig({
type: NetworkType.rpc,
chainId: '56',
rpcUrl: 'http://localhost:8545',
}),
[],
);
});
});
});
42 changes: 15 additions & 27 deletions packages/assets-controllers/src/TokenListController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@ import {
} from '@metamask/base-controller';
import { safelyExecute } from '@metamask/controller-utils';
import {
NetworkControllerProviderConfigChangeEvent,
NetworkControllerStateChangeEvent,
NetworkState,
ProviderConfig,
} from '@metamask/network-controller';
import {
isTokenListSupportedForNetwork,
Expand Down Expand Up @@ -62,10 +61,9 @@ export type GetTokenListState = {
type TokenListMessenger = RestrictedControllerMessenger<
typeof name,
GetTokenListState,
TokenListStateChange | NetworkControllerProviderConfigChangeEvent,
TokenListStateChange | NetworkControllerStateChangeEvent,
never,
| TokenListStateChange['type']
| NetworkControllerProviderConfigChangeEvent['type']
TokenListStateChange['type'] | NetworkControllerStateChangeEvent['type']
>;

const metadata = {
Expand Down Expand Up @@ -124,7 +122,7 @@ export class TokenListController extends BaseControllerV2<
chainId: string;
preventPollingOnNetworkRestart?: boolean;
onNetworkStateChange?: (
listener: (networkState: NetworkState | ProviderConfig) => void,
listener: (networkState: NetworkState) => void,
) => void;
interval?: number;
cacheRefreshThreshold?: number;
Expand All @@ -143,40 +141,30 @@ export class TokenListController extends BaseControllerV2<
this.updatePreventPollingOnNetworkRestart(preventPollingOnNetworkRestart);
this.abortController = new WhatwgAbortController();
if (onNetworkStateChange) {
onNetworkStateChange(async (networkStateOrProviderConfig) => {
// this check for "provider" is for testing purposes, since in the extension this callback will receive
// an object typed as NetworkState but within repo we can only simulate as if the callback receives an
// object typed as ProviderConfig
if ('providerConfig' in networkStateOrProviderConfig) {
await this.#onNetworkStateChangeCallback(
networkStateOrProviderConfig.providerConfig,
);
} else {
await this.#onNetworkStateChangeCallback(
networkStateOrProviderConfig,
);
}
onNetworkStateChange(async (networkControllerState) => {
await this.#onNetworkControllerStateChange(networkControllerState);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We can simulate a network controller state object in tests, so we don't need to make this check.

});
} else {
this.messagingSystem.subscribe(
'NetworkController:providerConfigChange',
async (providerConfig) => {
await this.#onNetworkStateChangeCallback(providerConfig);
'NetworkController:stateChange',
async (networkControllerState) => {
await this.#onNetworkControllerStateChange(networkControllerState);
},
);
}
}

/**
* Updates state and restart polling when updates are received through NetworkController subscription.
* Updates state and restarts polling on changes to the network controller
* state.
*
* @param providerConfig - the configuration for a provider containing critical network info.
* @param networkControllerState - The updated network controller state.
*/
async #onNetworkStateChangeCallback(providerConfig: ProviderConfig) {
if (this.chainId !== providerConfig.chainId) {
async #onNetworkControllerStateChange(networkControllerState: NetworkState) {
if (this.chainId !== networkControllerState.providerConfig.chainId) {
this.abortController.abort();
this.abortController = new WhatwgAbortController();
this.chainId = providerConfig.chainId;
this.chainId = networkControllerState.providerConfig.chainId;
if (this.state.preventPollingOnNetworkRestart) {
this.clearingTokenListData();
} else {
Expand Down
25 changes: 8 additions & 17 deletions packages/gas-fee-controller/src/GasFeeController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@ import * as sinon from 'sinon';
import { ControllerMessenger } from '@metamask/base-controller';
import {
NetworkController,
NetworkControllerGetEthQueryAction,
NetworkControllerGetProviderConfigAction,
NetworkControllerProviderConfigChangeEvent,
NetworkControllerGetStateAction,
NetworkControllerStateChangeEvent,
NetworkState,
} from '@metamask/network-controller';
import EthQuery from 'eth-query';
Expand Down Expand Up @@ -40,10 +39,8 @@ const mockedDetermineGasFeeCalculations =
const name = 'GasFeeController';

type MainControllerMessenger = ControllerMessenger<
| GetGasFeeState
| NetworkControllerGetProviderConfigAction
| NetworkControllerGetEthQueryAction,
GasFeeStateChange | NetworkControllerProviderConfigChangeEvent
GetGasFeeState | NetworkControllerGetStateAction,
GasFeeStateChange | NetworkControllerStateChangeEvent
>;

const getControllerMessenger = (): MainControllerMessenger => {
Expand All @@ -61,11 +58,8 @@ const setupNetworkController = async ({
}) => {
const restrictedMessenger = unrestrictedMessenger.getRestricted({
name: 'NetworkController',
allowedEvents: ['NetworkController:providerConfigChange'],
allowedActions: [
'NetworkController:getProviderConfig',
'NetworkController:getEthQuery',
],
allowedActions: ['NetworkController:getState'],
allowedEvents: ['NetworkController:stateChange'],
});

const networkController = new NetworkController({
Expand All @@ -89,11 +83,8 @@ const getRestrictedMessenger = (
) => {
const messenger = controllerMessenger.getRestricted({
name,
allowedActions: [
'NetworkController:getProviderConfig',
'NetworkController:getEthQuery',
],
allowedEvents: ['NetworkController:providerConfigChange'],
allowedActions: ['NetworkController:getState'],
allowedEvents: ['NetworkController:stateChange'],
});

return messenger;
Expand Down
Loading