Add methods to allow HttpRequestor subclasses to more easily intercept HTTP responses (e.g. for logging, analytics, etc).

Karl Rieb · Karl Rieb · commit d51b5902cb3c · 2016-07-07T10:58:45.000-07:00
diff --git a/src/main/java/com/dropbox/core/http/OkHttp3Requestor.java b/src/main/java/com/dropbox/core/http/OkHttp3Requestor.java
@@ -90,12 +90,25 @@ public OkHttpClient getClient() {
      */
     protected void configureRequest(Request.Builder request) { }
 
+    /**
+     * Called before returning {@link Response} from a request.
+     *
+     * <p> This method should be used by subclasses to add any logging, analytics, or cleanup
+     * necessary.
+     *
+     * <p> Do not consume the response body in this method.
+     *
+     * @param response OkHttp response
+     */
+    protected void interceptResponse(okhttp3.Response response) { }
+
     @Override
     public Response doGet(String url, Iterable<Header> headers) throws IOException {
         Request.Builder builder = new Request.Builder().get().url(url);
         toOkHttpHeaders(headers, builder);
         configureRequest(builder);
         okhttp3.Response response = client.newCall(builder.build()).execute();
+        interceptResponse(response);
         Map<String, List<String>> responseHeaders = fromOkHttpHeaders(response.headers());
         return new Response(response.code(), response.body().byteStream(), responseHeaders);
     }
@@ -138,7 +151,7 @@ private static Map<String, List<String>> fromOkHttpHeaders(Headers headers) {
      * the {@link java.io.OutputStream} from an Okio {@link Buffer} that is connected to an OkHttp
      * {@link RequestBody}.  Calling {@link #finish()} will execute the request with OkHttp
      */
-    private static class BufferUploader extends HttpRequestor.Uploader {
+    private class BufferUploader extends HttpRequestor.Uploader {
         private final Call call;
         private final Buffer requestBuffer;
 
@@ -161,6 +174,7 @@ public void abort() {
         @Override
         public Response finish() throws IOException {
             okhttp3.Response response = call.execute();
+            interceptResponse(response);
             Map<String, List<String>> responseHeaders = fromOkHttpHeaders(response.headers());
             return new Response(response.code(), response.body().byteStream(), responseHeaders);
         }
diff --git a/src/main/java/com/dropbox/core/http/OkHttpRequestor.java b/src/main/java/com/dropbox/core/http/OkHttpRequestor.java
@@ -93,12 +93,25 @@ public OkHttpClient getClient() {
      */
     protected void configureRequest(Request.Builder request) { }
 
+    /**
+     * Called before returning {@link Response} from a request.
+     *
+     * <p> This method should be used by subclasses to add any logging, analytics, or cleanup
+     * necessary.
+     *
+     * <p> Do not consume the response body in this method.
+     *
+     * @param response OkHttp response
+     */
+    protected void interceptResponse(com.squareup.okhttp.Response response) { }
+
     @Override
     public Response doGet(String url, Iterable<Header> headers) throws IOException {
         Request.Builder builder = new Request.Builder().get().url(url);
         toOkHttpHeaders(headers, builder);
         configureRequest(builder);
         com.squareup.okhttp.Response response = client.newCall(builder.build()).execute();
+        interceptResponse(response);
         Map<String, List<String>> responseHeaders = fromOkHttpHeaders(response.headers());
         return new Response(response.code(), response.body().byteStream(), responseHeaders);
     }
@@ -141,7 +154,7 @@ private static Map<String, List<String>> fromOkHttpHeaders(Headers headers) {
      * the {@link java.io.OutputStream} from an Okio {@link Buffer} that is connected to an OkHttp
      * {@link RequestBody}.  Calling {@link #finish()} will execute the request with OkHttp
      */
-    private static class BufferUploader extends HttpRequestor.Uploader {
+    private class BufferUploader extends HttpRequestor.Uploader {
         private final Call call;
         private final Buffer requestBuffer;
 
@@ -164,6 +177,7 @@ public void abort() {
         @Override
         public Response finish() throws IOException {
             com.squareup.okhttp.Response response = call.execute();
+            interceptResponse(response);
             Map<String, List<String>> responseHeaders = fromOkHttpHeaders(response.headers());
             return new Response(response.code(), response.body().byteStream(), responseHeaders);
         }
diff --git a/src/main/java/com/dropbox/core/http/StandardHttpRequestor.java b/src/main/java/com/dropbox/core/http/StandardHttpRequestor.java
@@ -45,14 +45,15 @@ public StandardHttpRequestor(Config config) {
         this.config = config;
     }
 
-    private static Response toResponse(HttpURLConnection conn) throws IOException {
+    private Response toResponse(HttpURLConnection conn) throws IOException {
         int responseCode = conn.getResponseCode();
         InputStream bodyStream;
         if (responseCode >= 400 || responseCode == -1) {
             bodyStream = conn.getErrorStream();
         } else {
             bodyStream = conn.getInputStream();
         }
+        interceptResponse(conn);
         return new Response(responseCode, bodyStream, conn.getHeaderFields());
     }
 
@@ -103,7 +104,26 @@ protected void configureConnection(HttpsURLConnection conn) throws IOException {
      */
     protected void configure(HttpURLConnection conn) throws IOException { }
 
-    private static class Uploader extends HttpRequestor.Uploader {
+    /**
+     * Called before returning {@link Response} from a request.
+     *
+     * <p> This method should be used by subclasses to add any logging, analytics, or cleanup
+     * necessary. Note that the connection response code and response streams will already be
+     * fetched before calling this method. This means any {@link IOException} from reading the
+     * response should already have occurred before this method is called.
+     *
+     * <p> Do not consume the response or error streams in this method.
+     *
+     * @param response OkHttp response
+     */
+    protected void interceptResponse(HttpURLConnection conn) throws IOException { }
+
+    private static OutputStream getOutputStream(HttpURLConnection conn) throws IOException {
+        conn.setDoOutput(true);
+        return conn.getOutputStream();
+    }
+
+    private class Uploader extends HttpRequestor.Uploader {
         private /*@Nullable*/ HttpURLConnection conn;
 
         public Uploader(HttpURLConnection conn)
@@ -113,12 +133,6 @@ public Uploader(HttpURLConnection conn)
             this.conn = conn;
         }
 
-        private static OutputStream getOutputStream(HttpURLConnection conn)
-            throws IOException {
-            conn.setDoOutput(true);
-            return conn.getOutputStream();
-        }
-
         @Override
         public void abort() {
             if (conn == null) {
