fix: handle ad_break_id key in the ad Summary event (#71)

Author: Mansi-mParticle

media/src/main/java/com/mparticle/media/MediaSession.kt

@@ -78,6 +78,7 @@ class MediaSession protected constructor(builder: Builder) {
 
     private var adContent: MediaAd? = null
     private var segment: MediaSegment? = null
+    private var mediaAdBreak: MediaAdBreak? = null
 
     var mediaSessionStartTimestamp: Long //Timestamp created on logMediaSessionStart event
         private set
@@ -283,6 +284,7 @@ class MediaSession protected constructor(builder: Builder) {
         val adBreakEvent = MediaEvent(this, MediaEventName.AD_BREAK_START, options = options).apply {
             this.adBreak = adBreak
         }
+        mediaAdBreak = adBreak
         logEvent(adBreakEvent)
     }
 
@@ -337,6 +339,9 @@ class MediaSession protected constructor(builder: Builder) {
             mediaTotalAdTimeSpent += ((endTime - startTime) / 1000)
         }
         val adEndEvent = MediaEvent(this, MediaEventName.AD_END, options = options)
+        mediaAdBreak?.let {
+            adContent?.adBreakId = it.id
+        }
         logEvent(adEndEvent)
 
         logAdSummary(adContent)
@@ -590,6 +595,9 @@ class MediaSession protected constructor(builder: Builder) {
             ad.title?.let {
                 customAttributes[adContentTitleKey] = it
             }
+            ad.adBreakId?.let {
+                customAttributes[adBreakIdKey] = it
+            }
             customAttributes[adContentSkippedKey] = ad.adSkipped.toString()
             customAttributes[adContentCompletedKey] = ad.adCompleted.toString()
 

media/src/main/java/com/mparticle/media/events/MediaAd.kt

@@ -19,5 +19,6 @@ class MediaAd(
     internal var adStartTimestamp: Long? = null,
     internal var adEndTimestamp: Long? = null,
     internal var adSkipped: Boolean = false,
-    internal var adCompleted: Boolean = false
+    internal var adCompleted: Boolean = false,
+    internal var adBreakId: String? = null
 )

media/src/main/java/com/mparticle/media/events/MediaEvent.kt

@@ -176,6 +176,7 @@ open class MediaEvent(
         adBreak?.apply {
             json.put(
                 "adBreak", JSONObject()
+                    .put("id",id)
                     .put("title", title)
                     .put("duration", duration)
             )

media/src/test/java/com/mparticle/MediaSessionTest.kt

@@ -592,6 +592,70 @@ class MediaSessionTest  {
         assertEquals(testContentTimeSpent, 1.0)
         assertEquals(testTimeSpent, 2.0)
     }
+
+    @Test
+    fun testLogAdSummary() {
+        val mparticle = MockMParticle()
+        val mediaSession = MediaSession.builder(mparticle) {
+            title = "hello"
+            mediaContentId ="123"
+            duration =1000
+        }
+
+        val events = mutableListOf<MediaEvent>()
+        mediaSession.mediaEventListener = { event ->
+            events.add(event)
+        }
+        mediaSession.logAdStart {  }
+        mediaSession.logAdBreakStart {
+            id = "123456"
+            title = "TestADBREAk"
+        }
+        mediaSession.logAdEnd()
+        mediaSession.logAdBreakEnd()
+        assertEquals(4, events.size)
+        events.forEach {
+            it.mediaContent.apply {
+                assertEquals("hello", name)
+                assertEquals("123", contentId)
+                assertEquals(1000L, duration)
+            }
+        }
+        assertNotNull(mparticle.loggedEvents[3].customAttributes)
+        assertNotNull(mparticle.loggedEvents[3].customAttributes?.get("ad_break_id"))
+        assertEquals("123456",mparticle.loggedEvents[3].customAttributes?.get("ad_break_id"))
+    }
+
+    @Test
+    fun testLogAdSummary_When_Break_ID_IS_NULL() {
+        val mparticle = MockMParticle()
+        val mediaSession = MediaSession.builder(mparticle) {
+            title = "hello"
+            mediaContentId ="123"
+            duration =1000
+        }
+
+        val events = mutableListOf<MediaEvent>()
+        mediaSession.mediaEventListener = { event ->
+            events.add(event)
+        }
+        mediaSession.logAdStart {  }
+        mediaSession.logAdBreakStart {
+            title = "TestADBREAk"
+        }
+        mediaSession.logAdEnd()
+        mediaSession.logAdBreakEnd()
+        assertEquals(4, events.size)
+        events.forEach {
+            it.mediaContent.apply {
+                assertEquals("hello", name)
+                assertEquals("123", contentId)
+                assertEquals(1000L, duration)
+            }
+        }
+        assertNotNull(mparticle.loggedEvents[3].customAttributes)
+        assertNull(mparticle.loggedEvents[3].customAttributes?.get("ad_break_id"))
+    }
 }
 
 fun <T: Any> T.assertTrue(assertion: (T) -> Boolean) {