From aa3de81141b41fc47cfc89e168e4ab622da12ea0 Mon Sep 17 00:00:00 2001 From: Ajay Date: Thu, 13 Jun 2019 17:09:19 -0400 Subject: [PATCH 1/4] add option to return raw input stream for response --- .../services/AbstractGoogleClientRequest.java | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/google-api-client/src/main/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequest.java b/google-api-client/src/main/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequest.java index 1de14b99a..c2c77f632 100644 --- a/google-api-client/src/main/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequest.java +++ b/google-api-client/src/main/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequest.java @@ -94,6 +94,9 @@ public abstract class AbstractGoogleClientRequest extends GenericData { /** Whether to disable GZip compression of HTTP content. */ private boolean disableGZipContent; + /** whether to return raw input stream in {@link HttpResponse#getContent()}. */ + private boolean returnRawInputStream; + /** Response class to parse into. */ private Class responseClass; @@ -222,6 +225,11 @@ public final boolean getDisableGZipContent() { return disableGZipContent; } + /** Returns whether response should return raw input stream. */ + public final boolean getReturnRawInputSteam() { + return returnRawInputStream; + } + /** * Sets whether to disable GZip compression of HTTP content. * @@ -239,6 +247,24 @@ public AbstractGoogleClientRequest setDisableGZipContent(boolean disableGZipC return this; } + /** + * Sets whether the response should return raw input stream or not. + * + *

+ * By default ti is {@code false}. + *

+ * + *

+ * Normally response stream is wrapped GZipInputStream when it contains content-encoding header to gzip + * This doesnt work when we download large compressed file in chunks, setting this to true will make + * response return raw input stream even if header contains content-encoding as gzip. + *

+ */ + public AbstractGoogleClientRequest setReturnRawInputStream(boolean returnRawInputStream) { + this.returnRawInputStream = returnRawInputStream; + return this; + } + /** Returns the HTTP method. */ public final String getRequestMethod() { return requestMethod; @@ -406,6 +432,7 @@ private HttpRequest buildHttpRequest(boolean usingHead) throws IOException { if (!disableGZipContent) { httpRequest.setEncoding(new GZipEncoding()); } + httpRequest.setResponseReturnRawInputStream(returnRawInputStream); final HttpResponseInterceptor responseInterceptor = httpRequest.getResponseInterceptor(); httpRequest.setResponseInterceptor(new HttpResponseInterceptor() { From 5aab6269439cf44fdd7d9dd63c12da0cd1ed9dd7 Mon Sep 17 00:00:00 2001 From: Ajay Date: Thu, 13 Jun 2019 16:02:12 -0400 Subject: [PATCH 2/4] add option to return raw response --- .../AbstractGoogleClientRequestTest.java | 52 +++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/google-api-client/src/test/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequestTest.java b/google-api-client/src/test/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequestTest.java index 58c5320da..458e991d5 100644 --- a/google-api-client/src/test/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequestTest.java +++ b/google-api-client/src/test/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequestTest.java @@ -18,6 +18,7 @@ import com.google.api.client.http.EmptyContent; import com.google.api.client.http.HttpMethods; import com.google.api.client.http.HttpRequest; +import com.google.api.client.http.HttpRequestInitializer; import com.google.api.client.http.HttpResponseException; import com.google.api.client.http.HttpStatusCodes; import com.google.api.client.http.HttpTransport; @@ -31,8 +32,12 @@ import com.google.api.client.testing.http.MockLowLevelHttpRequest; import com.google.api.client.testing.http.MockLowLevelHttpResponse; import com.google.api.client.util.StringUtils; +import com.google.common.io.BaseEncoding; +import java.io.ByteArrayInputStream; import java.io.IOException; +import java.io.InputStream; import java.util.Arrays; +import java.util.zip.GZIPInputStream; import junit.framework.TestCase; /** @@ -246,6 +251,53 @@ public void testSetsApiClientHeaderWithoutOsVersion() throws Exception { assertFalse("Api version should not contain the os version", version.matches(".*my-os.*")); } + public void testReturnRawInputStream_defaultFalse() throws Exception { + HttpTransport transport = new MockHttpTransport() { + @Override + public LowLevelHttpRequest buildRequest(final String method, final String url) { + return new MockLowLevelHttpRequest() { + @Override + public LowLevelHttpResponse execute() { + return new MockLowLevelHttpResponse().setContentEncoding("gzip").setContent(new ByteArrayInputStream( + BaseEncoding.base64() + .decode("H4sIAAAAAAAAAPNIzcnJV3DPz0/PSVVwzskvTVEILskvSkxPVQQA/LySchsAAAA="))); + } + }; + } + }; + MockGoogleClient client = new MockGoogleClient.Builder(transport, ROOT_URL, SERVICE_PATH, + JSON_OBJECT_PARSER, null).setApplicationName( + "Test Application").build(); + MockGoogleClientRequest request = new MockGoogleClientRequest( + client, HttpMethods.GET, URI_TEMPLATE, null, String.class); + InputStream inputStream = request.executeAsInputStream(); + assertTrue(inputStream instanceof GZIPInputStream); + } + + public void testReturnRawInputStream_True() throws Exception { + HttpTransport transport = new MockHttpTransport() { + @Override + public LowLevelHttpRequest buildRequest(final String method, final String url) { + return new MockLowLevelHttpRequest() { + @Override + public LowLevelHttpResponse execute() { + return new MockLowLevelHttpResponse().setContentEncoding("gzip").setContent(new ByteArrayInputStream( + BaseEncoding.base64() + .decode("H4sIAAAAAAAAAPNIzcnJV3DPz0/PSVVwzskvTVEILskvSkxPVQQA/LySchsAAAA="))); + } + }; + } + }; + MockGoogleClient client = new MockGoogleClient.Builder(transport, ROOT_URL, SERVICE_PATH, + JSON_OBJECT_PARSER, null).setApplicationName( + "Test Application").build(); + MockGoogleClientRequest request = new MockGoogleClientRequest( + client, HttpMethods.GET, URI_TEMPLATE, null, String.class); + request.setReturnRawInputStream(true); + InputStream inputStream = request.executeAsInputStream(); + assertFalse(inputStream instanceof GZIPInputStream); + } + private class AssertHeaderTransport extends MockHttpTransport { String expectedHeader; String expectedHeaderValue; From cd9c76567342fab8806780f07c27099bab1c4048 Mon Sep 17 00:00:00 2001 From: Ajay Date: Thu, 13 Jun 2019 17:22:33 -0400 Subject: [PATCH 3/4] fix checkstyle --- .../googleapis/services/AbstractGoogleClientRequest.java | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/google-api-client/src/main/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequest.java b/google-api-client/src/main/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequest.java index c2c77f632..99e80f59c 100644 --- a/google-api-client/src/main/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequest.java +++ b/google-api-client/src/main/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequest.java @@ -255,9 +255,10 @@ public AbstractGoogleClientRequest setDisableGZipContent(boolean disableGZipC *

* *

- * Normally response stream is wrapped GZipInputStream when it contains content-encoding header to gzip - * This doesnt work when we download large compressed file in chunks, setting this to true will make - * response return raw input stream even if header contains content-encoding as gzip. + * Normally response stream is wrapped GZipInputStream when it contains content-encoding header + * to gzip. This doesnt work when we download large compressed file in chunks, setting this to + * true will make response return raw input stream even if header contains content-encoding as + * gzip. *

*/ public AbstractGoogleClientRequest setReturnRawInputStream(boolean returnRawInputStream) { From bcd05750420edd9c8d50427ec132c400d0bf8776 Mon Sep 17 00:00:00 2001 From: Ajay Date: Mon, 17 Jun 2019 22:59:54 -0400 Subject: [PATCH 4/4] fix doc comment --- .../services/AbstractGoogleClientRequest.java | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/google-api-client/src/main/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequest.java b/google-api-client/src/main/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequest.java index 99e80f59c..f212ccd9b 100644 --- a/google-api-client/src/main/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequest.java +++ b/google-api-client/src/main/java/com/google/api/client/googleapis/services/AbstractGoogleClientRequest.java @@ -94,7 +94,7 @@ public abstract class AbstractGoogleClientRequest extends GenericData { /** Whether to disable GZip compression of HTTP content. */ private boolean disableGZipContent; - /** whether to return raw input stream in {@link HttpResponse#getContent()}. */ + /** Whether to return raw input stream in {@link HttpResponse#getContent()}. */ private boolean returnRawInputStream; /** Response class to parse into. */ @@ -251,14 +251,14 @@ public AbstractGoogleClientRequest setDisableGZipContent(boolean disableGZipC * Sets whether the response should return raw input stream or not. * *

- * By default ti is {@code false}. + * By default it is {@code false}. *

* *

- * Normally response stream is wrapped GZipInputStream when it contains content-encoding header - * to gzip. This doesnt work when we download large compressed file in chunks, setting this to - * true will make response return raw input stream even if header contains content-encoding as - * gzip. + * When the response contains a known content-encoding header, the response stream is wrapped + * with an InputStream that decodes the content. This fails when we download large files in + * chunks (see #1009 + * ). Setting this to true will make the response return the raw input stream. *

*/ public AbstractGoogleClientRequest setReturnRawInputStream(boolean returnRawInputStream) {