fix(clerk-js, shared, nextjs): Improve typesafety of useCheckout
#6473
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
🦋 Changeset detectedLatest commit: 369f00c The changes in this PR will be included in the next version bump. This PR includes changesets to release 19 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 |
@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: |
📝 WalkthroughWalkthroughThis set of changes focuses on strengthening type safety and discriminated union typing for the Estimated code review effort🎯 3 (Moderate) | ⏱️ ~18 minutes Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ 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)
🪧 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 (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
packages/clerk-js/src/ui/components/Checkout/CheckoutPage.tsx (1)
64-78: Critical: Missingerrorin dependency array could cause stale error states.While removing the optional chaining aligns with the discriminated union guarantees, removing
errorfrom the dependency array is problematic. If the error content changes whilefetchStatusremains 'error', the memoized value won't update, potentially showing outdated error information.const internalFetchStatus = useMemo(() => { if (fetchStatus === 'error') { const errorCodes = error.errors.map(e => e.code); if (errorCodes.includes('missing_payer_email')) { return 'missing_payer_email'; } if (errorCodes.includes('invalid_plan_change')) { return 'invalid_plan_change'; } } return fetchStatus; - }, [fetchStatus]); + }, [fetchStatus, error]);
🧹 Nitpick comments (2)
packages/shared/src/react/hooks/useCheckout.ts (1)
134-136: Consider removing the type assertion for better type safety.Type assertions bypass TypeScript's type checking. Since the
checkoutobject is constructed to match the return type, TypeScript should be able to infer it correctly without the assertion.return { checkout, - } as __experimental_UseCheckoutReturn; + };If the type assertion is necessary due to TypeScript inference limitations with the discriminated unions, consider adding a comment explaining why it's needed.
packages/clerk-js/src/ui/components/Checkout/CheckoutPage.tsx (1)
1-86: Consider adding runtime tests for the updated component behavior.While type-level tests were added for the hook, consider adding runtime tests to verify that the
FetchStatuscomponent correctly handles the discriminated union states and that the memoization works as expected with different error scenarios.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
.changeset/brown-wings-shake.md(1 hunks)packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx(1 hunks)packages/clerk-js/src/ui/components/Checkout/CheckoutPage.tsx(2 hunks)packages/shared/src/react/hooks/__tests__/useCheckout.type.spec.ts(2 hunks)packages/shared/src/react/hooks/useCheckout.ts(3 hunks)
🧰 Additional context used
📓 Path-based instructions (13)
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/CheckoutForm.tsxpackages/clerk-js/src/ui/components/Checkout/CheckoutPage.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/CheckoutForm.tsxpackages/shared/src/react/hooks/__tests__/useCheckout.type.spec.tspackages/shared/src/react/hooks/useCheckout.tspackages/clerk-js/src/ui/components/Checkout/CheckoutPage.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/CheckoutForm.tsxpackages/shared/src/react/hooks/__tests__/useCheckout.type.spec.tspackages/shared/src/react/hooks/useCheckout.tspackages/clerk-js/src/ui/components/Checkout/CheckoutPage.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/CheckoutForm.tsxpackages/shared/src/react/hooks/__tests__/useCheckout.type.spec.tspackages/shared/src/react/hooks/useCheckout.tspackages/clerk-js/src/ui/components/Checkout/CheckoutPage.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/CheckoutForm.tsxpackages/shared/src/react/hooks/__tests__/useCheckout.type.spec.tspackages/shared/src/react/hooks/useCheckout.tspackages/clerk-js/src/ui/components/Checkout/CheckoutPage.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/CheckoutForm.tsxpackages/shared/src/react/hooks/__tests__/useCheckout.type.spec.tspackages/shared/src/react/hooks/useCheckout.tspackages/clerk-js/src/ui/components/Checkout/CheckoutPage.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/CheckoutForm.tsxpackages/clerk-js/src/ui/components/Checkout/CheckoutPage.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/CheckoutForm.tsxpackages/shared/src/react/hooks/__tests__/useCheckout.type.spec.tspackages/shared/src/react/hooks/useCheckout.tspackages/clerk-js/src/ui/components/Checkout/CheckoutPage.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/CheckoutForm.tsxpackages/clerk-js/src/ui/components/Checkout/CheckoutPage.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.
Files:
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsxpackages/shared/src/react/hooks/__tests__/useCheckout.type.spec.tspackages/shared/src/react/hooks/useCheckout.tspackages/clerk-js/src/ui/components/Checkout/CheckoutPage.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/shared/src/react/hooks/__tests__/useCheckout.type.spec.ts
**/__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/shared/src/react/hooks/__tests__/useCheckout.type.spec.ts
.changeset/**
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/brown-wings-shake.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: semgrep-cloud-platform/scan
- GitHub Check: Build Packages
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (7)
packages/shared/src/react/hooks/useCheckout.ts (3)
31-39: LGTM! Well-structured discriminated union for error states.The
FetchStatusAndErrortype correctly enforces thaterroris only present whenfetchStatusis 'error', and null otherwise. This prevents accidental access to error properties in non-error states.
46-52: Consider using explicit type extension for clarity.The discriminated union is well-designed. For better readability, consider explicitly extending the type instead of using the spread operator with the type alias.
type CheckoutPropertiesPerStatus = | ({ status: Extract<__experimental_CheckoutCacheState['status'], 'needs_initialization'>; } & ForceNull<CheckoutProperties>) | ({ status: Extract<__experimental_CheckoutCacheState['status'], 'needs_confirmation' | 'completed'>; - } & CheckoutProperties); + } & CheckoutProperties);Actually, the current implementation is fine. The spread operator with type alias is a common pattern in TypeScript.
96-118: Good use of explicit typing for discriminated union support.The explicit type annotation on
useMemohelps TypeScript understand the discriminated union pattern and ensures type safety when accessing properties based on the checkout state.packages/shared/src/react/hooks/__tests__/useCheckout.type.spec.ts (2)
163-252: Excellent comprehensive type-level tests for discriminated unions!The test suite thoroughly validates:
- Correlation between
fetchStatusanderrorpresence- Property nullability based on
statusvalues- Preservation of method types across all states
This provides strong guarantees that the discriminated unions work as intended.
196-203: No action needed:paymentSourceis correctly typed asnull | undefined.In the
CommerceCheckoutResourcedefinition,paymentSourceis declared as optional (paymentSource?: …). As a result, its initialization state may legitimately beundefinedin addition tonull, whereas all other (required) properties are strictlynull.packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx (1)
279-286: Good adaptation to the new discriminated union pattern.The change from checking
idto explicitly checkingstatus === 'needs_initialization'is more semantically correct and aligns with the stricter typing of theuseCheckouthook..changeset/brown-wings-shake.md (1)
1-8: LGTM! Appropriate version bumps for the type safety improvements.The changeset correctly identifies this as a minor change for packages that export the hook and a patch for the consuming package. The description clearly communicates the improvement.
Description
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
New Features
Bug Fixes
Tests
Chores