Skip to content

fix(backend,shared,types): Do not check for sessionClaims on auth state #6164

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.

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

Closed
wants to merge 1 commit into from

Conversation

LauraBeatris
Copy link
Member

@LauraBeatris LauraBeatris commented Jun 20, 2025

Description

⚠️ Debugging weird bug with auth state - do not merge it, just using it to publish a snapshot ⚠️

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 handling of authentication data by making session claims optional and nullable in certain scenarios.
  • Documentation
    • Updated JSDoc comments for clarity and consistency.
  • Style
    • Made minor formatting adjustments and reordered export statements for improved readability.
  • Chores
    • Added temporary logging for debugging authentication data.

Copy link

changeset-bot bot commented Jun 20, 2025

🦋 Changeset detected

Latest commit: a5b9528

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

This PR includes changesets to release 22 packages
Name Type
@clerk/nextjs Patch
@clerk/shared Patch
@clerk/types 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/nuxt Patch
@clerk/react-router Patch
@clerk/clerk-react Patch
@clerk/remix Patch
@clerk/tanstack-react-start Patch
@clerk/testing Patch
@clerk/vue Patch
@clerk/localizations Patch
@clerk/themes 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

Copy link

vercel bot commented Jun 20, 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 Jun 20, 2025 0:17am

Copy link
Contributor

coderabbitai bot commented Jun 20, 2025

📝 Walkthrough

Walkthrough

The changes introduce console.log statements for debugging in the synchronous and asynchronous getAuthDataFromRequest functions within the Next.js package. In the shared authorization package, JSDoc comments for authorization check functions are updated for formatting and capitalization, and the resolveAuthState function simplifies conditional checks by removing sessionClaims presence conditions. The export order of authorization-related functions is rearranged without changing the exported entities. In the types package, the UseAuthReturn type is modified to make the sessionClaims property optional and nullable when isSignedIn is true. A new changeset file declares patch updates for three packages.

Possibly related PRs

Suggested labels

backend


📜 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 8d12e9f and a5b9528.

📒 Files selected for processing (4)
  • .changeset/weak-hands-kiss.md (1 hunks)
  • packages/nextjs/src/server/data/getAuthDataFromRequest.ts (2 hunks)
  • packages/shared/src/authorization.ts (6 hunks)
  • packages/types/src/hooks.ts (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .changeset/weak-hands-kiss.md
🚧 Files skipped from review as they are similar to previous changes (3)
  • packages/nextjs/src/server/data/getAuthDataFromRequest.ts
  • packages/types/src/hooks.ts
  • packages/shared/src/authorization.ts
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: Build Packages
  • 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.
    • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 545999c and 8d12e9f.

📒 Files selected for processing (3)
  • packages/nextjs/src/server/data/getAuthDataFromRequest.ts (2 hunks)
  • packages/shared/src/authorization.ts (6 hunks)
  • packages/types/src/hooks.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: semgrep/ci
🔇 Additional comments (6)
packages/types/src/hooks.ts (1)

97-97: The previous search failed due to the unrecognized tsx file type. Let’s rerun a broader search for any direct property access of sessionClaims across .ts and .tsx files:

#!/bin/bash
# Broader search for sessionClaims property access in TS/TSX files
rg -A 3 -B 3 "sessionClaims\." -g '*.ts' -g '*.tsx'
packages/shared/src/authorization.ts (5)

78-79: Minor JSDoc formatting improvement.

The capitalization of "Null" in the return description improves consistency with standard documentation conventions.


166-167: Minor JSDoc formatting improvement.

The capitalization of "Null" in the return description improves consistency with standard documentation conventions.


329-329: Correctly removes sessionClaims check from auth state resolution.

This change aligns with the PR objective to not check for sessionClaims when determining auth state. The logic now correctly considers a user signed in based on sessionId and userId presence, with sessionClaims being optional.


347-347: Export order changed without functional impact.

The reordering of exports doesn't affect functionality but changes the order in which functions are exported. This is a minor organizational change.


312-312: Correctly removes sessionClaims check from auth state resolution.

This change aligns with the PR objective to not check for sessionClaims when determining auth state. The logic now correctly considers a user signed in based on sessionId and userId presence, with sessionClaims being optional.

Verify that this change doesn't break existing functionality by ensuring all test cases pass:

#!/bin/bash
# Search for tests related to resolveAuthState to verify they still pass
rg -A 10 -B 5 "resolveAuthState" --type ts --type js packages/*/test* packages/*/src/**/*test*

@@ -78,6 +78,8 @@ export const getAuthDataFromRequestSync = (
return getAuthObjectFromJwt(jwt, options);
}

console.log('auth object from auth data request', { authObject });
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Remove console.log statement before production.

This debugging statement should be removed as it may expose sensitive authentication data in production logs and create unnecessary console noise.

-  console.log('auth object from auth data request', { authObject });
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
console.log('auth object from auth data request', { authObject });
🤖 Prompt for AI Agents
In packages/nextjs/src/server/data/getAuthDataFromRequest.ts at line 81, remove
the console.log statement that outputs the authObject to prevent exposing
sensitive authentication data and avoid unnecessary console noise in production
environments.

@LauraBeatris LauraBeatris force-pushed the laura/fix-auth-state branch from 8d12e9f to d9fad15 Compare June 20, 2025 00:15
Copy link

pkg-pr-new bot commented Jun 20, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: a5b9528

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

Successfully merging this pull request may close these issues.

2 participants