Skip to content

chore(shared): Improve useCheckout error messages #6475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Aug 5, 2025
Merged

chore(shared): Improve useCheckout error messages #6475

merged 2 commits into from
Aug 5, 2025

Conversation

panteliselef
Copy link
Member

@panteliselef panteliselef commented Aug 5, 2025 •
edited by coderabbitai bot
Loading

Description

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Summary by CodeRabbit

  • Bug Fixes
    • Improved error messages for the checkout process to provide clearer guidance when required conditions are not met during initialization.

@panteliselef panteliselef self-assigned this Aug 5, 2025
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Aug 5, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: 0796313

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 19 packages
Name Type
@clerk/shared Patch
@clerk/agent-toolkit Patch
@clerk/astro Patch
@clerk/backend Patch
@clerk/chrome-extension Patch
@clerk/clerk-js Patch
@clerk/elements Patch
@clerk/expo-passkeys Patch
@clerk/clerk-expo Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/clerk-react Patch
@clerk/remix Patch
@clerk/tanstack-react-start Patch
@clerk/testing Patch
@clerk/vue Patch

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

@vercel Vercel
Copy link

vercel bot commented Aug 5, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
clerk-js-sandbox ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 5, 2025 4:58pm

@panteliselef panteliselef changed the title chore(shared): Improve useCheckout error messages on mount chore(shared): Improve useCheckout error messages Aug 5, 2025
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 5, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

The changes introduce updates to the useCheckout hook within the @clerk/shared package. The hook now destructures isLoaded alongside user from the useUser hook and throws an error if isLoaded is false, instructing that useCheckout must be used inside a component wrapped with <ClerkLoaded />. Error messages for missing user and missing active organization context (when forOrganization is 'organization') have been revised to provide clearer instructions about wrapping with <SignedIn /> and checking for an active organization, respectively. No changes were made to the signatures of exported or public entities.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 92da47a and 0796313.

📒 Files selected for processing (1)
  • packages/shared/src/react/hooks/useCheckout.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/shared/src/react/hooks/useCheckout.ts
⏰ 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: semgrep-cloud-platform/scan
  • GitHub Check: Build Packages
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Aug 5, 2025 •
edited
Loading

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@6475

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@6475

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@6475

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@6475

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@6475

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@6475

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@6475

@clerk/clerk-expo

npm i https://pkg.pr.new/@clerk/clerk-expo@6475

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@6475

@clerk/express

npm i https://pkg.pr.new/@clerk/express@6475

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@6475

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@6475

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@6475

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@6475

@clerk/clerk-react

npm i https://pkg.pr.new/@clerk/clerk-react@6475

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@6475

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@6475

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@6475

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@6475

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@6475

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@6475

@clerk/types

npm i https://pkg.pr.new/@clerk/types@6475

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@6475

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@6475

commit: 0796313

@panteliselef panteliselef enabled auto-merge (squash) August 5, 2025 16:56
@panteliselef panteliselef merged commit ef87617 into main Aug 5, 2025
38 checks passed
@panteliselef panteliselef deleted the elef/improve-useCheckout-error branch August 5, 2025 17:07
@clerk-cookie clerk-cookie mentioned this pull request Aug 5, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anagstef anagstef anagstef approved these changes

Assignees

@panteliselef panteliselef

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@panteliselef @anagstef