working on test

Author: adonesky1

package.json

@@ -31,7 +31,7 @@
     "@metamask/base-controller": "^3.2.1",
     "@metamask/controller-utils": "^5.0.0",
     "@metamask/network-controller": "^13.0.0",
-    "@metamask/polling-controller": "^0.1.0",
+    "@metamask/polling-controller": "^0.2.0",
     "bignumber.js": "^9.0.1",
     "fast-json-patch": "^3.1.0",
     "lodash": "^4.17.21"

src/SmartTransactionsController.test.ts

@@ -6,6 +6,15 @@ import SmartTransactionsController, {
 import { API_BASE_URL, CHAIN_IDS } from './constants';
 import { SmartTransaction, SmartTransactionStatuses } from './types';
 
+/**
+ * Resolve all pending promises.
+ * This method is used for async tests that use fake timers.
+ * See https://stackoverflow.com/a/58716087 and https://jestjs.io/docs/timer-mocks.
+ */
+function flushPromises(): Promise<unknown> {
+  return new Promise(jest.requireActual('timers').setImmediate);
+}
+
 const confirmExternalMock = jest.fn();
 
 jest.mock('@ethersproject/bytes', () => ({
@@ -30,6 +39,8 @@ jest.mock('@ethersproject/providers', () => ({
 
 const addressFrom = '0x268392a24B6b093127E8581eAfbD1DA228bAdAe3';
 
+const pollingInterval = 1000;
+
 const createUnsignedTransaction = () => {
   return {
     from: addressFrom,
@@ -258,21 +269,24 @@ describe('SmartTransactionsController', () => {
   let networkListener: (networkState: NetworkState) => void;
 
   beforeEach(() => {
-    smartTransactionsController = new SmartTransactionsController({
-      onNetworkStateChange: (listener) => {
-        networkListener = listener;
+    smartTransactionsController = new SmartTransactionsController(
+      {
+        onNetworkStateChange: (listener) => {
+          networkListener = listener;
+        },
+        getNonceLock: jest.fn(() => {
+          return {
+            nextNonce: 'nextNonce',
+            releaseLock: jest.fn(),
+          };
+        }),
+        provider: jest.fn(),
+        confirmExternalTransaction: confirmExternalMock,
+        trackMetaMetricsEvent: trackMetaMetricsEventSpy,
+        getNetworkClientById: jest.fn(),
       },
-      getNonceLock: jest.fn(() => {
-        return {
-          nextNonce: 'nextNonce',
-          releaseLock: jest.fn(),
-        };
-      }),
-      provider: jest.fn(),
-      confirmExternalTransaction: confirmExternalMock,
-      trackMetaMetricsEvent: trackMetaMetricsEventSpy,
-      getNetworkClientById: jest.fn(),
-    });
+      { interval: pollingInterval },
+    );
     // eslint-disable-next-line jest/prefer-spy-on
     smartTransactionsController.subscribe = jest.fn();
   });
@@ -508,6 +522,54 @@ describe('SmartTransactionsController', () => {
     });
   });
 
+  describe.only('startPollingByNetworkClientId', () => {
+    it('calls smart transactions batch status api endpoint with the correct chainId at the interval passed via the constructor', async () => {
+      jest.useFakeTimers();
+      const pendingBatchStatusApiResponse =
+        createPendingBatchStatusApiResponse();
+      nock(API_BASE_URL)
+        .get(`/networks/${ethereumChainIdDec}/batchStatus?uuids=uuid1`)
+        .reply(200, pendingBatchStatusApiResponse);
+
+      smartTransactionsController.startPollingByNetworkClientId('mainnet');
+
+      await Promise.all([
+        jest.advanceTimersByTime(pollingInterval),
+        flushPromises(),
+      ]);
+
+      const pendingState = createStateAfterPending()[0];
+      const pendingTransaction = { ...pendingState, history: [pendingState] };
+      expect(smartTransactionsController.state).toStrictEqual({
+        smartTransactionsState: {
+          smartTransactions: {
+            [CHAIN_IDS.ETHEREUM]: [pendingTransaction],
+          },
+          userOptIn: undefined,
+          fees: {
+            approvalTxFees: undefined,
+            tradeTxFees: undefined,
+          },
+          feesByChainId: {
+            [CHAIN_IDS.ETHEREUM]: {
+              approvalTxFees: undefined,
+              tradeTxFees: undefined,
+            },
+            [CHAIN_IDS.GOERLI]: {
+              approvalTxFees: undefined,
+              tradeTxFees: undefined,
+            },
+          },
+          liveness: true,
+          livenessByChainId: {
+            [CHAIN_IDS.ETHEREUM]: true,
+            [CHAIN_IDS.GOERLI]: true,
+          },
+        },
+      });
+    });
+  });
+
   describe('fetchSmartTransactionsStatus', () => {
     beforeEach(() => {
       // eslint-disable-next-line jest/prefer-spy-on

src/SmartTransactionsController.ts

@@ -148,7 +148,7 @@ export default class SmartTransactionsController extends PollingControllerV1<
         },
       },
     };
-
+    this.setIntervalLength(this.config.interval || DEFAULT_INTERVAL);
     this.getNonceLock = getNonceLock;
     this.ethersProvider = new Web3Provider(provider);
     this.confirmExternalTransaction = confirmExternalTransaction;
@@ -170,6 +170,7 @@ export default class SmartTransactionsController extends PollingControllerV1<
   }
 
   executePoll(networkClientId: string): Promise<void> {
+    console.log('executePoll', networkClientId);
     // if this is going to be truly UI driven polling we shouldn't really reach here
     // with a networkClientId that is not supported, but for now I'll add a check in case
     // wondering if we should add some kind of predicate to the polling controller to check whether
@@ -465,7 +466,7 @@ export default class SmartTransactionsController extends PollingControllerV1<
     const params = new URLSearchParams({
       uuids: uuids.join(','),
     });
-
+    console.log('chainId', chainId);
     const url = `${getAPIRequestURL(
       APIType.BATCH_STATUS,
       chainId,