From 51f1399ee100606cba9e223c63283dbba5962567 Mon Sep 17 00:00:00 2001 From: Nan Date: Tue, 17 Jan 2023 11:27:23 -0800 Subject: [PATCH 1/2] fix crash with `WorkManager` helper for initialization * Before using WorkManager, check for its existence. Else, in rare cases that were crashing, initialize it ourselves. * Provides a method to check if WorkManager is initialized in this process. - This is effectively the `WorkManager.isInitialized()` public method introduced in `androidx.work:work-*:2.8.0-alpha02`. - Please see https://android-review.googlesource.com/c/platform/frameworks/support/+/1941186 for the library's implementation --- .../main/java/com/onesignal/OSFocusHandler.kt | 6 +- .../OSNotificationRestoreWorkManager.java | 3 +- .../onesignal/OSNotificationWorkManager.java | 6 +- .../onesignal/OSReceiveReceiptController.java | 3 +- .../java/com/onesignal/OSWorkManagerHelper.kt | 68 +++++++++++++++++++ 5 files changed, 76 insertions(+), 10 deletions(-) create mode 100644 OneSignalSDK/onesignal/src/main/java/com/onesignal/OSWorkManagerHelper.kt diff --git a/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSFocusHandler.kt b/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSFocusHandler.kt index 564d5ec03f..b0c4fc4ffa 100644 --- a/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSFocusHandler.kt +++ b/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSFocusHandler.kt @@ -32,7 +32,6 @@ import androidx.work.Constraints import androidx.work.ExistingWorkPolicy import androidx.work.NetworkType import androidx.work.OneTimeWorkRequest -import androidx.work.WorkManager import androidx.work.Worker import androidx.work.WorkerParameters import java.util.concurrent.TimeUnit @@ -87,7 +86,8 @@ class OSFocusHandler { .setInitialDelay(delay, TimeUnit.MILLISECONDS) .addTag(tag) .build() - WorkManager.getInstance(context) + + OSWorkManagerHelper.getInstance(context) .enqueueUniqueWork( tag, ExistingWorkPolicy.KEEP, @@ -96,7 +96,7 @@ class OSFocusHandler { } fun cancelOnLostFocusWorker(tag: String, context: Context) { - WorkManager.getInstance(context).cancelAllWorkByTag(tag) + OSWorkManagerHelper.getInstance(context).cancelAllWorkByTag(tag) } private fun resetStopState() { diff --git a/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationRestoreWorkManager.java b/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationRestoreWorkManager.java index fcc809f0aa..3539ca9c01 100644 --- a/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationRestoreWorkManager.java +++ b/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationRestoreWorkManager.java @@ -9,7 +9,6 @@ import androidx.annotation.NonNull; import androidx.work.ExistingWorkPolicy; import androidx.work.OneTimeWorkRequest; -import androidx.work.WorkManager; import androidx.work.Worker; import androidx.work.WorkerParameters; @@ -45,7 +44,7 @@ public static void beginEnqueueingWork(Context context, boolean shouldDelay) { .setInitialDelay(restoreDelayInSeconds, TimeUnit.SECONDS) .build(); - WorkManager.getInstance(context) + OSWorkManagerHelper.getInstance(context) .enqueueUniqueWork(NOTIFICATION_RESTORE_WORKER_IDENTIFIER, ExistingWorkPolicy.KEEP, workRequest); } diff --git a/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationWorkManager.java b/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationWorkManager.java index 3cb4d04423..199db9faad 100644 --- a/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationWorkManager.java +++ b/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationWorkManager.java @@ -6,7 +6,6 @@ import androidx.work.Data; import androidx.work.ExistingWorkPolicy; import androidx.work.OneTimeWorkRequest; -import androidx.work.WorkManager; import androidx.work.Worker; import androidx.work.WorkerParameters; @@ -63,8 +62,9 @@ static void beginEnqueueingWork(Context context, String osNotificationId, int an .build(); OneSignal.Log(OneSignal.LOG_LEVEL.DEBUG, "OSNotificationWorkManager enqueueing notification work with notificationId: " + osNotificationId + " and jsonPayload: " + jsonPayload); - WorkManager.getInstance(context) - .enqueueUniqueWork(osNotificationId, ExistingWorkPolicy.KEEP, workRequest); + + OSWorkManagerHelper.getInstance(context). + enqueueUniqueWork(osNotificationId, ExistingWorkPolicy.KEEP, workRequest); } public static class NotificationWorker extends Worker { diff --git a/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSReceiveReceiptController.java b/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSReceiveReceiptController.java index a4fdbb1df1..e6e0e9cae1 100644 --- a/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSReceiveReceiptController.java +++ b/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSReceiveReceiptController.java @@ -35,7 +35,6 @@ import androidx.work.ExistingWorkPolicy; import androidx.work.NetworkType; import androidx.work.OneTimeWorkRequest; -import androidx.work.WorkManager; import androidx.work.Worker; import androidx.work.WorkerParameters; @@ -82,7 +81,7 @@ void beginEnqueueingWork(Context context, String osNotificationId) { OneSignal.Log(OneSignal.LOG_LEVEL.DEBUG, "OSReceiveReceiptController enqueueing send receive receipt work with notificationId: " + osNotificationId + " and delay: " + delay + " seconds"); - WorkManager.getInstance(context) + OSWorkManagerHelper.getInstance(context) .enqueueUniqueWork(osNotificationId + "_receive_receipt", ExistingWorkPolicy.KEEP, workRequest); } diff --git a/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSWorkManagerHelper.kt b/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSWorkManagerHelper.kt new file mode 100644 index 0000000000..9065e3cf11 --- /dev/null +++ b/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSWorkManagerHelper.kt @@ -0,0 +1,68 @@ +/** + * Modified MIT License + *

