Skip to content

Commit

Permalink
Merge pull request #84 from applivery/develop
Browse files Browse the repository at this point in the history
Develop
  • Loading branch information
imablanco authored Dec 23, 2024
2 parents f34c013 + cdd3b53 commit 07cbcc5
Show file tree
Hide file tree
Showing 3 changed files with 104 additions and 1 deletion.
1 change: 1 addition & 0 deletions applvsdklib/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ android {
defaultConfig {
minSdkVersion versions.minSdk
targetSdkVersion versions.targetSdk
consumerProguardFiles 'consumer-rules.pro'

buildConfigField "Boolean", "CHECK_FOR_UPDATES_BACKGROUND", 'false'

Expand Down
102 changes: 102 additions & 0 deletions applvsdklib/consumer-rules.pro
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
-dontwarn org.bouncycastle.jsse.BCSSLParameters
-dontwarn org.bouncycastle.jsse.BCSSLSocket
-dontwarn org.bouncycastle.jsse.provider.BouncyCastleJsseProvider
-dontwarn org.conscrypt.Conscrypt$Version
-dontwarn org.conscrypt.Conscrypt
-dontwarn org.conscrypt.ConscryptHostnameVerifier
-dontwarn org.openjsse.javax.net.ssl.SSLParameters
-dontwarn org.openjsse.javax.net.ssl.SSLSocket
-dontwarn org.openjsse.net.ssl.OpenJSSE

##---------------Begin: Gson ----------

# For using GSON @Expose annotation
-keepattributes *Annotation*

# Gson specific classes
-dontwarn sun.misc.**
#-keep class com.google.gson.stream.** { *; }

# Prevent proguard from stripping interface information from TypeAdapter, TypeAdapterFactory,
# JsonSerializer, JsonDeserializer instances (so they can be used in @JsonAdapter)
-keep class * extends com.google.gson.TypeAdapter
-keep public class * implements java.lang.reflect.Type
-keep class * implements com.google.gson.TypeAdapterFactory
-keep class * implements com.google.gson.JsonSerializer
-keep class * implements com.google.gson.JsonDeserializer

# Prevent R8 from leaving Data object members always null
-keepclasseswithmembers,allowobfuscation,includedescriptorclasses class * {

This comment has been minimized.

Copy link
@benjaminRomano

benjaminRomano Dec 24, 2024

@imablanco IIRC, this will actually end up keeping a lot of extra code.

I had worked with R8 in the past to create better Gson keep rules that are now embedded directly within Gson:
https://github.com/google/gson/blob/84e5f16acafaa7c55d80a3621a37c7884ca928b6/gson/src/main/resources/META-INF/proguard/gson.pro#L57 (More context).

This generally is enough to ensure that GSON serialized classes are not stripped out by R8.

The issue I initally faced was that the generic here is stripped out by Retrofit.

Retrofit has these proguard keep rules to ensure the generics for their own classes don't get stripped out:

# 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,allowobfuscation,allowshrinking class okhttp3.RequestBody
-keep,allowobfuscation,allowshrinking class okhttp3.ResponseBody

but this will only prevent ServerResponse from being stripped out but not ServerResponse<T> here:


// generic will be stripped out here without proguard rules
suspend fun obtainAppConfig(): ServerResponse<ApiAppConfig>

// Retrofit proguard rules only ensure `Call<ServerResponse>` is preserved and not `Call<ServerResponse<ApiBuildToken>>` is preserved.
fun obtainBuildToken(@Path("build_id") buildId: String): Call<ServerResponse<ApiBuildToken>>

this should be solvable with just this keep rule:

-keep,allowobfuscation,allowshrinking com.applivery.data.response.ServerResponse

This didn't work for me due to what I suspect are R8 bugs so I just went with the broader rules here:

-keep class com.applivery.data.response.** { *; }
-keep class com.applivery.data.request.** { *; }

this tells R8 not to remove any fields or generics from the network request / response classes. This is conservative in that it will keep more code than is probably necessary, but this is fine for us since we don't ship this code in production and the app size hit even if we did would be negligible (probably <1KB)

@com.google.gson.annotations.SerializedName <fields>;
}

# Retain generic signatures of TypeToken and its subclasses with R8 version 3.0 and higher.
-keep,allowobfuscation,allowshrinking class com.google.gson.reflect.TypeToken
-keep,allowobfuscation,allowshrinking class * extends com.google.gson.reflect.TypeToken

##---------------End: Gson ----------

##---------------Begin: Retrofit 2.X ----------
# Retrofit does reflection on generic parameters. InnerClasses is required to use Signature and
# EnclosingMethod is required to use InnerClasses.
-keepattributes Signature, InnerClasses, EnclosingMethod

# Retrofit does reflection on method and parameter annotations.
-keepattributes RuntimeVisibleAnnotations, RuntimeVisibleParameterAnnotations

# Keep annotation default values (e.g., retrofit2.http.Field.encoded).
-keepattributes AnnotationDefault

# Retain service method parameters when optimizing.
-keepclassmembers,allowshrinking,allowobfuscation interface * {
@retrofit2.http.* <methods>;
}

# Ignore annotation used for build tooling.
-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement

# Ignore JSR 305 annotations for embedding nullability information.
-dontwarn javax.annotation.**

# Guarded by a NoClassDefFoundError try/catch and only used when on the classpath.
-dontwarn kotlin.Unit

# Top-level functions that can only be used by Kotlin.
-dontwarn retrofit2.KotlinExtensions
-dontwarn retrofit2.KotlinExtensions$*

# With R8 full mode, it sees no subtypes of Retrofit interfaces since they are created with a Proxy
# and replaces all potential values with null. Explicitly keeping the interfaces prevents this.
-if interface * { @retrofit2.http.* <methods>; }
-keep,allowobfuscation interface <1>
-if interface * { @retrofit2.http.* public *** *(...); }
-keep,allowoptimization,allowshrinking,allowobfuscation class <3>

# 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,allowobfuscation,allowshrinking class okhttp3.RequestBody
-keep,allowobfuscation,allowshrinking class okhttp3.ResponseBody

# 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.** { *; }
##---------------Begin: Retrofit 2.X ----------

##---------------Begin: OKHttp ----------
-keep class okhttp3.** { *; }
-keep interface okhttp3.** { *; }
-dontwarn retrofit2.**
-dontwarn okhttp3.**

-keepclasseswithmembers class * {
@retrofit2.http.* <methods>;
}
##---------------End: OKHttp ----------

##---------------Begin: Okio ----------
-dontwarn java.nio.file.*
-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement
-dontwarn okio.**
##---------------End: Okio ----------
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,5 @@ apply from: "${rootDir}/scripts/publish-root.gradle"

ext {
PUBLISH_GROUP_ID = 'com.applivery'
PUBLISH_VERSION = '3.8.1'
PUBLISH_VERSION = '3.8.2'
}

0 comments on commit 07cbcc5

Please sign in to comment.