Add preference to enable/disable collectible detection (#638)

* add preference to enable/disable collectible detection * update tests
MetaMask · Oct 11, 2023 · 775c55b · 775c55b
1 parent 625a731
commit 775c55b
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 6 deletions.
diff --git a/src/ComposableController.test.ts b/src/ComposableController.test.ts
@@ -165,6 +165,7 @@ describe('ComposableController', () => {
           lostIdentities: {},
           selectedAddress: '',
           useStaticTokenList: false,
+          useCollectibleDetection: false,
         },
       });
     });
@@ -234,6 +235,7 @@ describe('ComposableController', () => {
         provider: { type: 'mainnet', chainId: NetworksChainId.mainnet },
         selectedAddress: '',
         useStaticTokenList: false,
+        useCollectibleDetection: false,
         suggestedAssets: [],
         tokens: [],
       });

diff --git a/src/assets/CollectibleDetectionController.test.ts b/src/assets/CollectibleDetectionController.test.ts
@@ -53,6 +53,8 @@ describe('CollectibleDetectionController', () => {
       getCollectiblesState: () => collectiblesController.state,
     });
 
+    preferences.setUseCollectibleDetection(true);
+
     nock(OPEN_SEA_HOST)
       .get(`${OPEN_SEA_PATH}/assets?owner=0x2&offset=0&limit=50`)
       .reply(200, {
@@ -191,10 +193,12 @@ describe('CollectibleDetectionController', () => {
   });
 
   it('should set default config', () => {
+    preferences.setUseCollectibleDetection(false);
     expect(collectibleDetection.config).toStrictEqual({
       interval: DEFAULT_INTERVAL,
       networkType: 'mainnet',
       selectedAddress: '',
+      disabled: true,
     });
   });
 
@@ -219,8 +223,8 @@ describe('CollectibleDetectionController', () => {
         },
         { interval: 10 },
       );
+      collectiblesDetectionController.configure({ disabled: false });
       collectiblesDetectionController.start();
-
       expect(mockCollectibles.calledOnce).toBe(true);
       setTimeout(() => {
         expect(mockCollectibles.calledTwice).toBe(true);
@@ -360,6 +364,16 @@ describe('CollectibleDetectionController', () => {
     expect(collectiblesController.state.collectibles).toStrictEqual([]);
   });
 
+  it('should not detect and add collectibles if preferences controller useCollectibleDetection is set to false', async () => {
+    preferences.setUseCollectibleDetection(false);
+    collectibleDetection.configure({
+      networkType: MAINNET,
+      selectedAddress: '0x9',
+    });
+    collectibleDetection.detectCollectibles();
+    expect(collectiblesController.state.collectibles).toStrictEqual([]);
+  });
+
   it('should not add collectible if collectible or collectible contract has no information to display', async () => {
     const collectibleHH2574 = {
       address: '0xebE4e5E773AFD2bAc25De0cFafa084CFb3cBf1eD',

diff --git a/src/assets/CollectibleDetectionController.ts b/src/assets/CollectibleDetectionController.ts
@@ -229,13 +229,21 @@ export class CollectibleDetectionController extends BaseController<
       interval: DEFAULT_INTERVAL,
       networkType: MAINNET,
       selectedAddress: '',
+      disabled: true,
     };
     this.initialize();
     this.getCollectiblesState = getCollectiblesState;
-    onPreferencesStateChange(({ selectedAddress }) => {
-      const actualSelectedAddress = this.config.selectedAddress;
-      if (selectedAddress !== actualSelectedAddress) {
-        this.configure({ selectedAddress });
+    onPreferencesStateChange(({ selectedAddress, useCollectibleDetection }) => {
+      const {
+        selectedAddress: previouslySelectedAddress,
+        disabled,
+      } = this.config;
+
+      if (
+        selectedAddress !== previouslySelectedAddress ||
+        !useCollectibleDetection !== disabled
+      ) {
+        this.configure({ selectedAddress, disabled: !useCollectibleDetection });
         this.detectCollectibles();
       }
     });

diff --git a/src/user/PreferencesController.test.ts b/src/user/PreferencesController.test.ts
@@ -11,6 +11,7 @@ describe('PreferencesController', () => {
       lostIdentities: {},
       selectedAddress: '',
       useStaticTokenList: false,
+      useCollectibleDetection: false,
     });
   });
 
@@ -216,4 +217,10 @@ describe('PreferencesController', () => {
     controller.setUseStaticTokenList(true);
     expect(controller.state.useStaticTokenList).toStrictEqual(true);
   });
+
+  it('should set useCollectibleDetection', () => {
+    const controller = new PreferencesController();
+    controller.setUseCollectibleDetection(true);
+    expect(controller.state.useCollectibleDetection).toStrictEqual(true);
+  });
 });
diff --git a/src/user/PreferencesController.ts b/src/user/PreferencesController.ts
@@ -46,6 +46,7 @@ export interface PreferencesState extends BaseState {
   lostIdentities: { [address: string]: ContactEntry };
   selectedAddress: string;
   useStaticTokenList: boolean;
+  useCollectibleDetection: boolean;
 }
 
 /**
@@ -76,6 +77,7 @@ export class PreferencesController extends BaseController<
       lostIdentities: {},
       selectedAddress: '',
       useStaticTokenList: false,
+      useCollectibleDetection: false,
     };
     this.initialize();
   }
@@ -287,11 +289,20 @@ export class PreferencesController extends BaseController<
   /**
    * Toggle the token detection setting to use dynamic token list.
    *
-   * @param useStaticTokenList - IPFS gateway string.
+   * @param useStaticTokenList - Boolean indicating user preference on token detection.
    */
   setUseStaticTokenList(useStaticTokenList: boolean) {
     this.update({ useStaticTokenList });
   }
+
+  /**
+   * Toggle the collectible detection setting.
+   *
+   * @param useCollectibleDetection - Boolean indicating user preference on collectible detection.
+   */
+  setUseCollectibleDetection(useCollectibleDetection: boolean) {
+    this.update({ useCollectibleDetection });
+  }
 }
 
 export default PreferencesController;