+ * Copyright 2023 OneSignal + *

+ * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + *

+ * 1. The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + *

+ * 2. All copies of substantial portions of the Software may only be used in connection + * with services provided by OneSignal. + *

+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +package com.onesignal + +import android.annotation.SuppressLint +import android.content.Context +import androidx.work.Configuration +import androidx.work.WorkManager +import androidx.work.impl.WorkManagerImpl + +object OSWorkManagerHelper { + /** + * Helper method to provide a way to check if WorkManager is initialized in this process. + * + * This is effectively the `WorkManager.isInitialized()` public method introduced in androidx.work:work-*:2.8.0-alpha02. + * Please see https://android-review.googlesource.com/c/platform/frameworks/support/+/1941186. + * + * @return `true` if WorkManager has been initialized in this process. + */ + @SuppressWarnings("deprecation") + @SuppressLint("RestrictedApi") + private fun isInitialized(): Boolean { + val instance = WorkManagerImpl.getInstance() + return instance != null + } + + /** + * If there is an instance of WorkManager available, use it. Else, in rare cases, initialize it ourselves. + * + * Calling `WorkManager.getInstance(context)` directly can cause an exception if it is null. + * + * @return an instance of WorkManager + */ + @JvmStatic + fun getInstance(context: Context): WorkManager { + return if (isInitialized()) { + WorkManager.getInstance(context) + } else { + WorkManager.initialize(context, Configuration.Builder().build()) + WorkManager.getInstance(context) + } + } +} From 8fef4968282d8753ddb8128aa8d60df7755bfa3d Mon Sep 17 00:00:00 2001 From: Nan Date: Thu, 16 Feb 2023 11:00:18 -0800 Subject: [PATCH 2/2] address PR comments --- .../src/main/java/com/onesignal/OSWorkManagerHelper.kt | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSWorkManagerHelper.kt b/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSWorkManagerHelper.kt index 9065e3cf11..05c63ddbe4 100644 --- a/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSWorkManagerHelper.kt +++ b/OneSignalSDK/onesignal/src/main/java/com/onesignal/OSWorkManagerHelper.kt @@ -45,8 +45,7 @@ object OSWorkManagerHelper { @SuppressWarnings("deprecation") @SuppressLint("RestrictedApi") private fun isInitialized(): Boolean { - val instance = WorkManagerImpl.getInstance() - return instance != null + return WorkManagerImpl.getInstance() != null } /** @@ -57,12 +56,11 @@ object OSWorkManagerHelper { * @return an instance of WorkManager */ @JvmStatic + @Synchronized fun getInstance(context: Context): WorkManager { - return if (isInitialized()) { - WorkManager.getInstance(context) - } else { + if (!isInitialized()) { WorkManager.initialize(context, Configuration.Builder().build()) - WorkManager.getInstance(context) } + return WorkManager.getInstance(context) } }