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

Override cookie encode #10055

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

Evanion
Copy link

@Evanion Evanion commented Oct 3, 2024

Current behaviour

Right now, the Base64 encoding is applied before the value is sent to the cookie serializer. but the options object still takes parameters for overriding the encode/ decode functions.

Expected behaviour

I would expect that when I add my own encode/decode functions, that the value isn't Base64 encoded anymore.

Side effects

One side effect of this change, is that you can't sign cookies using the secrets property any more. But the user can still handle that themselves in the encode/decode functions.

This will give more flexibility to the cookie utils in remix, and allow developers to keep a good DX, by not having to use different APIs for different cookies minimizing confusion.

Testing Strategy

These new tests covers this code

Right now, if a developer adds an encode/decode function when creating a cookie, it's applied after the cookie is Base64 encoded. We should not Base64 encode a cookie if the developer have added a `encode`/`decode` override to the
cookie options. Unfortunately this makes the override and sign/secret options mutually exclusive.

BREAKING CHANGE: If you override the cookie encode/decode functions, you can't sign the cookie with a secret
adds tests for the encode/decode options.
Copy link

changeset-bot bot commented Oct 3, 2024

⚠️ No Changeset found

Latest commit: d307d8b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Oct 3, 2024

Hi @Evanion,

Welcome, and thank you for contributing to Remix!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at [email protected].

Thanks!

- The Remix team

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Oct 3, 2024

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

@Evanion
Copy link
Author

Evanion commented Oct 3, 2024

I'm unsure what changeset I should add. Strictly speaking, there is a breaking change, so following semver, it's a major bump.

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