Add UserStateObserver that returns both previous and current use states

jinliu9508 · jinliu9508 · commit 834bbca89805 · 2023-12-06T14:53:57.000-05:00
diff --git a/Examples/OneSignalDemo/app/src/main/java/com/onesignal/sdktest/model/MainActivityViewModel.java b/Examples/OneSignalDemo/app/src/main/java/com/onesignal/sdktest/model/MainActivityViewModel.java
@@ -28,7 +28,11 @@
 
 import com.onesignal.Continue;
 import com.onesignal.OneSignal;
+import com.onesignal.debug.internal.logging.Logging;
 import com.onesignal.sdktest.adapter.SubscriptionRecyclerViewAdapter;
+import com.onesignal.user.IUserStateObserver;
+import com.onesignal.user.UserChangedState;
+import com.onesignal.user.UserState;
 import com.onesignal.user.subscriptions.IEmailSubscription;
 import com.onesignal.user.subscriptions.IPushSubscription;
 import com.onesignal.user.subscriptions.ISmsSubscription;
@@ -63,7 +67,7 @@
 import java.util.Map;
 
 @RequiresApi(api = Build.VERSION_CODES.N)
-public class MainActivityViewModel implements ActivityViewModel, IPushSubscriptionObserver {
+public class MainActivityViewModel implements ActivityViewModel, IPushSubscriptionObserver, IUserStateObserver {
 
     private Animate animate;
     private Dialog dialog;
@@ -293,6 +297,7 @@ public ActivityViewModel onActivityCreated(Context context) {
         triggerArrayList = new ArrayList<>();
 
         OneSignal.getUser().getPushSubscription().addObserver(this);
+        OneSignal.getUser().addObserver(this);
         return this;
     }
 
@@ -501,6 +506,17 @@ public void onPushSubscriptionChange(@NonNull PushSubscriptionChangedState state
         refreshSubscriptionState();
     }
 
+    @Override
+    public void onUserStateChange(@NonNull UserChangedState state) {
+        UserState currentState = state.getCurrent();
+        UserState prevState = state.getPrevious();
+        Logging.debug("onUserStateChanged;  previous onesignalId: " + String.valueOf(prevState.getOnesignalId())
+                        + ", previous externalId: " + String.valueOf(prevState.getExternalId())
+                        + ", current onesignalId: " + String.valueOf(currentState.getOnesignalId())
+                        + ", current externalId: " + String.valueOf(currentState.getExternalId()),
+                null);
+    }
+
     private class DummySubscription implements ISubscription {
 
         private String _id;
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/IDManager.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/IDManager.kt
@@ -26,4 +26,19 @@ object IDManager {
      * @return true if the [id] provided was created via [createLocalId].
      */
     fun isLocalId(id: String): Boolean = id.startsWith(LOCAL_PREFIX)
+
+    /**
+     * Get non local ID or null.
+     *
+     * @param id The ID to test.
+     *
+     * @return [id] or null if the [id] provided was created via [createLocalId].
+     */
+    fun getNonLocalIDOrNull(id: String): String? {
+        if (isLocalId(id)) {
+            return null
+        }
+
+        return id
+    }
 }
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/events/EventProducer.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/events/EventProducer.kt
@@ -44,7 +44,7 @@ open class EventProducer<THandler> : IEventNotifier<THandler> {
      *
      * @param callback The callback will be invoked for each subscribed handler, allowing you to call the handler.
      */
-    fun fire(callback: (THandler) -> Unit) {
+    open fun fire(callback: (THandler) -> Unit) {
         synchronized(subscribers) {
             for (s in subscribers) {
                 callback(s)
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/modeling/IModelChangedHandler.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/modeling/IModelChangedHandler.kt
@@ -49,3 +49,14 @@ class ModelChangedArgs(
      */
     val newValue: Any?,
 )
+
+/**
+ * The arguments passed to the [IModelChangedHandler] handler when subscribed via [Model.subscribe]
+ */
+class ModelReplacedArgs<TModel>(
+    /**
+     * The full model in its previous and current state.
+     */
+    val oldModel: TModel,
+    val newModel: TModel,
+) where TModel : Model
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/modeling/ISingletonModelStoreChangeHandler.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/modeling/ISingletonModelStoreChangeHandler.kt
@@ -12,7 +12,7 @@ interface ISingletonModelStoreChangeHandler<TModel> where TModel : Model {
      * @param tag The tag which identifies how/why the model was replaced.
      */
     fun onModelReplaced(
-        model: TModel,
+        model: ModelReplacedArgs<TModel>,
         tag: String,
     )
 
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/modeling/SingletonModelStore.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/modeling/SingletonModelStore.kt
@@ -38,10 +38,12 @@ open class SingletonModelStore<TModel>(
         tag: String,
     ) {
         synchronized(replaceLock) {
+            val oldModel = this.store.create() ?: throw Exception("Unable to initialize model from store $store")
+            oldModel.initializeFromModel(singletonId, this.model)
             val existingModel = this.model
             existingModel.initializeFromModel(singletonId, model)
             store.persist()
-            changeSubscription.fire { it.onModelReplaced(existingModel, tag) }
+            changeSubscription.fire { it.onModelReplaced(ModelReplacedArgs(oldModel, existingModel), tag) }
         }
     }
 
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/config/impl/ConfigModelStoreListener.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/config/impl/ConfigModelStoreListener.kt
@@ -4,6 +4,7 @@ import com.onesignal.common.exceptions.BackendException
 import com.onesignal.common.modeling.ISingletonModelStoreChangeHandler
 import com.onesignal.common.modeling.ModelChangeTags
 import com.onesignal.common.modeling.ModelChangedArgs
+import com.onesignal.common.modeling.ModelReplacedArgs
 import com.onesignal.common.threading.suspendifyOnThread
 import com.onesignal.core.internal.backend.IParamsBackendService
 import com.onesignal.core.internal.config.ConfigModel
@@ -43,7 +44,7 @@ internal class ConfigModelStoreListener(
     }
 
     override fun onModelReplaced(
-        model: ConfigModel,
+        model: ModelReplacedArgs<ConfigModel>,
         tag: String,
     ) {
         if (tag != ModelChangeTags.NORMAL) {
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/operations/listeners/SingletonModelStoreListener.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/operations/listeners/SingletonModelStoreListener.kt
@@ -5,6 +5,7 @@ import com.onesignal.common.modeling.ISingletonModelStoreChangeHandler
 import com.onesignal.common.modeling.Model
 import com.onesignal.common.modeling.ModelChangeTags
 import com.onesignal.common.modeling.ModelChangedArgs
+import com.onesignal.common.modeling.ModelReplacedArgs
 import com.onesignal.common.modeling.SingletonModelStore
 import com.onesignal.core.internal.operations.IOperationRepo
 import com.onesignal.core.internal.operations.Operation
@@ -30,7 +31,7 @@ internal abstract class SingletonModelStoreListener<TModel>(
     }
 
     override fun onModelReplaced(
-        model: TModel,
+        model: ModelReplacedArgs<TModel>,
         tag: String,
     ) {
         if (tag != ModelChangeTags.NORMAL) {
@@ -62,7 +63,7 @@ internal abstract class SingletonModelStoreListener<TModel>(
      *
      * @return The operation to enqueue when the model has been replaced, or null if no operation should be enqueued.
      */
-    abstract fun getReplaceOperation(model: TModel): Operation?
+    abstract fun getReplaceOperation(model: ModelReplacedArgs<TModel>): Operation?
 
     /**
      * Called when the model has been updated.
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/IUserManager.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/IUserManager.kt
@@ -138,4 +138,15 @@ interface IUserManager {
      * Return a copy of all local tags from the current user.
      */
     fun getTags(): Map<String, String>
+
+    /**
+     * Add an observer to the user state, allowing the provider to be
+     * notified whenever the user state has changed.
+     */
+    fun addObserver(observer: IUserStateObserver)
+
+    /**
+     * Remove an observer from the user state.
+     */
+    fun removeObserver(observer: IUserStateObserver)
 }
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/IUserStateObserver.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/IUserStateObserver.kt
@@ -0,0 +1,15 @@
+package com.onesignal.user
+
+/**
+ * A user state changed handler. Implement this interface and provide the implementation
+ * to be notified when the user has changed.
+ */
+interface IUserStateObserver {
+    /**
+     * Called when the user state this change handler was added to, has changed. A
+     * user state can change when user has logged in or out
+     *
+     * @param state The user changed state.
+     */
+    fun onUserStateChange(state: UserChangedState)
+}
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/UserChangedState.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/UserChangedState.kt
@@ -0,0 +1,14 @@
+package com.onesignal.user
+
+import org.json.JSONObject
+
+class UserChangedState(
+    val previous: UserState,
+    val current: UserState,
+) {
+    fun toJSONObject(): JSONObject {
+        return JSONObject()
+            .put("previous", previous.toJSONObject())
+            .put("current", current.toJSONObject())
+    }
+}
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/UserState.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/UserState.kt
@@ -0,0 +1,39 @@
+package com.onesignal.user
+
+import com.onesignal.common.IDManager
+import org.json.JSONObject
+
+/**
+ * A user state.
+ */
+class UserState {
+    /**
+     * The unique identifier for your OneSignal account. This will be a null string until the
+     * user has been successfully logged in on the backend and assigned an ID.
+     * Use [addObserver] to be notified when the [onesignalId] has been successfully assigned.
+     */
+    val onesignalId: String?
+
+    /**
+     * The external identifier that you use to identify users. This will be an null string
+     * until the user has been successfully logged in on the backend and
+     * assigned an ID.  Use [addObserver] to be notified when the [externalId] has
+     * been successfully assigned.
+     */
+    val externalId: String?
+
+    constructor(onesignalId: String?, externalId: String?) {
+        if (onesignalId == null) {
+            this.onesignalId = null
+        } else {
+            this.onesignalId = IDManager.getNonLocalIDOrNull(onesignalId)
+        }
+        this.externalId = externalId
+    }
+
+    fun toJSONObject(): JSONObject {
+        return JSONObject()
+            .put("onesignalId", onesignalId)
+            .put("externalId", externalId)
+    }
+}
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/UserManager.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/UserManager.kt
@@ -1,10 +1,18 @@
 package com.onesignal.user.internal
 
+import com.onesignal.common.IDManager
 import com.onesignal.common.OneSignalUtils
+import com.onesignal.common.events.EventProducer
+import com.onesignal.common.modeling.ISingletonModelStoreChangeHandler
+import com.onesignal.common.modeling.ModelChangedArgs
+import com.onesignal.common.modeling.ModelReplacedArgs
 import com.onesignal.core.internal.language.ILanguageContext
 import com.onesignal.debug.LogLevel
 import com.onesignal.debug.internal.logging.Logging
 import com.onesignal.user.IUserManager
+import com.onesignal.user.IUserStateObserver
+import com.onesignal.user.UserChangedState
+import com.onesignal.user.UserState
 import com.onesignal.user.internal.backend.IdentityConstants
 import com.onesignal.user.internal.identity.IdentityModel
 import com.onesignal.user.internal.identity.IdentityModelStore
@@ -19,7 +27,10 @@ internal open class UserManager(
     private val _identityModelStore: IdentityModelStore,
     private val _propertiesModelStore: PropertiesModelStore,
     private val _languageContext: ILanguageContext,
-) : IUserManager {
+) : IUserManager, ISingletonModelStoreChangeHandler<IdentityModel> {
+    val onesignalId: String?
+        get() = IDManager.getNonLocalIDOrNull(_identityModel.onesignalId)
+
     val externalId: String?
         get() = _identityModel.externalId
 
@@ -29,6 +40,8 @@ internal open class UserManager(
     val subscriptions: SubscriptionList
         get() = _subscriptionManager.subscriptions
 
+    val changeHandlersNotifier = EventProducer<IUserStateObserver>()
+
     override val pushSubscription: IPushSubscription
         get() = _subscriptionManager.subscriptions.push
 
@@ -42,6 +55,10 @@ internal open class UserManager(
         _languageContext.language = value
     }
 
+    init {
+        _identityModelStore.subscribe(this)
+    }
+
     override fun addAlias(
         label: String,
         id: String,
@@ -219,4 +236,45 @@ internal open class UserManager(
     override fun getTags(): Map<String, String> {
         return _propertiesModel.tags.toMap()
     }
+
+    override fun addObserver(observer: IUserStateObserver) {
+        changeHandlersNotifier.subscribe(observer)
+    }
+
+    override fun removeObserver(observer: IUserStateObserver) {
+        changeHandlersNotifier.unsubscribe(observer)
+    }
+
+    override fun onModelReplaced(
+        args: ModelReplacedArgs<IdentityModel>,
+        tag: String,
+    ) {
+        val oldUserState = UserState(args.oldModel[IdentityConstants.ONESIGNAL_ID], args.oldModel.externalId)
+        val newUserState = UserState(args.newModel.onesignalId, args.newModel.externalId)
+
+        // do not fire the callback if onesignalId is null or the new model is identical to the old model
+        if (newUserState.onesignalId == null ||
+            oldUserState.onesignalId.equals(newUserState.onesignalId) &&
+            oldUserState.externalId.equals(newUserState.externalId)
+        ) {
+            return
+        }
+        this.changeHandlersNotifier.fire {
+            it.onUserStateChange(UserChangedState(oldUserState, newUserState))
+        }
+    }
+
+    override fun onModelUpdated(
+        args: ModelChangedArgs,
+        tag: String,
+    ) {
+        if (args.property.equals(IdentityConstants.ONESIGNAL_ID)) {
+            val oldUserState = UserState(args.oldValue.toString(), externalId)
+            val newUserState = UserState(args.newValue.toString(), externalId)
+            this.changeHandlersNotifier.fire {
+                it.onUserStateChange(UserChangedState(oldUserState, newUserState))
+            }
+        }
+        Logging.debug(args.property)
+    }
 }
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/operations/impl/listeners/IdentityModelStoreListener.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/operations/impl/listeners/IdentityModelStoreListener.kt
@@ -1,5 +1,6 @@
 package com.onesignal.user.internal.operations.impl.listeners
 
+import com.onesignal.common.modeling.ModelReplacedArgs
 import com.onesignal.core.internal.config.ConfigModelStore
 import com.onesignal.core.internal.operations.IOperationRepo
 import com.onesignal.core.internal.operations.Operation
@@ -14,7 +15,7 @@ internal class IdentityModelStoreListener(
     opRepo: IOperationRepo,
     private val _configModelStore: ConfigModelStore,
 ) : SingletonModelStoreListener<IdentityModel>(store, opRepo) {
-    override fun getReplaceOperation(model: IdentityModel): Operation? {
+    override fun getReplaceOperation(model: ModelReplacedArgs<IdentityModel>): Operation? {
         // when the identity model is replaced, nothing to do on the backend. Already handled via login process.
         return null
     }
diff --git a/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/operations/impl/listeners/PropertiesModelStoreListener.kt b/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/operations/impl/listeners/PropertiesModelStoreListener.kt
@@ -1,5 +1,6 @@
 package com.onesignal.user.internal.operations.impl.listeners
 
+import com.onesignal.common.modeling.ModelReplacedArgs
 import com.onesignal.core.internal.config.ConfigModelStore
 import com.onesignal.core.internal.operations.IOperationRepo
 import com.onesignal.core.internal.operations.Operation
@@ -15,7 +16,7 @@ internal class PropertiesModelStoreListener(
     opRepo: IOperationRepo,
     private val _configModelStore: ConfigModelStore,
 ) : SingletonModelStoreListener<PropertiesModel>(store, opRepo) {
-    override fun getReplaceOperation(model: PropertiesModel): Operation? {
+    override fun getReplaceOperation(model: ModelReplacedArgs<PropertiesModel>): Operation? {
         // when the property model is replaced, nothing to do on the backend. Already handled via login process.
         return null
     }
diff --git a/OneSignalSDK/onesignal/core/src/test/java/com/onesignal/mocks/MockHelper.kt b/OneSignalSDK/onesignal/core/src/test/java/com/onesignal/mocks/MockHelper.kt
@@ -65,7 +65,7 @@ object MockHelper {
             action(identityModel)
         }
 
-        val mockIdentityStore = mockk<IdentityModelStore>()
+        val mockIdentityStore = mockk<IdentityModelStore>(relaxed = true)
 
         every { mockIdentityStore.model } returns identityModel
 
diff --git a/OneSignalSDK/onesignal/in-app-messages/src/main/java/com/onesignal/inAppMessages/internal/InAppMessagesManager.kt b/OneSignalSDK/onesignal/in-app-messages/src/main/java/com/onesignal/inAppMessages/internal/InAppMessagesManager.kt
@@ -8,6 +8,7 @@ import com.onesignal.common.events.EventProducer
 import com.onesignal.common.exceptions.BackendException
 import com.onesignal.common.modeling.ISingletonModelStoreChangeHandler
 import com.onesignal.common.modeling.ModelChangedArgs
+import com.onesignal.common.modeling.ModelReplacedArgs
 import com.onesignal.common.threading.suspendifyOnThread
 import com.onesignal.core.internal.application.IApplicationService
 import com.onesignal.core.internal.config.ConfigModel
@@ -184,7 +185,7 @@ internal class InAppMessagesManager(
     }
 
     override fun onModelReplaced(
-        model: ConfigModel,
+        model: ModelReplacedArgs<ConfigModel>,
         tag: String,
     ) {
         suspendifyOnThread {
diff --git a/OneSignalSDK/onesignal/notifications/consumer-rules.pro b/OneSignalSDK/onesignal/notifications/consumer-rules.pro
diff --git a/OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/listeners/DeviceRegistrationListener.kt b/OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/listeners/DeviceRegistrationListener.kt

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ open class EventProducer<THandler> : IEventNotifier<THandler> {`
`44`	`44`	`*`
`45`	`45`	`* @param callback The callback will be invoked for each subscribed handler, allowing you to call the handler.`
`46`	`46`	`*/`
`47`		`- fun fire(callback: (THandler) -> Unit) {`
	`47`	`+ open fun fire(callback: (THandler) -> Unit) {`
`48`	`48`	`synchronized(subscribers) {`
`49`	`49`	`for (s in subscribers) {`
`50`	`50`	`callback(s)`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ interface ISingletonModelStoreChangeHandler<TModel> where TModel : Model {`
`12`	`12`	`* @param tag The tag which identifies how/why the model was replaced.`
`13`	`13`	`*/`
`14`	`14`	`fun onModelReplaced(`
`15`		`- model: TModel,`
	`15`	`+ model: ModelReplacedArgs<TModel>,`
`16`	`16`	`tag: String,`
`17`	`17`	`)`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -38,10 +38,12 @@ open class SingletonModelStore<TModel>(`
`38`	`38`	`tag: String,`
`39`	`39`	`) {`
`40`	`40`	`synchronized(replaceLock) {`
	`41`	`+ val oldModel = this.store.create() ?: throw Exception("Unable to initialize model from store $store")`
	`42`	`+ oldModel.initializeFromModel(singletonId, this.model)`
`41`	`43`	`val existingModel = this.model`
`42`	`44`	`existingModel.initializeFromModel(singletonId, model)`
`43`	`45`	`store.persist()`
`44`		`- changeSubscription.fire { it.onModelReplaced(existingModel, tag) }`
	`46`	`+ changeSubscription.fire { it.onModelReplaced(ModelReplacedArgs(oldModel, existingModel), tag) }`
`45`	`47`	`}`
`46`	`48`	`}`
`47`	`49`