[Don't Merge Yet] Fix #3906: missing url escape of square backets #3908
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
As System.Uri.GetComponents(...*UriFormat.SafeUnescaped*) is based on the outdated RFC 2396 it unescapes angle brackets, which usage is only declared "unwise" in the original URI RFC from 1998. The uptodate one, RFC 3986, forbidds them in path segments. This causes trouble with software based on the newer RFC, such as the OPC API in `System.IO.Packaing`. Instead of hooking a third layer of escape/unescape layer on top of the existing code, I decided to rewrite the `ensureValidName` method, hoping the intend of the code is clearer now. For more details see the comments in fsprojects#3906.
jbaehr
changed the title
|
Currently, it's not clear if this proposed fix here is for better or worse, cf. #3906 (comment). |
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.
As System.Uri.GetComponents(...UriFormat.SafeUnescaped) is based on
the outdated RFC 2396 it unescapes angle brackets, which usage is only
declared "unwise" in the original URI RFC from 1998. The uptodate one,
RFC 3986, forbidds them in path segments. This causes trouble with
software based on the newer RFC, such as the OPC API in
System.IO.Packaing.Instead of hooking a third layer of escape/unescape layer on top of the
existing code, I decided to rewrite the
ensureValidNamemethod, hopingthe intend of the code is clearer now. For more details see the comments
in #3906.
Note: I was only able to verify the method isolated in LinqPad. I tried hard but failed to compile paket (and thus run the tests) because of a corporate proxy requiring credentials. Sorry for that; let's hope for the CI.