[Bug]: consumer-proguard-rules.pro - Out of date for version 5.0.0

[michael-winkler]

What happened?

Out of date for version 5.0.0

https://github.com/OneSignal/OneSignal-Android-SDK/blob/main/OneSignalSDK/onesignal/consumer-proguard-rules.pro

We regret to inform you that the current Consumer ProGuard rules included in your project for OneSignal version 5.0.0 are no longer up to date. This is due to recent changes in class and method names within the OneSignal SDK.

To ensure the smooth functioning and proper optimization of your application, it's imperative to update the ProGuard rules in accordance with the latest version of OneSignal. Failing to do so might lead to unexpected behavior, decreased performance, or even app crashes.

Steps to reproduce?

-

What did you expect to happen?

Updated proguard rules for OneSignal version 5.0.0

OneSignal Android SDK version

5.0.0

Android version

13, 12, 11, 10, 9, 8, 7.1, 7.0, 6, 5.1, 5.0, 4.4, 4.3 or below

Specific Android models

No response

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[michael-winkler]

see also my coment here #1779 (comment)

[jennantilla]

Hello @michael-winkler thank you for reaching out! We'll look into this and get back to you as soon as possible.

[michael-winkler]

Any news? @jennantilla

[michael-winkler]

I tried to convert the rules by myself.

-dontwarn com.onesignal.**

# These 2 methods are called with reflection.
-keep class com.google.android.gms.common.api.GoogleApiClient {
    void connect();
    void disconnect();
}

I dont know the new correct lines for these:

-keep class com.onesignal.ActivityLifecycleListenerCompat** {*;}

# Observer backcall methods are called with reflection
-keep class com.onesignal.OSSubscriptionState {
    void changed(com.onesignal.OSPermissionState);
}

-keep class com.onesignal.OSPermissionChangedInternalObserver {
    void changed(com.onesignal.OSPermissionState);
}

-keep class com.onesignal.OSSubscriptionChangedInternalObserver {
    void changed(com.onesignal.OSSubscriptionState);
}

And here is the rest which i converted:

-keep class * implements com.onesignal.notifications.IPermissionObserver{
    void onNotificationPermissionChange(java.lang.Boolean);
}

-keep class * implements com.onesignal.user.subscriptions.IPushSubscriptionObserver {
    void onPushSubscriptionChange(com.onesignal.user.subscriptions.PushSubscriptionChangedState);
}

-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.AdwHomeBadger { <init>(...); }
-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.ApexHomeBadger { <init>(...); }
-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.AsusHomeBadger { <init>(...); }
-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.DefaultBadger { <init>(...); }
-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.EverythingMeHomeBadger { <init>(...); }
-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.HuaweiHomeBadger { <init>(...); }
-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.LGHomeBadger { <init>(...); }
-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.NewHtcHomeBadger { <init>(...); }
-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.NovaHomeBadger { <init>(...); }
-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.OPPOHomeBader { <init>(...); }
-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.SamsungHomeBadger { <init>(...); }
-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.SonyHomeBadger { <init>(...); }
-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.VivoHomeBadger { <init>(...); }
-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.XiaomiHomeBadger { <init>(...); }
-keep class com.onesignal.notifications.internal.badges.impl.shortcutbadger.impl.ZukHomeBadger { <init>(...); }

-dontwarn com.amazon.**

# Proguard ends up removing this class even if it is used in AndroidManifest.xml so force keeping it.
-keep public class com.onesignal.notifications.services.ADMMessageHandler {*;}

-keep class com.onesignal.JobIntentService$* {*;}

-keep class ** implements com.onesignal.notifications.INotificationServiceExtension{
   void onNotificationReceived(com.onesignal.notifications.INotificationReceivedEvent);
}

[michael-winkler]

Maybe this line is needed to:

-keep class com.onesignal.user.subscriptions.** { *; }

[ahmtbrk]

Maybe this line is needed to:

-keep class com.onesignal.user.subscriptions.** { *; }

I am getting the following error even though I have defined all the proguard rules. Also i see on firebase crashlytics.
com.onesignal.OneSignal.initWithContext (OneSignal.kt:126)
com.onesignal.core.internal.operations.impl.OperationModelStore.create (OperationModelStore.kt:58)
Unrecognized operation: login-user-from-subscription

[Petr-Kubista]

OneSignal.initWithContext is crashing at getService even with updated proguard rules on 5.0.1

[michael-winkler]

@Petr-Kubista Please provide more details that OneSignal can find the bug.
@emawby Please look again into the proguard rules. It looks like 5.0.1 does not fix the problem.

[michael-winkler]

It would be great if we also can see a new file like this https://github.com/OneSignal/OneSignal-Android-SDK/blob/main/OneSignalSDK/onesignal/consumer-proguard-rules.pro which contains all new rules.

[Petr-Kubista]

@michael-winkler the situation is described in a related issue:
#1811

[emawby]

@Petr-Kubista Which class is it not able to find? I am no longer able to reproduce the issue on 5.0.1

[michael-winkler]

@emawby I think @Petr-Kubista means this one:
java.lang.Exception: Service class com.onesignal.core.internal.config.ConfigModelStore could not be instantiated

[emawby]

I am not able to reproduce that problem on 5.0.1. Does your app have any custom proguard rules set?