fix(clerk-js): Correct ticket field reference in SignUpStart.tsx handleSubmit logic gate
#6824
Conversation
…andleSubmit` logic gate Signed-off-by: Kenton Duprey <[email protected]>
🦋 Changeset detectedLatest commit: 7784fd2 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.
|
WalkthroughA changeset is added for a patch release. In SignUpStart.tsx, the ticket detection logic in handleSubmit is updated to read the ticket value from formState.ticket.value instead of fields.ticket, affecting when a ticket from query parameters is pushed into submission fields. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant SU as SignUpStart (UI)
participant FS as formState
participant S as Submit Handler
U->>SU: Submit sign-up form
SU->>FS: Read ticket value
FS-->>SU: ticket = formState.ticket.value
alt ticket detected
SU->>S: Include ticket from query params in submission fields
else no ticket
SU->>S: Submit without ticket
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx (1)
262-273: Gate logic on ticket presence, not field visibility.Using
fields.ticket(UI visibility) to decide API behavior can still route toupsertand setstrategy='ticket'even when the ticket value is empty. Base these checks on the actual value (hasTicket) instead.Apply this diff:
- if (fields.ticket || hasExistingSignUpWithTicket) { + if (hasTicket || hasExistingSignUpWithTicket) { const noop = () => {}; // fieldsToSubmit: Constructing a fake fields object for strategy. fieldsToSubmit.push({ id: 'strategy', value: 'ticket', clearFeedback: noop, setValue: noop, onChange: noop, setError: noop, } as any); } ... - if (!fields.ticket && !hasExistingSignUpWithTicket) { + if (!hasTicket && !hasExistingSignUpWithTicket) { signUpAttempt = signUp.create(buildRequest(fieldsToSubmit)); } else { signUpAttempt = signUp.upsert(buildRequest(fieldsToSubmit)); }Also applies to: 333-337
🧹 Nitpick comments (2)
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx (2)
295-305: Avoid pushing multiplestrategyfields.If a ticket flow is active and an alternative phone code channel is selected, we end up pushing two
strategyfields (ticketandphone_code). Guard to ensure only one strategy is sent.Apply this diff:
- fieldsToSubmit.push({ - id: 'strategy', - value: 'phone_code', - clearFeedback: noop, - setValue: noop, - onChange: noop, - setError: noop, - } as any); + if (!fieldsToSubmit.some(f => f.id === 'strategy')) { + fieldsToSubmit.push({ + id: 'strategy', + value: 'phone_code', + clearFeedback: noop, + setValue: noop, + onChange: noop, + setError: noop, + } as any); + }Please confirm FAPI doesn’t require multiple strategies in a single payload for this path; if it does, we should model it explicitly rather than duplicate
ids.
275-286: Optionally sync the form state after backfilling the ticket.Setting
formState.ticketafter you inject the ticket keeps UI and state consistent for subsequent attempts.Apply this diff:
if (ticketValue) { + // Keep form state in sync so future submissions don't need to refetch + formState.ticket.setValue(ticketValue); fieldsToSubmit.push({ id: 'ticket', value: ticketValue, clearFeedback: noop, setValue: noop, onChange: noop, setError: noop, } as any); }
📜 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 (2)
.changeset/floppy-coins-jump.md(1 hunks)packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (10)
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/SignUp/SignUpStart.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/SignUp/SignUpStart.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/SignUp/SignUpStart.tsx
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/ui/components/SignUp/SignUpStart.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/SignUp/SignUpStart.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/SignUp/SignUpStart.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/SignUp/SignUpStart.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/SignUp/SignUpStart.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/SignUp/SignUpStart.tsx
.changeset/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/floppy-coins-jump.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: Formatting | Dedupe | Changeset
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (2)
.changeset/floppy-coins-jump.md (1)
1-5: Changeset looks good for a patch.Title and scope match the code change. Optionally add a reference to the linked issue (USER-2322) in the body for traceability.
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx (1)
274-287: Fix preserves ticket across retries (correct value source).Good change: checking
formState.ticket.valueand backfilling from query params ensures the ticket is included after errors clear the field.Please validate the repro flow from the PR description: after an initial error clears the ticket, submit again and confirm the network request includes both
strategy=ticketand a non-emptyticket.
@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
deleted the
kenton/user-2322-provide-better-error-messaging-when-a-user-is-unable-to
branch
Description
Root Cause: When
SignUp.tsxform validation errors occur likenot_allowed_access, the error handler clears the ticket from form stateformState.ticket.setValue(''). On subsequent form submissions, the system no longer includes theticketin thehandleSubmitpayload, preventing proper invitation acceptance.Fixes USER-2322
Testing Flow:
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
Bug Fixes
Chores