fix(clerk-js): Remove condition to always send redirect_url for SSO with after-auth
#6498
Conversation
🦋 Changeset detectedLatest commit: 5657b07 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 ↗︎
|
LauraBeatris
force-pushed
the
laura/remove-sso-hacky-moved-to-fapi
branch
from
21b4f5e to
5657b07
Compare
📝 WalkthroughWalkthroughThe changes update the redirect URL handling logic for single sign-on (SSO) flows in the Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 🪧 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: |
![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
🔭 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.
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 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