fix: stop polling on environment close (#29707)

## **Description**

When the asset controllers start polling, they add their polling tokens
to app state, keyed by the particular environment (popup vs fullscreen).
But these polling tokens in app state were not being used during
cleanup. This PR updates `onEnvironmentTypeClosed` to stop polling by
those tokens.


[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/29707?quickstart=1)

## **Related issues**


## **Manual testing steps**

1. Open MM in fullscreen
2. Open MM popup
3. Close the popup
4. `onEnvironmentTypeClosed` should fire for the popup environment
5. Each polling token should be found and removed by one of the
controllers

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [ ] I've completed the PR template to the best of my ability
- [ ] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.

Author: bergeron

app/scripts/controllers/account-tracker-controller.test.ts

@@ -368,6 +368,23 @@ describe('AccountTrackerController', () => {
       });
     });
 
+    it('should gracefully handle unknown polling tokens', async () => {
+      await withController(({ controller, blockTrackerFromHookStub }) => {
+        jest.spyOn(controller, 'updateAccounts').mockResolvedValue();
+
+        const pollingToken =
+          controller.startPollingByNetworkClientId('mainnet');
+
+        controller.stopPollingByPollingToken('unknown-token');
+        controller.stopPollingByPollingToken(pollingToken);
+
+        expect(blockTrackerFromHookStub.removeListener).toHaveBeenCalledWith(
+          'latest',
+          expect.any(Function),
+        );
+      });
+    });
+
     it('should not unsubscribe from the block tracker if called with one of multiple active polling tokens for a given networkClient', async () => {
       await withController(({ controller, blockTrackerFromHookStub }) => {
         jest.spyOn(controller, 'updateAccounts').mockResolvedValue();
@@ -391,14 +408,6 @@ describe('AccountTrackerController', () => {
         }).toThrow('pollingToken required');
       });
     });
-
-    it('should error if no matching pollingToken is found', async () => {
-      await withController(({ controller }) => {
-        expect(() => {
-          controller.stopPollingByPollingToken('potato');
-        }).toThrow('pollingToken not found');
-      });
-    });
   });
 
   describe('stopAll', () => {

app/scripts/controllers/account-tracker-controller.ts

@@ -403,20 +403,15 @@ export default class AccountTrackerController extends BaseController<
     if (!pollingToken) {
       throw new Error('pollingToken required');
     }
-    let found = false;
     this.#pollingTokenSets.forEach((tokenSet, key) => {
       if (tokenSet.has(pollingToken)) {
-        found = true;
         tokenSet.delete(pollingToken);
         if (tokenSet.size === 0) {
           this.#pollingTokenSets.delete(key);
           this.#unsubscribeWithNetworkClientId(key);
         }
       }
     });
-    if (!found) {
-      throw new Error('pollingToken not found');
-    }
   }
 
   /**

app/scripts/metamask-controller.js

@@ -7011,7 +7011,7 @@ export default class MetamaskController extends EventEmitter {
 
   /**
    * A method that is called by the background when a particular environment type is closed (fullscreen, popup, notification).
-   * Currently used to stop polling in the gasFeeController for only that environement type
+   * Currently used to stop polling controllers for only that environement type
    *
    * @param environmentType
    */
@@ -7021,8 +7021,15 @@ export default class MetamaskController extends EventEmitter {
     const pollingTokensToDisconnect =
       this.appStateController.state[appStatePollingTokenType];
     pollingTokensToDisconnect.forEach((pollingToken) => {
+      // We don't know which controller the token is associated with, so try them all.
+      // Consider storing the tokens per controller in state instead.
       this.gasFeeController.stopPollingByPollingToken(pollingToken);
       this.currencyRateController.stopPollingByPollingToken(pollingToken);
+      this.tokenRatesController.stopPollingByPollingToken(pollingToken);
+      this.tokenDetectionController.stopPollingByPollingToken(pollingToken);
+      this.tokenListController.stopPollingByPollingToken(pollingToken);
+      this.tokenBalancesController.stopPollingByPollingToken(pollingToken);
+      this.accountTrackerController.stopPollingByPollingToken(pollingToken);
       this.appStateController.removePollingToken(
         pollingToken,
         appStatePollingTokenType,