feat: add missing test coverage

Author: rarquevaux

app/scripts/messenger-client-init/confirmations/transaction-controller-init.test.ts

@@ -10,6 +10,8 @@ import {
   TransactionControllerOptions,
   TransactionStatus,
   PublishHook,
+  PublishBatchHookRequest,
+  PublishBatchHookTransaction,
 } from '@metamask/transaction-controller';
 import { TransactionPayPublishHook } from '@metamask/transaction-pay-controller';
 import {
@@ -581,4 +583,165 @@ describe('Transaction Controller Init', () => {
       });
     });
   });
+
+  describe('publishBatch hook', () => {
+    const mockTransactionMeta: TransactionMeta = {
+      id: 'batch-tx-last',
+      chainId: CHAIN_ID_MOCK,
+      status: TransactionStatus.approved,
+      time: Date.now(),
+      txParams: {
+        from: '0x0000000000000000000000000000000000000000',
+      },
+      networkClientId: 'test-network',
+    };
+
+    it('calls upsertTransactionUIMetricsFragment with sentinel_stx for each batch tx with an id on STX success', async () => {
+      jest
+        .mocked(smartTransactionsModule.getSmartTransactionCommonParams)
+        .mockReturnValue({
+          isSmartTransaction: true,
+          featureFlags: {
+            extensionReturnTxHashAsap: false,
+            extensionReturnTxHashAsapBatch: false,
+            extensionSkipSmartTransactionStatusPage: false,
+            mobileActive: false,
+            extensionActive: false,
+          },
+          isHardwareWalletAccount: false,
+        });
+
+      jest
+        .mocked(smartTransactionsModule.submitBatchSmartTransactionHook)
+        .mockResolvedValue({ results: [] });
+
+      const upsertFragmentMock = jest.fn();
+      const requestMock = buildInitRequestMock();
+      requestMock.getTransactionMetricsRequest.mockReturnValue({
+        upsertTransactionUIMetricsFragment: upsertFragmentMock,
+      } as unknown as ReturnType<
+        typeof requestMock.getTransactionMetricsRequest
+      >);
+
+      TransactionControllerInit(requestMock);
+
+      const { hooks } = transactionControllerClassMock.mock.calls[0][0];
+      const controllerInstance =
+        transactionControllerClassMock.mock.instances[0];
+      // @ts-expect-error Partial mock state
+      controllerInstance.state = {
+        transactions: [mockTransactionMeta],
+      };
+
+      await hooks?.publishBatch?.({
+        transactions: [
+          { id: 'batch-tx-1' } as unknown as PublishBatchHookTransaction,
+          { id: 'batch-tx-last' } as unknown as PublishBatchHookTransaction,
+        ],
+      } as unknown as PublishBatchHookRequest);
+
+      expect(upsertFragmentMock).toHaveBeenCalledTimes(2);
+      expect(upsertFragmentMock).toHaveBeenCalledWith('batch-tx-1', {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        properties: { transaction_submission_method: 'sentinel_stx' },
+      });
+      expect(upsertFragmentMock).toHaveBeenCalledWith('batch-tx-last', {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        properties: { transaction_submission_method: 'sentinel_stx' },
+      });
+    });
+
+    it('skips upsertTransactionUIMetricsFragment for batch txs without an id', async () => {
+      jest
+        .mocked(smartTransactionsModule.getSmartTransactionCommonParams)
+        .mockReturnValue({
+          isSmartTransaction: true,
+          featureFlags: {
+            extensionReturnTxHashAsap: false,
+            extensionReturnTxHashAsapBatch: false,
+            extensionSkipSmartTransactionStatusPage: false,
+            mobileActive: false,
+            extensionActive: false,
+          },
+          isHardwareWalletAccount: false,
+        });
+
+      jest
+        .mocked(smartTransactionsModule.submitBatchSmartTransactionHook)
+        .mockResolvedValue({ results: [] });
+
+      const upsertFragmentMock = jest.fn();
+      const requestMock = buildInitRequestMock();
+      requestMock.getTransactionMetricsRequest.mockReturnValue({
+        upsertTransactionUIMetricsFragment: upsertFragmentMock,
+      } as unknown as ReturnType<
+        typeof requestMock.getTransactionMetricsRequest
+      >);
+
+      TransactionControllerInit(requestMock);
+
+      const { hooks } = transactionControllerClassMock.mock.calls[0][0];
+      const controllerInstance =
+        transactionControllerClassMock.mock.instances[0];
+      // @ts-expect-error Partial mock state
+      controllerInstance.state = {
+        transactions: [mockTransactionMeta],
+      };
+
+      await hooks?.publishBatch?.({
+        transactions: [
+          {} as unknown as PublishBatchHookTransaction,
+          { id: 'batch-tx-last' } as unknown as PublishBatchHookTransaction,
+        ],
+      } as unknown as PublishBatchHookRequest);
+
+      expect(upsertFragmentMock).toHaveBeenCalledTimes(1);
+      expect(upsertFragmentMock).toHaveBeenCalledWith('batch-tx-last', {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        properties: { transaction_submission_method: 'sentinel_stx' },
+      });
+    });
+
+    it('does not call upsertTransactionUIMetricsFragment when publishBatchHook returns undefined', async () => {
+      jest
+        .mocked(smartTransactionsModule.getSmartTransactionCommonParams)
+        .mockReturnValue({
+          isSmartTransaction: false,
+          featureFlags: {
+            extensionReturnTxHashAsap: false,
+            extensionReturnTxHashAsapBatch: false,
+            extensionSkipSmartTransactionStatusPage: false,
+            mobileActive: false,
+            extensionActive: false,
+          },
+          isHardwareWalletAccount: false,
+        });
+
+      const upsertFragmentMock = jest.fn();
+      const requestMock = buildInitRequestMock();
+      requestMock.getTransactionMetricsRequest.mockReturnValue({
+        upsertTransactionUIMetricsFragment: upsertFragmentMock,
+      } as unknown as ReturnType<
+        typeof requestMock.getTransactionMetricsRequest
+      >);
+
+      TransactionControllerInit(requestMock);
+
+      const { hooks } = transactionControllerClassMock.mock.calls[0][0];
+      const controllerInstance =
+        transactionControllerClassMock.mock.instances[0];
+      // @ts-expect-error Partial mock state
+      controllerInstance.state = {
+        transactions: [mockTransactionMeta],
+      };
+
+      await hooks?.publishBatch?.({
+        transactions: [
+          { id: 'batch-tx-last' } as unknown as PublishBatchHookTransaction,
+        ],
+      } as unknown as PublishBatchHookRequest);
+
+      expect(upsertFragmentMock).not.toHaveBeenCalled();
+    });
+  });
 });

