Merge pull request #785 from Iterable/loren/embedded/MOB-12267-android-add-start-impression-and-pause-impressio

[MOB-12267] add pauseEmbeddedImpression method to manage embedded message impressions

Author: lposen

android/src/main/java/com/iterable/reactnative/RNIterableAPIModuleImpl.java

@@ -709,6 +709,16 @@ public void endEmbeddedSession() {
         IterableApi.getInstance().getEmbeddedManager().getEmbeddedSessionManager().endSession();
     }
 
+    public void startEmbeddedImpression(String messageId, int placementId) {
+        IterableLogger.d(TAG, "startEmbeddedImpression");
+        IterableApi.getInstance().getEmbeddedManager().getEmbeddedSessionManager().startImpression(messageId, placementId);
+    }
+
+    public void pauseEmbeddedImpression(String messageId) {
+        IterableLogger.d(TAG, "pauseEmbeddedImpression");
+        IterableApi.getInstance().getEmbeddedManager().getEmbeddedSessionManager().pauseImpression(messageId);
+    }
+
     public void getEmbeddedPlacementIds(Promise promise) {
         IterableLogger.d(TAG, "getEmbeddedPlacementIds");
         try {

android/src/newarch/java/com/RNIterableAPIModule.java

@@ -239,6 +239,16 @@ public void endEmbeddedSession() {
     moduleImpl.endEmbeddedSession();
   }
 
+  @Override
+  public void startEmbeddedImpression(String messageId, double placementId) {
+    moduleImpl.startEmbeddedImpression(messageId, (int) placementId);
+  }
+
+  @Override
+  public void pauseEmbeddedImpression(String messageId) {
+    moduleImpl.pauseEmbeddedImpression(messageId);
+  }
+
   @Override
   public void getEmbeddedPlacementIds(Promise promise) {
     moduleImpl.getEmbeddedPlacementIds(promise);

android/src/oldarch/java/com/RNIterableAPIModule.java

@@ -243,6 +243,16 @@ public void endEmbeddedSession() {
       moduleImpl.endEmbeddedSession();
     }
 
+    @ReactMethod
+    public void startEmbeddedImpression(String messageId, double placementId) {
+      moduleImpl.startEmbeddedImpression(messageId, (int) placementId);
+    }
+
+    @ReactMethod
+    public void pauseEmbeddedImpression(String messageId) {
+      moduleImpl.pauseEmbeddedImpression(messageId);
+    }
+
     @ReactMethod
     public void getEmbeddedPlacementIds(Promise promise) {
       moduleImpl.getEmbeddedPlacementIds(promise);

example/src/components/Embedded/Embedded.styles.ts

@@ -1,5 +1,5 @@
 import { StyleSheet } from 'react-native';
-import { button, buttonText, container, hr } from '../../constants';
+import { button, buttonText, container, hr, link } from '../../constants';
 
 const styles = StyleSheet.create({
   button,
@@ -11,7 +11,17 @@ const styles = StyleSheet.create({
     gap: 16,
     paddingHorizontal: 16,
   },
+  embeddedTitle: {
+    fontSize: 16,
+    fontWeight: 'bold',
+    lineHeight: 20,
+  },
+  embeddedTitleContainer: {
+    display: 'flex',
+    flexDirection: 'row',
+  },
   hr,
+  link,
   text: { textAlign: 'center' },
   utilitySection: {
     paddingHorizontal: 16,

example/src/components/Embedded/Embedded.tsx

@@ -49,6 +49,26 @@ export const Embedded = () => {
       });
   }, [getPlacementIds]);
 
+  const startEmbeddedImpression = useCallback(
+    (message: IterableEmbeddedMessage) => {
+      console.log(`startEmbeddedImpression`, message);
+      Iterable.embeddedManager.startImpression(
+        message.metadata.messageId,
+        // TODO: check if this should be changed to a number, as per the type
+        Number(message.metadata.placementId)
+      );
+    },
+    []
+  );
+
+  const pauseEmbeddedImpression = useCallback(
+    (message: IterableEmbeddedMessage) => {
+      console.log(`pauseEmbeddedImpression:`, message);
+      Iterable.embeddedManager.pauseImpression(message.metadata.messageId);
+    },
+    []
+  );
+
   return (
     <SafeAreaView style={styles.container}>
       <Text style={styles.text}>EMBEDDED</Text>
@@ -64,27 +84,41 @@ export const Embedded = () => {
           Placement ids: [{placementIds.join(', ')}]
         </Text>
         <TouchableOpacity style={styles.button} onPress={syncEmbeddedMessages}>
-          <Text style={styles.buttonText}>Sync embedded messages</Text>
+          <Text style={styles.buttonText}>Sync messages</Text>
         </TouchableOpacity>
         <TouchableOpacity style={styles.button} onPress={getPlacementIds}>
           <Text style={styles.buttonText}>Get placement ids</Text>
         </TouchableOpacity>
         <TouchableOpacity style={styles.button} onPress={startEmbeddedSession}>
-          <Text style={styles.buttonText}>Start embedded session</Text>
+          <Text style={styles.buttonText}>Start session</Text>
         </TouchableOpacity>
         <TouchableOpacity style={styles.button} onPress={endEmbeddedSession}>
-          <Text style={styles.buttonText}>End embedded session</Text>
+          <Text style={styles.buttonText}>End session</Text>
         </TouchableOpacity>
         <TouchableOpacity style={styles.button} onPress={getEmbeddedMessages}>
-          <Text style={styles.buttonText}>Get embedded messages</Text>
+          <Text style={styles.buttonText}>Get messages</Text>
         </TouchableOpacity>
       </View>
       <View style={styles.hr} />
       <ScrollView>
         <View style={styles.embeddedSection}>
           {embeddedMessages.map((message) => (
             <View key={message.metadata.messageId}>
-              <Text>Embedded message</Text>
+              <View style={styles.embeddedTitleContainer}>
+                <Text style={styles.embeddedTitle}>Embedded message | </Text>
+                <TouchableOpacity
+                  onPress={() => startEmbeddedImpression(message)}
+                >
+                  <Text style={styles.link}>Start impression</Text>
+                </TouchableOpacity>
+                <Text style={styles.embeddedTitle}> | </Text>
+                <TouchableOpacity
+                  onPress={() => pauseEmbeddedImpression(message)}
+                >
+                  <Text style={styles.link}>Pause impression</Text>
+                </TouchableOpacity>
+              </View>
+
               <Text>metadata.messageId: {message.metadata.messageId}</Text>
               <Text>metadata.placementId: {message.metadata.placementId}</Text>
               <Text>elements.title: {message.elements?.title}</Text>

example/src/constants/styles/typography.ts

@@ -56,3 +56,8 @@ export const requiredStar: TextStyle = {
   ...label,
   color: colors.textDestructive,
 };
+
+export const link: TextStyle = {
+  color: colors.textInteractive,
+  textDecorationLine: 'underline',
+};

src/__mocks__/MockRNIterableAPI.ts

@@ -178,6 +178,10 @@ export class MockRNIterableAPI {
     },
   ]);
 
+  static startEmbeddedImpression = jest.fn();
+
+  static pauseEmbeddedImpression = jest.fn();
+
   // set messages function is to set the messages static property
   // this is for testing purposes only
   static setMessages(messages: IterableInAppMessage[]): void {

src/api/NativeRNIterableAPI.ts

@@ -149,6 +149,8 @@ export interface Spec extends TurboModule {
   syncEmbeddedMessages(): void;
   startEmbeddedSession(): void;
   endEmbeddedSession(): void;
+  startEmbeddedImpression(messageId: string, placementId: number): void;
+  pauseEmbeddedImpression(messageId: string): void;
   getEmbeddedPlacementIds(): Promise<number[]>;
   getEmbeddedMessages(
     placementIds: number[] | null

src/core/classes/IterableApi.ts

@@ -535,6 +535,22 @@ export class IterableApi {
     return RNIterableAPI.endEmbeddedSession();
   }
 
+  /**
+   * Starts an embedded impression.
+   */
+  static startEmbeddedImpression(messageId: string, placementId: number) {
+    IterableLogger.log('startEmbeddedImpression: ', messageId, placementId);
+    return RNIterableAPI.startEmbeddedImpression(messageId, placementId);
+  }
+
+  /**
+   * Pauses an embedded impression.
+   */
+  static pauseEmbeddedImpression(messageId: string) {
+    IterableLogger.log('pauseEmbeddedImpression: ', messageId);
+    return RNIterableAPI.pauseEmbeddedImpression(messageId);
+  }
+
   /**
    * Get the embedded placement IDs.
    */

src/embedded/classes/IterableEmbeddedManager.test.ts

@@ -167,5 +167,92 @@ describe('IterableEmbeddedManager', () => {
     });
   });
 
+  describe('startImpression', () => {
+    it('should call IterableApi.startEmbeddedImpression with messageId and placementId', () => {
+      // GIVEN a message ID and placement ID
+      const messageId = 'message-123';
+      const placementId = 456;
+
+      // WHEN startImpression is called
+      embeddedManager.startImpression(messageId, placementId);
+
+      // THEN IterableApi.startEmbeddedImpression is called with the correct parameters
+      expect(MockRNIterableAPI.startEmbeddedImpression).toHaveBeenCalledTimes(
+        1
+      );
+      expect(MockRNIterableAPI.startEmbeddedImpression).toHaveBeenCalledWith(
+        messageId,
+        placementId
+      );
+    });
+
+    it('should handle multiple impression starts', () => {
+      // GIVEN multiple messages
+      const messageId1 = 'message-1';
+      const placementId1 = 100;
+      const messageId2 = 'message-2';
+      const placementId2 = 200;
+
+      // WHEN startImpression is called multiple times
+      embeddedManager.startImpression(messageId1, placementId1);
+      embeddedManager.startImpression(messageId2, placementId2);
+
+      // THEN IterableApi.startEmbeddedImpression is called twice
+      expect(MockRNIterableAPI.startEmbeddedImpression).toHaveBeenCalledTimes(
+        2
+      );
+      expect(MockRNIterableAPI.startEmbeddedImpression).toHaveBeenNthCalledWith(
+        1,
+        messageId1,
+        placementId1
+      );
+      expect(MockRNIterableAPI.startEmbeddedImpression).toHaveBeenNthCalledWith(
+        2,
+        messageId2,
+        placementId2
+      );
+    });
+  });
+
+  describe('pauseImpression', () => {
+    it('should call IterableApi.pauseEmbeddedImpression with messageId', () => {
+      // GIVEN a message ID
+      const messageId = 'message-123';
+
+      // WHEN pauseImpression is called
+      embeddedManager.pauseImpression(messageId);
+
+      // THEN IterableApi.pauseEmbeddedImpression is called with the correct parameter
+      expect(MockRNIterableAPI.pauseEmbeddedImpression).toHaveBeenCalledTimes(
+        1
+      );
+      expect(MockRNIterableAPI.pauseEmbeddedImpression).toHaveBeenCalledWith(
+        messageId
+      );
+    });
+
+    it('should handle multiple impression pauses', () => {
+      // GIVEN multiple message IDs
+      const messageId1 = 'message-1';
+      const messageId2 = 'message-2';
+
+      // WHEN pauseImpression is called multiple times
+      embeddedManager.pauseImpression(messageId1);
+      embeddedManager.pauseImpression(messageId2);
+
+      // THEN IterableApi.pauseEmbeddedImpression is called twice
+      expect(MockRNIterableAPI.pauseEmbeddedImpression).toHaveBeenCalledTimes(
+        2
+      );
+      expect(MockRNIterableAPI.pauseEmbeddedImpression).toHaveBeenNthCalledWith(
+        1,
+        messageId1
+      );
+      expect(MockRNIterableAPI.pauseEmbeddedImpression).toHaveBeenNthCalledWith(
+        2,
+        messageId2
+      );
+    });
+  });
 });