chore: event bus integration with push

messagingpush/api/messagingpush.api

@@ -162,7 +162,7 @@ public final class io/customer/messagingpush/util/PushTrackingUtil$Companion {
 }
 
 public final class io/customer/messagingpush/util/PushTrackingUtilImpl : io/customer/messagingpush/util/PushTrackingUtil {
- public fun <init> (Lio/customer/sdk/repository/TrackRepository;)V
+ public fun <init> ()V
  public fun parseLaunchedActivityForTracking (Landroid/os/Bundle;)Z
 }
 

messagingpush/build.gradle

@@ -46,4 +46,23 @@ dependencies {
 
  api Dependencies.firebaseMessaging
  implementation Dependencies.googlePlayServicesBase
+
+ testImplementation(platform(Dependencies.junitBom))
+ testImplementation(Dependencies.junitJupiter)
+ testImplementation(Dependencies.mockk)
+
+ // enables running JUnit 4 tests within the JUnit 5 (jupiter) platform.
+ testRuntimeOnly(Dependencies.junitVintageEngine)
+}
+
+tasks.withType(Test).configureEach {
+ useJUnitPlatform()
+ filter {
+ excludeTestsMatching("*Integration*")
+ }
+ ignoreFailures = true
+ // https://github.com/mockk/mockk/issues/681
+ jvmArgs("--add-opens", "java.base/java.time=ALL-UNNAMED",
+ "--add-opens", "java.base/java.util=ALL-UNNAMED"
+ )
 }

messagingpush/src/main/java/io/customer/messagingpush/CustomerIOFirebaseMessagingService.kt

@@ -6,6 +6,8 @@
 import io.customer.messagingpush.di.pushMessageProcessor
 import io.customer.messagingpush.extensions.getSDKInstanceOrNull
 import io.customer.sdk.android.CustomerIO
+import io.customer.sdk.communication.Event
+import io.customer.sdk.core.di.SDKComponent.eventBus
 
 open class CustomerIOFirebaseMessagingService : FirebaseMessagingService() {
 
@@ -91,6 +93,10 @@
  }
 
  private fun handleNewToken(context: Context, token: String) {
+ eventBus.publish(
+ Event.RegisterDeviceTokenEvent(token)
+ )
+ // todo: remove this
  context.getSDKInstanceOrNull()?.registerDeviceToken(deviceToken = token)
  }
 

messagingpush/src/main/java/io/customer/messagingpush/ModuleMessagingPushFCM.kt

@@ -6,6 +6,8 @@ import io.customer.messagingpush.di.pushTrackingUtil
 import io.customer.messagingpush.lifecycle.MessagingPushLifecycleCallback
 import io.customer.sdk.android.CustomerIO
 import io.customer.sdk.android.CustomerIOInstance
+import io.customer.sdk.communication.Event
+import io.customer.sdk.core.di.SDKComponent.eventBus
 import io.customer.sdk.core.module.CustomerIOModule
 import io.customer.sdk.di.CustomerIOComponent
 
