Add percent progress to event (close #662)

snowplow · Feb 9, 2024 · f755406 · f755406
1 parent 18cdf59
commit f755406
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 5 deletions.
diff --git a/...otlin/src/main/java/com/snowplowanalytics/snowplowdemokotlin/media/VideoViewController.kt b/...otlin/src/main/java/com/snowplowanalytics/snowplowdemokotlin/media/VideoViewController.kt
@@ -26,6 +26,7 @@ import android.view.View
 import android.widget.MediaController
 import com.snowplowanalytics.snowplow.Snowplow
 import com.snowplowanalytics.snowplow.event.Event
+import com.snowplowanalytics.snowplow.media.configuration.MediaTrackingConfiguration
 import com.snowplowanalytics.snowplow.media.controller.MediaTracking
 import com.snowplowanalytics.snowplow.media.entity.MediaPlayerEntity
 import com.snowplowanalytics.snowplow.media.event.*
@@ -130,9 +131,14 @@ class VideoViewController(activity: Activity, uri: Uri) {
             reset()
             loaded = true
 
-            mediaTracking = Snowplow.defaultTracker?.media?.startMediaTracking(
+            val configuration = MediaTrackingConfiguration(
                 id = UUID.randomUUID().toString(),
-                player = player
+                player = player,
+                boundaries = listOf(10, 25, 50, 75),
+            )
+
+            mediaTracking = Snowplow.defaultTracker?.media?.startMediaTracking(
+                configuration
             )
 
             updateThread = UpdateThread()

diff --git a/...-tracker/src/androidTest/java/com/snowplowanalytics/snowplow/media/TestMediaController.kt b/...-tracker/src/androidTest/java/com/snowplowanalytics/snowplow/media/TestMediaController.kt
@@ -523,6 +523,29 @@ class TestMediaController {
         assertEquals(3, trackedEvents.filter { it.schema == eventSchema("percent_progress") }.size)
     }
 
+    @Test
+    fun progressEventShouldHavePercentValue() {
+        val configuration = MediaTrackingConfiguration(
+            id = "media1",
+            player = MediaPlayerEntity(duration = 100.0),
+            boundaries = listOf(50),
+        )
+        val media = tracker?.media?.startMediaTracking(configuration = configuration)
+
+        media?.track(MediaPlayEvent())
+        for (i in 1 until 60) {
+            media?.update(player = MediaPlayerEntity(currentTime = i.toDouble()))
+        }
+
+        Thread.sleep(100)
+
+        assertEquals(2, trackedEvents.size)
+
+        val progressEvents = trackedEvents.filter { it.schema == eventSchema("percent_progress") }
+        assertEquals(1, progressEvents.size)
+        assertEquals(50, progressEvents[0].payload["percentProgress"])
+    }
+
     @Test
     fun doesntSendProgressEventsIfPaused() {
         val configuration = MediaTrackingConfiguration(

diff --git a/...ow-tracker/src/main/java/com/snowplowanalytics/core/media/controller/MediaTrackingImpl.kt b/...ow-tracker/src/main/java/com/snowplowanalytics/core/media/controller/MediaTrackingImpl.kt
@@ -101,7 +101,7 @@ class MediaTrackingImpl (
             // track events
             event?.let { addEntitiesAndTrack(it) }
             if (shouldSendPercentProgressEvent()) {
-                addEntitiesAndTrack(MediaPercentProgressEvent())
+                addEntitiesAndTrack(MediaPercentProgressEvent(this.player.percentProgress))
             }
 
             // update state for events after this one

diff --git a/...tracker/src/main/java/com/snowplowanalytics/core/media/event/MediaPercentProgressEvent.kt b/...tracker/src/main/java/com/snowplowanalytics/core/media/event/MediaPercentProgressEvent.kt
@@ -19,10 +19,12 @@ import com.snowplowanalytics.snowplow.event.AbstractSelfDescribing
 /**
  * Media player event fired when a percentage boundary set in the `boundaries` list in `MediaTrackingConfiguration` is reached.
  */
-class MediaPercentProgressEvent : AbstractSelfDescribing() {
+class MediaPercentProgressEvent(val percentProgress: Int?) : AbstractSelfDescribing() {
     override val schema: String
         get() = MediaSchemata.eventSchema("percent_progress")
 
     override val dataPayload: Map<String, Any?>
-        get() = emptyMap()
+        get() = mapOf(
+            "percentProgress" to percentProgress,
+        )
 }