Add consumer proguard rules to prevent minification

markmur · markmur · commit dd24027327f0 · 2024-11-04T09:24:17.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 3.1.2 - November 4, 2024
+
+- Add `consumerProguardRules` build.gradle option to prevent minification of
+  classes in release builds.
+
 ## 3.1.1 - November 1, 2024
 
 - Logs invalid JSON for lifecycle events
diff --git a/modules/@shopify/checkout-sheet-kit/android/build.gradle b/modules/@shopify/checkout-sheet-kit/android/build.gradle
@@ -60,8 +60,16 @@ android {
   }
 
   buildTypes {
+    debug {
+      minifyEnabled true
+      // consumerProguardFiles 'proguard-rules.pro'
+    }
+
     release {
-      minifyEnabled false
+      minifyEnabled true
+
+      // Rules in consumerProguardFiles are automatically included in the ProGuard configuration of any application that uses the library
+      // consumerProguardFiles 'proguard-rules.pro'
     }
   }
 
diff --git a/modules/@shopify/checkout-sheet-kit/android/proguard-rules.pro b/modules/@shopify/checkout-sheet-kit/android/proguard-rules.pro
@@ -0,0 +1,12 @@
+# Keep the ObjectMapper and its methods
+-keep class com.fasterxml.jackson.databind.ObjectMapper { *; }
+
+# Keep Checkout Sheet Kit classes
+-keep class com.shopify.checkoutsheetkit.lifecycleevents.CheckoutCompletedEvent { *; }
+-keep class com.shopify.checkoutsheetkit.pixelevents.PixelEvent { *; }
+-keep class com.shopify.checkoutsheetkit.CheckoutException { *; }
+-keep class com.shopify.checkoutsheetkit.CheckoutExpiredException { *; }
+-keep class com.shopify.checkoutsheetkit.ClientException { *; }
+-keep class com.shopify.checkoutsheetkit.HttpException { *; }
+-keep class com.shopify.checkoutsheetkit.ConfigurationException { *; }
+-keep class com.shopify.checkoutsheetkit.CheckoutSheetKitException { *; }
diff --git a/modules/@shopify/checkout-sheet-kit/package.json b/modules/@shopify/checkout-sheet-kit/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@shopify/checkout-sheet-kit",
   "license": "MIT",
-  "version": "3.1.1",
+  "version": "3.1.2",
   "main": "lib/commonjs/index.js",
   "types": "src/index.ts",
   "source": "src/index.ts",
diff --git a/sample/android/app/build.gradle b/sample/android/app/build.gradle
@@ -53,11 +53,6 @@ react {
      hermesFlags = ["-O", "-output-source-map"]
 }
 
-/**
- * Set this to true to Run Proguard on Release builds to minify the Java bytecode.
- */
-def enableProguardInReleaseBuilds = false
-
 /**
  * The preferred build flavor of JavaScriptCore (JSC)
  *
@@ -115,8 +110,8 @@ android {
     }
     release {
       signingConfig signingConfigs.release
-      minifyEnabled enableProguardInReleaseBuilds
-      proguardFiles getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro"
+      minifyEnabled true
+      proguardFiles "proguard-rules.pro"
     }
   }
 }
diff --git a/sample/ios/Podfile.lock b/sample/ios/Podfile.lock
@@ -1235,7 +1235,7 @@ PODS:
     - ReactCommon/turbomodule/bridging
     - ReactCommon/turbomodule/core
     - Yoga
-  - RNShopifyCheckoutSheetKit (3.1.0):
+  - RNShopifyCheckoutSheetKit (3.1.1):
     - React-Core
     - ShopifyCheckoutSheetKit (~> 3.1.1)
   - RNVectorIcons (10.0.3):
@@ -1524,7 +1524,7 @@ SPEC CHECKSUMS:
   RNGestureHandler: 9b113eb9b7a4cbe66e1dbf4d9914281863ee0703
   RNReanimated: d534e0114e2c3e7011550a78ecf2d0b431435a60
   RNScreens: 23dad53fc9db1da2c93e647ae33fd7ce2bd49d60
-  RNShopifyCheckoutSheetKit: 3d854ed7fe1bc96eab4718819ee79d33488066bc
+  RNShopifyCheckoutSheetKit: 0fb6aa9fe539a331f313d8e009ecb1917fc6c103
   RNVectorIcons: 50ea777efffdd991a22e968aa312d75da7ff46c3
   ShopifyCheckoutSheetKit: fe309799b18b8d554f28c3f075d6d57d4811c9ab
   SocketRocket: abac6f5de4d4d62d24e11868d7a2f427e0ef940d

Original file line number	Diff line number	Diff line change
`@@ -60,8 +60,16 @@ android {`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`buildTypes {`
	`63`	`+ debug {`
	`64`	`+ minifyEnabled true`
	`65`	`+ // consumerProguardFiles 'proguard-rules.pro'`
	`66`	`+ }`
	`67`	`+`
`63`	`68`	`release {`
`64`		`- minifyEnabled false`
	`69`	`+ minifyEnabled true`
	`70`	`+`
	`71`	`+ // Rules in consumerProguardFiles are automatically included in the ProGuard configuration of any application that uses the library`
	`72`	`+ // consumerProguardFiles 'proguard-rules.pro'`
`65`	`73`	`}`
`66`	`74`	`}`
`67`	`75`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@shopify/checkout-sheet-kit",`
`3`	`3`	`"license": "MIT",`
`4`		`- "version": "3.1.1",`
	`4`	`+ "version": "3.1.2",`
`5`	`5`	`"main": "lib/commonjs/index.js",`
`6`	`6`	`"types": "src/index.ts",`
`7`	`7`	`"source": "src/index.ts",`
Original file line number	Diff line number	Diff line change
`@@ -53,11 +53,6 @@ react {`
`53`	`53`	`hermesFlags = ["-O", "-output-source-map"]`
`54`	`54`	`}`
`55`	`55`
`56`		`-/**`
`57`		`- * Set this to true to Run Proguard on Release builds to minify the Java bytecode.`
`58`		`- */`
`59`		`-def enableProguardInReleaseBuilds = false`
`60`		`-`
`61`	`56`	`/**`
`62`	`57`	`* The preferred build flavor of JavaScriptCore (JSC)`
`63`	`58`	`*`
`@@ -115,8 +110,8 @@ android {`
`115`	`110`	`}`
`116`	`111`	`release {`
`117`	`112`	`signingConfig signingConfigs.release`
`118`		`- minifyEnabled enableProguardInReleaseBuilds`
`119`		`- proguardFiles getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro"`
	`113`	`+ minifyEnabled true`
	`114`	`+ proguardFiles "proguard-rules.pro"`
`120`	`115`	`}`
`121`	`116`	`}`
`122`	`117`	`}`