fix(clerk-js): Reduce unnecessary re-renders on CheckoutComplete #6765
Conversation
🦋 Changeset detectedLatest commit: a334212 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 GitHub.
|
WalkthroughRefactors CheckoutComplete by extracting the SVG success ring animation into an internal SuccessRing component driven by requestAnimationFrame and hover state, while preserving existing mouse tracking and UI structure. Adds a changeset entry for a patch release of @clerk/clerk-js noting Checkout performance improvements. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant User
participant CheckoutComplete
participant SuccessRing
participant rAF as requestAnimationFrame
User->>CheckoutComplete: Move mouse
CheckoutComplete->>CheckoutComplete: Update mousePosition (x,y)
CheckoutComplete->>SuccessRing: props { positionX, positionY, canHover }
alt canHover && !reducedMotion
SuccessRing->>rAF: start animation loop
loop per frame
rAF-->>SuccessRing: tick
SuccessRing->>SuccessRing: lerp currentPosition -> target
SuccessRing->>SuccessRing: render SVG gradients/masks
end
else
SuccessRing->>SuccessRing: render static ring (no highlight)
end
Note over SuccessRing: Unique IDs via useId to avoid collisions
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
✨ Finishing touches
🧪 Generate unit tests
Comment |
@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: 3
🧹 Nitpick comments (3)
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx (2)
54-55: Avoid ts-ignore; use ts-expect-error or restructure to a nested .Prefer a typed assertion. If keeping Box-as-svg, at least document the expectation.
Apply this diff:
- // @ts-ignore - viewBox is a valid prop for svg + // @ts-expect-error — Box typing doesn't include 'viewBox' when as='svg'; valid on the rendered <svg>.
21-27: De-duplicate canHover logic to avoid SSR hydration mismatches.Compute canHover once in the parent and pass it (and isMotionSafe) down. Defaults should be false on SSR to avoid mismatches.
I can provide a follow-up diff to thread these props if you prefer this approach over the local hook usage in SuccessRing.
Also applies to: 252-255
.changeset/tangy-snails-poke.md (1)
5-5: Make the changeset message more specific.Clarify what improved to help consumers scanning release notes.
Apply this diff:
-Performance improvements for `<Checkout />`. +Reduce unnecessary re-renders in `<CheckoutComplete />` success animation.
📜 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/tangy-snails-poke.md(1 hunks)packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx(2 hunks)
🧰 Additional context used
📓 Path-based instructions (10)
.changeset/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/tangy-snails-poke.md
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/components/Checkout/CheckoutComplete.tsx
**/*.{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/ui/components/Checkout/CheckoutComplete.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/ui/components/Checkout/CheckoutComplete.tsx
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.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/ui/components/Checkout/CheckoutComplete.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/ui/components/Checkout/CheckoutComplete.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/components/Checkout/CheckoutComplete.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/ui/components/Checkout/CheckoutComplete.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/components/Checkout/CheckoutComplete.tsx
🧬 Code graph analysis (1)
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx (2)
packages/clerk-js/src/ui/customizables/index.ts (1)
Box(15-15)packages/clerk-js/src/ui/customizables/elementDescriptors.ts (1)
descriptors(568-568)
⏰ 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). (4)
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx (1)
252-255: Nice isolation of the animation surface.Moving rAF state into SuccessRing limits re-renders to the child and aligns with the PR goal.
| const canHover = | ||
| typeof window === 'undefined' ? true : window.matchMedia('(hover: hover) and (pointer: fine)').matches; | ||
|
|
||
| useEffect(() => { | ||
| if (!canHover) { | ||
| return; | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Honor reduced-motion and gate the animation accordingly.
SuccessRing ignores prefers-reduced-motion and still runs rAF. Gate both the effect and highlight.
Apply this diff:
@@
- const canHover =
- typeof window === 'undefined' ? true : window.matchMedia('(hover: hover) and (pointer: fine)').matches;
+ const canHover =
+ typeof window === 'undefined' ? false : window.matchMedia('(hover: hover) and (pointer: fine)').matches;
+ const prefersReducedMotion = usePrefersReducedMotion();
+ const isMotionSafe = !prefersReducedMotion;
@@
- useEffect(() => {
- if (!canHover) {
+ useEffect(() => {
+ if (!canHover || !isMotionSafe) {
return;
}
@@
- }, [positionX, positionY, canHover]);
+ }, [positionX, positionY, canHover, isMotionSafe]);
@@
- {canHover && (
+ {canHover && isMotionSafe && (Also applies to: 24-44, 143-153
🤖 Prompt for AI Agents
In packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx around
lines 21-27 (and similarly for ranges 24-44 and 143-153), the component
currently checks only for hover capability but ignores the user's
prefers-reduced-motion setting; update the logic to also detect
prefers-reduced-motion via window.matchMedia('(prefers-reduced-motion:
reduce)').matches and gate both the useEffect that runs requestAnimationFrame
and any highlight/animation rendering by returning early when
prefersReducedMotion is true (i.e., treat either !canHover or
prefersReducedMotion as reasons to skip the effect), and ensure any
highlight/animated class or element is not applied/rendered when reduced motion
is requested.
| const animate = () => { | ||
| setCurrentPosition(prev => { | ||
| const amt = 0.15; | ||
| const x = lerp(prev.x, positionX, amt); | ||
| const y = lerp(prev.y, positionY, amt); | ||
| return { x, y }; | ||
| }); | ||
| animationRef.current = requestAnimationFrame(animate); | ||
| }; | ||
| animationRef.current = requestAnimationFrame(animate); |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Stop the rAF loop when the target is reached to avoid perpetual re-renders.
The loop runs forever even when the point stabilizes. Add an epsilon and stop scheduling.
Apply this diff:
- const animate = () => {
- setCurrentPosition(prev => {
- const amt = 0.15;
- const x = lerp(prev.x, positionX, amt);
- const y = lerp(prev.y, positionY, amt);
- return { x, y };
- });
- animationRef.current = requestAnimationFrame(animate);
- };
+ const animate = () => {
+ let continueAnim = false;
+ setCurrentPosition(prev => {
+ const amt = 0.15;
+ const x = lerp(prev.x, positionX, amt);
+ const y = lerp(prev.y, positionY, amt);
+ continueAnim = Math.hypot(x - prev.x, y - prev.y) > 0.5;
+ return { x, y };
+ });
+ if (continueAnim) {
+ animationRef.current = requestAnimationFrame(animate);
+ } else {
+ animationRef.current = null;
+ }
+ };Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx around
lines 28–37, the requestAnimationFrame loop never stops once the point
stabilizes; add a small epsilon threshold (e.g., 0.5 pixels or a small
squared-distance) to detect when lerp has effectively reached the target, and
stop scheduling further frames by calling
cancelAnimationFrame(animationRef.current) and clearing animationRef.current
when within that threshold; only call requestAnimationFrame(animate) if the
distance is above epsilon, and ensure any existing animation is cancelled before
starting a new loop.
| // Generate unique IDs for SVG elements to avoid conflicts with multiple component instances | ||
| const maskId1 = useId(); | ||
| const maskId2 = useId(); | ||
| const maskId3 = useId(); | ||
|
|
There was a problem hiding this comment.
Make all SVG IDs unique to prevent collisions when multiple instances render.
Static IDs for the radialGradient, filter, and mask can collide. Generate unique IDs and update references.
Apply this diff:
@@
- // Generate unique IDs for SVG elements to avoid conflicts with multiple component instances
- const maskId1 = useId();
- const maskId2 = useId();
- const maskId3 = useId();
+ // Generate unique IDs per instance to avoid <defs> collisions
+ const maskId1 = useId();
+ const maskId2 = useId();
+ const maskId3 = useId();
+ const uid = useId();
+ const mainMaskId = `clerk-checkout-success-mask-${uid}`;
+ const radialGradientId = `clerk-checkout-success-gradient-${uid}`;
+ const blurFilterId = `clerk-checkout-success-blur-effect-${uid}`;
@@
- <radialGradient id='clerk-checkout-success-gradient'>
+ <radialGradient id={radialGradientId}>
@@
- <filter id='clerk-checkout-success-blur-effect'>
+ <filter id={blurFilterId}>
@@
- <mask id='clerk-checkout-success-mask'>
+ <mask id={mainMaskId}>
@@
- <g mask='url(#clerk-checkout-success-mask)'>
+ <g mask={`url(#${mainMaskId})`}>
@@
- fill='url(#clerk-checkout-success-gradient)'
- filter='url(#clerk-checkout-success-blur-effect)'
+ fill={`url(#${radialGradientId})`}
+ filter={`url(#${blurFilterId})`}Also applies to: 64-82, 117-117, 135-135, 150-151
🤖 Prompt for AI Agents
In packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx around
lines 45-49, 64-82, 117, 135, and 150-151, the SVG IDs (for radialGradient,
filter, mask, etc.) are currently static and can collide across multiple
component instances; replace each static ID with a unique ID generated via useId
(or similar) at the top of the component and update every SVG attribute
reference (id, href/xlink:href, mask, filter, clipPath, etc.) to use those
generated IDs so each instance uses distinct identifiers and avoids collisions.
Description
Before
Screen.Recording.2025-09-12.at.9.06.22.PM.mov
After
Screen.Recording.2025-09-12.at.9.04.51.PM.mov
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit