Merge pull request #1681 from OneSignal/user-model/login-identity

[User Model] New login process and operation repo updates

Author: brismithers

Examples/OneSignalDemo/app/src/main/java/com/onesignal/sdktest/model/MainActivityViewModel.java

@@ -395,10 +395,11 @@ private void setupAppLayout() {
 
         switchUserButton.setOnClickListener(v -> {
             if(isLoggedIn) {
-                OneSignal.logout();
-                isLoggedIn = false;
-                switchUserButton.setText(R.string.login_user);
-                refreshState();
+                OneSignal.logout(Continue.with(r -> {
+                    isLoggedIn = false;
+                    switchUserButton.setText(R.string.login_user);
+                    refreshState();
+                }));
             }
             else {
                 dialog.createUpdateAlertDialog(OneSignal.getUser().getExternalId(), Dialog.DialogAction.LOGIN, ProfileUtil.FieldType.EXTERNAL_USER_ID, new UpdateAlertDialogCallback() {

OneSignalSDK/onesignal/iam/src/main/java/com/onesignal/iam/internal/IAMManager.kt

@@ -4,9 +4,9 @@ import android.app.AlertDialog
 import com.onesignal.common.AndroidUtils
 import com.onesignal.common.IDManager
 import com.onesignal.common.JSONUtils
-import com.onesignal.common.exceptions.BackendException
 import com.onesignal.common.events.CallbackProducer
 import com.onesignal.common.events.ICallbackProducer
+import com.onesignal.common.exceptions.BackendException
 import com.onesignal.common.modeling.ISingletonModelStoreChangeHandler
 import com.onesignal.common.modeling.ModelChangedArgs
 import com.onesignal.common.threading.suspendifyOnThread
@@ -193,7 +193,7 @@ internal class IAMManager(
         val appId = _configModelStore.model.appId
         val subscriptionId = _subscriptionManager.subscriptions.push?.id
 
-        if (subscriptionId == null || IDManager.isIdLocalOnly(subscriptionId) || appId.isEmpty()) {
+        if (subscriptionId == null || IDManager.isLocalId(subscriptionId) || appId.isEmpty()) {
             return
         }
 

OneSignalSDK/onesignal/notification/src/main/java/com/onesignal/notification/internal/NotificationsManager.kt

@@ -1,8 +1,8 @@
 package com.onesignal.notification.internal
 
 import android.app.Activity
-import com.onesignal.common.exceptions.BackendException
 import com.onesignal.common.events.EventProducer
+import com.onesignal.common.exceptions.BackendException
 import com.onesignal.common.threading.suspendifyOnMain
 import com.onesignal.common.threading.suspendifyOnThread
 import com.onesignal.core.internal.application.IApplicationService

OneSignalSDK/onesignal/src/main/java/com/onesignal/IOneSignal.kt

@@ -113,5 +113,5 @@ interface IOneSignal {
      * be retrieved, except through this device as long as the app remains installed and the app
      * data is not cleared.
      */
-    fun logout()
+    suspend fun logout()
 }

OneSignalSDK/onesignal/src/main/java/com/onesignal/OneSignal.kt

@@ -178,7 +178,7 @@ object OneSignal {
      * data is not cleared.
      */
     @JvmStatic
-    fun logout() = oneSignal.logout()
+    suspend fun logout() = oneSignal.logout()
 
     private val oneSignal: IOneSignal by lazy {
         OneSignalImp()

OneSignalSDK/onesignal/src/main/java/com/onesignal/common/IDManager.kt

@@ -3,55 +3,27 @@ package com.onesignal.common
 import java.util.UUID
 
 /**
- * Manages IDs that are initially generated locally, then regenerated on the backend. Generally when
- * resources are created they are first created with a locally generated ID.  Once the resource
- * has been created on the backend that local ID is replaced with the backend one.
- *
- * The [IDManager] is able to handle IDs created locally in one application instance, and detected
- * as local/translated in a subsequent application instance.
+ * Manages IDs that are created locally.  Has the ability to generate globally unique identifiers
+ * and detect whether a provided ID was generated locally.
  */
 object IDManager {
     private const val LOCAL_PREFIX = "local-"
-    private val _localIdMap = mutableMapOf<String, String?>()
 
     /**
      * Create a new local ID to be used temporarily prior to backend generation.
      *
      * @return A new locally generated ID.
      */
     fun createLocalId(): String {
-        val newID = "$LOCAL_PREFIX${UUID.randomUUID()}"
-        _localIdMap[newID] = null
-        return newID
+        return "$LOCAL_PREFIX${UUID.randomUUID()}"
     }
 
     /**
-     * Set the backend-generated ID for the previously locally-generated ID.
-     *
-     * @param localId The locally-generated ID previously generated via [createLocalId].
-     * @param backendId The backend-generated ID.
-     */
-    fun setLocalToBackendIdTranslation(localId: String, backendId: String) {
-        _localIdMap[localId] = backendId
-    }
-
-    /**
-     * Determine whether the ID provided is locally generated, and has yet to have a backend-generated ID.
+     * Determine whether the ID provided is locally generated.
      *
      * @param id The ID to test.
      *
-     * @return true if the [id] provided was created via [createLocalId], but has not yet had
-     * a backend-generated ID set via [setLocalToBackendIdTranslation].
-     */
-    fun isIdLocalOnly(id: String): Boolean = id.startsWith(LOCAL_PREFIX)
-
-    /**
-     * Retrieve the provided ID.  Will retrieve the backend-generated ID if there is one, falling
-     * back to the provided ID if there is not.
-     *
-     * @param id The ID to retrieve.
-     *
-     * @return The backend-generated ID, or the ID provided if there is no backend-generated ID.
+     * @return true if the [id] provided was created via [createLocalId].
      */
-    fun retrieveId(id: String): String = _localIdMap[id] ?: id
+    fun isLocalId(id: String): Boolean = id.startsWith(LOCAL_PREFIX)
 }

OneSignalSDK/onesignal/src/main/java/com/onesignal/common/JSONObjectExtensions.kt

@@ -17,6 +17,21 @@ fun JSONObject.safeInt(name: String): Int? {
     return null
 }
 
+/**
+ * Retrieve an [Long] from the [JSONObject] safely.
+ *
+ * @param name The name of the attribute that contains an [Int] value.
+ *
+ * @return The [Long] value if it exists, null otherwise.
+ */
+fun JSONObject.safeLong(name: String): Long? {
+    if (this.has(name)) {
+        return this.getLong(name)
+    }
+
+    return null
+}
+
 /**
  * Retrieve a [Boolean] from the [JSONObject] safely.
  *

OneSignalSDK/onesignal/src/main/java/com/onesignal/core/internal/backend/IParamsBackendService.kt

@@ -30,6 +30,7 @@ class ParamsObject(
     var unsubscribeWhenNotificationsDisabled: Boolean? = null,
     var locationShared: Boolean? = null,
     var requiresUserPrivacyConsent: Boolean? = null,
+    var opRepoExecutionInterval: Long? = null,
     var influenceParams: InfluenceParamsObject,
     var fcmParams: FCMParamsObject
 )

OneSignalSDK/onesignal/src/main/java/com/onesignal/core/internal/backend/impl/ParamsBackendService.kt

@@ -1,9 +1,11 @@
 package com.onesignal.core.internal.backend.impl
 
+import com.onesignal.common.IDManager
 import com.onesignal.common.exceptions.BackendException
 import com.onesignal.common.expand
 import com.onesignal.common.safeBool
 import com.onesignal.common.safeInt
+import com.onesignal.common.safeLong
 import com.onesignal.common.safeString
 import com.onesignal.core.internal.backend.FCMParamsObject
 import com.onesignal.core.internal.backend.IParamsBackendService
@@ -23,7 +25,7 @@ internal class ParamsBackendService(
         Logging.log(LogLevel.DEBUG, "ParamsBackendService.fetchParams(appId: $appId, subscriptionId: $subscriptionId)")
 
         var paramsUrl = "apps/$appId/android_params.js"
-        if (subscriptionId != null) {
+        if (subscriptionId != null && !IDManager.isLocalId(subscriptionId)) {
             paramsUrl += "?player_id=$subscriptionId"
         }
 
@@ -64,6 +66,7 @@ internal class ParamsBackendService(
             unsubscribeWhenNotificationsDisabled = responseJson.safeBool("unsubscribe_on_notifications_disabled"),
             locationShared = responseJson.safeBool("location_shared"),
             requiresUserPrivacyConsent = responseJson.safeBool("requires_user_privacy_consent"),
+            opRepoExecutionInterval = responseJson.safeLong("oprepo_execution_interval"), // TODO: New
             influenceParams = influenceParams ?: InfluenceParamsObject(),
             fcmParams = fcmParams ?: FCMParamsObject()
         )

OneSignalSDK/onesignal/src/main/java/com/onesignal/core/internal/config/ConfigModel.kt

@@ -61,6 +61,14 @@ class ConfigModel : Model() {
         get() = getProperty(::sessionFocusTimeout.name) { 30000 }
         set(value) { setProperty(::sessionFocusTimeout.name, value) }
 
+    /**
+     * The minimum number of milliseconds required to pass before executing another operation on
+     * the queue.
+     */
+    var opRepoExecutionInterval: Long
+        get() = getProperty(::opRepoExecutionInterval.name) { 5000 }
+        set(value) { setProperty(::opRepoExecutionInterval.name, value) }
+
     /**
      * The minimum number of milliseconds required to pass to allow the fetching of IAM to occur.
      */
@@ -79,7 +87,7 @@ class ConfigModel : Model() {
      * Whether the current application is an enterprise-level
      */
     var enterprise: Boolean
-        get() = getProperty(::enterprise.name)
+        get() = getProperty(::enterprise.name) { false }
         set(value) { setProperty(::enterprise.name, value) }
 
     /**
@@ -107,14 +115,14 @@ class ConfigModel : Model() {
      * Whether to honor TTL for notifications
      */
     var restoreTTLFilter: Boolean
-        get() = getProperty(::restoreTTLFilter.name) { false }
+        get() = getProperty(::restoreTTLFilter.name) { true }
         set(value) { setProperty(::restoreTTLFilter.name, value) }
 
     /**
      * Whether to track notification receive receipts
      */
     var receiveReceiptEnabled: Boolean
-        get() = getProperty(::receiveReceiptEnabled.name) { true }
+        get() = getProperty(::receiveReceiptEnabled.name) { false }
         set(value) { setProperty(::receiveReceiptEnabled.name, value) }
 
     /**