@mhubcloud/tms_core 3.4.0-beta.5 → 3.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mhubcloud/tms_core",
-  "version": "3.4.0-beta.5",
+  "version": "3.4.0",
   "description": "Core function for mHub Cloud TMS publishers",
   "homepage": "https://mhubcloud.com/",
   "license": "Apache 2.0",

package/src/defaultPublisher.ts

@@ -40,17 +40,23 @@ export async function defaultPublisher(
   for (const result of results) {
     if (result.status === 'rejected') {
       if (result.reason instanceof Error) {
-        const errorMessage = utils.parseErrorMessage(result.reason);
-        utils.logException(azureFunctionContext.log, new Error(errorMessage));
-        throw new Error(errorMessage);
+        const formattedError = utils.formatError(result.reason);
+        utils.logException(
+          azureFunctionContext.log,
+          new Error(formattedError.message),
+        );
+        throw formattedError;
       } else {
-        const errorMessage = utils.parseErrorMessage(
+        const formattedError = utils.formatError(
           typeof result.reason === 'object'
             ? JSON.stringify(result.reason)
             : (result.reason as Error['message']),
         );
-        utils.logException(azureFunctionContext.log, new Error(errorMessage));
-        throw new Error(errorMessage);
+        utils.logException(
+          azureFunctionContext.log,
+          new Error(formattedError.message),
+        );
+        throw formattedError;
       }
     }
   }

package/src/publishers/googleAds.ts

@@ -1,24 +1,65 @@
+import { Logger } from '@azure/functions';
 import * as utils from './../utils/utils';
-import {
-  PlatformPublisher,
-  PlatformRequestOptions,
-} from '../types/PlatformPublisher';
-import {
-  fetchGoogleAdsToken,
-  GoogleAdsConfig,
-} from '../utils/tokens/googleAdsToken';
+import { EventToLog } from '../types/EventToLog';
+import { TypeSafeObject } from '../types/UtilTypes';
+
+interface GoogleAdsPlatformPublisher {
+  source: string;
+  publish: (
+    log: Logger,
+    config: GoogleAdsConfig,
+    data: TypeSafeObject,
+    event: EventToLog,
+  ) => Promise<void>;
+  getToken: (config: GoogleAdsConfig) => Promise<TokenCache>;
+}
 
 interface GoogleAdsData {
   gclid?: string;
   wbraid?: string;
   gbraid?: string;
   // eslint-disable-next-line @typescript-eslint/naming-convention
-  user_identifiers: Record<string, unknown>[];
+  user_identifiers?: Record<string, unknown>[];
   conversionAction?: string;
   [x: string]: unknown;
 }
 
-export const googleAds: PlatformPublisher = {
+interface GoogleAdsConfig extends TypeSafeObject {
+  client: {
+    id: string;
+    secret: string;
+    developerToken: string;
+  };
+  refreshToken: string;
+  customerId: string;
+  conversionId: string;
+}
+
+interface GoogleAdsResponse {
+  partialFailureError?: {
+    message: string;
+  };
+  error?: {
+    message: string;
+  };
+}
+
+interface TokenCache {
+  token: string;
+  createdAt: number;
+}
+
+interface TokenResponse {
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  access_token: string;
+}
+
+type TokenPromise = Promise<TokenCache> | null;
+
+let tokenCache: TokenCache | null;
+let tokenPromise: TokenPromise;
+
+export const googleAds: GoogleAdsPlatformPublisher = {
   source: 'GoogleAds',
   /**
    *Publishes data to Google Ads
@@ -38,7 +79,7 @@ export const googleAds: PlatformPublisher = {
       return;
     }
 
-    const tokenData = await fetchGoogleAdsToken(config);
+    const tokenData = await this.getToken(config);
 
     data.conversionAction = `customers/${config.customerId}/conversionActions/${config.conversionId}`;
 
@@ -54,6 +95,7 @@ export const googleAds: PlatformPublisher = {
       headers: {
         // eslint-disable-next-line @typescript-eslint/naming-convention
         Authorization: `Bearer ${tokenData.token}`,
+        // eslint-disable-next-line @typescript-eslint/naming-convention
         'developer-token': config.client.developerToken,
       },
       body: JSON.stringify(body),
@@ -65,32 +107,75 @@ export const googleAds: PlatformPublisher = {
     const responseJson: GoogleAdsResponse = await response.json();
 
     const knownErrors = [
-      'The imported event has a conversion_date_time that precedes the click. Make sure your conversion_date_time is correct and try again., at conversions[0].conversion_date_time',
-      "The click ID or call is associated with an Ads account you don't have access to. Make sure you import conversions for accounts managed by your manager account., at conversions[0].gclid",
-      "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., at conversions[0].gclid",
-      'The imported event includes an order ID that was previously recorded, so the event was not processed., at conversions[0].order_id',
-      'The imported event could not be attributed to a click. This may be because the event did not come from a Google Ads campaign., at conversions[0].gclid',
-      "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., at conversions[0].conversion_action",
+      'The imported event has a conversion_date_time that precedes the click. Make sure your conversion_date_time is correct and try again.',
+      "The click ID or call is associated with an Ads account you don't have access to. Make sure you import conversions for accounts managed by your manager account.",
+      "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.",
+      'The imported event includes an order ID that was previously recorded, so the event was not processed.',
+      '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.",
     ];
 
     if (responseJson.partialFailureError) {
       utils.logMessage(1, responseJson.partialFailureError.message);
-      if (!knownErrors.includes(responseJson.partialFailureError.message)) {
+      const trimmedMessage =
+        responseJson.partialFailureError.message.split('., at')[0] ?? '';
+      if (!knownErrors.includes(trimmedMessage)) {
         throw new Error(responseJson.partialFailureError.message);
       }
     } else if (responseJson.error) {
       throw new Error(responseJson.error.message);
     } else {
-      utils.logEvent(this.source, event.event, event.region);
+      utils.logEvent(
+        this.source,
+        event.event,
+        event.region,
+        response.status,
+        requestOptions.body,
+      );
     }
   },
-};
 
-interface GoogleAdsResponse {
-  partialFailureError?: {
-    message: string;
-  };
-  error?: {
-    message: string;
-  };
-}
+  async getToken(config: GoogleAdsConfig) {
+    if (tokenCache && tokenCache.createdAt + 3500 * 1000 > Date.now()) {
+      return tokenCache;
+    }
+
+    if (!tokenPromise) {
+      tokenPromise = (async () => {
+        const tokenResponse = await fetch(
+          `https://oauth2.googleapis.com/token`,
+          {
+            method: 'POST',
+            headers: {
+              // eslint-disable-next-line @typescript-eslint/naming-convention
+              'Content-Type': 'application/x-www-form-urlencoded',
+            },
+            body: new URLSearchParams({
+              // eslint-disable-next-line @typescript-eslint/naming-convention
+              client_id: config.client.id,
+              // eslint-disable-next-line @typescript-eslint/naming-convention
+              client_secret: config.client.secret,
+              // eslint-disable-next-line @typescript-eslint/naming-convention
+              refreshToken: config.refreshToken,
+              // eslint-disable-next-line @typescript-eslint/naming-convention
+              grant_type: 'refresh_token',
+            }),
+          },
+        );
+
+        if (!tokenResponse.ok) {
+          throw new Error('Access token fetch failed');
+        }
+
+        const parsedTokenResponse: TokenResponse = await tokenResponse.json();
+        const createdAt = Date.now();
+
+        tokenCache = { token: parsedTokenResponse.access_token, createdAt };
+        tokenPromise = null;
+        return tokenCache;
+      })();
+    }
+
+    return tokenPromise;
+  },
+};

package/src/utils/utils.ts

@@ -12,10 +12,7 @@ import { TypeSafeObject } from '../types/UtilTypes';
 
 let aiClient: appInsights.TelemetryClient | null = null;
 
-if (
-  process.env.APPLICATIONINSIGHTS_CONNECTION_STRING ||
-  process.env.APPINSIGHTS_INSTRUMENTATIONKEY
-) {
+if (process.env.APPLICATIONINSIGHTS_CONNECTION_STRING) {
   appInsights
     .setup() // Set environment variable APPLICATIONINSIGHTS_CONNECTION_STRING, so setup() can be called w/o parameters
     .setAutoCollectDependencies(false)
@@ -76,11 +73,15 @@ export function logEvent(
   publisher: string,
   event: string,
   region: string,
+  status: number,
+  payload?: string,
 ): void {
   const properties: Telemetry['properties'] = {
-    publisher: publisher,
-    event: event,
-    region: region,
+    publisher,
+    event,
+    region,
+    status,
+    payload,
   };
   logMessage(1, 'Event dispatched to platform', properties);
 }
@@ -322,7 +323,10 @@ export async function handlePlatformRequest({
     headers: { ...requestOptions.headers },
   };
 
-  const rawPlatformResponse = await fetch(fullUrl, fetchRequestOptions);
+  const rawPlatformResponse: Response = await fetch(
+    fullUrl,
+    fetchRequestOptions,
+  );
 
   if (process.env.PUBLISHER_TESTURL) {
     await handleTestRequest({
@@ -339,11 +343,23 @@ export async function handlePlatformRequest({
       event.event,
     );
 
-    logEvent(source, event.event, event.region);
+    logEvent(
+      source,
+      event.event,
+      event.region,
+      rawPlatformResponse.status,
+      requestOptions.body ? JSON.stringify(requestOptions.body) : undefined,
+    );
 
     return processedPlatformResponse;
   } else {
-    logEvent(source, event.event, event.region);
+    logEvent(
+      source,
+      event.event,
+      event.region,
+      rawPlatformResponse.status,
+      requestOptions.body ? JSON.stringify(requestOptions.body) : undefined,
+    );
   }
 }
 
@@ -377,16 +393,19 @@ async function handleTestRequest(params: HandleTestRequestParams) {
   }
 }
 
-export function parseErrorMessage(error: Error | Error['message']) {
-  let errorMessage;
+export function formatError(error: Error | Error['message']) {
+  let formattedError: Error;
   if (error instanceof Error) {
+    formattedError = error;
     if (error.cause) {
-      errorMessage = `${error.message} Cause: ${error.cause.toString()}`;
+      formattedError.message = `${
+        error.message
+      } Cause: ${error.cause.toString()}`;
     } else {
-      errorMessage = error.message;
+      formattedError.message = error.message;
     }
   } else {
-    errorMessage = error;
+    formattedError = new Error(error);
   }
-  return errorMessage;
+  return formattedError;
 }

package/tests/AffiliatePort.js

@@ -1,7 +1,8 @@
+const localSettings = require('../local.settings.json').Values;
+process.env = { ...process.env, ...localSettings };
 const publisher = require('../dist/index.js').publisher.AffiliatePort;
 const defaultPublisher = require('../dist/index.js').DefaultPublisher;
 const utils = require('../dist/index.js').utils;
-var assert = require('assert');
 const testUtils = require('../dist/index.js').testUtils;
 
 describe('test AffiliatePort publisher', function () {

package/tests/CJ.js

@@ -1,7 +1,8 @@
+const localSettings = require('../local.settings.json').Values;
+process.env = { ...process.env, ...localSettings };
 const publisher = require('../dist/index.js').publisher.CJ;
 const defaultPublisher = require('../dist/index.js').DefaultPublisher;
 const utils = require('../dist/index.js').utils;
-var assert = require('assert');
 const testUtils = require('../dist/index.js').testUtils;
 
 describe('test CJ publisher', function () {

package/tests/Facebook.js

@@ -1,7 +1,8 @@
+const localSettings = require('../local.settings.json').Values;
+process.env = { ...process.env, ...localSettings };
 const publisher = require('../dist/index.js').publisher.Facebook;
 const defaultPublisher = require('../dist/index.js').DefaultPublisher;
 const utils = require('../dist/index.js').utils;
-var assert = require('assert');
 const testUtils = require('../dist/index.js').testUtils;
 
 describe('test Facebook publisher', function () {

package/tests/GoogleAds.js

@@ -1,9 +1,9 @@
+const localSettings = require('../local.settings.json').Values;
+process.env = { ...process.env, ...localSettings };
 const publisher = require('../dist/index.js').publisher.GoogleAds;
 const defaultPublisher = require('../dist/index.js').DefaultPublisher;
 const utils = require('../dist/index.js').utils;
 const testUtils = require('../dist/index.js').testUtils;
-const localSettings = require('../local.settings.json');
-process.env = { ...process.env, ...localSettings };
 
 describe('test GoogleAds publisher', function () {
   it('purchase', async function () {
@@ -84,11 +84,11 @@ function trigger(data) {
     },
     refreshToken:
       // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
-      process.env['Publisher_GoogleAds_RefreshToken_' + data.event.region],
+      process.env.Publisher_GoogleAds_RefreshToken,
     customerId:
       // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
-      process.env['Publisher_GoogleAds_CustomerID_' + data.event.region],
-    conversionId: process.env.Publisher_GoogleAds_ConversionID_purchase_MAIN,
+      process.env.Publisher_GoogleAds_CustomerID,
+    conversionId: process.env.Publisher_GoogleAds_ConversionID_purchase,
   };
 
   switch (data.event?.code) {

package/tests/GoogleAnalytics4.js

@@ -1,7 +1,8 @@
+const localSettings = require('../local.settings.json').Values;
+process.env = { ...process.env, ...localSettings };
 const publisher = require('../dist/index.js').publisher.GoogleAnalytics4;
 const defaultPublisher = require('../dist/index.js').DefaultPublisher;
 const utils = require('../dist/index.js').utils;
-var assert = require('assert');
 const testUtils = require('../dist/index.js').testUtils;
 
 describe('test GoogleAnalytics4 publisher', function () {

package/tests/Piano.js

@@ -1,8 +1,9 @@
+const localSettings = require('../local.settings.json').Values;
+process.env = { ...process.env, ...localSettings };
 const publisher = require('../dist/index.js').publisher.Piano;
 const defaultPublisher = require('../dist/index.js').DefaultPublisher;
 const utils = require('../dist/index.js').utils;
 const testUtils = require('../dist/index.js').testUtils;
-var assert = require('assert');
 
 describe('test Piano publisher', function () {
   it('purchase', async function () {

package/tests/UniversalAnalytics.js

@@ -1,7 +1,8 @@
+const localSettings = require('../local.settings.json').Values;
+process.env = { ...process.env, ...localSettings };
 const publisher = require('../dist/index.js').publisher.UniversalAnalytics;
 const defaultPublisher = require('../dist/index.js').DefaultPublisher;
 const utils = require('../dist/index.js').utils;
-var assert = require('assert');
 const testUtils = require('../dist/index.js').testUtils;
 
 describe('test UniversalAnalytics publisher', function () {

package/src/utils/tokens/googleAdsToken.ts

@@ -1,66 +0,0 @@
-let tokenCache: TokenCache | null = null;
-let tokenPromise: Promise<TokenCache> | null = null;
-
-export async function fetchGoogleAdsToken(
-  config: GoogleAdsConfig,
-): Promise<TokenCache> {
-  if (tokenCache && tokenCache.createdAt + 3500 * 1000 > Date.now()) {
-    return tokenCache;
-  }
-
-  if (!tokenPromise) {
-    tokenPromise = (async () => {
-      const tokenResponse = await fetch(`https://oauth2.googleapis.com/token`, {
-        method: 'POST',
-        headers: {
-          // eslint-disable-next-line @typescript-eslint/naming-convention
-          'Content-Type': 'application/x-www-form-urlencoded',
-        },
-        body: new URLSearchParams({
-          // eslint-disable-next-line @typescript-eslint/naming-convention
-          client_id: config.client.id,
-          // eslint-disable-next-line @typescript-eslint/naming-convention
-          client_secret: config.client.secret,
-          refreshToken: config.refreshToken,
-          // eslint-disable-next-line @typescript-eslint/naming-convention
-          grant_type: 'refresh_token',
-        }),
-      });
-
-      // if (!tokenResponse.ok) {
-      //     throw new Error('Access token fetch failed')
-      // }
-
-      const parsedTokenResponse: TokenResponse = await tokenResponse.json();
-      const createdAt = Date.now();
-
-      tokenCache = { token: parsedTokenResponse.access_token, createdAt };
-      tokenPromise = null;
-      return tokenCache;
-    })();
-  }
-
-  return tokenPromise;
-}
-
-interface TokenCache {
-  token: string;
-  createdAt: number;
-}
-
-interface TokenResponse {
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  access_token: string;
-}
-
-export interface GoogleAdsConfig {
-  client: {
-    id: string;
-    secret: string;
-    developerToken: string;
-  };
-  refreshToken: string;
-  customerId: string;
-  conversionId: string;
-  [x: string]: unknown;
-}