Merge pull request #1687 from OneSignal/user-model/track-session-start

[User Model] Track Session Start

Author: brismithers

OneSignalSDK/onesignal/src/main/java/com/onesignal/core/internal/operations/impl/OperationModelStore.kt

@@ -13,7 +13,8 @@ import com.onesignal.user.internal.operations.SetAliasOperation
 import com.onesignal.user.internal.operations.SetPropertyOperation
 import com.onesignal.user.internal.operations.SetTagOperation
 import com.onesignal.user.internal.operations.TrackPurchaseOperation
-import com.onesignal.user.internal.operations.TrackSessionOperation
+import com.onesignal.user.internal.operations.TrackSessionEndOperation
+import com.onesignal.user.internal.operations.TrackSessionStartOperation
 import com.onesignal.user.internal.operations.UpdateSubscriptionOperation
 import com.onesignal.user.internal.operations.impl.executors.IdentityOperationExecutor
 import com.onesignal.user.internal.operations.impl.executors.LoginUserOperationExecutor
@@ -49,7 +50,8 @@ internal class OperationModelStore(prefs: IPreferencesService) : ModelStore<Oper
             UpdateUserOperationExecutor.SET_TAG -> SetTagOperation()
             UpdateUserOperationExecutor.DELETE_TAG -> DeleteTagOperation()
             UpdateUserOperationExecutor.SET_PROPERTY -> SetPropertyOperation()
-            UpdateUserOperationExecutor.TRACK_SESSION -> TrackSessionOperation()
+            UpdateUserOperationExecutor.TRACK_SESSION_START -> TrackSessionStartOperation()
+            UpdateUserOperationExecutor.TRACK_SESSION_END -> TrackSessionEndOperation()
             UpdateUserOperationExecutor.TRACK_PURCHASE -> TrackPurchaseOperation()
             else -> throw Exception("Unrecognized operation: $operationName")
         }

OneSignalSDK/onesignal/src/main/java/com/onesignal/session/internal/session/impl/SessionListener.kt

@@ -8,14 +8,21 @@ import com.onesignal.session.internal.outcomes.IOutcomeEventsController
 import com.onesignal.session.internal.session.ISessionLifecycleHandler
 import com.onesignal.session.internal.session.ISessionService
 import com.onesignal.user.internal.identity.IdentityModelStore
-import com.onesignal.user.internal.operations.TrackSessionOperation
+import com.onesignal.user.internal.operations.TrackSessionEndOperation
+import com.onesignal.user.internal.operations.TrackSessionStartOperation
 
 /**
  * The [SessionListener] is responsible for subscribing itself as an [ISessionLifecycleHandler]
- * and reacting to the session ending.  Specifically we need to do 2 things whenever a session
- * has ended.
+ * and reacting to the session ending.
  *
- * 1. Enqueue a [TrackSessionOperation] to the [IOperationRepo] so session data will be counted
+ * We need to do the following on session start:
+ *
+ * 1. Enqueue a [TrackSessionStartOperation] to the [IOperationRepo] so session data will be counted
+ *    against the user.
+ *
+ * We need to do the following on session end:
+ *
+ * 1. Enqueue a [TrackSessionEndOperation] to the [IOperationRepo] so session data will be counted
  *    against the user.
  * 2. Send up an internal `__os_session_end` outcome, which will pick up any influences that led
  *    to the session existing.
@@ -33,13 +40,14 @@ internal class SessionListener(
     }
 
     override fun onSessionStarted() {
+        _operationRepo.enqueue(TrackSessionStartOperation(_configModelStore.model.appId, _identityModelStore.model.onesignalId))
     }
 
     override fun onSessionActive() {
     }
 
     override fun onSessionEnded(duration: Long) {
-        _operationRepo.enqueue(TrackSessionOperation(_configModelStore.model.appId, _identityModelStore.model.onesignalId, duration))
+        _operationRepo.enqueue(TrackSessionEndOperation(_configModelStore.model.appId, _identityModelStore.model.onesignalId, duration))
 
         suspendifyOnThread {
             _outcomeEventsController.sendOutcomeEvent("os__session_duration")

OneSignalSDK/onesignal/src/main/java/com/onesignal/session/internal/session/impl/SessionService.kt

@@ -54,7 +54,7 @@ internal class SessionService(
     }
 
     override suspend fun backgroundRun() {
-        Logging.log(LogLevel.DEBUG, "SessionService.run()")
+        Logging.log(LogLevel.DEBUG, "SessionService.backgroundRun()")
 
         if (!_session!!.isValid) {
             return

OneSignalSDK/onesignal/src/main/java/com/onesignal/user/internal/backend/PropertiesDeltasObject.kt

@@ -4,7 +4,7 @@ import java.math.BigDecimal
 
 class PropertiesDeltasObject(
     val sessionTime: Long? = null,
-    val sessionCounts: Int? = null,
+    val sessionCount: Int? = null,
     val amountSpent: BigDecimal? = null,
     val purchases: List<PurchaseObject>? = null
 )

OneSignalSDK/onesignal/src/main/java/com/onesignal/user/internal/backend/impl/UserBackendService.kt

@@ -118,8 +118,8 @@ internal class UserBackendService(
             deltasObject.put("session_time", propertiesDeltas.sessionTime)
         }
 
-        if (propertiesDeltas.sessionCounts != null) {
-            deltasObject.put("session_counts", propertiesDeltas.sessionCounts)
+        if (propertiesDeltas.sessionCount != null) {
+            deltasObject.put("session_counts", propertiesDeltas.sessionCount)
         }
 
         if (propertiesDeltas.amountSpent != null) {

OneSignalSDK/onesignal/src/main/java/com/onesignal/user/internal/operations/TrackSessionOperation.kt renamed to OneSignalSDK/onesignal/src/main/java/com/onesignal/user/internal/operations/TrackSessionEndOperation.kt

@@ -8,7 +8,7 @@ import com.onesignal.user.internal.operations.impl.executors.UpdateUserOperation
 /**
  * An [Operation] to track the ending of a session, related to a specific user.
  */
