Merge pull request #38 from browserup/merge-har-reader

Merge har-reader and use mrog LittleProxy fork

Author: dpowell

browserup-proxy-core/build.gradle

@@ -57,22 +57,7 @@ uploadArchives {
 dependencies {
     implementation project(':browserup-proxy-mitm')
 
-    implementation 'com.browserup:har-reader:3.0.0-SNAPSHOT'
-    implementation 'com.browserup:littleproxy:2.0.0-SNAPSHOT'
-
     implementation 'javax.xml.bind:jaxb-api:2.3.1'
-    // Needed by org.littleshoot.proxy JAR
-    implementation 'org.apache.commons:commons-lang3:3.5'
-
-    // We haven't upgraded to this:
-    // implementation('org.littleshoot:littleproxy:1.1.2')
-    // because it still uses Guava 23. We should fork it some day.
-    //implementation('com.browserup.bup:littleproxy:1.1.0-beta-bup-15') {
-    // Using our own fork now, build it and put it in the lib/ dir
-    //    implementation('org.littleshoot:littleproxy:1.1.2') {
-    //        exclude(module: 'barchart-udt-bundle')
-    //        exclude(module: 'commons-cli')
-    //    }
 
     implementation 'com.fasterxml.jackson.core:jackson-core:2.8.6'
     implementation 'com.fasterxml.jackson.core:jackson-databind:2.8.6'
@@ -89,6 +74,7 @@ dependencies {
     implementation 'org.seleniumhq.selenium:selenium-api:3.141.59'
     implementation 'org.slf4j:jcl-over-slf4j:1.7.22'
     implementation 'org.slf4j:slf4j-api:1.7.22'
+    implementation 'xyz.rogfam:littleproxy:2.0.0-beta-3'
 
     testImplementation 'junit:junit:4.12'
     testImplementation 'org.codehaus.groovy:groovy-all:2.4.16'

browserup-proxy-core/src/main/java/com/browserup/bup/BrowserUpProxyServer.java

@@ -68,6 +68,7 @@
 import org.littleshoot.proxy.HttpProxyServer;
 import org.littleshoot.proxy.HttpProxyServerBootstrap;
 import org.littleshoot.proxy.MitmManager;
+import org.littleshoot.proxy.impl.ClientDetails;
 import org.littleshoot.proxy.impl.DefaultHttpProxyServer;
 import org.littleshoot.proxy.impl.ProxyUtils;
 import org.littleshoot.proxy.impl.ThreadPoolConfiguration;
@@ -361,7 +362,7 @@ public int getMaximumResponseBufferSizeInBytes() {
 
             bootstrap.withChainProxyManager(new ChainedProxyManager() {
                 @Override
-                public void lookupChainedProxies(HttpRequest httpRequest, Queue<ChainedProxy> chainedProxies) {
+                public void lookupChainedProxies(HttpRequest httpRequest, Queue<ChainedProxy> chainedProxies, ClientDetails clientDetails) {
                     final InetSocketAddress upstreamProxy = upstreamProxyAddress;
                     if (upstreamProxy != null) {
                         chainedProxies.add(new ChainedProxyAdapter() {

browserup-proxy-core/src/main/java/com/browserup/bup/client/ClientUtil.java

@@ -48,6 +48,7 @@ public static AdvancedHostResolver createNativeResolver() {
      * @return a new DnsJavaResolver
      * @deprecated The dnsjava resolver has been deprecated in favor of the standard JVM resolver and will be removed in BUP >2.1.
      */
+    @Deprecated
     public static AdvancedHostResolver createDnsJavaResolver() {
         return new DnsJavaResolver();
     }
@@ -60,6 +61,7 @@ public static AdvancedHostResolver createDnsJavaResolver() {
      * @return a new ChainedHostResolver that resolves addresses first using a DnsJavaResolver, then using a NativeCacheManipulatingResolver
      * @deprecated The dnsjava resolver has been deprecated in favor of the standard JVM resolver and will be removed in BUP >2.1.
      */
+    @Deprecated
     public static AdvancedHostResolver createDnsJavaWithNativeFallbackResolver() {
         return new ChainedHostResolver(ImmutableList.of(new DnsJavaResolver(), new NativeCacheManipulatingResolver()));
     }

browserup-proxy-core/src/main/java/com/browserup/bup/proxy/dns/DnsJavaResolver.java

@@ -31,6 +31,7 @@
  *
  * @deprecated The dnsjava resolver has been deprecated in favor of the standard JVM resolver and will be removed in BUP >2.1.
  */
+@Deprecated
 public class DnsJavaResolver extends AbstractHostNameRemapper implements AdvancedHostResolver {
     private static final Logger log = LoggerFactory.getLogger(DnsJavaResolver.class);
 

browserup-proxy-core/src/main/java/com/browserup/harreader/HarReader.java

@@ -0,0 +1,52 @@
+package com.browserup.harreader;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.browserup.harreader.jackson.DefaultMapperFactory;
+import com.browserup.harreader.jackson.MapperFactory;
+import com.browserup.harreader.model.Har;
+
+import java.io.File;
+import java.io.IOException;
+
+public class HarReader {
+
+    private final MapperFactory mapperFactory;
+
+    public HarReader(MapperFactory mapperFactory) {
+        if (mapperFactory == null) {
+            throw new IllegalArgumentException("mapperFactory must not be null!");
+        }
+        this.mapperFactory = mapperFactory;
+    }
+
+    public HarReader() {
+        this(new DefaultMapperFactory());
+    }
+
+    public Har readFromFile(File har) throws HarReaderException {
+        return this.readFromFile(har, HarReaderMode.STRICT);
+    }
+
+    public Har readFromFile(File har, HarReaderMode mode) throws HarReaderException {
+        ObjectMapper mapper = mapperFactory.instance(mode);
+        try {
+            return mapper.readValue(har, Har.class);
+        } catch (IOException e) {
+            throw new HarReaderException(e);
+        }
+    }
+
+    public Har readFromString(String har) throws HarReaderException {
+        return this.readFromString(har, HarReaderMode.STRICT);
+    }
+
+    public Har readFromString(String har, HarReaderMode mode) throws HarReaderException {
+        ObjectMapper mapper = mapperFactory.instance(mode);
+        try {
+            return mapper.readValue(har, Har.class);
+        } catch (IOException e) {
+            throw new HarReaderException(e);
+        }
+    }
+
+}

browserup-proxy-core/src/main/java/com/browserup/harreader/HarReaderException.java

@@ -0,0 +1,9 @@
+package com.browserup.harreader;
+
+public class HarReaderException extends Exception {
+
+    public HarReaderException(Throwable cause) {
+        super(cause);
+    }
+
+}

browserup-proxy-core/src/main/java/com/browserup/harreader/HarReaderMode.java

@@ -0,0 +1,19 @@
+package com.browserup.harreader;
+
+public enum HarReaderMode {
+
+    /**
+     * Using strict mode enforces some rules.
+     * When trying to open an invalid HAR file an exception will be thrown.
+     */
+    STRICT,
+
+    /**
+     * Using lax mode you are able to read even invalid HAR files.
+     * Currently lax mode allows:
+     * <ul>
+     *     <li>invalid date formats</li>
+     * </ul>
+     */
+    LAX;
+}

browserup-proxy-core/src/main/java/com/browserup/harreader/filter/HarEntriesFilter.java

@@ -0,0 +1,10 @@
+package com.browserup.harreader.filter;
+
+import com.browserup.harreader.model.HarEntry;
+import java.util.function.Predicate;
+
+public interface HarEntriesFilter extends Predicate<HarEntry> {
+
+    @Override
+    boolean test(HarEntry entry);
+}

browserup-proxy-core/src/main/java/com/browserup/harreader/filter/HarEntriesUrlPatternFilter.java

@@ -0,0 +1,18 @@
+package com.browserup.harreader.filter;
+
+import com.browserup.harreader.model.HarEntry;
+import java.util.regex.Pattern;
+
+public class HarEntriesUrlPatternFilter implements HarEntriesFilter {
+
+    private final Pattern pattern;
+
+    public HarEntriesUrlPatternFilter(Pattern pattern) {
+        this.pattern = pattern;
+    }
+
+    @Override
+    public boolean test(HarEntry entry) {
+        return pattern.matcher(entry.getRequest().getUrl()).matches();
+    }
+}

browserup-proxy-core/src/main/java/com/browserup/harreader/jackson/DefaultMapperFactory.java

@@ -0,0 +1,22 @@
+package com.browserup.harreader.jackson;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.module.SimpleModule;
+import com.browserup.harreader.HarReaderMode;
+
+import java.util.Date;
+
+public class DefaultMapperFactory implements MapperFactory {
+
+    public ObjectMapper instance(HarReaderMode mode) {
+        ObjectMapper mapper = new ObjectMapper();
+        SimpleModule module = new SimpleModule();
+        if (mode == HarReaderMode.LAX) {
+            module.addDeserializer(Date.class, new ExceptionIgnoringDateDeserializer());
+            module.addDeserializer(Integer.class, new ExceptionIgnoringIntegerDeserializer());
+        }
+        mapper.registerModule(module);
+        return mapper;
+    }
+
+}