Add Status parameter to GrpcExceptionHandlerFunction.apply() method.
#5786
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: When an exception is raised, `GrpcService` creates a new `Status` from `Status.getCause()` via `GrpcExceptionHandlerFunction`. This can result in sending an incorrect status in certain situations: - If the original exception is a `StatusRuntimeException` containing the `Status` that the user wants to send. - The original exception has already been converted into a `Status` via `Status.fromThrowable()`: https://github.com/grpc/grpc-java/blob/5770114d08dcd352f2288ef52d17e1833530323c/stub/src/main/java/io/grpc/stub/ServerCalls.java#L389 - This converted `Status` is ignored and a new, potentially incorrect `Status` is created by `GrpcExceptionHandlerFunction` and sent. Modifications: - Added a `Status` parameter to the `GrpcExceptionHandlerFunction.apply()` method. - Updated the default implementation of `GrpcExceptionHandlerFunction.of()` to return the provided `Status` if it is not an unknown status. Result: - The `GrpcExceptionHandlerFunction` now properly handles and returns the correct `Status`. - (Breaking) The `apply` method of `GrpcExceptionHandlerFunction` now takes a `Status`.
trustin
reviewed
Jun 26, 2024
grpc/src/main/java/com/linecorp/armeria/common/grpc/DefaultGrpcExceptionHandlerFunction.java
Outdated
Show resolved
Hide resolved
grpc/src/main/java/com/linecorp/armeria/common/grpc/GrpcExceptionHandlerFunction.java
Outdated
Show resolved
Hide resolved
trustin
approved these changes
Jun 26, 2024
ikhoon
approved these changes
Jun 27, 2024
| @@ -11,7 +11,7 @@ class GrpcExceptionHandler implements GrpcExceptionHandlerFunction { | |||
|
|
|||
| @Nullable | |||
| @Override | |||
| public Status apply(RequestContext ctx, Throwable cause, Metadata metadata) { | |||
| public Status apply(RequestContext ctx, Status status, Throwable cause, Metadata metadata) { | |||
There was a problem hiding this comment.
Suggested change
| public Status apply(RequestContext ctx, Status status, Throwable cause, Metadata metadata) { | |
| public Status apply(RequestContext ctx, @Nullable Status status, Throwable cause, Metadata metadata) { |
| @@ -40,15 +40,15 @@ public interface GoogleGrpcExceptionHandlerFunction extends GrpcExceptionHandler | |||
|
|
|||
| @Nullable | |||
| @Override | |||
| default Status apply(RequestContext ctx, Throwable throwable, Metadata metadata) { | |||
| default Status apply(RequestContext ctx, Status status, Throwable throwable, Metadata metadata) { | |||
There was a problem hiding this comment.
Suggested change
| default Status apply(RequestContext ctx, Status status, Throwable throwable, Metadata metadata) { | |
| default Status apply(RequestContext ctx, @Nullable Status status, Throwable throwable, Metadata metadata) { |
| @@ -35,9 +35,9 @@ public UnwrappingGrpcExceptionHandleFunction(GrpcExceptionHandlerFunction handle | |||
| } | |||
|
|
|||
| @Override | |||
| public @Nullable Status apply(RequestContext ctx, Throwable cause, Metadata metadata) { | |||
| public @Nullable Status apply(RequestContext ctx, Status status, Throwable cause, Metadata metadata) { | |||
There was a problem hiding this comment.
Suggested change
| public @Nullable Status apply(RequestContext ctx, Status status, Throwable cause, Metadata metadata) { | |
| public @Nullable Status apply(RequestContext ctx, @Nullable Status status, Throwable cause, Metadata metadata) { |
| @@ -145,7 +145,7 @@ private static class FirstGrpcExceptionHandler implements GrpcExceptionHandlerFu | |||
| private static class SecondGrpcExceptionHandler implements GrpcExceptionHandlerFunction { | |||
|
|
|||
| @Override | |||
| public @Nullable Status apply(RequestContext ctx, Throwable cause, Metadata metadata) { | |||
| public @Nullable Status apply(RequestContext ctx, Status status, Throwable cause, Metadata metadata) { | |||
There was a problem hiding this comment.
Suggested change
| public @Nullable Status apply(RequestContext ctx, Status status, Throwable cause, Metadata metadata) { | |
| public @Nullable Status apply(RequestContext ctx, @Nullable Status status, Throwable cause, Metadata metadata) { |
| @@ -133,7 +133,7 @@ void exceptionHandler() { | |||
| private static class FirstGrpcExceptionHandler implements GrpcExceptionHandlerFunction { | |||
|
|
|||
| @Override | |||
| public @Nullable Status apply(RequestContext ctx, Throwable cause, Metadata metadata) { | |||
| public @Nullable Status apply(RequestContext ctx, Status status, Throwable cause, Metadata metadata) { | |||
There was a problem hiding this comment.
Suggested change
| public @Nullable Status apply(RequestContext ctx, Status status, Throwable cause, Metadata metadata) { | |
| public @Nullable Status apply(RequestContext ctx, @Nullable Status status, Throwable cause, Metadata metadata) { |
There was a problem hiding this comment.
All addressed. Thanks! 😉
minwoox
added a commit
that referenced
this pull request
Jun 28, 2024
…od. (#5786) Motivation: When an exception is raised, `GrpcService` creates a new `Status` from `Status.getCause()` via `GrpcExceptionHandlerFunction`. This can result in sending an incorrect status in certain situations: - If the original exception is a `StatusRuntimeException` containing the `Status` that the user wants to send. - The original exception has already been converted into a `Status` via `Status.fromThrowable()`: https://github.com/grpc/grpc-java/blob/5770114d08dcd352f2288ef52d17e1833530323c/stub/src/main/java/io/grpc/stub/ServerCalls.java#L389 - This converted `Status` is ignored and a new, potentially incorrect `Status` is created by `GrpcExceptionHandlerFunction` and sent. Modifications: - Added a `Status` parameter to the `GrpcExceptionHandlerFunction.apply()` method. - Updated the default implementation of `GrpcExceptionHandlerFunction.of()` to return the provided `Status` if it is not an unknown status. Result: - The `GrpcExceptionHandlerFunction` now properly handles and returns the correct `Status`. - (Breaking) The `apply` method of `GrpcExceptionHandlerFunction` now takes a `Status`.
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 an exception is raised,
GrpcServicecreates a newStatusfromStatus.getCause()viaGrpcExceptionHandlerFunction. This can result in sending an incorrect status in certain situations:StatusRuntimeExceptioncontaining theStatusthat the user wants to send.StatusviaStatus.fromThrowable(): https://github.com/grpc/grpc-java/blob/5770114d08dcd352f2288ef52d17e1833530323c/stub/src/main/java/io/grpc/stub/ServerCalls.java#L389Statusis ignored and a new, potentially incorrectStatusis created byGrpcExceptionHandlerFunctionand sent.Modifications:
Statusparameter to theGrpcExceptionHandlerFunction.apply()method.GrpcExceptionHandlerFunction.of()to return the providedStatusif it is not an unknown status.Result:
GrpcExceptionHandlerFunctionnow properly handles and returns the correctStatus.applymethod ofGrpcExceptionHandlerFunctionnow takes aStatus.