Merge pull request #282 from jekh/capture-redirect-url-in-har

Capture redirectURL in HAR

Author: jekh

browsermob-core-littleproxy/src/main/java/net/lightbody/bmp/filters/HarCaptureFilter.java

@@ -479,6 +479,10 @@ protected void captureResponse(HttpResponse httpResponse) {
         if (dataToCapture.contains(CaptureType.RESPONSE_HEADERS)) {
             captureResponseHeaders(httpResponse);
         }
+
+        if (BrowserMobHttpUtil.isRedirect(httpResponse)) {
+            captureRedirectUrl(httpResponse);
+        }
     }
 
     protected void captureResponseCookies(HttpResponse httpResponse) {
@@ -524,6 +528,13 @@ protected void captureResponseHeaders(HttpResponse httpResponse) {
         }
     }
 
+    protected void captureRedirectUrl(HttpResponse httpResponse) {
+        String locationHeaderValue = HttpHeaders.getHeader(httpResponse, HttpHeaders.Names.LOCATION);
+        if (locationHeaderValue != null) {
+            harEntry.getResponse().setRedirectURL(locationHeaderValue);
+        }
+    }
+
     /**
      * Adds the size of this httpContent to the requestBodySize.
      *

browsermob-core-littleproxy/src/test/groovy/net/lightbody/bmp/proxy/NewHarTest.groovy

@@ -15,6 +15,7 @@ import net.lightbody.bmp.proxy.dns.AdvancedHostResolver
 import net.lightbody.bmp.proxy.test.util.MockServerTest
 import net.lightbody.bmp.proxy.test.util.ProxyServerTest
 import net.lightbody.bmp.proxy.util.IOUtils
+import org.apache.http.client.config.RequestConfig
 import org.apache.http.client.methods.CloseableHttpResponse
 import org.apache.http.client.methods.HttpGet
 import org.junit.After
@@ -857,5 +858,105 @@ class NewHarTest extends MockServerTest {
         assertEquals("Expected receive time to not be populated", 0L, harTimings.getReceive(TimeUnit.NANOSECONDS))
     }
 
+    @Test
+    void testRedirectUrlCapturedForRedirects() {
+        mockServer.when(request()
+                .withMethod("GET")
+                .withPath("/test300"),
+                Times.once())
+                .respond(response()
+                .withStatusCode(300)
+                .withHeader("Location", "/redirected-location"))
+
+        mockServer.when(request()
+                .withMethod("GET")
+                .withPath("/test301"),
+                Times.once())
+                .respond(response()
+                .withStatusCode(301)
+                .withHeader("Location", "/redirected-location"))
+
+        mockServer.when(request()
+                .withMethod("GET")
+                .withPath("/test302"),
+                Times.once())
+                .respond(response()
+                .withStatusCode(302)
+                .withHeader("Location", "/redirected-location"))
+
+        mockServer.when(request()
+                .withMethod("GET")
+                .withPath("/test303"),
+                Times.once())
+                .respond(response()
+                .withStatusCode(303)
+                .withHeader("Location", "/redirected-location"))
+
+        mockServer.when(request()
+                .withMethod("GET")
+                .withPath("/test307"),
+                Times.once())
+                .respond(response()
+                .withStatusCode(307)
+                .withHeader("Location", "/redirected-location"))
+
+        mockServer.when(request()
+                .withMethod("GET")
+                .withPath("/test301-no-location-header"),
+                Times.once())
+                .respond(response()
+                .withStatusCode(301))
+
+        proxy = new BrowserMobProxyServer();
+        proxy.start()
+
+        proxy.newHar()
+
+        def verifyRedirect = { String requestUrl, expectedStatusCode, expectedLocationValue ->
+            ProxyServerTest.getNewHttpClient(proxy.port).withCloseable {
+                // for some reason, even when the HTTP client is built with .disableRedirectHandling(), it still tries to follow
+                // the 301. so explicitly disable following redirects at the request level.
+                def request = new HttpGet(requestUrl)
+                request.setConfig(RequestConfig.custom().setRedirectsEnabled(false).build())
+
+                CloseableHttpResponse response = it.execute(request)
+                assertEquals("HTTP response code did not match expected response code", expectedStatusCode, response.getStatusLine().getStatusCode())
+            };
+
+            Thread.sleep(500)
+            Har har = proxy.getHar()
+
+            assertThat("Expected to find entries in the HAR", har.getLog().getEntries(), not(empty()))
+
+            // make sure request data is still captured despite the failure
+            String capturedUrl = har.log.entries[0].request.url
+            assertEquals("URL captured in HAR did not match request URL", requestUrl, capturedUrl)
+
+            HarResponse harResponse = har.log.entries[0].response
+            assertNotNull("No HAR response found", harResponse)
+
+            assertEquals("Expected redirect location to be populated in redirectURL field", expectedLocationValue, harResponse.redirectURL);
+        }
+
+        verifyRedirect("http://localhost:${mockServerPort}/test300", 300, "/redirected-location")
+
+        // clear the HAR between every request, to make the verification step easier
+        proxy.newHar()
+        verifyRedirect("http://localhost:${mockServerPort}/test301", 301, "/redirected-location")
+
+        proxy.newHar()
+        verifyRedirect("http://localhost:${mockServerPort}/test302", 302, "/redirected-location")
+
+        proxy.newHar()
+        verifyRedirect("http://localhost:${mockServerPort}/test303", 303, "/redirected-location")
+
+        proxy.newHar()
+        verifyRedirect("http://localhost:${mockServerPort}/test307", 307, "/redirected-location")
+
+        proxy.newHar()
+        // redirectURL should always be populated or an empty string, never null
+        verifyRedirect("http://localhost:${mockServerPort}/test301-no-location-header", 301, "")
+    }
+
     //TODO: Add Request Capture Type tests
 }

browsermob-core/src/main/java/net/lightbody/bmp/util/BrowserMobHttpUtil.java

@@ -4,6 +4,7 @@
 import io.netty.buffer.ByteBuf;
 import io.netty.handler.codec.http.HttpHeaders;
 import io.netty.handler.codec.http.HttpRequest;
+import io.netty.handler.codec.http.HttpResponse;
 import net.lightbody.bmp.exception.DecompressionException;
 import org.apache.http.entity.ContentType;
 import org.slf4j.Logger;
@@ -323,6 +324,26 @@ public static String getHostAndPortFromUri(String uriString) throws URISyntaxExc
         }
     }
 
+    /**
+     * Returns true if the specified response is an HTTP redirect response, i.e. a 300, 301, 302, 303, or 307.
+     *
+     * @param httpResponse HTTP response
+     * @return true if the response is a redirect, otherwise false
+     */
+    public static boolean isRedirect(HttpResponse httpResponse) {
+        switch (httpResponse.getStatus().code()) {
+            case 300:
+            case 301:
+            case 302:
+            case 303:
+            case 307:
+                return true;
+
+            default:
+                return false;
+        }
+    }
+
     /**
      * Retrieves the host and, optionally, the port from the specified request's Host header.
      *