[Fix] Android minify builds #644

shepherd-l · 2023-10-03T01:52:36Z

Description

One Line Summary

Adds proguard rules to fix Android builds with minify enabled

Details

Motivation

Fix runtime error, AndroidJavaException: java.lang.ClassNotFoundException: com.onesignal.OneSignal for Android builds with Minify enabled.

Scope

OneSignalConfig.plugin has changed to OneSignalConfig.androidlib.

Custom notification icons are now located in Assets/Plugins/Android/OneSignalConfig.androidlib/src/main/res

Users must run the "Copy Android plugin to Assets" step in Window > OneSignal SDK Setup to migrate.

Testing

Manual testing

Tested OneSignal initialization and custom notification icons, app build with Unity 2022.3.10f1 with Minify enabled for release and development builds of the OneSignal example app on a emulated Pixel 4 with Android 12.

Affected code checklist

Checklist

Overview

I have filled out all REQUIRED sections above
PR does one thing
Any Public API changes are explained in the PR details and conform to existing APIs

Testing

I have included test coverage for these changes, or explained why they are not needed
All automated tests pass, or I explained why that is not possible
I have personally tested this on my device, or explained why that is not possible

Final pass

Code is as readable as possible.
I have reviewed this PR myself, ensuring it meets each checklist item

This change is

Match compileSdkVersion of Android SDK and remove build tools version

jkasten2 · 2023-10-03T16:59:24Z

OneSignalExample/Assets/Plugins/Android/OneSignalConfig.androidlib.meta

@@ -1,6 +1,5 @@
 fileFormatVersion: 2
 guid: 006a8c36b25a144879a84c0bf1ce24a7
-folderAsset: yes


Seems odd this folderAsset: yes went away, it is still a folder. Did Unity change something where they no longer flag folders in their .meta files?

I think it's mentioned here:
https://forum.unity.com/threads/loadable-plugin-directory-import-behaviour-change-androidlib-bundle-framework-and-plugin.1381113/

I think they applied this to Unity 2022

When using Unity 2022.3.10, .meta files where not generated in com.onesignal.unity.android/Editor/OneSignalConfig.androidlib/consumer-proguard.pro
but did so in Unity 2021.3.30

I think we should upgrade the example app Unity Editor version to 2022 and also regenerate the Custom template files - maybe in a PR after the release?

When I loaded the example project in 2022.3.10 - OneSignalConfig.plugin.meta also has this change

jkasten2 · 2023-10-03T17:01:12Z

com.onesignal.unity.android/Editor/OneSignalConfig.androidlib/consumer-proguard.pro

@@ -0,0 +1,3 @@
+-keep class com.onesignal.** { *; }
+
+-keep class kotlinx.coroutines.android.AndroidDispatcherFactory {*;}


Can we add a comment to this line that indicate we are working around an issue with this library?

jkasten2 · 2023-10-03T17:05:11Z

com.onesignal.unity.android/Editor/SetupSteps/ExportAndroidResourcesStep.cs

+                    }
+
+                    // Rename OneSignalConfig.plugin to OneSignalConfig.androidlib
+                    AssetDatabase.MoveAsset(_pluginV3ExportPath, _pluginExportPath);


We also need to account for moving the icons and .wav file to /src/main.

jkasten2 · 2023-10-03T17:05:37Z

com.onesignal.unity.android/Editor/SetupSteps/ExportAndroidResourcesStep.cs

