Skip to content

fix(shared,expo-passkeys): Add docs URL to passkey_invalid_rpID_or_domain error#8216

Open
tmilewski wants to merge 1 commit intomainfrom
tom/user-2256-link-docs-to-when-users-get-passkey_invalid_rpid_or_domain
Open

fix(shared,expo-passkeys): Add docs URL to passkey_invalid_rpID_or_domain error#8216
tmilewski wants to merge 1 commit intomainfrom
tom/user-2256-link-docs-to-when-users-get-passkey_invalid_rpid_or_domain

Conversation

@tmilewski
Copy link
Copy Markdown
Member

@tmilewski tmilewski commented Mar 31, 2026

Description

Adds a documentation link to the passkey_invalid_rpID_or_domain error, pointing users to https://clerk.com/docs/deployments/overview#authentication-across-subdomains explaining the issue.

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
    • Passkey error messages now include documentation links to help troubleshoot authentication issues related to domain configuration.

@tmilewski tmilewski self-assigned this Mar 31, 2026
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 31, 2026

🦋 Changeset detected

Latest commit: e38fb08

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

This PR includes changesets to release 21 packages
Name Type
@clerk/expo-passkeys Patch
@clerk/shared Patch
@clerk/expo Patch
@clerk/agent-toolkit Patch
@clerk/astro Patch
@clerk/backend Patch
@clerk/chrome-extension Patch
@clerk/clerk-js Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/hono Patch
@clerk/localizations Patch
@clerk/msw Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/react Patch
@clerk/tanstack-react-start Patch
@clerk/testing Patch
@clerk/ui 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
Copy link
Copy Markdown

vercel bot commented Mar 31, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment Mar 31, 2026 9:29pm

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 31, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: 25788e9e-f57d-434c-a57e-d8f6b6c0d49b

📥 Commits

Reviewing files that changed from the base of the PR and between cfb8cbe and e38fb08.

📒 Files selected for processing (4)
  • .changeset/whole-paws-unite.md
  • packages/expo-passkeys/src/utils.ts
  • packages/shared/src/errors/webAuthNError.ts
  • packages/shared/src/internal/clerk-js/passkeys.ts

📝 Walkthrough

Walkthrough

This pull request enhances passkey-related error handling by adding documentation URL references to the ClerkWebAuthnError class. The ClerkWebAuthnError constructor is refactored to accept a flexible options object that supports additional fields beyond just the error code. This enables error instances for passkey_invalid_rpID_or_domain to include a docsUrl pointing to Clerk's subdomain authentication documentation. Changes are applied across the expo-passkeys and shared packages, with a corresponding changeset entry documenting patch-level version updates.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding a documentation URL to the passkey_invalid_rpID_or_domain error across the shared and expo-passkeys packages.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new bot commented Mar 31, 2026

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8216

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8216

@clerk/upgrade

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

@clerk/vue

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

commit: e38fb08

Copy link
Copy Markdown
Member

@wobsoriano wobsoriano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants