Add Base64 get/setCookie and documentation to Obelisk.Frontend.Cookie #1017
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
madeline-os
requested changes
Jan 26, 2023
| @@ -10,26 +10,72 @@ | |||
| {-# LANGUAGE RankNTypes #-} | |||
| {-# LANGUAGE TypeFamilies #-} | |||
| {-# LANGUAGE UndecidableInstances #-} | |||
| {-# LANGUAGE OverloadedStrings #-} | |||
| {-| | |||
| Description: | |||
|
|
||
|
|
||
|
|
||
| -- TODO: Make generic over both frontend and backend. |
There was a problem hiding this comment.
todo in code >:|
can you make an issue instead?
| askCookies = fmap (parseCookies . encodeUtf8) $ DOM.getCookie =<< askDocument | ||
|
|
||
| -- | Store a cookie which will be Base64 encoded. | ||
| setCookie :: (HasSetCookie m) => SetCookie -> m () |
There was a problem hiding this comment.
Can we name this encodeAndSetCookie? I don't want it to be surprising that this function re-encodes your cookie value for you.
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
This extends the Cookie module with a class for setting cookies and adds some documentation to the module.
HasSetCookieis implemented onSnapandMonadJSM/Client m. The Haddocks warn thatHasSetCookieandHasCookiesdo not necessarily implement a state monad. While this is the case forClient m, inSnapsetting cookies affects the HTTP response while asking cookies looks at the request. I did this for pragmatic reasons (not breaking old code, not requiring a wrapper type inside Snap to distinguish the two sources of cookies).A few helper functions are added to encourage Base64 use by default:
setCookieandaskCookiework do Base64 encoding/decoding of cookies.developbranchhlint .(lint found code you did not write can be left alone)$(nix-build -A selftest --no-out-link)Failed on some unrelated points?nix-build release.nix -A build.x86_64-linux --no-out-link(orx86_64-darwinon macOS)Closes #977.