@mhubcloud/tms_core 3.4.6 → 3.5.0

package/.vscode/settings.json

@@ -42,7 +42,6 @@
     "**/*.log": true,
     "**/*.log*": true,
     "**/build": true,
-    "**/dist": true
   },
   "search.exclude": {
     "**/node_modules": false

package/dist/index.js

@@ -54,10 +54,10 @@ __export(utils_exports, {
   EventPublisherBase: () => EventPublisherBase,
   encodeEmail: () => encodeEmail,
   extractAdCode: () => extractAdCode,
+  extractPlatformCodes: () => extractPlatformCodes,
   flatten: () => flatten,
   formatError: () => formatError,
   handlePlatformRequest: () => handlePlatformRequest,
-  handleResponse: () => handleResponse,
   logEvent: () => logEvent,
   logException: () => logException,
   logMessage: () => logMessage,
@@ -100,17 +100,23 @@ function logMessage(level, message, properties) {
     properties
   });
 }
-function logEvent(publisher2, event, region, status, payload) {
+function logEvent(publisher2, event, region, id, status, payload) {
+  const message = status >= 200 && status < 300 ? "Event dispatched to platform" : "Event dispatch failed";
   const properties = {
     publisher: publisher2,
     event,
     region,
+    id,
     status,
     payload
   };
-  logMessage(1, "Event dispatched to platform", properties);
+  logMessage(1, message, properties);
 }
 function logException(exception) {
+  aiClient?.trackMetric({
+    name: `Error/${exception.name}`,
+    value: 1
+  });
   aiClient?.trackException({ exception });
 }
 function removeUndefined(originalValue) {
@@ -168,6 +174,19 @@ function extractAdCode(data, adPlatform, adCode, format = null) {
   }
   return null;
 }
+function extractPlatformCodes(data, adPlatform) {
+  const platformCodes = data.ads.filter((x) => {
+    return x.adPlatform === adPlatform;
+  }).sort((a, b) => b.visitAt - a.visitAt)[0];
+  if (!platformCodes) {
+    return null;
+  } else {
+    return {
+      adCodes: platformCodes.adCodes,
+      visitAt: platformCodes.visitAt
+    };
+  }
+}
 function flatten(event, separator = "_") {
   return Object.assign(
     {},
@@ -192,27 +211,12 @@ function prepareTestRequestHeaders(headers, origUrl, origRequest, origResponse)
   headers["x-mhub-orig-response-status-code"] = origResponse.status;
   headers["x-mhub-orig-response-status-message"] = origResponse.statusText;
 }
-async function handleResponse(response, event) {
-  if (!response.ok) {
-    throw new Error(
-      `HTTP Error code: ${response.status}, event: ${event}, body: ${await response.text()}`
-    );
-  }
-  const body = await response.text();
-  try {
-    return JSON.parse(body);
-  } catch (ex) {
-    return body;
-  }
-}
 async function handlePlatformRequest({
   source,
   baseUrl,
   requestOptions,
   query = "",
-  event,
-  logger,
-  handlePlatformResponse = true
+  event
 }) {
   if (!baseUrl || baseUrl.length < 3) {
     throw new Error("URL for request was not provided or was not valid");
@@ -224,39 +228,42 @@ async function handlePlatformRequest({
     // eslint-disable-next-line @typescript-eslint/naming-convention
     headers: { ...requestOptions.headers }
   };
-  const rawPlatformResponse = await fetch(
-    fullUrl,
-    fetchRequestOptions
-  );
-  if (process.env.PUBLISHER_TESTURL) {
-    await handleTestRequest({
-      fetchRequestOptions,
-      fullUrl,
-      query,
-      rawPlatformResponse
-    });
-  }
-  if (handlePlatformResponse) {
-    const processedPlatformResponse = await handleResponse(
-      rawPlatformResponse,
-      event.event
-    );
+  let rawPlatformResponse;
+  try {
+    rawPlatformResponse = await fetch(fullUrl, fetchRequestOptions);
+  } catch (e) {
     logEvent(
       source,
       event.event,
       event.region,
-      rawPlatformResponse.status,
+      event.id,
+      0,
       requestOptions.body ? JSON.stringify(requestOptions.body) : void 0
     );
-    return processedPlatformResponse;
-  } else {
+    throw e;
+  }
+  if (rawPlatformResponse) {
+    if (process.env.PUBLISHER_TESTURL) {
+      await handleTestRequest({
+        fetchRequestOptions,
+        fullUrl,
+        query,
+        rawPlatformResponse
+      });
+    }
     logEvent(
       source,
       event.event,
       event.region,
+      event.id,
       rawPlatformResponse.status,
       requestOptions.body ? JSON.stringify(requestOptions.body) : void 0
     );
+    if (!rawPlatformResponse.ok) {
+      throw new Error(
+        `HTTP Error code: ${rawPlatformResponse.status}, event: ${event.event}, region: ${event.region}, body: ${await rawPlatformResponse.text()}`
+      );
+    }
   }
 }
 async function handleTestRequest(params) {
@@ -450,7 +457,7 @@ async function processMessage(message, log2, platformPublisher, trigger) {
     source: platformPublisher.source,
     data: JSON.stringify(message)
   };
-  const publishers = trigger(message, log2);
+  const publishers = await trigger(message, log2);
   if (!publishers.length) {
     logMessage(
       1,
@@ -470,7 +477,8 @@ async function processMessage(message, log2, platformPublisher, trigger) {
       platformPublisher,
       {
         event: message.event.code + (message.event.name ? "/" + message.event.name : ""),
-        region: message.event.region
+        region: message.event.region,
+        id: message.messageId
       }
     );
     if (res) {
@@ -598,6 +606,13 @@ var facebook = {
    */
   async publish(log2, config, data, event) {
     if (typeof config.id === "string" && typeof config.access_token === "string") {
+      if (!(data.user_data.fbp || data.user_data.fbc || data.user_data.client_user_agent && data.user_data.client_ip_address)) {
+        logMessage(
+          1,
+          `Facebook: excluded ${event.event} due to a lack of user identifiers`
+        );
+        return;
+      }
       const requestOptions = {
         method: "POST",
         body: JSON.stringify({ data: [removeUndefined(data)] }),
@@ -670,22 +685,31 @@ var googleAds = {
       "The imported event could not be attributed to a click. This may be because the event did not come from a Google Ads campaign.",
       "The imported event can't be recorded because its click occurred before this conversion's click-through window. Make sure you import the most recent data."
     ];
+    let status = 0;
+    let error;
     if (responseJson.partialFailureError) {
+      status = 500;
       logMessage(1, responseJson.partialFailureError.message);
       const trimmedMessage = responseJson.partialFailureError.message.split("., at")[0] ?? "";
       if (!knownErrors.includes(trimmedMessage)) {
-        throw new Error(responseJson.partialFailureError.message);
+        error = responseJson.partialFailureError.message;
       }
     } else if (responseJson.error) {
-      throw new Error(responseJson.error.message);
+      status = 500;
+      error = responseJson.error.message;
     } else {
-      logEvent(
-        this.source,
-        event.event,
-        event.region,
-        response.status,
-        requestOptions.body
-      );
+      status = 200;
+    }
+    logEvent(
+      this.source,
+      event.event,
+      event.region,
+      event.id,
+      status,
+      requestOptions.body
+    );
+    if (error) {
+      throw new Error(error);
     }
   },
   async getToken(config) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mhubcloud/tms_core",
-  "version": "3.4.6",
+  "version": "3.5.0",
   "description": "Core function for mHub Cloud TMS publishers",
   "homepage": "https://mhubcloud.com/",
   "license": "Apache 2.0",
@@ -42,6 +42,6 @@
   "scripts": {
     "test": "mocha ./tests/*.js --local-settings=./local.settings.json --timeout 100000",
     "dev": "ts-node index.ts",
-    "build": "tsup ./src/index.ts --format cjs --target node20"
+    "build": "tsup ./src/index.ts --format cjs --target node22"
   }
 }

package/src/defaultPublisher.ts

@@ -21,7 +21,7 @@ export async function defaultPublisher(
   serviceBusMessage: ServiceBusMessage,
   source: string,
   platformPublisher: PlatformPublisher,
-  trigger: (a: unknown) => EventPublisher[],
+  trigger: (a: unknown) => Promise<EventPublisher[]>,
 ) {
   if (serviceBusMessage.$schema === 'mhub/pingtest') {
     return;
@@ -69,14 +69,13 @@ async function processMessage(
   message: ServiceBusMessage,
   log: Logger,
   platformPublisher: PlatformPublisher,
-  trigger: (a: object, log: Logger) => EventPublisher[],
+  trigger: (a: object, log: Logger) => Promise<EventPublisher[]>,
 ) {
-  // TODO Je potreba otestovat, ze se to nerozbije, kdyz jsme prestali prepisovat enqueuedAt na Date.now()
   const logProperties: Telemetry['properties'] = {
     source: platformPublisher.source,
     data: JSON.stringify(message),
   };
-  const publishers = trigger(message, log);
+  const publishers = await trigger(message, log);
   if (!publishers.length) {
     utils.logMessage(
       1,
@@ -100,6 +99,7 @@ async function processMessage(
           message.event.code +
           (message.event.name ? '/' + message.event.name : ''),
         region: message.event.region,
+        id: message.messageId,
       },
     );
     if (res) {

package/src/publishers/facebook.ts

@@ -4,6 +4,36 @@ import {
   PlatformRequestOptions,
 } from '../types/PlatformPublisher';
 
+/* eslint-disable @typescript-eslint/naming-convention */
+interface FacebookData {
+  event_name: string;
+  event_time: number;
+  action_source: string;
+  event_id: string;
+  event_source_url: string;
+  opt_out: boolean;
+  user_data: {
+    client_user_agent: string;
+    fbc: string;
+    fbp: string;
+    client_ip_address: string;
+  };
+  custom_data: {
+    currency: string;
+    value: number;
+    contents: {
+      id: string;
+      quantity: number;
+      item_price: number;
+    }[];
+    content_type: string;
+    order_id: string;
+    content_category: string;
+  };
+  [x: string]: unknown;
+}
+/* eslint-enable @typescript-eslint/naming-convention */
+
 export const facebook: PlatformPublisher = {
   source: 'Facebook',
   /**
@@ -18,6 +48,20 @@ export const facebook: PlatformPublisher = {
       typeof config.id === 'string' &&
       typeof config.access_token === 'string'
     ) {
+      if (
+        !(
+          (data as FacebookData).user_data.fbp ||
+          (data as FacebookData).user_data.fbc ||
+          ((data as FacebookData).user_data.client_user_agent &&
+            (data as FacebookData).user_data.client_ip_address)
+        )
+      ) {
+        utils.logMessage(
+          1,
+          `Facebook: excluded ${event.event} due to a lack of user identifiers`,
+        );
+        return;
+      }
       const requestOptions: PlatformRequestOptions = {
         method: 'POST',
         body: JSON.stringify({ data: [utils.removeUndefined(data)] }),

package/src/publishers/googleAds.ts

@@ -115,23 +115,35 @@ export const googleAds: GoogleAdsPlatformPublisher = {
       "The imported event can't be recorded because its click occurred before this conversion's click-through window. Make sure you import the most recent data.",
     ];
 
+    let status = 0;
+    let error;
+
     if (responseJson.partialFailureError) {
+      status = 500;
       utils.logMessage(1, responseJson.partialFailureError.message);
       const trimmedMessage =
         responseJson.partialFailureError.message.split('., at')[0] ?? '';
       if (!knownErrors.includes(trimmedMessage)) {
-        throw new Error(responseJson.partialFailureError.message);
+        error = responseJson.partialFailureError.message;
       }
     } else if (responseJson.error) {
-      throw new Error(responseJson.error.message);
+      status = 500;
+      error = responseJson.error.message;
     } else {
-      utils.logEvent(
-        this.source,
-        event.event,
-        event.region,
-        response.status,
-        requestOptions.body,
-      );
+      status = 200;
+    }
+
+    utils.logEvent(
+      this.source,
+      event.event,
+      event.region,
+      event.id,
+      status,
+      requestOptions.body,
+    );
+
+    if (error) {
+      throw new Error(error);
     }
   },
 

package/src/types/EventToLog.ts

@@ -1,4 +1,5 @@
 export interface EventToLog {
   event: string;
   region: string;
+  id: string;
 }

package/src/types/ServiceBusMessage.ts

@@ -5,5 +5,6 @@ export interface ServiceBusMessage {
     name?: string;
     region: string;
   };
+  messageId: string;
   [x: string]: unknown;
 }

package/src/utils/utils.ts

@@ -73,17 +73,23 @@ export function logEvent(
   publisher: string,
   event: string,
   region: string,
+  id: string,
   status: number,
   payload?: string,
 ): void {
+  const message =
+    status >= 200 && status < 300
+      ? 'Event dispatched to platform'
+      : 'Event dispatch failed';
   const properties: Telemetry['properties'] = {
     publisher,
     event,
     region,
+    id,
     status,
     payload,
   };
-  logMessage(1, 'Event dispatched to platform', properties);
+  logMessage(1, message, properties);
 }
 
 /**
@@ -91,6 +97,10 @@ export function logEvent(
  */
 export function logException(exception: Error) {
   // log.warn(exception.message);
+  aiClient?.trackMetric({
+    name: `Error/${exception.name}`,
+    value: 1,
+  });
   aiClient?.trackException({ exception: exception });
 }
 
@@ -207,6 +217,27 @@ export function extractAdCode(
   return null;
 }
 
+export function extractPlatformCodes(
+  data: {
+    ads: Ad[];
+  },
+  adPlatform: string,
+) {
+  const platformCodes = data.ads
+    .filter((x) => {
+      return x.adPlatform === adPlatform;
+    })
+    .sort((a, b) => b.visitAt - a.visitAt)[0];
+  if (!platformCodes) {
+    return null;
+  } else {
+    return {
+      adCodes: platformCodes.adCodes,
+      visitAt: platformCodes.visitAt,
+    };
+  }
+}
+
 /**
  * Transforms an object to be flat, for instance for GA4
  * @param event Event that is received
@@ -263,28 +294,6 @@ export function prepareTestRequestHeaders(
   headers['x-mhub-orig-response-status-message'] = origResponse.statusText;
 }
 
-/**
- * Handles HTTP response from node-fetch
- * @param response Node-fetch response object
- * @param event Event for which the response is
- * @returns Deserialized response JSON
- */
-export async function handleResponse(response: Response, event: string) {
-  if (!response.ok) {
-    throw new Error(
-      `HTTP Error code: ${
-        response.status
-      }, event: ${event}, body: ${await response.text()}`,
-    );
-  }
-  const body = await response.text();
-  try {
-    return JSON.parse(body) as object;
-  } catch (ex) {
-    return body;
-  }
-}
-
 interface HandleRequestParams {
   source: string;
   baseUrl: string;
@@ -307,8 +316,6 @@ export async function handlePlatformRequest({
   requestOptions,
   query = '',
   event,
-  logger,
-  handlePlatformResponse = true,
 }: HandleRequestParams) {
   if (!baseUrl || baseUrl.length < 3) {
     // ? Mohli bychom zacit delat poradnou kontrolu validity vstupnich paramteru. Idealne pres ZOD
@@ -323,43 +330,48 @@ export async function handlePlatformRequest({
     headers: { ...requestOptions.headers },
   };
 
-  const rawPlatformResponse: Response = await fetch(
-    fullUrl,
-    fetchRequestOptions,
-  );
-
-  if (process.env.PUBLISHER_TESTURL) {
-    await handleTestRequest({
-      fetchRequestOptions,
-      fullUrl,
-      query,
-      rawPlatformResponse,
-    });
-  }
-
-  if (handlePlatformResponse) {
-    const processedPlatformResponse = await handleResponse(
-      rawPlatformResponse,
-      event.event,
-    );
+  let rawPlatformResponse: Response | undefined;
 
+  try {
+    rawPlatformResponse = await fetch(fullUrl, fetchRequestOptions);
+  } catch (e: unknown) {
     logEvent(
       source,
       event.event,
       event.region,
-      rawPlatformResponse.status,
+      event.id,
+      0,
       requestOptions.body ? JSON.stringify(requestOptions.body) : undefined,
     );
+    throw e;
+  }
+
+  if (rawPlatformResponse) {
+    if (process.env.PUBLISHER_TESTURL) {
+      await handleTestRequest({
+        fetchRequestOptions,
+        fullUrl,
+        query,
+        rawPlatformResponse,
+      });
+    }
 
-    return processedPlatformResponse;
-  } else {
     logEvent(
       source,
       event.event,
       event.region,
+      event.id,
       rawPlatformResponse.status,
       requestOptions.body ? JSON.stringify(requestOptions.body) : undefined,
     );
+
+    if (!rawPlatformResponse.ok) {
+      throw new Error(
+        `HTTP Error code: ${rawPlatformResponse.status}, event: ${
+          event.event
+        }, region: ${event.region}, body: ${await rawPlatformResponse.text()}`,
+      );
+    }
   }
 }
 

package/tests/AffiliatePort.js

@@ -84,7 +84,8 @@ async function test(serviceBusMessage) {
   );
 }
 
-function trigger(data) {
+// eslint-disable-next-line @typescript-eslint/require-await
+async function trigger(data) {
   const publishers = [];
   let publisher;
 

package/tests/CJ.js

@@ -118,7 +118,8 @@ async function test(serviceBusMessage) {
   );
 }
 
-function trigger(data, log) {
+// eslint-disable-next-line @typescript-eslint/require-await
+async function trigger(data, log) {
   const publishers = [];
   if (data.event.code === 'purchase') {
     let publisher = CJPurchasePublisher;

package/tests/Facebook.js

@@ -42,7 +42,7 @@ describe('test Facebook publisher', function () {
           quantity: 1,
         },
       ],
-      enqueuedAt: 1657003409370,
+      enqueuedAt: Date.now(),
       ads: [],
     };
     await test(serviceBusMessage);
@@ -63,15 +63,16 @@ async function test(serviceBusMessage) {
   );
 }
 
-function trigger(data) {
+// eslint-disable-next-line @typescript-eslint/require-await
+async function trigger(data) {
   const publishers = [];
   let publisher;
 
   // Dummy config, replace with your own
   const config = {
-    id: 'fffff',
+    id: process.env.Publisher_Facebook_PixelId,
     // eslint-disable-next-line @typescript-eslint/naming-convention
-    access_token: 'zzzz',
+    access_token: process.env.Publisher_Facebook_AccessToken,
   };
 
   switch (data.event?.code) {

package/tests/GoogleAds.js

@@ -48,6 +48,7 @@ describe('test GoogleAds publisher', function () {
           adPlatform: 'googleads',
           adCodes: {
             gclid: 'mhubcloud',
+            gcl_src: 'aw.ds',
           },
           visitAt: 1727173492000,
         },
@@ -71,7 +72,8 @@ async function test(serviceBusMessage) {
   );
 }
 
-function trigger(data) {
+// eslint-disable-next-line @typescript-eslint/require-await
+async function trigger(data) {
   const publishers = [];
   let publisher;
 
@@ -97,6 +99,7 @@ function trigger(data) {
       publishers.push(publisher);
       break;
   }
+
   return publishers;
 }
 

package/tests/GoogleAnalytics4.js

@@ -63,7 +63,8 @@ async function test(serviceBusMessage) {
   );
 }
 
-function trigger(data) {
+// eslint-disable-next-line @typescript-eslint/require-await
+async function trigger(data) {
   const publishers = [];
   const config = { trackingId: 'G-289495622' };
 

package/tests/Piano.js

@@ -63,7 +63,8 @@ async function test(serviceBusMessage) {
   );
 }
 
-function trigger(data) {
+// eslint-disable-next-line @typescript-eslint/require-await
+async function trigger(data) {
   const publishers = [];
   const config = {
     collectionDomain: 'xxxxx.xiti.com', // Secured collection domain

package/tests/UniversalAnalytics.js

@@ -54,7 +54,8 @@ async function test(serviceBusMessage) {
   );
 }
 
-function trigger(data) {
+// eslint-disable-next-line @typescript-eslint/require-await
+async function trigger(data) {
   const publishers = [];
   const config = { trackingId: 'UA-xxxxxxx-yy' };