fix(clerk-js): Correct multisession sign in redirect behavior #6456
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
jacekradko
changed the title
📝 WalkthroughWalkthroughThe changes introduce a new guard function, Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Assessment against linked issues
Assessment against linked issues: Out-of-scope changesNo out-of-scope changes were found. Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
packages/clerk-js/src/ui/common/withRedirect.tsx (1)
91-98: Remove duplicated combined guard logic.This is identical to the logic in
withRedirectToAfterSignIn. Use the extracted guard function mentioned in the previous comment.
🧹 Nitpick comments (3)
packages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsx (3)
1-6: Fix import sorting issue.ESLint indicates the imports need to be sorted.
Apply this diff to fix the import order:
import React from 'react'; +import { sessionExistsAndRedirectUrlPresent } from '../../../utils/componentGuards'; import { render } from '../../../testUtils'; import { bindCreateFixtures } from '../../utils/test/createFixtures'; import { withRedirect } from '../withRedirect'; -import { sessionExistsAndRedirectUrlPresent } from '../../../utils/componentGuards';
47-53: Improve beforeEach setup.The initial location setup in beforeEach is overwritten in each test, making it redundant.
Consider either removing the beforeEach or making it more useful:
beforeEach(() => { - // Set up window.location.href for tests - Object.defineProperty(window, 'location', { - value: { href: 'http://test.host/' }, - writable: true, - }); + // Reset window.location to a clean state + Object.defineProperty(window, 'location', { + value: { + href: 'http://test.host/', + search: '' + }, + writable: true, + }); });
82-84: Fix unused parameter warning.The parameter
fis defined but never used. Prefix with underscore to indicate intentional non-usage.Apply this diff:
- const { wrapper, fixtures } = await createFixtures(f => { + const { wrapper, fixtures } = await createFixtures(_f => { // No user signed in });
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
packages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsx(2 hunks)packages/clerk-js/src/ui/common/withRedirect.tsx(3 hunks)packages/clerk-js/src/utils/componentGuards.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (14)
**/*.{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/utils/componentGuards.tspackages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsxpackages/clerk-js/src/ui/common/withRedirect.tsx
**/*.{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/utils/componentGuards.tspackages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsxpackages/clerk-js/src/ui/common/withRedirect.tsx
packages/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/utils/componentGuards.tspackages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsxpackages/clerk-js/src/ui/common/withRedirect.tsx
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/utils/componentGuards.tspackages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsxpackages/clerk-js/src/ui/common/withRedirect.tsx
**/*.{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/utils/componentGuards.tspackages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsxpackages/clerk-js/src/ui/common/withRedirect.tsx
**/*.{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/utils/componentGuards.tspackages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsxpackages/clerk-js/src/ui/common/withRedirect.tsx
**/*
⚙️ 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.Whenever reviewing a pull request, if there are any changes that could impact security, always tag
@clerk/securityin the PR.Security-impacting changes include, but are not limited to:
- Changes to authentication logic or mechanisms (e.g. login, session handling, token issuance)
- Any modification to access control, authorization checks, or role-based permissions
- Introduction or modification of hashing algorithms, signature verification, or cryptographic primitives
- Handling of sensitive data (e.g. passwords, tokens, secrets, PII)
- Integration with external identity providers (e.g. SSO, OAuth, OpenID Connect)
- Modifications to security headers, cookie flags, CORS policies, or CSRF protections
- Bypass mechanisms (e.g. feature flags, testing overrides) that could weaken protections
- Changes to rate limiting, abuse prevention, or input validation
If you're unsure whether a change is security-relevant, err on the side of caution and tag
@clerk/security.Any time that you tag
@clerk/security, please do so explicitly in a code comment, rather than within a collapsed section in a coderabbit comment, such as the "recent review details" section. If you do use the team name in any thinking or non-direct-code-comment content, it can be referred to as "clerk security team" to avoid accidentally printing the tag which sends a notification to the team.
Files:
packages/clerk-js/src/utils/componentGuards.tspackages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsxpackages/clerk-js/src/ui/common/withRedirect.tsx
packages/clerk-js/src/ui/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/clerk-js-ui.mdc)
packages/clerk-js/src/ui/**/*.{ts,tsx}: Element descriptors should always be camelCase
Use element descriptors in UI components to enable consistent theming and styling via appearance.elements
Element descriptors should generate unique, stable CSS classes for theming
Element descriptors should handle state classes (e.g., cl-loading, cl-active, cl-error, cl-open) automatically based on component state
Do not render hard-coded values; all user-facing strings must be localized using provided localization methods
Use the useLocalizations hook and localizationKeys utility for all text and error messages
Use the styled system (sx prop, theme tokens, responsive values) for custom component styling
Use useCardState for card-level state, useFormState for form-level state, and useLoadingStatus for loading states
Always use handleError utility for API errors and use translateError for localized error messages
Use useFormControl for form field state, implement proper validation, and handle loading and error states in forms
Use localization keys for all form labels and placeholders
Use element descriptors for consistent styling and follow the theme token system
Use the Card and FormContainer patterns for consistent UI structure
Files:
packages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsxpackages/clerk-js/src/ui/common/withRedirect.tsx
**/*.{jsx,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
**/*.{jsx,tsx}: Use error boundaries in React components
Minimize re-renders in React components
**/*.{jsx,tsx}: Always use functional components with hooks instead of class components
Follow PascalCase naming for components:UserProfile,NavigationMenu
Keep components focused on a single responsibility - split large components
Limit component size to 150-200 lines; extract logic into custom hooks
Use composition over inheritance - prefer smaller, composable components
Export components as named exports for better tree-shaking
One component per file with matching filename and component name
Use useState for simple state management
Use useReducer for complex state logic
Implement proper state initialization
Use proper state updates with callbacks
Implement proper state cleanup
Use Context API for theme/authentication
Implement proper state selectors
Use proper state normalization
Implement proper state persistence
Use React.memo for expensive components
Implement proper useCallback for handlers
Use proper useMemo for expensive computations
Implement proper virtualization for lists
Use proper code splitting with React.lazy
Implement proper cleanup in useEffect
Use proper refs for DOM access
Implement proper event listener cleanup
Use proper abort controllers for fetch
Implement proper subscription cleanup
Use proper HTML elements
Implement proper ARIA attributes
Use proper heading hierarchy
Implement proper form labels
Use proper button types
Implement proper focus management
Use proper keyboard shortcuts
Implement proper tab order
Use proper skip links
Implement proper focus traps
Implement proper error boundaries
Use proper error logging
Implement proper error recovery
Use proper error messages
Implement proper error fallbacks
Use proper form validation
Implement proper error states
Use proper error messages
Implement proper form submission
Use proper form reset
Use proper component naming
Implement proper file naming
Use proper prop naming
Implement proper...
Files:
packages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsxpackages/clerk-js/src/ui/common/withRedirect.tsx
packages/**/*.{test,spec}.{js,jsx,ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Unit tests should use Jest or Vitest as the test runner.
Files:
packages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsx
packages/{clerk-js,elements,themes}/**/*.{test,spec}.{js,jsx,ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Visual regression testing should be performed for UI components.
Files:
packages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsx
**/*.tsx
📄 CodeRabbit Inference Engine (.cursor/rules/react.mdc)
**/*.tsx: Use proper type definitions for props and state
Leverage TypeScript's type inference where possible
Use proper event types for handlers
Implement proper generic types for reusable components
Use proper type guards for conditional rendering
Files:
packages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsxpackages/clerk-js/src/ui/common/withRedirect.tsx
**/*.test.{jsx,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/react.mdc)
**/*.test.{jsx,tsx}: Use React Testing Library
Test component behavior, not implementation
Use proper test queries
Implement proper test isolation
Use proper test coverage
Test component interactions
Use proper test data
Implement proper test setup
Use proper test cleanup
Implement proper test assertions
Use proper test structure
Files:
packages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsx
**/__tests__/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/typescript.mdc)
**/__tests__/**/*.{ts,tsx}: Create type-safe test builders/factories
Use branded types for test isolation
Implement proper mock types that match interfaces
Files:
packages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsx
🧬 Code Graph Analysis (2)
packages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsx (2)
packages/clerk-js/src/ui/common/withRedirect.tsx (1)
withRedirect(16-53)packages/clerk-js/src/utils/componentGuards.ts (1)
sessionExistsAndRedirectUrlPresent(13-22)
packages/clerk-js/src/ui/common/withRedirect.tsx (1)
packages/clerk-js/src/utils/componentGuards.ts (3)
ComponentGuard(3-7)sessionExistsAndSingleSessionModeEnabled(9-11)sessionExistsAndRedirectUrlPresent(13-22)
🪛 ESLint
packages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsx
[error] 1-6: Run autofix to sort these imports!
(simple-import-sort/imports)
[error] 82-82: 'f' is defined but never used. Allowed unused args must match /^_/u.
(@typescript-eslint/no-unused-vars)
🔇 Additional comments (1)
packages/clerk-js/src/ui/common/__tests__/withRedirect.test.tsx (1)
46-132: Comprehensive test coverage for the new guard.The test suite provides excellent coverage of the
sessionExistsAndRedirectUrlPresentguard function, testing all the key scenarios:
- Signed in user with redirect_url present (should redirect)
- Not signed in with redirect_url present (should not redirect)
- Signed in user without redirect_url (should not redirect)
The mocking of
window.locationis appropriate and the test structure follows established patterns.
|
|
||
| // Combined guard: redirect if user is signed in AND either: | ||
| // 1. Single session mode is enabled, OR | ||
| // 2. There's a redirect_url in the query parameters | ||
| const combinedGuard: ComponentGuard = (clerk, environment) => { | ||
| return sessionExistsAndSingleSessionModeEnabled(clerk, environment) || | ||
| sessionExistsAndRedirectUrlPresent(clerk); | ||
| }; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Extract duplicated combined guard logic.
The same combined guard logic is duplicated in both withRedirectToAfterSignIn and withRedirectToAfterSignUp functions.
Extract the combined guard to reduce duplication:
+// Combined guard: redirect if user is signed in AND either:
+// 1. Single session mode is enabled, OR
+// 2. There's a redirect_url in the query parameters
+const sessionExistsAndEitherSingleSessionOrRedirectUrl: ComponentGuard = (clerk, environment) => {
+ return sessionExistsAndSingleSessionModeEnabled(clerk, environment) ||
+ sessionExistsAndRedirectUrlPresent(clerk);
+};
+
export const withRedirectToAfterSignIn = <P extends AvailableComponentProps>(Component: ComponentType<P>) => {
const displayName = Component.displayName || Component.name || 'Component';
Component.displayName = displayName;
const HOC = (props: P) => {
const signInCtx = useSignInContext();
-
- // Combined guard: redirect if user is signed in AND either:
- // 1. Single session mode is enabled, OR
- // 2. There's a redirect_url in the query parameters
- const combinedGuard: ComponentGuard = (clerk, environment) => {
- return sessionExistsAndSingleSessionModeEnabled(clerk, environment) ||
- sessionExistsAndRedirectUrlPresent(clerk);
- };
-
return withRedirect(
Component,
- combinedGuard,
+ sessionExistsAndEitherSingleSessionOrRedirectUrl,Apply the same change to withRedirectToAfterSignUp.
📝 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.
| // Combined guard: redirect if user is signed in AND either: | |
| // 1. Single session mode is enabled, OR | |
| // 2. There's a redirect_url in the query parameters | |
| const combinedGuard: ComponentGuard = (clerk, environment) => { | |
| return sessionExistsAndSingleSessionModeEnabled(clerk, environment) || | |
| sessionExistsAndRedirectUrlPresent(clerk); | |
| }; | |
| // Combined guard: redirect if user is signed in AND either: | |
| // 1. Single session mode is enabled, OR | |
| // 2. There's a redirect_url in the query parameters | |
| const sessionExistsAndEitherSingleSessionOrRedirectUrl: ComponentGuard = (clerk, environment) => { | |
| return sessionExistsAndSingleSessionModeEnabled(clerk, environment) || | |
| sessionExistsAndRedirectUrlPresent(clerk); | |
| }; | |
| export const withRedirectToAfterSignIn = <P extends AvailableComponentProps>( | |
| Component: ComponentType<P> | |
| ) => { | |
| const displayName = Component.displayName || Component.name || 'Component'; | |
| Component.displayName = displayName; | |
| const HOC = (props: P) => { | |
| const signInCtx = useSignInContext(); | |
| return withRedirect( | |
| Component, | |
| sessionExistsAndEitherSingleSessionOrRedirectUrl, | |
| ); | |
| }; | |
| HOC.displayName = `withRedirectToAfterSignIn(${displayName})`; | |
| return HOC; | |
| }; |
🤖 Prompt for AI Agents
In packages/clerk-js/src/ui/common/withRedirect.tsx around lines 61 to 68, the
combined guard logic is duplicated in both withRedirectToAfterSignIn and
withRedirectToAfterSignUp functions. Extract this combined guard logic into a
single reusable function or constant outside these functions, then replace the
duplicated code in both withRedirectToAfterSignIn and withRedirectToAfterSignUp
with calls to this extracted combined guard to eliminate duplication.
| export const sessionExistsAndRedirectUrlPresent: ComponentGuard = (clerk) => { | ||
| if (!clerk.session) { | ||
| return false; | ||
| } | ||
|
|
||
| const urlParams = new URLSearchParams(window.location.search); | ||
| const redirectUrl = urlParams.get('redirect_url'); | ||
|
|
||
| return !!redirectUrl; | ||
| }; |
There was a problem hiding this comment.
Add SSR safety check for window object access.
The function directly accesses window.location.search which will cause runtime errors in server-side rendering environments where window is undefined.
Apply this diff to add SSR safety:
export const sessionExistsAndRedirectUrlPresent: ComponentGuard = (clerk) => {
if (!clerk.session) {
return false;
}
+ // Guard against SSR environments where window is undefined
+ if (typeof window === 'undefined') {
+ return false;
+ }
+
const urlParams = new URLSearchParams(window.location.search);
const redirectUrl = urlParams.get('redirect_url');
return !!redirectUrl;
};📝 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.
| export const sessionExistsAndRedirectUrlPresent: ComponentGuard = (clerk) => { | |
| if (!clerk.session) { | |
| return false; | |
| } | |
| const urlParams = new URLSearchParams(window.location.search); | |
| const redirectUrl = urlParams.get('redirect_url'); | |
| return !!redirectUrl; | |
| }; | |
| export const sessionExistsAndRedirectUrlPresent: ComponentGuard = (clerk) => { | |
| if (!clerk.session) { | |
| return false; | |
| } | |
| // Guard against SSR environments where window is undefined | |
| if (typeof window === 'undefined') { | |
| return false; | |
| } | |
| const urlParams = new URLSearchParams(window.location.search); | |
| const redirectUrl = urlParams.get('redirect_url'); | |
| return !!redirectUrl; | |
| }; |
🤖 Prompt for AI Agents
In packages/clerk-js/src/utils/componentGuards.ts around lines 13 to 22, the
function accesses window.location.search directly, which breaks in server-side
rendering environments where window is undefined. To fix this, add a check to
ensure window is defined before accessing window.location.search. If window is
undefined, return false early to prevent runtime errors during SSR.
Description
Working through this still
Fixes: USER-2549
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
New Features
Tests