feat: [IOCOM-2586] AAR Phase 2 tracking

ts/features/messages/components/MessageDetail/MessageDetailsAttachmentItem.tsx

@@ -3,12 +3,17 @@ import I18n from "i18next";
 import { ServiceId } from "../../../../../definitions/backend/ServiceId";
 import { ThirdPartyAttachment } from "../../../../../definitions/backend/ThirdPartyAttachment";
 import { useAttachmentDownload } from "../../hooks/useAttachmentDownload";
+import {
+  SendOpeningSource,
+  SendUserType
+} from "../../../pushNotifications/analytics";
 
 export type MessageDetailsAttachmentItemProps = {
   attachment: ThirdPartyAttachment;
   bottomSpacer?: boolean;
   disabled?: boolean;
-  isPN?: boolean;
+  sendOpeningSource: SendOpeningSource;
+  sendUserType: SendUserType;
   messageId: string;
   onPreNavigate?: () => void;
   serviceId: ServiceId;
@@ -18,7 +23,8 @@ export const MessageDetailsAttachmentItem = ({
   attachment,
   bottomSpacer,
   disabled = false,
-  isPN = false,
+  sendOpeningSource,
+  sendUserType,
   messageId,
   onPreNavigate = undefined,
   serviceId
@@ -27,7 +33,8 @@ export const MessageDetailsAttachmentItem = ({
     useAttachmentDownload(
       messageId,
       attachment,
-      isPN,
+      sendOpeningSource,
+      sendUserType,
       serviceId,
       onPreNavigate
     );

ts/features/messages/components/MessageDetail/MessageDetailsAttachments.tsx

@@ -5,27 +5,34 @@ import { ServiceId } from "../../../../../definitions/backend/ServiceId";
 import { useIOSelector } from "../../../../store/hooks";
 import { thirdPartyMessageAttachments } from "../../store/reducers/thirdPartyById";
 import { ATTACHMENT_CATEGORY } from "../../types/attachmentCategory";
+import {
+  SendOpeningSource,
+  SendUserType
+} from "../../../pushNotifications/analytics";
 import { MessageDetailsAttachmentItem } from "./MessageDetailsAttachmentItem";
 
 export type MessageDetailsAttachmentsProps = {
   banner?: ReactNode;
   disabled?: boolean;
-  isPN?: boolean;
   messageId: string;
   serviceId: ServiceId;
+  sendOpeningSource: SendOpeningSource;
+  sendUserType: SendUserType;
 };
 
 export const MessageDetailsAttachments = ({
   banner,
   disabled = false,
-  isPN = false,
   messageId,
-  serviceId
+  serviceId,
+  sendOpeningSource,
+  sendUserType
 }: MessageDetailsAttachmentsProps) => {
   const originalAttachments = useIOSelector(state =>
     thirdPartyMessageAttachments(state, messageId)
   );
-  const attachments = isPN
+  const isSend = sendUserType !== "not_set";
+  const attachments = isSend
     ? originalAttachments.filter(
         attachment => attachment.category !== ATTACHMENT_CATEGORY.F24
       )
@@ -47,7 +54,8 @@ export const MessageDetailsAttachments = ({
         <MessageDetailsAttachmentItem
           attachment={attachment}
           bottomSpacer={index + 1 < attachmentCount}
-          isPN={isPN}
+          sendOpeningSource={sendOpeningSource}
+          sendUserType={sendUserType}
           disabled={disabled}
           key={`MessageAttachment_${index}`}
           messageId={messageId}

ts/features/messages/components/MessageDetail/MessageDetailsPayment.tsx

@@ -46,6 +46,8 @@ export const MessageDetailsPayment = ({
         noticeNumber={paymentData.noticeNumber}
         rptId={rptId}
         serviceId={serviceId}
+        sendOpeningSource={"not_set"}
+        sendUserType={"not_set"}
       />
     </>
   );

ts/features/messages/components/MessageDetail/MessagePaymentItem.tsx

@@ -41,6 +41,10 @@ import { formatPaymentNoticeNumber } from "../../../payments/common/utils";
 import { ServiceId } from "../../../../../definitions/backend/ServiceId";
 import { trackPNPaymentStart } from "../../../pn/analytics";
 import { formatAndValidateDueDate } from "../../../payments/checkout/utils";
+import {
+  SendOpeningSource,
+  SendUserType
+} from "../../../pushNotifications/analytics";
 import {
   computeAndTrackPaymentStart,
   shouldUpdatePaymentUponReturning
@@ -55,6 +59,8 @@ type MessagePaymentItemProps = {
   noticeNumber: string;
   paymentAmount?: PaymentAmount;
   rptId: string;
+  sendOpeningSource: SendOpeningSource;
+  sendUserType: SendUserType;
   serviceId: ServiceId;
   willNavigateToPayment?: () => void;
 };
@@ -175,6 +181,8 @@ export const MessagePaymentItem = ({
   noSpaceOnTop = false,
   noticeNumber,
   rptId,
+  sendOpeningSource,
+  sendUserType,
   serviceId,
   willNavigateToPayment = undefined
 }: MessagePaymentItemProps) => {
@@ -205,7 +213,7 @@ export const MessagePaymentItem = ({
       dispatch,
       () => {
         if (isPNPayment) {
-          trackPNPaymentStart();
+          trackPNPaymentStart(sendOpeningSource, sendUserType);
         } else {
           computeAndTrackPaymentStart(serviceId, store.getState());
         }
@@ -219,6 +227,8 @@ export const MessagePaymentItem = ({
     isPNPayment,
     paymentStatusForUI,
     rptId,
+    sendOpeningSource,
+    sendUserType,
     serviceId,
     store,
     toast,

ts/features/messages/components/MessageDetail/__mocks__/MessageDetailsAttachmentItem.tsx

@@ -5,7 +5,8 @@ export const MessageDetailsAttachmentItem = ({
   attachment,
   bottomSpacer,
   disabled,
-  isPN,
+  sendOpeningSource,
+  sendUserType,
   messageId,
   onPreNavigate,
   serviceId
@@ -21,7 +22,8 @@ export const MessageDetailsAttachmentItem = ({
     </View>
     <View>{`Has${bottomSpacer ? "" : " no"} bottom spacer`}</View>
     <View>{`Is ${disabled ? "" : "not "}disabled`}</View>
-    <View>{`Is ${isPN ? "" : "not "}SEND`}</View>
+    <View>{`Send Opening Source ${sendOpeningSource}`}</View>
+    <View>{`Send User Type ${sendUserType}`}</View>
     <View>{`Message Id: ${messageId}`}</View>
     <View>{`Service Id: ${serviceId}`}</View>
     <Pressable accessibilityLabel="" onPress={onPreNavigate}>

ts/features/messages/components/MessageDetail/__mocks__/MessageDetailsAttachments.tsx

@@ -4,15 +4,17 @@ import { MessageDetailsAttachmentsProps } from "../MessageDetailsAttachments";
 export const MessageDetailsAttachments = ({
   banner,
   disabled,
-  isPN,
   messageId,
-  serviceId
+  serviceId,
+  sendOpeningSource,
+  sendUserType
 }: MessageDetailsAttachmentsProps) => (
   <>
     <View>Mock MessageDetailsAttachments</View>
     <View>{`${banner ? "Has" : "Does not have"} Banner`}</View>
     <View>{`Is ${disabled ? "" : "not "}disabled`}</View>
-    <View>{`Is ${isPN ? "" : "not "}SEND`}</View>
+    <View>{`Send Opening Source ${sendOpeningSource}`}</View>
+    <View>{`Send User Type ${sendUserType}`}</View>
     <View>{`Message Id: ${messageId}`}</View>
     <View>{`Service Id: ${serviceId}`}</View>
   </>

ts/features/messages/components/MessageDetail/__tests__/MessageDetailsAttachmentItem.test.tsx

@@ -6,85 +6,79 @@ import { renderScreenWithNavigationStoreContext } from "../../../../../utils/tes
 import { MessageDetailsAttachmentItem } from "../MessageDetailsAttachmentItem";
 import { ThirdPartyAttachment } from "../../../../../../definitions/backend/ThirdPartyAttachment";
 import { ServiceId } from "../../../../../../definitions/backend/ServiceId";
+import { MESSAGES_ROUTES } from "../../../navigation/routes";
+import {
+  SendOpeningSource,
+  SendUserType
+} from "../../../../pushNotifications/analytics";
 
-describe("MessageDetailsAttachmentItem", () => {
-  it("Should match snapshot with required parameters", () => {
-    const messageId = "01HNWXJG52YS359GWSYSRK2BWC";
-    const serviceId = "01HNWXKWAGWPHV7VGMQ21EZPSA" as ServiceId;
-    const thirdPartyAttachment = {
-      id: "1",
-      url: "https://invalid.url",
-      content_type: "application/pdf",
-      name: "A PDF File",
-      category: "DOCUMENT"
-    } as ThirdPartyAttachment;
+const messageId = "01HNWXJG52YS359GWSYSRK2BWC";
+const serviceId = "01HNWXKWAGWPHV7VGMQ21EZPSA" as ServiceId;
+const thirdPartyAttachments: ReadonlyArray<ThirdPartyAttachment> = [
+  {
+    id: "1",
+    url: "https://invalid.url",
+    content_type: "application/pdf",
+    category: "DOCUMENT"
+  } as ThirdPartyAttachment,
+  {
+    id: "1",
+    url: "https://invalid.url",
+    content_type: "application/pdf",
+    name: "A PDF File",
+    category: "DOCUMENT"
+  } as ThirdPartyAttachment
+];
 
-    const component = renderScreen(thirdPartyAttachment, messageId, serviceId);
-    expect(component.toJSON()).toMatchSnapshot();
-  });
-  it("Should match snapshot with all parameters", () => {
-    const messageId = "01HNWXJG52YS359GWSYSRK2BWC";
-    const thirdPartyAttachment = {
-      id: "1",
-      url: "https://invalid.url",
-      content_type: "application/pdf",
-      name: "A PDF File",
-      category: "DOCUMENT"
-    } as ThirdPartyAttachment;
-    const serviceId = "01HNWXKWAGWPHV7VGMQ21EZPSA" as ServiceId;
-
-    const component = renderScreen(
-      thirdPartyAttachment,
-      messageId,
-      serviceId,
-      true,
-      false,
-      true
-    );
-    expect(component.toJSON()).toMatchSnapshot();
-  });
-  it("Should match snapshot when the attachment has no name", () => {
-    const messageId = "01HNWXJG52YS359GWSYSRK2BWC";
-    const serviceId = "01HNWXKWAGWPHV7VGMQ21EZPSA" as ServiceId;
-    const thirdPartyAttachment = {
-      id: "1",
-      url: "https://invalid.url",
-      content_type: "application/pdf",
-      category: "DOCUMENT"
-    } as ThirdPartyAttachment;
-
-    const component = renderScreen(thirdPartyAttachment, messageId, serviceId);
-    expect(component.toJSON()).toMatchSnapshot();
-  });
-  it("Should match snapshot when is fetching the attachment", () => {
-    const messageId = "01HNWXJG52YS359GWSYSRK2BWC";
-    const serviceId = "01HNWXKWAGWPHV7VGMQ21EZPSA" as ServiceId;
-    const thirdPartyAttachment = {
-      id: "1",
-      url: "https://invalid.url",
-      content_type: "application/pdf",
-      category: "DOCUMENT"
-    } as ThirdPartyAttachment;
+const sendOpeningSources: ReadonlyArray<SendOpeningSource> = [
+  "aar",
+  "message",
+  "not_set"
+];
+const sendUserTypes: ReadonlyArray<SendUserType> = [
+  "mandatory",
+  "not_set",
+  "recipient"
+];
 
-    const component = renderScreen(
-      thirdPartyAttachment,
-      messageId,
-      serviceId,
-      undefined,
-      true,
-      false
-    );
-    expect(component.toJSON()).toMatchSnapshot();
+thirdPartyAttachments.forEach(thirdPartyAttachment => {
+  // eslint-disable-next-line sonarjs/cognitive-complexity
+  [false, true].forEach(isFetching => {
+    [undefined, false, true].forEach(showBottomSpacer => {
+      [undefined, false, true].forEach(isDisabled => {
+        sendOpeningSources.forEach(sendOpeningSource => {
+          sendUserTypes.forEach(sendUserType => {
+            it(`should match snapshot (attachment ${
+              thirdPartyAttachment.name ? "with" : "without"
+            } name, ${isFetching ? "" : "not "}fetching, ${
+              showBottomSpacer ? "with" : "without"
+            } bottom spacer, ${
+              isDisabled ? "disabled" : "enabled"
+            }, opening source ${sendOpeningSource}, user type ${sendUserType})`, () => {
+              const component = renderScreen(
+                thirdPartyAttachment,
+                isFetching,
+                showBottomSpacer,
+                isDisabled,
+                sendOpeningSource,
+                sendUserType
+              );
+              expect(component.toJSON()).toMatchSnapshot();
+            });
+          });
+        });
+      });
+    });
   });
 });
 
 const renderScreen = (
   attachment: ThirdPartyAttachment,
-  messageId: string,
-  serviceId: ServiceId,
-  bottomSpacer?: boolean,
-  isFetching?: boolean,
-  disabled?: boolean
+  isFetching: boolean,
+  bottomSpacer: boolean | undefined,
+  disabled: boolean | undefined,
+  sendOpeningSource: SendOpeningSource,
+  sendUserType: SendUserType
 ) => {
   const initialState = appReducer(undefined, applicationChangeState("active"));
   const finalState = appReducer(
@@ -112,9 +106,11 @@ const renderScreen = (
         disabled={disabled}
         messageId={messageId}
         serviceId={serviceId}
+        sendOpeningSource={sendOpeningSource}
+        sendUserType={sendUserType}
       />
     ),
-    "DUMMY",
+    MESSAGES_ROUTES.MESSAGE_DETAIL,
     {},
     store
   );