Merge pull request #276 from jekh/capture-failed-connect-requests-in-har

Add HAR error capture for HTTPS requests

Author: jekh

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

@@ -16,6 +16,8 @@
 import net.lightbody.bmp.filters.BlacklistFilter;
 import net.lightbody.bmp.filters.BrowserMobHttpFilterChain;
 import net.lightbody.bmp.filters.HarCaptureFilter;
+import net.lightbody.bmp.filters.ResolvedHostnameCacheFilter;
+import net.lightbody.bmp.filters.HttpConnectHarCaptureFilter;
 import net.lightbody.bmp.filters.HttpsHostCaptureFilter;
 import net.lightbody.bmp.filters.HttpsOriginalHostCaptureFilter;
 import net.lightbody.bmp.filters.LatencyFilter;
@@ -52,6 +54,7 @@
 import org.littleshoot.proxy.HttpProxyServer;
 import org.littleshoot.proxy.HttpProxyServerBootstrap;
 import org.littleshoot.proxy.impl.DefaultHttpProxyServer;
+import org.littleshoot.proxy.impl.ProxyUtils;
 import org.openqa.selenium.Proxy;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -1279,6 +1282,13 @@ public boolean isMitmDisabled() {
      * Adds the basic browsermob-proxy filters, except for the relatively-expensive HAR capture filter.
      */
     protected void addBrowserMobFilters() {
+        addHttpFilterFactory(new HttpFiltersSourceAdapter() {
+            @Override
+            public HttpFilters filterRequest(HttpRequest originalRequest, ChannelHandlerContext ctx) {
+                return new ResolvedHostnameCacheFilter(originalRequest, ctx);
+            }
+        });
+
         addHttpFilterFactory(new HttpFiltersSourceAdapter() {
             @Override
             public HttpFilters filterRequest(HttpRequest originalRequest, ChannelHandlerContext ctx) {
@@ -1374,10 +1384,31 @@ private int getMaximumResponseBufferSize() {
      */
     protected void addHarCaptureFilter() {
         if (harCaptureFilterEnabled.compareAndSet(false, true)) {
+            // the HAR capture filter is (relatively) expensive, so only enable it when a HAR is being captured. furthermore,
+            // restricting the HAR capture filter to requests where the HAR exists, as well as  excluding HTTP CONNECTs
+            // from the HAR capture filter, greatly simplifies the filter code.
+            addHttpFilterFactory(new HttpFiltersSourceAdapter() {
+                @Override
+                public HttpFilters filterRequest(HttpRequest originalRequest, ChannelHandlerContext ctx) {
+                    Har har = getHar();
+                    if (har != null && !ProxyUtils.isCONNECT(originalRequest)) {
+                        return new HarCaptureFilter(originalRequest, ctx, har, getCurrentHarPage() == null ? null : getCurrentHarPage().getId(), getHarCaptureTypes());
+                    } else {
+                        return null;
+                    }
+                }
+            });
+
+            // HTTP CONNECTs are a special case, since they require special timing and error handling
             addHttpFilterFactory(new HttpFiltersSourceAdapter() {
                 @Override
                 public HttpFilters filterRequest(HttpRequest originalRequest, ChannelHandlerContext ctx) {
-                    return new HarCaptureFilter(originalRequest, ctx, getHar(), getCurrentHarPage() == null ? null : getCurrentHarPage().getId(), getHarCaptureTypes());
+                    Har har = getHar();
+                    if (har != null && ProxyUtils.isCONNECT(originalRequest)) {
+                        return new HttpConnectHarCaptureFilter(originalRequest, ctx, har, getCurrentHarPage() == null ? null : getCurrentHarPage().getId());
+                    } else {
+                        return null;
+                    }
                 }
             });
         }

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

@@ -40,7 +40,11 @@ public BrowserMobHttpFilterChain(BrowserMobProxyServer proxyServer, HttpRequest
             // instantiate all HttpFilters using the proxy's filter factories
             for (HttpFiltersSource filterFactory : proxyServer.getFilterFactories()) {
                 HttpFilters filter = filterFactory.filterRequest(originalRequest, ctx);
-                filters.add(filter);
+                // allow filter factories to avoid adding a filter on a per-request basis by returning a null
+                // HttpFilters instance
+                if (filter != null) {
+                    filters.add(filter);
+                }
             }
         } else {
             filters = Collections.emptyList();