fix(shared): Move organization environment helper to React-specific shared path #7334
Conversation
🦋 Changeset detectedLatest commit: db159cc The changes in this PR will be included in the next version bump. This PR includes changesets to release 22 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.
|
WalkthroughRemoved Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/shared/src/react/hooks/index.ts (1)
5-5: Confirm intended visibility ofuseAttemptToEnableOrganizationsin the public hooks barrelRe‑exporting
useAttemptToEnableOrganizationshere exposes it alongside public hooks likeuseOrganizationanduseUser, while the implementation is marked@internal. If this is meant to stay internal, consider either:
- Exporting it under an internal/underscored name (similar to the
__internal_*exports below), or- Keeping it as a local import only where needed instead of re‑exporting it from this index.
If external consumption is desired, the current export is fine; just be aware it effectively becomes part of the public React hooks surface.
packages/shared/src/react/hooks/useAttemptToEnableOrganizations.ts (1)
10-27: Hook logic correctly migrated; consider explicit return typeThe hook cleanly encapsulates the environment‑enabling behavior, with:
- Proper use of
useRefto ensure the effect runs only once even ifclerkchanges.- Optional chaining to remain compatible with older Clerk versions that lack
__internal_attemptToEnableEnvironmentSetting.- A narrowed
callerunion that aligns with the current hook callers.To better follow the TypeScript guideline of explicit return types for exported functions, you could annotate the signature as:
export function useAttemptToEnableOrganizations( caller: 'useOrganization' | 'useOrganizationList', ): void { // ... }Functionality-wise, this migration looks correct and non‑breaking.
📜 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 (5)
packages/shared/src/organization.ts(0 hunks)packages/shared/src/react/hooks/index.ts(1 hunks)packages/shared/src/react/hooks/useAttemptToEnableOrganizations.ts(1 hunks)packages/shared/src/react/hooks/useOrganization.tsx(2 hunks)packages/shared/src/react/hooks/useOrganizationList.tsx(1 hunks)
💤 Files with no reviewable changes (1)
- packages/shared/src/organization.ts
🧰 Additional context used
📓 Path-based instructions (11)
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
All code must pass ESLint checks with the project's configuration
Files:
packages/shared/src/react/hooks/index.tspackages/shared/src/react/hooks/useAttemptToEnableOrganizations.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/hooks/useOrganizationList.tsx
**/*.{js,jsx,ts,tsx,json,md,yml,yaml}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/shared/src/react/hooks/index.tspackages/shared/src/react/hooks/useAttemptToEnableOrganizations.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/hooks/useOrganizationList.tsx
packages/**/src/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/shared/src/react/hooks/index.tspackages/shared/src/react/hooks/useAttemptToEnableOrganizations.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/hooks/useOrganizationList.tsx
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Follow established naming conventions (PascalCase for components, camelCase for variables)
Prefer importing types from
@clerk/shared/typesinstead of the deprecated@clerk/typesalias
Files:
packages/shared/src/react/hooks/index.tspackages/shared/src/react/hooks/useAttemptToEnableOrganizations.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/hooks/useOrganizationList.tsx
packages/**/src/**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
packages/**/src/**/*.{ts,tsx,js,jsx}: Maintain comprehensive JSDoc comments for public APIs
Use tree-shaking friendly exports
Validate all inputs and sanitize outputs
All public APIs must be documented with JSDoc
Use dynamic imports for optional features
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
Implement proper logging with different levels
Files:
packages/shared/src/react/hooks/index.tspackages/shared/src/react/hooks/useAttemptToEnableOrganizations.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/hooks/useOrganizationList.tsx
**/*.ts?(x)
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
Files:
packages/shared/src/react/hooks/index.tspackages/shared/src/react/hooks/useAttemptToEnableOrganizations.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/hooks/useOrganizationList.tsx
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)
**/*.{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
Implement type guards forunknowntypes using the patternfunction isType(value: unknown): value is Type
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details in classes
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Use mixins for shared behavior across unrelated classes in TypeScript
Use generic constraints with bounded type parameters like<T extends { id: string }>
Use utility types likeOmit,Partial, andPickfor data transformation instead of manual type construction
Use discriminated unions instead of boolean flags for state management and API responses
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation at the type level
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Document functions with JSDoc comments including @param, @returns, @throws, and @example tags
Create custom error classes that extend Error for specific error types
Use the Result pattern for error handling instead of throwing exceptions
Use optional chaining (?.) and nullish coalescing (??) operators for safe property access
Let TypeScript infer obvious types to reduce verbosity
Useconst assertionswithas constfor literal types
Usesatisfiesoperator for type checking without widening types
Declare readonly arrays and objects for immutable data structures
Use spread operator and array spread for immutable updates instead of mutations
Use lazy loading for large types...
Files:
packages/shared/src/react/hooks/index.tspackages/shared/src/react/hooks/useAttemptToEnableOrganizations.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/hooks/useOrganizationList.tsx
**/index.ts
📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)
Avoid barrel files (index.ts re-exports) as they can cause circular dependencies
Files:
packages/shared/src/react/hooks/index.ts
**/*.tsx
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.tsx: Use error boundaries in React components
Minimize re-renders in React components
**/*.tsx: Use proper type definitions for props and state in React components
Leverage TypeScript's type inference where possible in React components
Use proper event types for handlers in React components
Implement proper generic types for reusable React components
Use proper type guards for conditional rendering in React components
Files:
packages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/hooks/useOrganizationList.tsx
**/*.{md,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Update documentation for API changes
Files:
packages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/hooks/useOrganizationList.tsx
**/*.{jsx,tsx}
📄 CodeRabbit inference engine (.cursor/rules/react.mdc)
**/*.{jsx,tsx}: Always use functional components with hooks instead of class components
Follow PascalCase naming for components (e.g.,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
Separate UI components from business logic components
Use useState for simple state management in React components
Use useReducer for complex state logic in React components
Implement proper state initialization in React components
Use proper state updates with callbacks in React components
Implement proper state cleanup in React components
Use Context API for theme/authentication state management
Implement proper state persistence in React applications
Use React.memo for expensive components
Implement proper useCallback for handlers in React components
Use proper useMemo for expensive computations in React components
Implement proper virtualization for lists in React components
Use proper code splitting with React.lazy in React applications
Implement proper cleanup in useEffect hooks
Use proper refs for DOM access in React components
Implement proper event listener cleanup in React components
Use proper abort controllers for fetch in React components
Implement proper subscription cleanup in React components
Use proper HTML elements for semantic HTML in React components
Implement proper ARIA attributes for accessibility in React components
Use proper heading hierarchy in React components
Implement proper form labels in React components
Use proper button types in React components
Implement proper focus management for keyboard navigation in React components
Use proper keyboard shortcuts in React components
Implement proper tab order in React components
Use proper ...
Files:
packages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/hooks/useOrganizationList.tsx
🧬 Code graph analysis (1)
packages/shared/src/react/hooks/useAttemptToEnableOrganizations.ts (2)
packages/shared/src/react/hooks/index.ts (2)
useAttemptToEnableOrganizations(5-5)useClerk(10-10)packages/shared/src/organization.ts (1)
useAttemptToEnableOrganizations(27-44)
⏰ 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: Formatting | Dedupe | Changeset
- GitHub Check: Build Packages
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (2)
packages/shared/src/react/hooks/useOrganization.tsx (1)
23-25: Localized hook import looks goodSwitching
useAttemptToEnableOrganizationsto the local./useAttemptToEnableOrganizationsmodule keeps the organization‑environment logic within the React hooks layer and avoids reaching into the broaderorganizationmodule. No behavior change, and this is consistent with the new dedicated hook file.packages/shared/src/react/hooks/useOrganizationList.tsx (1)
17-18: Consistent local import for organization environment helperImporting
useAttemptToEnableOrganizationsfrom./useAttemptToEnableOrganizationsaligns this hook with the new shared React hook location and mirrorsuseOrganization.tsx. This keeps the environment‑enabling logic localized to the React hooks layer without altering behavior.
@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: 0
🧹 Nitpick comments (1)
.changeset/proud-ads-repeat.md (1)
5-5: Consider a more explicit changelog message for clarity.The current message is concise but doesn't clearly communicate the bug being fixed or the root cause. Since non-React applications (Vue/Nuxt/Astro) were failing to start, consider expanding the message to better reflect the fix:
-Moved helper to enable Organizations feature to React-specific shared path +Fix: Prevent React dependencies from loading in non-React environments by moving organization helper to React-specific shared pathOr alternatively:
-Moved helper to enable Organizations feature to React-specific shared path +Fix: Moved useAttemptToEnableOrganizations to @clerk/shared/react to prevent swr (React-specific) from loading in non-React apps
📜 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 (1)
.changeset/proud-ads-repeat.md(1 hunks)
⏰ 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). (30)
- GitHub Check: Integration Tests (nextjs, chrome, 15)
- GitHub Check: Integration Tests (nextjs, chrome, 14)
- GitHub Check: Integration Tests (machine, chrome, RQ)
- GitHub Check: Integration Tests (nextjs, chrome, 15, RQ)
- GitHub Check: Integration Tests (react-router, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 16)
- GitHub Check: Integration Tests (quickstart, chrome, 16)
- GitHub Check: Integration Tests (quickstart, chrome, 15)
- GitHub Check: Integration Tests (billing, chrome, RQ)
- GitHub Check: Integration Tests (handshake:staging, chrome)
- GitHub Check: Integration Tests (handshake, chrome)
- GitHub Check: Integration Tests (custom, chrome)
- GitHub Check: Integration Tests (nuxt, chrome)
- GitHub Check: Integration Tests (machine, chrome)
- GitHub Check: Integration Tests (expo-web, chrome)
- GitHub Check: Integration Tests (vue, chrome)
- GitHub Check: Integration Tests (billing, chrome)
- GitHub Check: Integration Tests (astro, chrome)
- GitHub Check: Integration Tests (sessions, chrome)
- GitHub Check: Integration Tests (localhost, chrome)
- GitHub Check: Integration Tests (tanstack-react-start, chrome)
- GitHub Check: Integration Tests (express, chrome)
- GitHub Check: Integration Tests (sessions:staging, chrome)
- GitHub Check: Integration Tests (elements, chrome)
- GitHub Check: Integration Tests (ap-flows, chrome)
- GitHub Check: Integration Tests (generic, chrome)
- GitHub Check: Publish with pkg-pr-new
- GitHub Check: Unit Tests (22, **)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
Description
Starting from
@clerk/shared@3.36.0, non-React applications (e.g., Vue/Nuxt/Astro) fail to start in development mode due to it loadingswrwhich is specific to React. This PR moves theuseAttemptToEnableOrganizationshook to@clerk/shared/react.Discord thread: https://discord.com/channels/856971667393609759/1443954348479746048
Resolves USER-4119
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.