In networkDidChange event listener, detect tokens if networkClientId is changed instead of chainId, and avoid resetting polling interval

MajorLift · MajorLift · commit 312e450a7a25 · 2024-02-06T16:46:01.000-05:00
diff --git a/packages/assets-controllers/CHANGELOG.md b/packages/assets-controllers/CHANGELOG.md
@@ -15,7 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - **BREAKING:** `TokenDetectionController` is merged with `DetectTokensController` from the `metamask-extension` repo. ([#3775](https://github.com/MetaMask/core/pull/3775/))
-  - **BREAKING:** `TokenDetectionController` now resets its polling interval to the default value of 3 minutes when token detection is triggered by external controller events.
+  - **BREAKING:** `TokenDetectionController` now resets its polling interval to the default value of 3 minutes when token detection is triggered by external controller events `KeyringController:unlock`, `TokenListController:stateChange`, `PreferencesController:stateChange`, `AccountsController:selectedAccountChange`.
+  - **BREAKING:** `TokenDetectionController` now responds to `NetworkController:networkDidChange` event only if the `networkClientId` is changed, and does not reset the polling interval in this case.
   - **BREAKING:** `TokenDetectionController` cannot initiate polling or token detection if `KeyringController` state is locked. It also subscribes to the `KeyringController:lock` and `KeyringController:unlock` events.
   - **BREAKING:** The `detectTokens` method now excludes tokens that are already included in the `TokensController`'s `detectedTokens` list from the batch of incoming tokens it sends to the `TokensController` `addDetectedTokens` method.
   - **BREAKING:** The constructor for `TokenDetectionController` expects a new required proprerty `trackMetaMetricsEvent`, which defines the callback that is called in the `detectTokens` method.
diff --git a/packages/assets-controllers/jest.config.js b/packages/assets-controllers/jest.config.js
@@ -17,7 +17,7 @@ module.exports = merge(baseConfig, {
   // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
-      branches: 88.5,
+      branches: 88.3,
       functions: 95.32,
       lines: 96.76,
       statements: 96.76,
diff --git a/packages/assets-controllers/src/TokenDetectionController.test.ts b/packages/assets-controllers/src/TokenDetectionController.test.ts
@@ -760,7 +760,7 @@ describe('TokenDetectionController', () => {
     });
 
     describe('when "disabled" is "false"', () => {
-      it('should detect new tokens after switching chains', async () => {
+      it('should detect new tokens after switching network client id', async () => {
         const mockGetBalancesInSingleCall = jest.fn().mockResolvedValue({
           [sampleTokenA.address]: new BN(1),
         });
@@ -859,7 +859,7 @@ describe('TokenDetectionController', () => {
         );
       });
 
-      it('should not detect new tokens if the chain has not changed', async () => {
+      it('should not detect new tokens if the network client id has not changed', async () => {
         const mockGetBalancesInSingleCall = jest.fn().mockResolvedValue({
           [sampleTokenA.address]: new BN(1),
         });
@@ -898,7 +898,7 @@ describe('TokenDetectionController', () => {
 
             messenger.publish('NetworkController:networkDidChange', {
               ...defaultNetworkState,
-              selectedNetworkClientId: 'mainnnet',
+              selectedNetworkClientId: 'mainnet',
             });
             await advanceTime({ clock, duration: 1 });
 
@@ -909,7 +909,7 @@ describe('TokenDetectionController', () => {
     });
 
     describe('when "disabled" is "true"', () => {
-      it('should not detect new tokens after switching chains', async () => {
+      it('should not detect new tokens after switching network client id', async () => {
         const mockGetBalancesInSingleCall = jest.fn().mockResolvedValue({
           [sampleTokenA.address]: new BN(1),
         });
diff --git a/packages/assets-controllers/src/TokenDetectionController.ts b/packages/assets-controllers/src/TokenDetectionController.ts
@@ -306,16 +306,16 @@ export class TokenDetectionController extends StaticIntervalPollingController<
     this.messagingSystem.subscribe(
       'NetworkController:networkDidChange',
       async ({ selectedNetworkClientId }) => {
-        this.#networkClientId = selectedNetworkClientId;
-        const newChainId = this.#getCorrectChainId(selectedNetworkClientId);
-        const isChainIdChanged = this.#chainId !== newChainId;
+        const isNetworkClientIdChanged =
+          this.#networkClientId !== selectedNetworkClientId;
 
+        const newChainId = this.#getCorrectChainId(selectedNetworkClientId);
         this.#isDetectionEnabledForNetwork =
           isTokenDetectionSupportedForNetwork(newChainId);
 
-        if (isChainIdChanged && this.#isDetectionEnabledForNetwork) {
-          this.#chainId = newChainId;
-          await this.#restartTokenDetection({
+        if (isNetworkClientIdChanged && this.#isDetectionEnabledForNetwork) {
+          this.#networkClientId = selectedNetworkClientId;
+          await this.detectTokens({
             networkClientId: this.#networkClientId,
           });
         }
