fix(clerk-js): Update error handling and adjust Web3WalletMenu logic with verification status #7489
Conversation
… verification status Signed-off-by: Kenton Duprey <[email protected]>
…ed_at to PasswordSection test fixtures Signed-off-by: Kenton Duprey <[email protected]>
🦋 Changeset detectedLatest commit: 06dff03 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.
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThis PR addresses a Web3 wallet connection issue by preventing users from setting unverified wallets as primary. Changes include modifying the Web3WalletMenu component to accept an Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10-15 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
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: |
kduprey
changed the title
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![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 (1)
.changeset/busy-frogs-type.md (1)
2-2: Consider using 'patch' instead of 'minor' for this bug fix.This PR fixes a bug (preventing the 422 error when attempting to set an unverified Web3 wallet as primary), which typically warrants a patch version bump rather than a minor version bump. According to semantic versioning, minor versions are for new features, while patches are for bug fixes.
Apply this diff if you agree:
-'@clerk/clerk-js': minor +'@clerk/clerk-js': patch
📜 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 (4)
.changeset/busy-frogs-type.md(1 hunks)packages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx(2 hunks)packages/clerk-js/src/ui/components/UserProfile/Web3Section.tsx(3 hunks)packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsx(8 hunks)
🧰 Additional context used
📓 Path-based instructions (18)
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 be written in camelCase
Use useCardState for card-level state management
Use useFormState for form-level state management
Use useLoadingStatus for managing loading states
Use useFormControl hook for form field state management with validation and localization support
All rendered values must be localized using useLocalizations hook - hard coded values are not allowed
Use localizationKeys for translating UI text with support for parameters and error messages
Use handleError utility for API error handling and provide field states for proper error mapping
Use the styled system sx prop with theme tokens for custom styling instead of inline styles
Use the Card component pattern with Card.Root, Card.Header, Card.Title, Card.Content, and Card.Footer for consistent card layouts
Use FormContainer with headerTitle and headerSubtitle localization keys combined with Form.Root and FormButtons for consistent form layouts
When form submission occurs, manage loading and error states by calling status.setLoading(), card.setLoading(), and card.setError() appropriately
Files:
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Section.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
All code must pass ESLint checks with the project's configuration
Files:
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Section.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx
**/*.{js,jsx,ts,tsx,json,md,yml,yaml}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Section.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx
packages/**/src/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Section.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Follow established naming conventions (PascalCase for components, camelCase for variables)
Files:
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Section.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Form.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/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Section.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx
**/*.{test,spec}.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.{test,spec}.{ts,tsx,js,jsx}: Unit tests are required for all new functionality
Verify proper error handling and edge cases
Include tests for all new features
Files:
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsx
**/*.ts?(x)
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
Files:
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Section.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx
**/*.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/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Section.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx
**/*.{test,spec,e2e}.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use real Clerk instances for integration tests
Files:
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsx
**/*.{md,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Update documentation for API changes
Files:
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Section.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx
**/*.test.tsx
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use React Testing Library for component testing
Files:
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.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/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Section.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx
**/*.{test,spec}.{jsx,tsx}
📄 CodeRabbit inference engine (.cursor/rules/react.mdc)
**/*.{test,spec}.{jsx,tsx}: Use React Testing Library for unit testing React components
Test component behavior, not implementation details
Use proper test queries in React Testing Library tests
Implement proper test isolation in React component tests
Use proper test coverage in React component tests
Test component interactions in integration tests
Use proper test data in React component tests
Implement proper test setup in React component tests
Use proper test cleanup in React component tests
Implement proper test assertions in React component tests
Use proper test structure for React component tests
Files:
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.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/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Section.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx
**/*.test.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Use React Testing Library for component testing
Files:
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsx
**/*.{js,ts,jsx,tsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Use ESLint with custom configurations tailored for different package types
Files:
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Section.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx
**/*.{js,ts,jsx,tsx,json,md,yml,yaml}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Use Prettier for code formatting across all packages
Files:
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Section.tsxpackages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx
🧬 Code graph analysis (1)
packages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx (1)
packages/clerk-js/src/ui/utils/web3CallbackErrorHandler.ts (1)
web3CallbackErrorHandler(10-23)
🔇 Additional comments (6)
packages/clerk-js/src/ui/components/UserProfile/__tests__/PasswordSection.test.tsx (1)
142-142: LGTM: Test fixtures enhanced with additional enterprise fields.The test data has been augmented with
enterprise_connection_idandlast_authenticated_atfields, making the fixtures more complete and aligned with the actual data structure. These additions improve test data quality without affecting test logic.Also applies to: 159-160, 218-218, 235-236, 387-387, 404-405, 464-464, 481-482
packages/clerk-js/src/ui/components/UserProfile/Web3Form.tsx (2)
9-9: LGTM: Centralized error handling improves consistency.The refactor to use
web3CallbackErrorHandlerconsolidates error handling logic and provides better error messages for Web3-specific failures (e.g., missing wallet extensions). This aligns with the coding guideline to use thehandleErrorutility for proper error mapping.Also applies to: 63-63
12-12: Error display is properly handled via Card.Alert in Web3Section.The
Textcomponent removal from Web3Form.tsx imports has no impact on error handling. TheAddWeb3WalletActionMenucomponent callscard.setError()viaweb3CallbackErrorHandler(line 63), and since both AddWeb3WalletActionMenu and Web3Section share the same card state context, errors display correctly through<Card.Alert>{card.error}</Card.Alert>in Web3Section (line 56).packages/clerk-js/src/ui/components/UserProfile/Web3Section.tsx (3)
98-101: LGTM: Correctly passes verification status to menu.The
Web3WalletMenunow receives theisVerifiedprop computed fromwallet.verification.status === 'verified', enabling the menu to conditionally render actions based on verification state.
121-149: LGTM: Fix properly prevents setting unverified wallets as primary.The updated logic correctly addresses the bug by gating the "Set primary" action with the
isVerifiedcondition. This prevents users from attempting to set an unverified Web3 wallet as primary, which would result in a 422 error. The comment on line 132 clearly documents the intention.The implementation properly:
- Updates the function signature to accept
isVerified- Adds the verification check to the conditional rendering
- Filters null actions from the array
- Maintains the "Remove" action for all wallets (verified or not)
100-100: The type safety is correct.wallet.verification.statusis properly typed asVerificationStatus | null, whereVerificationStatusis the union'unverified' | 'verified' | 'transferable' | 'failed' | 'expired'. The equality checkwallet.verification.status === 'verified'correctly returnstrueonly for the'verified'state and treats all other states (includingnull) as unverified. No changes needed.
Signed-off-by: Kenton Duprey <[email protected]>
kduprey
force-pushed
the
kenton/user-4238-fix-userprofile-web3walletmenu-actions-to-remove-set-primary
branch
from
4778123 to
7f31ffd
Compare
…eb3walletmenu-actions-to-remove-set-primary
kduprey
deleted the
kenton/user-4238-fix-userprofile-web3walletmenu-actions-to-remove-set-primary
branch
…with verification status (#7489) Signed-off-by: Kenton Duprey <[email protected]>
Description
Currently, if a C2 starts to add their Web3 wallet, but rejects the request to sign the message (e.g. closes the browser window pop up to sign the message), the identifier is still added but marked unverified and still allows users to "Set primary" identifier, which results in a 422 error.
This hides this option from the action menu and only lets the user remove the Web3 connection from their account in order to request to add the connection again and complete the full verification flow.
USER-4238
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
Bug Fixes
✏️ Tip: You can customize this high-level summary in your review settings.