fix(testing): Fix captcha triggering issue in Playwright tests (#5075)

Author: anagstef

.changeset/smooth-insects-perform.md

@@ -0,0 +1,5 @@
+---
+'@clerk/testing': patch
+---
+
+Fix captcha triggering on Playwright tests

packages/testing/src/playwright/setupClerkTestingToken.ts

@@ -31,16 +31,41 @@ export const setupClerkTestingToken = async ({ page, options }: SetupClerkTestin
   }
   const apiUrl = `https://${fapiUrl}/v1/**/*`;
 
-  await page.route(apiUrl, (route, request) => {
-    const originalUrl = new URL(request.url());
+  await page.route(apiUrl, async route => {
+    const originalUrl = new URL(route.request().url());
     const testingToken = process.env.CLERK_TESTING_TOKEN;
 
     if (testingToken) {
       originalUrl.searchParams.set(TESTING_TOKEN_PARAM, testingToken);
     }
 
-    void route.continue({
-      url: originalUrl.toString(),
-    });
+    try {
+      const response = await route.fetch({
+        url: originalUrl.toString(),
+      });
+
+      const json = await response.json();
+
+      // Override captcha_bypass in /v1/client
+      if (json?.response?.captcha_bypass === false) {
+        json.response.captcha_bypass = true;
+      }
+
+      // Override captcha_bypass in piggybacking
+      if (json?.client?.captcha_bypass === false) {
+        json.client.captcha_bypass = true;
+      }
+
+      await route.fulfill({
+        response,
+        json,
+      });
+    } catch {
+      await route
+        .continue({
+          url: originalUrl.toString(),
+        })
+        .catch(console.error);
+    }
   });
 };

packages/types/src/json.ts

@@ -70,7 +70,7 @@ export interface ClientJSON extends ClerkResourceJSON {
   sessions: SessionJSON[];
   sign_up: SignUpJSON | null;
   sign_in: SignInJSON | null;
-  captcha_bypass?: boolean;
+  captcha_bypass?: boolean; // this is used by the @clerk/testing package
   last_active_session_id: string | null;
   cookie_expires_at: number | null;
   created_at: number;