feat: automatic screen tracking (customerio#52)

app/src/main/AndroidManifest.xml

@@ -17,6 +17,7 @@
         tools:targetApi="m">
         <activity
             android:name="io.customer.example.MainActivity"
+            android:label="Home"
             android:exported="true">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />

sdk/src/main/java/io/customer/sdk/CustomerIO.kt

@@ -1,7 +1,12 @@
 package io.customer.sdk
 
-import android.content.Context
+import android.app.Activity
+import android.app.Application
+import android.content.pm.PackageManager
 import io.customer.base.comunication.Action
+import io.customer.base.data.ErrorResult
+import io.customer.base.error.ErrorDetail
+import io.customer.base.utils.ActionUtils
 import io.customer.sdk.api.CustomerIOApi
 import io.customer.sdk.data.communication.CustomerIOUrlHandler
 import io.customer.sdk.data.model.Region
@@ -41,10 +46,13 @@ class CustomerIO internal constructor(
         private val siteId: String,
         private val apiKey: String,
         private var region: Region = Region.US,
-        private val appContext: Context
+        private val appContext: Application
     ) {
         private var timeout = 6000L
         private var urlHandler: CustomerIOUrlHandler? = null
+        private var shouldAutoRecordScreenViews: Boolean = false
+
+        private lateinit var activityLifecycleCallback: CustomerIOActivityLifecycleCallbacks
 
         fun setRegion(region: Region): Builder {
             this.region = region
@@ -56,6 +64,11 @@ class CustomerIO internal constructor(
             return this
         }
 
+        fun autoTrackScreenViews(shouldRecordScreenViews: Boolean): Builder {
+            this.shouldAutoRecordScreenViews = shouldRecordScreenViews
+            return this
+        }
+
         /**
          * Override url/deep link handling
          *
@@ -81,7 +94,8 @@ class CustomerIO internal constructor(
                 apiKey = apiKey,
                 region = region,
                 timeout = timeout,
-                urlHandler = urlHandler
+                urlHandler = urlHandler,
+                autoTrackScreenViews = shouldAutoRecordScreenViews
             )
 
             val customerIoComponent =
@@ -90,8 +104,12 @@ class CustomerIO internal constructor(
             val client = CustomerIO(
                 config = config,
                 store = customerIoComponent.buildStore(),
-                api = customerIoComponent.buildApi()
+                api = customerIoComponent.buildApi(),
             )
+
+            activityLifecycleCallback = CustomerIOActivityLifecycleCallbacks(client)
+            appContext.registerActivityLifecycleCallbacks(activityLifecycleCallback)
+
             instance = client
             return client
         }
@@ -141,6 +159,18 @@ class CustomerIO internal constructor(
         attributes: Map<String, Any> = emptyMap()
     ) = api.screen(name, attributes)
 
+    /**
+     * Track activity screen, `label` added for this activity in `manifest` will be utilized for tracking
+
+     * @param activity Instance of the activity you want to track.
+     * @param attributes Optional event body in Map format used as JSON object
+     * @return Action<Unit> which can be accessed via `execute` or `enqueue`
+     */
+    fun screen(
+        activity: Activity,
+        attributes: Map<String, Any> = emptyMap()
+    ) = recordScreenViews(activity, attributes)
+
     /**
      * Stop identifying the currently persisted customer. All future calls to the SDK will no longer
      * be associated with the previously identified customer.
@@ -178,4 +208,19 @@ class CustomerIO internal constructor(
         event = event,
         deviceToken = deviceToken
     )
+
+    private fun recordScreenViews(activity: Activity, attributes: Map<String, Any>): Action<Unit> {
+        val packageManager = activity.packageManager
+        return try {
+            val info = packageManager.getActivityInfo(
+                activity.componentName, PackageManager.GET_META_DATA
+            )
+            val activityLabel = info.loadLabel(packageManager)
+            screen(activityLabel.toString(), attributes)
+        } catch (e: PackageManager.NameNotFoundException) {
+            ActionUtils.getErrorAction(ErrorResult(error = ErrorDetail(message = "Activity Not Found: $e")))
+        } catch (e: Exception) {
+            ActionUtils.getErrorAction(ErrorResult(error = ErrorDetail(message = "Unable to track, $activity")))
+        }
+    }
 }

sdk/src/main/java/io/customer/sdk/CustomerIOActivityLifecycleCallbacks.kt

@@ -0,0 +1,34 @@
+package io.customer.sdk
+
+import android.app.Activity
+import android.app.Application.ActivityLifecycleCallbacks
+import android.os.Bundle
+
+class CustomerIOActivityLifecycleCallbacks internal constructor(
+    private val customerIO: CustomerIO
+) : ActivityLifecycleCallbacks {
+
+    override fun onActivityCreated(activity: Activity, bundle: Bundle?) {
+    }
+
+    override fun onActivityStarted(activity: Activity) {
+        if (customerIO.config.autoTrackScreenViews) {
+            customerIO.screen(activity).enqueue()
+        }
+    }
+
+    override fun onActivityResumed(activity: Activity) {
+    }
+
+    override fun onActivityPaused(activity: Activity) {
+    }
+
+    override fun onActivityStopped(activity: Activity) {
+    }
+
+    override fun onActivitySaveInstanceState(activity: Activity, bundle: Bundle) {
+    }
+
+    override fun onActivityDestroyed(activity: Activity) {
+    }
+}

sdk/src/main/java/io/customer/sdk/CustomerIOConfig.kt

@@ -8,5 +8,6 @@ class CustomerIOConfig(
     val apiKey: String,
     val region: Region,
     val timeout: Long,
-    val urlHandler: CustomerIOUrlHandler?
+    val urlHandler: CustomerIOUrlHandler?,
+    val autoTrackScreenViews: Boolean
 )

sdk/src/test/java/io/customer/sdk/CustomerIOTest.kt

@@ -32,6 +32,7 @@ internal class CustomerIOTest {
         customerIO.config.timeout `should be equal to` MockCustomerIOBuilder.timeout.toLong()
         customerIO.config.region `should be equal to` MockCustomerIOBuilder.region
         customerIO.config.urlHandler `should be equal to` MockCustomerIOBuilder.urlHandler
+        customerIO.config.autoTrackScreenViews `should be equal to` MockCustomerIOBuilder.shouldAutoRecordScreenViews
     }
 
     @Test

sdk/src/test/java/io/customer/sdk/MockCustomerIOBuilder.kt

@@ -17,6 +17,7 @@ internal class MockCustomerIOBuilder {
         val region = Region.US
         const val timeout = 6000
         val urlHandler = null
+        const val shouldAutoRecordScreenViews = false
     }
 
     fun build(): CustomerIO {
@@ -25,7 +26,8 @@ internal class MockCustomerIOBuilder {
             siteId = "mock-site",
             region = Region.US,
             timeout = 6000,
-            urlHandler = null
+            urlHandler = urlHandler,
+            autoTrackScreenViews = shouldAutoRecordScreenViews
         )
 
         api = mock()