fix: implement cookie persistence using tough-cookie
#2206
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kettanaito
commented
Jul 16, 2024
| } | ||
| const cookiesFromStore = Object.fromEntries( | ||
| cookieStore | ||
| .getCookiesSync(request.url) |
There was a problem hiding this comment.
The tough-cookie package implements specification-compliant way of returning matching cookies for the given URL. It's maintained and well-used. I see no reason for us to rely on @mswjs/cookies anymore.
kettanaito
commented
Jul 19, 2024
| // in the HeadersInit. This is later used to store these cookies | ||
| // in cookie jar and return the right cookies in the "cookies" | ||
| // response resolver argument. | ||
| Object.defineProperty(response, kSetCookie, { |
There was a problem hiding this comment.
I would love to store the cookies here directly but tough-cookie needs a URL to associate the cookies with. response.url is not always defined (this may be easier to solve). I don't like introducing a symbol just to pass the data around.
kettanaito
changed the title
kettanaito
changed the title
4 tasks
kettanaito
changed the title
tough-cookie
Released: v2.3.3 🎉This has been released in v2.3.3! Make sure to always update to the latest version ( Predictable release automation by @ossjs/release. |
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
HttpOnlycookies are not exposed to thecookiesargument of the response resolver.This is a rework of the request/response cookie handling. Since v2, I believe the previous logic has become obsolete. We are forwarding the mocked response cookies to the
document.cookiebut we won't be able to read them back if those cookies are not exposed to JavaScript (likeHttpOnlycookies). Neither would we be able to read them back from theresponse.headers.get('set-cookie')because that's a forbidden header field.In this rework, I'm removing
@mswjs/cookiesand introducingtough-cookieand itsCookieJarclass to get cookie filtering and, eventually, persistence (has to be implemented separately through a customStore).Roadmap
requireleaking throughtough-cookie(is it CJS-only?)@bundled-es-modules/tough-cookielocalStorageso they persist across page refreshes.