Merge branch 'master' into release/7.0.0

Author: hborisoff

AndroidSDKCore/build.gradle

@@ -42,7 +42,7 @@ dependencies {
     api "androidx.legacy:legacy-support-v4:1.0.0"
     api "androidx.appcompat:appcompat:${APPCOMPAT_LIBRARY_VERSION}"
 
-    api "com.clevertap.android:clevertap-android-sdk:4.6.4"
+    api "com.clevertap.android:clevertap-android-sdk:4.6.5"
 }
 
 task generateJavadoc(type: Javadoc) {

AndroidSDKCore/src/main/java/com/clevertap/android/sdk/CTUtils.kt

@@ -0,0 +1,29 @@
+package com.clevertap.android.sdk
+
+import android.annotation.SuppressLint
+import com.clevertap.android.sdk.task.CTExecutorFactory
+import com.clevertap.android.sdk.task.Task
+
+object CTUtils {
+
+  @SuppressLint("RestrictedApi")
+  fun ensureLocalDataStoreValue(key: String, cleverTapApi: CleverTapAPI) {
+    val value = cleverTapApi.coreState.localDataStore.getProfileValueForKey(key)
+    if (value == null) {
+      cleverTapApi.coreState.localDataStore.setProfileField(key, "")
+    }
+  }
+
+  @SuppressLint("RestrictedApi")
+  fun addMultiValueForKey(key: String, value: String, cleverTapApi: CleverTapAPI) {
+    CTExecutorFactory
+      .executors(cleverTapApi.coreState.config)
+      .postAsyncSafelyTask<Task<Void>>()
+      .execute("CTUtils") {
+        ensureLocalDataStoreValue(key, cleverTapApi)
+        cleverTapApi.addMultiValueForKey(key, value)
+        null
+      }
+  }
+
+}

AndroidSDKCore/src/main/java/com/leanplum/migration/MigrationConstants.kt

@@ -27,6 +27,8 @@ import com.leanplum.internal.Log
 object MigrationConstants {
   const val IDENTITY = "Identity"
   const val STATE_PREFIX = "state_"
+  const val ANONYMOUS_DEVICE_PROPERTY = "lp_device"
+  const val DEVICES_USER_PROPERTY = "lp_devices"
 
   const val CHARGED_EVENT_PARAM = "event"
   const val VALUE_PARAM = "value"

AndroidSDKCore/src/main/java/com/leanplum/migration/wrapper/CTWrapper.kt

@@ -25,6 +25,7 @@ import android.app.Application
 import android.content.Context
 import android.text.TextUtils
 import com.clevertap.android.sdk.ActivityLifecycleCallback
+import com.clevertap.android.sdk.CTUtils
 import com.clevertap.android.sdk.CleverTapAPI
 import com.clevertap.android.sdk.CleverTapInstanceConfig
 import com.clevertap.android.sdk.pushnotification.PushConstants
@@ -54,8 +55,8 @@ internal class CTWrapper(
   private var cleverTapInstance: CleverTapAPI? = null
   private var instanceCallback: CleverTapInstanceCallback? = null
 
-  private var firstTimeStart = IdentityManager.isStateUndefined()
   private var identityManager = IdentityManager(deviceId, userId ?: deviceId)
+  private var firstTimeStart = identityManager.isFirstTimeStart()
 
   override fun launch(context: Context, callback: CleverTapInstanceCallback?) {
     instanceCallback = callback
@@ -84,9 +85,11 @@ internal class CTWrapper(
       }
       if (identityManager.isAnonymous()) {
         Log.d("Wrapper: identity not set for anonymous user")
+        setAnonymousDeviceProperty()
       } else {
         Log.d("Wrapper: will call onUserLogin with $profile and __h$cleverTapId")
         onUserLogin(profile, cleverTapId)
+        setDevicesProperty()
       }
       Log.d("Wrapper: CleverTap instance created by Leanplum")
     }
@@ -142,15 +145,34 @@ internal class CTWrapper(
 
   override fun setUserId(userId: String?) {
     if (userId == null || userId.isEmpty()) return
-    if (identityManager.getUserId() == userId) return
 
-    identityManager.setUserId(userId)
+    if (!identityManager.setUserId(userId)) {
+      // trying to set same userId
+      return
+    }
 
     val cleverTapId = identityManager.cleverTapId()
     val profile = identityManager.profile()
 
     Log.d("Wrapper: Leanplum.setUserId will call onUserLogin with $profile and __h$cleverTapId")
     cleverTapInstance?.onUserLogin(profile, cleverTapId)
+    cleverTapInstance?.setDevicesProperty()
+  }
+
+  private fun CleverTapAPI.setAnonymousDeviceProperty() {
+    if (identityManager.isDeviceIdHashed()) {
+      val deviceId = identityManager.getOriginalDeviceId()
+      Log.d("Wrapper: property ${MigrationConstants.ANONYMOUS_DEVICE_PROPERTY} set $deviceId")
+      pushProfile(mapOf(MigrationConstants.ANONYMOUS_DEVICE_PROPERTY to deviceId))
+    }
+  }
+
+  private fun CleverTapAPI.setDevicesProperty() {
+    if (identityManager.isDeviceIdHashed()) {
+      val deviceId = identityManager.getOriginalDeviceId()
+      Log.d("Wrapper: property ${MigrationConstants.DEVICES_USER_PROPERTY} add $deviceId")
+      CTUtils.addMultiValueForKey(MigrationConstants.DEVICES_USER_PROPERTY, deviceId, this)
+    }
   }
 
   /**

AndroidSDKCore/src/main/java/com/leanplum/migration/wrapper/IdentityManager.kt

@@ -25,11 +25,17 @@ import com.leanplum.internal.Log
 import com.leanplum.migration.MigrationConstants
 import com.leanplum.utils.StringPreference
 import com.leanplum.utils.StringPreferenceNullable
+import kotlin.properties.ReadWriteProperty
+
+private const val UNDEFINED = "undefined"
+private const val ANONYMOUS = "anonymous"
+private const val IDENTIFIED = "identified"
 
 /**
  * Scheme for migrating user profile is as follows:
  *   - anonymous is translated to <CTID=deviceId, Identity=null>
- *   - non-anonymous to <CTID=deviceId_userId, Identity=userId>
+ *   - non-anonymous to <CTID=deviceId_hash(userId), Identity=userId>
+ * Where deviceId is also hashed if it is longer than 50 characters or contains invalid symbols.
  *
  * When you login, but previous profile is anonymous, a merge should happen. CT SDK allows merges
  * only when the CTID remains the same, meaning that the merged profile would get the anonymous
@@ -42,7 +48,7 @@ import com.leanplum.utils.StringPreferenceNullable
  * 1. "undefined" state
  *
  * Wrapper hasn't been started even once, meaning that anonymous profile doesn't exist, so use the
- * "deviceId_userId" scheme.
+ * "deviceId_hash(userId)" scheme.
  *
  * 2. "anonymous" state
  *
@@ -51,32 +57,33 @@ import com.leanplum.utils.StringPreferenceNullable
  *
  * 3. "identified" state
  *
- * Wrapper has been started and previous user is not anonymous - use the "deviceId_userId" scheme.
+ * Wrapper has been started and previous user is not anonymous - use the "deviceId_hash(userId)"
+ * scheme.
  */
-internal class IdentityManager(
-  private val deviceId: String,
-  private var userId: String
+class IdentityManager(
+  deviceId: String,
+  userId: String,
+  stateDelegate: ReadWriteProperty<Any, String> = StringPreference("ct_login_state", UNDEFINED),
+  mergeUserDelegate: ReadWriteProperty<Any, String?> = StringPreferenceNullable("ct_anon_merge_userid"),
 ) {
 
-  companion object {
-    private const val UNDEFINED = "undefined"
-    private const val ANONYMOUS = "anonymous"
-    private const val IDENTIFIED = "identified"
-
-    private var anonymousMergeUserId: String? by StringPreferenceNullable("ct_anon_merge_userid")
-    private var state: String by StringPreference("ct_login_state", UNDEFINED)
-    fun isStateUndefined() = state == UNDEFINED
-  }
+  private val identity: LPIdentity = LPIdentity(deviceId = deviceId, userId = userId)
+  private var state: String by stateDelegate
+  private val startState: String
+  private var anonymousMergeUserId: String? by mergeUserDelegate
 
   init {
+    startState = state
     if (isAnonymous()) {
       loginAnonymously()
     } else {
       loginIdentified()
     }
   }
 
-  fun isAnonymous() = userId == deviceId
+  fun isAnonymous() = identity.isAnonymous()
+
+  fun isFirstTimeStart() = startState == UNDEFINED
 
   private fun loginAnonymously() {
     state = ANONYMOUS
@@ -87,31 +94,40 @@ internal class IdentityManager(
       state = IDENTIFIED
     }
     else if (state == ANONYMOUS) {
-      anonymousMergeUserId = userId
+      anonymousMergeUserId = identity.userId()
       Log.d("Wrapper: anonymous data will be merged to $anonymousMergeUserId")
       state = IDENTIFIED
     }
   }
 
   fun cleverTapId(): String {
-    return when (userId) {
-      deviceId -> deviceId
-      anonymousMergeUserId -> deviceId
-      else -> "${deviceId}_${userId}"
+    if (identity.isAnonymous()) {
+      return identity.deviceId()
+    } else if (identity.userId() == anonymousMergeUserId) {
+      return identity.deviceId()
+    } else {
+      return "${identity.deviceId()}_${identity.userId()}"
     }
   }
 
-  fun profile() = mapOf(MigrationConstants.IDENTITY to userId)
+  fun profile() = mapOf(MigrationConstants.IDENTITY to identity.originalUserId())
+
+  fun setUserId(userId: String): Boolean {
+    if (!identity.setUserId(userId)) {
+      // trying to set same userId
+      return false
+    }
 
-  fun setUserId(userId: String) {
     if (state == ANONYMOUS) {
-      anonymousMergeUserId = userId
+      anonymousMergeUserId = identity.userId()
       Log.d("Wrapper: anonymous data will be merged to $anonymousMergeUserId")
       state = IDENTIFIED
     }
-    this.userId = userId
+    return true;
   }
 
-  fun getUserId() = userId
+  fun isDeviceIdHashed() = identity.originalDeviceId() != identity.deviceId()
+
+  fun getOriginalDeviceId() = identity.originalDeviceId()
 
 }

AndroidSDKCore/src/main/java/com/leanplum/migration/wrapper/LPIdentity.kt

@@ -0,0 +1,37 @@
+package com.leanplum.migration.wrapper
+
+import com.clevertap.android.sdk.Utils
+import com.leanplum.utils.HashUtil
+
+private const val DEVICE_ID_MAX_LENGTH = 50
+
+class LPIdentity(
+  private val deviceId: String,
+  private var userId: String
+) {
+
+  private var deviceIdHash: String? = null
+  private var userIdHash: String? = null
+
+  init {
+    if (deviceId.length > DEVICE_ID_MAX_LENGTH || !Utils.validateCTID(deviceId)) {
+      deviceIdHash = HashUtil.sha256_200(deviceId)
+    }
+    userIdHash = HashUtil.sha256_40(userId)
+  }
+
+  fun deviceId() = deviceIdHash ?: deviceId
+  fun originalDeviceId() = deviceId
+  fun userId() = userIdHash
+  fun originalUserId() = userId
+  fun isAnonymous() = userId == deviceId
+
+  fun setUserId(userId: String): Boolean {
+    if (this.userId == userId) {
+      return false
+    }
+    this.userId = userId
+    this.userIdHash = HashUtil.sha256_40(userId)
+    return true
+  }
+}

AndroidSDKCore/src/main/java/com/leanplum/utils/HashUtil.kt

@@ -0,0 +1,31 @@
+package com.leanplum.utils
+
+import java.security.MessageDigest
+
+object HashUtil {
+
+  private fun ByteArray.toHex(limit: Int): String =
+    joinToString(separator = "", limit = limit, truncated = "") { eachByte ->
+      "%02x".format(eachByte)
+    }
+
+  /**
+   * Returns hexadecimal representation of sha256 on the input string.
+   */
+  fun sha256(text: String, limit: Int = 32): String {
+    return MessageDigest
+      .getInstance("SHA-256")
+      .digest(text.toByteArray(Charsets.UTF_8))
+      .toHex(limit)
+  }
+
+  /**
+   * Get first 10 symbols from hexadecimal representation of sha256.
+   */
+  fun sha256_40(text: String) = sha256(text, 5)
+
+  /**
+   * Get first 50 symbols from hexadecimal representation of sha256.
+   */
+  fun sha256_200(text: String) = sha256(text, 25)
+}