fix test flakiness

Author: Lms24

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/linked-traces/consistent-sampling/default/test.ts

@@ -9,6 +9,7 @@ import { sentryTest } from '../../../../../../utils/fixtures';
 import {
   eventAndTraceHeaderRequestParser,
   shouldSkipTracingTest,
+  waitForTracingHeadersOnUrl,
   waitForTransactionRequest,
 } from '../../../../../../utils/helpers';
 
@@ -109,19 +110,13 @@ sentryTest.describe('When `consistentTraceSampling` is `true`', () => {
     });
 
     await sentryTest.step('Make fetch request', async () => {
-      let sentryTrace = undefined;
-      let baggage = undefined;
-
-      await page.route('https://someUrl.com', (route, req) => {
-        baggage = req.headers()['baggage'];
-        sentryTrace = req.headers()['sentry-trace'];
-        return route.fulfill({ status: 200, body: 'ok' });
-      });
-
       const fetchTracePromise = waitForTransactionRequest(page, evt => evt.contexts?.trace?.op === 'custom');
+      const tracingHeadersPromise = waitForTracingHeadersOnUrl(page, 'https://someUrl.com');
 
       await page.locator('#btn2').click();
 
+      const { baggage, sentryTrace } = await tracingHeadersPromise;
+
       const [fetchTraceEvent, fetchTraceTraceHeader] = eventAndTraceHeaderRequestParser(await fetchTracePromise);
 
       const fetchTraceSampleRand = Number(fetchTraceTraceHeader?.sample_rand);

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/linked-traces/consistent-sampling/meta-negative/test.ts

@@ -8,6 +8,7 @@ import {
   hidePage,
   shouldSkipTracingTest,
   waitForClientReportRequest,
+  waitForTracingHeadersOnUrl,
 } from '../../../../../../utils/helpers';
 
 const metaTagSampleRand = 0.9;
@@ -49,16 +50,10 @@ sentryTest.describe('When `consistentTraceSampling` is `true` and page contains
       });
 
       await sentryTest.step('Make fetch request', async () => {
-        let sentryTrace = undefined;
-        let baggage = undefined;
-
-        await page.route('https://someUrl.com', (route, req) => {
-          baggage = req.headers()['baggage'];
-          sentryTrace = req.headers()['sentry-trace'];
-          return route.fulfill({ status: 200, body: 'ok' });
-        });
+        const tracingHeadersPromise = waitForTracingHeadersOnUrl(page, 'https://someUrl.com');
 
         await page.locator('#btn2').click();
+        const { baggage, sentryTrace } = await tracingHeadersPromise;
 
         expect(sentryTrace).toBeDefined();
         expect(baggage).toBeDefined();

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/linked-traces/consistent-sampling/meta-precedence/test.ts

@@ -8,6 +8,7 @@ import {
   hidePage,
   shouldSkipTracingTest,
   waitForClientReportRequest,
+  waitForTracingHeadersOnUrl,
   waitForTransactionRequest,
 } from '../../../../../../utils/helpers';
 
@@ -33,17 +34,12 @@ sentryTest.describe('When `consistentTraceSampling` is `true` and page contains
       });
 
       await sentryTest.step('Make fetch request', async () => {
-        let sentryTrace = undefined;
-        let baggage = undefined;
-
-        await page.route('https://someUrl.com', (route, req) => {
-          baggage = req.headers()['baggage'];
-          sentryTrace = req.headers()['sentry-trace'];
-          return route.fulfill({ status: 200, body: 'ok' });
-        });
+        const tracingHeadersPromise = waitForTracingHeadersOnUrl(page, 'https://someUrl.com');
 
         await page.locator('#btn2').click();
 
+        const { baggage, sentryTrace } = await tracingHeadersPromise;
+
         expect(sentryTrace).toBeDefined();
         expect(baggage).toBeDefined();
 

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/linked-traces/consistent-sampling/meta/test.ts

@@ -9,6 +9,7 @@ import { sentryTest } from '../../../../../../utils/fixtures';
 import {
   eventAndTraceHeaderRequestParser,
   shouldSkipTracingTest,
+  waitForTracingHeadersOnUrl,
   waitForTransactionRequest,
 } from '../../../../../../utils/helpers';
 
@@ -129,19 +130,13 @@ sentryTest.describe('When `consistentTraceSampling` is `true` and page contains
       });
 
       await sentryTest.step('Make fetch request', async () => {
-        let sentryTrace = undefined;
-        let baggage = undefined;
-
-        await page.route('https://someUrl.com', (route, req) => {
-          baggage = req.headers()['baggage'];
-          sentryTrace = req.headers()['sentry-trace'];
-          return route.fulfill({ status: 200, body: 'ok' });
-        });
-
         const fetchTracePromise = waitForTransactionRequest(page, evt => evt.contexts?.trace?.op === 'custom');
+        const tracingHeadersPromise = waitForTracingHeadersOnUrl(page, 'https://someUrl.com');
 
         await page.locator('#btn2').click();
 
+        const { baggage, sentryTrace } = await tracingHeadersPromise;
+
         const [fetchTraceEvent, fetchTraceTraceHeader] = eventAndTraceHeaderRequestParser(await fetchTracePromise);
 
         const fetchTraceSampleRand = Number(fetchTraceTraceHeader?.sample_rand);

dev-packages/browser-integration-tests/utils/helpers.ts

@@ -460,3 +460,22 @@ export async function hidePage(page: Page): Promise<void> {
     document.dispatchEvent(new Event('visibilitychange'));
   });
 }
+
+export async function waitForTracingHeadersOnUrl(
+  page: Page,
+  url: string,
+): Promise<{ baggage: string; sentryTrace: string }> {
+  return new Promise<{ baggage: string; sentryTrace: string }>(resolve => {
+    page
+      .route(url, (route, req) => {
+        const baggage = req.headers()['baggage'];
+        const sentryTrace = req.headers()['sentry-trace'];
+        resolve({ baggage, sentryTrace });
+        return route.fulfill({ status: 200, body: 'ok' });
+      })
+      .catch(error => {
+        // Handle any routing setup errors
+        throw error;
+      });
+  });
+}