Document System.Net.Cookie path related breaking changes #20416
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
gewarren
reviewed
Sep 2, 2020
| @@ -254,6 +254,7 @@ If you're migrating from version 3.1 of .NET Core, ASP.NET Core, or EF Core to v | |||
|
|
|||
| - [WinHttpHandler removed from .NET runtime](#winhttphandler-removed-from-net-runtime) | |||
| - [MulticastOption.Group doesn't accept a null value](#multicastoptiongroup-doesnt-accept-a-null-value) | |||
| - [Cookie Path handling now conforms to RFC 6265](#cookie-path-handling-now-conforms-to-rfc-6265) | |||
There was a problem hiding this comment.
Please also add the include link to the networking category file: https://github.com/dotnet/docs/blob/master/docs/core/compatibility/networking.md
| @@ -0,0 +1,34 @@ | |||
| ### Cookie Path handling now conforms to RFC 6265 | |||
|
|
|||
| Path handling algorithms defined in [RFC 6265](https://tools.ietf.org/html/rfc6265) were implemented for `Cookie` and `CookieContainer` classes. | |||
There was a problem hiding this comment.
Suggested change
| Path handling algorithms defined in [RFC 6265](https://tools.ietf.org/html/rfc6265) were implemented for `Cookie` and `CookieContainer` classes. | |
| Path-handling algorithms defined in [RFC 6265](https://tools.ietf.org/html/rfc6265) were implemented for the <xref:System.Net.Cookie> and <xref:System.Net.CookieContainer> classes. |
| #### Change description | ||
|
|
||
| - Restriction for the `Path` attribute is removed (it's no longer expected to be a prefix of the request path). | ||
| - Calculation of the default value of `Path` and path matching algorithms were implemented as defined in [section 5.1.4](https://tools.ietf.org/html/rfc6265#section-5.1.4) of RFC 6265. |
There was a problem hiding this comment.
Suggested change
| - Calculation of the default value of `Path` and path matching algorithms were implemented as defined in [section 5.1.4](https://tools.ietf.org/html/rfc6265#section-5.1.4) of RFC 6265. | |
| - The calculation of the default value of <xref:System.Net.Cookie.Path> and path-matching algorithms were implemented as defined in [section 5.1.4](https://tools.ietf.org/html/rfc6265#section-5.1.4) of RFC 6265. |
|
|
||
| #### Change description | ||
|
|
||
| - Restriction for the `Path` attribute is removed (it's no longer expected to be a prefix of the request path). |
There was a problem hiding this comment.
Suggested change
| - Restriction for the `Path` attribute is removed (it's no longer expected to be a prefix of the request path). | |
| - The <xref:System.Net.Cookie.Path> property is no longer required to be a prefix of the request path. |
|
|
||
| #### Recommended action | ||
|
|
||
| In most cases, you won't need to take any action. However, if your code was dependent on `Path` validation you would need to implement required validation in your code; or if your code was dependent on `Path`'s default value calculation, you might want to supply the `Path` value manually instead of using the default value. |
There was a problem hiding this comment.
Suggested change
| In most cases, you won't need to take any action. However, if your code was dependent on `Path` validation you would need to implement required validation in your code; or if your code was dependent on `Path`'s default value calculation, you might want to supply the `Path` value manually instead of using the default value. | |
| In most cases, you won't need to take any action. However, if your code was dependent on <xref:System.Net.Cookie.Path> validation, you'll need to implement required validation in your code. If your code was dependent on default value calculation for <xref:System.Net.Cookie.Path>, consider supplying the <xref:System.Net.Cookie.Path> value manually instead of using the default value. |
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.
Described changes introduced by PR dotnet/runtime#39250
Fixes #20363