fix(clerk-js, chrome-extension): Hide stripe.js dependant flows from UP and OP #6754
Conversation
🦋 Changeset detectedLatest commit: 24dcd1e 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.
|
WalkthroughGates UI flows with a build-time flag: hides “add new payment method” paths in Checkout and PaymentSources when BUILD_DISABLE_RHC is true, initializes checkout to prefer existing sources under the flag, early-returns PaymentSources if no sources exist, and adds a changeset bump for @clerk/clerk-js. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor User
participant CheckoutForm
participant PaymentSources
rect #E6F0FF
note right of CheckoutForm: Checkout initialization
User->>CheckoutForm: open checkout
CheckoutForm->>CheckoutForm: set paymentMethodSource = (hasSources or __BUILD_DISABLE_RHC__) ? 'existing' : 'new'
alt __BUILD_DISABLE_RHC__ == true
CheckoutForm-->>User: render existing-method path only
CheckoutForm-x CheckoutForm: SegmentedControl and AddPaymentSource omitted
else
CheckoutForm-->>User: render SegmentedControl (existing/new)
User->>CheckoutForm: choose "new"
CheckoutForm->>CheckoutForm: render AddPaymentSourceForCheckout
end
end
rect #F0FFF0
note right of PaymentSources: Payment sources screen
User->>PaymentSources: open payment sources
alt __BUILD_DISABLE_RHC__ == true and noSources
PaymentSources-->>User: render nothing (null)
else
PaymentSources-->>User: list existing sources (with Remove)
alt __BUILD_DISABLE_RHC__ == false
PaymentSources-->>User: show Add trigger/screen
else
PaymentSources-x PaymentSources: Add UI hidden
end
end
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 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). (27)
✨ 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 (1)
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx (1)
124-126: Early-return guard is good; consider an explicit empty-state for consistency.Returning
nullavoids a confusing empty section, but an explicit empty-state message may help users understand why add actions are missing in this environment.Option:
// Instead of return null, render a ProfileSection with an info message.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
.changeset/great-adults-nail.md(1 hunks)packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx(3 hunks)packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.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/great-adults-nail.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/PaymentSources/PaymentSources.tsxpackages/clerk-js/src/ui/components/Checkout/CheckoutForm.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/PaymentSources/PaymentSources.tsxpackages/clerk-js/src/ui/components/Checkout/CheckoutForm.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/PaymentSources/PaymentSources.tsxpackages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsxpackages/clerk-js/src/ui/components/Checkout/CheckoutForm.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/PaymentSources/PaymentSources.tsxpackages/clerk-js/src/ui/components/Checkout/CheckoutForm.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/PaymentSources/PaymentSources.tsxpackages/clerk-js/src/ui/components/Checkout/CheckoutForm.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/PaymentSources/PaymentSources.tsxpackages/clerk-js/src/ui/components/Checkout/CheckoutForm.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/PaymentSources/PaymentSources.tsxpackages/clerk-js/src/ui/components/Checkout/CheckoutForm.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/PaymentSources/PaymentSources.tsxpackages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx
🧬 Code graph analysis (2)
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx (2)
packages/clerk-js/src/ui/elements/Actions.tsx (1)
Action(155-243)packages/clerk-js/src/ui/elements/Section.tsx (1)
ProfileSection(335-344)
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx (1)
packages/clerk-js/src/ui/elements/SegmentedControl.tsx (1)
SegmentedControl(158-161)
⏰ 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). (3)
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (3)
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx (2)
238-239: Gating new-payment flow looks correct.Hiding the new-payment path under
__BUILD_DISABLE_RHC__is aligned with the PR’s objective.
231-239: Render empty-state when RHC is disabled and there are no existing payment sourcesFile: packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx
When BUILD_DISABLE_RHC is true and paymentSources.length === 0, show a localized alert instead of rendering ExistingPaymentSourceForm.
Apply:
- {paymentMethodSource === 'existing' && ( - <ExistingPaymentSourceForm - paymentSources={paymentSources} - totalDueNow={totals.totalDueNow} - /> - )} + {paymentMethodSource === 'existing' && ( + __BUILD_DISABLE_RHC__ && paymentSources.length === 0 ? ( + <Card.Alert> + <Text localizationKey={localizationKeys('commerce.checkout.paymentMethodUnavailableInThisEnvironment')} /> + </Card.Alert> + ) : ( + <ExistingPaymentSourceForm + paymentSources={paymentSources} + totalDueNow={totals.totalDueNow} + /> + ) + )}If that localization key doesn't exist, add one or reuse an appropriate existing key.
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx (1)
169-183: Add UI correctly gated behind RHC flag.The conditional rendering for Add trigger/screen looks good and follows the theming/localization patterns.
| const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>(() => | ||
| paymentSources.length > 0 ? 'existing' : 'new', | ||
| paymentSources.length > 0 || __BUILD_DISABLE_RHC__ ? 'existing' : 'new', | ||
| ); |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Avoid “dead-end” checkout when RHC is disabled and there are no payment sources.
With __BUILD_DISABLE_RHC__ true, state initializes to 'existing'. If paymentSources.length === 0, users can't add a method and the submit path will likely fail (empty payment_source_id). Provide an empty-state/fallback or disable the submit path.
Minimal in-scope guard (render a localized notice instead of a broken form):
- const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>(() =>
- paymentSources.length > 0 || __BUILD_DISABLE_RHC__ ? 'existing' : 'new',
- );
+ const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>(() =>
+ (paymentSources.length > 0 || __BUILD_DISABLE_RHC__) ? 'existing' : 'new',
+ );And adjust rendering (below, see 231–239 diff) to show an empty-state when __BUILD_DISABLE_RHC__ && paymentSources.length === 0.
Additionally, make paymentSourceId optional on submit so free-trial/zero-due flows don’t break:
// outside changed range: lines 162–171
const payWithExistingPaymentSource = (e: React.FormEvent<HTMLFormElement>) => {
e.preventDefault();
const data = new FormData(e.currentTarget);
const paymentSourceId = data.get('payment_source_id') as string | null;
return confirmCheckout(
paymentSourceId ? { paymentSourceId } : {},
);
};If ConfirmCheckoutParams requires a discriminator, please confirm and adapt accordingly.
🏁 Script executed:
#!/bin/bash
set -euo pipefail
target="packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx"
if [ ! -f "$target" ]; then
echo "MISSING: $target"
exit 0
fi
echo "FILE: $target"
echo "---- full file (numbered) ----"
nl -ba "$target" | sed -n '1,400p'
echo "---- context lines 160-260 ----"
nl -ba "$target" | sed -n '160,260p'
echo "---- repo-wide grep for related symbols ----"
rg -n "__BUILD_DISABLE_RHC__|paymentSources|payment_source_id|confirmCheckout|ConfirmCheckoutParams|payWithExistingPaymentSource" || trueLength of output: 140
🏁 Script executed:
#!/bin/bash
set -euo pipefail
target="packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx"
if [ ! -f "$target" ]; then
echo "MISSING: $target"
exit 0
fi
echo "=== head (1-240) ==="
sed -n '1,240p' "$target"
echo
echo "=== context (160-260) ==="
sed -n '160,260p' "$target"
echo
echo "=== repo-wide search for related symbols ==="
if command -v rg >/dev/null 2>&1; then
rg -n "__BUILD_DISABLE_RHC__|paymentSources|payment_source_id|confirmCheckout|ConfirmCheckoutParams|payWithExistingPaymentSource" || true
else
grep -nR --exclude-dir=node_modules -E "__BUILD_DISABLE_RHC__|paymentSources|payment_source_id|confirmCheckout|ConfirmCheckoutParams|payWithExistingPaymentSource" . || true
fiLength of output: 28472
Fix dead-end checkout when RHC is disabled and no payment sources
-
Render an explicit empty-state / disable submit when BUILD_DISABLE_RHC && paymentSources.length === 0 so users aren’t stuck on the “existing” path. (packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx — CheckoutFormElements; state init ~lines 193–195; segmented-control/rendering ~lines 207–239)
-
Make payWithExistingPaymentSource tolerate a missing payment_source_id before calling confirm:
const paymentSourceId = data.get('payment_source_id') as string | null;
return confirmCheckout(paymentSourceId ? { paymentSourceId } : {});(location: payWithExistingPaymentSource, ~lines 162–171). ConfirmCheckoutParams accepts optional fields; passing {} is safe.
🤖 Prompt for AI Agents
In packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx around lines
193–195 and the segmented-control/rendering block ~207–239, currently state
initializes paymentMethodSource to "existing" when __BUILD_DISABLE_RHC__ is true
even if paymentSources.length === 0 which leads to a dead-end; change the render
path to show an explicit empty state or disable the submit control when
__BUILD_DISABLE_RHC__ && paymentSources.length === 0 so users cannot select the
non-existent "existing" path (update the JSX for CheckoutFormElements to render
a disabled submit or an empty-state message and prevent choosing the existing
option). Also update payWithExistingPaymentSource (~lines 162–171) to tolerate a
missing payment_source_id by reading it as string | null and calling
confirmCheckout with an empty object when absent (i.e., if paymentSourceId is
present pass { paymentSourceId } else pass {}), since ConfirmCheckoutParams
accepts optional fields.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
packages/clerk-js/jest.config.js (3)
11-12: Make the flag CI-/locally-togglable via envAllows running suites under both modes without code edits.
Apply:
- __BUILD_DISABLE_RHC__: false, + // When true, hide Stripe.js-dependent flows in UP/OP (mirrors build define) + __BUILD_DISABLE_RHC__: process.env.BUILD_DISABLE_RHC === 'true',
11-12: Cover both states in testsAdd targeted tests that toggle the global to assert the gated UI for Checkout/PaymentSources.
Example pattern:
const orig = globalThis.__BUILD_DISABLE_RHC__; beforeEach(() => { globalThis.__BUILD_DISABLE_RHC__ = true; }); afterEach(() => { globalThis.__BUILD_DISABLE_RHC__ = orig; });
3-3: Minor: align JSDoc config type with @swc/jest usageYou’re using
@swc/jest; the ts-jest JSDoc type can confuse tooling.Apply:
-/** @type {import('ts-jest').JestConfigWithTsJest} */ +/** @type {import('@jest/types').Config.InitialOptions} */Also applies to: 45-47
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
packages/clerk-js/jest.config.js(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{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/jest.config.js
**/*.{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/jest.config.js
**/*.{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/jest.config.js
🔇 Additional comments (2)
packages/clerk-js/jest.config.js (2)
11-12: LGTM: Jest global added for the new build flagAdding
__BUILD_DISABLE_RHC__prevents ReferenceErrors in tests and mirrors the build-time flag intent.
11-12: Add ambient typing & ensure build-time define parityVerification failed in sandbox — ripgrep returned no files.
- Add a shared ambient type (e.g., types/build-flags.d.ts):
declare const __BUILD_DISABLE_RHC__: boolean;- Ensure production bundlers define the same symbol at build-time (Vite / Rollup / esbuild / webpack DefinePlugin).
- Jest currently sets
__BUILD_DISABLE_RHC__: falsein packages/clerk-js/jest.config.js (lines 11–12); keep the test default but align bundler defines with intended runtime behavior.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Description
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
New Features
Chores