The Android library is crashing when running with release build variant

[balazsbarany]

Describe the bug

After resolving awslabs/aws-crt-java#907, we attempted to finalise the SDK's integration in our consumer-facing application.

However, when running our app using the release build variant (isShrinkResources = true & isMinifyEnabled = true & isDebuggable = false), the app is crashing with the trace below.

Fatal signal 6 (SIGABRT), code -1 (SI_QUEUE) in tid 21676 (DefaultDispatch), pid 12463 ([REDACTED PACKAGE NAME])
Cmdline: [REDACTED PACKAGE NAME]
pid: 12463, tid: 21676, name: DefaultDispatch  >>> [REDACTED PACKAGE NAME] <<<
      #01 pc 0000000000404834  /data/app/~~igC0lzbqE1iO5UHsWaPINg==/[REDACTED PACKAGE NAME]-JveEFSI_YqQbhoZsVwxRGQ==/base.apk!libaws-crt-jni.so (offset 0xac8000) (BuildId: 46630636312ade92f02973b60506c3c6c17b7449)
      #02 pc 00000000001d27c8  /data/app/~~igC0lzbqE1iO5UHsWaPINg==/[REDACTED PACKAGE NAME]-JveEFSI_YqQbhoZsVwxRGQ==/base.apk!libaws-crt-jni.so (offset 0xac8000) (BuildId: 46630636312ade92f02973b60506c3c6c17b7449)
      #04 pc 0000000000410c64  /data/app/~~igC0lzbqE1iO5UHsWaPINg==/[REDACTED PACKAGE NAME]-JveEFSI_YqQbhoZsVwxRGQ==/base.apk!libaws-crt-jni.so (offset 0xac8000) (BuildId: 46630636312ade92f02973b60506c3c6c17b7449)
      #05 pc 00000000001e5040  /data/app/~~igC0lzbqE1iO5UHsWaPINg==/[REDACTED PACKAGE NAME]-JveEFSI_YqQbhoZsVwxRGQ==/base.apk!libaws-crt-jni.so (offset 0xac8000) (Java_software_amazon_awssdk_crt_io_TlsContextOptions_tlsContextOptionsIsAlpnAvailable+8) (BuildId: 46630636312ade92f02973b60506c3c6c17b7449)
      #08 pc 00000000019726e8  /data/app/~~igC0lzbqE1iO5UHsWaPINg==/[REDACTED PACKAGE NAME]-JveEFSI_YqQbhoZsVwxRGQ==/oat/arm64/base.vdex (software.amazon.awssdk.crt.io.TlsContextOptions.v+0)
      #10 pc 000000000116ef52  /data/app/~~igC0lzbqE1iO5UHsWaPINg==/[REDACTED PACKAGE NAME]-JveEFSI_YqQbhoZsVwxRGQ==/oat/arm64/base.vdex (uf.b.a+106)
      #12 pc 00000000010ca10a  /data/app/~~igC0lzbqE1iO5UHsWaPINg==/[REDACTED PACKAGE NAME]-JveEFSI_YqQbhoZsVwxRGQ==/oat/arm64/base.vdex (lf.b.h+366)
      #14 pc 000000000117db0c  /data/app/~~igC0lzbqE1iO5UHsWaPINg==/[REDACTED PACKAGE NAME]-JveEFSI_YqQbhoZsVwxRGQ==/oat/arm64/base.vdex (vf.d$a.invokeSuspend+116)

Expected Behavior

The release build variant shouldn't crash using the SDK.

Current Behavior

The release build variant is crashing using the SDK.

Reproduction Steps

• Integrate https://github.com/aws/aws-iot-device-sdk-java-v2 into an Android sample application.
• Ensure that the release buid variant is configured with isShrinkResources = true & isMinifyEnabled = true & isDebuggable = false.
• Run the sample application with the release build variant.

Possible Solution

The issue is the same as #443. However, we expected that any required ProGuard rules would be included in the SDK's source by now and could be pulled into the host application through the dedicated Android dependency.

Including the minimum required ProGuard rules for Android could eliminate the need to define these in the host.

Additional Information/Context

No response

SDK version used

1.27.2

Environment details (OS name and version, etc.)

Android

[balazsbarany]

ℹ️ For now, we have mitigated the issue by adding the following ProGuard rule to our application.

-keep class software.amazon.awssdk.crt.** { *; }

This was sufficient without adding more, as proposed under #443.

However, ideally, this or a more scoped version, if possible, should be shipped with the SDK.

[sfod]

Shipping these rules with the SDK sounds reasonable, we'll investigate the possibility to do that.

[sbSteveK]

We have added protections for native libraries in this PR: awslabs/aws-crt-java#918

The addition to consumer-rules.pro for the crt should protect it from any downstream attempts to minify or shrink resources.

The latest version of aws-iot-device-sdk-java-v2 (which includes the android iot device sdk) depends on the updated version of the crt. Using v1.27.4 (https://github.com/aws/aws-iot-device-sdk-java-v2/releases/tag/v1.27.4) should remove the requirement to exclude the library explicitly by anyone using the SDK downstream.

Thanks for bringing this to our attention!

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.