Add session_time to OutcomeEvent

* Add `sessionTime` as an additional property to an `OutcomeEvent` object
* This is for the influenced session ending outcomes that send session_time to the outcomes endpoint
* For `OutcomeEventParams` constructor, don't make the parameter `timestamp` optional, so not to confuse with other parameters when instantiating an instance

Author: nan-li

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/session/internal/outcomes/IOutcomeEvent.kt

@@ -8,5 +8,6 @@ interface IOutcomeEvent {
     val notificationIds: JSONArray?
     val name: String
     val timestamp: Long
+    val sessionTime: Long // in seconds
     val weight: Float
 }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/session/internal/outcomes/impl/OutcomeConstants.kt

@@ -6,6 +6,7 @@ internal object OutcomeConstants {
     const val OUTCOME_SOURCES = "sources"
     const val WEIGHT = "weight"
     const val TIMESTAMP = "timestamp"
+    const val SESSION_TIME = "session_time"
 
     // OSOutcomeSource Constants
     const val DIRECT = "direct"

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/session/internal/outcomes/impl/OutcomeEvent.kt

@@ -11,6 +11,7 @@ internal class OutcomeEvent(
     override val notificationIds: JSONArray?,
     override val name: String,
     override val timestamp: Long,
+    override val sessionTime: Long,
     override val weight: Float,
 ) : IOutcomeEvent {
     @Throws(JSONException::class)
@@ -20,6 +21,7 @@ internal class OutcomeEvent(
         json.put(NOTIFICATION_IDS, notificationIds)
         json.put(OUTCOME_ID, name)
         json.put(TIMESTAMP, timestamp)
+        json.put(SESSION_TIME, sessionTime)
         json.put(WEIGHT, weight)
         return json
     }
@@ -28,11 +30,11 @@ internal class OutcomeEvent(
         if (this === o) return true
         if (o == null || this.javaClass != o.javaClass) return false
         val event = o as OutcomeEvent
-        return session == event.session && notificationIds == event.notificationIds && name == event.name && timestamp == event.timestamp && weight == event.weight
+        return session == event.session && notificationIds == event.notificationIds && name == event.name && timestamp == event.timestamp && sessionTime == event.sessionTime && weight == event.weight
     }
 
     override fun hashCode(): Int {
-        val a = arrayOf(session, notificationIds, name, timestamp, weight)
+        val a = arrayOf(session, notificationIds, name, timestamp, sessionTime, weight)
         var result = 1
         for (element in a) result = 31 * result + (element?.hashCode() ?: 0)
         return result
@@ -44,6 +46,7 @@ internal class OutcomeEvent(
             ", notificationIds=" + notificationIds +
             ", name='" + name + '\'' +
             ", timestamp=" + timestamp +
+            ", sessionTime=" + sessionTime +
             ", weight=" + weight +
             '}'
     }
@@ -53,6 +56,7 @@ internal class OutcomeEvent(
         private const val NOTIFICATION_IDS = "notification_ids"
         private const val OUTCOME_ID = "id"
         private const val TIMESTAMP = "timestamp"
+        private const val SESSION_TIME = "session_time"
         private const val WEIGHT = "weight"
 
         /**
@@ -76,6 +80,7 @@ internal class OutcomeEvent(
                 notificationId,
                 outcomeEventParams.outcomeId,
                 outcomeEventParams.timestamp,
+                outcomeEventParams.sessionTime,
                 outcomeEventParams.weight,
             )
         }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/session/internal/outcomes/impl/OutcomeEventParams.kt

@@ -7,7 +7,8 @@ internal class OutcomeEventParams constructor(
     val outcomeId: String,
     val outcomeSource: OutcomeSource?, // This field is optional
     var weight: Float, // This field is optional.
-    var timestamp: Long = 0,
+    var sessionTime: Long, // This field is optional
+    var timestamp: Long,
 ) {
     @Throws(JSONException::class)
     fun toJSONObject(): JSONObject {
@@ -18,6 +19,7 @@ internal class OutcomeEventParams constructor(
         }
         if (weight > 0) json.put(OutcomeConstants.WEIGHT, weight)
         if (timestamp > 0) json.put(OutcomeConstants.TIMESTAMP, timestamp)
+        if (sessionTime > 0) json.put(OutcomeConstants.SESSION_TIME, sessionTime)
         return json
     }
 
@@ -29,6 +31,7 @@ internal class OutcomeEventParams constructor(
             ", outcomeSource=" + outcomeSource +
             ", weight=" + weight +
             ", timestamp=" + timestamp +
+            ", sessionTime=" + sessionTime +
             '}'
     }
 }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/session/internal/outcomes/impl/OutcomeEventsBackendService.kt

@@ -35,6 +35,10 @@ internal class OutcomeEventsBackendService(private val _http: IHttpClient) :
             jsonObject.put("timestamp", event.timestamp)
         }
 
+        if (event.sessionTime > 0) {
+            jsonObject.put("session_time", event.sessionTime)
+        }
+
         val response = _http.post("outcomes/measure", jsonObject)
 
         if (!response.isSuccess) {

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/session/internal/outcomes/impl/OutcomeEventsController.kt

@@ -88,12 +88,12 @@ Outcome event was cached and will be reattempted on app cold start""",
 
     override suspend fun sendOutcomeEvent(name: String): OutcomeEvent? {
         val influences: List<Influence> = _influenceManager.influences
-        return sendAndCreateOutcomeEvent(name, 0f, influences)
+        return sendAndCreateOutcomeEvent(name, 0f, 0, influences)
     }
 
     override suspend fun sendOutcomeEventWithValue(name: String, weight: Float): OutcomeEvent? {
         val influences: List<Influence> = _influenceManager.influences
-        return sendAndCreateOutcomeEvent(name, weight, influences)
+        return sendAndCreateOutcomeEvent(name, weight, 0, influences)
     }
 
     /**
@@ -134,7 +134,7 @@ Outcome event was cached and will be reattempted on app cold start""",
                 // Return null to determine not a failure, but not a success in terms of the request made
                 return null
             }
-            return sendAndCreateOutcomeEvent(name, 0f, uniqueInfluences)
+            return sendAndCreateOutcomeEvent(name, 0f, 0, uniqueInfluences)
         } else {
             // Make sure unique outcome has not been sent for current unattributed session
             if (unattributedUniqueOutcomeEventsSentOnSession.contains(name)) {
@@ -150,13 +150,14 @@ Outcome event was cached and will be reattempted on app cold start""",
                 return null
             }
             unattributedUniqueOutcomeEventsSentOnSession.add(name)
-            return sendAndCreateOutcomeEvent(name, 0f, influences)
+            return sendAndCreateOutcomeEvent(name, 0f, 0, influences)
         }
     }
 
     private suspend fun sendAndCreateOutcomeEvent(
         name: String,
         weight: Float,
+        sessionTime: Long, // Note: this is optional
         influences: List<Influence>,
     ): OutcomeEvent? {
         val timestampSeconds: Long = _time.currentTimeMillis / 1000
@@ -186,7 +187,7 @@ Outcome event was cached and will be reattempted on app cold start""",
         }
 
         val source = OutcomeSource(directSourceBody, indirectSourceBody)
-        val eventParams = OutcomeEventParams(name, source, weight, 0)
+        val eventParams = OutcomeEventParams(name, source, weight, sessionTime, 0)
 
         try {
             requestMeasureOutcomeEvent(eventParams)

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/session/internal/outcomes/impl/OutcomeEventsRepository.kt

@@ -88,6 +88,7 @@ internal class OutcomeEventsRepository(
                 put(OutcomeEventsTable.COLUMN_NAME_NAME, eventParams.outcomeId)
                 put(OutcomeEventsTable.COLUMN_NAME_WEIGHT, eventParams.weight)
                 put(OutcomeEventsTable.COLUMN_NAME_TIMESTAMP, eventParams.timestamp)
+                put(OutcomeEventsTable.COLUMN_NAME_SESSION_TIME, eventParams.sessionTime)
             }.also { values ->
                 _databaseProvider.os.insert(OutcomeEventsTable.TABLE_NAME, null, values)
             }
@@ -128,6 +129,8 @@ internal class OutcomeEventsRepository(
                             cursor.getFloat(OutcomeEventsTable.COLUMN_NAME_WEIGHT)
                         val timestamp =
                             cursor.getLong(OutcomeEventsTable.COLUMN_NAME_TIMESTAMP)
+                        val sessionTime =
+                            cursor.getLong(OutcomeEventsTable.COLUMN_NAME_SESSION_TIME)
 
                         try {
                             val directSourceBody = OutcomeSourceBody()
@@ -147,7 +150,7 @@ internal class OutcomeEventsRepository(
                                         it,
                                     )
                                 } ?: OutcomeSource(null, null)
-                            OutcomeEventParams(name, source, weight, timestamp).also {
+                            OutcomeEventParams(name, source, weight, sessionTime, timestamp).also {
                                 events.add(it)
                             }
                         } catch (e: JSONException) {