Merge pull request #46 from bitmovin/release/2.1.4

Release/2.1.4
bitmovin · Sep 20, 2022 · 4ad149f · 4ad149f
2 parents c9d8183 + 544b424
commit 4ad149f
Show file tree

Hide file tree

Showing 11 changed files with 532 additions and 462 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+### [2.1.4]
+### Fixed
+
+- Send buffering event to Conviva on seek/timeshift
+
+### [2.1.3]
+### Fixed
+
+- Fixed remaining unit tests
+
 ### [2.1.2]
 ### Fixed
 

diff --git a/...vaTestApp/src/androidTest/java/com/bitmovin/analytics/conviva/testapp/AdsTrackingTests.kt b/...vaTestApp/src/androidTest/java/com/bitmovin/analytics/conviva/testapp/AdsTrackingTests.kt
@@ -23,13 +23,13 @@ class AdsTrackingTests : TestBase() {
 
         // load source and verify
         loadSource(activityScenario, DEFAULT_DASH_VOD_SOURCE)
+        verifyPlaying(activityScenario = activityScenario)
 
-        //verifyPlaying(activityScenario = activityScenario)
+        Thread.sleep(8000) // Bit flakey with smaller timeouts than this
 
         // verify Ad start
         activityScenario.onActivity { activity: MainActivity ->
-            verifyOrder {
-                convivaAnalyticsIntegration?.updateContentMetadata(any())
+            verify {
                 videoAnalyticsMock?.reportAdBreakStarted(ConvivaSdkConstants.AdPlayer.CONTENT, ConvivaSdkConstants.AdType.CLIENT_SIDE)
             }
         }

diff --git a/...aTestApp/src/androidTest/java/com/bitmovin/analytics/conviva/testapp/CustomEventsTests.kt b/...aTestApp/src/androidTest/java/com/bitmovin/analytics/conviva/testapp/CustomEventsTests.kt
@@ -1,12 +1,14 @@
 package com.bitmovin.analytics.conviva.testapp
 
 import androidx.test.ext.junit.runners.AndroidJUnit4
-import com.conviva.api.*
+import com.conviva.sdk.ConvivaAnalytics
 import com.conviva.sdk.ConvivaSdkConstants
-import io.mockk.*
+import io.mockk.clearMocks
+import io.mockk.verify
+import io.mockk.verifyAll
+import io.mockk.verifyOrder
 import org.junit.Test
 import org.junit.runner.RunWith
-import java.util.*
 
 @RunWith(AndroidJUnit4::class)
 class CustomEventsTests: TestBase() {
@@ -15,151 +17,144 @@ class CustomEventsTests: TestBase() {
         // launch player with autoPlay enabled
         activityScenario = setupPlayerActivityForTest(autoPlay = true, defaultMetadataOverrides())
 
-        // verify that custom events are not sent before Conviva session is initialized
-//        activityScenario.onActivity { activity: MainActivity ->
-//            convivaAnalyticsIntegration?.sendCustomApplicationEvent(CUSTOM_EVENT_NAME)
-//            convivaAnalyticsIntegration?.sendCustomApplicationEvent(CUSTOM_EVENT_NAME, CUSTOM_EVENT_ATTRIBUTES)
-//            verifyAll(inverse = true) {
-//                clientMock?.sendCustomEvent(
-//                    Client.NO_SESSION_KEY, CUSTOM_EVENT_NAME,
-//                    HashMap()
-//                )
-//                clientMock?.sendCustomEvent(
-//                    Client.NO_SESSION_KEY, CUSTOM_EVENT_NAME,
-//                    CUSTOM_EVENT_ATTRIBUTES
-//                )
-//            }
-//        }
+        // initialize and verify session
+        initializeSession(activityScenario)
+        verifySessionInitialization(activityScenario)
+
+        // In the latest Conviva SDK, there is no problem with reporting app events before
+        // a session is opened, as shown here.
+        activityScenario.onActivity { activity: MainActivity ->
+            convivaAnalyticsIntegration?.sendCustomApplicationEvent(CUSTOM_EVENT_NAME)
+            convivaAnalyticsIntegration?.sendCustomApplicationEvent(CUSTOM_EVENT_NAME, HashMap(CUSTOM_EVENT_ATTRIBUTES) as Map<String, Any>?)
+
+            verifyOrder() {
+                ConvivaAnalytics.reportAppEvent(CUSTOM_EVENT_NAME, HashMap())
+                ConvivaAnalytics.reportAppEvent(CUSTOM_EVENT_NAME, HashMap(CUSTOM_EVENT_ATTRIBUTES) as Map<String, Any>?)
+            }
+        }
+
+        loadSource(activityScenario, DEFAULT_DASH_VOD_SOURCE)
+
+        activityScenario.onActivity { activity: MainActivity ->
+            convivaAnalyticsIntegration?.sendCustomApplicationEvent(CUSTOM_EVENT_NAME)
+            convivaAnalyticsIntegration?.sendCustomApplicationEvent(CUSTOM_EVENT_NAME, HashMap(CUSTOM_EVENT_ATTRIBUTES) as Map<String, Any>?)
+            verifyOrder() {
+                ConvivaAnalytics.reportAppEvent(CUSTOM_EVENT_NAME, HashMap())
+                ConvivaAnalytics.reportAppEvent(CUSTOM_EVENT_NAME, HashMap(CUSTOM_EVENT_ATTRIBUTES) as Map<String, Any>?)
+            }
+        }
+    }
+
+    @Test
+    fun customPlaybackEvent() {
+        // launch player with autoPlay enabled
+        activityScenario = setupPlayerActivityForTest(autoPlay = true, defaultMetadataOverrides())
 
         // initialize and verify session
         initializeSession(activityScenario)
         verifySessionInitialization(activityScenario)
+        // In the latest Conviva SDK, there is no problem with reporting app events before
+        // a session is opened, as shown here.
+        activityScenario.onActivity { activity: MainActivity ->
+            convivaAnalyticsIntegration?.sendCustomPlaybackEvent(CUSTOM_EVENT_NAME)
+            convivaAnalyticsIntegration?.sendCustomPlaybackEvent(CUSTOM_EVENT_NAME, HashMap(CUSTOM_EVENT_ATTRIBUTES) as Map<String, Any>?)
+
+            verifyOrder() {
+                ConvivaAnalytics.reportAppEvent(CUSTOM_EVENT_NAME, HashMap())
+                ConvivaAnalytics.reportAppEvent(CUSTOM_EVENT_NAME, HashMap(CUSTOM_EVENT_ATTRIBUTES) as Map<String, Any>?)
+            }
+        }
 
-        // verify that custom events are sent after Conviva session is initialized
-//        activityScenario.onActivity { activity: MainActivity ->
-//            convivaAnalyticsIntegration?.sendCustomApplicationEvent(CUSTOM_EVENT_NAME)
-//            convivaAnalyticsIntegration?.sendCustomApplicationEvent(CUSTOM_EVENT_NAME, CUSTOM_EVENT_ATTRIBUTES)
-//            verifyOrder() {
-//                clientMock?.sendCustomEvent(
-//                    Client.NO_SESSION_KEY,
-//                    CUSTOM_EVENT_NAME,
-//                    HashMap())
-//                clientMock?.sendCustomEvent(
-//                    Client.NO_SESSION_KEY,
-//                    CUSTOM_EVENT_NAME,
-//                    CUSTOM_EVENT_ATTRIBUTES)
-//            }
-//        }
+        loadSource(activityScenario, DEFAULT_DASH_VOD_SOURCE)
+
+        activityScenario.onActivity { activity: MainActivity ->
+            convivaAnalyticsIntegration?.sendCustomPlaybackEvent(CUSTOM_EVENT_NAME)
+            convivaAnalyticsIntegration?.sendCustomPlaybackEvent(CUSTOM_EVENT_NAME, HashMap(CUSTOM_EVENT_ATTRIBUTES) as Map<String, Any>?)
+
+            verifyOrder() {
+                ConvivaAnalytics.reportAppEvent(CUSTOM_EVENT_NAME, HashMap())
+                ConvivaAnalytics.reportAppEvent(CUSTOM_EVENT_NAME, HashMap(CUSTOM_EVENT_ATTRIBUTES) as Map<String, Any>?)
+            }
+        }
     }
 
-//    @Test
-//    fun customPlaybackEvent() {
-//        // launch player with autoPlay enabled
-//        activityScenario = setupPlayerActivityForTest(autoPlay = true, defaultMetadataOverrides())
-//
-//        // Verify that custom events are not sent before Conviva session is initialized
-//        activityScenario.onActivity { activity: MainActivity ->
-//            convivaAnalyticsIntegration?.sendCustomPlaybackEvent(CUSTOM_EVENT_NAME)
-//            convivaAnalyticsIntegration?.sendCustomPlaybackEvent(CUSTOM_EVENT_NAME, CUSTOM_EVENT_ATTRIBUTES)
-//            verifyOrder(inverse = true) {
-//                clientMock?.sendCustomEvent(
-//                    CONVIVA_SESSION_ID,
-//                    CUSTOM_EVENT_NAME,
-//                    HashMap()
-//                )
-//                clientMock?.sendCustomEvent(
-//                    CONVIVA_SESSION_ID,
-//                    CUSTOM_EVENT_NAME,
-//                    CUSTOM_EVENT_ATTRIBUTES
-//                )
-//            }
-//        }
-//
-//        // initialize and verify session
-//        initializeSession(activityScenario)
-//        verifySessionIntialization(activityScenario)
-//
-//        // verify that custom events are sent after Conviva session is initialized
-//        activityScenario.onActivity { activity: MainActivity ->
-//            convivaAnalyticsIntegration?.sendCustomPlaybackEvent(CUSTOM_EVENT_NAME)
-//            convivaAnalyticsIntegration?.sendCustomPlaybackEvent(CUSTOM_EVENT_NAME, CUSTOM_EVENT_ATTRIBUTES)
-//            verifyOrder() {
-//                clientMock?.sendCustomEvent(
-//                    CONVIVA_SESSION_ID,
-//                    CUSTOM_EVENT_NAME,
-//                    HashMap())
-//                clientMock?.sendCustomEvent(
-//                    CONVIVA_SESSION_ID,
-//                    CUSTOM_EVENT_NAME,
-//                    CUSTOM_EVENT_ATTRIBUTES)
-//            }
-//        }
-//    }
-
-//    @Test
-//    fun customErrorEvent() {
-//        // launch player with autoPlay enabled
-//        activityScenario = setupPlayerActivityForTest(autoPlay = true, defaultMetadataOverrides())
-//
-//        // verify that custom error events are not sent before Conviva session is initialized
-//        activityScenario.onActivity { activity: MainActivity ->
-//            convivaAnalyticsIntegration?.reportPlaybackDeficiency(
-//                CUSTOM_ERROR_MESSAGE,
-//                Client.ErrorSeverity.WARNING,
-//                false
-//            )
-//            verify(inverse = true) {
-//                clientMock?.reportError(any(), any(), any())
-//            }
-//            convivaAnalyticsIntegration?.reportPlaybackDeficiency(
-//                CUSTOM_ERROR_MESSAGE,
-//                ConvivaSdkConstants.ErrorSeverity.FATAL,
-//                true
-//            )
-//            verify(inverse = true) {
-//                clientMock?.reportError(any(), any(), any())
-//            }
-//        }
-//
-//        // initialize and verify session
-//        initializeSession(activityScenario)
-//        verifySessionIntialization(activityScenario)
-//
-//        // verify that custom error events are sent after Conviva session is initialized
-//        // but Conviva session is not ended when endSession argument is not passed as true
-//        activityScenario.onActivity { activity: MainActivity ->
-//            clearMocks(clientMock!!)
-//            convivaAnalyticsIntegration?.reportPlaybackDeficiency(
-//                CUSTOM_ERROR_MESSAGE,
-//                ConvivaSdkConstants.ErrorSeverity.WARNING,
-//                false
-//            )
-//            verify(exactly = 1) {
-//                clientMock?.reportError(
-//                    CONVIVA_SESSION_ID,
-//                    CUSTOM_ERROR_MESSAGE,
-//                    Client.ErrorSeverity.WARNING
-//                )
-//            }
-//            verifyAll(inverse = true) {
-//                clientMock?.detachPlayer(CONVIVA_SESSION_ID)
-//                clientMock?.cleanupSession(CONVIVA_SESSION_ID)
-//                clientMock?.releasePlayerStateManager(playerStateManagerMock)
-//            }
-//        }
-//
-//        // verify that custom error events are sent after Conviva session is initialized
-//        // and Conviva session is also ended when endSession argument is passed as true
-//        activityScenario.onActivity { activity: MainActivity ->
-//            clearMocks(clientMock!!)
-//            clearMocks(playerStateManagerMock!!)
-//            convivaAnalyticsIntegration?.reportPlaybackDeficiency(CUSTOM_ERROR_MESSAGE, Client.ErrorSeverity.FATAL, true)
-//            verifyOrder() {
-//                clientMock?.reportError(CONVIVA_SESSION_ID, CUSTOM_ERROR_MESSAGE, Client.ErrorSeverity.FATAL)
-//                clientMock?.detachPlayer(CONVIVA_SESSION_ID)
-//                clientMock?.cleanupSession(CONVIVA_SESSION_ID)
-//                clientMock?.releasePlayerStateManager(playerStateManagerMock)
-//            }
-//        }
-//    }
+    @Test
+    fun customErrorEvent() {
+        // launch player with autoPlay enabled
+        activityScenario = setupPlayerActivityForTest(autoPlay = true, defaultMetadataOverrides())
+
+        // initialize and verify session
+        initializeSession(activityScenario)
+        verifySessionInitialization(activityScenario)
+
+        // In the latest Conviva SDK, there is no problem with reporting app events before
+        // a session is opened, as shown here.
+        activityScenario.onActivity { activity: MainActivity ->
+            clearMocks(videoAnalyticsMock!!)
+            convivaAnalyticsIntegration?.reportPlaybackDeficiency(
+                CUSTOM_ERROR_MESSAGE,
+                ConvivaSdkConstants.ErrorSeverity.WARNING,
+                false
+            )
+
+            verify() {
+                videoAnalyticsMock?.reportPlaybackError(
+                        CUSTOM_ERROR_MESSAGE,
+                        ConvivaSdkConstants.ErrorSeverity.WARNING
+                )
+            }
+
+            convivaAnalyticsIntegration?.reportPlaybackDeficiency(
+                CUSTOM_ERROR_MESSAGE,
+                ConvivaSdkConstants.ErrorSeverity.FATAL,
+                true
+            )
+
+            verify() {
+                videoAnalyticsMock?.reportPlaybackError(
+                        CUSTOM_ERROR_MESSAGE,
+                        ConvivaSdkConstants.ErrorSeverity.FATAL
+                )
+            }
+        }
+
+        activityScenario = setupPlayerActivityForTest(autoPlay = true, defaultMetadataOverrides())
+
+        // initialize and verify session  again
+        initializeSession(activityScenario)
+        verifySessionInitialization(activityScenario)
+
+        // verify that custom error events are sent after Conviva session is initialized
+        // but Conviva session is not ended when endSession argument is not passed as true
+        activityScenario.onActivity { activity: MainActivity ->
+            clearMocks(videoAnalyticsMock!!)
+            convivaAnalyticsIntegration?.reportPlaybackDeficiency(
+                CUSTOM_ERROR_MESSAGE,
+                ConvivaSdkConstants.ErrorSeverity.WARNING,
+                false
+            )
+            verify(exactly = 1) {
+                videoAnalyticsMock?.reportPlaybackError(
+                    CUSTOM_ERROR_MESSAGE,
+                    ConvivaSdkConstants.ErrorSeverity.WARNING
+                )
+            }
+            verify(inverse = true) {
+                videoAnalyticsMock?.reportPlaybackEnded()
+            }
+        }
+
+        // verify that custom error events are sent after Conviva session is initialized
+        // and Conviva session is also ended when endSession argument is passed as true
+        activityScenario.onActivity { activity: MainActivity ->
+            clearMocks(videoAnalyticsMock!!)
+            convivaAnalyticsIntegration?.reportPlaybackDeficiency(
+                    CUSTOM_ERROR_MESSAGE,
+                    ConvivaSdkConstants.ErrorSeverity.FATAL,
+                    true)
+            verifyOrder() {
+                videoAnalyticsMock?.reportPlaybackEnded()
+            }
+        }
+    }
 }
diff --git a/...estApp/src/androidTest/java/com/bitmovin/analytics/conviva/testapp/CustomMetadataTests.kt b/...estApp/src/androidTest/java/com/bitmovin/analytics/conviva/testapp/CustomMetadataTests.kt
@@ -1,18 +1,20 @@
 package com.bitmovin.analytics.conviva.testapp
 
 import androidx.test.ext.junit.runners.AndroidJUnit4
+import com.bitmovin.analytics.conviva.MetadataOverrides
 import com.conviva.sdk.ConvivaSdkConstants
 import com.conviva.sdk.ConvivaSdkConstants.*
 import io.mockk.*
 import org.junit.Test
 import org.junit.runner.RunWith
 import java.util.*
 
+// TODO - currently broken
 @RunWith(AndroidJUnit4::class)
 class CustomMetadataTests : TestBase() {
     @Test
     fun metadataOverrideVodExplicitInitialize() {
-        val customInternTags: MutableMap<String, String> = HashMap()
+        val customInternTags: MutableMap<String, String> = mutableMapOf<String, String>()
         customInternTags["contentType"] = "Episode"
         val customMetadata = customMetadataOverrides(
             source = DEFAULT_DASH_VOD_SOURCE,
@@ -42,7 +44,7 @@ class CustomMetadataTests : TestBase() {
     }
 
     @Test
-    fun metadataOverrideLiveExplicitInitalize() {
+    fun metadataOverrideLiveExplicitInitialize() {
         val customInternTags: MutableMap<String, String> = HashMap()
         customInternTags["contentType"] = "Episode"
         val customMetadata = customMetadataOverrides(
@@ -104,19 +106,5 @@ class CustomMetadataTests : TestBase() {
             metadata = customMetadata,
             overrideCustom = true
         )
-
-//        activityScenario.onActivity { activity: MainActivity ->
-//            verify {
-//                clientMock?.updateContentMetadata(
-//                    CONVIVA_SESSION_ID,
-//                    metadataEq(expectedContentMetadata(
-//                        source = DEFAULT_DASH_VOD_SOURCE,
-//                        streamType = StreamType.VOD,
-//                        duration = DEFAULT_DASH_VOD_SOURCE_DURATION,
-//                        overrideMetadata = customMetadata,
-//                        overrideCustom = true))
-//                )
-//            }
-//        }
     }
 }