Add Status parameter to GrpcExceptionHandlerFunction.apply() method.
#5786
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -48,12 +48,13 @@ static GrpcExceptionHandlerFunction of() { | |
| } | ||
|
|
||
| /** | ||
| * Maps the specified {@link Throwable} to a gRPC {@link Status} and mutates the specified {@link Metadata}. | ||
| * The {@link Status} that was created via {@link Status#fromThrowable(Throwable)} might be specified | ||
| * as well. You can return this {@link Status} or any other {@link Status} as needed. | ||
| * If {@code null} is returned, {@link #of()} will be used as the default. | ||
trustin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| */ | ||
| @Nullable | ||
| Status apply(RequestContext ctx, @Nullable Status status, Throwable cause, Metadata metadata); | ||
|
|
||
| /** | ||
| * Returns a {@link GrpcExceptionHandlerFunction} that returns the result of this function | ||
|
|
@@ -63,12 +64,12 @@ static GrpcExceptionHandlerFunction of() { | |
| */ | ||
| default GrpcExceptionHandlerFunction orElse(GrpcExceptionHandlerFunction next) { | ||
| requireNonNull(next, "next"); | ||
| return (ctx, status, cause, metadata) -> { | ||
| final Status newStatus = apply(ctx, status, cause, metadata); | ||
| if (newStatus != null) { | ||
| return newStatus; | ||
| } | ||
| return next.apply(ctx, status, cause, metadata); | ||
| }; | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -54,7 +54,7 @@ public final class GrpcExceptionHandlerFunctionBuilder { | |
| */ | ||
| public GrpcExceptionHandlerFunctionBuilder on(Class<? extends Throwable> exceptionType, Status status) { | ||
| requireNonNull(status, "status"); | ||
| return on(exceptionType, (ctx, unused, cause, metadata) -> status); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -66,7 +66,7 @@ public <T extends Throwable> GrpcExceptionHandlerFunctionBuilder on( | |
| requireNonNull(exceptionType, "exceptionType"); | ||
| requireNonNull(exceptionHandler, "exceptionHandler"); | ||
| //noinspection unchecked | ||
| return on(exceptionType, (ctx, status, cause, metadata) -> exceptionHandler.apply((T) cause, metadata)); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -107,11 +107,11 @@ public GrpcExceptionHandlerFunction build() { | |
|
|
||
| final List<Entry<Class<? extends Throwable>, GrpcExceptionHandlerFunction>> mappings = | ||
| ImmutableList.copyOf(exceptionMappings); | ||
| return (ctx, status, cause, metadata) -> { | ||
| for (Map.Entry<Class<? extends Throwable>, GrpcExceptionHandlerFunction> mapping : mappings) { | ||
| if (mapping.getKey().isInstance(cause)) { | ||
| final Status newStatus = mapping.getValue().apply(ctx, status, cause, metadata); | ||
| return newStatus == null ? null : newStatus.withCause(cause); | ||
| } | ||
| } | ||
| return null; | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -248,7 +248,7 @@ public void start(Listener<O> responseListener, Metadata metadata) { | |
| prepareHeaders(compressor, metadata, remainingNanos); | ||
|
|
||
| final BiFunction<ClientRequestContext, Throwable, HttpResponse> errorResponseFactory = | ||
| (unused, cause) -> HttpResponse.ofFailure(exceptionHandler.apply(ctx, null, cause, metadata) | ||
| .withDescription(cause.getMessage()) | ||
| .asRuntimeException()); | ||
| final HttpResponse res = initContextAndExecuteWithFallback( | ||
|
|
@@ -454,7 +454,7 @@ public void onNext(DeframedMessage message) { | |
| }); | ||
| } catch (Throwable t) { | ||
| final Metadata metadata = new Metadata(); | ||
| close(exceptionHandler.apply(ctx, null, t, metadata), metadata); | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -511,7 +511,7 @@ private void prepareHeaders(Compressor compressor, Metadata metadata, long remai | |
|
|
||
| private void closeWhenListenerThrows(Throwable t) { | ||
| final Metadata metadata = new Metadata(); | ||
| closeWhenEos(exceptionHandler.apply(ctx, null, t, metadata), metadata); | ||
| } | ||
|
|
||
| private void closeWhenEos(Status status, Metadata metadata) { | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -120,7 +120,7 @@ public void processHeaders(HttpHeaders headers, StreamDecoderOutput<DeframedMess | |
| decompressor(ForwardingDecompressor.forGrpc(decompressor)); | ||
| } catch (Throwable t) { | ||
| final Metadata metadata = new Metadata(); | ||
| transportStatusListener.transportReportStatus(exceptionHandler.apply(ctx, null, t, metadata), | ||
| metadata); | ||
| return; | ||
| } | ||
|
|
@@ -148,7 +148,8 @@ public void processTrailers(HttpHeaders headers, StreamDecoderOutput<DeframedMes | |
| @Override | ||
| public void processOnError(Throwable cause) { | ||
| final Metadata metadata = new Metadata(); | ||
| transportStatusListener.transportReportStatus( | ||
| exceptionHandler.apply(ctx, null, cause, metadata), metadata); | ||
| } | ||
|
|
||
| @Override | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -35,9 +35,9 @@ public UnwrappingGrpcExceptionHandleFunction(GrpcExceptionHandlerFunction handle | |||||
| } | ||||||
|
|
||||||
| @Override | ||||||
| public @Nullable Status apply(RequestContext ctx, Status status, Throwable cause, Metadata metadata) { | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| final Throwable t = peelAndUnwrap(cause); | ||||||
| return delegate.apply(ctx, status, t, metadata); | ||||||
| } | ||||||
|
|
||||||
| private static Throwable peelAndUnwrap(Throwable t) { | ||||||
|
|
||||||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -213,7 +213,7 @@ public final void close(Throwable exception) { | |
| public final void close(Throwable exception, boolean cancelled) { | ||
| exception = Exceptions.peel(exception); | ||
| final Metadata metadata = generateMetadataFromThrowable(exception); | ||
| final Status status = exceptionHandler.apply(ctx, null, exception, metadata); | ||
| close(new ServerStatusAndMetadata(status, metadata, false, cancelled), exception); | ||
| } | ||
|
|
||
|
|
@@ -223,7 +223,7 @@ public final void close(Status status, Metadata metadata) { | |
| close(new ServerStatusAndMetadata(status, metadata, false)); | ||
| return; | ||
| } | ||
| Status newStatus = exceptionHandler.apply(ctx, status, status.getCause(), metadata); | ||
| assert newStatus != null; | ||
| if (status.getDescription() != null) { | ||
| newStatus = newStatus.withDescription(status.getDescription()); | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -239,7 +239,7 @@ protected HttpResponse doPost(ServiceRequestContext ctx, HttpRequest req) throws | |
| return HttpResponse.of( | ||
| (ResponseHeaders) AbstractServerCall.statusToTrailers( | ||
| ctx, defaultHeaders.get(serializationFormat).toBuilder(), | ||
| exceptionHandler.apply(ctx, null, e, metadata), metadata)); | ||
| } | ||
| } else { | ||
| if (Boolean.TRUE.equals(ctx.attr(AbstractUnframedGrpcService.IS_UNFRAMED_GRPC))) { | ||
|
|
@@ -320,7 +320,7 @@ private <I, O> void startCall(ServerMethodDefinition<I, O> methodDef, ServiceReq | |
| call.setListener(listener); | ||
| call.startDeframing(); | ||
| ctx.whenRequestCancelling().handle((cancellationCause, unused) -> { | ||
| final Status status = call.exceptionHandler().apply(ctx, null, cancellationCause, headers); | ||
| assert status != null; | ||
| call.close(new ServerStatusAndMetadata(status, new Metadata(), true, true)); | ||
| return null; | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -878,7 +878,8 @@ public GrpcServiceBuilder exceptionHandler(GrpcExceptionHandlerFunction exceptio | |
| @Deprecated | ||
| public GrpcServiceBuilder exceptionMapping(GrpcStatusFunction statusFunction) { | ||
| requireNonNull(statusFunction, "statusFunction"); | ||
| return exceptionHandler( | ||
| (ctx, status, throwable, metadata) -> statusFunction.apply(ctx, throwable, metadata)); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -943,7 +944,9 @@ public GrpcServiceBuilder addExceptionMapping(Class<? extends Throwable> excepti | |
| checkState(exceptionHandler == null, | ||
| "addExceptionMapping() and exceptionMapping() are mutually exclusive."); | ||
|
|
||
| exceptionMappingsBuilder().on(exceptionType, | ||
| (ctx, status, throwable, metadata) -> | ||
| statusFunction.apply(ctx, throwable, metadata)); | ||
| return this; | ||
| } | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -290,7 +290,7 @@ public O parse(InputStream inputStream) { | |
|
|
||
| @Test | ||
| void useDefaultGrpcExceptionHandlerFunctionAsFallback() { | ||
| final GrpcExceptionHandlerFunction noopExceptionHandler = (ctx, status, cause, metadata) -> null; | ||
| final GrpcExceptionHandlerFunction exceptionHandler = | ||
| GrpcExceptionHandlerFunction.builder() | ||
| .on(ContentTooLargeException.class, noopExceptionHandler) | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -85,15 +85,15 @@ void chaining() { | |
| final RuntimeException exception = new RuntimeException(); | ||
| final TestServiceBlockingStub stub = | ||
| GrpcClients.builder(server.httpUri()) | ||
| .exceptionHandler(((ctx, status, cause, metadata) -> { | ||
| stringDeque.add("1"); | ||
| return null; | ||
| })) | ||
| .exceptionHandler(((ctx, status, cause, metadata) -> { | ||
| stringDeque.add("2"); | ||
| return null; | ||
| })) | ||
| .exceptionHandler(((ctx, status, cause, metadata) -> { | ||
| if (cause == exception) { | ||
| stringDeque.add("3"); | ||
| return Status.DATA_LOSS; | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -747,7 +747,7 @@ void cancelAfterBegin() throws Exception { | |
| responseObserver.awaitCompletion(); | ||
| assertThat(responseObserver.getValues()).isEmpty(); | ||
| assertThat(GrpcExceptionHandlerFunction.of() | ||
| .apply(null, null, responseObserver.getError(), null) | ||
| .getCode()).isEqualTo(Code.CANCELLED); | ||
|
|
||
| final RequestLog log = requestLogQueue.take(); | ||
|
|
@@ -783,7 +783,7 @@ void cancelAfterFirstResponse() throws Exception { | |
| responseObserver.awaitCompletion(operationTimeoutMillis(), TimeUnit.MILLISECONDS); | ||
| assertThat(responseObserver.getValues()).hasSize(1); | ||
| assertThat(GrpcExceptionHandlerFunction.of() | ||
| .apply(null, null, responseObserver.getError(), null) | ||
| .getCode()).isEqualTo(Code.CANCELLED); | ||
|
|
||
| checkRequestLog((rpcReq, rpcRes, grpcStatus) -> { | ||
|
|
@@ -1418,7 +1418,7 @@ void deadlineExceededServerStreaming() throws Exception { | |
|
|
||
| assertThat(recorder.getError()).isNotNull(); | ||
| assertThat(GrpcExceptionHandlerFunction.of() | ||
| .apply(null, null, recorder.getError(), null) | ||
| .getCode()) | ||
| .isEqualTo(Status.DEADLINE_EXCEEDED.getCode()); | ||
|
|
||
|
|
@@ -1618,10 +1618,10 @@ void statusCodeAndMessage() throws Exception { | |
| verify(responseObserver, | ||
| timeout(operationTimeoutMillis())).onError(captor.capture()); | ||
| assertThat(GrpcExceptionHandlerFunction.of() | ||
| .apply(null, null, captor.getValue(), null) | ||
| .getCode()).isEqualTo(Status.UNKNOWN.getCode()); | ||
| assertThat(GrpcExceptionHandlerFunction.of() | ||
| .apply(null, null, captor.getValue(), null) | ||
| .getDescription()).isEqualTo(errorMessage); | ||
| verifyNoMoreInteractions(responseObserver); | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,15 +33,16 @@ class DefaultGrpcExceptionHandlerFunctionTest { | |
| void failFastExceptionToUnavailableCode() { | ||
| assertThat(GrpcExceptionHandlerFunction | ||
| .of() | ||
| .apply(null, null, new FailFastException(CircuitBreaker.ofDefaultName()), null) | ||
| .getCode()).isEqualTo(Status.Code.UNAVAILABLE); | ||
| } | ||
|
|
||
| @Test | ||
| void invalidProtocolBufferExceptionToInvalidArgumentCode() { | ||
| assertThat(GrpcExceptionHandlerFunction | ||
| .of() | ||
| .apply(null, null, | ||
| new InvalidProtocolBufferException("Failed to parse message"), null) | ||
| .getCode()).isEqualTo(Status.Code.INVALID_ARGUMENT); | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.