SDK 4.0 - Push Notifications

.gitignore

@@ -30,6 +30,8 @@ output.json
 /.idea/deploymentTargetDropDown.xml
 /.idea/assetWizardSettings.xml
 /.idea/kotlinc.xml
+/.idea/deploymentTargetSelector.xml
+/.idea/other.xml
 vendor/
 
 # Keystore files

README.md

@@ -17,6 +17,7 @@ The SDK is a Kotlin library for sending user properties and events to the Appcue
     - [One Time Setup](#one-time-setup)
       - [Initializing the SDK](#initializing-the-sdk)
       - [Supporting Builder Preview and Screen Capture](#supporting-builder-preview-and-screen-capture)
+      - [Enabling Push Notifications](#enabling-push-notifications)
     - [Identifying Users](#identifying-users)
     - [Tracking Screens and Events](#tracking-screens-and-events)
     - [Anchored Tooltips](#anchored-tooltips)
@@ -99,6 +100,10 @@ Initializing the SDK requires you to provide two values: `APPCUES_ACCOUNT_ID` an
 
 During installation, follow the steps outlined in [Configuring the Appcues URL Scheme](https://github.com/appcues/appcues-android-sdk/blob/main/docs/URLSchemeConfiguring.md). This is necessary for the complete Appcues builder experience, supporting experience preview, screen capture and debugging. Refer to the [Debug Guide](https://github.com/appcues/appcues-android-sdk/blob/main/docs/Debugging.md) for details about using the Appcues debugger.
 
+#### Enabling Push Notifications
+
+During installation, follow the steps outlined in [Push Notification](https://github.com/appcues/appcues-android-sdk/blob/main/docs/PushNotification.md).
+
 ### Identifying Users
 
 In order to target content to the right users at the right time, you need to identify users and send Appcues data about them. A user is identified with a unique ID.

appcues/appcues.properties

@@ -1,9 +1,9 @@
 GROUP_ID = com.appcues
 ARTIFACT_ID = appcues
-VERSION_MAJOR = 3
-VERSION_MINOR = 3
-VERSION_PATCH = 2
-VERSION_CLASSIFIER = 
+VERSION_MAJOR = 4
+VERSION_MINOR = 0
+VERSION_PATCH = 0
+VERSION_CLASSIFIER = beta01
 NAME = Appcues
 DESCRIPTION = Kotlin SDK for embedding Appcues experiences in Android applications.
 ORG_ID = appcues

appcues/build.gradle

@@ -110,6 +110,8 @@ dependencies {
     // Play In-App Review
     implementation 'com.google.android.play:review:2.0.1'
     implementation 'com.google.android.play:review-ktx:2.0.1'
+    // Messaging
+    implementation "com.google.firebase:firebase-messaging-ktx:23.4.1"
     // Animation
     implementation 'nl.dionsegijn:konfetti-compose:2.0.4'
 

appcues/src/main/AndroidManifest.xml

@@ -3,20 +3,23 @@
     xmlns:tools="http://schemas.android.com/tools">
 
     <uses-permission android:name="android.permission.INTERNET" />
-
     <uses-permission android:name="android.permission.VIBRATE" />
 
     <application>
         <activity
             android:name=".ui.InAppReviewActivity"
             android:exported="false"
             android:theme="@style/Appcues.AppcuesActivityTheme" />
+        <activity
+            android:name=".ui.RequestPermissionActivity"
+            android:exported="false"
+            android:theme="@style/Appcues.AppcuesActivityTheme" />
+
         <provider
             android:name="androidx.startup.InitializationProvider"
             android:authorities="${applicationId}.androidx-startup"
             android:exported="false"
             tools:node="merge">
-
             <meta-data
                 android:name="com.appcues.monitor.AppcuesInitializer"
                 android:value="androidx.startup" />

appcues/src/main/java/com/appcues/Appcues.kt

@@ -6,6 +6,7 @@
 import com.appcues.action.ActionRegistry
 import com.appcues.action.ExperienceAction
 import com.appcues.analytics.ActivityScreenTracking
+import com.appcues.analytics.AnalyticsEvent
 import com.appcues.analytics.AnalyticsTracker
 import com.appcues.data.model.ExperienceTrigger
 import com.appcues.data.model.RenderContext
@@ -18,12 +19,13 @@
 import com.appcues.di.scope.inject
 import com.appcues.logging.LogcatDestination
 import com.appcues.logging.Logcues
+import com.appcues.push.PushOpenedProcessor
 import com.appcues.trait.ExperienceTrait
 import com.appcues.trait.ExperienceTraitLevel
 import com.appcues.trait.TraitRegistry
 import com.appcues.ui.ExperienceRenderer
+import com.google.firebase.messaging.FirebaseMessaging
 import kotlinx.coroutines.launch
-import kotlin.DeprecationLevel.ERROR
 
 /**
  * Construct and return an instance of the Appcues SDK.
@@ -38,13 +40,40 @@
     accountId: String,
     applicationId: String,
     config: (AppcuesConfig.() -> Unit)? = null,
-): Appcues = Bootstrap
+): Appcues {
     // This creates the Scope and initializes the Appcues instance within, then returns the Appcues instance
     // ready to go with the necessary dependency configuration in its scope.
-    .createScope(
-        context = context,
-        config = AppcuesConfig(accountId, applicationId).apply { config?.invoke(this) }
-    ).get()
+    val scope = Bootstrap
+        .createScope(
+            context = context,
+            config = AppcuesConfig(accountId, applicationId).apply { config?.invoke(this) }
+        )
+
+    val appcues = scope.get<Appcues>()
+
+    try {
+        // this is necessary to ensure that not only when we get a new token but whenever we initialize the application appcues should know
+        // whats the latest available token
+        FirebaseMessaging.getInstance().token.addOnCompleteListener {
+            // ensures we have token set
+            if (it.isSuccessful) {
+                val sessionMonitor = scope.get<SessionMonitor>()
+                if (sessionMonitor.hasSession()) {
+                    // can call setPushToken directly if we are already in a session, so the device_updated event is tracked
+                    appcues.setPushToken(it.result)
+                } else {
+                    // store token on static pushToken that will be used on the next session start to track device props
+                    val storage = scope.get<Storage>()
+                    storage.pushToken = it.result
+                }
+            }
+        }
+    } catch (_: Exception) {
+        // do nothing on any exception we may hit here as customer might not even have google messaging services setup
+    }
+
+    return appcues
+}
 
 /**
  * The main entry point for using Appcues functionality in your application - tracking
@@ -66,6 +95,8 @@
          * provided by the SDK is based on Android View layout information.
          */
         public var elementTargeting: ElementTargetingStrategy = AndroidTargetingStrategy()
+
+        internal var pushToken: String? = null
     }
 
     private val config by scope.inject<AppcuesConfig>()
@@ -81,6 +112,7 @@
     private val debuggerManager by scope.inject<AppcuesDebuggerManager>()
     private val appcuesCoroutineScope by scope.inject<AppcuesCoroutineScope>()
     private val analyticsPublisher by scope.inject<AnalyticsPublisher>()
+    private val pushOpenedProcessor by scope.inject<PushOpenedProcessor>()
 
     /**
      * Set the listener to be notified about the display of Experience content.
@@ -159,21 +191,17 @@
         identify(true, "anon:$anonymousId", null)
     }
 
-    /**
-     * This function has been removed. Calling the anonymous function with a properties parameter
-     * is no longer supported. A call to `anonymous()` with no parameters should be used instead.
-     */
-    @Deprecated("properties are no longer supported for anonymous users.", level = ERROR)
-    @Suppress("UnusedPrivateMember", "UNUSED_PARAMETER")
-    public fun anonymous(properties: Map<String, Any>?) {
-        // removed
-    }
-
     /**
      * Clears out the current user in this session.
      * Can be used when the user logs out of your application.
      */
     public fun reset() {
+        analyticsTracker.track(
+            name = AnalyticsEvent.DeviceUnregistered.eventName,
+            properties = mapOf("reason" to "sdk_reset"),
+            isInternal = true,
+            interactive = false
+        )
         // flush any pending analytics for the previous user, prior to reset
         analyticsTracker.flushPendingActivity()
 
@@ -263,6 +291,19 @@
         }
     }
 
+    /**
+     *  Provide the Firebase Cloud Messaging (FCM) device token to Appcues.
+     *
+     *  @param token A globally unique token that identifies this device to FCM.
+     */
+    public fun setPushToken(token: String?) {
+        if (token != storage.pushToken) {
+            storage.pushToken = token
+
+            analyticsTracker.track(AnalyticsEvent.DeviceUpdated.eventName, properties = null, interactive = true, isInternal = true)
+        }
+    }
+
     /**
      * Enables automatic screen tracking for Activities.
      */
@@ -322,5 +363,18 @@
         storage.isAnonymous = isAnonymous
         storage.userSignature = mutableProperties?.remove("appcues:user_id_signature") as? String
         analyticsTracker.identify(mutableProperties)
+        if (!userChanged) {
+            // track a device update on any re-identify of the same user as well, since it will not trigger a new
+            // session but this is a way to force an update of any device props that may have changed outside of the SDK
+            // i.e. push permission.
+            // this is interactive=true so it gets batched together with the identify in a single request
+            analyticsTracker.track(AnalyticsEvent.DeviceUpdated.eventName, properties = null, interactive = true, isInternal = true)
+        }
+
+        // whenever user identifies we check to see if there is a pending push open action matching the userId,
+        // in case there is we run it.
+        appcuesCoroutineScope.launch {
+            pushOpenedProcessor.processDeferred(userId)
+        }
     }
 }

appcues/src/main/java/com/appcues/AppcuesFirebaseMessagingService.kt

@@ -0,0 +1,122 @@
+package com.appcues
+
+import android.Manifest.permission
+import android.content.Context
+import android.content.pm.PackageManager
+import androidx.core.app.ActivityCompat
+import com.appcues.data.MoshiConfiguration
+import com.appcues.util.getNotificationBuilder
+import com.appcues.util.notify
+import com.appcues.util.setContent
+import com.appcues.util.setIntent
+import com.appcues.util.setStyle
+import com.appcues.util.setupNotification
+import com.google.firebase.messaging.FirebaseMessagingService
+import com.google.firebase.messaging.RemoteMessage
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * Appcues Firebase Messaging Service implementation.
+ *
+ * To use it you can either add directly to your Manifest as a service or
+ * call handleMessage and setToken on your custom implementation.
+ */
+public class AppcuesFirebaseMessagingService : FirebaseMessagingService() {
+
+    public companion object {
+
+        internal var notificationId = 1_000_000
+
+        internal const val CHECK_PUSH_NOTIFICATION_ID = 1_100_100
+
+        /**
+         * handleMessage will try to parse the received message into an Appcues notification, if it does it will return true,
+         * or false in case the message is not for Appcues to handle
+         *
+         * @param context application context ('this' when calling from service)
+         * @param message remote message coming from the messaging service
+         *
+         * @return determining whether we handled the message or not.
+         */
+        @JvmStatic
+        public fun handleMessage(context: Context, message: RemoteMessage): Boolean {
+            val data = try {
+                val appcuesData = message.data["appcues"] ?: throw IllegalStateException("Appcues message data not found.")
+                MoshiConfiguration.moshi.adapter(AppcuesMessagingData::class.java).fromJson(appcuesData)!!
+            } catch (_: Exception) {
+                // unable to get data, most likely means this message is not for us.
+                return false
+            }
+
+            // check for permission
+            if (ActivityCompat.checkSelfPermission(context, permission.POST_NOTIFICATIONS) != PackageManager.PERMISSION_GRANTED)
+                return false
+
+            val isCheckPush = data.test && data.notificationId.startsWith("test-push")
+
+            context.getNotificationBuilder()
+                .setupNotification(message)
+                .setContent(data)
+                .setStyle(context, data)
+                .setIntent(context, data, isCheckPush)
+                .notify(context, isCheckPush)
+
+            return true
+        }
+
+        /**
+         * sets the global appcues token
+         *
+         * @param token token value coming from the messaging service
+         */
+        @JvmStatic
+        public fun setToken(token: String) {
+            Appcues.pushToken = token
+        }
+    }
+
+    @JsonClass(generateAdapter = true)
+    internal data class AppcuesMessagingData(
+        val title: String,
+        val body: String,
+        @Json(name = "notification_id")
+        val notificationId: String,
+        @Json(name = "notification_version")
+        val notificationVersion: Long? = null,
+        @Json(name = "account_id")
+        val accountId: String,
+        @Json(name = "app_id")
+        val appId: String,
+        @Json(name = "user_id")
+        val userId: String,
+        @Json(name = "workflow_id")
+        val workflowId: String?,
+        @Json(name = "workflow_task_id")
+        val workflowTaskId: String?,
+        @Json(name = "workflow_version")
+        val workflowVersion: Long? = null,
+        @Json(name = "deep_link_url")
+        val deeplink: String?,
+        @Json(name = "attachment_url")
+        val image: String?,
+        @Json(name = "experience_id")
+        val experienceId: String?,
+        @Json(name = "category")
+        val category: String?,
+        @Json(name = "android_notification_id")
+        val androidNotificationId: String?,
+        @Json(name = "test")
+        val test: Boolean = false
+    )
+
+    override fun onMessageReceived(remoteMessage: RemoteMessage) {
+        super.onMessageReceived(remoteMessage)
+        handleMessage(this, remoteMessage)
+    }
+
+    override fun onNewToken(token: String) {
+        super.onNewToken(token)
+        setToken(token)
+    }
+}