test: stabilize swap deeplink smoke after sendToHome on iOS (MetaMask#29523)

davibroc · web-flow · commit 8d4e444f188b · 2026-04-30T22:41:38.000Z
## **Description** On iOS<16, Detox’s device.sendToHome() brings the home screen to the front. On iOS 16 and later, that path is not used the same way from the simulator tooling, so Detox instead launches and immediately quits the Settings app to put the app under test in the background. That can briefly show Settings and race the next step. This PR tightens tests/smoke/swap/swap-deeplink-smoke.spec.ts: a 1 second wait after sendToHome() before launchApp({ url }), newInstance: false on those launchApp calls so the flow is clearly “same app instance, URL delivered after background,” and short comments above each wait explaining the pre‑16 vs 16+ behavior. ## **Changelog**  CHANGELOG entry: ## **Related issues** Fixes: ## **Manual testing steps** ```gherkin Feature: my feature name Scenario: user [verb for user action] Given [describe expected initial app state] When user [verb for user action] Then [describe expected outcome] ``` ## **Screenshots/Recordings**  ### **Before**  ### **After**  ## **Pre-merge author checklist**  - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile Coding Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I've included tests if applicable - [x] I've documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I've applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. #### Performance checks (if applicable) - [x] I've tested on Android - Ideally on a mid-range device; emulator is acceptable - [x] I've tested with a power user scenario - Use these [power-user SRPs](https://consensyssoftware.atlassian.net/wiki/spaces/TL1/pages/edit-v2/401401446401?draftShareId=9d77e1e1-4bdc-4be1-9ebb-ccd916988d93) to import wallets with many accounts and tokens - [ ] I've instrumented key operations with Sentry traces for production performance metrics - See [`trace()`](/app/util/trace.ts) for usage and [`addToken`](/app/components/Views/AddAsset/components/AddCustomToken/AddCustomToken.tsx#L274) for an example For performance guidelines and tooling, see the [Performance Guide](https://consensyssoftware.atlassian.net/wiki/spaces/TL1/pages/400085549067/Performance+Guide+for+Engineers). ## **Pre-merge reviewer checklist**  - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.  --- > [!NOTE] > **Low Risk** > Test-only changes that adjust Detox app launching behavior and add additional HTTP mocks; low risk to production code, with minor risk of masking real integration issues if mock matching is too broad. > > **Overview** > Stabilizes swap deeplink smoke tests on iOS by adding a short post-`sendToHome()` delay and launching deeplinks with `newInstance: false` to ensure URLs are delivered to the existing app instance. > > Expands swap E2E mocking by introducing reusable `setupSwapSocialAndComplianceMocks()` to stub the Social leaderboard and compliance batch endpoints, wiring it into swap and trending-token smoke setups. Also tightens the swap proxy URL interception so the `insufficientBal` rewrite only targets JSON `getQuote` requests (not `getQuoteStream`). > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit edbfe2c. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup>
diff --git a/tests/helpers/swap/swap-mocks.ts b/tests/helpers/swap/swap-mocks.ts
@@ -6,6 +6,7 @@ import {
   setupMockRequest,
   setupSSEMockRequest,
 } from '../../api-mocking/helpers/mockHelpers';
+import { getDecodedProxiedURL } from '../../smoke/notifications/utils/helpers';
 import {
   GET_QUOTE_ETH_USDC_RESPONSE,
   GET_QUOTE_ETH_USDC_RESPONSE_CUSTOM_SLIPPAGE,
@@ -30,6 +31,9 @@ const WETH_MAINNET = '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2';
 const GOOGLON_MAINNET = '0xba47214edd2bb43099611b208f75e4b42fdcfedc';
 const MUSD_MAINNET = '0xaca92e438df0b2401ff60da7e4337b687a2435da';
 
+/** SocialService leaderboard response shape (empty list is valid for E2E). */
+const SOCIAL_LEADERBOARD_EMPTY_RESPONSE = { traders: [] };
+
 /**
  * Mock spot prices so balance display (balance * price) does not show NaN.
  * Shared by swap and bridge E2E tests.
@@ -77,10 +81,64 @@ export async function setupSpotPricesMock(mockServer: Mockttp): Promise<void> {
   });
 }
 
+/**
+ * Social leaderboard + compliance batch — used by swap `testSpecificMock` and
+ * bridge/trending specs that do not use swap-mocks’ full mock bundle.
+ */
+export async function setupSwapSocialAndComplianceMocks(
+  mockServer: Mockttp,
+): Promise<void> {
+  await setupMockRequest(
+    mockServer,
+    {
+      requestMethod: 'GET',
+      url: /social\.api\.cx\.metamask\.io\/api\/v1\/leaderboard/,
+      response: SOCIAL_LEADERBOARD_EMPTY_RESPONSE,
+      responseCode: 200,
+    },
+    1001,
+  );
+
+  await mockServer
+    .forPost('/proxy')
+    .matching((request) => {
+      try {
+        const decodedUrl = getDecodedProxiedURL(request.url);
+        return /compliance\.(dev-api|api|uat-api)\.cx\.metamask\.io\/v1\/wallet\/batch/.test(
+          decodedUrl,
+        );
+      } catch {
+        return false;
+      }
+    })
+    .asPriority(1001)
+    .thenCallback(async (request) => {
+      let addresses: string[] = [];
+      try {
+        const text = await request.body.getText();
+        if (text) {
+          const parsed = JSON.parse(text) as unknown;
+          if (Array.isArray(parsed)) {
+            addresses = parsed.filter(
+              (a): a is string => typeof a === 'string',
+            );
+          }
+        }
+      } catch {
+        /* ignore malformed body */
+      }
+      return {
+        statusCode: 200,
+        json: addresses.map((address) => ({ address, blocked: false })),
+      };
+    });
+}
+
 export const testSpecificMock: TestSpecificMock = async (
   mockServer: Mockttp,
 ) => {
   await setupSpotPricesMock(mockServer);
+  await setupSwapSocialAndComplianceMocks(mockServer);
 
   // Catch-all for getQuoteStream with no slippage param (initial render before
   // useInitialSlippage fires). Registered first so specific mocks below at
@@ -206,7 +264,10 @@ export const testSpecificMock: TestSpecificMock = async (
 
   await interceptProxyUrl(
     mockServer,
-    (url) => url.includes('getQuote') && url.includes('insufficientBal=false'),
+    (url) =>
+      url.includes('getQuote') &&
+      !url.includes('getQuoteStream') &&
+      url.includes('insufficientBal=false'),
     (url) => url.replace('insufficientBal=false', 'insufficientBal=true'),
   );
 };
diff --git a/tests/helpers/swap/swap-unified-ui.ts b/tests/helpers/swap/swap-unified-ui.ts
@@ -1,9 +1,12 @@
 import QuoteView from '../../page-objects/swaps/QuoteView';
 import SlippageModal from '../../page-objects/swaps/SlippageModal';
 import { Assertions } from '../../framework';
+import { createLogger } from '../../framework/logger';
 import ActivitiesView from '../../page-objects/Transactions/ActivitiesView';
 import { ActivitiesViewSelectorsText } from '../../../app/components/Views/ActivityView/ActivitiesView.testIds';
 
+const logger = createLogger({ name: 'SwapUnifiedUI' });
+
 interface SwapOptions {
   /** Custom slippage percentage (e.g., "2.5" for 2.5%) */
   slippage?: string;
@@ -30,9 +33,11 @@ export async function submitSwapUnifiedUI(
   await QuoteView.tapDestinationToken();
   await QuoteView.tapToken(chainId, destTokenSymbol);
 
+  const getQuoteStarted = Date.now();
   await Assertions.expectElementToBeVisible(QuoteView.networkFeeLabel, {
     timeout: 60000,
   });
+  logger.debug(`⏳ Quote visible after ${Date.now() - getQuoteStarted}ms`);
 
   // Dismiss the keypad so quote details (slippage, confirm) are not obscured
   await QuoteView.dismissKeypad();
diff --git a/tests/smoke/swap/swap-deeplink-smoke.spec.ts b/tests/smoke/swap/swap-deeplink-smoke.spec.ts
@@ -11,6 +11,7 @@ import Assertions from '../../framework/Assertions';
 import { asDetoxElement } from '../../framework';
 import QuoteView from '../../page-objects/swaps/QuoteView';
 import { testSpecificMock } from '../../helpers/swap/swap-mocks';
+import TestHelpers from '../../helpers';
 import WalletView from '../../page-objects/wallet/WalletView';
 
 // Deep link URLs for testing unified swap/bridge experience
@@ -62,7 +63,10 @@ describe(
         async () => {
           await loginToApp();
           await device.sendToHome();
+          // intentional: Detox iOS 16+ sendToHome briefly opens Settings; wait before launchApp({ url }).
+          if (device.getPlatform() === 'ios') await TestHelpers.delay(1000);
           await device.launchApp({
+            newInstance: false,
             url: SWAP_DEEPLINK_FULL,
           });
 
@@ -121,7 +125,10 @@ describe(
         async () => {
           await loginToApp();
           await device.sendToHome();
+          // intentional: Detox iOS 16+ sendToHome briefly opens Settings; wait before launchApp({ url }).
+          if (device.getPlatform() === 'ios') await TestHelpers.delay(1000);
           await device.launchApp({
+            newInstance: false,
             url: SWAP_DEEPLINK_BASE,
           });
 
@@ -175,7 +182,10 @@ describe(
         async () => {
           await loginToApp();
           await device.sendToHome();
+          // intentional: Detox iOS 16+ sendToHome briefly opens Settings; wait before launchApp({ url }).
+          if (device.getPlatform() === 'ios') await TestHelpers.delay(1000);
           await device.launchApp({
+            newInstance: false,
             url: invalidDeeplink,
           });
 
diff --git a/tests/smoke/swap/swap-trending-tokens.spec.ts b/tests/smoke/swap/swap-trending-tokens.spec.ts
@@ -11,6 +11,7 @@ import TokenOverview from '../../page-objects/wallet/TokenOverview';
 import FixtureBuilder from '../../framework/fixtures/FixtureBuilder';
 import { prepareSwapsTestEnvironment } from '../../helpers/swap/prepareSwapsTestEnvironment';
 import { testSpecificMock } from '../../helpers/swap/bridge-mocks';
+import { setupSwapSocialAndComplianceMocks } from '../../helpers/swap/swap-mocks';
 import { GET_QUOTE_ETH_USDC_RESPONSE } from '../../helpers/swap/constants';
 import { getDecodedProxiedURL } from '../notifications/utils/helpers';
 import { SmokeSwap } from '../../tags';
@@ -77,6 +78,8 @@ const setupSwapsTrendingTokensMock = async (mockServer: Mockttp) => {
     },
     1001,
   );
+
+  await setupSwapSocialAndComplianceMocks(mockServer);
 };
 
 const setupTrendingTokensMock = async (mockServer: Mockttp) => {
