Define default value for Cookie Max-Age #10775
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
The Cookie interface is updated with a constant value to represent an undefined Max-Age, and its JavaDocs are updated to explicitly state that the undefined value should not be encoded. The CookieHttpCookieAdapter implementation is updated to explicitly set the required undefined max age value in its constructor. The new constant is consistent with the behavior of the Netty Cookie implementation, and is meant to enforce consistency between it and the HttpCookie based implementation, if only by explicitly stating the intended contract. The CookieFactory service definition is removed from the http module as HttpCookieFactory already gets loaded by default (if no other service definitions are loaded) via CookieFactory.INSTANCE. This allows other explicit services definitions such as that in http-netty to reliably override the default implementation. Tests are added to verify the undefined max age value in both implementations, and to ensure that NettyServerCookieEncoder can correctly encode a Cookie created by the default HttpCookieFactory.
sdelamo
approved these changes
Apr 29, 2024
There was a problem hiding this comment.
I added the same test for the DefaultServerCookieEncoder.
A difference in encoding is the Netty encoder uses HTTPOnly while the other uses HttpOnly. The latter seems more correct but I guess both work.
@jeremyg484 I also changed the adapter to set max only if it is -1.
|
yawkat
approved these changes
Apr 29, 2024
sdelamo
pushed a commit
that referenced
this pull request
Apr 29, 2024
The Cookie interface is updated with a constant value to represent an undefined Max-Age, and its JavaDocs are updated to explicitly state that the undefined value should not be encoded. The CookieHttpCookieAdapter implementation is updated to explicitly set the required undefined max age value in its constructor. The new constant is consistent with the behavior of the Netty Cookie implementation, and is meant to enforce consistency between it and the HttpCookie based implementation, if only by explicitly stating the intended contract. The CookieFactory service definition is removed from the http module as HttpCookieFactory already gets loaded by default (if no other service definitions are loaded) via CookieFactory.INSTANCE. This allows other explicit services definitions such as that in http-netty to reliably override the default implementation. Tests are added to verify the undefined max age value in both implementations, and to ensure that NettyServerCookieEncoder can correctly encode a Cookie created by the default HttpCookieFactory. * test: DefaultServerCookieEncoder encoding test * Only set if -1
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.
Close: #10773
Close: micronaut-projects/micronaut-security#1682
The
Cookieinterface is updated with a constant value to represent anundefined Max-Age, and its JavaDocs are updated to explicitly state
that the undefined value should not be encoded.
The
CookieHttpCookieAdapterimplementation is updated to explicitly setthe required undefined max age value in its constructor.
The new constant is consistent with the behavior of the Netty
Cookieimplementation, and is meant to enforce consistency between it and the
HttpCookiebased implementation, if only by explicitly stating theintended contract.
The
CookieFactoryservice definition is removed from thehttpmoduleas
HttpCookieFactoryalready gets loaded by default (if no otherservice definitions are loaded) via
CookieFactory.INSTANCE. Thisallows other explicit service definitions such as that in
http-nettyto reliably override the default implementation.
Tests are added to verify the undefined max age value in both
implementations, and to ensure that
NettyServerCookieEncodercancorrectly encode a
Cookiecreated by the defaultHttpCookieFactory.This should resolved issues occurring in Micronaut Security with session
based authentication such as micronaut-projects/micronaut-security#1682