chore: cordial

src/cdk/v2/destinations/cordial/procWorkflow.yaml

@@ -35,21 +35,28 @@ steps:
     template: |
       $.context.messageType = .message.type.toLowerCase();
 
-  - name: validateInput
+  - name: validateConfig
+    template: |
+      $.assertConfig(.destination.Config.apiKey, "API Key is not present. Aborting");
+      $.assertConfig(.destination.Config.apiBaseUrl, "API Base URl is not present. Aborting");
+
+  - name: validateMessageType
     template: |
       let messageType = $.context.messageType;
       $.assert(messageType, "message Type is not present. Aborting");
       $.assert(messageType in {{$.EventType.([.TRACK, .IDENTIFY])}}, "message type " + messageType + " is not supported");
-      $.assertConfig(.destination.Config.apiKey, "API Key is not present. Aborting");
-      $.assertConfig(.destination.Config.apiBaseUrl, "API Base URl is not present. Aborting");
 
   - name: getContactId
     template: |
       $.getDestinationExternalID(.message,'cordialContactId');
 
   - name: getContactEmail
     template: |
-      .message.().({{{{$.getGenericPaths("email")}}}};);
+      .message.().({{{{$.getGenericPaths("emailOnly")}}}});
+
+  - name: validateEventPayload
+    template: |
+      $.assert($.outputs.getContactId || $.outputs.getContactEmail, "Either one of cordial contact id or email is required. Aborting");
 
   - name: buildIdentifyPayload
     condition: $.context.messageType in [{{$.EventType.IDENTIFY}}]

src/v1/sources/cordial/config.js

@@ -0,0 +1,6 @@
+const eventsMapping = {
+  crdl_app_install: 'Application Installed',
+  crdl_app_open: 'Application Opened',
+};
+
+module.exports = { eventsMapping };

src/v1/sources/cordial/mapping.json

@@ -0,0 +1,22 @@
+[
+  {
+    "sourceKeys": "event._id",
+    "destKeys": "properties.event_id"
+  },
+  {
+    "sourceKeys": "contact._id",
+    "destKeys": ["context.traits.userId", "userId"]
+  },
+  {
+    "sourceKeys": ["event.ts", "event.ats"],
+    "destKeys": ["timestamp", "sentAt", "originalTimestamp"]
+  },
+  {
+    "sourceKeys": "event.d",
+    "destKeys": "context.device"
+  },
+  {
+    "sourceKeys": "contact.channels.email.address",
+    "destKeys": ["context.traits.email"]
+  }
+]

src/v1/sources/cordial/transform.js

@@ -0,0 +1,51 @@
+const Message = require('../../../v0/sources/message');
+const { CommonUtils } = require('../../../util/common');
+const { generateUUID, isDefinedAndNotNull } = require('../../../v0/util');
+const { eventsMapping } = require('./config');
+
+const mapping = require('./mapping.json');
+
+const processEvent = (inputPaylaod) => {
+  const message = new Message(`Cordial`);
+  let eventName = inputPaylaod.event?.a || inputPaylaod.event?.action;
+  if (eventName in eventsMapping) {
+    eventName = eventsMapping[eventName];
+  }
+  message.setEventType('track');
+  message.setEventName(eventName);
+  message.setPropertiesV2(inputPaylaod, mapping);
+
+  const externalId = [];
+  // setting up cordial contact_id to externalId
+  if (inputPaylaod.contact.cID) {
+    externalId.push({
+      type: 'cordialContactId',
+      id: inputPaylaod.contact.cID,
+    });
+  }
+  message.context.externalId = externalId;
+
+  if (!isDefinedAndNotNull(message.userId)) {
+    message.anonymousId = generateUUID();
+  }
+  // Due to multiple mappings to the same destination path object some are not showing up due to which we are doing the following
+  message.context.traits = { ...message.context.traits, ...inputPaylaod.contact };
+  message.properties = {
+    ...message.properties,
+    ...inputPaylaod.event.properties,
+    ...inputPaylaod.event,
+  };
+  delete message.properties.properties;
+  delete message.properties.d;
+  // eslint-disable-next-line no-underscore-dangle
+  delete message.properties._id;
+  return message;
+};
+
+const process = (inputEvent) => {
+  const { event: events } = inputEvent;
+  const eventsArray = CommonUtils.toArray(events);
+  return eventsArray.map(processEvent);
+};
+
+exports.process = process;

test/integrations/destinations/cordial/processor/validation.ts

@@ -3,6 +3,47 @@ import { generateMetadata } from '../../../testUtils';
 import { destType, destination, processorInstrumentationErrorStatTags } from '../common';
 
 export const validation: ProcessorTestData[] = [
+  {
+    id: 'cordial-validation-test-1',
+    name: destType,
+    description: 'All of the required fields — cordial contact id, email — are missing.',
+    scenario: 'Framework',
+    successCriteria: 'Instrumentation Error',
+    feature: 'processor',
+    module: 'destination',
+    version: 'v0',
+    input: {
+      request: {
+        body: [
+          {
+            destination,
+            message: {
+              type: 'identify',
+              integrations: {
+                All: true,
+              },
+              originalTimestamp: '2024-03-04T15:32:56.409Z',
+            },
+            metadata: generateMetadata(1),
+          },
+        ],
+      },
+    },
+    output: {
+      response: {
+        status: 200,
+        body: [
+          {
+            error:
+              'Either one of cordial contact id or email is required. Aborting: Workflow: procWorkflow, Step: validateEventPayload, ChildStep: undefined, OriginalError: Either one of cordial contact id or email is required. Aborting',
+            metadata: generateMetadata(1),
+            statTags: processorInstrumentationErrorStatTags,
+            statusCode: 400,
+          },
+        ],
+      },
+    },
+  },
   {
     id: 'cordial-validation-test-2',
     name: destType,
@@ -38,7 +79,7 @@ export const validation: ProcessorTestData[] = [
         body: [
           {
             error:
-              'message type group is not supported: Workflow: procWorkflow, Step: validateInput, ChildStep: undefined, OriginalError: message type group is not supported',
+              'message type group is not supported: Workflow: procWorkflow, Step: validateMessageType, ChildStep: undefined, OriginalError: message type group is not supported',
             metadata: generateMetadata(1),
             statTags: processorInstrumentationErrorStatTags,
             statusCode: 400,