fix: suppress some ad events when outside of an ad break (#102)

muxinc · Nov 21, 2024 · e955ff8 · e955ff8
1 parent 612b60f
commit e955ff8
Show file tree

Hide file tree

Showing 2 changed files with 209 additions and 1 deletion.
diff --git a/library/src/main/java/com/mux/stats/sdk/muxstats/MuxStatsSdkMedia3.kt b/library/src/main/java/com/mux/stats/sdk/muxstats/MuxStatsSdkMedia3.kt
@@ -6,9 +6,18 @@ import androidx.annotation.OptIn
 import androidx.media3.common.MediaLibraryInfo
 import androidx.media3.common.Player
 import androidx.media3.common.util.UnstableApi
+import com.mux.android.util.noneOf
 import com.mux.stats.sdk.core.CustomOptions
 import com.mux.stats.sdk.core.events.EventBus
+import com.mux.stats.sdk.core.events.playback.AdBreakEndEvent
+import com.mux.stats.sdk.core.events.playback.AdEndedEvent
 import com.mux.stats.sdk.core.events.playback.AdEvent
+import com.mux.stats.sdk.core.events.playback.AdFirstQuartileEvent
+import com.mux.stats.sdk.core.events.playback.AdMidpointEvent
+import com.mux.stats.sdk.core.events.playback.AdPauseEvent
+import com.mux.stats.sdk.core.events.playback.AdPlayEvent
+import com.mux.stats.sdk.core.events.playback.AdPlayingEvent
+import com.mux.stats.sdk.core.events.playback.AdThirdQuartileEvent
 import com.mux.stats.sdk.core.model.CustomerData
 import com.mux.stats.sdk.core.model.CustomerVideoData
 import com.mux.stats.sdk.core.util.MuxLogger
@@ -145,7 +154,24 @@ class AdCollector private constructor(
   }
 
   fun dispatch(event: AdEvent) {
-    eventBus.dispatch(event)
+
+    if (
+      muxPlayerState != MuxPlayerState.PLAYING_ADS &&
+      event.type.noneOf(
+        AdPlayingEvent.TYPE,
+        AdPlayEvent.TYPE,
+        AdFirstQuartileEvent.TYPE,
+        AdMidpointEvent.TYPE,
+        AdThirdQuartileEvent.TYPE,
+        AdEndedEvent.TYPE,
+        AdBreakEndEvent.TYPE,
+        AdPauseEvent.TYPE
+      )
+      ) {
+      eventBus.dispatch(event)
+    } else if (muxPlayerState == MuxPlayerState.PLAYING_ADS) {
+      eventBus.dispatch(event)
+    }
   }
 
   companion object {

diff --git a/library/src/test/java/com/mux/stats/sdk/muxstats/AdCollectorTests.kt b/library/src/test/java/com/mux/stats/sdk/muxstats/AdCollectorTests.kt
@@ -3,6 +3,11 @@ package com.mux.stats.sdk.muxstats
 import com.mux.stats.media3.test.tools.AbsRobolectricTest
 import com.mux.stats.sdk.core.events.EventBus
 import com.mux.stats.sdk.core.events.IEvent
+import com.mux.stats.sdk.core.events.playback.AdErrorEvent
+import com.mux.stats.sdk.core.events.playback.AdPlayEvent
+import com.mux.stats.sdk.core.events.playback.AdPlayingEvent
+import com.mux.stats.sdk.core.events.playback.AdRequestEvent
+import com.mux.stats.sdk.core.events.playback.AdResponseEvent
 import com.mux.stats.sdk.core.events.playback.RebufferEndEvent
 import io.mockk.every
 import io.mockk.just
@@ -45,4 +50,181 @@ class AdCollectorTests : AbsRobolectricTest() {
     )
 
   }
+
+  @Test
+  fun testDispatchesAdPlayAndAdPlayingOnlyDuringAdBreaks() {
+    val dispatchedEvents = mutableListOf<IEvent>()
+    val eventBus = mockk<EventBus> {
+      every { addListener(any()) } just runs
+      every { removeListener(any()) } just runs
+      every { removeAllListeners() } just runs
+      every { dispatch(any()) } answers { call ->
+        dispatchedEvents += (call.invocation.args.first() as IEvent)
+      }
+    }
+    val stateCollector = MuxStateCollector(mockk<MuxStats>(relaxed = true), eventBus)
+    val adCollector = AdCollector.create(stateCollector, eventBus)
+
+    adCollector.dispatch(AdPlayEvent(null))
+    adCollector.dispatch(AdPlayingEvent(null))
+
+    Assert.assertTrue(
+      "adplay should not be sent to event bus",
+      dispatchedEvents.find { it is AdPlayEvent } == null
+    )
+
+    Assert.assertTrue(
+      "adplaying should not be sent to event bus",
+      dispatchedEvents.find { it is AdPlayingEvent } == null
+    )
+
+    dispatchedEvents.clear()
+    adCollector.onStartPlayingAds()
+
+    adCollector.dispatch(AdPlayEvent(null))
+    adCollector.dispatch(AdPlayingEvent(null))
+
+    Assert.assertTrue(
+      "adplay should not be sent to event bus",
+      dispatchedEvents.find { it is AdPlayEvent } != null
+    )
+
+    Assert.assertTrue(
+      "adplaying should not be sent to event bus",
+      dispatchedEvents.find { it is AdPlayingEvent } != null
+    )
+
+    dispatchedEvents.clear()
+    adCollector.onFinishPlayingAds(willPlay = true)
+
+    adCollector.dispatch(AdPlayEvent(null))
+    adCollector.dispatch(AdPlayingEvent(null))
+
+    Assert.assertTrue(
+      "adplay should not be sent to event bus",
+      dispatchedEvents.find { it is AdPlayEvent } == null
+    )
+
+    Assert.assertTrue(
+      "adplaying should not be sent to event bus",
+      dispatchedEvents.find { it is AdPlayingEvent } == null
+    )
+  }
+
+  @Test
+  fun testDispatchesAdErrorBothDuringAndOutsideOfAdBreaks() {
+    val dispatchedEvents = mutableListOf<IEvent>()
+    val eventBus = mockk<EventBus> {
+      every { addListener(any()) } just runs
+      every { removeListener(any()) } just runs
+      every { removeAllListeners() } just runs
+      every { dispatch(any()) } answers { call ->
+        dispatchedEvents += (call.invocation.args.first() as IEvent)
+      }
+    }
+    val stateCollector = MuxStateCollector(mockk<MuxStats>(relaxed = true), eventBus)
+    val adCollector = AdCollector.create(stateCollector, eventBus)
+
+    adCollector.dispatch(AdErrorEvent(null))
+    Assert.assertTrue(
+      "aderror should be sent to event bus before the start of an ad break",
+      dispatchedEvents.find { it is AdErrorEvent } != null
+    )
+
+    dispatchedEvents.clear()
+    adCollector.onStartPlayingAds()
+
+    adCollector.dispatch(AdErrorEvent(null))
+    Assert.assertTrue(
+      "aderror should be sent to event bus during an ad break",
+      dispatchedEvents.find { it is AdErrorEvent } != null
+    )
+
+    dispatchedEvents.clear()
+    adCollector.onFinishPlayingAds(willPlay = true)
+
+    adCollector.dispatch(AdErrorEvent(null))
+    Assert.assertTrue(
+      "aderror should be sent to event bus after an ad break is finished",
+      dispatchedEvents.find { it is AdErrorEvent } != null
+    )
+  }
+
+  @Test
+  fun testDispatchesAdRequestBothDuringAndOutsideOfAdBreaks() {
+    val dispatchedEvents = mutableListOf<IEvent>()
+    val eventBus = mockk<EventBus> {
+      every { addListener(any()) } just runs
+      every { removeListener(any()) } just runs
+      every { removeAllListeners() } just runs
+      every { dispatch(any()) } answers { call ->
+        dispatchedEvents += (call.invocation.args.first() as IEvent)
+      }
+    }
+    val stateCollector = MuxStateCollector(mockk<MuxStats>(relaxed = true), eventBus)
+    val adCollector = AdCollector.create(stateCollector, eventBus)
+
+    adCollector.dispatch(AdRequestEvent(null))
+    Assert.assertTrue(
+      "adrequest should be sent to event bus before the start of an ad break",
+      dispatchedEvents.find { it is AdRequestEvent } != null
+    )
+
+    dispatchedEvents.clear()
+    adCollector.onStartPlayingAds()
+
+    adCollector.dispatch(AdRequestEvent(null))
+    Assert.assertTrue(
+      "adrequest should be sent to event bus during an ad break",
+      dispatchedEvents.find { it is AdRequestEvent } != null
+    )
+
+    dispatchedEvents.clear()
+    adCollector.onFinishPlayingAds(willPlay = true)
+
+    adCollector.dispatch(AdRequestEvent(null))
+    Assert.assertTrue(
+      "adrequest should be sent to event bus  after an ad break is finished",
+      dispatchedEvents.find { it is AdRequestEvent } != null
+    )
+  }
+
+  @Test
+  fun testDispatchesAdResponseBothDuringAndOutsideOfAdBreaks() {
+    val dispatchedEvents = mutableListOf<IEvent>()
+    val eventBus = mockk<EventBus> {
+      every { addListener(any()) } just runs
+      every { removeListener(any()) } just runs
+      every { removeAllListeners() } just runs
+      every { dispatch(any()) } answers { call ->
+        dispatchedEvents += (call.invocation.args.first() as IEvent)
+      }
+    }
+    val stateCollector = MuxStateCollector(mockk<MuxStats>(relaxed = true), eventBus)
+    val adCollector = AdCollector.create(stateCollector, eventBus)
+
+    adCollector.dispatch(AdResponseEvent(null))
+    Assert.assertTrue(
+      "adresponse should be sent to event bus before the start of an ad break",
+      dispatchedEvents.find { it is AdResponseEvent } != null
+    )
+
+    dispatchedEvents.clear()
+    adCollector.onStartPlayingAds()
+
+    adCollector.dispatch(AdResponseEvent(null))
+    Assert.assertTrue(
+      "adresponse should be sent to event bus during an ad break",
+      dispatchedEvents.find { it is AdResponseEvent } != null
+    )
+
+    dispatchedEvents.clear()
+    adCollector.onFinishPlayingAds(willPlay = true)
+
+    adCollector.dispatch(AdResponseEvent(null))
+    Assert.assertTrue(
+      "adresponse should be sent to event bus after an ad break is finished",
+      dispatchedEvents.find { it is AdResponseEvent } != null
+    )
+  }
 }