Skip to content
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

chore: deprecate pathless cookie, warn on path: '' #11237

Merged
merged 3 commits into from Dec 9, 2023

Conversation

Rich-Harris
Copy link
Member

This prints a warning if you call cookies.set(...) or cookies.delete(...) without specifying a path, as part of #9299.

I think we should change the behaviour of path: '' in SvelteKit 2.0 as well. Currently, it's equivalent to leaving it unspecified. It would be more useful (and more consistent with other places where paths are resolved) if it meant 'the current path' instead — the fact that it doesn't is a quirk of how cookie headers are serialized, rather than something deliberate. As such, I've also added a warning that it will change. (I expect very few people are doing path: '' today.)

In development, the warning also points to the callsite, making it easy to fix.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

@Rich-Harris Rich-Harris added this to the 2.0 milestone Dec 8, 2023
Copy link

changeset-bot bot commented Dec 8, 2023

🦋 Changeset detected

Latest commit: 9f030d7

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

This PR includes changesets to release 1 package
Name Type
@sveltejs/kit 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

@dummdidumm dummdidumm merged commit ded1630 into master Dec 9, 2023
14 checks passed
@dummdidumm dummdidumm deleted the deprecate-pathless-cookie-set branch December 9, 2023 14:53
@github-actions github-actions bot mentioned this pull request Dec 9, 2023
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.

None yet

3 participants