get_cookie_name in SessionInterface for easier overriding in SecureCookieSessionInterface #3369
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
|
Makes sense. Needs a changelog and tests. |
doronhorwitz
force-pushed
the
get-cookie-name
branch
5 times, most recently
from
6f328f4
to
9d640ae
Compare
|
Thanks @davidism. Added a test and changelog. |
|
@davidism, is my test and changelog adequate? Is there anything more required? |
|
Looks good, I'll get to it when I can. |
|
great, thanks. |
davidism
force-pushed
the
get-cookie-name
branch
from
9d640ae
to
0c2dff8
Compare
…okieSessionInterface
davidism
force-pushed
the
get-cookie-name
branch
from
0c2dff8
to
0c0b31a
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Most of the other arguments passed into
response.set_cookie()inSecureCookieSessionInterface.save_session()use the overridable methods ofSessionInterfaceto fill in each argument. Except for the cookie name, which is statically set toapp.session_cookie_name.Sometimes a cookie name needs to be set dynamically based on the current request, for example, a cookie name that is dependent on the current subpath in the URL. At the moment, the best way of doing this is to override the
save_session()method ofSecureCookieSessionInterfaceand make it dynamically pass in the cookie name toresponse.set_cookie().To avoid having to override the whole of
save_session(), this pull request adds in an overridableget_cookie_name()method onSessionInterfaceto match the otherget_xxx()methods of that class.Note: I originally posted a question about this in Stackoverflow ("Something like get_cookie_name in Flask's SessionInterface?") and also asked the question (using the Stackoverflow link) in the Flask Discord chat. I was not satisfied with the response I got, so I've opened up this pull request.