Merge branch 'develop' into 17191/onboarding-unit-tests-create-new-vault

MetaMask · Apr 20, 2023 · a7643f9 · a7643f9
2 parents f5c3e32 + e96c0b6
commit a7643f9
Show file tree

Hide file tree

Showing 60 changed files with 639 additions and 326 deletions.
diff --git a/app/_locales/en/messages.json b/app/_locales/en/messages.json
diff --git a/app/scripts/controllers/network/network-controller.test.ts b/app/scripts/controllers/network/network-controller.test.ts
@@ -6740,7 +6740,7 @@ describe('NetworkController', () => {
     it('throws if the given chain ID is not a 0x-prefixed hex number', async () => {
       const invalidChainId = '1';
       await withController(async ({ controller }) => {
-        expect(() =>
+        await expect(() =>
           controller.upsertNetworkConfiguration(
             {
               /* @ts-expect-error We are intentionally passing bad input. */
@@ -6755,7 +6755,7 @@ describe('NetworkController', () => {
               source: MetaMetricsNetworkEventSource.Dapp,
             },
           ),
-        ).toThrow(
+        ).rejects.toThrow(
           new Error(
             `Invalid chain ID "${invalidChainId}": invalid hex string.`,
           ),
@@ -6765,7 +6765,7 @@ describe('NetworkController', () => {
 
     it('throws if the given chain ID is greater than the maximum allowed ID', async () => {
       await withController(async ({ controller }) => {
-        expect(() =>
+        await expect(() =>
           controller.upsertNetworkConfiguration(
             {
               chainId: '0xFFFFFFFFFFFFFFFF',
@@ -6779,7 +6779,7 @@ describe('NetworkController', () => {
               source: MetaMetricsNetworkEventSource.Dapp,
             },
           ),
-        ).toThrow(
+        ).rejects.toThrow(
           new Error(
             'Invalid chain ID "0xFFFFFFFFFFFFFFFF": numerical value greater than max safe value.',
           ),
@@ -6789,7 +6789,7 @@ describe('NetworkController', () => {
 
     it('throws if the no (or a falsy) rpcUrl is passed', async () => {
       await withController(async ({ controller }) => {
-        expect(() =>
+        await expect(() =>
           controller.upsertNetworkConfiguration(
             /* @ts-expect-error We are intentionally passing bad input. */
             {
@@ -6803,7 +6803,7 @@ describe('NetworkController', () => {
               source: MetaMetricsNetworkEventSource.Dapp,
             },
           ),
-        ).toThrow(
+        ).rejects.toThrow(
           new Error(
             'An rpcUrl is required to add or update network configuration',
           ),
@@ -6813,7 +6813,7 @@ describe('NetworkController', () => {
 
     it('throws if rpcUrl passed is not a valid Url', async () => {
       await withController(async ({ controller }) => {
-        expect(() =>
+        await expect(() =>
           controller.upsertNetworkConfiguration(
             {
               chainId: '0x9999',
@@ -6827,13 +6827,13 @@ describe('NetworkController', () => {
               source: MetaMetricsNetworkEventSource.Dapp,
             },
           ),
-        ).toThrow(new Error('rpcUrl must be a valid URL'));
+        ).rejects.toThrow(new Error('rpcUrl must be a valid URL'));
       });
     });
 
     it('throws if the no (or a falsy) ticker is passed', async () => {
       await withController(async ({ controller }) => {
-        expect(() =>
+        await expect(() =>
           controller.upsertNetworkConfiguration(
             /* @ts-expect-error We are intentionally passing bad input. */
             {
@@ -6847,7 +6847,7 @@ describe('NetworkController', () => {
               source: MetaMetricsNetworkEventSource.Dapp,
             },
           ),
-        ).toThrow(
+        ).rejects.toThrow(
           new Error(
             'A ticker is required to add or update networkConfiguration',
           ),
@@ -6857,15 +6857,15 @@ describe('NetworkController', () => {
 
     it('throws if an options object is not passed as a second argument', async () => {
       await withController(async ({ controller }) => {
-        expect(() =>
+        await expect(() =>
           /* @ts-expect-error We are intentionally passing bad input. */
           controller.upsertNetworkConfiguration({
             chainId: '0x5',
             nickname: 'RPC',
             rpcPrefs: { blockExplorerUrl: 'test-block-explorer.com' },
             rpcUrl: 'https://mock-rpc-url',
           }),
-        ).toThrow(
+        ).rejects.toThrow(
           new Error(
             "Cannot read properties of undefined (reading 'setActive')",
           ),
@@ -6888,7 +6888,7 @@ describe('NetworkController', () => {
             ticker: 'test_ticker',
           };
 
-          controller.upsertNetworkConfiguration(rpcUrlNetwork, {
+          await controller.upsertNetworkConfiguration(rpcUrlNetwork, {
             referrer: 'https://test-dapp.com',
             source: MetaMetricsNetworkEventSource.Dapp,
           });
@@ -6926,7 +6926,7 @@ describe('NetworkController', () => {
             invalidKey2: {},
           };
 
-          controller.upsertNetworkConfiguration(rpcUrlNetwork, {
+          await controller.upsertNetworkConfiguration(rpcUrlNetwork, {
             referrer: 'https://test-dapp.com',
             source: MetaMetricsNetworkEventSource.Dapp,
           });
@@ -6975,7 +6975,7 @@ describe('NetworkController', () => {
             ticker: 'RPC',
           };
 
-          controller.upsertNetworkConfiguration(rpcUrlNetwork, {
+          await controller.upsertNetworkConfiguration(rpcUrlNetwork, {
             referrer: 'https://test-dapp.com',
             source: MetaMetricsNetworkEventSource.Dapp,
           });
@@ -7024,7 +7024,7 @@ describe('NetworkController', () => {
             rpcPrefs: { blockExplorerUrl: 'alternativetestchainscan.io' },
             chainId: '0x1' as const,
           };
-          controller.upsertNetworkConfiguration(updatedConfiguration, {
+          await controller.upsertNetworkConfiguration(updatedConfiguration, {
             referrer: 'https://test-dapp.com',
             source: MetaMetricsNetworkEventSource.Dapp,
           });
@@ -7069,7 +7069,7 @@ describe('NetworkController', () => {
           },
         },
         async ({ controller }) => {
-          controller.upsertNetworkConfiguration(
+          await controller.upsertNetworkConfiguration(
             {
               rpcUrl: 'https://test-rpc-url',
               ticker: 'new-ticker',
@@ -7136,7 +7136,7 @@ describe('NetworkController', () => {
             ticker: 'test_ticker',
           };
 
-          controller.upsertNetworkConfiguration(rpcUrlNetwork, {
+          await controller.upsertNetworkConfiguration(rpcUrlNetwork, {
             referrer: 'https://test-dapp.com',
             source: MetaMetricsNetworkEventSource.Dapp,
           });
@@ -7180,7 +7180,7 @@ describe('NetworkController', () => {
             ticker: 'test_ticker',
           };
 
-          controller.upsertNetworkConfiguration(rpcUrlNetwork, {
+          await controller.upsertNetworkConfiguration(rpcUrlNetwork, {
             setActive: true,
             referrer: 'https://test-dapp.com',
             source: MetaMetricsNetworkEventSource.Dapp,
@@ -7229,7 +7229,7 @@ describe('NetworkController', () => {
             rpcPrefs: { blockExplorerUrl: 'https://block-explorer' },
           };
 
-          controller.upsertNetworkConfiguration(newNetworkConfiguration, {
+          await controller.upsertNetworkConfiguration(newNetworkConfiguration, {
             referrer: 'https://test-dapp.com',
             source: MetaMetricsNetworkEventSource.Dapp,
           });
@@ -7296,10 +7296,10 @@ describe('NetworkController', () => {
             rpcPrefs: { blockExplorerUrl: 'https://block-explorer' },
           };
 
-          expect(() => {
+          await expect(() =>
             /* @ts-expect-error We are intentionally passing bad input. */
-            controller.upsertNetworkConfiguration(newNetworkConfiguration, {});
-          }).toThrow(
+            controller.upsertNetworkConfiguration(newNetworkConfiguration, {}),
+          ).rejects.toThrow(
             'referrer and source are required arguments for adding or updating a network configuration',
           );
         },

diff --git a/app/scripts/controllers/network/network-controller.ts b/app/scripts/controllers/network/network-controller.ts
@@ -1034,7 +1034,7 @@ export class NetworkController extends EventEmitter {
    * @throws if `rpcUrl` is not a valid URL.
    * @returns The ID for the added or updated network configuration.
    */
-  upsertNetworkConfiguration(
+  async upsertNetworkConfiguration(
     {
       rpcUrl,
       chainId,
@@ -1051,7 +1051,7 @@ export class NetworkController extends EventEmitter {
       referrer: string;
       source: string;
     },
-  ): NetworkConfigurationId {
+  ): Promise<NetworkConfigurationId> {
     assert.ok(
       isPrefixedFormattedHexString(chainId),
       `Invalid chain ID "${chainId}": invalid hex string.`,
@@ -1129,7 +1129,7 @@ export class NetworkController extends EventEmitter {
     }
 
     if (setActive) {
-      this.setActiveNetwork(newNetworkConfigurationId);
+      await this.setActiveNetwork(newNetworkConfigurationId);
     }
 
     return newNetworkConfigurationId;

diff --git a/app/scripts/controllers/swaps.js b/app/scripts/controllers/swaps.js
@@ -113,7 +113,7 @@ export default class SwapsController {
     fetchTradesInfo = defaultFetchTradesInfo,
     getCurrentChainId,
     getEIP1559GasFeeEstimates,
-    onNetworkDidChange,
+    onNetworkStateChange,
   }) {
     this.store = new ObservableStore({
       swapsState: { ...initialState.swapsState },
@@ -137,7 +137,7 @@ export default class SwapsController {
 
     this.ethersProvider = new Web3Provider(provider);
     this._currentNetworkId = networkController.store.getState().networkId;
-    onNetworkDidChange(() => {
+    onNetworkStateChange(() => {
       const { networkId, networkStatus } = networkController.store.getState();
       if (
         networkStatus === NetworkStatus.Available &&

diff --git a/app/scripts/controllers/swaps.test.js b/app/scripts/controllers/swaps.test.js
@@ -160,7 +160,7 @@ describe('SwapsController', function () {
     return new SwapsController({
       getBufferedGasLimit: MOCK_GET_BUFFERED_GAS_LIMIT,
       networkController: getMockNetworkController(),
-      onNetworkDidChange: sinon.stub(),
+      onNetworkStateChange: sinon.stub(),
       provider: _provider,
       getProviderConfig: MOCK_GET_PROVIDER_CONFIG,
       getTokenRatesState: MOCK_TOKEN_RATES_STORE,
@@ -208,19 +208,19 @@ describe('SwapsController', function () {
 
     it('should replace ethers instance when network changes', function () {
       const networkController = getMockNetworkController();
-      const onNetworkDidChange = sinon.stub();
+      const onNetworkStateChange = sinon.stub();
       const swapsController = new SwapsController({
         getBufferedGasLimit: MOCK_GET_BUFFERED_GAS_LIMIT,
         networkController,
-        onNetworkDidChange,
+        onNetworkStateChange,
         provider,
         getProviderConfig: MOCK_GET_PROVIDER_CONFIG,
         getTokenRatesState: MOCK_TOKEN_RATES_STORE,
         fetchTradesInfo: fetchTradesInfoStub,
         getCurrentChainId: getCurrentChainIdStub,
       });
       const currentEthersInstance = swapsController.ethersProvider;
-      const changeNetwork = onNetworkDidChange.getCall(0).args[0];
+      const changeNetwork = onNetworkStateChange.getCall(0).args[0];
 
       networkController.store.getState.returns({
         networkId: NETWORK_IDS.MAINNET,
@@ -238,19 +238,19 @@ describe('SwapsController', function () {
 
     it('should not replace ethers instance when network changes to loading', function () {
       const networkController = getMockNetworkController();
-      const onNetworkDidChange = sinon.stub();
+      const onNetworkStateChange = sinon.stub();
       const swapsController = new SwapsController({
         getBufferedGasLimit: MOCK_GET_BUFFERED_GAS_LIMIT,
         networkController,
-        onNetworkDidChange,
+        onNetworkStateChange,
         provider,
         getProviderConfig: MOCK_GET_PROVIDER_CONFIG,
         getTokenRatesState: MOCK_TOKEN_RATES_STORE,
         fetchTradesInfo: fetchTradesInfoStub,
         getCurrentChainId: getCurrentChainIdStub,
       });
       const currentEthersInstance = swapsController.ethersProvider;
-      const changeNetwork = onNetworkDidChange.getCall(0).args[0];
+      const changeNetwork = onNetworkStateChange.getCall(0).args[0];
 
       networkController.store.getState.returns({
         networkId: null,
@@ -268,19 +268,19 @@ describe('SwapsController', function () {
 
     it('should not replace ethers instance when network changes to the same network', function () {
       const networkController = getMockNetworkController();
-      const onNetworkDidChange = sinon.stub();
+      const onNetworkStateChange = sinon.stub();
       const swapsController = new SwapsController({
         getBufferedGasLimit: MOCK_GET_BUFFERED_GAS_LIMIT,
         networkController,
-        onNetworkDidChange,
+        onNetworkStateChange,
         provider,
         getProviderConfig: MOCK_GET_PROVIDER_CONFIG,
         getTokenRatesState: MOCK_TOKEN_RATES_STORE,
         fetchTradesInfo: fetchTradesInfoStub,
         getCurrentChainId: getCurrentChainIdStub,
       });
       const currentEthersInstance = swapsController.ethersProvider;
-      const changeNetwork = onNetworkDidChange.getCall(0).args[0];
+      const changeNetwork = onNetworkStateChange.getCall(0).args[0];
 
       networkController.store.getState.returns({
         networkId: NETWORK_IDS.GOERLI,

diff --git a/app/scripts/metamask-controller.js b/app/scripts/metamask-controller.js
@@ -1195,10 +1195,8 @@ export default class MetamaskController extends EventEmitter {
         this.txController.txGasUtil,
       ),
       networkController: this.networkController,
-      onNetworkDidChange: networkControllerMessenger.subscribe.bind(
-        networkControllerMessenger,
-        NetworkControllerEventType.NetworkDidChange,
-      ),
+      onNetworkStateChange: (listener) =>
+        this.networkController.store.subscribe(listener),
       provider: this.provider,
       getProviderConfig: () => this.networkController.store.getState().provider,
       getTokenRatesState: () => this.tokenRatesController.state,

diff --git a/coverage-targets.js b/coverage-targets.js
@@ -6,10 +6,10 @@
 // subset of files to check against these targets.
 module.exports = {
   global: {
-    lines: 67.8,
-    branches: 55.84,
-    statements: 67.13,
-    functions: 59.66,
+    lines: 68.5,
+    branches: 56.34,
+    statements: 67.86,
+    functions: 60.69,
   },
   transforms: {
     branches: 100,