Skip to content

Fixed the issue where the SDK did not offload future completion #3034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
import java.util.concurrent.Executor;
import java.util.concurrent.ScheduledExecutorService;
import java.util.function.Supplier;
import org.reactivestreams.Publisher;
import org.reactivestreams.Subscriber;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.core.Response;
Expand All @@ -48,7 +47,6 @@
import software.amazon.awssdk.core.metrics.CoreMetric;
import software.amazon.awssdk.http.SdkHttpFullRequest;
import software.amazon.awssdk.http.SdkHttpMethod;
import software.amazon.awssdk.http.SdkHttpResponse;
import software.amazon.awssdk.http.async.AsyncExecuteRequest;
import software.amazon.awssdk.http.async.SdkAsyncHttpClient;
import software.amazon.awssdk.http.async.SdkHttpContentPublisher;
Expand Down Expand Up @@ -119,59 +117,12 @@ public CompletableFuture<Response<OutputT>> execute(CompletableFuture<SdkHttpFul
return toReturn;
}

private static final class WrappedErrorForwardingResponseHandler<T>
implements TransformingAsyncResponseHandler<T> {

private final TransformingAsyncResponseHandler<T> wrappedHandler;
private final CompletableFuture<T> responseFuture;

private WrappedErrorForwardingResponseHandler(TransformingAsyncResponseHandler<T> wrappedHandler,
CompletableFuture<T> responseFuture) {
this.wrappedHandler = wrappedHandler;
this.responseFuture = responseFuture;

}

private static <T> WrappedErrorForwardingResponseHandler<T> of(
TransformingAsyncResponseHandler<T> wrappedHandler,
CompletableFuture<T> responseFuture) {

return new WrappedErrorForwardingResponseHandler<>(wrappedHandler, responseFuture);
}

@Override
public CompletableFuture<T> prepare() {
return wrappedHandler.prepare();
}

@Override
public void onHeaders(SdkHttpResponse headers) {
wrappedHandler.onHeaders(headers);
}

@Override
public void onStream(Publisher<ByteBuffer> stream) {
wrappedHandler.onStream(stream);
}

@Override
public void onError(Throwable error) {
responseFuture.completeExceptionally(error);
wrappedHandler.onError(error);
}
}