app/scripts/metamask-controller.test.js

@@ -334,6 +334,23 @@ jest.mock('../../shared/lib/environment', () => ({
   getEnabledAdvancedPermissions: jest.fn(() => []),
 }));
 
+jest.mock('../../shared/lib/selectors/smart-transactions', () => {
+  const actual = jest.requireActual(
+    '../../shared/lib/selectors/smart-transactions',
+  );
+  return {
+    ...actual,
+    // Plain implementation avoids Reselect identity-function console warnings when
+    // getTransactionMetricsRequest tests call through MetaMaskController.
+    getSmartTransactionsPreferenceEnabled: (state) => {
+      const preferences = state?.metamask?.preferences ?? {};
+      const optIn = preferences.smartTransactionsOptInStatus;
+      const DEFAULT_SMART_TRANSACTIONS_ENABLED = true;
+      return optIn ?? DEFAULT_SMART_TRANSACTIONS_ENABLED;
+    },
+  };
+});
+
 jest.mock('./lib/forwardRequestToSnap', () => ({
   forwardRequestToSnap: jest.fn().mockResolvedValue({}),
 }));
@@ -1042,6 +1059,23 @@ describe('MetaMaskController', () => {
       });
     });
 
+    describe('getTransactionMetricsRequest', () => {
+      it('getSmartTransactionsPreferenceEnabled returns selector result from metamask state', () => {
+        metamaskController.preferencesController.update((state) => {
+          state.preferences.smartTransactionsOptInStatus = false;
+        });
+        const { getSmartTransactionsPreferenceEnabled } =
+          metamaskController.getTransactionMetricsRequest();
+        expect(getSmartTransactionsPreferenceEnabled()).toBe(false);
+      });
+
+      it('getSmartTransactionsEnabled returns selector result for a given chainId', () => {
+        const { getSmartTransactionsEnabled } =
+          metamaskController.getTransactionMetricsRequest();
+        expect(getSmartTransactionsEnabled(MAINNET_CHAIN_ID)).toBe(false);
+      });
+    });
+
     describe('submitPassword', () => {
       it('removes any identities that do not correspond to known accounts.', async () => {
         const localMetaMaskController = new MetaMaskController({