Skip to content

Commit

Permalink
Update TokenDetectionController tests to not create networkController (…
Browse files Browse the repository at this point in the history 
…#1062)

**No NetworkController in tests**

**Description**:
Mocking the behaviour of the network controller makes the tests more
flexible, and lessens the burden of cleanup / maintainability of the
tests. This PR removes the `NetworkController` from the
`TokenDetectionController` tests.

partially fixes #1051

Co-authored-by: Mark Stacey <markjstacey@gmail.com>
  • Loading branch information
@BelfordZ @Gudahtt @MajorLift
2 people authored and MajorLift committed Oct 11, 2023
1 parent 508171c commit 41a84af
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 69 deletions.
108 changes: 40 additions & 68 deletions packages/assets-controllers/src/TokenDetectionController.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,17 @@ import * as sinon from 'sinon';
import nock from 'nock';
import { BN } from 'ethereumjs-util';
import {
NetworkController,
NetworkControllerMessenger,
NetworkControllerProviderConfigChangeEvent,
NetworkControllerStateChangeEvent,
defaultState as defaultNetworkState,
NetworkState,
ProviderConfig,
} from '@metamask/network-controller';
import { NetworksChainId, MAINNET } from '@metamask/controller-utils';
import {
NetworksChainId,
MAINNET,
NetworkType,
} from '@metamask/controller-utils';
import { PreferencesController } from '@metamask/preferences-controller';
import { ControllerMessenger } from '@metamask/base-controller';
import { TokensController } from './TokensController';
Expand Down Expand Up @@ -94,26 +99,6 @@ const getControllerMessenger = (): MainControllerMessenger => {
return new ControllerMessenger();
};

const setupNetworkController = (
controllerMessenger: MainControllerMessenger,
) => {
const networkMessenger = controllerMessenger.getRestricted({
name: 'NetworkController',
allowedEvents: [
'NetworkController:providerConfigChange',
'NetworkController:stateChange',
],
allowedActions: [],
});

const network = new NetworkController({
messenger: networkMessenger,
infuraProjectId: '123',
});

return { network, networkMessenger };
};

const setupTokenListController = (
controllerMessenger: MainControllerMessenger,
) => {
Expand All @@ -138,8 +123,6 @@ const setupTokenListController = (
describe('TokenDetectionController', () => {
let tokenDetection: TokenDetectionController;
let preferences: PreferencesController;
let network: NetworkController;
let networkMessenger: NetworkControllerMessenger;
let tokensController: TokensController;
let tokenList: TokenListController;
let controllerMessenger: MainControllerMessenger;
Expand All @@ -148,6 +131,20 @@ describe('TokenDetectionController', () => {
ReturnType<AssetsContractController['getBalancesInSingleCall']>
>;

const onNetworkStateChangeListeners: ((state: NetworkState) => void)[] = [];
const changeNetwork = (providerConfig: ProviderConfig) => {
onNetworkStateChangeListeners.forEach((listener) => {
listener({
...defaultNetworkState,
providerConfig,
});
});
};
const mainnet = {
chainId: NetworksChainId.mainnet,
type: MAINNET as NetworkType,
};

beforeEach(async () => {
nock(TOKEN_END_POINT_API)
.get(`/tokens/${NetworksChainId.mainnet}`)
Expand All @@ -164,22 +161,24 @@ describe('TokenDetectionController', () => {

preferences = new PreferencesController({}, { useTokenDetection: true });
controllerMessenger = getControllerMessenger();
const networkSetup = setupNetworkController(controllerMessenger);
network = networkSetup.network;
networkMessenger = networkSetup.networkMessenger;
sinon
.stub(TokensController.prototype, '_instantiateNewEthersProvider')
.callsFake(() => null);

tokensController = new TokensController({
onPreferencesStateChange: (listener) => preferences.subscribe(listener),
onNetworkStateChange: (listener) =>
networkMessenger.subscribe('NetworkController:stateChange', listener),
onNetworkStateChangeListeners.push(listener),
});

const tokenListSetup = setupTokenListController(controllerMessenger);
tokenList = tokenListSetup.tokenList;
await tokenList.start();
getBalancesInSingleCall = sinon.stub();
tokenDetection = new TokenDetectionController({
onPreferencesStateChange: (listener) => preferences.subscribe(listener),
onNetworkStateChange: (listener) =>
networkMessenger.subscribe('NetworkController:stateChange', listener),
onNetworkStateChangeListeners.push(listener),
onTokenListStateChange: (listener) =>
tokenListSetup.tokenListMessenger.subscribe(
`TokenListController:stateChange`,
Expand All @@ -191,7 +190,7 @@ describe('TokenDetectionController', () => {
tokensController.addDetectedTokens.bind(tokensController),
getTokensState: () => tokensController.state,
getTokenListState: () => tokenList.state,
getNetworkState: () => network.state,
getNetworkState: () => defaultNetworkState,
getPreferencesState: () => preferences.state,
});

Expand Down Expand Up @@ -270,12 +269,8 @@ describe('TokenDetectionController', () => {
});

it('should detect tokens correctly on supported networks', async () => {
sinon
.stub(tokensController, '_instantiateNewEthersProvider')
.callsFake(() => null);

preferences.update({ selectedAddress: '0x1' });
network.setProviderType(MAINNET);
changeNetwork(mainnet);

getBalancesInSingleCall.resolves({
[sampleTokenA.address]: new BN(1),
Expand All @@ -285,12 +280,8 @@ describe('TokenDetectionController', () => {
});

it('should update detectedTokens when new tokens are detected', async () => {
sinon
.stub(tokensController, '_instantiateNewEthersProvider')
.callsFake(() => null);

preferences.update({ selectedAddress: '0x1' });
network.setProviderType(MAINNET);
changeNetwork(mainnet);

await tokenDetection.start();

Expand All @@ -311,13 +302,9 @@ describe('TokenDetectionController', () => {
});

it('should not add ignoredTokens to the tokens list if detected with balance', async () => {
sinon
.stub(tokensController, '_instantiateNewEthersProvider')
.callsFake(() => null);

preferences.setSelectedAddress('0x0001');

network.setProviderType('mainnet');
changeNetwork(mainnet);

await tokenDetection.start();

Expand Down Expand Up @@ -347,12 +334,8 @@ describe('TokenDetectionController', () => {
});

it('should add a token when detected with a balance even if it is ignored on another account', async () => {
sinon
.stub(tokensController, '_instantiateNewEthersProvider')
.callsFake(() => null);

preferences.setSelectedAddress('0x0001');
network.setProviderType('mainnet');
changeNetwork(mainnet);

await tokenDetection.start();

Expand All @@ -374,12 +357,8 @@ describe('TokenDetectionController', () => {
});

it('should not autodetect tokens that exist in the ignoreList', async () => {
sinon
.stub(tokensController, '_instantiateNewEthersProvider')
.callsFake(() => null);

preferences.update({ selectedAddress: '0x1' });
network.setProviderType(MAINNET);
changeNetwork(mainnet);

await tokenDetection.start();

Expand All @@ -405,12 +384,8 @@ describe('TokenDetectionController', () => {
});

it('should detect new tokens after switching between accounts', async () => {
sinon
.stub(tokensController, '_instantiateNewEthersProvider')
.callsFake(() => null);

preferences.setSelectedAddress('0x0001');
network.setProviderType(MAINNET);
changeNetwork(mainnet);

getBalancesInSingleCall.resolves({
[sampleTokenA.address]: new BN(1),
Expand All @@ -429,9 +404,6 @@ describe('TokenDetectionController', () => {
.get(`/tokens/${polygonDecimalChainId}`)
.reply(200, sampleTokenList);

sinon
.stub(tokensController, '_instantiateNewEthersProvider')
.callsFake(() => null);
const stub = sinon.stub();
const getBalancesInSingleCallMock = sinon.stub();
let networkStateChangeListener: (state: any) => void;
Expand All @@ -448,7 +420,7 @@ describe('TokenDetectionController', () => {
addDetectedTokens: stub,
getTokensState: () => tokensController.state,
getTokenListState: () => tokenList.state,
getNetworkState: () => network.state,
getNetworkState: () => defaultNetworkState,
getPreferencesState: () => preferences.state,
},
{
Expand Down Expand Up @@ -490,7 +462,7 @@ describe('TokenDetectionController', () => {
addDetectedTokens: stub,
getTokensState: stub,
getTokenListState: stub,
getNetworkState: () => network.state,
getNetworkState: () => defaultNetworkState,
getPreferencesState: () => preferences.state,
},
{
Expand Down Expand Up @@ -522,7 +494,7 @@ describe('TokenDetectionController', () => {
addDetectedTokens: stub,
getTokensState: () => tokensController.state,
getTokenListState: () => tokenList.state,
getNetworkState: () => network.state,
getNetworkState: () => defaultNetworkState,
getPreferencesState: () => preferences.state,
},
{
Expand Down Expand Up @@ -558,7 +530,7 @@ describe('TokenDetectionController', () => {
addDetectedTokens: stub,
getTokensState: () => tokensController.state,
getTokenListState: () => tokenList.state,
getNetworkState: () => network.state,
getNetworkState: () => defaultNetworkState,
getPreferencesState: () => preferences.state,
},
{
Expand Down
2 changes: 1 addition & 1 deletion packages/network-controller/src/NetworkController.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ export type NetworkControllerOptions = {
state?: Partial<NetworkState>;
};

const defaultState: NetworkState = {
export const defaultState: NetworkState = {
network: 'loading',
isCustomNetwork: false,
providerConfig: { type: MAINNET, chainId: NetworksChainId.mainnet },
Expand Down

0 comments on commit 41a84af

Please sign in to comment.