Allow setting all cookie package serialize/parse options

[alex-sherwin]

This PR fixes #9062

• Changes AstroCookieSetOptions to be based on CookieSerializeOptions from the cookie package. All the Astro code was already passing the options provided directly to cookie's serialize function, so this is just a typing change.
• Changes AstroCookieSetOptions to be exported from the main astro package so it can be utilized by end-user code
• Adds an exported AstroCookieGetOptions based on CookieParseOptions from the cookie package.
• Modifies the Astro.cookies.get() function to take an optional options: AstroCookieGetOptions | undefined which is passed down to the cookie package's parse function
• Astro.cookies.has() gets the same treatment as get since it triggers cookie parsing
• Test coverage for existing behavior which covers the fact that the default behavior of cookie set/get value serialization is to URI encode the value (the cookie package is doing this by default, but no tests were explicitly covering this behavior)
• Test coverage for overriding the cookie set/get behavior for serialization/deserialization with identity functions to prevent URI encoding/decoding

[changeset-bot]

🦋 Changeset detected

Latest commit: d41b619

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

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

[matthewp]

Thanks for the contribution @alex-sherwin! We don't normally like to expose dependency options like this, because it leaks an implementation detail. We would like to be able to swap out the serialization dependency without it being a breaking change in Astro.

So, instead what I would suggest is adding the properties from CookieSerializeOptions that you need directly to AstroCookieSetOptions, so that it's part of our explicit API. Thanks!

[matthewp]

Instead of inheriting from CookieSerializeOptions, just take the properties it has that we need.

[alex-sherwin]

Thanks for the contribution @alex-sherwin! We don't normally like to expose dependency options like this, because it leaks an implementation detail. We would like to be able to swap out the serialization dependency without it being a breaking change in Astro.

So, instead what I would suggest is adding the properties from CookieSerializeOptions that you need directly to AstroCookieSetOptions, so that it's part of our explicit API. Thanks!

Happy to make that change @matthewp

But to clarify, you're receptive to exposing at least the encode and decode options (and thus commit to supporting these in Astro in the event the underlying serialization package/dependency changes in the future)?

I don't think that should be a problem, the barrier is low (the behavior now is to delegate to the encodeURIComponent and decodeURIComponent builtins

[matthewp]

@alex-sherwin Yeah, totally fine with exposing such an option, just didn't want to expose all of the dependencies' options for the backwards compat reason.

[matthewp]

Hello @alex-sherwin, was wondering if you planned to update this PR?

[alex-sherwin]

Hello @alex-sherwin, was wondering if you planned to update this PR?

Hi @matthewp, yes, I will plan to update it today

[florian-lefebvre]

@alex-sherwin up! ;)

[matthewp]

Great job getting this over the line @florian-lefebvre. We don't currently have a plan for the next minor, it will likely come around the new year.

[matthewp]

Docs PR: withastro/docs#6042

[sarah11918]

Thanks so much for providing this, @matthewp ! Looks great! Just left some tiny suggestions for your consideration!

[ematipico]

Added a better suggestion for the changelog. The arrow function o => o didn't tell us very much

[sarah11918]

Approving on behalf of docs for the sake of completion/visibility!