-
Notifications
You must be signed in to change notification settings - Fork 925
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Prevent Execution of Delayed Tasks for Cancelled gRPC Requests (#6066)
Motivation: When blockingTaskExecutor is used in a gRPC service, tasks handling gRPC requests are queued if the executor is busy with heavy blocking jobs. https://github.com/line/armeria/blob/0960d091bfc7f350c17e68f57cc627de584b9705/grpc/src/main/java/com/linecorp/armeria/internal/server/grpc/AbstractServerCall.java#L363 If these tasks are delayed for too long, the corresponding gRPC requests may time out and get cancelled. Despite the cancellation, the queued tasks are still executed once the executor becomes available, leading to unnecessary processing. https://github.com/line/armeria/blob/0960d091bfc7f350c17e68f57cc627de584b9705/grpc/src/main/java/com/linecorp/armeria/internal/server/grpc/AbstractServerCall.java#L394-L404 Modifications: - Updated `AbstractServerCall.invokeOnMessage()` to check if the request is cancelled before calling `listener.onMessage`. Result: - Prevents execution of delayed tasks for gRPC requests that have already been cancelled. Co-authored-by: szymon.habrainski <[email protected]>
- Loading branch information
Showing
4 changed files
with
173 additions
and
7 deletions.
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
155 changes: 155 additions & 0 deletions
155
grpc/src/test/java/com/linecorp/armeria/internal/server/grpc/AbstractServerCallTest.java
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 |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| /* | ||
| * Copyright 2025 LINE Corporation | ||
| * | ||
| * LINE Corporation licenses this file to you under the Apache License, | ||
| * version 2.0 (the "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at: | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package com.linecorp.armeria.internal.server.grpc; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
| import static org.awaitility.Awaitility.await; | ||
|
|
||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.concurrent.atomic.AtomicBoolean; | ||
| import java.util.concurrent.atomic.AtomicReference; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.RegisterExtension; | ||
| import org.reactivestreams.Subscriber; | ||
| import org.reactivestreams.Subscription; | ||
|
|
||
| import com.linecorp.armeria.client.grpc.GrpcClients; | ||
| import com.linecorp.armeria.common.FilteredHttpRequest; | ||
| import com.linecorp.armeria.common.HttpObject; | ||
| import com.linecorp.armeria.server.ServerBuilder; | ||
| import com.linecorp.armeria.server.grpc.GrpcService; | ||
| import com.linecorp.armeria.testing.junit5.server.ServerExtension; | ||
|
|
||
| import io.grpc.Metadata; | ||
| import io.grpc.ServerCall; | ||
| import io.grpc.ServerCall.Listener; | ||
| import io.grpc.ServerCallHandler; | ||
| import io.grpc.ServerInterceptor; | ||
| import io.grpc.ServerInterceptors; | ||
| import io.grpc.StatusRuntimeException; | ||
| import io.grpc.stub.StreamObserver; | ||
| import testing.grpc.Messages.StreamingInputCallRequest; | ||
| import testing.grpc.Messages.StreamingInputCallResponse; | ||
| import testing.grpc.TestServiceGrpc; | ||
| import testing.grpc.TestServiceGrpc.TestServiceStub; | ||
|
|
||
| class AbstractServerCallTest { | ||
|
|
||
| @RegisterExtension | ||
| static final ServerExtension server = new ServerExtension() { | ||
| @Override | ||
| protected void configure(ServerBuilder sb) throws Exception { | ||
| final AtomicReference<ServerCall<?, ?>> serverCallCaptor = new AtomicReference<>(); | ||
| final GrpcService grpcService = | ||
| GrpcService.builder() | ||
| .useBlockingTaskExecutor(true) | ||
| .useClientTimeoutHeader(false) | ||
| .addService(ServerInterceptors.intercept( | ||
| new FooTestServiceImpl(), | ||
| new ServerInterceptor() { | ||
|
|
||
| @Override | ||
| public <T, U> Listener<T> interceptCall( | ||
| ServerCall<T, U> call, Metadata headers, | ||
| ServerCallHandler<T, U> next) { | ||
| serverCallCaptor.set(call); | ||
| return next.startCall(call, headers); | ||
| } | ||
| })) | ||
| .build(); | ||
| sb.service(grpcService); | ||
| sb.decorator((delegate, ctx, req) -> { | ||
| final FilteredHttpRequest newReq = new FilteredHttpRequest(req) { | ||
| @Override | ||
| protected void beforeSubscribe(Subscriber<? super HttpObject> subscriber, | ||
| Subscription subscription) { | ||
| // This is called right before | ||
| // blockingExecutor.execute(() -> invokeOnMessage(request, endOfStream)); | ||
| // in AbstractServerCall. | ||
| // https://github.com/line/armeria/blob/0960d091bfc7f350c17e68f57cc627de584b9705/grpc/src/main/java/com/linecorp/armeria/internal/server/grpc/AbstractServerCall.java#L363 | ||
| final ServerCall<?, ?> serverCall = serverCallCaptor.get(); | ||
| assertThat(serverCall).isInstanceOf(AbstractServerCall.class); | ||
| ((AbstractServerCall<?, ?>) serverCall).blockingExecutor.execute(() -> { | ||
| // invokeOnMessage is not called until the request is cancelled. | ||
| await().until(serverCall::isCancelled); | ||
| // Now, AbstractServerCall.invokeOnMessage() is called and it doesn't call | ||
| // listener.onMessage() because the request is cancelled. | ||
| }); | ||
| } | ||
|
|
||
| @Override | ||
| protected HttpObject filter(HttpObject obj) { | ||
| return obj; | ||
| } | ||
| }; | ||
| ctx.updateRequest(newReq); | ||
| return delegate.serve(ctx, newReq); | ||
| }); | ||
| sb.requestTimeoutMillis(100); | ||
| } | ||
| }; | ||
|
|
||
| private static final AtomicBoolean isOnNextCalled = new AtomicBoolean(); | ||
|
|
||
| @Test | ||
| void onMessageIsNotCalledWhenRequestCancelled() throws InterruptedException { | ||
| final TestServiceStub testServiceStub = GrpcClients.newClient(server.httpUri(), TestServiceStub.class); | ||
| final CompletableFuture<Throwable> future = new CompletableFuture<>(); | ||
| final StreamObserver<StreamingInputCallRequest> streamingInputCallRequestStreamObserver = | ||
| testServiceStub.streamingInputCall(new StreamObserver<StreamingInputCallResponse>() { | ||
| @Override | ||
| public void onNext(StreamingInputCallResponse value) {} | ||
|
|
||
| @Override | ||
| public void onError(Throwable t) { | ||
| future.completeExceptionally(t); | ||
| } | ||
|
|
||
| @Override | ||
| public void onCompleted() { | ||
| } | ||
| }); | ||
| streamingInputCallRequestStreamObserver.onNext(StreamingInputCallRequest.newBuilder().build()); | ||
| assertThatThrownBy(future::get).hasCauseInstanceOf(StatusRuntimeException.class) | ||
| .hasMessageContaining("CANCELLED"); | ||
| // Sleep additional 1 second to make sure that the onNext() is not called. | ||
| Thread.sleep(1000); | ||
| assertThat(isOnNextCalled).isFalse(); | ||
| } | ||
|
|
||
| private static class FooTestServiceImpl extends TestServiceGrpc.TestServiceImplBase { | ||
|
|
||
| @Override | ||
| public StreamObserver<StreamingInputCallRequest> streamingInputCall( | ||
| StreamObserver<StreamingInputCallResponse> responseObserver) { | ||
| return new StreamObserver<StreamingInputCallRequest>() { | ||
| @Override | ||
| public void onNext(StreamingInputCallRequest value) { | ||
| // If this method is called that means listener.onMessage() in AbstractServerCall is called. | ||
| isOnNextCalled.set(true); | ||
| } | ||
|
|
||
| @Override | ||
| public void onError(Throwable t) {} | ||
|
|
||
| @Override | ||
| public void onCompleted() {} | ||
| }; | ||
| } | ||
| } | ||
| } |
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