Skip to content

Refactor NetworkController to BaseControllerV2 #903

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

Merged
merged 16 commits into from
Oct 3, 2022
Merged

Refactor NetworkController to BaseControllerV2 #903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
aa62468
Refactor NetworkController to BaseControllerV2
shanejonas Aug 22, 2022
38b053a
Remove infura api key from TokenBalanceController
BelfordZ Sep 22, 2022
d7ecb32
Update TokenListController to use messaging system
BelfordZ Sep 22, 2022
bc0acd5
Fixed TokenDetectionController tests with new TokenList interface
BelfordZ Sep 22, 2022
a3bfd06
Changed onNetworkChange to use messaging system
BelfordZ Sep 23, 2022
3ac5e09
Changed tests to be less DRY
BelfordZ Sep 26, 2022
1fce0e7
Remove use of beforeeach in composablecontroller tests
BelfordZ Sep 26, 2022
3889b6b
Remove more beforeEach and fix composableController test
BelfordZ Sep 26, 2022
3e0ed67
Add types to state updates in network controller
BelfordZ Sep 27, 2022
97763c8
Fixed pr feedback
BelfordZ Sep 27, 2022
0d9cb21
Remove any as the type for main messenger in ComposableController tests
BelfordZ Sep 29, 2022
624d691
Move assertions into the it block and rename fn to setupController
BelfordZ Sep 29, 2022
bbee562
Fixed composable controller test by exporting restrictedmessenger type
BelfordZ Sep 29, 2022
ec62973
Fixed optional network controller state fields
BelfordZ Sep 29, 2022
aa6cc45
Changed networkController actions to have Action in their name
BelfordZ Sep 29, 2022
bdc7690
Removed underscore infront of infuraProjectId
BelfordZ Sep 29, 2022
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
220 changes: 127 additions & 93 deletions src/ComposableController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ import { TokensController } from './assets/TokensController';
import { CollectiblesController } from './assets/CollectiblesController';
import { AddressBookController } from './user/AddressBookController';
import { EnsController } from './third-party/EnsController';
import { ComposableController } from './ComposableController';
import {
ComposableController,
ComposableControllerRestrictedMessenger,
} from './ComposableController';
import { BaseController, BaseState } from './BaseController';
import { BaseController as BaseControllerV2 } from './BaseControllerV2';
import {
Expand All @@ -14,6 +17,8 @@ import {
import { PreferencesController } from './user/PreferencesController';
import {
NetworkController,
NetworkControllerMessenger,
NetworkControllerStateChangeEvent,
NetworksChainId,
} from './network/NetworkController';
import { AssetsContractController } from './assets/AssetsContractController';
Expand Down Expand Up @@ -86,61 +91,112 @@ class BarController extends BaseController<never, BarControllerState> {
}
}

const setupControllers = () => {
const mainMessenger = new ControllerMessenger<
never,
NetworkControllerStateChangeEvent
>();

const messenger: NetworkControllerMessenger = mainMessenger.getRestricted({
name: 'NetworkController',
allowedEvents: ['NetworkController:stateChange'],
allowedActions: [],
});

const composableMessenger: ComposableControllerRestrictedMessenger =
mainMessenger.getRestricted({
name: 'ComposableController',
allowedEvents: ['NetworkController:stateChange'],
allowedActions: [],
});

const networkController = new NetworkController({
messenger,
infuraProjectId: 'potato',
});
const preferencesController = new PreferencesController();

const assetContractController = new AssetsContractController({
onPreferencesStateChange: (listener) =>
preferencesController.subscribe(listener),
onNetworkStateChange: (listener) =>
messenger.subscribe('NetworkController:stateChange', listener),
});

const collectiblesController = new CollectiblesController({
onPreferencesStateChange: (listener) =>
preferencesController.subscribe(listener),
onNetworkStateChange: (listener) =>
messenger.subscribe('NetworkController:stateChange', listener),
getERC721AssetName: assetContractController.getERC721AssetName.bind(
assetContractController,
),
getERC721AssetSymbol: assetContractController.getERC721AssetSymbol.bind(
assetContractController,
),
getERC721TokenURI: assetContractController.getERC721TokenURI.bind(
assetContractController,
),
getERC721OwnerOf: assetContractController.getERC721OwnerOf.bind(
assetContractController,
),
getERC1155BalanceOf: assetContractController.getERC1155BalanceOf.bind(
assetContractController,
),
getERC1155TokenURI: assetContractController.getERC1155TokenURI.bind(
assetContractController,
),
onCollectibleAdded: jest.fn(),
});

const tokensController = new TokensController({
onPreferencesStateChange: (listener) =>
preferencesController.subscribe(listener),
onNetworkStateChange: (listener) =>
messenger.subscribe('NetworkController:stateChange', listener),
});

return {
messenger,
composableMessenger,
networkController,
preferencesController,
assetContractController,
collectiblesController,
tokensController,
};
};

describe('ComposableController', () => {
afterEach(() => {
sinon.restore();
});

describe('BaseController', () => {
it('should compose controller state', () => {
const preferencesController = new PreferencesController();
const networkController = new NetworkController();
const assetContractController = new AssetsContractController({
onPreferencesStateChange: (listener) =>
preferencesController.subscribe(listener),
onNetworkStateChange: (listener) =>
networkController.subscribe(listener),
});
const collectiblesController = new CollectiblesController({
onPreferencesStateChange: (listener) =>
preferencesController.subscribe(listener),
onNetworkStateChange: (listener) =>
networkController.subscribe(listener),
getERC721AssetName: assetContractController.getERC721AssetName.bind(
assetContractController,
),
getERC721AssetSymbol: assetContractController.getERC721AssetSymbol.bind(
assetContractController,
),
getERC721TokenURI: assetContractController.getERC721TokenURI.bind(
assetContractController,
),
getERC721OwnerOf: assetContractController.getERC721OwnerOf.bind(
assetContractController,
),
getERC1155BalanceOf: assetContractController.getERC1155BalanceOf.bind(
assetContractController,
),
getERC1155TokenURI: assetContractController.getERC1155TokenURI.bind(
assetContractController,
),
onCollectibleAdded: jest.fn(),
});
const tokensController = new TokensController({
onPreferencesStateChange: (listener) =>
preferencesController.subscribe(listener),
onNetworkStateChange: (listener) =>
networkController.subscribe(listener),
});
const controller = new ComposableController([
new AddressBookController(),
collectiblesController,
assetContractController,
new EnsController(),
const {
messenger,
composableMessenger,
networkController,
preferencesController,
assetContractController,
collectiblesController,
tokensController,
]);
preferencesController,
} = setupControllers();

const controller = new ComposableController(
[
new AddressBookController(),
collectiblesController,
assetContractController,
new EnsController(),
networkController,
preferencesController,
tokensController,
],
composableMessenger,
);

expect(controller.state).toStrictEqual({
AddressBookController: { addressBook: {} },
AssetsContractController: {},
Expand Down Expand Up @@ -179,57 +235,33 @@ describe('ComposableController', () => {
openSeaEnabled: false,
},
});

messenger.clearEventSubscriptions('NetworkController:stateChange');
});

it('should compose flat controller state', () => {
const preferencesController = new PreferencesController();
const networkController = new NetworkController();
const assetContractController = new AssetsContractController({
onPreferencesStateChange: (listener) =>
preferencesController.subscribe(listener),
onNetworkStateChange: (listener) =>
networkController.subscribe(listener),
});
const collectiblesController = new CollectiblesController({
onPreferencesStateChange: (listener) =>
preferencesController.subscribe(listener),
onNetworkStateChange: (listener) =>
networkController.subscribe(listener),
getERC721AssetName: assetContractController.getERC721AssetName.bind(
assetContractController,
),
getERC721AssetSymbol: assetContractController.getERC721AssetSymbol.bind(
assetContractController,
),
getERC721TokenURI: assetContractController.getERC721TokenURI.bind(
assetContractController,
),
getERC721OwnerOf: assetContractController.getERC721OwnerOf.bind(
assetContractController,
),
getERC1155BalanceOf: assetContractController.getERC1155BalanceOf.bind(
assetContractController,
),
getERC1155TokenURI: assetContractController.getERC1155TokenURI.bind(
assetContractController,
),
onCollectibleAdded: jest.fn(),
});
const tokensController = new TokensController({
onPreferencesStateChange: (listener) =>
preferencesController.subscribe(listener),
onNetworkStateChange: (listener) =>
networkController.subscribe(listener),
});
const controller = new ComposableController([
new AddressBookController(),
collectiblesController,
assetContractController,
new EnsController(),
const {
messenger,
composableMessenger,
networkController,
preferencesController,
assetContractController,
collectiblesController,
tokensController,
]);
preferencesController,
} = setupControllers();

const controller = new ComposableController(
[
new AddressBookController(),
collectiblesController,
assetContractController,
new EnsController(),
networkController,
preferencesController,
tokensController,
],
composableMessenger,
);
expect(controller.flatState).toStrictEqual({
addressBook: {},
allCollectibleContracts: {},
Expand Down Expand Up @@ -257,6 +289,8 @@ describe('ComposableController', () => {
suggestedAssets: [],
tokens: [],
});

messenger.clearEventSubscriptions('NetworkController:stateChange');
});

it('should set initial state', () => {
Expand Down
19 changes: 5 additions & 14 deletions src/ComposableController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,16 @@ export type ControllerList = (
| { name: string; state: Record<string, unknown> }
)[];

export type ComposableControllerRestrictedMessenger =
RestrictedControllerMessenger<'ComposableController', never, any, never, any>;

/**
* Controller that can be used to compose multiple controllers together
*/
export class ComposableController extends BaseController<never, any> {
private controllers: ControllerList = [];

private messagingSystem?: RestrictedControllerMessenger<
'ComposableController',
never,
any,
never,
any
>;
private messagingSystem?: ComposableControllerRestrictedMessenger;

/**
* Name of this controller used during composition
Expand All @@ -42,13 +39,7 @@ export class ComposableController extends BaseController<never, any> {
*/
constructor(
controllers: ControllerList,
messenger?: RestrictedControllerMessenger<
'ComposableController',
never,
any,
never,
any
>,
messenger?: ComposableControllerRestrictedMessenger,
) {
super(
undefined,
Expand Down
Loading