Skip to content

fix(nuxt): write initial cookie value if different from document.cookie #31517

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 1 commit into from
Mar 25, 2025
Merged

fix(nuxt): write initial cookie value if different from document.cookie #31517

merged 1 commit into from
Mar 25, 2025

Conversation

danielroe
Copy link
Member

🔗 Linked issue

resolves #26701

📚 Description

this ensures we always write initial cookie value in the browser if it has expired or we are using the default cookie value

@danielroe danielroe self-assigned this Mar 24, 2025
@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Mar 24, 2025

Walkthrough

The changes update the cookie handling logic and testing in the application. In the cookie.ts file, a new variable, shouldSetInitialClientCookie, has been introduced to determine whether an initial client cookie should be set based on conditions such as being on the client side, the cookie having expired, or the cookie being undefined or null. Additionally, the callback function’s signature has been revised to include a force parameter (defaulting to false), with its execution now contingent on this parameter or a change in value when the cookie is not read-only. In the test file, a new test case has been added under the useCookie suite. This test verifies that cookies are correctly set on the client side under different configurations, including scenarios with standard, watched, and read-only cookies.

📜 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 f2124b3 and a6eb28f.

📒 Files selected for processing (2)
  • packages/nuxt/src/app/composables/cookie.ts (3 hunks)
  • test/nuxt/composables.test.ts (1 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
test/nuxt/composables.test.ts (1)
packages/nuxt/src/app/composables/cookie.ts (1)
  • useCookie (41-165)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build
  • GitHub Check: code
🔇 Additional comments (4)
packages/nuxt/src/app/composables/cookie.ts (3)

56-56: Good addition: Variable to track when to set the initial client cookie

This new variable correctly identifies the scenarios when a cookie should be initially set on the client side: when the cookie has expired, or when it doesn't exist yet (undefined or null). This is a sensible improvement that makes the code's intent clearer.

78-81: Improved callback function with force parameter

The addition of the force parameter to the callback function enables more control over when cookies are written. This allows bypassing the readonly check and equality comparison when necessary, which is essential for ensuring initial cookie values are consistently set.

138-139: Fixed initial cookie setting on the client side

This change ensures that the initial cookie value is written to the client when needed (expired cookies, undefined cookies, or null cookies). The use of the variable as both a condition and a parameter to the callback function is elegant.

test/nuxt/composables.test.ts (1)

798-807: Good test coverage for the fix

This test case properly verifies that cookies are correctly set in the browser under different configurations:

  • With watch set to false
  • With watch set to true
  • With readonly set to true

The test ensures that the initial cookie value is written to the document in all three scenarios, which aligns with the implementation changes in the cookie.ts file.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 docstrings to generate docstrings for 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 Mar 24, 2025

Open in Stackblitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@31517

nuxt

npm i https://pkg.pr.new/nuxt@31517

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@31517

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@31517

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@31517

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@31517

commit: a6eb28f

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Mar 24, 2025

CodSpeed Performance Report

Merging #31517 will not alter performance

Comparing fix/client-cookie (a6eb28f) with main (f2124b3)

Summary

✅ 10 untouched benchmarks

@danielroe danielroe merged commit 62b320d into main Mar 25, 2025
47 checks passed
@danielroe danielroe deleted the fix/client-cookie branch March 25, 2025 22:45
This was referenced Mar 25, 2025
Closed
Merged
danielroe added a commit that referenced this pull request Mar 26, 2025
@danielroe
fix(nuxt): write initial cookie value if different from `document.coo…
ac3adb7 
…kie` (#31517)
@github-actions github-actions bot mentioned this pull request Mar 26, 2025
Merged
@wattanx wattanx mentioned this pull request Jun 4, 2025
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@danielroe danielroe

Labels
3.x bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Cookie default value not set if useCookie only invoked in CSR
1 participant
@danielroe
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy