fix(clerk-js): Remove condition to always send redirect_url for SSO with after-auth
#6498
Conversation
🦋 Changeset detectedLatest commit: d336777 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
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 Git ↗︎
|
21b4f5e to
5657b07
Compare
📝 WalkthroughWalkthroughThe changes update the redirect URL handling logic for single sign-on (SSO) flows in the Estimated code review effort🎯 3 (Moderate) | ⏱️ ~15 minutes Note 🔌 MCP (Model Context Protocol) integration is now available in Early Access!Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
@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
🔭 Outside diff range comments (1)
.changeset/mighty-ducks-occur.md (1)
6-6: Remove stray character on the last lineThere’s a lone "6" on the final line that will end up in release notes and can confuse readers.
Apply this diff:
-6 +
🧹 Nitpick comments (4)
.changeset/mighty-ducks-occur.md (1)
5-5: Optional: tighten up the summary sentenceAdd a period and optionally clarify “after-auth flows” to improve the release note readability.
-Remove sending `redirect_url_complete` as `redirect_url` for SSO with after-auth flows +Remove sending `redirect_url_complete` as `redirect_url` for SSO with after-auth flows.packages/clerk-js/src/core/resources/SignUp.ts (1)
291-303: Parity check: confirm whetherredirectUrlshould still include auth token hereSignUp still uses
redirectUrlWithAuthTokenwhile SignIn switched to passing rawredirectUrlduring the initial create path (but still usesbuildUrlWithAuthin prepare-first-factor for SSO). If the intent is to unify semantics across SignIn/SignUp, consider passing the rawredirectUrlhere as well. Otherwise, please confirm this difference is intentional.If alignment is desired, here’s a minimal change:
- const redirectUrlWithAuthToken = SignUp.clerk.buildUrlWithAuth(redirectUrl); - const authenticateFn = () => { const authParams = { strategy, - redirectUrl: redirectUrlWithAuthToken, + redirectUrl, actionCompleteRedirectUrl: redirectUrlComplete, unsafeMetadata, emailAddress, legalAccepted, oidcPrompt, }; return continueSignUp && this.id ? this.update(authParams) : this.create(authParams); };Also, please add tests to ensure:
actionCompleteRedirectUrlis forwarded asredirectUrlComplete.redirectUrlis not replaced withredirect_url_complete.packages/clerk-js/src/core/resources/SignIn.ts (2)
587-595: AlignSignInFuture.ssowith the new semantics (optional)This path still constructs
redirectUrlWithAuthTokenfor the initialcreate. To avoid divergent behavior betweenSignIn.authenticateWithRedirectOrPopupandSignInFuture.sso, consider passing the rawredirectUrland relying on FAPI + prepare flow to handle auth URL construction where needed.- const redirectUrlWithAuthToken = SignIn.clerk.buildUrlWithAuth(redirectUrl); - if (!this.resource.id) { await this.create({ strategy, - redirectUrl: redirectUrlWithAuthToken, + redirectUrl, actionCompleteRedirectUrl: redirectUrlComplete, }); }Please also add/update tests to cover:
createreceives rawredirectUrlin this path.- end-to-end navigation remains correct for SSO via
SignInFuture.sso.
282-294: Add tests to lock the new behaviorPlease add unit/integration tests verifying:
createis invoked with rawredirectUrlandactionCompleteRedirectUrl = redirectUrlComplete.- For SSO strategies, prepare-first-factor uses the appropriate URL builder (if still required).
- The SDK does not navigate to
/sso-callbackprematurely when the session is not pending.I can draft the test scaffolding for these flows (mocks for FAPI client + navigation), if helpful.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.changeset/mighty-ducks-occur.md(1 hunks)packages/clerk-js/src/core/resources/SignIn.ts(1 hunks)packages/clerk-js/src/core/resources/SignUp.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (8)
**/*.{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/clerk-js/src/core/resources/SignIn.tspackages/clerk-js/src/core/resources/SignUp.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/clerk-js/src/core/resources/SignIn.tspackages/clerk-js/src/core/resources/SignUp.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/core/resources/SignIn.tspackages/clerk-js/src/core/resources/SignUp.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/clerk-js/src/core/resources/SignIn.tspackages/clerk-js/src/core/resources/SignUp.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/clerk-js/src/core/resources/SignIn.tspackages/clerk-js/src/core/resources/SignUp.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/clerk-js/src/core/resources/SignIn.tspackages/clerk-js/src/core/resources/SignUp.ts
**/*
⚙️ CodeRabbit Configuration File
If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.
Files:
packages/clerk-js/src/core/resources/SignIn.tspackages/clerk-js/src/core/resources/SignUp.ts
.changeset/**
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/mighty-ducks-occur.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). (22)
- GitHub Check: Unit Tests (22, **)
- GitHub Check: Integration Tests (quickstart, chrome)
- GitHub Check: Integration Tests (billing, chrome)
- GitHub Check: Integration Tests (sessions, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 15)
- GitHub Check: Integration Tests (nuxt, chrome)
- GitHub Check: Integration Tests (elements, chrome)
- GitHub Check: Integration Tests (generic, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 14)
- GitHub Check: Integration Tests (react-router, chrome)
- GitHub Check: Integration Tests (localhost, chrome)
- GitHub Check: Integration Tests (vue, chrome)
- GitHub Check: Integration Tests (astro, chrome)
- GitHub Check: Integration Tests (expo-web, chrome)
- GitHub Check: Integration Tests (tanstack-react-router, chrome)
- GitHub Check: Integration Tests (ap-flows, chrome)
- GitHub Check: Integration Tests (express, chrome)
- GitHub Check: Integration Tests (tanstack-react-start, chrome)
- GitHub Check: Unit Tests (18, --filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@c...
- GitHub Check: Publish with pkg-pr-new
- GitHub Check: Static analysis
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (4)
.changeset/mighty-ducks-occur.md (1)
2-5: Changeset entry is appropriate (patch) and message is clearPatch bump for '@clerk/clerk-js' aligns with the described behavioral change. Looks good.
packages/clerk-js/src/core/resources/SignUp.ts (1)
294-299: Directly usingredirectUrlCompleteforactionCompleteRedirectUrlis correctThis aligns the responsibility with FAPI and removes the SDK-side conditional. Good step toward simplifying after-auth SSO.
packages/clerk-js/src/core/resources/SignIn.ts (2)
252-261: Good: SDK stops replacingredirect_urland delegates completion to FAPIUsing
actionCompleteRedirectUrl = redirectUrlCompleteand passing rawredirectUrlduring create simplifies the flow and aligns with the stated direction.
264-271: SSO prepare flow: No changes needed tobuildUrlWithAuthWe scanned every occurrence of
buildUrlWithAuth—it’s applied uniformly across all redirect-based authentication flows (SignIn, SignUp, email-link verification, enterprise SSO/SAML, third-party redirects, popup flows, etc.) to ensure development-mode tokens are bound to those URLs. Removing it here would introduce an inconsistency and break token binding in non-production environments.• Key usages in SSO prepare flow
- packages/clerk-js/src/core/resources/SignIn.ts (lines 264–271 and 586–590)
- packages/clerk-js/src/core/resources/SignUp.ts (lines 291–294)
- packages/elements/src/internals/machines/third-party/third-party.actors.ts (lines 32–36)
- packages/utils/authenticateWithPopup.ts (lines 33–39)
All other flows rely on the same augmentation, so we should keep calling
buildUrlWithAuth(redirectUrl)here.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
integration/tests/session-tasks-sign-up.test.ts (1)
26-27: Clarifying comment and provider cleanup — LGTMGood call documenting and keeping the provider-side cleanup explicit. If there’s no ordering dependency with app-side deletion, consider running both deletions concurrently after org cleanup to reduce test duration.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
integration/tests/session-tasks-sign-up.test.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (8)
**/*.{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:
integration/tests/session-tasks-sign-up.test.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:
integration/tests/session-tasks-sign-up.test.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:
integration/tests/session-tasks-sign-up.test.ts
integration/**
📄 CodeRabbit Inference Engine (.cursor/rules/global.mdc)
Framework integration templates and E2E tests should be placed under the integration/ directory
Files:
integration/tests/session-tasks-sign-up.test.ts
integration/**/*
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
End-to-end tests and integration templates must be located in the 'integration/' directory.
Files:
integration/tests/session-tasks-sign-up.test.ts
integration/**/*.{test,spec}.{js,ts}
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Integration tests should use Playwright.
Files:
integration/tests/session-tasks-sign-up.test.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:
integration/tests/session-tasks-sign-up.test.ts
**/*
⚙️ CodeRabbit Configuration File
If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.
Files:
integration/tests/session-tasks-sign-up.test.ts
⏰ 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). (25)
- GitHub Check: Integration Tests (sessions, chrome)
- GitHub Check: Integration Tests (tanstack-react-router, chrome)
- GitHub Check: Integration Tests (tanstack-react-start, chrome)
- GitHub Check: Integration Tests (expo-web, chrome)
- GitHub Check: Integration Tests (quickstart, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 14)
- GitHub Check: Integration Tests (billing, chrome)
- GitHub Check: Integration Tests (nuxt, chrome)
- GitHub Check: Integration Tests (react-router, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 15)
- GitHub Check: Integration Tests (astro, chrome)
- GitHub Check: Integration Tests (vue, chrome)
- GitHub Check: Integration Tests (ap-flows, chrome)
- GitHub Check: Integration Tests (elements, chrome)
- GitHub Check: Integration Tests (localhost, chrome)
- GitHub Check: Integration Tests (express, chrome)
- GitHub Check: Integration Tests (generic, chrome)
- GitHub Check: Unit Tests (22, **)
- GitHub Check: Publish with pkg-pr-new
- GitHub Check: Unit Tests (18, --filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@c...
- GitHub Check: Static analysis
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
4dfd13b to
569356b
Compare
569356b to
d336777
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
integration/tests/session-tasks-sign-up.test.ts (1)
32-48: Make teardown unconditional and avoid suite failure on cleanup errors; move user deletions out of afterAll
- Risk: If any deletion throws,
app.teardown()won’t run.- Also, combined with
beforeEach, this deletes only the last-created users, leaking users from prior tests.Wrap teardown in
finallyand remove user deletions fromafterAll. We'll handle deletions per test inafterEach(see separate comment).- test.afterAll(async () => { - const u = createTestUtils({ app }); - await u.services.organizations.deleteAll(); - await regularFakeUser.deleteIfExists(); - - // Delete user from OAuth provider instance - const client = createClerkClient({ - secretKey: instanceKeys.get('oauth-provider').sk, - publishableKey: instanceKeys.get('oauth-provider').pk, - }); - const users = createUserService(client); - await users.deleteIfExists({ email: fakeUserForOAuth.email }); - // Delete OAuth user from `with-session-tasks` instance - await u.services.users.deleteIfExists({ email: fakeUserForOAuth.email }); - - await app.teardown(); - }); + test.afterAll(async () => { + const u = createTestUtils({ app }); + try { + await u.services.organizations.deleteAll(); + } finally { + await app.teardown(); + } + });
🧹 Nitpick comments (1)
integration/tests/session-tasks-sign-up.test.ts (1)
71-73: Avoid double createFakeOrganization calls; mutate the slug onceSimplifies intent and avoids extra object allocations.
- const fakeOrganization = Object.assign(u.services.organizations.createFakeOrganization(), { - slug: u.services.organizations.createFakeOrganization().slug + '-with-sign-up', - }); + const org = u.services.organizations.createFakeOrganization(); + org.slug = `${org.slug}-with-sign-up`; + const fakeOrganization = org;- const fakeOrganization = Object.assign(u.services.organizations.createFakeOrganization(), { - slug: u.services.organizations.createFakeOrganization().slug + '-with-sign-in-sso', - }); + const org = u.services.organizations.createFakeOrganization(); + org.slug = `${org.slug}-with-sign-in-sso`; + const fakeOrganization = org;Also applies to: 102-104
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
integration/tests/session-tasks-sign-up.test.ts(4 hunks)
🧰 Additional context used
📓 Path-based instructions (8)
**/*.{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:
integration/tests/session-tasks-sign-up.test.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:
integration/tests/session-tasks-sign-up.test.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:
integration/tests/session-tasks-sign-up.test.ts
integration/**
📄 CodeRabbit Inference Engine (.cursor/rules/global.mdc)
Framework integration templates and E2E tests should be placed under the integration/ directory
Files:
integration/tests/session-tasks-sign-up.test.ts
integration/**/*
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
End-to-end tests and integration templates must be located in the 'integration/' directory.
Files:
integration/tests/session-tasks-sign-up.test.ts
integration/**/*.{test,spec}.{js,ts}
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Integration tests should use Playwright.
Files:
integration/tests/session-tasks-sign-up.test.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:
integration/tests/session-tasks-sign-up.test.ts
**/*
⚙️ CodeRabbit Configuration File
If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.
Files:
integration/tests/session-tasks-sign-up.test.ts
🔇 Additional comments (4)
integration/tests/session-tasks-sign-up.test.ts (4)
1-1: Imports look good for test-only backend opsAdding
createClerkClient,instanceKeys, andcreateUserServiceis appropriate for cross-instance cleanup in integration tests.Also applies to: 5-5, 8-8
15-16: Good separation of users for email/password vs OAuth flowsUsing distinct
regularFakeUserandfakeUserForOAuthavoids cross-contamination between test paths.
61-63: Usage of per-flow fake users is correctCorrectly wires the regular and OAuth users into their respective flows.
Also applies to: 91-91
50-54: Move user deletions intoafterEachto avoid orphaned test accountsThe current
afterAllcleanup only deletes the last-allocated users and leaves all earlier fake users undeleted when running multiple tests. Shifting the deletions intoafterEachensures each test cleans up its own users immediately, and usingPromise.allSettledprevents non-critical cleanup failures from failing the suite.Please update integration/tests/session-tasks-sign-up.test.ts as follows:
- test.afterEach(async ({ page, context }) => { - const u = createTestUtils({ app, page, context }); - await u.page.signOut(); - await u.page.context().clearCookies(); - }); + test.afterEach(async ({ page, context }) => { + const u = createTestUtils({ app, page, context }); + // Tear down session to avoid bleed + await u.page.signOut(); + await u.page.context().clearCookies(); + + // Best-effort per-test user cleanup + const deletions: Promise<unknown>[] = []; + + if (regularFakeUser) { + deletions.push(regularFakeUser.deleteIfExists()); + } + + const oauth = instanceKeys.get('oauth-provider'); + if (oauth && fakeUserForOAuth?.email) { + // Delete from both the OAuth provider and our app + const client = createClerkClient({ + secretKey: oauth.sk, + publishableKey: oauth.pk, + }); + const usersService = createUserService(client); + deletions.push(usersService.deleteIfExists({ email: fakeUserForOAuth.email })); + deletions.push(u.services.users.deleteIfExists({ email: fakeUserForOAuth.email })); + } + + const results = await Promise.allSettled(deletions); + for (const r of results) { + if (r.status === 'rejected') { + console.warn('[cleanup] user deletion failed:', r.reason); + } + } + });• Confirm that your CI always provides an
oauth-providerentry viainstanceKeys.get('oauth-provider'); if not, the guard prevents failures, but you may want totest.skipthe OAuth flow when keys are missing.
• Remove the existingtest.afterAlldeletions for these users (they’re now inafterEach).
| // TODO - Remove this once FAPI changes are deployed to redirect | ||
| // to `redirect_url` for pending sessions on SSO callback | ||
| await u.page.waitForAppUrl('/'); | ||
| await u.page.goToRelative('/page-protected'); | ||
|
|
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Make SSO wait resilient across pre/post FAPI change
Instead of hardcoding '/', wait for either '/' or '/sso-callback' so the test passes regardless of where FAPI redirects during pending sessions.
- // TODO - Remove this once FAPI changes are deployed to redirect
- // to `redirect_url` for pending sessions on SSO callback
- await u.page.waitForAppUrl('/');
- await u.page.goToRelative('/page-protected');
+ // Handle both current and future FAPI behaviors:
+ // - current: redirect to `/sso-callback` for pending sessions
+ // - future: redirect directly to the final `redirect_url` (`/`)
+ await page.waitForURL(/\/($|sso-callback)$/);
+ await u.page.goToRelative('/page-protected');If preferred to keep using wrappers, we can switch back once waitForAppUrl supports regex or multiple targets.
🏁 Script executed:
#!/bin/bash
# Locate the definition of waitForAppUrl to verify its capabilities
rg "waitForAppUrl" -n .Length of output: 8323
🏁 Script executed:
#!/bin/bash
# Display the implementation of waitForAppUrl to confirm its signature and capabilities
awk 'NR>=1 && NR<=200' packages/testing/src/playwright/unstable/page-objects/app.ts | sed -n 's/\t/ /g'Length of output: 108
🏁 Script executed:
#!/bin/bash
# Show the implementation of waitForAppUrl with surrounding context
rg -nC5 "waitForAppUrl" packages/testing/src/playwright/unstable/page-objects/app.tsLength of output: 493
🏁 Script executed:
#!/bin/bash
# Show the implementation block of waitForAppUrl to confirm its behavior
sed -n '70,120p' packages/testing/src/playwright/unstable/page-objects/app.tsLength of output: 1682
🏁 Script executed:
#!/bin/bash
# Show the beginning of the test file to inspect how `page` and `u` are used
sed -n '1,50p' integration/tests/session-tasks-sign-up.test.tsLength of output: 1826
🏁 Script executed:
#!/bin/bash
# Display the header and creation of page objects to inspect returned structure
sed -n '1,70p' packages/testing/src/playwright/unstable/page-objects/app.tsLength of output: 2473
Make SSO wait resilient across pre/post FAPI change
Handle both current and future FAPI redirect patterns by using Playwright’s built-in waitForURL with a regex instead of the wrapper:
File: integration/tests/session-tasks-sign-up.test.ts
Lines: 95–99
- // TODO - Remove this once FAPI changes are deployed to redirect
- // to `redirect_url` for pending sessions on SSO callback
- await u.page.waitForAppUrl('/');
+ // Handle both current (redirect to `/sso-callback`) and future (direct `/`) FAPI behaviors
+ await u.page.waitForURL(/\/(?:sso-callback)?$/);
await u.page.goToRelative('/page-protected');This covers both “/sso-callback” and “/” without changing the wrapper; once waitForAppUrl supports regex or multiple targets, you can revert to it.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // TODO - Remove this once FAPI changes are deployed to redirect | |
| // to `redirect_url` for pending sessions on SSO callback | |
| await u.page.waitForAppUrl('/'); | |
| await u.page.goToRelative('/page-protected'); | |
| // Handle both current (redirect to `/sso-callback`) and future (direct `/`) FAPI behaviors | |
| await u.page.waitForURL(/\/(?:sso-callback)?$/); | |
| await u.page.goToRelative('/page-protected'); |
🤖 Prompt for AI Agents
In integration/tests/session-tasks-sign-up.test.ts around lines 95 to 99,
replace the current use of the custom wrapper u.page.waitForAppUrl('/') with
Playwright's built-in waitForURL method using a regex pattern that matches both
"/sso-callback" and "/" URLs. This change will make the SSO wait resilient to
both pre- and post-FAPI redirect behaviors. Use page.waitForURL with a regex
covering these paths directly, and keep the subsequent navigation to
'/page-protected' as is.
Description
Context
This was previously introduced for FAPI to avoid redirecting to, for example,
/dashboard, if the sign-in/sign-up was complete but with apendingsession.The problem is that the SDK couldn't know ahead of time if the session created by sign-in/sign-up would be pending, and it was navigating to
/sso-callbackfor all sign-ins/sign-ups, even when the task was already satisfied.What's the fix now
We're removing this condition, and thinking whether is worth moving the logic to FAPI: https://github.com/clerk/clerk_go/pull/13037
For SPAs, as long as their apps are protected with
SignedInorSignedOuton private routes, or for server-side protections likeauth.protect, it should also handle the case where FAPI redirects toredirect_url_completewhile the PR above isn't merged.Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
Summary by CodeRabbit