fix branch updated error

Author: Mansi-mParticle

.github/workflows/cross-platform-tests.yml

@@ -56,7 +56,13 @@ jobs:
           force-avd-creation: false
           emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
           disable-animations: true
-          script: ./gradlew runAndroid
+          script: |
+            adb uninstall com.mparticle.kittests || true
+            adb uninstall com.mparticle.kits.test || true
+            adb uninstall com.mparticle.legacyTest || true
+            adb uninstall com.mparticle.test || true
+            adb uninstall com.mparticle.cpt.testing.test || true
+            ./gradlew runAndroid
       - name: "Archive Test Results"
         if: ${{ always() }}
         uses: actions/upload-artifact@v4

.github/workflows/pull-request.yml

@@ -47,16 +47,17 @@ jobs:
           force-avd-creation: false
           emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
           disable-animations: true
-          #script: ./gradlew :android-core:cAT :android-kit-base:cAT --stacktrace
           script: |
             # Disable benchmark tests as they do not work on emulators
+            adb uninstall com.mparticle.kittests || true
             adb uninstall com.mparticle.kits.test || true
-            adb uninstall com.mparticle.testutils.test || true
+            adb uninstall com.mparticle.legacyTest || true
+            adb uninstall com.mparticle.test || true
+
             ./gradlew connectedCheck --stacktrace
             
-            adb uninstall com.mparticle.kits.test || true
-            adb uninstall com.mparticle.testutils.test || true
-            ./gradlew :android-core:cAT :android-kit-base:cAT -Pandroid.testInstrumentationRunnerArguments.androidx.benchmark.enabledRules=none
+            ./gradlew :android-core:cAT -Pandroid.testInstrumentationRunnerArguments.androidx.benchmark.enabledRules=none
+            ./gradlew :android-kit-base:cAT -Pandroid.testInstrumentationRunnerArguments.androidx.benchmark.enabledRules=none
       - name: "Archive Instrumented Tests Results"
         uses: actions/upload-artifact@v4
         if: always()
@@ -102,7 +103,12 @@ jobs:
           disable-animations: true
           script: |
             # Disable benchmark tests as they do not work on emulators
-            adb uninstall com.mparticle.test; ./gradlew connectedCheck --stacktrace
+            adb uninstall com.mparticle.kittests || true
+            adb uninstall com.mparticle.kits.test || true
+            adb uninstall com.mparticle.legacyTest || true
+            adb uninstall com.mparticle.test || true
+            
+            ./gradlew connectedCheck --stacktrace
             ./gradlew -Porchestrator=true :android-core:cAT -Pandroid.testInstrumentationRunnerArguments.androidx.benchmark.enabledRules=none
       - name: "Archive Instrumented Orchestrator Tests Results"
         uses: actions/upload-artifact@v4

.gitignore

@@ -23,6 +23,7 @@ local.properties
 
 # Keystore
 *keystore
+!debug.keystore
 
 # OS X files
 .DS_Store

android-core/proguard.pro

@@ -250,3 +250,6 @@
 -keep interface com.mparticle.MpRoktEventCallback { *; }
 -keep interface com.mparticle.UnloadReasons { *; }
 -keep class com.mparticle.UnloadReasons { *; }
+-keep class com.mparticle.RoktEvent { *; }
+-keepclassmembers class com.mparticle.RoktEvent { *; }
+-keepclasseswithmembers class com.mparticle.RoktEvent$* { *; }

android-core/src/main/java/com/mparticle/internal/KitFrameworkWrapper.java

@@ -1,5 +1,7 @@
 package com.mparticle.internal;
 
+import static kotlinx.coroutines.flow.FlowKt.flowOf;
+
 import android.app.Activity;
 import android.content.Context;
 import android.content.Intent;
@@ -18,6 +20,7 @@
 import com.mparticle.MParticle;
 import com.mparticle.MParticleOptions;
 import com.mparticle.MpRoktEventCallback;
