Enable minification and add proguard configs

All apk producing modules now have minification enabled. Code that is exposed to different modules is now being kept by a proguard.pro file within the base directory of each project.
googlearchive · Dec 13, 2017 · b78449c · b78449c
1 parent 9695094
commit b78449c
Show file tree

Hide file tree

Showing 57 changed files with 421 additions and 89 deletions.
diff --git a/README.md b/README.md
@@ -65,6 +65,27 @@ adb shell am start -a android.intent.action.VIEW -c android.intent.category.BROW
 cd - # takes you back to the root directory
 ```
 
+### Code minification & obfuscation
+
+Each sample's `minified` build type has code minification enabled.
+In case API surfaces are being exposed to other modules, these surfaces are being explicitly excluded from
+the obfuscation process through a proguard configuration file.
+Take a look in a module's `build.gradle` file to see what is being done for that module.
+
+#### Usage
+
+From Android Studio
+ * Open Build Variants
+ * Change each variant to a "minified" variant
+ * Run the "instant" configuration of the sample
+
+From the command line
+ * Assemble a minified build `./gradlew assembleMinified`
+ * Navigate to `instant/build/outputs/apk/*/minified`
+ * Run the instant app as described in the above section
+
+Note: For samples containing flavors the paths & variant names will be slightly different.
+
 ### Troubleshooting
 
 Refer to the [troubleshooting section](https://developer.android.com/topic/instant-apps/troubleshoot.html)

diff --git a/analytics/base/build.gradle b/analytics/base/build.gradle
@@ -28,8 +28,18 @@ android {
         versionCode rootProject.versionCode
         versionName rootProject.versionName
     }
+
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
-        release {}
+        minified {
+            debuggable true
+            minifyEnabled true
+            signingConfig signingConfigs.debug
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), '../proguard.pro'
+        }
+        debug {}
     }
 }
 

diff --git a/analytics/feature/build.gradle b/analytics/feature/build.gradle
@@ -27,8 +27,17 @@ android {
 
         testInstrumentationRunner 'android.support.test.runner.AndroidJUnitRunner'
     }
+
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
-        release {}
+        minified {
+            debuggable true
+            minifyEnabled true
+            signingConfig signingConfigs.debug
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), '../proguard.pro'
+        }
         debug {}
     }
 

diff --git a/analytics/installed/build.gradle b/analytics/installed/build.gradle
@@ -29,8 +29,18 @@ android {
         versionName rootProject.versionName
 
     }
+
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
-        release {}
+        minified {
+            debuggable true
+            minifyEnabled true
+            signingConfig signingConfigs.debug
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), '../proguard.pro'
+        }
+        debug {}
     }
 }
 

diff --git a/analytics/proguard.pro b/analytics/proguard.pro
@@ -0,0 +1,9 @@
+-keep class android.support.v7.app.AppCompatActivity {
+  public void onCreate(...);
+}
+-keep class com.google.firebase.analytics.FirebaseAnalytics {
+  public protected *;
+}
+-keep class com.google.android.instantapps.InstantApps {
+  public boolean isInstantApp(...);
+}
diff --git a/configuration-apks/features/build.gradle b/configuration-apks/features/build.gradle
@@ -42,7 +42,16 @@ android {
         }
     }
 
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
+        minified {
+            debuggable true
+            minifyEnabled true
+            signingConfig signingConfigs.debug
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), '../proguard.pro'
+        }
         debug {}
     }
 

diff --git a/configuration-apks/installed/build.gradle b/configuration-apks/installed/build.gradle
@@ -31,7 +31,16 @@ android {
         missingDimensionStrategy 'delivery', 'installed'
     }
 
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
+        minified {
+            debuggable true
+            signingConfig signingConfigs.debug
+            minifyEnabled true
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), '../proguard.pro'
+        }
         debug {}
     }
 }

diff --git a/configuration-apks/instant/build.gradle b/configuration-apks/instant/build.gradle
@@ -26,6 +26,7 @@ android {
     }
 
     buildTypes {
+        minified {}
         debug {}
     }
 }

diff --git a/configuration-apks/proguard.pro b/configuration-apks/proguard.pro
@@ -0,0 +1,3 @@
+-keep class android.support.v7.app.AppCompatActivity {
+    public void onCreate(...);
+}
diff --git a/cookie-api/features/base/build.gradle b/cookie-api/features/base/build.gradle
@@ -33,6 +33,7 @@ android {
         playServices {
             // Demonstrates usage of the Cookie API with APILevel < 26
             dimension "version"
+            proguardFiles '../../proguard-playservices.pro'
         }
         framework {
             dimension "version"
@@ -41,8 +42,16 @@ android {
         }
     }
 
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
-        release {}
+        minified {
+            debuggable true
+            minifyEnabled true
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), '../../proguard.pro'
+            signingConfig signingConfigs.debug
+        }
         debug {}
     }
 

diff --git a/cookie-api/features/cookie/build.gradle b/cookie-api/features/cookie/build.gradle
@@ -30,8 +30,15 @@ android {
         testInstrumentationRunner 'android.support.test.runner.AndroidJUnitRunner'
     }
 
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
-        release {}
+        minified {
+            debuggable true
+            minifyEnabled true
+            signingConfig signingConfigs.debug
+        }
         debug {}
     }
 

diff --git a/cookie-api/installed/build.gradle b/cookie-api/installed/build.gradle
@@ -29,7 +29,12 @@ android {
     }
 
     buildTypes {
-        release {}
+        minified {
+            debuggable true
+            minifyEnabled true
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), '../proguard.pro'
+            signingConfig signingConfigs.debug
+        }
         debug {}
     }
 

diff --git a/cookie-api/instant/build.gradle b/cookie-api/instant/build.gradle
@@ -28,7 +28,7 @@ android {
     }
 
     buildTypes {
-        release {}
+        minified {}
         debug {}
     }
 

diff --git a/cookie-api/proguard-playservices.pro b/cookie-api/proguard-playservices.pro
@@ -0,0 +1,5 @@
+
+-keep class com.google.android.gms.instantapps.PackageManagerCompat { *; }
+-keep class com.google.android.gms.instantapps.InstantApps {
+    public static *** getPackageManagerCompat(***);
+}
diff --git a/cookie-api/proguard.pro b/cookie-api/proguard.pro
@@ -0,0 +1,3 @@
+-keep class android.support.v7.app.AppCompatActivity {
+    public void onCreate(...);
+}
diff --git a/flavors/features/base/build.gradle b/flavors/features/base/build.gradle
@@ -27,9 +27,17 @@ android {
         versionName rootProject.versionName
     }
 
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
+        minified {
+            debuggable true
+            minifyEnabled true
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), '../../proguard.pro'
+            signingConfig signingConfigs.debug
+        }
         debug {}
-        release {}
     }
 
     flavorDimensions "pricing"

diff --git a/flavors/features/bye/build.gradle b/flavors/features/bye/build.gradle
@@ -29,9 +29,16 @@ android {
         testInstrumentationRunner 'android.support.test.runner.AndroidJUnitRunner'
     }
 
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
+        minified {
+            debuggable true
+            minifyEnabled true
+            signingConfig signingConfigs.debug
+        }
         debug {}
-        release {}
     }
 
     flavorDimensions "pricing"

diff --git a/flavors/features/hello/build.gradle b/flavors/features/hello/build.gradle
@@ -29,9 +29,16 @@ android {
         testInstrumentationRunner 'android.support.test.runner.AndroidJUnitRunner'
     }
 
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
+        minified {
+            debuggable true
+            minifyEnabled true
+            signingConfig signingConfigs.debug
+        }
         debug {}
-        release {}
     }
 
     flavorDimensions "pricing"

diff --git a/flavors/installed/build.gradle b/flavors/installed/build.gradle
@@ -27,11 +27,16 @@ android {
         versionName rootProject.versionName
     }
 
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
-        debug {}
-        release {
-            signingConfig = signingConfigs.debug
+        minified {
+            debuggable true
+            minifyEnabled true
+            signingConfig signingConfigs.debug
         }
+        debug {}
     }
 
     flavorDimensions "pricing"

diff --git a/flavors/instant/build.gradle b/flavors/instant/build.gradle
@@ -27,7 +27,7 @@ android {
         versionName rootProject.versionName
     }
     buildTypes {
-        release {}
+        minified {}
         debug {}
     }
 

diff --git a/flavors/proguard.pro b/flavors/proguard.pro
@@ -0,0 +1,3 @@
+-keep public class android.support.v7.app.AppCompatActivity {
+  public protected *;
+}
diff --git a/hello-feature-module/features/base/build.gradle b/hello-feature-module/features/base/build.gradle
@@ -28,8 +28,17 @@ android {
 
         testInstrumentationRunner 'android.support.test.runner.AndroidJUnitRunner'
     }
+
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
-        release {}
+        minified {
+            debuggable true
+            minifyEnabled true
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), '../../proguard.pro'
+            signingConfig signingConfigs.debug
+        }
         debug {}
     }
 

diff --git a/hello-feature-module/features/bye/build.gradle b/hello-feature-module/features/bye/build.gradle
@@ -27,8 +27,16 @@ android {
 
         testInstrumentationRunner 'android.support.test.runner.AndroidJUnitRunner'
     }
+
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
-        release {}
+        minified {
+            debuggable true
+            minifyEnabled true
+            signingConfig signingConfigs.debug
+        }
         debug {}
     }
 }

diff --git a/hello-feature-module/features/hello/build.gradle b/hello-feature-module/features/hello/build.gradle
@@ -28,8 +28,16 @@ android {
 
         testInstrumentationRunner 'android.support.test.runner.AndroidJUnitRunner'
     }
+
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
-        release {}
+        minified {
+            debuggable true
+            minifyEnabled true
+            signingConfig signingConfigs.debug
+        }
         debug {}
     }
 }

diff --git a/hello-feature-module/installed/build.gradle b/hello-feature-module/installed/build.gradle
@@ -27,8 +27,15 @@ android {
         versionCode rootProject.versionCode
         versionName rootProject.versionName
     }
+
+    // Switch between test types by swapping commented out state
+    testBuildType /* 'debug' */  'minified'
+
     buildTypes {
-        release {}
+        minified {
+            debuggable true
+            minifyEnabled true
+        }
         debug {}
     }
 }

diff --git a/hello-feature-module/instant/build.gradle b/hello-feature-module/instant/build.gradle
@@ -27,7 +27,7 @@ android {
         versionName rootProject.versionName
     }
     buildTypes {
-        release {}
+        minified {}
         debug {}
     }
 }

diff --git a/hello-feature-module/proguard.pro b/hello-feature-module/proguard.pro
@@ -0,0 +1,3 @@
+-keep public class android.support.v7.app.AppCompatActivity {
+  public protected *;
+}