[Bug]: Getting crash when running release build

[dchandrani]

What happened?

Implemented OneSignal version 5.0.0 in Flutter app, but when tried to run the app in release mode I got a FATAL EXCEPTION saying Unable to start receiver com.onesignal.notifications.receivers.UpgradeReceiver: java.lang.Exception: Service class e7.b could not be instantiated.

Steps to reproduce?

1. Install onesignal_flutter: ^5.0.0

2. Launch the Android app in release mode

3. Note the crash in debug console

What did you expect to happen?

I expected to receive call back of OneSignal.User.pushSubscription.addObserver to get user id.

OneSignal Flutter SDK version

5.0.0

Which platform(s) are affected?

• iOS
• Android

Relevant log output

E/AndroidRuntime(11216): FATAL EXCEPTION: main
E/AndroidRuntime(11216): Process: com.voliz, PID: 11216
E/AndroidRuntime(11216): java.lang.RuntimeException: Unable to start receiver com.onesignal.notifications.receivers.UpgradeReceiver: java.lang.Exception: Service class e7.b could not be instantiated
E/AndroidRuntime(11216):        at android.app.ActivityThread.handleReceiver(ActivityThread.java:4485)
E/AndroidRuntime(11216):        at android.app.ActivityThread.access$1900(ActivityThread.java:254)
E/AndroidRuntime(11216):        at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2195)
E/AndroidRuntime(11216):        at android.os.Handler.dispatchMessage(Handler.java:106)
E/AndroidRuntime(11216):        at android.os.Looper.loopOnce(Looper.java:233)
E/AndroidRuntime(11216):        at android.os.Looper.loop(Looper.java:344)
E/AndroidRuntime(11216):        at android.app.ActivityThread.main(ActivityThread.java:8212)
E/AndroidRuntime(11216):        at java.lang.reflect.Method.invoke(Native Method)
E/AndroidRuntime(11216):        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:584)
E/AndroidRuntime(11216):        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:1034)
E/AndroidRuntime(11216): Caused by: java.lang.Exception: Service class e7.b could not be instantiated
E/AndroidRuntime(11216):        at u6.c.i(ServiceProvider.kt:59)
E/AndroidRuntime(11216):        at f8.a.l(OneSignalImp.kt:79)
E/AndroidRuntime(11216):        at o6.d.j(OneSignal.kt:13)
E/AndroidRuntime(11216):        at com.onesignal.notifications.receivers.UpgradeReceiver.onReceive(UpgradeReceiver.kt:18)
E/AndroidRuntime(11216):        at android.app.ActivityThread.handleReceiver(ActivityThread.java:4469)
E/AndroidRuntime(11216):        ... 9 more

Code of Conduct

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

[Wiwo99]

me too

[rafaelbarbosadrip]

me too

[Jakoo13]

I am seeing this as well. In version 5 after all proper migration and app working in debug, in release build the OneSignal.initialize(appId) is not working.

[sur2548]

Same for me as well, all the classes from the OneSignal are getting removed in the production build.

[Kuodster]

Same problem here, only after building the apk.

[sur2548]

Solution: Adding ProGuard Rules for OneSignal in Release Build

To ensure that ProGuard doesn't obfuscate the necessary classes from the OneSignal library in your Android project's release build, follow these steps:

1. Create or locate the proguard-rules.pro file in the root directory of your project.

2. Open the proguard-rules.pro file and add the following ProGuard rule to keep all classes within the com.onesignal package:

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

3. Modify your app's build.gradle file to include the ProGuard rule and enable ProGuard for the release build:

   android {
       // ... other configuration settings ...
   
       buildTypes {
           release {
               minifyEnabled true
               shrinkResources true
               proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
               signingConfig signingConfigs.release
           }
       }
   
       // ... other configuration settings ...
   }

By adding the above ProGuard rule and configuring the release build type in this manner, you're ensuring that ProGuard won't obfuscate the classes required by the OneSignal library. This helps prevent any runtime issues or unexpected behavior when using OneSignal features in the production version of your app.

[Chhay67]

any solution ???

[dchandrani]

@Chhay67 You can try the above solution by @sur2548

[PhamChiNang151020]

@Chhay67 You can try the above solution by @sur2548

I tried to try, but now my Apk file is still not registered for OneSignal control version

[sur2548]

@Chhay67 You can try the above solution by @sur2548

I tried to try, but now my Apk file is still not registered for OneSignal control version

@PhamChiNang151020 Do not initialize directly in the main function.

https://documentation.onesignal.com/docs/flutter-sdk-setup#step-5-set-up-onesignal-for-android

[PhamChiNang151020]

@sur2548>

Sorry, But I initialize by main.dart

And, buildTypes in the path android/app/build.gradle

If I'm doing something wrong, please help. Thank you!

[sur2548]

@PhamChiNang151020 You can follow the official doc or Could you move the initialization to the app level?

Anyway there is a PR for this, you can check that as well

#716

[Mohamed-Nagdy]

Solution: Adding ProGuard Rules for OneSignal in Release Build

To ensure that ProGuard doesn't obfuscate the necessary classes from the OneSignal library in your Android project's release build, follow these steps:

1. Create or locate the proguard-rules.pro file in the root directory of your project.
2. Open the proguard-rules.pro file and add the following ProGuard rule to keep all classes within the com.onesignal package:

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

3. Modify your app's build.gradle file to include the ProGuard rule and enable ProGuard for the release build:

   android {
       // ... other configuration settings ...
   
       buildTypes {
           release {
               minifyEnabled true
               shrinkResources true
               proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
               signingConfig signingConfigs.release
           }
       }
   
       // ... other configuration settings ...
   }
   

By adding the above ProGuard rule and configuring the release build type in this manner, you're ensuring that ProGuard won't obfuscate the classes required by the OneSignal library. This helps prevent any runtime issues or unexpected behavior when using OneSignal features in the production version of your app.

Thanks it resolve my problem

[emawby]

The latest release 5.0.1 adds the proguard rules to Android release builds that should resolve this issue. If that is not the case please tag me here!