feat!: register device attributes when set

levibostian · web-flow · commit 0f5159ef5848 · 2022-05-06T19:50:17.000+08:00
diff --git a/app/src/main/java/io/customer/example/MainActivity.kt b/app/src/main/java/io/customer/example/MainActivity.kt
@@ -24,7 +24,7 @@ class MainActivity : AppCompatActivity() {
     }
 
     private fun makeAddCustomDeviceAttributesRequest() {
-        CustomerIO.instance().deviceAttributes.putAll(mapOf("bingo" to "heyaa"))
+        CustomerIO.instance().deviceAttributes = mapOf("bingo" to "heyaa")
     }
 
     private fun makeRegisterDeviceRequest() {
diff --git a/sdk/src/main/java/io/customer/sdk/CustomerIO.kt b/sdk/src/main/java/io/customer/sdk/CustomerIO.kt
@@ -302,7 +302,12 @@ class CustomerIO internal constructor(
      * Use to provide additional and custom device attributes
      * apart from the ones the SDK is programmed to send to customer workspace.
      */
-    val deviceAttributes: MutableMap<String, Any> = mutableMapOf()
+    var deviceAttributes: CustomAttributes = emptyMap()
+        set(value) {
+            field = value
+
+            api.addCustomDeviceAttributes(value)
+        }
 
     private fun recordScreenViews(activity: Activity, attributes: CustomAttributes) {
         val packageManager = activity.packageManager
diff --git a/sdk/src/main/java/io/customer/sdk/CustomerIOClient.kt b/sdk/src/main/java/io/customer/sdk/CustomerIOClient.kt
@@ -123,6 +123,19 @@ internal class CustomerIOClient(
         backgroundQueue.queueRegisterDevice(identifiedProfileId, device)
     }
 
+    override fun addCustomDeviceAttributes(attributes: CustomAttributes) {
+        logger.debug("adding custom device attributes request made")
+
+        val existingDeviceToken = preferenceRepository.getDeviceToken()
+
+        if (existingDeviceToken == null) {
+            logger.debug("no device token yet registered. ignoring request to add custom device attributes")
+            return
+        }
+
+        registerDeviceToken(existingDeviceToken, attributes)
+    }
+
     private fun createDeviceAttributes(customAddedAttributes: CustomAttributes): Map<String, Any> {
         if (!config.autoTrackDeviceAttributes) return customAddedAttributes
 
diff --git a/sdk/src/main/java/io/customer/sdk/api/CustomerIOApi.kt b/sdk/src/main/java/io/customer/sdk/api/CustomerIOApi.kt
@@ -8,6 +8,7 @@ internal interface CustomerIOApi {
     fun track(name: String, attributes: CustomAttributes)
     fun clearIdentify()
     fun registerDeviceToken(deviceToken: String, attributes: CustomAttributes)
+    fun addCustomDeviceAttributes(attributes: CustomAttributes)
     fun deleteDeviceToken()
     fun trackMetric(deliveryID: String, event: MetricEvent, deviceToken: String)
     fun screen(name: String, attributes: CustomAttributes)
diff --git a/sdk/src/sharedTest/java/io/customer/sdk/CustomerIOClientTest.kt b/sdk/src/sharedTest/java/io/customer/sdk/CustomerIOClientTest.kt
@@ -221,6 +221,44 @@ class CustomerIOClientTest : BaseTest() {
         prefRepository.getDeviceToken() shouldBeEqualTo givenDeviceToken
     }
 
+    // addCustomDeviceAttributes
+
+    @Test
+    fun addCustomDeviceAttributes_givenNoPushToken_expectDoNotRegisterPushToken() {
+        val givenAttributes = mapOf(String.random to String.random)
+
+        customerIOClient.addCustomDeviceAttributes(givenAttributes)
+
+        // no token registered
+        verifyNoInteractions(backgroundQueueMock)
+    }
+
+    @Test
+    fun addCustomDeviceAttributes_givenExistingPushToken_expectRegisterPushTokenAndAttributes() {
+        val givenAttributes = mapOf(String.random to String.random)
+        val givenDeviceToken = String.random
+        val givenIdentifier = String.random
+        prefRepository.saveDeviceToken(givenDeviceToken)
+        prefRepository.saveIdentifier(givenIdentifier)
+
+        customerIOClient.addCustomDeviceAttributes(givenAttributes)
+
+        // a token got registered
+        verify(backgroundQueueMock).addTask(
+            QueueTaskType.RegisterDeviceToken,
+            RegisterPushNotificationQueueTaskData(
+                givenIdentifier,
+                Device(
+                    token = givenDeviceToken,
+                    lastUsed = dateUtilStub.givenDate,
+                    attributes = deviceStore.buildDeviceAttributes() + givenAttributes
+                )
+            ),
+            groupStart = QueueTaskGroup.RegisterPushToken(givenDeviceToken),
+            blockingGroups = listOf(QueueTaskGroup.IdentifyProfile(givenIdentifier))
+        )
+    }
+
     // deleteDeviceToken
 
     @Test
diff --git a/sdk/src/sharedTest/java/io/customer/sdk/CustomerIOTest.kt b/sdk/src/sharedTest/java/io/customer/sdk/CustomerIOTest.kt
@@ -13,6 +13,7 @@ import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.mockito.kotlin.mock
+import org.mockito.kotlin.verify
 
 @RunWith(AndroidJUnit4::class)
 class CustomerIOTest : BaseTest() {
@@ -52,4 +53,13 @@ class CustomerIOTest : BaseTest() {
         actual.urlHandler.shouldNotBeNull()
         actual.autoTrackScreenViews shouldBeEqualTo true
     }
+
+    @Test
+    fun deviceAttributes_givenSetValue_expectMakeRequestToAddAttributes() {
+        val givenAttributes = mapOf(String.random to String.random)
+
+        customerIO.deviceAttributes = givenAttributes
+
+        verify(apiMock).addCustomDeviceAttributes(givenAttributes)
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class MainActivity : AppCompatActivity() {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`private fun makeAddCustomDeviceAttributesRequest() {`
`27`		`- CustomerIO.instance().deviceAttributes.putAll(mapOf("bingo" to "heyaa"))`
	`27`	`+ CustomerIO.instance().deviceAttributes = mapOf("bingo" to "heyaa")`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`private fun makeRegisterDeviceRequest() {`