WIP: Adding plugin to proxy all okhttp requests without interceptors

Author: shehabic

app/build.gradle

@@ -2,7 +2,7 @@ apply plugin: 'com.android.application'
 apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-android-extensions'
 apply plugin: 'kotlin-kapt'
-apply plugin: 'sherlock-plugin'
+//apply plugin: 'sherlock-plugin'
 
 android {
     configurations {

build.gradle

@@ -5,7 +5,7 @@ buildscript {
     ext.architecture_components_version = '1.1.1'
     ext.support_libraries_version = '27.1.1'
     ext.okhttp_version = '3.11.0'
-    ext.VERSION_NAME = "v1.0.5"
+    ext.VERSION_NAME = "v1.0.7"
 
     repositories {
         google()
@@ -15,11 +15,11 @@ buildscript {
         maven { url "https://plugins.gradle.org/m2/" }
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.2.1'
+        classpath 'com.android.tools.build:gradle:3.3.0'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
-        classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1'
         classpath "com.gradle.publish:plugin-publish-plugin:0.9.9"
-        classpath 'com.github.shehabic.sherlock:sherlock-plugin:v1.0.5'
+        classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1'
+//        classpath 'com.github.shehabic.sherlock:sherlock-plugin:v1.0.6e'
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }

gradle.properties

@@ -18,7 +18,7 @@ VERSION_CODE=0.9.2
 POM_DEVELOPER_ID=shehabic
 POM_DEVELOPER_NAME=Mohamed Shehab Osman
 
-GROUP=com.github.shehabic
+GROUP=com.github.shehabic.sherlock
 POM_DESCRIPTION=A library to capture android app crashes and show their details
 POM_URL=https://github.com/shehabic/sherlock
 POM_SCM_URL=https://github.com/shehabic/sherlock

gradle/wrapper/gradle-wrapper.properties

@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.6-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.1-all.zip

sherlock-no-op/build.gradle

@@ -4,9 +4,6 @@ apply plugin: 'maven-publish'
 
 android {
     compileSdkVersion 28
-
-
-
     defaultConfig {
         minSdkVersion 15
         targetSdkVersion 28
@@ -41,7 +38,7 @@ repositories {
 publishing {
     publications {
         bar(MavenPublication) {
-            groupId 'com.github.shehabic'
+            groupId GROUP
             artifactId 'sherlock-no-op'
             version VERSION_NAME
             artifact(bundleReleaseAar)
@@ -53,7 +50,7 @@ publishing {
         }
     }
 }
-apply plugin: 'com.github.dcendents.android-maven'
+//apply plugin: 'com.github.dcendents.android-maven'
 
 
 //apply from: rootProject.file('gradle/publish.gradle')

sherlock-plugin/build.gradle

@@ -43,7 +43,7 @@ task javadocJar(type: Jar) {
 publishing {
     publications {
         maven(MavenPublication) {
-            groupId 'com.github.shehabic'
+            groupId GROUP
             artifactId 'sherlock-plugin'
             version VERSION_NAME
             from components.java

sherlock-plugin/src/main/java/com/shehabic/sherlock/plugin/SherlockClassWriter.java

@@ -5,13 +5,10 @@
 import org.objectweb.asm.ClassVisitor;
 import org.objectweb.asm.ClassWriter;
 import org.objectweb.asm.MethodVisitor;
+import org.objectweb.asm.Opcodes;
 
 import static org.objectweb.asm.ClassReader.SKIP_FRAMES;
 import static org.objectweb.asm.ClassWriter.COMPUTE_FRAMES;
-import static org.objectweb.asm.Opcodes.ASM6;
-
-import org.objectweb.asm.Type;
-import org.objectweb.asm.commons.AdviceAdapter;
 
 /**
  * @author shehabic
@@ -25,36 +22,9 @@ byte[] instrument(byte[] contents) {
         return writer.toByteArray();
     }
 
-    public static class ClassInfo {
-        org.objectweb.asm.Type type;
-        String[] interfaces;
-
-        ClassInfo() { }
-    }
-
-
     public class SherlockClassVisitor extends ClassVisitor {
-
-        private final ClassInfo mClassInfo = new ClassInfo();
-
-        public void visit(
-            int version,
-            int access,
-            String className,
-            String signature,
-            String superName,
-            String[] interfaces
-        ) {
-            super.visit(version, access, className, signature, superName, interfaces);
-
-            mClassInfo.type = Type.getObjectType(className);
-            mClassInfo.interfaces = interfaces;
-        }
-
-
         SherlockClassVisitor(ClassVisitor cv) {
-            super(ASM6, cv);
-            this.cv = cv;
+            super(Opcodes.ASM5, cv);
         }
 
         @Override
@@ -65,49 +35,44 @@ public MethodVisitor visitMethod(
             String signature,
             String[] exceptions
         ) {
-            MethodVisitor mv = cv.visitMethod(access, name, desc, signature, exceptions);
-            return new SherlockMethodVisitor(api, mv, access, name, desc);
-        }
-
-        public void visitInnerClass(String name, String outerName, String innerName, int access) {
-            super.visitInnerClass(name, outerName, innerName, access);
-        }
-
-        public void visitEnd() {
-            super.visitEnd();
+            if (name.equals("build")) {
+                System.out.println("Will do the builder here ... ");
+                return new SherlockMethodVisitor(super.visitMethod(
+                    access,
+                    name,
+                    desc,
+                    signature,
+                    exceptions
+                ));
+            }
+            return super.visitMethod(access, name, desc, signature, exceptions);
         }
     }
 
-    static class SherlockMethodVisitor extends AdviceAdapter {
 
-        SherlockMethodVisitor(int api, MethodVisitor mv, int access, String name, String desc) {
-            super(api, mv, access, name, desc);
+    private static class SherlockMethodVisitor extends MethodVisitor {
+        SherlockMethodVisitor(MethodVisitor mv) {
+            super(Opcodes.ASM5, mv);
         }
 
-        public void visitMethodInsn(int opcode, String owner, String name, String desc, boolean itf) {
-            switch (name) {
-                case "execute":
-                    mv.visitMethodInsn(
-                        INVOKESTATIC,
-                        "com/shehabic/sherlock/interceptors/SherlockOkHttpInterceptor",
-                        "execute",
-                        "(Lokhttp3/Call;)Lokhttp3/Response;",
-                        false
-                    );
-                    break;
-                case "enqueue":
-                    mv.visitMethodInsn(
-                        INVOKESTATIC,
-                        "com/shehabic/sherlock/interceptors/SherlockOkHttpInterceptor",
-                        "enqueue",
-                        "(Lokhttp3/Call;Lokhttp3/Callback;)V",
-                        false
-                    );
-                    break;
-                default:
-                    super.visitMethodInsn(opcode, owner, name, desc, itf);
-                    break;
-            }
+        // This method will be called before almost all instructions
+        @Override
+        public void visitCode() {
+            // Puts 'this' on top of the stack. If your method is static just delete it
+            visitVarInsn(Opcodes.ALOAD, 0);
+            // Takes instance of class "the/full/name/of/your/Class" from top of the stack and put value of field interceptors
+            // "Ljava/util/List;" is just internal name of java.util.List
+            visitFieldInsn(Opcodes.GETFIELD, "okhttp3/OkHttpClient$Builder", "interceptors", "Ljava/util/List;");
+            // Before we call add method of list we have to put target value on top of the stack
+            visitTypeInsn(Opcodes.NEW, "com/shehabic/sherlock/interceptors/SherlockOkHttpInterceptor");
+            visitInsn(Opcodes.DUP);
+            // We have to call classes constructor
+            // Internal name of constructor - <init>
+            // ()V - signature of method. () - method doesn't have parameters. V - method returns void
+            visitMethodInsn(Opcodes.INVOKESPECIAL, "com/shehabic/sherlock/interceptors/SherlockOkHttpInterceptor", "<init>", "()V", false);
+            // So on top of the stack we have initialized instance of com/shehabic/sherlock/interceptors/SherlockOkHttpInterceptor
+            // Now we can put it into list
+            visitMethodInsn(Opcodes.INVOKEINTERFACE, "java/util/List", "add", "(Ljava/lang/Object;)Z", true);
         }
     }
 }

sherlock-plugin/src/main/java/com/shehabic/sherlock/plugin/SherlockInstrumentation.java

@@ -4,6 +4,8 @@
 import com.google.common.io.ByteStreams;
 import com.google.common.io.Files;
 
+import org.apache.commons.io.FileUtils;
+
 import java.io.BufferedInputStream;
 import java.io.File;
 import java.io.FileInputStream;
@@ -14,16 +16,14 @@
 import java.util.jar.JarEntry;
 import java.util.jar.JarInputStream;
 
-import org.apache.commons.io.FileUtils;
+class SherlockInstrumentation {
 
-public class SherlockInstrumentation {
-    ClassLoader classLoader;
+    private static final String CLASS_TO_INSTRUMENT = "okhttp3/OkHttpClient$Builder";
 
-    public SherlockInstrumentation(ClassLoader cl) {
-        this.classLoader = cl;
+    SherlockInstrumentation(ClassLoader cl) {
     }
 
-    public void instrumentClassesInDir(
+    void instrumentClassesInDir(
         final File dir,
         int depth,
         String outDir,
@@ -41,16 +41,7 @@ public void instrumentClassesInDir(
                     if (file.isDirectory()) {
                         ++depth;
                         String fileName = file.getName();
-                        this.instrumentClassesInDir(
-                            file,
-                            depth,
-                            (
-                                new StringBuilder(1 +
-                                    String.valueOf(outDir).length() +
-                                    String.valueOf(fileName).length())
-                            ).append(outDir).append(fileName).append("/").toString(),
-                            changed
-                        );
+                        this.instrumentClassesInDir(file, depth, outDir + fileName + "/", changed);
                     } else if (dirName.endsWith(".class")) {
                         String outputDir = String.valueOf(outDir);
                         String fileName = dirName;
@@ -69,12 +60,7 @@ public void instrumentClassesInDir(
         }
     }
 
-    public void instrumentClassFile(
-        final File f,
-        String outDir,
-        Map<File, Status> changed
-    ) throws IOException {
-        String filename = String.valueOf(f);
+    private void instrumentClassFile(final File f, String outDir, Map<File, Status> changed) throws IOException {
         File outFile = new File(outDir);
         outFile.getParentFile().mkdirs();
         outFile.createNewFile();
@@ -87,46 +73,43 @@ public void instrumentClassFile(
         }
 
         InputStream is = new BufferedInputStream(new FileInputStream(f));
-        byte[] fileBytes = ByteStreams.toByteArray(is);
+//        byte[] fileBytes = ByteStreams.toByteArray(is);
         is.close();
 
-        try {
-            byte[] out = this.instrument(fileBytes);
-            FileOutputStream fos = new FileOutputStream(outFile);
-            fos.write(out);
-            fos.close();
-        } catch (Exception e1) {
-            System.out.print("Error here ----------->");
-            e1.printStackTrace();
-        }
+        Files.copy(f, outFile);
+//        try {
+//            byte[] out = this.instrument(fileBytes);
+//            FileOutputStream fos = new FileOutputStream(outFile);
+//            fos.write(out);
+//            fos.close();
+//        } catch (Exception e) {
+//            System.out.print("[Sherlock Plugin Error]: " + e.getLocalizedMessage());
+//            e.printStackTrace();
+//            Files.copy(f, outFile);
+//        }
 
     }
 
-    public void instrumentClassesInJar(File inJarFile, File outDir) throws IOException {
-        JarInputStream jis = new JarInputStream(new BufferedInputStream(new FileInputStream(
-            inJarFile)));
+    void instrumentClassesInJar(File inJarFile, File outDir) throws IOException {
+        JarInputStream jis = new JarInputStream(new BufferedInputStream(new FileInputStream(inJarFile)));
 
         JarEntry inEntry;
         while ((inEntry = jis.getNextJarEntry()) != null) {
             String name = inEntry.getName();
             byte[] entryBytes = ByteStreams.toByteArray(jis);
             jis.closeEntry();
-            if (name.endsWith(".class") && this.checkIfInstrumentable(name)) {
+            if (name.endsWith(".class") && this.isInstrumentable(name)) {
                 try {
                     entryBytes = this.instrument(entryBytes);
                 } catch (Exception e) {
-
+                    System.out.println("[Sherlock Plugin Error]: " + e.getLocalizedMessage());
                     e.printStackTrace();
                 }
             }
 
             if (!inEntry.isDirectory()) {
                 String var8 = String.valueOf(outDir);
-                File outFile = new File((
-                    new StringBuilder(1 +
-                        String.valueOf(var8).length() +
-                        String.valueOf(name).length())
-                ).append(var8).append("/").append(name).toString());
+                File outFile = new File(var8 + "/" + name);
                 outFile.getParentFile().mkdirs();
                 outFile.createNewFile();
                 FileOutputStream fos = new FileOutputStream(outFile);
@@ -138,11 +121,11 @@ public void instrumentClassesInJar(File inJarFile, File outDir) throws IOExcepti
         jis.close();
     }
 
-    public boolean checkIfInstrumentable(String name) {
-        return name.startsWith("okhttp3/Call");
+    private boolean isInstrumentable(String name) {
+        return name.startsWith(CLASS_TO_INSTRUMENT);
     }
 
-    public byte[] instrument(final byte[] in) {
+    private byte[] instrument(final byte[] in) {
         SherlockClassWriter cw = new SherlockClassWriter();
 
         return cw.instrument(in);

sherlock-plugin/src/main/java/com/shehabic/sherlock/plugin/SherlockPlugin.java

@@ -1,19 +1,21 @@
 package com.shehabic.sherlock.plugin;
 
-import com.android.build.gradle.internal.dsl.BaseAppModuleExtension;
-
+import com.android.build.gradle.BaseExtension;
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
 
 class SherlockPlugin implements Plugin<Project> {
     @Override
     public void apply(Project project) {
-        Object ext = project.getExtensions().findByName("android");
-        BaseAppModuleExtension androidExt = (BaseAppModuleExtension) ext;
-        if (androidExt != null) {
-            androidExt.registerTransform(new SherlockTransformer(project));
+        BaseExtension androidExt = (BaseExtension) project.getExtensions().getByName("android");
+
+        if (project.getPlugins().findPlugin("com.android.application") != null) {
             project.getExtensions().create("SherlockExtension", SherlockExtension.class);
+            androidExt.registerTransform(new SherlockTransformer(project));
+        } else if (project.getPlugins().findPlugin("com.android.library") != null) {
+            throw new RuntimeException("Sherlock cannot be applied to library project", null);
         } else {
+            throw new RuntimeException("Need android application plugin to be applied first", null);
         }
     }
 }