private CompletableFuture<Response<OutputT>> executeHttpRequest(SdkHttpFullRequest request,
RequestExecutionContext context) {

CompletableFuture<Response<OutputT>> responseFuture = new CompletableFuture<>();

// Wrap the response handler in a layer that will notify the newly created responseFuture when the onError event
// is triggered
TransformingAsyncResponseHandler<Response<OutputT>> wrappedResponseHandler =
WrappedErrorForwardingResponseHandler.of(responseHandler, responseFuture);

CompletableFuture<Response<OutputT>> responseHandlerFuture = wrappedResponseHandler.prepare();
CompletableFuture<Response<OutputT>> responseHandlerFuture = responseHandler.prepare();

SdkHttpContentPublisher requestProvider = context.requestProvider() == null
? new SimpleHttpContentPublisher(request)
Expand All @@ -184,7 +135,7 @@ private CompletableFuture<Response<OutputT>> executeHttpRequest(SdkHttpFullReque
AsyncExecuteRequest.Builder executeRequestBuilder = AsyncExecuteRequest.builder()
.request(requestWithContentLength)
.requestContentPublisher(requestProvider)
.responseHandler(wrappedResponseHandler)
.responseHandler(responseHandler)
.fullDuplex(isFullDuplex(context.executionAttributes()))
.metricCollector(httpMetricCollector);
if (context.executionAttributes().getAttribute(SDK_HTTP_EXECUTION_ATTRIBUTES) != null) {
Expand Down Expand Up @@ -223,7 +174,6 @@ private CompletableFuture<Void> doExecuteHttpRequest(RequestExecutionContext con
long callStart = System.nanoTime();
CompletableFuture<Void> httpClientFuture = sdkAsyncHttpClient.execute(executeRequest);

// Offload the metrics reporting from this stage onto the future completion executor
CompletableFuture<Void> result = httpClientFuture.whenComplete((r, t) -> {
long duration = System.nanoTime() - callStart;
metricCollector.reportMetric(CoreMetric.SERVICE_CALL_DURATION, Duration.ofNanos(duration));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,12 @@
import static com.github.tomakehurst.wiremock.client.WireMock.stubFor;
import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo;
import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
import static org.assertj.core.api.AssertionsForClassTypes.assertThatThrownBy;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.atLeast;
import static org.mockito.Mockito.verify;
import static software.amazon.awssdk.core.client.config.SdkAdvancedAsyncClientOption.FUTURE_COMPLETION_EXECUTOR;

import com.github.tomakehurst.wiremock.http.Fault;
import com.github.tomakehurst.wiremock.junit.WireMockRule;
import java.net.URI;
import java.util.concurrent.Executor;
Expand All @@ -34,8 +35,11 @@
import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
import software.amazon.awssdk.core.ResponseBytes;
import software.amazon.awssdk.core.async.AsyncResponseTransformer;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.core.retry.RetryPolicy;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.protocolrestjson.ProtocolRestJsonAsyncClient;
import software.amazon.awssdk.services.protocolrestjson.model.ProtocolRestJsonException;
import software.amazon.awssdk.services.protocolrestjson.model.StreamingOutputOperationRequest;
import software.amazon.awssdk.services.protocolrestjson.model.StreamingOutputOperationResponse;

Expand Down Expand Up @@ -63,13 +67,56 @@ public void completionWithNioThreadWorksCorrectly() {
client.streamingOutputOperation(StreamingOutputOperationRequest.builder().build(),
AsyncResponseTransformer.toBytes()).join();

// #1 reporting metrics, #2 completing response
verify(mockExecutor, atLeast(1)).execute(any());
verify(mockExecutor).execute(any());

byte[] arrayCopy = response.asByteArray();
assertThat(arrayCopy).containsExactly('t', 'e', 's', 't');
}

@Test
public void connectionError_completionWithNioThreadWorksCorrectly() {
stubFor(post(urlPathEqualTo(STREAMING_OUTPUT_PATH)).willReturn(aResponse().withFault(Fault.CONNECTION_RESET_BY_PEER).withBody("test")));

Executor mockExecutor = Mockito.spy(new SpyableExecutor());

ProtocolRestJsonAsyncClient client =
ProtocolRestJsonAsyncClient.builder()
.region(Region.US_WEST_1)
.endpointOverride(URI.create("http://localhost:" + wireMock.port()))
.credentialsProvider(() -> AwsBasicCredentials.create("akid", "skid"))
.asyncConfiguration(c -> c.advancedOption(FUTURE_COMPLETION_EXECUTOR, mockExecutor))
.overrideConfiguration(o -> o.retryPolicy(RetryPolicy.none()))
.build();

assertThatThrownBy(() ->
client.streamingOutputOperation(StreamingOutputOperationRequest.builder().build(),
AsyncResponseTransformer.toBytes()).join())
.hasCauseInstanceOf(SdkClientException.class);

verify(mockExecutor).execute(any());
}

@Test
public void serverError_completionWithNioThreadWorksCorrectly() {
stubFor(post(urlPathEqualTo(STREAMING_OUTPUT_PATH)).willReturn(aResponse().withStatus(500).withBody("test")));

Executor mockExecutor = Mockito.spy(new SpyableExecutor());

ProtocolRestJsonAsyncClient client =
ProtocolRestJsonAsyncClient.builder()
.region(Region.US_WEST_1)
.endpointOverride(URI.create("http://localhost:" + wireMock.port()))
.credentialsProvider(() -> AwsBasicCredentials.create("akid", "skid"))
.overrideConfiguration(o -> o.retryPolicy(RetryPolicy.none()))
.asyncConfiguration(c -> c.advancedOption(FUTURE_COMPLETION_EXECUTOR, mockExecutor))
.build();

assertThatThrownBy(() ->
client.streamingOutputOperation(StreamingOutputOperationRequest.builder().build(),
AsyncResponseTransformer.toBytes()).join()).hasCauseInstanceOf(ProtocolRestJsonException.class);
verify(mockExecutor).execute(any());
}

private static class SpyableExecutor implements Executor {
@Override
public void execute(Runnable command) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public class AsyncAwsJsonRetryTest {
public void setupClient() {
client = ProtocolJsonRpcAsyncClient.builder()
.credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create
("akid", "skid")))
("akid", "skid")))
.region(Region.US_EAST_1)
.endpointOverride(URI.create("http://localhost:" + wireMock.port()))
.build();
Expand Down Expand Up @@ -155,4 +155,4 @@ public void retryPolicyNone_shouldNotRetry() {
assertThatThrownBy(() -> clientWithNoRetry.allTypes(AllTypesRequest.builder().build()).join())
.hasCauseInstanceOf(ProtocolJsonRpcException.class);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@

# Set up logging implementation
org.eclipse.jetty.util.log.class=org.eclipse.jetty.util.log.StdErrLog
org.eclipse.jetty.LEVEL=INFO
org.eclipse.jetty.LEVEL=OFF