[grpc-protoc] Add an option to generate default service methods #3110
+132
−4
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
idelpivnitskiy
requested changes
Nov 18, 2024
...ns/src/main/java/io/servicetalk/examples/grpc/protocoptions/BlockingProtocOptionsServer.java
Show resolved
Hide resolved
|
|
||
| package grpc.netty; | ||
|
|
||
| service Tester { |
There was a problem hiding this comment.
Reminder to remove this file before merging PR
servicetalk-grpc-protoc/src/main/java/io/servicetalk/grpc/protoc/Main.java
Show resolved
Hide resolved
| printJavaDocs, (__, c) -> { | ||
| c.addModifiers(DEFAULT) | ||
| .addParameter(GrpcServiceContext, ctx) | ||
| .addStatement("throw new UnsupportedOperationException(\"Method " + methodName + |
There was a problem hiding this comment.
- gRPC services should use
GrpcStatusExceptionwithUNIMPLEMENTEDstatus, similar to official grpc-java to be compatible. Consider adding a test inProtocolCompatibilityTestto make sure our default behavior is the same as grpc-java default behavior. In grpc-netty tests we can always use this new option, no need to create a new test module. - Async RPC that return
SingleorPublishercan not throw, they should return a failed async source, likeSingle.failed(...)orPublisher.failed(...). - grpc-java uses
fullMethodName()from method descriptor for exception message.
There was a problem hiding this comment.
Sounds good. I hammered this together to gather feedback on the option. I'll clean things up.
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
When evolving a service definition that has multiple implementations it is ideal not to break these implementations. Therefore it would be nice if the protoc generator was able to generate default implementations on the service interface to ensure implementations always conform.
Changes
Add an option,
defaultServiceMethodsto the grpc-protoc stub compiler to generate these default implementation. The result is that service interfaces will provide a default, throwing, implementation of all service RPC interfaces that they implement.test_service.proto: https://gist.github.com/mgodave/d9064c67da9f365de70ef7526c9eea72