Skip to content

Conversation

@brkalow
Copy link
Member

@brkalow brkalow commented Jul 21, 2025

Description

  • In some cases where we weren't using default cookie attributes, our .remove() helper was not working as expected. This refactors our cookie handlers to use the same attributes for setting and removing.
  • Uses the UserSignOut event to handle unsetting cookies during the sign out flow, instead of relying on TokenUpdate.
  • Fixes types for our cookie remove() handler to mirror the underlying library

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

    • Resolved an issue where cookies were not always cleared correctly during sign out when custom cookie attributes were used. Cookies are now consistently removed with the correct attributes.
  • Documentation

    • Improved documentation for cookie handling, clarifying the requirements for removing cookies with custom attributes.
  • Tests

    • Added test coverage to verify that cookies are deleted using the same attributes as when they were set.
  • Refactor

    • Standardized and centralized cookie attribute handling for improved consistency.

@changeset-bot
Copy link

changeset-bot bot commented Jul 21, 2025

🦋 Changeset detected

Latest commit: 6af5c67

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

This PR includes changesets to release 19 packages
Name Type
@clerk/clerk-js Patch
@clerk/shared Patch
@clerk/chrome-extension Patch
@clerk/clerk-expo Patch
@clerk/agent-toolkit Patch
@clerk/astro Patch
@clerk/backend Patch
@clerk/elements Patch
@clerk/expo-passkeys 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
Copy link

vercel bot commented Jul 21, 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 28, 2025 7:53pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 21, 2025

📝 Walkthrough

Walkthrough

This change addresses a bug in the handling of cookies during user sign out, specifically ensuring that cookies are correctly cleared when non-default attributes are used. The main updates include centralizing and standardizing the determination of cookie attributes (such as sameSite, secure, and partitioned) in helper functions, and ensuring these attributes are consistently applied when setting and removing cookies. The AuthCookieService now listens for the UserSignOut event to trigger cookie removal. The createCookieHandler API is updated to clarify and enforce the need for matching attributes during cookie removal. Tests are added to verify correct attribute usage. The emission of a TokenUpdate event with a null token during sign out is removed.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 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 7cfeed2 and 6af5c67.

📒 Files selected for processing (1)
  • packages/clerk-js/src/core/clerk.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/clerk-js/src/core/clerk.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). (4)
  • 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.
    • @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 21, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 6af5c67

import { getSuffixedCookieName } from '@clerk/shared/keys';

import { inCrossOriginIframe } from '../../../utils';
import { getSecureAttribute } from '../getSecureAttribute';
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
import { getSecureAttribute } from '../getSecureAttribute';
import { inCrossOriginIframe } from '../../../utils';
import { getSecureAttribute } from '../getSecureAttribute';

@brkalow brkalow merged commit f1d9d34 into main Jul 28, 2025
36 checks passed
@brkalow brkalow deleted the brk.fix/unset-cookies-on-sign-out branch July 28, 2025 20:25
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.

5 participants