fix(testing): Update FAPI URL to use Regex on Playwright #7036
Conversation
🦋 Changeset detectedLatest commit: 684c26f The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
💡 Enable Vercel Agent with $100 free credit for automated AI reviews |
WalkthroughAdded a patch changeset and replaced a string/Glob-based Playwright API route matcher with a RegExp that escapes the Frontend API URL and enforces the v1 path plus optional query string. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Test as Playwright test
participant Setup as setupClerkTestingToken()
participant Router as Playwright Route matcher
participant Backend as Clerk Frontend API
Test->>Setup: initialize test fixture
Setup->>Router: register route matcher (RegExp anchored to Frontend API URL + /v1/...)
Note over Router,Backend: Router uses RegExp to match requests
Test->>Backend: perform API request
Backend-->>Router: request URL emitted
Router-->>Setup: matched via RegExp (handled)
Setup-->>Test: return mocked/handled response
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/testing/src/playwright/setupClerkTestingToken.ts (1)
41-41: The RegExp pattern is correct and addresses the Playwright v1.52 breaking change.The dot escaping and pattern construction work as intended. The
.*?(\\?.*)?pattern correctly matches the path and optional query string.Optional simplification:
The pattern could be simplified since the code manipulates URLs via the URL API rather than regex capture groups. Consider:
- const apiUrl = new RegExp(`^https://${fapiUrl.replace(/\./g, '\\.')}/v1/.*?(\\?.*)?$`); + const apiUrl = new RegExp(`^https://${fapiUrl.replace(/\./g, '\\.')}/v1/.*$`);The simpler
.*$pattern matches everything after/v1/(including query strings) and is more straightforward, though both patterns are functionally equivalent for this use case.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
.changeset/cool-keys-scream.md(1 hunks)packages/testing/src/playwright/setupClerkTestingToken.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (7)
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels
Files:
packages/testing/src/playwright/setupClerkTestingToken.ts
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/testing/src/playwright/setupClerkTestingToken.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/testing/src/playwright/setupClerkTestingToken.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/testing/src/playwright/setupClerkTestingToken.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Preferreadonlyfor properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Useconst assertionsfor literal types:as const
Usesatisfiesoperator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports:import type { ... } from ...
Noanytypes without justification
Proper error handling with typed errors
Consistent use ofreadonlyfor immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)
Files:
packages/testing/src/playwright/setupClerkTestingToken.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.
Files:
packages/testing/src/playwright/setupClerkTestingToken.ts
.changeset/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/cool-keys-scream.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: Build Packages
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
.changeset/cool-keys-scream.md (1)
1-5: LGTM! Changeset correctly documents the patch.The changeset properly categorizes this as a patch-level change for
@clerk/testingwith a clear description of the fix.
@clerk/agent-toolkit
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/dev-cli
@clerk/elements
@clerk/clerk-expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/clerk-react
@clerk/react-router
@clerk/remix
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/themes
@clerk/types
@clerk/upgrade
@clerk/vue
commit: |
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
packages/testing/src/playwright/setupClerkTestingToken.ts (1)
42-43: Backslash escaping is now covered—resolves prior alert
/[.*+?^${}()|[\]\\]/gescapes\and], addressing the previous “incomplete escaping” warning.
🧹 Nitpick comments (4)
packages/testing/src/playwright/setupClerkTestingToken.ts (4)
42-44: Good fix; harden matcher with normalization and cheaper patternThe escape is correct. To make the matcher more robust and reduce backtracking, normalize the host, use a case‑insensitive host match, and avoid lazy
.*?before an optional group.Apply:
- const escapedFapiUrl = fapiUrl.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); - const apiUrl = new RegExp(`^https://${escapedFapiUrl}/v1/.*?(\\?.*)?$`); + const normalizedHost = fapiUrl.replace(/^\s*https?:\/\//i, '').replace(/\/+$/, ''); + const escapedHost = normalizedHost.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); + // If you need to support http for local setups, change ^https:// to ^https?:// + const apiUrl = new RegExp(`^https://${escapedHost}/v1(?:/[^?]*)?(?:\\?.*)?$`, 'i');
49-51: Don’t overwrite an existing testing token in the URLAvoid clobbering a pre‑set token.
- if (testingToken) { - originalUrl.searchParams.set(TESTING_TOKEN_PARAM, testingToken); - } + if (testingToken && !originalUrl.searchParams.has(TESTING_TOKEN_PARAM)) { + originalUrl.searchParams.set(TESTING_TOKEN_PARAM, testingToken); + }
53-80: Avoid extra network round‑trip for non‑JSON responsesCurrently, a non‑JSON response triggers
route.fetch()thenroute.continue(), sending a second request. Fulfill with the first response when it’s not JSON; only parse/patch when JSON.try { - const response = await route.fetch({ - url: originalUrl.toString(), - }); - - const json = await response.json(); + const response = await route.fetch({ url: originalUrl.toString() }); + const contentType = (response.headers()['content-type'] || '').toLowerCase(); + if (!contentType.includes('application/json')) { + await route.fulfill({ response }); + return; + } + const json = await response.json(); @@ - await route.fulfill({ - response, - json, - }); - } catch { + await route.fulfill({ response, json }); + } catch (err) { await route .continue({ url: originalUrl.toString(), }) .catch(console.error); }
30-30: Add explicit return type per project guidelinesDeclare
Promise<void>for this exported function.-export const setupClerkTestingToken = async ({ context, options, page }: SetupClerkTestingTokenParams) => { +export const setupClerkTestingToken = async ( + { context, options, page }: SetupClerkTestingTokenParams, +): Promise<void> => {
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
packages/testing/src/playwright/setupClerkTestingToken.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels
Files:
packages/testing/src/playwright/setupClerkTestingToken.ts
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/testing/src/playwright/setupClerkTestingToken.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/testing/src/playwright/setupClerkTestingToken.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/testing/src/playwright/setupClerkTestingToken.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Preferreadonlyfor properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Useconst assertionsfor literal types:as const
Usesatisfiesoperator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports:import type { ... } from ...
Noanytypes without justification
Proper error handling with typed errors
Consistent use ofreadonlyfor immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)
Files:
packages/testing/src/playwright/setupClerkTestingToken.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.
Files:
packages/testing/src/playwright/setupClerkTestingToken.ts
🪛 ast-grep (0.39.6)
packages/testing/src/playwright/setupClerkTestingToken.ts
[warning] 42-42: Regular expression constructed from variable input detected. This can lead to Regular Expression Denial of Service (ReDoS) attacks if the variable contains malicious patterns. Use libraries like 'recheck' to validate regex safety or use static patterns.
Context: new RegExp(^https://${escapedFapiUrl}/v1/.*?(\\?.*)?$)
Note: [CWE-1333] Inefficient Regular Expression Complexity [REFERENCES]
- https://owasp.org/www-community/attacks/Regular_expression_Denial_of_Service_-_ReDoS
- https://cwe.mitre.org/data/definitions/1333.html
(regexp-from-variable)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: Build Packages
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
…right-breaking-change-in-url
anagstef
deleted the
stefanos/user-3743-fix-interceptor-for-playwright-breaking-change-in-url
branch
4 participants
Description
Playwright released a breaking change on their
1.52release that affects us. This is a fix for it.Playwright changelog: https://playwright.dev/docs/release-notes#breaking-changes-2
Specific breaking change that affects us:
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit