Merge pull request #627 from nimblehq/feature/570-add-pre-release-build-type-to-distribute-release-build-with-chucker

[#570] Add preRelease build type to distribute release build with Chucker

Author: hoangnguyen92dn

.cicdtemplate/.github/workflows/deploy_staging_and_production_to_firebase_app_distribution.yml

@@ -57,23 +57,23 @@ jobs:
           path: app/build/reports/kover/
 
       - name: Build staging APK
-        run: ./gradlew assembleStagingDebug
+        run: ./gradlew assembleStagingPreRelease
 
       - name: Deploy staging to Firebase
         uses: wzieba/Firebase-Distribution-Github-Action@v1
         with:
           appId: ${{secrets.FIREBASE_APP_ID_STAGING}}
           serviceCredentialsFileContent: ${{ secrets.FIREBASE_SERVICE_ACCOUNT_CREDENTIAL_FILE_CONTENT }}
           groups: testers
-          file: app/build/outputs/apk/staging/debug/app-staging-debug.apk
+          file: app/build/outputs/apk/staging/preRelease/app-staging-preRelease.apk
 
       - name: Build production APK
-        run: ./gradlew assembleProductionDebug
+        run: ./gradlew assembleProductionPreRelease
 
       - name: Deploy production to Firebase
         uses: wzieba/Firebase-Distribution-Github-Action@v1
         with:
           appId: ${{secrets.FIREBASE_APP_ID_PRODUCTION}}
           serviceCredentialsFileContent: ${{ secrets.FIREBASE_SERVICE_ACCOUNT_CREDENTIAL_FILE_CONTENT }}
           groups: testers
-          file: app/build/outputs/apk/production/debug/app-production-debug.apk
+          file: app/build/outputs/apk/production/preRelease/app-production-preRelease.apk

sample-compose/app/build.gradle.kts

@@ -49,6 +49,10 @@ android {
             buildConfigField("String", "BASE_API_URL", "\"https://jsonplaceholder.typicode.com/\"")
         }
 
+        create(BuildType.PRERELEASE) {
+            initWith(getByName(BuildType.RELEASE))
+        }
+
         getByName(BuildType.DEBUG) {
             // For quickly testing build with proguard, enable this
             isMinifyEnabled = false
@@ -139,6 +143,7 @@ dependencies {
     implementation(libs.kotlinx.collections.immutable)
 
     debugImplementation(libs.chucker)
+    preReleaseImplementation(libs.chucker)
     releaseImplementation(libs.chucker.noOp)
 
     // Unit test

sample-compose/app/proguard-rules.pro

@@ -19,7 +19,3 @@
 # If you keep the line number information, uncomment this to
 # hide the original source file name.
 #-renamesourcefileattribute SourceFile
-
-# Data class
--keepclassmembers class co.nimblehq.sample.compose.data.remote.models.requests.** { *; }
--keepclassmembers class co.nimblehq.sample.compose.data.remote.models.responses.** { *; }

sample-compose/app/src/main/java/co/nimblehq/sample/compose/di/modules/OkHttpClientModule.kt

@@ -13,6 +13,7 @@ import okhttp3.logging.HttpLoggingInterceptor
 import java.util.concurrent.*
 
 private const val READ_TIME_OUT = 30L
+private const val BUILD_TYPE_RELEASE = "release"
 
 @Module
 @InstallIn(SingletonComponent::class)
@@ -22,7 +23,7 @@ class OkHttpClientModule {
     fun provideOkHttpClient(
         chuckerInterceptor: ChuckerInterceptor
     ) = OkHttpClient.Builder().apply {
-        if (BuildConfig.DEBUG) {
+        if (!BuildConfig.BUILD_TYPE.equals(BUILD_TYPE_RELEASE, ignoreCase = true)) {
             addInterceptor(HttpLoggingInterceptor().apply {
                 level = HttpLoggingInterceptor.Level.BODY
             })

sample-compose/buildSrc/src/main/java/Configurations.kt

@@ -6,5 +6,6 @@ object Flavor {
 
 object BuildType {
     const val DEBUG = "debug"
+    const val PRERELEASE = "preRelease"
     const val RELEASE = "release"
 }

sample-compose/buildSrc/src/main/java/DependencyHandlerExt.kt

@@ -0,0 +1,5 @@
+import org.gradle.api.artifacts.Dependency
+import org.gradle.api.artifacts.dsl.DependencyHandler
+
+fun DependencyHandler.preReleaseImplementation(dependencyNotation: Any): Dependency? =
+    add("preReleaseImplementation", dependencyNotation)

sample-compose/data/build.gradle.kts

@@ -15,10 +15,12 @@ android {
 
     buildTypes {
         getByName(BuildType.RELEASE) {
-            isMinifyEnabled = true
-            proguardFiles(
-                getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro"
-            )
+            isMinifyEnabled = false
+            consumerProguardFiles("consumer-rules.pro")
+        }
+
+        create(BuildType.PRERELEASE) {
+            initWith(getByName(BuildType.RELEASE))
         }
 
         getByName(BuildType.DEBUG) {
@@ -59,6 +61,10 @@ dependencies {
     api(libs.bundles.moshi)
     implementation(libs.moshi)
 
+    debugImplementation(libs.chucker)
+    preReleaseImplementation(libs.chucker)
+    releaseImplementation(libs.chucker.noOp)
+
     // Testing
     testImplementation(libs.bundles.unitTest)
     testImplementation(libs.test.core.ktx)

sample-compose/data/consumer-rules.pro

@@ -0,0 +1,32 @@
+# RETROFIT https://square.github.io/retrofit/
+# R8 full mode https://github.com/square/retrofit/issues/3751#issuecomment-1192043644
+# Keep generic signature of Call, Response (R8 full mode strips signatures from non-kept items).
+-keep,allowobfuscation,allowshrinking interface retrofit2.Call
+-keep,allowobfuscation,allowshrinking class retrofit2.Response
+# Keep classes for NewRelic instrumentation
+# https://docs.newrelic.com/docs/mobile-monitoring/new-relic-mobile-android/install-configure/configure-proguard-or-dexguard-android-apps/#proguard-library
+-keep class retrofit2.** { *; }
+-dontwarn retrofit2.**
+# To enable the workaround in the [RetrofitDynamicBaseUrlBinder]
+-keep class retrofit2.Retrofit { *; }
+-keep class okhttp3.HttpUrl { *; }
+
+# With R8 full mode generic signatures are stripped for classes that are not
+# kept. Suspend functions are wrapped in continuations where the type argument
+# is used.
+-keep,allowobfuscation,allowshrinking class kotlin.coroutines.Continuation
+
+# MOSHI https://github.com/square/moshi/tree/master?tab=readme-ov-file#r8--proguard
+
+# OKHTTP https://square.github.io/okhttp/features/r8_proguard/
+# Keep classes for NewRelic instrumentation
+# https://docs.newrelic.com/docs/mobile-monitoring/new-relic-mobile-android/install-configure/configure-proguard-or-dexguard-android-apps/#proguard-library
+-keep class okhttp3.** { *; }
+-dontwarn okhttp3.**
+-dontwarn okio.**
+# To enable the workaround in the [RequestInterceptor] for [NewRelic.addHTTPHeadersTrackingFor]
+-keep class okhttp3.Headers { *; }
+
+# Moshi's models https://medium.com/androiddevelopers/practical-proguard-rules-examples-5640a3907dc9
+-keep class co.nimblehq.sample.compose.data.remote.models.requests.** { *; }
+-keep class co.nimblehq.sample.compose.data.remote.models.responses.** { *; }

sample-compose/data/proguard-rules.pro

@@ -1,21 +1,5 @@
-# Add project specific ProGuard rules here.
-# You can control the set of applied configuration files using the
-# proguardFiles setting in build.gradle.kts.
+# ProGuard rules for data module
 #
-# For more details, see
-#   http://developer.android.com/guide/developing/tools/proguard.html
-
-# If your project uses WebView with JS, uncomment the following
-# and specify the fully qualified class name to the JavaScript interface
-# class:
-#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
-#   public *;
-#}
-
-# Uncomment this to preserve the line number information for
-# debugging stack traces.
-#-keepattributes SourceFile,LineNumberTable
-
-# If you keep the line number information, uncomment this to
-# hide the original source file name.
-#-renamesourcefileattribute SourceFile
+# Note: This module has minification disabled (isMinifyEnabled = false).
+# All ProGuard rules for this module are defined in consumer-rules.pro,
+# which is automatically applied to consuming modules (app) during their minification.

sample-compose/data/src/main/java/co/nimblehq/sample/compose/data/extensions/ResponseMapping.kt

@@ -29,9 +29,9 @@ private fun Throwable.mapError(): Throwable {
         is HttpException -> {
             val errorResponse = parseErrorResponse(response())
             ApiException(
-                errorResponse?.toModel(),
-                code(),
-                message()
+                error = errorResponse?.toModel(),
+                httpCode = code(),
+                httpMessage = message()
             )
         }
         else -> this
@@ -44,9 +44,9 @@ private fun parseErrorResponse(response: Response<*>?): ErrorResponse? {
         val moshi = MoshiBuilderProvider.moshiBuilder.build()
         val adapter = moshi.adapter(ErrorResponse::class.java)
         adapter.fromJson(jsonString.orEmpty())
-    } catch (exception: IOException) {
+    } catch (_: IOException) {
         null
-    } catch (exception: JsonDataException) {
+    } catch (_: JsonDataException) {
         null
     }
 }