add openSeaEnabled preference (#645)

* add openSeaEnabled preference * stop polling when useCollectibleDetection set to false, set useCollectibleDetection to false when openSeaEnabled set to false * cleanup * update tests
MetaMask · Nov 30, 2021 · dd23b43 · dd23b43
1 parent 064a9a0
commit dd23b43
Show file tree

Hide file tree

Showing 7 changed files with 73 additions and 22 deletions.
diff --git a/src/ComposableController.test.ts b/src/ComposableController.test.ts
@@ -166,6 +166,7 @@ describe('ComposableController', () => {
           selectedAddress: '',
           useStaticTokenList: false,
           useCollectibleDetection: false,
+          openSeaEnabled: false,
         },
       });
     });
@@ -236,6 +237,7 @@ describe('ComposableController', () => {
         selectedAddress: '',
         useStaticTokenList: false,
         useCollectibleDetection: false,
+        openSeaEnabled: false,
         suggestedAssets: [],
         tokens: [],
       });

diff --git a/src/assets/CollectibleDetectionController.test.ts b/src/assets/CollectibleDetectionController.test.ts
@@ -53,6 +53,7 @@ describe('CollectibleDetectionController', () => {
       getCollectiblesState: () => collectiblesController.state,
     });
 
+    preferences.setOpenSeaEnabled(true);
     preferences.setUseCollectibleDetection(true);
 
     nock(OPEN_SEA_HOST)
@@ -376,6 +377,16 @@ describe('CollectibleDetectionController', () => {
     expect(collectiblesController.state.collectibles).toStrictEqual([]);
   });
 