+import com.mparticle.RoktEvent;
 import com.mparticle.WrapperSdkVersion;
 import com.mparticle.consent.ConsentState;
 import com.mparticle.identity.IdentityApiRequest;
@@ -40,6 +43,8 @@
 import java.util.TreeMap;
 import java.util.concurrent.ConcurrentLinkedQueue;
 
+import kotlinx.coroutines.flow.Flow;
+
 public class KitFrameworkWrapper implements KitManager {
     private final Context mContext;
     final CoreCallbacks mCoreCallbacks;
@@ -679,6 +684,15 @@ public void execute(@NonNull String viewName,
         }
     }
 
+    @Override
+    public Flow<RoktEvent> events(@NonNull String identifier) {
+        if (mKitManager != null) {
+            return mKitManager.events(identifier);
+        } else {
+            return flowOf();
+        }
+    }
+
     @Override
     public void setWrapperSdkVersion(@NonNull WrapperSdkVersion wrapperSdkVersion) {
         if (mKitManager != null) {

android-core/src/main/java/com/mparticle/internal/KitManager.java

@@ -17,6 +17,7 @@
 import com.mparticle.MParticle;
 import com.mparticle.MParticleOptions;
 import com.mparticle.MpRoktEventCallback;
+import com.mparticle.RoktEvent;
 import com.mparticle.WrapperSdkVersion;
 import com.mparticle.consent.ConsentState;
 import com.mparticle.identity.IdentityApiRequest;
@@ -32,6 +33,8 @@
 import java.util.Map;
 import java.util.Set;
 
+import kotlinx.coroutines.flow.Flow;
+
 public interface KitManager {
 
     WeakReference<Activity> getCurrentActivity();
@@ -137,6 +140,8 @@ void execute(@NonNull String identifier,
                  @Nullable Map<String, WeakReference<Typeface>> fontTypefaces,
                  @Nullable RoktConfig config);
 
+    Flow<RoktEvent> events(@NonNull String identifier);
+
     void setWrapperSdkVersion(@NonNull WrapperSdkVersion wrapperSdkVersion);
 
     void purchaseFinalized(@NonNull String placementId, @NonNull String catalogItemId, boolean status);

android-core/src/main/kotlin/com/mparticle/Rokt.kt

@@ -6,6 +6,8 @@ import com.mparticle.internal.KitManager
 import com.mparticle.internal.listeners.ApiClass
 import com.mparticle.rokt.RoktConfig
 import com.mparticle.rokt.RoktEmbeddedView
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.flowOf
 import java.lang.ref.WeakReference
 
 @ApiClass
@@ -28,6 +30,14 @@ class Rokt internal constructor(
         }
     }
 
+    fun events(identifier: String) : Flow<RoktEvent> {
+        return if (mConfigManager.isEnabled) {
+            mKitManager.events(identifier)
+        } else {
+            flowOf()
+        }
+    }
+
     fun purchaseFinalized(placementId: String, catalogItemId: String, status: Boolean) {
         if (mConfigManager.isEnabled) {
             mKitManager.purchaseFinalized(placementId, catalogItemId, status)

android-core/src/main/kotlin/com/mparticle/RoktEvent.kt

@@ -0,0 +1,102 @@
+package com.mparticle
+
+// RoktEvent interface for handling events from the Rokt SDK.
+sealed interface RoktEvent {
+    /**
+     * ShowLoadingIndicator event will be triggered before SDK calls Rokt backend
+     */
+    data object ShowLoadingIndicator : RoktEvent
+
+    /**
+     * HideLoadingIndicator event will be triggered when SDK obtains a success or failure from
+     * Rokt backend
+     */
+    data object HideLoadingIndicator : RoktEvent
+
+    /**
+     * OfferEngagement event will be triggered if User engaged with the offer
+     * @param placementId - identifier for the placement emitting the event
+     */
+    data class OfferEngagement(val placementId: String) : RoktEvent
+
+    /**
+     * PositiveEngagement event will be triggered if User positively engaged with the offer
+     * @param placementId - identifier for the placement emitting the event
+     */
+    data class PositiveEngagement(val placementId: String) : RoktEvent
+
+    /**
+     * FirstPositiveEngagement event will be triggered when the user positively engaged with the offer first time
+     * @param placementId - identifier for the placement emitting the event
+     */
+    data class FirstPositiveEngagement(val placementId: String) : RoktEvent
+
+    /**
+     * PlacementInteractive event will be triggered when placement has been rendered and is interactable
+     * @param placementId - identifier for the placement emitting the event
+     */
+    data class PlacementInteractive(val placementId: String) : RoktEvent
+
+    /**
+     * PlacementReady event will be triggered when placement is ready to display but has not rendered content yet
+     * @param placementId - identifier for the placement emitting the event
+     */
+    data class PlacementReady(val placementId: String) : RoktEvent
+
+    /**
+     * PlacementClosed event will be triggered when placement closes by user
+     * @param placementId - identifier for the placement emitting the event
+     */
+    data class PlacementClosed(val placementId: String) : RoktEvent
+
+    /**
+     * PlacementCompleted event will be triggered when the offer progression moves to the end and no more
+     * offer to display
+     * @param placementId - identifier for the placement emitting the event
+     */
+    data class PlacementCompleted(val placementId: String) : RoktEvent
+
+    /**
+     * PlacementFailure event will be triggered when placement could not be displayed due to some failure
+     * @param placementId - optional identifier for the placement emitting the event
+     */
+    data class PlacementFailure(val placementId: String? = null) : RoktEvent
+
+    /**
+     * InitComplete event will be triggered when SDK has finished initialization
+     * @param success - true if init was successful
+     */
+    data class InitComplete(val success: Boolean) : RoktEvent
+
+    /**
+     * OpenUrl event will be triggered when user clicks on a link and the link target is set to Passthrough
+     * @param placementId - identifier for the placement emitting the event
+     * @param url - url to open
+     */
+    data class OpenUrl(val placementId: String, val url: String) : RoktEvent
+
+    /**
+     * CartItemInstantPurchase event will be triggered when the catalog item purchase is initiated
+     * by the user
+     * @property placementId The layout identifier.
+     * @property cartItemId The cart item identifier.
+     * @property catalogItemId The catalog item identifier.
+     * @property currency The currency used for the purchase.
+     * @property description The description of the cart item.
+     * @property linkedProductId The linked product identifier.
+     * @property totalPrice The total price of the cart item.
+     * @property quantity The quantity of the cart item.
+     * @property unitPrice The unit price of the cart item.
+     */
+    data class CartItemInstantPurchase(
+        val placementId: String,
+        val cartItemId: String,
+        val catalogItemId: String,
+        val currency: String,
+        val description: String,
+        val linkedProductId: String,
+        val totalPrice: Double,
+        val quantity: Int,
+        val unitPrice: Double
+    ) : RoktEvent
+}

android-core/src/test/kotlin/com/mparticle/RoktTest.kt

@@ -7,6 +7,10 @@ import com.mparticle.internal.ConfigManager
 import com.mparticle.internal.KitManager
 import com.mparticle.rokt.RoktConfig
 import com.mparticle.rokt.RoktEmbeddedView
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.flowOf
+import kotlinx.coroutines.flow.toList
+import kotlinx.coroutines.test.runTest
 import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -19,6 +23,8 @@ import org.mockito.MockitoAnnotations
 import org.powermock.core.classloader.annotations.PrepareForTest
 import org.powermock.modules.junit4.PowerMockRunner
 import java.lang.ref.WeakReference
+import kotlin.test.assertEquals
+import kotlin.test.assertTrue
 
 @RunWith(PowerMockRunner::class)
 @PrepareForTest(Looper::class, SystemClock::class)
@@ -133,4 +139,33 @@ class RoktTest {
 
         verify(kitManager, never()).purchaseFinalized("132", "1111", true)
     }
+
+    @Test
+    fun testEvents_whenEnabled_delegatesToKitManager() {
+        `when`(configManager.isEnabled).thenReturn(true)
+
+        val testIdentifier = "test-identifier"
+        val expectedFlow: Flow<RoktEvent> = flowOf()
+        `when`(kitManager.events(testIdentifier)).thenReturn(expectedFlow)
+
+        val result = rokt.events(testIdentifier)
+
+        verify(kitManager).events(testIdentifier)
+        assertEquals(expectedFlow, result)
+    }
+
+    @Test
+    fun testEvents_whenDisabled_returnsEmptyFlow() {
+        `when`(configManager.isEnabled).thenReturn(false)
+
+        val testIdentifier = "test-identifier"
+
+        val result = rokt.events(testIdentifier)
+
+        verify(kitManager, never()).events(any())
+        runTest {
+            val elements = result.toList()
+            assertTrue(elements.isEmpty())
+        }
+    }
 }

android-core/src/test/kotlin/com/mparticle/internal/KitFrameworkWrapperTest.kt

@@ -8,11 +8,16 @@ import com.mparticle.MPEvent
 import com.mparticle.MParticle
 import com.mparticle.MParticleOptions
 import com.mparticle.MockMParticle
+import com.mparticle.RoktEvent
 import com.mparticle.WrapperSdk
 import com.mparticle.WrapperSdkVersion
 import com.mparticle.commerce.CommerceEvent
 import com.mparticle.internal.PushRegistrationHelper.PushRegistration
 import com.mparticle.testutils.RandomUtils
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.flowOf
+import kotlinx.coroutines.flow.toList
+import kotlinx.coroutines.test.runTest
 import org.json.JSONArray
 import org.junit.Assert
 import org.junit.Test
@@ -22,11 +27,14 @@ import org.mockito.Mockito
 import org.mockito.Mockito.mock
 import org.mockito.Mockito.times
 import org.mockito.Mockito.verify
+import org.mockito.Mockito.`when`
 import org.powermock.api.mockito.PowerMockito
 import org.powermock.core.classloader.annotations.PrepareForTest
 import org.powermock.modules.junit4.PowerMockRunner
 import java.lang.ref.WeakReference
 import java.util.Random
+import kotlin.test.assertEquals
+import kotlin.test.assertTrue
 
 @RunWith(PowerMockRunner::class)
 class KitFrameworkWrapperTest {
@@ -652,4 +660,51 @@ class KitFrameworkWrapperTest {
 
         verify(mockKitManager).setWrapperSdkVersion(expectedSdkVersion)
     }
+
+    @Test
+    fun testEvents_kitManagerNull_returnsEmptyFlow() {
+        val wrapper = KitFrameworkWrapper(
+            mock(
+                Context::class.java
+            ),
+            mock(ReportingManager::class.java),
+            mock(ConfigManager::class.java),
+            mock(AppStateManager::class.java),
+            true,
+            mock(MParticleOptions::class.java)
+        )
+
+        val result = wrapper.events("test-identifier")
+
+        runTest {
+            val elements = result.toList()
+            assertTrue(elements.isEmpty())
+        }
+    }
+
+    @Test
+    fun testEvents_kitManagerSet_delegatesToKitManager() {
+        val wrapper = KitFrameworkWrapper(
+            mock(
+                Context::class.java
+            ),
+            mock(ReportingManager::class.java),
+            mock(ConfigManager::class.java),
+            mock(AppStateManager::class.java),
+            true,
+            mock(MParticleOptions::class.java)
+        )
+
+        val mockKitManager = mock(KitManager::class.java)
+        val expectedFlow: Flow<RoktEvent> = flowOf()
+        val testIdentifier = "test-identifier"
+
+        `when`(mockKitManager.events(testIdentifier)).thenReturn(expectedFlow)
+        wrapper.setKitManager(mockKitManager)
+
+        val result = wrapper.events(testIdentifier)
+
+        verify(mockKitManager).events(testIdentifier)
+        assertEquals(expectedFlow, result)
+    }
 }