Do not validate content-length for 304 and HEAD responses.

Author: millems

http-clients/netty-nio-client/src/main/java/software/amazon/awssdk/http/nio/netty/internal/ChannelAttributeKey.java

@@ -91,6 +91,9 @@ public final class ChannelAttributeKey {
     static final AttributeKey<Boolean> RESPONSE_COMPLETE_KEY = NettyUtils.getOrCreateAttributeKey(
         "aws.http.nio.netty.async.responseComplete");
 
+    static final AttributeKey<Integer> RESPONSE_STATUS_CODE = NettyUtils.getOrCreateAttributeKey(
+        "aws.http.nio.netty.async.responseStatusCode");
+
     static final AttributeKey<Long> RESPONSE_CONTENT_LENGTH = NettyUtils.getOrCreateAttributeKey(
         "aws.http.nio.netty.async.responseContentLength");
 

http-clients/netty-nio-client/src/main/java/software/amazon/awssdk/http/nio/netty/internal/ResponseHandler.java

@@ -24,6 +24,7 @@
 import static software.amazon.awssdk.http.nio.netty.internal.ChannelAttributeKey.RESPONSE_COMPLETE_KEY;
 import static software.amazon.awssdk.http.nio.netty.internal.ChannelAttributeKey.RESPONSE_CONTENT_LENGTH;
 import static software.amazon.awssdk.http.nio.netty.internal.ChannelAttributeKey.RESPONSE_DATA_READ;
+import static software.amazon.awssdk.http.nio.netty.internal.ChannelAttributeKey.RESPONSE_STATUS_CODE;
 import static software.amazon.awssdk.http.nio.netty.internal.utils.ExceptionHandlingUtils.tryCatch;
 import static software.amazon.awssdk.http.nio.netty.internal.utils.ExceptionHandlingUtils.tryCatchFinally;
 
@@ -38,6 +39,7 @@
 import io.netty.handler.codec.http.HttpHeaders;
 import io.netty.handler.codec.http.HttpObject;
 import io.netty.handler.codec.http.HttpResponse;
+import io.netty.handler.codec.http.HttpResponseStatus;
 import io.netty.handler.codec.http.HttpUtil;
 import io.netty.util.ReferenceCountUtil;
 import java.io.IOException;
@@ -56,6 +58,7 @@
 import software.amazon.awssdk.http.Protocol;
 import software.amazon.awssdk.http.SdkCancellationException;
 import software.amazon.awssdk.http.SdkHttpFullResponse;
+import software.amazon.awssdk.http.SdkHttpMethod;
 import software.amazon.awssdk.http.SdkHttpResponse;
 import software.amazon.awssdk.http.async.SdkAsyncHttpResponseHandler;
 import software.amazon.awssdk.http.nio.netty.internal.http2.Http2ResetSendingSubscription;
@@ -88,6 +91,7 @@ protected void channelRead0(ChannelHandlerContext channelContext, HttpObject msg
                                                              .statusCode(response.status().code())
                                                              .statusText(response.status().reasonPhrase())
                                                              .build();
+            channelContext.channel().attr(RESPONSE_STATUS_CODE).set(response.status().code());
             channelContext.channel().attr(RESPONSE_CONTENT_LENGTH).set(responseContentLength(response));
             channelContext.channel().attr(KEEP_ALIVE).set(shouldKeepAlive(response));
             requestContext.handler().onHeaders(sdkResponse);
@@ -136,6 +140,10 @@ private Long responseContentLength(HttpResponse response) {
     }
 
     private static void validateResponseContentLength(ChannelHandlerContext ctx) throws IOException {
+        if (!shouldValidateResponseContentLength(ctx)) {
+            return;
+        }
+
         Long contentLengthHeader = ctx.channel().attr(RESPONSE_CONTENT_LENGTH).get();
         Long actualContentLength = ctx.channel().attr(RESPONSE_DATA_READ).get();
 
@@ -155,6 +163,23 @@ private static void validateResponseContentLength(ChannelHandlerContext ctx) thr
                               + actualContentLength + " bytes before the connection was closed.");
     }
 
+    private static boolean shouldValidateResponseContentLength(ChannelHandlerContext ctx) {
+        RequestContext requestContext = ctx.channel().attr(REQUEST_CONTEXT_KEY).get();
+
+        // HEAD requests may return Content-Length without a payload
+        if (requestContext.executeRequest().request().method() == SdkHttpMethod.HEAD) {
+            return false;
+        }
+
+        // 304 responses may contain Content-Length without a payload
+        Integer responseStatusCode = ctx.channel().attr(RESPONSE_STATUS_CODE).get();
+        if (responseStatusCode != null && responseStatusCode == HttpResponseStatus.NOT_MODIFIED.code()) {
+            return false;
+        }
+
+        return true;
+    }
+
 
     /**
      * Finalize the response by completing the execute future and release the channel pool being used.

http-clients/netty-nio-client/src/test/java/software/amazon/awssdk/http/nio/netty/internal/PublisherAdapterTest.java

@@ -38,6 +38,7 @@
 import io.netty.handler.codec.http.HttpResponseStatus;
 import io.netty.handler.codec.http.HttpVersion;
 import io.reactivex.Flowable;
+import java.net.URI;
 import java.nio.ByteBuffer;
 import java.util.concurrent.CompletableFuture;
 import org.junit.Before;
@@ -49,6 +50,8 @@
 import org.reactivestreams.Subscriber;
 import org.reactivestreams.Subscription;
 import software.amazon.awssdk.http.Protocol;
+import software.amazon.awssdk.http.SdkHttpMethod;
+import software.amazon.awssdk.http.SdkHttpRequest;
 import software.amazon.awssdk.http.async.AsyncExecuteRequest;
 import software.amazon.awssdk.http.async.SdkAsyncHttpResponseHandler;
 import software.amazon.awssdk.http.nio.netty.internal.nrs.DefaultStreamedHttpResponse;
@@ -86,7 +89,13 @@ public void setUp() throws Exception {
         when(fullHttpResponse.content()).thenReturn(new EmptyByteBuf(ByteBufAllocator.DEFAULT));
         requestContext = new RequestContext(channelPool,
                                             eventLoopGroup,
-                                            AsyncExecuteRequest.builder().responseHandler(responseHandler).build(),
+                                            AsyncExecuteRequest.builder()
+                                                               .request(SdkHttpRequest.builder()
+                                                                                      .uri(URI.create("https://localhost"))
+                                                                                      .method(SdkHttpMethod.GET)
+                                                                                      .build())
+                                                               .responseHandler(responseHandler)
+                                                               .build(),
                                             null);
 
         channel = new MockChannel();

test/http-client-tests/src/main/java/software/amazon/awssdk/http/SdkAsyncHttpClientH1TestSuite.java

@@ -17,12 +17,15 @@
 
 import static io.netty.handler.codec.http.HttpHeaderNames.CONNECTION;
 import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_LENGTH;
+import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_TYPE;
 import static io.netty.handler.codec.http.HttpHeaderValues.CLOSE;
+import static io.netty.handler.codec.http.HttpHeaderValues.TEXT_PLAIN;
 import static io.netty.handler.codec.http.HttpResponseStatus.INTERNAL_SERVER_ERROR;
 import static io.netty.handler.codec.http.HttpResponseStatus.OK;
 import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat;
 
 import io.netty.bootstrap.ServerBootstrap;
+import io.netty.buffer.Unpooled;
 import io.netty.channel.Channel;
 import io.netty.channel.ChannelDuplexHandler;
 import io.netty.channel.ChannelHandlerContext;
@@ -42,6 +45,7 @@
 import io.netty.handler.ssl.SslContext;
 import io.netty.handler.ssl.SslContextBuilder;
 import io.netty.handler.ssl.util.SelfSignedCertificate;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.List;
 import org.junit.jupiter.api.AfterEach;
@@ -129,6 +133,7 @@ public void headRequestResponsesHaveNoPayload() {
     }
 
     private static class Server extends ChannelInitializer<Channel> {
+        private static final byte[] CONTENT = "helloworld".getBytes(StandardCharsets.UTF_8);
         private ServerBootstrap bootstrap;
         private ServerSocketChannel serverSock;
         private List<Channel> channels = new ArrayList<>();
@@ -180,8 +185,12 @@ public void channelRead(ChannelHandlerContext ctx, Object msg) {
                         status = OK;
                     }
 
-                    FullHttpResponse response = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, status);
-                    response.headers().set(CONTENT_LENGTH, 0);
+                    FullHttpResponse response = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, status,
+                                                                            Unpooled.wrappedBuffer(CONTENT));
+
+                    response.headers()
+                            .set(CONTENT_TYPE, TEXT_PLAIN)
+                            .setInt(CONTENT_LENGTH, response.content().readableBytes());
 
                     if (closeConnection) {
                         response.headers().set(CONNECTION, CLOSE);