@@ -67,10 +66,23 @@ public override bool IsRequired
        }

        protected override void _runStep() {
-            var files         = Directory.GetFiles(_pluginPackagePath, "*", SearchOption.AllDirectories);
-            var filteredFiles = files.Where(file => !file.EndsWith(".meta"));
+            if (Directory.Exists(_pluginV3ExportPath)) {


It would be cleaner to move this migration logic into its own method.

jkasten2 · 2023-10-03T17:07:47Z

com.onesignal.unity.android/Editor/SetupSteps/ExportAndroidResourcesStep.cs

@@ -102,5 +114,10 @@ public override bool IsRequired

        private static readonly string _manifestPackagePath = Path.Combine(_pluginPackagePath, "AndroidManifest.xml");
        private static readonly string _manifestExportPath = Path.Combine(_pluginExportPath, "AndroidManifest.xml");
+
+        // OneSignalConfig name used in the 3.x version of the SDK


While the name was primarily used in 3.x.x I think it is important to include this folder name was used in v5 as well. So maybe say old name used from 3.x.x to 5.0.2 in a comment.

jkasten2 · 2023-10-03T17:16:43Z

OneSignalExample/Assets/OneSignal/CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - Sending VSAttribution data from the editor
 - iOS notifications clicked event firing if the app was cold started from clicking a notification
+- ClassNotFoundException: com.onesignal.OneSignal for Android builds with minify enabled


Can we add a sub note to this that you must run the export Android step again?, as I see ExportAndroidResourcesStep has changes.

I see we have in our 3.x.x migration guide to run this, but this is something customers on 5.0.0 to 5.0.2 will need to be aware of they need to re-run.

Ran setup step again to apply androidlib nit fixes

emawby

Reviewed 21 of 67 files at r1, 1 of 2 files at r2, 3 of 5 files at r3, all commit messages.
Reviewable status: 25 of 67 files reviewed, 6 unresolved discussions (waiting on @jennantilla, @jkasten2, @nan-li, and @shepherd-l)

[Fix] Android minify builds

shepherd-l added 7 commits October 2, 2023 15:51

Change plugin to androidlib

845d86b

Add proguard

4331ecd

Remove project properties

aee4a2a

Remove meta files

4ec4d12

Update setup step

54e29e9

Update CHANGELOG

388b37a

Update minimum editor requirement to legacy LTS version

725b00a

shepherd-l force-pushed the fix/proguardAndroidlib branch 2 times, most recently from f355f6b to 9c41d79 Compare October 3, 2023 04:41

shepherd-l added 4 commits October 3, 2023 03:38

Update icon directory

0966ab2

Update OneSignalConfig references

e9f255c

Remove unneeded step

5f09abd

Update CHANGELOG

d3e6ca2

shepherd-l force-pushed the fix/proguardAndroidlib branch from 9c41d79 to d3e6ca2 Compare October 3, 2023 07:45

shepherd-l added 2 commits October 3, 2023 08:00

Update build gradle

cdd58a6

Match compileSdkVersion of Android SDK and remove build tools version

Update example app with OneSignalConfig.androidlib

c705a96

shepherd-l requested review from jkasten2, emawby, nan-li and jennantilla October 3, 2023 12:28

jkasten2 requested changes Oct 3, 2023

View reviewed changes

shepherd-l added 5 commits October 3, 2023 13:50

Update CHANGELOG

48c3fa1

Update comment

be9a68c

Move logic to helper method

457d3f6

Add comment to indicate work around for kotlinx-coroutines-android

9cc3338

Move icons and .wav file to /src/main

9f6c33c

shepherd-l requested a review from jkasten2 October 3, 2023 23:31

Capitalize method name

013bf26

shepherd-l force-pushed the fix/proguardAndroidlib branch from 347ed8b to 013bf26 Compare October 4, 2023 16:30

Update setup name

3d4aad7

Update example app androidlib with nit fixes

32d4a01

Ran setup step again to apply androidlib nit fixes

emawby approved these changes Oct 4, 2023

View reviewed changes

shepherd-l merged commit 425f868 into user-model/main Oct 4, 2023
1 check passed

shepherd-l deleted the fix/proguardAndroidlib branch October 4, 2023 19:39

jinliu9508 pushed a commit that referenced this pull request Feb 23, 2024

Merge pull request #644 from OneSignal/fix/proguardAndroidlib

4fe1d74

[Fix] Android minify builds

jinliu9508 pushed a commit that referenced this pull request Feb 27, 2024

Merge pull request #644 from OneSignal/fix/proguardAndroidlib

43e21fd

[Fix] Android minify builds

jinliu9508 pushed a commit that referenced this pull request Feb 27, 2024

Merge pull request #644 from OneSignal/fix/proguardAndroidlib

9d53f5f

[Fix] Android minify builds

jinliu9508 pushed a commit that referenced this pull request Feb 27, 2024

Merge pull request #644 from OneSignal/fix/proguardAndroidlib

c3606f9

[Fix] Android minify builds

jinliu9508 pushed a commit that referenced this pull request Feb 27, 2024

Merge pull request #644 from OneSignal/fix/proguardAndroidlib

5b316ba

[Fix] Android minify builds

jinliu9508 pushed a commit that referenced this pull request Mar 1, 2024

Merge pull request #644 from OneSignal/fix/proguardAndroidlib

64bee77

[Fix] Android minify builds

jinliu9508 pushed a commit that referenced this pull request Mar 4, 2024

Merge pull request #644 from OneSignal/fix/proguardAndroidlib

ec26bdd

[Fix] Android minify builds

jinliu9508 pushed a commit that referenced this pull request Mar 4, 2024

Merge pull request #644 from OneSignal/fix/proguardAndroidlib

e9d41d5

[Fix] Android minify builds

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fix] Android minify builds #644

[Fix] Android minify builds #644

shepherd-l commented Oct 3, 2023 •

edited

Loading

jkasten2 Oct 3, 2023

shepherd-l Oct 3, 2023

shepherd-l Oct 4, 2023

jkasten2 Oct 3, 2023

jkasten2 Oct 3, 2023

jkasten2 Oct 3, 2023

jkasten2 Oct 3, 2023

jkasten2 Oct 3, 2023

emawby left a comment

		@@ -0,0 +1,3 @@
		-keep class com.onesignal.** { *; }

		-keep class kotlinx.coroutines.android.AndroidDispatcherFactory {*;}

[Fix] Android minify builds #644

[Fix] Android minify builds #644

Conversation

shepherd-l commented Oct 3, 2023 • edited Loading

Description

One Line Summary

Details

Motivation

Scope

Testing

Manual testing

Affected code checklist

Checklist

Overview

Testing

Final pass

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emawby left a comment

Choose a reason for hiding this comment

shepherd-l commented Oct 3, 2023 •

edited

Loading