+  it('should not detect and add collectibles if preferences controller openSeaEnabled is set to false', async () => {
+    preferences.setOpenSeaEnabled(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
@@ -233,6 +233,10 @@ export class CollectibleDetectionController extends BaseController<
         this.configure({ selectedAddress, disabled: !useCollectibleDetection });
         this.detectCollectibles();
       }
+
+      if (!useCollectibleDetection) {
+        this.stop();
+      }
     });
 
     onNetworkStateChange(({ provider }) => {

diff --git a/src/assets/CollectiblesController.test.ts b/src/assets/CollectiblesController.test.ts
@@ -60,7 +60,10 @@ describe('CollectiblesController', () => {
       ),
     });
 
-    preferences.update({ selectedAddress: OWNER_ADDRESS });
+    preferences.update({
+      selectedAddress: OWNER_ADDRESS,
+      openSeaEnabled: true,
+    });
 
     sandbox
       .stub(collectiblesController, 'isCollectibleOwner' as any)

diff --git a/src/assets/CollectiblesController.ts b/src/assets/CollectiblesController.ts
@@ -126,6 +126,7 @@ export interface CollectiblesConfig extends BaseConfig {
   selectedAddress: string;
   chainId: string;
   ipfsGateway: string;
+  openSeaEnabled: boolean;
 }
 
 /**
@@ -355,12 +356,15 @@ export class CollectiblesController extends BaseController<
       );
     });
 
-    const openSeaMetadata = await safelyExecute(async () => {
-      return await this.getCollectibleInformationFromApi(
-        contractAddress,
-        tokenId,
-      );
-    });
+    let openSeaMetadata;
+    if (this.config.openSeaEnabled) {
+      openSeaMetadata = await safelyExecute(async () => {
+        return await this.getCollectibleInformationFromApi(
+          contractAddress,
+          tokenId,
+        );
+      });
+    }
 
     return {
       ...openSeaMetadata,
@@ -428,11 +432,14 @@ export class CollectiblesController extends BaseController<
       );
     });
 
-    const openSeaContractData = await safelyExecute(async () => {
-      return await this.getCollectibleContractInformationFromApi(
-        contractAddress,
-      );
-    });
+    let openSeaContractData;
+    if (this.config.openSeaEnabled) {
+      openSeaContractData = await safelyExecute(async () => {
+        return await this.getCollectibleContractInformationFromApi(
+          contractAddress,
+        );
+      });
+    }
 
     if (blockchainContractData || openSeaContractData) {
       return { ...openSeaContractData, ...blockchainContractData };
@@ -787,6 +794,7 @@ export class CollectiblesController extends BaseController<
       selectedAddress: '',
       chainId: '',
       ipfsGateway: IPFS_DEFAULT_GATEWAY_URL,
+      openSeaEnabled: false,
     };
 
     this.defaultState = {
@@ -803,16 +811,18 @@ export class CollectiblesController extends BaseController<
     this.getOwnerOf = getOwnerOf;
     this.balanceOfERC1155Collectible = balanceOfERC1155Collectible;
     this.uriERC1155Collectible = uriERC1155Collectible;
-    onPreferencesStateChange(({ selectedAddress, ipfsGateway }) => {
-      const { allCollectibleContracts, allCollectibles } = this.state;
-      const { chainId } = this.config;
-      this.configure({ selectedAddress, ipfsGateway });
-      this.update({
-        collectibleContracts:
-          allCollectibleContracts[selectedAddress]?.[chainId] || [],
-        collectibles: allCollectibles[selectedAddress]?.[chainId] || [],
-      });
-    });
+    onPreferencesStateChange(
+      ({ selectedAddress, ipfsGateway, openSeaEnabled }) => {
+        const { allCollectibleContracts, allCollectibles } = this.state;
+        const { chainId } = this.config;
+        this.configure({ selectedAddress, ipfsGateway, openSeaEnabled });
+        this.update({
+          collectibleContracts:
+            allCollectibleContracts[selectedAddress]?.[chainId] || [],
+          collectibles: allCollectibles[selectedAddress]?.[chainId] || [],
+        });
+      },
+    );
 
     onNetworkStateChange(({ provider }) => {
       const { allCollectibleContracts, allCollectibles } = this.state;

diff --git a/src/user/PreferencesController.test.ts b/src/user/PreferencesController.test.ts
@@ -12,6 +12,7 @@ describe('PreferencesController', () => {
       selectedAddress: '',
       useStaticTokenList: false,
       useCollectibleDetection: false,
+      openSeaEnabled: false,
     });
   });
 
@@ -220,6 +221,7 @@ describe('PreferencesController', () => {
 
   it('should set useCollectibleDetection', () => {
     const controller = new PreferencesController();
+    controller.setOpenSeaEnabled(true);
     controller.setUseCollectibleDetection(true);
     expect(controller.state.useCollectibleDetection).toStrictEqual(true);
   });

diff --git a/src/user/PreferencesController.ts b/src/user/PreferencesController.ts
@@ -47,6 +47,7 @@ export interface PreferencesState extends BaseState {
   selectedAddress: string;
   useStaticTokenList: boolean;
   useCollectibleDetection: boolean;
+  openSeaEnabled: boolean;
 }
 
 /**
@@ -78,6 +79,7 @@ export class PreferencesController extends BaseController<
       selectedAddress: '',
       useStaticTokenList: false,
       useCollectibleDetection: false,
+      openSeaEnabled: false,
     };
     this.initialize();
   }
@@ -301,8 +303,25 @@ export class PreferencesController extends BaseController<
    * @param useCollectibleDetection - Boolean indicating user preference on collectible detection.
    */
   setUseCollectibleDetection(useCollectibleDetection: boolean) {
+    if (useCollectibleDetection && !this.state.openSeaEnabled) {
+      throw new Error(
+        'useCollectibleDetection cannot be enabled if openSeaEnabled is false',
+      );
+    }
     this.update({ useCollectibleDetection });
   }
+
+  /**
+   * Toggle the opensea enabled setting.
+   *
+   * @param openSeaEnabled - Boolean indicating user preference on using OpenSea's API.
+   */
+  setOpenSeaEnabled(openSeaEnabled: boolean) {
+    this.update({ openSeaEnabled });
+    if (!openSeaEnabled) {
+      this.update({ useCollectibleDetection: false });
+    }
+  }
 }
 
 export default PreferencesController;