@@ -52,7 +54,11 @@ internal constructor(
  */
  private fun getCurrentFcmToken() {
  fcmTokenProvider.getCurrentToken { token ->
- token?.let { customerIO.registerDeviceToken(token) }
+ token?.let {
+ eventBus.publish(Event.RegisterDeviceTokenEvent(token))
+ // todo: remove this
+ customerIO.registerDeviceToken(token)
+ }
  }
  }
 

messagingpush/src/main/java/io/customer/messagingpush/di/DiGraphMessagingPush.kt

@@ -35,15 +35,14 @@ internal val CustomerIOComponent.deepLinkUtil: DeepLinkUtil
 
 @InternalCustomerIOApi
 val CustomerIOComponent.pushTrackingUtil: PushTrackingUtil
- get() = override() ?: PushTrackingUtilImpl(trackRepository)
+ get() = override() ?: PushTrackingUtilImpl()
 
 internal val CustomerIOComponent.pushMessageProcessor: PushMessageProcessor
  get() = override() ?: getSingletonInstanceCreate {
  PushMessageProcessorImpl(
  logger = logger,
  moduleConfig = moduleConfig,
- deepLinkUtil = deepLinkUtil,
- trackRepository = trackRepository
+ deepLinkUtil = deepLinkUtil
  )
  }
 

messagingpush/src/main/java/io/customer/messagingpush/processor/PushMessageProcessorImpl.kt

@@ -11,16 +11,16 @@ import io.customer.messagingpush.data.model.CustomerIOParsedPushPayload
 import io.customer.messagingpush.extensions.parcelable
 import io.customer.messagingpush.util.DeepLinkUtil
 import io.customer.messagingpush.util.PushTrackingUtil
+import io.customer.sdk.communication.Event
+import io.customer.sdk.core.di.SDKComponent.eventBus
 import io.customer.sdk.core.util.Logger
 import io.customer.sdk.data.request.MetricEvent
 import io.customer.sdk.extensions.takeIfNotBlank
-import io.customer.sdk.repository.TrackRepository
 
 internal class PushMessageProcessorImpl(
  private val logger: Logger,
  private val moduleConfig: MessagingPushModuleConfig,
- private val deepLinkUtil: DeepLinkUtil,
- private val trackRepository: TrackRepository
+ private val deepLinkUtil: DeepLinkUtil
 ) : PushMessageProcessor {
 
  /**
@@ -87,10 +87,12 @@ internal class PushMessageProcessorImpl(
  private fun trackDeliveredMetrics(deliveryId: String, deliveryToken: String) {
  // Track delivered event only if auto-tracking is enabled
  if (moduleConfig.autoTrackPushEvents) {
- trackRepository.trackMetric(
- deliveryID = deliveryId,
- deviceToken = deliveryToken,
- event = MetricEvent.delivered
+ eventBus.publish(
+ Event.TrackPushMetricEvent(
+ event = MetricEvent.delivered.name,
+ deliveryId = deliveryId,
+ deviceToken = deliveryToken
+ )
  )
  }
  }
@@ -119,10 +121,12 @@ internal class PushMessageProcessorImpl(
 
  private fun trackNotificationClickMetrics(payload: CustomerIOParsedPushPayload) {
  if (moduleConfig.autoTrackPushEvents) {
- trackRepository.trackMetric(
- deliveryID = payload.cioDeliveryId,
- event = MetricEvent.opened,
- deviceToken = payload.cioDeliveryToken
+ eventBus.publish(
+ Event.TrackPushMetricEvent(
+ event = MetricEvent.opened.name,
+ deliveryId = payload.cioDeliveryId,
+ deviceToken = payload.cioDeliveryToken
+ )
  )
  }
  }

messagingpush/src/main/java/io/customer/messagingpush/util/PushTrackingUtil.kt

@@ -1,8 +1,9 @@
 package io.customer.messagingpush.util
 
 import android.os.Bundle
+import io.customer.sdk.communication.Event
+import io.customer.sdk.core.di.SDKComponent.eventBus
 import io.customer.sdk.data.request.MetricEvent
-import io.customer.sdk.repository.TrackRepository
 
 interface PushTrackingUtil {
  fun parseLaunchedActivityForTracking(bundle: Bundle): Boolean
@@ -13,20 +14,20 @@ interface PushTrackingUtil {
  }
 }
 
-class PushTrackingUtilImpl(
- private val trackRepository: TrackRepository
-) : PushTrackingUtil {
+class PushTrackingUtilImpl : PushTrackingUtil {
 
  override fun parseLaunchedActivityForTracking(bundle: Bundle): Boolean {
  val deliveryId = bundle.getString(PushTrackingUtil.DELIVERY_ID_KEY)
  val deliveryToken = bundle.getString(PushTrackingUtil.DELIVERY_TOKEN_KEY)
 
  if (deliveryId == null || deliveryToken == null) return false
 
- trackRepository.trackMetric(
- deliveryID = deliveryId,
- deviceToken = deliveryToken,
- event = MetricEvent.opened
+ eventBus.publish(
+ Event.TrackPushMetricEvent(
+ deliveryId = deliveryId,
+ event = MetricEvent.opened.name,
+ deviceToken = deliveryToken
+ )
  )
 
  return true

messagingpush/src/test/kotlin/io/customer/messagingpush/PushTrackingUtilTest.kt

@@ -0,0 +1,67 @@
+package io.customer.messagingpush
+
+import android.os.Bundle
+import io.customer.messagingpush.util.PushTrackingUtil
+import io.customer.messagingpush.util.PushTrackingUtilImpl
+import io.customer.sdk.communication.Event
+import io.customer.sdk.communication.EventBus
+import io.customer.sdk.core.di.SDKComponent
+import io.customer.sdk.data.request.MetricEvent
+import io.customer.sdk.extensions.random
+import io.mockk.every
+import io.mockk.mockk
+import io.mockk.verify
+import org.amshove.kluent.shouldBe
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+
+class PushTrackingUtilTest {
+
+ private lateinit var eventBus: EventBus
+ private lateinit var util: PushTrackingUtil
+
+ @BeforeEach
+ fun setup() {
+ util = PushTrackingUtilImpl()
+ eventBus = mockk(relaxed = true)
+ SDKComponent.overrideDependency(EventBus::class.java, eventBus)
+ }
+
+ @Test
+ fun parseLaunchedActivityForTracking_givenBundleWithoutDeliveryData_expectDoNoTrackPush() {
+ val givenBundle = mockk<Bundle>()
+ every { givenBundle.getString("foo") } returns "randomString"
+ every { givenBundle.getString(PushTrackingUtil.DELIVERY_ID_KEY) } returns null
+ every { givenBundle.getString(PushTrackingUtil.DELIVERY_TOKEN_KEY) } returns null
+
+ val result = util.parseLaunchedActivityForTracking(givenBundle)
+
+ result shouldBe false
+
+ verify(exactly = 0) { eventBus.publish(any<Event.TrackPushMetricEvent>()) }
+ }
+
+ @Test
+ fun parseLaunchedActivityForTracking_givenBundleWithDeliveryData_expectTrackPush() {
+ val givenDeliveryId = String.random
+ val givenDeviceToken = String.random
+
+ val givenBundle = mockk<Bundle>()
+ every { givenBundle.getString(PushTrackingUtil.DELIVERY_ID_KEY) } returns givenDeliveryId
+ every { givenBundle.getString(PushTrackingUtil.DELIVERY_TOKEN_KEY) } returns givenDeviceToken
+
+ val result = util.parseLaunchedActivityForTracking(givenBundle)
+
+ result shouldBe true
+
+ verify(exactly = 1) {
+ eventBus.publish(
+ Event.TrackPushMetricEvent(
+ deliveryId = givenDeliveryId,
+ event = MetricEvent.opened.name,
+ deviceToken = givenDeviceToken
+ )
+ )
+ }
+ }
+}