Fresco: ProGuard configuration required for version 1.2.0

[shoheikawano]

Description

I have updated fresco library version from 1.1.0 to 1.2.0 and tried to build the project with ProGuard.

It seems like the build fails due to the obfuscation of two specific annotations that fresco depends on, starting from 1.2.0, which are

• com.facebook.infer.annotation.ReturnsOwnership
• com.facebook.infer.annotation.Functional

The error message is below:

Warning: com.facebook.common.util.TriState: can't find referenced class com.facebook.infer.annotation.Functional
Warning: com.facebook.common.util.TriState: can't find referenced class com.facebook.infer.annotation.Functional
Warning: com.facebook.common.util.TriState: can't find referenced class com.facebook.infer.annotation.Functional
Warning: com.facebook.common.util.TriState: can't find referenced class com.facebook.infer.annotation.Functional
Warning: com.facebook.common.util.TriState: can't find referenced class com.facebook.infer.annotation.Functional
Warning: com.facebook.common.util.TriState: can't find referenced class com.facebook.infer.annotation.Functional
Warning: com.facebook.common.util.TriState: can't find referenced class com.facebook.infer.annotation.Functional
Warning: com.facebook.common.util.TriState: can't find referenced class com.facebook.infer.annotation.Functional
Warning: com.facebook.drawee.controller.AbstractDraweeControllerBuilder: can't find referenced class com.facebook.infer.annotation.ReturnsOwnership
Warning: com.facebook.drawee.generic.GenericDraweeHierarchyInflater: can't find referenced class com.facebook.infer.annotation.ReturnsOwnership
....

FAILURE: Build failed with an exception.

Reproduction

The build fails for every attempt when updating fresco library version from 1.1.0 to 1.2.0.
The build succeeds if the library version is specified to 1.1.0.

Additional Information

• Fresco version: 1.2.0

[foghina]

@erikandre I think you did the last release and I think I recall you hitting some issues with these annotations as well. Can you take a look?

[foghina]

@shaunkawano what happens if you just tell proguard to keep those two classes?

[shoheikawano]

@foghina Thank you for the quick response; adding these two dontwarn configuration fixes build failure and made the build to succeed for me.

-dontwarn com.facebook.infer.annotation.ReturnsOwnership
-dontwarn com.facebook.infer.annotation.Functional

Hopefully this is the minimum configuration required to make the build succeed, but still I am not 100% sure simply dontwarning them solves the entire issue here.

[foghina]

These annotations are only used by infer, so at lint time. They are not used at runtime at all. I think -dontwarn should be fine. I'll add this to the docs. Thanks!

[foghina]

Wait, looks like infer classes should already have -dontwarn, according to proguard-fresco.pro. @shaunkawano did you follow the proguard doc?

[shoheikawano]

Oops..my bad; I haven't checked that documentation. Thanks for your info!

(By the way, in the future, possibly fresco could contain consumerProguardFiles configuration on its build.gradle file to include those ProGuard settings within the library itself so that users may no longer need to set up additional ProGuard setting on top of their own. :) (Glide seems to have done this already; I have pasted the code ref below as well).

Reference I have looked up:

• http://gfx.hatenablog.com/entry/2016/01/16/184846 (Japanese)
• https://github.com/bumptech/glide/blob/master/library/build.gradle#L53

Anyway, thanks for your quick response and help!

[foghina]

consumerProguardFiles sounds useful, we'll look into it.

[foghina]

PRs are also welcome ;)

[shoheikawano]

Thanks! :)