Encode/Decode grpc-message status per spec #3023
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
Motivation ---------- At the moment a grpc status message is not percent-encoded which the spec mandates. This is not a problem as long as regular printable ascii characters are used, but other ranges mandate a percent encoding on the wire. Modifications ------------- This changeset implements the percent encoding/decoding for the grpc status message and transparently applies it in the places where the ServiceTalk codebase would access the header previously. The implementation is strongly aligned on the io.grpc equivalent in order to ensure maximum compatibility across systems. Result ------ Properly percent-encoded/decoded grpc-message payload when non ascii-printable characters are sent.
daschl
commented
Jul 30, 2024
servicetalk-grpc-internal/src/main/java/io/servicetalk/grpc/internal/StatusMessageUtils.java
Outdated
Show resolved
Hide resolved
|
@idelpivnitskiy looked into the grpc test suite where to put a proper integration test but did not find a good candidate right away. If you have a preference please let me know. |
|
@daschl |
servicetalk-grpc-internal/src/main/java/io/servicetalk/grpc/internal/StatusMessageUtils.java
Outdated
Show resolved
Hide resolved
servicetalk-grpc-internal/src/main/java/io/servicetalk/grpc/internal/StatusMessageUtils.java
Outdated
Show resolved
Hide resolved
...icetalk-grpc-internal/src/test/java/io/servicetalk/grpc/internal/StatusMessageUtilsTest.java
Outdated
Show resolved
Hide resolved
servicetalk-grpc-internal/src/main/java/io/servicetalk/grpc/internal/StatusMessageUtils.java
Outdated
Show resolved
Hide resolved
servicetalk-grpc-internal/src/main/java/io/servicetalk/grpc/internal/StatusMessageUtils.java
Outdated
Show resolved
Hide resolved
servicetalk-grpc-internal/src/main/java/io/servicetalk/grpc/internal/StatusMessageUtils.java
Outdated
Show resolved
Hide resolved
daschl
commented
Jul 31, 2024
servicetalk-grpc-netty/src/test/java/io/servicetalk/grpc/netty/ProtocolCompatibilityTest.java
Show resolved
Hide resolved
|
@bryce-anderson the current implementation in the PR is now as vanilla as it gets w.r.t io.grpc compatibility. From this point on we can decide if we want to optimize etc. |
servicetalk-grpc-internal/src/main/java/io/servicetalk/grpc/internal/GrpcStatusUtils.java
Outdated
Show resolved
Hide resolved
servicetalk-grpc-internal/src/main/java/io/servicetalk/grpc/internal/GrpcStatusUtils.java
Outdated
Show resolved
Hide resolved
servicetalk-grpc-netty/src/test/java/io/servicetalk/grpc/netty/ProtocolCompatibilityTest.java
Outdated
Show resolved
Hide resolved
servicetalk-grpc-internal/src/main/java/io/servicetalk/grpc/internal/GrpcStatusUtils.java
Outdated
Show resolved
Hide resolved
bryce-anderson
approved these changes
Aug 1, 2024
servicetalk-grpc-internal/src/main/java/io/servicetalk/grpc/internal/GrpcStatusUtils.java
Show resolved
Hide resolved
servicetalk-grpc-internal/src/main/java/io/servicetalk/grpc/internal/GrpcStatusUtils.java
Show resolved
Hide resolved
idelpivnitskiy
approved these changes
Aug 1, 2024
| @@ -249,7 +249,7 @@ private static Collection<Arguments> sslAndCompressionParams() { | |||
|
|
|||
| private static Collection<Arguments> statusMessageParams() { | |||
| final String[] messages = { | |||
| "abc", "Hello, World!", "a\r\nbc", "a%bc", "~ what? ~", | |||
| "abc", "Hello, World!", "a\r\nbc", "a%bc", "~ what? ~", "фяї", "üñö", "非常感謝", | |||
There was a problem hiding this comment.
Home those are good words 🤣
servicetalk-grpc-internal/src/test/java/io/servicetalk/grpc/internal/GrpcStatusUtilsTest.java
Outdated
Show resolved
Hide resolved
servicetalk-grpc-internal/src/test/java/io/servicetalk/grpc/internal/GrpcStatusUtilsTest.java
Outdated
Show resolved
Hide resolved
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.
Motivation
At the moment a grpc status message is not percent-encoded which the spec mandates. This is not a problem as long as regular printable ascii characters are used, but other ranges mandate a percent encoding on the wire.
Modifications
This changeset implements the percent encoding/decoding for the grpc status message and transparently applies it in the places where the ServiceTalk codebase would access the header previously.
The implementation is strongly aligned on the io.grpc equivalent in order to ensure maximum compatibility across systems.
Result
Properly percent-encoded/decoded grpc-message payload when non ascii-printable characters are sent.