fix: Improve state management (#353)

Author: dan437

src/SmartTransactionsController.test.ts

@@ -460,6 +460,79 @@ describe('SmartTransactionsController', () => {
       } as NetworkState);
       expect(checkPollSpy).toHaveBeenCalled();
     });
+
+    it('calls "ensureUniqueSmartTransactions" on network change if it is a new chainId', () => {
+      const { smartTransactionsState } = smartTransactionsController.state;
+      const smartTransactionsForChainId = createStateAfterSuccess();
+      smartTransactionsForChainId.push({
+        // Duplicate a smart transaction with the same uuid.
+        ...smartTransactionsForChainId[0],
+        status: 'pending',
+      });
+      smartTransactionsController.update({
+        smartTransactionsState: {
+          ...smartTransactionsState,
+          smartTransactions: {
+            [ChainId.mainnet]:
+              smartTransactionsForChainId as SmartTransaction[],
+          },
+        },
+      });
+      smartTransactionsController.config.chainId = ChainId.sepolia;
+      networkListener({
+        providerConfig: {
+          chainId: ChainId.mainnet,
+          type: 'rpc',
+          ticker: 'ETH',
+        },
+        selectedNetworkClientId: 'networkClientId',
+        networkConfigurations: {},
+        networksMetadata: {},
+      } as NetworkState);
+      const uniqueSmartTransactionsForChainId =
+        smartTransactionsController.state.smartTransactionsState
+          .smartTransactions[ChainId.mainnet];
+      expect(uniqueSmartTransactionsForChainId).toHaveLength(1);
+      expect(uniqueSmartTransactionsForChainId).toStrictEqual([
+        smartTransactionsForChainId[0],
+      ]);
+    });
+
+    it('does not call "ensureUniqueSmartTransactions" on network change for the same chainId', () => {
+      const { smartTransactionsState } = smartTransactionsController.state;
+      const smartTransactionsForChainId = createStateAfterSuccess();
+      smartTransactionsForChainId.push({
+        // Duplicate a smart transaction with the same uuid.
+        ...smartTransactionsForChainId[0],
+        status: 'pending',
+      });
+      smartTransactionsController.update({
+        smartTransactionsState: {
+          ...smartTransactionsState,
+          smartTransactions: {
+            [ChainId.mainnet]:
+              smartTransactionsForChainId as SmartTransaction[],
+          },
+        },
+      });
+      networkListener({
+        providerConfig: {
+          chainId: ChainId.mainnet,
+          type: 'rpc',
+          ticker: 'ETH',
+        },
+        selectedNetworkClientId: 'networkClientId',
+        networkConfigurations: {},
+        networksMetadata: {},
+      } as NetworkState);
+      const currentSmartTransactionsForChainId =
+        smartTransactionsController.state.smartTransactionsState
+          .smartTransactions[ChainId.mainnet];
+      expect(currentSmartTransactionsForChainId).toHaveLength(2);
+      expect(currentSmartTransactionsForChainId).toStrictEqual(
+        smartTransactionsForChainId,
+      );
+    });
   });
 
   describe('checkPoll', () => {

src/SmartTransactionsController.ts

@@ -183,11 +183,16 @@ export default class SmartTransactionsController extends StaticIntervalPollingCo
     this.getNetworkClientById = getNetworkClientById;
 
     this.initializeSmartTransactionsForChainId();
+    this.#ensureUniqueSmartTransactions();
 
     onNetworkStateChange(({ providerConfig: newProvider }) => {
       const { chainId } = newProvider;
+      const isNewChainId = chainId !== this.config.chainId;
       this.configure({ chainId });
       this.initializeSmartTransactionsForChainId();
+      if (isNewChainId) {
+        this.#ensureUniqueSmartTransactions();
+      }
       this.checkPoll(this.state);
       this.ethQuery = new EthQuery(provider);
     });
@@ -238,6 +243,35 @@ export default class SmartTransactionsController extends StaticIntervalPollingCo
     }
   }
 
+  // We fixed having duplicate smart transactions with the same uuid in a very rare edge case.
+  // This function resolves it for a few users who have this issue and once we see in logs
+  // that everything is fine, we can remove this function.
+  #ensureUniqueSmartTransactions() {
+    const { smartTransactions } = this.state.smartTransactionsState;
+    const chainId = ChainId.mainnet; // Smart Transactions are only available on Ethereum mainnet at the moment.
+    const smartTransactionsForChainId = smartTransactions[chainId];
+    if (!smartTransactionsForChainId) {
+      return;
+    }
+    const uniqueUUIDs = new Set();
+    const uniqueSmartTransactionsForChainId = [];
+    for (const transaction of smartTransactionsForChainId) {
+      if (!uniqueUUIDs.has(transaction.uuid)) {
+        uniqueUUIDs.add(transaction.uuid);
+        uniqueSmartTransactionsForChainId.push(transaction);
+      }
+    }
+    this.update({
+      smartTransactionsState: {
+        ...this.state.smartTransactionsState,
+        smartTransactions: {
+          ...smartTransactions,
+          [chainId]: uniqueSmartTransactionsForChainId,
+        },
+      },
+    });
+  }
+
   async poll(interval?: number): Promise<void> {
     const { chainId, supportedChainIds } = this.config;
     interval && this.configure({ interval }, false, false);