Skip to content

Conversation

@brkalow
Copy link
Member

@brkalow brkalow commented Jul 25, 2025

Description

Fixes an issue where if the origin header is not present, the cross origin check would not properly execute. The origin header is actually not sent in many cases, and so I wasn't seeing this handshake case trigger when I was expecting it to. The origin that we really want is the request URL's origin, and so I've switched to using that value.

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 detection of request origin to address issues with cross-origin requests in the Clerk SDK backend.
  • Chores
    • Updated internal documentation to reflect the patch update.
    • Adjusted test cases to better align with the updated origin detection logic.

@changeset-bot
Copy link

changeset-bot bot commented Jul 25, 2025

🦋 Changeset detected

Latest commit: 0635999

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

This PR includes changesets to release 11 packages
Name Type
@clerk/backend Patch
@clerk/agent-toolkit Patch
@clerk/astro Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/remix Patch
@clerk/tanstack-react-start Patch
@clerk/testing 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

vercel bot commented Jul 25, 2025

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 Jul 25, 2025 7:38pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 25, 2025

📝 Walkthrough

Walkthrough

A new changeset file was added to document a patch update for the @clerk/backend package, specifically addressing an issue with the Clerk SDK's detection of request origins. In the test suite for request authentication, the origin header was removed from three test cases, and a host header was added to one. In the authenticateContext.ts file, the isCrossOriginReferrer() method was updated to use this.clerkUrl.origin instead of this.origin for determining the origin of requests, with no changes to exported or public entity declarations.

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 3290039 and 0635999.

📒 Files selected for processing (3)
  • .changeset/tidy-windows-travel.md (1 hunks)
  • packages/backend/src/tokens/__tests__/request.test.ts (1 hunks)
  • packages/backend/src/tokens/authenticateContext.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (10)
.changeset/**

📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)

Automated releases must use Changesets.

Files:

  • .changeset/tidy-windows-travel.md
**/*.{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/backend/src/tokens/__tests__/request.test.ts
  • packages/backend/src/tokens/authenticateContext.ts
**/*.{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/backend/src/tokens/__tests__/request.test.ts
  • packages/backend/src/tokens/authenticateContext.ts
packages/**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)

TypeScript is required for all packages

Files:

  • packages/backend/src/tokens/__tests__/request.test.ts
  • packages/backend/src/tokens/authenticateContext.ts
packages/**/*.{ts,tsx,d.ts}

📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)

Packages should export TypeScript types alongside runtime code

Files:

  • packages/backend/src/tokens/__tests__/request.test.ts
  • packages/backend/src/tokens/authenticateContext.ts
**/*.{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
Avoid any type - prefer unknown when type is uncertain, then narrow with type guards
Use interface for object shapes that might be extended
Use type for unions, primitives, and computed types
Prefer readonly properties for immutable data structures
Use private for internal implementation details
Use protected for inheritance hierarchies
Use public explicitly for clarity in public APIs
Prefer readonly for 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
Use const assertions for literal types: as const
Use satisfies operator 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 ...
No any types without justification
Proper error handling with typed errors
Consistent use of readonly for 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/backend/src/tokens/__tests__/request.test.ts
  • packages/backend/src/tokens/authenticateContext.ts
packages/**/*.{test,spec}.{js,jsx,ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)

Unit tests should use Jest or Vitest as the test runner.

Files:

  • packages/backend/src/tokens/__tests__/request.test.ts
**/*.{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/backend/src/tokens/__tests__/request.test.ts
  • packages/backend/src/tokens/authenticateContext.ts
**/__tests__/**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/typescript.mdc)

**/__tests__/**/*.{ts,tsx}: Create type-safe test builders/factories
Use branded types for test isolation
Implement proper mock types that match interfaces

Files:

  • packages/backend/src/tokens/__tests__/request.test.ts
**/*

⚙️ CodeRabbit Configuration File

**/*: If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.

Whenever reviewing a pull request, if there are any changes that could impact security, always tag @clerk/security in the PR.

Security-impacting changes include, but are not limited to:

  • Changes to authentication logic or mechanisms (e.g. login, session handling, token issuance)
  • Any modification to access control, authorization checks, or role-based permissions
  • Introduction or modification of hashing algorithms, signature verification, or cryptographic primitives
  • Handling of sensitive data (e.g. passwords, tokens, secrets, PII)
  • Integration with external identity providers (e.g. SSO, OAuth, OpenID Connect)
  • Modifications to security headers, cookie flags, CORS policies, or CSRF protections
  • Bypass mechanisms (e.g. feature flags, testing overrides) that could weaken protections
  • Changes to rate limiting, abuse prevention, or input validation

If you're unsure whether a change is security-relevant, err on the side of caution and tag @clerk/security.

Any time that you tag @clerk/security, please do so explicitly in a code comment, rather than within a collapsed section in a coderabbit comment, such as the "recent review details" section. If you do use the team name in any thinking or non-direct-code-comment content, it can be referred to as "clerk security team" to avoid accidentally printing the tag which sends a notification to the team.

Files:

  • packages/backend/src/tokens/__tests__/request.test.ts
  • packages/backend/src/tokens/authenticateContext.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: Formatting | Dedupe | Changeset
  • GitHub Check: Build Packages
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (4)
.changeset/tidy-windows-travel.md (1)

1-6: LGTM! Changeset properly documents the origin detection fix.

The changeset correctly categorizes this as a patch-level update and provides a clear description of the issue being fixed.

packages/backend/src/tokens/__tests__/request.test.ts (1)

1469-1469: Good test alignment with the implementation fix.

The addition of the host header correctly aligns with the implementation change where origin is now derived from the request URL (this.clerkUrl.origin) rather than from the origin header (this.origin). This ensures the test properly validates the same-origin scenario.

packages/backend/src/tokens/authenticateContext.ts (2)

187-187: Consistent application of the origin detection fix.

The comparison logic now properly uses the URL-derived origin instead of the potentially missing origin header, ensuring consistent cross-origin detection behavior.


177-177: Approve: Origin detection change is robust and fully tested.

The switch from this.origin to this.clerkUrl.origin is safe and reliable—deriveUrlFromHeaders in clerkRequest.ts constructs clerkUrl.origin from the request URL (including forwarded-host/proto headers), and the existing tests cover all relevant scenarios.

• packages/backend/src/tokens/authenticateContext.ts (lines 177 & 187) now correctly use this.clerkUrl.origin.
• Verification: clerkRequest tests confirm proper handling of forwarded headers, query parameters, and URL fragments.

Please tag @clerk/security for a final security audit.


🪧 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.
    • @coderabbitai modularize this function.
  • 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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
Copy link

pkg-pr-new bot commented Jul 25, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 0635999

Copy link
Member

@jacekradko jacekradko left a comment

Choose a reason for hiding this comment

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

👍🏼

@brkalow brkalow merged commit af615b8 into main Jul 28, 2025
39 checks passed
@brkalow brkalow deleted the brk.fix/primary-domain-cross-origin-check branch July 28, 2025 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants