Realtime Storage on Android with ProGuard

348 views
Skip to first unread message

Su-Au Hwang

unread,
Jun 11, 2015, 5:15:02 AM6/11/15
to realtime-...@googlegroups.com
I added Realtime Storage to a project to implement a chat feature.
Here is my setup:
  • Android Studio
  • com.android.tools.build.gradle:1.0.0
  • buildToolsVersion "21.1.2"
I added the Realtime Storage SDK through my application build.gradle:
dependencies {
   ...
   compile 'co.realtime:storage-android:1.0.24'
   ...
}
so far that's working fine.

However enabling ProGuard broke the whole thing and I got following error messages (shortened for brevity):

Note: there were 157 duplicate class definitions.
      (http://proguard.sourceforge.net/manual/troubleshooting.html#duplicateclass)
Warning:library class org.apache.http.auth.AuthenticationException extends or implements program class org.apache.http.ProtocolException
Warning:library class org.apache.http.auth.AuthenticationException extends or implements program class org.apache.http.ProtocolException
...
Warning:com.fasterxml.jackson.databind.ext.DOMSerializer: can't find referenced class org.w3c.dom.bootstrap.DOMImplementationRegistry
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpRequest
...
Warning:there were 4 unresolved references to classes or interfaces.
...
Warning:there were 141 instances of library classes depending on program classes.
...
:app:proguardDevelopmentDebug FAILED
Error:Execution failed for task ':app:proguardDevelopmentDebug'.
> java.io.IOException: Please correct the above warnings first.

It looks like the Realtime Storage SDK includes some classes already present in the android framework.

Upon further investigation I couldn't find any mention of ProGuard rules in the RT documentation.
The provided sample projects do not use ProGuard either and used slightly outdated jars instead of maven/gradle.
I managed to get the the app running and probably (???) working correctly with the following ProGuard rules in proguard-rules.pro, which might be either overkill or not enough to get all features working properly:

-dontwarn android.net.http.AndroidHttpClient
-dontwarn org.apache.http.**
-dontwarn org.w3c.dom.bootstrap.DOMImplementationRegistry
-keepattributes Annotation,SourceFile,LineNumberTable
-keepattributes *Annotation*
-keepclasseswithmembernames class * { native <methods>; }
-keep class android.net.http.AndroidHttpClient { *;}
-keep interface android.net.http.AndroidHttpClient { *;}
-keep class org.apache.http.** { *;}
-keep interface org.apache.http.** { *;}
-keep class org.w3c.dom.bootstrap.DOMImplementationRegistry { *;}
-keep interface org.w3c.dom.bootstrap.DOMImplementationRegistry { *;}
-keep class co.realtime.** { *; }
-keep interface co.realtime.** { *; }
-keepnames class co.realtime.** { *; }
-keepnames interface co.realtime.** { *; }
-keep class ibt.ortc.** { *; }
-keep interface ibt.ortc.** { *; }
-keepnames class com.fasterxml.jackson.** { *; }
-keepnames interface com.fasterxml.jackson.** { *; }

As I believe most serious apps should enable ProGuard for various reasons like 65k method limit, bloated Google Play services etc...
It would be great if Realtime.co could provide a 'official' and minimal ProGuard rule set and if possible update the sample projects with the current RT-SDKs preferably as maven/gradle artifacts instead of jars.
Also the "library class depends on program class" error needs to be double checked.

Thanks for you time,
Su-Au

Su-Au Hwang

unread,
Jun 11, 2015, 5:17:11 AM6/11/15
to realtime-...@googlegroups.com
Here is the complete Warning/Error log:
:app:proguardDevelopmentDebug
Note: there were 157 duplicate class definitions.
Warning:library class org.apache.http.auth.AuthenticationException extends or implements program class org.apache.http.ProtocolException
Warning:library class org.apache.http.auth.MalformedChallengeException extends or implements program class org.apache.http.ProtocolException
Warning:library class org.apache.http.auth.params.AuthParamBean extends or implements program class org.apache.http.params.HttpAbstractParamBean
Warning:library class org.apache.http.client.NonRepeatableRequestException extends or implements program class org.apache.http.ProtocolException
Warning:library class org.apache.http.client.RedirectException extends or implements program class org.apache.http.ProtocolException
Warning:library class org.apache.http.client.entity.UrlEncodedFormEntity extends or implements program class org.apache.http.entity.StringEntity
Warning:library class org.apache.http.client.methods.HttpEntityEnclosingRequestBase extends or implements program class org.apache.http.HttpEntityEnclosingRequest
Warning:library class org.apache.http.client.methods.HttpRequestBase extends or implements program class org.apache.http.message.AbstractHttpMessage
Warning:library class org.apache.http.client.methods.HttpUriRequest extends or implements program class org.apache.http.HttpRequest
Warning:library class org.apache.http.client.params.AllClientPNames extends or implements program class org.apache.http.params.CoreConnectionPNames
Warning:library class org.apache.http.client.params.AllClientPNames extends or implements program class org.apache.http.params.CoreProtocolPNames
Warning:library class org.apache.http.client.params.ClientParamBean extends or implements program class org.apache.http.params.HttpAbstractParamBean
Warning:library class org.apache.http.client.protocol.RequestAddCookies extends or implements program class org.apache.http.HttpRequestInterceptor
Warning:library class org.apache.http.client.protocol.RequestDefaultHeaders extends or implements program class org.apache.http.HttpRequestInterceptor
Warning:library class org.apache.http.client.protocol.RequestProxyAuthentication extends or implements program class org.apache.http.HttpRequestInterceptor
Warning:library class org.apache.http.client.protocol.RequestTargetAuthentication extends or implements program class org.apache.http.HttpRequestInterceptor
Warning:library class org.apache.http.client.protocol.ResponseProcessCookies extends or implements program class org.apache.http.HttpResponseInterceptor
Warning:library class org.apache.http.conn.BasicManagedEntity extends or implements program class org.apache.http.entity.HttpEntityWrapper
Warning:library class org.apache.http.conn.ManagedClientConnection extends or implements program class org.apache.http.HttpClientConnection
Warning:library class org.apache.http.conn.ManagedClientConnection extends or implements program class org.apache.http.HttpInetConnection
Warning:library class org.apache.http.conn.OperatedClientConnection extends or implements program class org.apache.http.HttpClientConnection
Warning:library class org.apache.http.conn.OperatedClientConnection extends or implements program class org.apache.http.HttpInetConnection
Warning:library class org.apache.http.conn.params.ConnConnectionParamBean extends or implements program class org.apache.http.params.HttpAbstractParamBean
Warning:library class org.apache.http.conn.params.ConnManagerParamBean extends or implements program class org.apache.http.params.HttpAbstractParamBean
Warning:library class org.apache.http.conn.params.ConnRouteParamBean extends or implements program class org.apache.http.params.HttpAbstractParamBean
Warning:library class org.apache.http.cookie.MalformedCookieException extends or implements program class org.apache.http.ProtocolException
Warning:library class org.apache.http.cookie.params.CookieSpecParamBean extends or implements program class org.apache.http.params.HttpAbstractParamBean
Warning:library class org.apache.http.impl.client.ClientParamsStack extends or implements program class org.apache.http.params.AbstractHttpParams
Warning:library class org.apache.http.impl.client.EntityEnclosingRequestWrapper extends or implements program class org.apache.http.HttpEntityEnclosingRequest
Warning:library class org.apache.http.impl.client.RequestWrapper extends or implements program class org.apache.http.message.AbstractHttpMessage
Warning:library class org.apache.http.impl.client.TunnelRefusedException extends or implements program class org.apache.http.HttpException
Warning:library class org.apache.http.impl.conn.DefaultClientConnection extends or implements program class org.apache.http.impl.SocketHttpClientConnection
Warning:library class org.apache.http.impl.conn.DefaultResponseParser extends or implements program class org.apache.http.impl.io.AbstractMessageParser
Warning:library class org.apache.http.impl.conn.LoggingSessionInputBuffer extends or implements program class org.apache.http.io.SessionInputBuffer
Warning:library class org.apache.http.impl.conn.LoggingSessionOutputBuffer extends or implements program class org.apache.http.io.SessionOutputBuffer
Warning:co.realtime.storage.ProcessRestResponse: can't find referenced class com.google.gson.Gson
Warning:com.fasterxml.jackson.databind.ext.DOMSerializer: can't find referenced class org.w3c.dom.bootstrap.DOMImplementationRegistry
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpRequest
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpEntity
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.params.HttpParams
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpResponse
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.protocol.HttpContext
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpResponse
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpHost
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpRequest
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpResponse
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpHost
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpRequest
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.protocol.HttpContext
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpResponse
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.protocol.HttpContext
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpHost
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpRequest
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpHost
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.HttpRequest
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.protocol.HttpContext
Warning:library class android.net.http.AndroidHttpClient depends on program class org.apache.http.entity.AbstractHttpEntity
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.params.HttpParams
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.HttpResponse
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.protocol.HttpContext
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.HttpResponse
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.HttpHost
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.HttpRequest
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.HttpResponse
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.HttpHost
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.HttpRequest
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.protocol.HttpContext
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.HttpResponse
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.protocol.HttpContext
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.HttpHost
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.HttpRequest
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.HttpHost
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.HttpRequest
Warning:library class org.apache.http.client.HttpClient depends on program class org.apache.http.protocol.HttpContext
Warning:library class org.apache.http.client.methods.HttpEntityEnclosingRequestBase depends on program class org.apache.http.HttpEntity
Warning:library class org.apache.http.client.methods.HttpOptions depends on program class org.apache.http.HttpResponse
Warning:library class org.apache.http.client.methods.HttpRequestBase depends on program class org.apache.http.ProtocolVersion
Warning:library class org.apache.http.client.methods.HttpRequestBase depends on program class org.apache.http.RequestLine
Warning:library class org.apache.http.client.params.HttpClientParams depends on program class org.apache.http.params.HttpParams
Warning:library class org.apache.http.conn.params.ConnManagerParams depends on program class org.apache.http.params.HttpParams
Warning:library class org.apache.http.conn.scheme.PlainSocketFactory depends on program class org.apache.http.params.HttpParams
Warning:library class org.apache.http.conn.scheme.SchemeRegistry depends on program class org.apache.http.HttpHost
Warning:library class org.apache.http.conn.scheme.SocketFactory depends on program class org.apache.http.params.HttpParams
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.params.HttpParams
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.protocol.HttpContext
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.protocol.HttpRequestExecutor
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.ConnectionReuseStrategy
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.protocol.BasicHttpProcessor
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.params.HttpParams
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.protocol.HttpRequestExecutor
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.ConnectionReuseStrategy
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.protocol.BasicHttpProcessor
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpResponseInterceptor
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpRequestInterceptor
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpResponse
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.protocol.HttpContext
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpResponse
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpHost
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpRequest
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpResponse
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpHost
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpRequest
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.protocol.HttpContext
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpResponse
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.protocol.HttpRequestExecutor
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.ConnectionReuseStrategy
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.protocol.HttpProcessor
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.params.HttpParams
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpRequest
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.params.HttpParams
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.protocol.HttpContext
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpHost
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpRequest
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpHost
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.HttpRequest
Warning:library class org.apache.http.impl.client.AbstractHttpClient depends on program class org.apache.http.protocol.HttpContext
Warning:library class org.apache.http.impl.client.DefaultHttpClient depends on program class org.apache.http.params.HttpParams
Warning:library class org.apache.http.impl.client.DefaultHttpClient depends on program class org.apache.http.protocol.HttpRequestExecutor
Warning:library class org.apache.http.impl.client.DefaultHttpClient depends on program class org.apache.http.protocol.HttpContext
Warning:library class org.apache.http.impl.client.DefaultHttpClient depends on program class org.apache.http.ConnectionReuseStrategy
Warning:library class org.apache.http.impl.client.DefaultHttpClient depends on program class org.apache.http.protocol.BasicHttpProcessor
Warning:library class org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager depends on program class org.apache.http.params.HttpParams
Warning:there were 7 unresolved references to classes or interfaces.
         You may need to add missing library jars or update their versions.
         If your code works fine without the missing classes, you can suppress
         the warnings with '-dontwarn' options.
Warning:there were 141 instances of library classes depending on program classes.
         You must avoid such dependencies, since the program classes will
         be processed, while the library classes will remain unchanged.
:app:proguardDevelopmentDebug FAILED
Error:Execution failed for task ':app:proguardDevelopmentDebug'.
> java.io.IOException: Please correct the above warnings first.
Information:BUILD FAILED
Information:Total time: 10.469 secs
Information:1 error
Information:124 warnings
Information:See complete output in console

João Parreira

unread,
Jun 11, 2015, 6:04:43 AM6/11/15
to realtime-...@googlegroups.com
Thanks for the feedback Su. We'll look into that asap.

--
You received this message because you are subscribed to the Google Groups "Realtime Framework" group.
To unsubscribe from this group and stop receiving emails from it, send an email to realtime-framew...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

João Parreira

unread,
Jun 11, 2015, 3:16:25 PM6/11/15
to realtime-...@googlegroups.com
We have analyzed this issue and found that maybe the inclusion of httpcore-4.2.4.jar in the Realtime Messaging dependency of the Realtime Storage SDK was causing the duplication issues.

We have deployed to Maven Central a new version of the Messaging SDK (2.1.52, https://github.com/realtime-framework/RealtimeMessaging-Android/releases/tag/2.1.52) and a new version of the Storage SDK (1.0.26, https://github.com/realtime-framework/RealtimeStorage-Android/releases/tag/1.0.26) using the newly published version of the Messaging SDK.

In some of our tests with sample apps using ProGuard we still had to include
-dontwarn org.apache.http.**
-dontwarn org.w3c.dom.bootstrap.DOMImplementationRegistry

at the app proguard rules file (don't really know why, the duplication should be gone).

In the end if your app is running with your proguard rules I would say you are on the clear.
If you find anything not normal please let us know.

Best regards,
Joao

Su-Au Hwang

unread,
Jun 11, 2015, 11:51:41 PM6/11/15
to realtime-...@googlegroups.com
Thanks, that was quick!
I gave it a quick try, but had the same issues as before, I'll do some more testing and debugging later and get back when I have more details.

Su-Au
To unsubscribe from this group and stop receiving emails from it, send an email to realtime-framework+unsub...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Realtime Framework" group.
To unsubscribe from this group and stop receiving emails from it, send an email to realtime-framework+unsub...@googlegroups.com.
Reply all
Reply to author
Forward
0 new messages