Merge branch 'release/0.7.0'

snowplow · Apr 10, 2024 · 23b9bff · 23b9bff
2 parents ec702d5 + d417c9b
commit 23b9bff
Show file tree

Hide file tree

Showing 119 changed files with 4,780 additions and 866 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,12 @@
+# 0.7.0
+
+* Add media tracking APIs to the tracker (close #49)
+* Fix tracker initialization with partial platform context property overrides on Android (#53)
+* Update uuid package constraint to 4.0.0 (#48) thanks to @petermnt
+* Add support for Android Gradle Plugin 8 (close #46) thanks to @petermnt
+* Remove documentation in the project in favour of docs.snowplow.io to reduce duplicity (#51)
+* Update flutter_lints, http, js, and example dependency versions (#52)
+
 # 0.6.0
 
 * Upgrade mobile trackers to version 6.0

diff --git a/README.md b/README.md
@@ -34,6 +34,7 @@ It is build on top of Snowplow's native [iOS](https://github.com/snowplow/snowpl
 | Configurable GDPR context entity                                                                             | ✔ | ✔ | ✔      |
 | Lifecycle autotracking                                                                                       | ✔ | ✔ |        |
 | Engagement tracking (activity tracking on Web, mobile screen engagement on mobile)                           | ✔ | ✔ | ✔      |
+| Media playback tracking                                                                                      | ✔ | ✔ | ✔      |
 
 ## Quick Start
 
@@ -49,7 +50,7 @@ This will add a line with the dependency like this to your `pubspec.yaml`:
 
 ```yml
 dependencies:
-    snowplow_tracker: ^0.6.0
+    snowplow_tracker: ^0.7.0
 ```
 
 Import the package into your Dart code:

diff --git a/android/build.gradle b/android/build.gradle
@@ -25,6 +25,10 @@ apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 
 android {
+    // Conditional for compatibility with AGP <4.2.
+    if (project.android.hasProperty('namespace')) {
+        namespace 'com.snowplowanalytics.snowplow_tracker'
+    }
     compileSdkVersion 33
 
     compileOptions {

diff --git a/android/src/main/kotlin/com/snowplowanalytics/snowplow_tracker/SnowplowTrackerController.kt b/android/src/main/kotlin/com/snowplowanalytics/snowplow_tracker/SnowplowTrackerController.kt
@@ -15,6 +15,7 @@ import android.content.Context
 
 import com.snowplowanalytics.snowplow.Snowplow;
 import com.snowplowanalytics.snowplow.configuration.Configuration;
+import com.snowplowanalytics.snowplow.event.Event
 import com.snowplowanalytics.snowplow_tracker.readers.configurations.DefaultTrackerConfiguration
 import com.snowplowanalytics.snowplow_tracker.readers.messages.*
 
@@ -51,59 +52,43 @@ object SnowplowTrackerController {
     }
 
     fun trackStructured(eventReader: EventMessageReader) {
-        val trackerController = Snowplow.getTracker(eventReader.tracker)
         val structured = eventReader.toStructuredWithContexts()
-
-        trackerController?.track(structured)
+        trackEvent(structured, eventReader)
     }
 
     fun trackSelfDescribing(eventReader: EventMessageReader) {
-        val trackerController = Snowplow.getTracker(eventReader.tracker)
         val selfDescribing = eventReader.toSelfDescribingWithContexts()
-
-        trackerController?.track(selfDescribing)
+        trackEvent(selfDescribing, eventReader)
     }
 
     fun trackScreenView(eventReader: EventMessageReader) {
-        val trackerController = Snowplow.getTracker(eventReader.tracker)
         val screenView = eventReader.toScreenViewWithContexts()
-
-        trackerController?.track(screenView)
+        trackEvent(screenView, eventReader)
     }
 
     fun trackScrollChanged(eventReader: EventMessageReader) {
-        val trackerController = Snowplow.getTracker(eventReader.tracker)
         val scroll = eventReader.toScrollChangedWithContexts()
-
-        trackerController?.track(scroll)
+        trackEvent(scroll, eventReader)
     }
 
     fun trackListItemView(eventReader: EventMessageReader) {
-        val trackerController = Snowplow.getTracker(eventReader.tracker)
         val listItem = eventReader.toListItemViewWithContexts()
-
-        trackerController?.track(listItem)
+        trackEvent(listItem, eventReader)
     }
 
     fun trackTiming(eventReader: EventMessageReader) {
-        val trackerController = Snowplow.getTracker(eventReader.tracker)
         val timing = eventReader.toTimingWithContexts()
-
-        trackerController?.track(timing)
+        trackEvent(timing, eventReader)
     }
 
     fun trackConsentGranted(eventReader: EventMessageReader) {
-        val trackerController = Snowplow.getTracker(eventReader.tracker)
         val consentGranted = eventReader.toConsentGrantedWithContexts()
-
-        trackerController?.track(consentGranted)
+        trackEvent(consentGranted, eventReader)
     }
 
     fun trackConsentWithdrawn(eventReader: EventMessageReader) {
-        val trackerController = Snowplow.getTracker(eventReader.tracker)
         val consentWithdrawn = eventReader.toConsentWithdrawnWithContexts()
-
-        trackerController?.track(consentWithdrawn)
+        trackEvent(consentWithdrawn, eventReader)
     }
 
     fun setUserId(messageReader: SetUserIdMessageReader) {
@@ -130,4 +115,167 @@ object SnowplowTrackerController {
         return trackerController?.session?.sessionIndex
     }
 
+    fun startMediaTracking(messageReader: StartMediaTrackingMessageReader) {
+        val trackerController = Snowplow.getTracker(messageReader.tracker)
+        trackerController?.media?.startMediaTracking(
+            messageReader.configuration.toConfiguration()
+        )
+    }
+
+    fun endMediaTracking(messageReader: EndMediaTrackingMessageReader) {
+        val trackerController = Snowplow.getTracker(messageReader.tracker)
+        trackerController?.media?.endMediaTracking(messageReader.mediaTrackingId)
+    }
+
+    fun updateMediaTracking(messageReader: UpdateMediaTrackingMessageReader) {
+        val trackerController = Snowplow.getTracker(messageReader.tracker)
+        val mediaTracking = trackerController?.media?.getMediaTracking(messageReader.mediaTrackingId)
+        mediaTracking?.update(
+            player = messageReader.player?.toMediaPlayerEntity(),
+            ad = messageReader.ad?.toMediaAdEntity(),
+            adBreak = messageReader.adBreak?.toMediaAdBreakEntity()
+        )
+    }
+
+    fun trackMediaAdBreakEndEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaAdBreakEndEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaAdBreakStartEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaAdBreakStartEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaAdClickEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaAdClickEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaAdCompleteEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaAdCompleteEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaAdFirstQuartileEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaAdFirstQuartileEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaAdMidpointEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaAdMidpointEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaAdPauseEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaAdPauseEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaAdResumeEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaAdResumeEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaAdSkipEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaAdSkipEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaAdStartEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaAdStartEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaAdThirdQuartileEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaAdThirdQuartileEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaBufferEndEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaBufferEndEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaBufferStartEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaBufferStartEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaEndEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaEndEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaErrorEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaErrorEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaFullscreenChangeEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaFullscreenChangeEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaPauseEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaPauseEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaPictureInPictureChangeEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaPictureInPictureChangeEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaPlayEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaPlayEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaPlaybackRateChangeEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaPlaybackRateChangeEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaQualityChangeEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaQualityChangeEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaReadyEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaReadyEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaSeekEndEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaSeekEndEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaSeekStartEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaSeekStartEvent()
+        trackEvent(event, messageReader)
+    }
+
+    fun trackMediaVolumeChangeEvent(messageReader: EventMessageReader) {
+        val event = messageReader.toMediaVolumeChangeEvent()
+        trackEvent(event, messageReader)
+    }
+
+    private fun trackEvent(event: Event, messageReader: EventMessageReader) {
+        val trackerController = Snowplow.getTracker(messageReader.tracker)
+        val mediaTrackingId = messageReader.mediaTrackingId
+        if (mediaTrackingId == null) {
+            trackerController?.track(event)
+        } else {
+            val mediaTracking = trackerController?.media?.getMediaTracking(mediaTrackingId)
+            mediaTracking?.track(
+                event = event,
+                player = messageReader.player?.toMediaPlayerEntity(),
+                ad = messageReader.ad?.toMediaAdEntity(),
+                adBreak = messageReader.adBreak?.toMediaAdBreakEntity()
+            )
+        }
+    }
+
 }