fix: missing push sub ID by a new recovery

Author: jinliu9508

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/UserModule.kt

@@ -17,6 +17,7 @@ import com.onesignal.user.internal.backend.impl.UserBackendService
 import com.onesignal.user.internal.builduser.IRebuildUserService
 import com.onesignal.user.internal.builduser.impl.RebuildUserService
 import com.onesignal.user.internal.identity.IdentityModelStore
+import com.onesignal.user.internal.migrations.RecoverConfigPushSubscription
 import com.onesignal.user.internal.migrations.RecoverFromDroppedLoginBug
 import com.onesignal.user.internal.operations.impl.executors.IdentityOperationExecutor
 import com.onesignal.user.internal.operations.impl.executors.LoginUserFromSubscriptionOperationExecutor
@@ -74,6 +75,7 @@ internal class UserModule : IModule {
         builder.register<UserRefreshService>().provides<IStartableService>()
 
         builder.register<RecoverFromDroppedLoginBug>().provides<IStartableService>()
+        builder.register<RecoverConfigPushSubscription>().provides<IStartableService>()
 
         // Shared state between Executors
         builder.register<NewRecordsState>().provides<NewRecordsState>()

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/migrations/IMigrationRecovery.kt

@@ -0,0 +1,17 @@
+package com.onesignal.user.internal.migrations
+
+import com.onesignal.core.internal.startup.IStartableService
+
+/**
+ * Purpose: allow to identify and take corrective action for some specific bad states during migration
+ *
+ * Implement these properties to:
+ *  - isInBadState(): return true the condition for the bad state has met
+ *  - recover(): take a recovery action if the bad state has been identified
+ *  - recoveryMessage: log a message after the bad state is found and the corrective action is taken
+ */
+interface IMigrationRecovery: IStartableService {
+	fun isInBadState(): Boolean
+	fun recover()
+	fun recoveryMessage(): String
+}

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/migrations/MigrationRecovery.kt

@@ -0,0 +1,25 @@
+package com.onesignal.user.internal.migrations
+
+import com.onesignal.debug.internal.logging.Logging
+
+open class MigrationRecovery : IMigrationRecovery {
+	override fun isInBadState(): Boolean {
+		return false
+	}
+
+	override fun recover() {
+		// left blank intentionally
+	}
+
+	override fun recoveryMessage(): String {
+		return ""
+	}
+
+	override fun start() {
+		// log a message and take the corrective action if it is determined that app is in a bad state
+		if (isInBadState()) {
+			Logging.warn(recoveryMessage())
+			recover()
+		}
+	}
+}

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/migrations/RecoverConfigPushSubscription.kt

@@ -0,0 +1,35 @@
+package com.onesignal.user.internal.migrations
+
+import com.onesignal.core.internal.config.ConfigModelStore
+import com.onesignal.core.internal.operations.containsInstanceOf
+import com.onesignal.user.internal.operations.LoginUserOperation
+import com.onesignal.user.internal.subscriptions.SubscriptionModelStore
+import com.onesignal.user.internal.subscriptions.SubscriptionType
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.launch
+
+/**
+ * Purpose: Automatically recovers a missing push sub ID in the config model store due
+ * to a bug migrating from the SDK 5.2.0-beta
+ */
+class RecoverConfigPushSubscription(
+	private val _configModelStore: ConfigModelStore,
+	private val _subscriptionModelStore: SubscriptionModelStore,
+) : MigrationRecovery() {
+
+	val activePushSubscription by lazy { _subscriptionModelStore.list().firstOrNull{ it.type == SubscriptionType.PUSH } }
+
+	override fun isInBadState(): Boolean {
+		val isPushSubIdMissing = _configModelStore.model.pushSubscriptionId == null
+		return isPushSubIdMissing && activePushSubscription != null
+	}
+
+	override fun recover() {
+		_configModelStore.model.pushSubscriptionId = activePushSubscription?.id
+	}
+
+	override fun recoveryMessage(): String {
+		return "Recovering missing push subscription ID in the config model store."
+	}
+}