Improve documentation for CookiePolicyMiddleware and CookieOptions#54968
Merged
captainsafia merged 3 commits intodotnet:mainfrom Apr 8, 2024
Merged
Conversation
bseptember
requested review from
BrennanConroy,
captainsafia and
halter73
as code owners
ghost
added
the
area-networking
dotnet-policy-service
bot
added
the
community-contribution
bseptember
changed the title
Contributor
Author
|
@dotnet-policy-service agree company="Retro Rabbit" |
amcasey
added
area-middleware
Contributor
|
cc: @Rick-Anderson @tdykstra for docs review. |
tdykstra
reviewed
Apr 5, 2024
Contributor
tdykstra
left a comment
tdykstra
left a comment
There was a problem hiding this comment.
Some suggestions for you to consider.
Rick-Anderson
approved these changes
Apr 5, 2024
Contributor
Rick-Anderson
left a comment
Rick-Anderson
left a comment
There was a problem hiding this comment.
Approve with @tdykstra suggestions.
Co-authored-by: Tom Dykstra <[email protected]>
Co-authored-by: Tom Dykstra <[email protected]>
captainsafia
approved these changes
Apr 8, 2024
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
Improve documentation for CookiePolicyMiddleware and CookieOptions
Summary of the changes (Less than 80 chars)
Added more detail in the doc. to warn developers of the recommended usage to avoid potential issues related to reusing CookieOptions instances.
Description
This pull request deals with Issue #53875 which is related to CookiePolicyMiddleware that's set up with UseCookiePolicy directly modifies the CookieOptions that's passed in to IResponseCookies.Append. This can lead to bugs where the modifications "bleed" over to unintended cookies if the CookieOptions is reused for multiple cookies, for example if it's stored in a static field in a controller.
Therefore, the documentation has been updated accordingly.
Fixes #53875 (documentation changed)