fix(clerk-react): Check for __experimental_asProvider before logging in UserButton #6715
Conversation
🦋 Changeset detectedLatest commit: 9c47189 The changes in this PR will be included in the next version bump. This PR includes changesets to release 8 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 |
WalkthroughAdds an allowForAnyChildren flag to custom menu/page hooks, propagating it from uiComponents via __experimental_asProvider. Unknown/non-matching children are ignored without dev logs when the flag is true; when false, prior logging remains. One exported hook signature now accepts an options object. Changes
Sequence Diagram(s)sequenceDiagram
actor Dev as App Developer
participant UI as uiComponents.tsx
participant Hook as useUserButtonCustomMenuItems
participant Core as useCustomMenuItems (internal)
Dev->>UI: <UserButton __experimental_asProvider={bool}>{children}</UserButton>
UI->>Hook: useUserButtonCustomMenuItems(children, { allowForAnyChildren: !!__experimental_asProvider })
Hook->>Core: useCustomMenuItems({ children, allowForAnyChildren })
alt allowForAnyChildren = true
Core->>Core: Ignore non-matching children (no dev log)
else allowForAnyChildren = false
Core->>Dev: Dev-mode log for non-matching children
end
Core-->>Hook: Parsed menu items
Hook-->>UI: Menu items
UI-->>Dev: Rendered button/menu
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
✨ Finishing Touches🧪 Generate unit tests
🪧 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/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
@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: |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
packages/react/src/utils/useCustomMenuItems.tsx (3)
31-31: Minor: drop redundant defaulting; rely on callee’s default.
useCustomMenuItemsalready defaults tofalse.- allowForAnyChildren: options?.allowForAnyChildren ?? false, + allowForAnyChildren: options?.allowForAnyChildren,
43-44: Document the new flag’s intent to prevent misuse.Clarify it’s tied to
__experimental_asProviderto avoid accidental broad silencing.- allowForAnyChildren?: boolean; + /** + * Ignore and do not log unknown top-level children. + * Set by components when `__experimental_asProvider` is enabled. + */ + allowForAnyChildren?: boolean;
68-71: Guard dev logging on valid React elements- if (child && !allowForAnyChildren) { + if (React.isValidElement(child) && !allowForAnyChildren) { logErrorInDevMode(userButtonIgnoredComponent); }Add a unit test verifying that when
__experimental_asProvideris true and non-element children are passed, no dev logs are emitted.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
packages/react/src/components/uiComponents.tsx(1 hunks)packages/react/src/utils/useCustomMenuItems.tsx(5 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/react/src/components/uiComponents.tsxpackages/react/src/utils/useCustomMenuItems.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/react/src/components/uiComponents.tsxpackages/react/src/utils/useCustomMenuItems.tsx
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/react/src/components/uiComponents.tsxpackages/react/src/utils/useCustomMenuItems.tsx
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/react/src/components/uiComponents.tsxpackages/react/src/utils/useCustomMenuItems.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/react/src/components/uiComponents.tsxpackages/react/src/utils/useCustomMenuItems.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/react/src/components/uiComponents.tsxpackages/react/src/utils/useCustomMenuItems.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/react/src/components/uiComponents.tsxpackages/react/src/utils/useCustomMenuItems.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/react/src/components/uiComponents.tsxpackages/react/src/utils/useCustomMenuItems.tsx
🧬 Code graph analysis (1)
packages/react/src/components/uiComponents.tsx (1)
packages/react/src/utils/useCustomMenuItems.tsx (1)
useUserButtonCustomMenuItems(18-33)
⏰ 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: Build Packages
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep/ci
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (1)
packages/react/src/components/uiComponents.tsx (1)
259-261: Forwarding__experimental_asProviderto custom menu items is correct and consistent.Matches the custom pages path and fulfills “don’t log under asProvider” intent.
| export const useUserButtonCustomMenuItems = ( | ||
| children: React.ReactNode | React.ReactNode[], | ||
| options?: { allowForAnyChildren?: boolean }, | ||
| ) => { |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add explicit return type and JSDoc for the exported hook; keep API surface clear.
Per repo guidelines, public APIs need explicit return types and JSDoc. Also, ReactNode already includes arrays, so the union is redundant.
Apply:
-export const useUserButtonCustomMenuItems = (
- children: React.ReactNode | React.ReactNode[],
- options?: { allowForAnyChildren?: boolean },
-) => {
+/**
+ * Parses <UserButton.MenuItems> children into runtime menu items and portals.
+ * When `allowForAnyChildren` is true (e.g. with `__experimental_asProvider`), unknown
+ * top‑level children are ignored and no dev logs are emitted.
+ */
+export const useUserButtonCustomMenuItems = (
+ children: React.ReactNode,
+ options?: UseUserButtonCustomMenuItemsOptions,
+): UseUserButtonCustomMenuItemsResult => {And add these types near the top of the file:
export type UseUserButtonCustomMenuItemsOptions = {
allowForAnyChildren?: boolean;
};
export type UseUserButtonCustomMenuItemsResult = {
customMenuItems: CustomMenuItem[];
customMenuItemsPortals: React.ComponentType[];
};|
!snapshot |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
.changeset/purple-crabs-cheat.md (1)
5-5: Tighten the summary to match behavior and props; include UserProfile scope.
- Use the exact prop name with underscores.
- Prefer “suppress” over “removed” to clarify it’s conditional (only when the provider mode is used).
- Mention the parallel change for UserProfile, per the implementation.
Apply this diff:
-Removed custom menu item logging from UserButton when asProvider is used. +Suppress dev logging for unknown custom menu items in UserButton when __experimental_asProvider is used. +Also suppress logs for unknown custom pages in UserProfile under __experimental_asProvider.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
.changeset/purple-crabs-cheat.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
.changeset/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/purple-crabs-cheat.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). (27)
- GitHub Check: Integration Tests (billing, chrome)
- GitHub Check: Integration Tests (nuxt, chrome)
- GitHub Check: Integration Tests (expo-web, chrome)
- GitHub Check: Integration Tests (astro, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 14)
- GitHub Check: Integration Tests (tanstack-react-start, chrome)
- GitHub Check: Integration Tests (machine, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 15)
- GitHub Check: Unit Tests (22, **)
- GitHub Check: Integration Tests (react-router, chrome)
- GitHub Check: Integration Tests (custom, chrome)
- GitHub Check: Integration Tests (vue, chrome)
- GitHub Check: Integration Tests (sessions, chrome)
- GitHub Check: Integration Tests (generic, chrome)
- GitHub Check: Integration Tests (quickstart, chrome)
- GitHub Check: Integration Tests (tanstack-react-router, chrome)
- GitHub Check: Integration Tests (ap-flows, chrome)
- GitHub Check: Integration Tests (elements, chrome)
- GitHub Check: Integration Tests (express, chrome)
- GitHub Check: Integration Tests (localhost, chrome)
- GitHub Check: Static analysis
- 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: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (1)
.changeset/purple-crabs-cheat.md (1)
1-3: Frontmatter looks valid for Changesets.Package name and patch bump are correct.
|
Hey @alexcarpenter - the snapshot version command generated the following package versions:
Tip: Use the snippet copy button below to quickly install the required packages. npm i @clerk/astro@2.12.0-snapshot.v20250905153823 --save-exact
npm i @clerk/chrome-extension@2.5.30-snapshot.v20250905153823 --save-exact
npm i @clerk/elements@0.23.62-snapshot.v20250905153823 --save-exact
npm i @clerk/clerk-expo@2.14.29-snapshot.v20250905153823 --save-exact
npm i @clerk/nextjs@6.31.10-snapshot.v20250905153823 --save-exact
npm i @clerk/clerk-react@5.46.2-snapshot.v20250905153823 --save-exact
npm i @clerk/react-router@1.9.10-snapshot.v20250905153823 --save-exact
npm i @clerk/remix@4.11.10-snapshot.v20250905153823 --save-exact
npm i @clerk/tanstack-react-start@0.23.5-snapshot.v20250905153823 --save-exact |
Description
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit