Pass safe and idempotent options to the MethodDescriptor
#1774
+7
−0
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
thesamet
reviewed
Nov 29, 2024
| @@ -179,12 +180,18 @@ final class GrpcServicePrinter(service: ServiceDescriptor, implicits: Descriptor | |||
|
|
|||
| val grpcMethodDescriptor = "_root_.io.grpc.MethodDescriptor" | |||
|
|
|||
| val idempotencyLevel = method.getOptions.getIdempotencyLevel | |||
| val safe = idempotencyLevel == IdempotencyLevel.NO_SIDE_EFFECTS | |||
| val idempotent = idempotencyLevel == IdempotencyLevel.IDEMPOTENT | |||
There was a problem hiding this comment.
No side effects implies idempotent. Should there be a logical or here? https://protobuf.dev/reference/java/api-docs/com/google/protobuf/DescriptorProtos.MethodOptions.IdempotencyLevel.html#NO_SIDE_EFFECTS_VALUE
thesamet
reviewed
Nov 29, 2024
| p.add( | ||
| s"""${method.deprecatedAnnotation}val ${method.grpcDescriptor.nameSymbol}: $grpcMethodDescriptor[${method.inputType.scalaType}, ${method.outputType.scalaType}] = | ||
| | $grpcMethodDescriptor.newBuilder() | ||
| | .setType($grpcMethodDescriptor.MethodType.$methodType) | ||
| | .setFullMethodName($grpcMethodDescriptor.generateFullMethodName("${service.getFullName}", "${method.getName}")) | ||
| | .setSampledToLocalTracing(true) | ||
| | .setSafe($safe) |
There was a problem hiding this comment.
Can we setSafe and setIdempotent only when method.getOptions.hasIdempotencyLevel ? You cal use p.when to emit code conditionally.
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.
Hi! I'm working on the library that provides ConnectRPC-compatible REST interface from ScalaPB service interfaces https://github.com/igor-vovk/connect-rpc-scala.
One of the nice features of the Connect protocol is being able to expose endpoints so they are reachable with GET-requests instead of POST (https://connectrpc.com/docs/protocol/#unary-get-request). It is controlled by the
idempotency_leveloption. This PR adds passing this option to the MethodDefinition, so that https://github.com/igor-vovk/connect-rpc-scala/pull/14/files#diff-c75d247c647e264575f9907d360db7a0769a44833b041a1a540b2eb7592ca656R71 would be possible.Sadly I did not find any tests for similar functionality, so I wonder if I should add anything.