-class TrackSessionOperation() : Operation(UpdateUserOperationExecutor.TRACK_SESSION) {
+class TrackSessionEndOperation() : Operation(UpdateUserOperationExecutor.TRACK_SESSION_END) {
     /**
      * The OneSignal appId the session was captured under.
      */

OneSignalSDK/onesignal/src/main/java/com/onesignal/user/internal/operations/TrackSessionStartOperation.kt

@@ -0,0 +1,42 @@
+package com.onesignal.user.internal.operations
+
+import com.onesignal.common.IDManager
+import com.onesignal.core.internal.operations.GroupComparisonType
+import com.onesignal.core.internal.operations.Operation
+import com.onesignal.user.internal.operations.impl.executors.UpdateUserOperationExecutor
+
+/**
+ * An [Operation] to track the starting of a session, related to a specific user.
+ */
+class TrackSessionStartOperation() : Operation(UpdateUserOperationExecutor.TRACK_SESSION_START) {
+    /**
+     * The OneSignal appId the session was captured under.
+     */
+    var appId: String
+        get() = getProperty(::appId.name)
+        private set(value) { setProperty(::appId.name, value) }
+
+    /**
+     * The OneSignal ID driving the session. This ID *may* be locally generated
+     * and can be checked via [IDManager.isLocalId] to ensure correct processing.
+     */
+    var onesignalId: String
+        get() = getProperty(::onesignalId.name)
+        private set(value) { setProperty(::onesignalId.name, value) }
+
+    override val createComparisonKey: String get() = ""
+    override val modifyComparisonKey: String get() = "$appId.User.$onesignalId"
+    override val groupComparisonType: GroupComparisonType = GroupComparisonType.ALTER
+    override val canStartExecute: Boolean get() = !IDManager.isLocalId(onesignalId)
+
+    constructor(appId: String, onesignalId: String) : this() {
+        this.appId = appId
+        this.onesignalId = onesignalId
+    }
+
+    override fun translateIds(map: Map<String, String>) {
+        if (map.containsKey(onesignalId)) {
+            onesignalId = map[onesignalId]!!
+        }
+    }
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/user/internal/operations/impl/executors/UpdateUserOperationExecutor.kt

@@ -19,7 +19,8 @@ import com.onesignal.user.internal.operations.DeleteTagOperation
 import com.onesignal.user.internal.operations.SetPropertyOperation
 import com.onesignal.user.internal.operations.SetTagOperation
 import com.onesignal.user.internal.operations.TrackPurchaseOperation
-import com.onesignal.user.internal.operations.TrackSessionOperation
+import com.onesignal.user.internal.operations.TrackSessionEndOperation
+import com.onesignal.user.internal.operations.TrackSessionStartOperation
 import com.onesignal.user.internal.properties.PropertiesModelStore
 
 internal class UpdateUserOperationExecutor(
@@ -29,7 +30,7 @@ internal class UpdateUserOperationExecutor(
 ) : IOperationExecutor {
 
     override val operations: List<String>
-        get() = listOf(SET_TAG, DELETE_TAG, SET_PROPERTY, TRACK_SESSION, TRACK_PURCHASE)
+        get() = listOf(SET_TAG, DELETE_TAG, SET_PROPERTY, TRACK_SESSION_START, TRACK_SESSION_END, TRACK_PURCHASE)
 
     override suspend fun execute(ops: List<Operation>): ExecutionResponse {
         Logging.log(LogLevel.DEBUG, "UserOperationExecutor(operation: $operations)")
@@ -39,6 +40,7 @@ internal class UpdateUserOperationExecutor(
 
         var propertiesObject = PropertiesObject()
         var deltasObject = PropertiesDeltasObject()
+        var refreshDeviceMetadata = false
 
         for (operation in ops) {
             when (operation) {
@@ -66,20 +68,32 @@ internal class UpdateUserOperationExecutor(
 
                     propertiesObject = PropertyOperationHelper.createPropertiesFromOperation(operation, propertiesObject)
                 }
-                is TrackSessionOperation -> {
+                is TrackSessionStartOperation -> {
                     if (appId == null) {
                         appId = operation.appId
                         onesignalId = operation.onesignalId
                     }
 
-                    // The session count we pass up is essentially the number of `TrackSessionOperation`
+                    // The session count we pass up is essentially the number of `TrackSessionStartOperation`
                     // operations we come across in this group, while the session time we pass up is
                     // the total session time across all `TrackSessionOperation` operations
                     // that exist in this group.
+                    val sessionCount = if (deltasObject.sessionCount != null) deltasObject.sessionCount!! + 1 else 1
+
+                    deltasObject = PropertiesDeltasObject(deltasObject.sessionTime, sessionCount, deltasObject.amountSpent, deltasObject.purchases)
+                    refreshDeviceMetadata = true
+                }
+                is TrackSessionEndOperation -> {
+                    if (appId == null) {
+                        appId = operation.appId
+                        onesignalId = operation.onesignalId
+                    }
+
+                    // The session time we pass up is the total session time across all `TrackSessionEndOperation`
+                    // operations that exist in this group.
                     val sessionTime = if (deltasObject.sessionTime != null) deltasObject.sessionTime!! + operation.sessionTime else operation.sessionTime
-                    val sessionCount = if (deltasObject.sessionCounts != null) deltasObject.sessionCounts!! + 1 else 1
 
-                    deltasObject = PropertiesDeltasObject(sessionTime, sessionCount, deltasObject.amountSpent, deltasObject.purchases)
+                    deltasObject = PropertiesDeltasObject(sessionTime, deltasObject.sessionCount, deltasObject.amountSpent, deltasObject.purchases)
                 }
                 is TrackPurchaseOperation -> {
                     if (appId == null) {
@@ -97,14 +111,14 @@ internal class UpdateUserOperationExecutor(
                         purchasesArray.add(PurchaseObject(purchase.sku, purchase.iso, purchase.amount))
                     }
 
-                    deltasObject = PropertiesDeltasObject(deltasObject.sessionTime, deltasObject.sessionCounts, amountSpent, purchasesArray)
+                    deltasObject = PropertiesDeltasObject(deltasObject.sessionTime, deltasObject.sessionCount, amountSpent, purchasesArray)
                 }
             }
         }
 
         if (appId != null && onesignalId != null) {
             try {
-                _userBackend.updateUser(appId, IdentityConstants.ONESIGNAL_ID, onesignalId, propertiesObject, true, deltasObject)
+                _userBackend.updateUser(appId, IdentityConstants.ONESIGNAL_ID, onesignalId, propertiesObject, refreshDeviceMetadata, deltasObject)
 
                 if (_identityModelStore.model.onesignalId == onesignalId) {
                     // go through and make sure any properties are in the correct model state
@@ -132,7 +146,8 @@ internal class UpdateUserOperationExecutor(
         const val SET_TAG = "set-tag"
         const val DELETE_TAG = "delete-tag"
         const val SET_PROPERTY = "set-property"
-        const val TRACK_SESSION = "track-session"
+        const val TRACK_SESSION_START = "track-session-start"
+        const val TRACK_SESSION_END = "track-session-end"
         const val TRACK_PURCHASE = "track-purchase"
     }
 }

OneSignalSDK/onesignal/src/test/java/com/onesignal/user/internal/backend/UserBackendServiceTests.kt

@@ -342,7 +342,7 @@ class UserBackendServiceTests : FunSpec({
         coEvery { spyHttpClient.post(any(), any()) } returns HttpResponse(202, "{properties: { }}")
         val userBackendService = UserBackendService(spyHttpClient, spySubscriptionBackend)
         val properties = PropertiesObject()
-        val propertiesDelta = PropertiesDeltasObject(sessionTime = 1111, sessionCounts = 1)
+        val propertiesDelta = PropertiesDeltasObject(sessionTime = 1111, sessionCount = 1)
 
         /* When */
         userBackendService.updateUser("appId", aliasLabel, aliasValue, properties, refreshDeviceMetadata = true, propertiesDelta)

OneSignalSDK/onesignal/src/test/java/com/onesignal/user/internal/operations/UpdateUserOperationExecutorTests.kt

@@ -131,7 +131,7 @@ class UpdateUserOperationExecutorTests : FunSpec({
             mockPropertiesModelStore
         )
         val operations = listOf<Operation>(
-            TrackSessionOperation(appId, remoteOneSignalId, 1111)
+            TrackSessionEndOperation(appId, remoteOneSignalId, 1111)
         )
 
         /* When */
@@ -150,7 +150,6 @@ class UpdateUserOperationExecutorTests : FunSpec({
                 any(),
                 withArg {
                     it.sessionTime shouldBe 1111
-                    it.sessionCounts shouldBe 1
                 }
             )
         }
@@ -171,7 +170,7 @@ class UpdateUserOperationExecutorTests : FunSpec({
             mockPropertiesModelStore
         )
         val operations = listOf<Operation>(
-            TrackSessionOperation(appId, remoteOneSignalId, 1111),
+            TrackSessionEndOperation(appId, remoteOneSignalId, 1111),
             TrackPurchaseOperation(
                 appId,
                 remoteOneSignalId,
@@ -182,7 +181,7 @@ class UpdateUserOperationExecutorTests : FunSpec({
                     PurchaseInfo("sku2", "iso2", BigDecimal(1222))
                 )
             ),
-            TrackSessionOperation(appId, remoteOneSignalId, 3333)
+            TrackSessionEndOperation(appId, remoteOneSignalId, 3333)
         )
 
         /* When */
@@ -201,7 +200,6 @@ class UpdateUserOperationExecutorTests : FunSpec({
                 any(),
                 withArg {
                     it.sessionTime shouldBe (1111 + 3333)
-                    it.sessionCounts shouldBe 2
                     it.amountSpent shouldBe BigDecimal(2222)
                     it.purchases shouldNotBe null
                     it.purchases!!.count() shouldBe 2
@@ -231,9 +229,9 @@ class UpdateUserOperationExecutorTests : FunSpec({
             mockPropertiesModelStore
         )
         val operations = listOf<Operation>(
-            TrackSessionOperation(appId, remoteOneSignalId, 1111),
+            TrackSessionEndOperation(appId, remoteOneSignalId, 1111),
             SetTagOperation(appId, remoteOneSignalId, "tagKey1", "tagValue1"),
-            TrackSessionOperation(appId, remoteOneSignalId, 3333)
+            TrackSessionEndOperation(appId, remoteOneSignalId, 3333)
         )
 
         /* When */
@@ -252,7 +250,6 @@ class UpdateUserOperationExecutorTests : FunSpec({
                 any(),
                 withArg {
                     it.sessionTime shouldBe (1111 + 3333)
-                    it.sessionCounts shouldBe 2
                 }
             )
         }