@mhubcloud/tms_core 3.3.0-beta.2 → 3.3.0-beta.3

package/dist/index.js

@@ -57,10 +57,7 @@ var crypto = __toESM(require("crypto"));
 var appInsights = __toESM(require("applicationinsights"));
 var aiClient = null;
 if (process.env.APPLICATIONINSIGHTS_CONNECTION_STRING || process.env.APPINSIGHTS_INSTRUMENTATIONKEY) {
-  const samplingLevel = process.env.SamplingLevel ?? "12.5";
-  appInsights.setup().setAutoCollectDependencies(false).setAutoCollectConsole(true, false).setSendLiveMetrics(false).setAutoCollectRequests(false).setAutoCollectPerformance(false).setUseDiskRetryCaching(false);
-  appInsights.defaultClient.config.samplingPercentage = parseFloat(samplingLevel);
-  appInsights.start();
+  appInsights.setup().setAutoCollectDependencies(false).setAutoCollectConsole(true, false).setSendLiveMetrics(false).setAutoCollectRequests(false).setAutoCollectPerformance(false).setUseDiskRetryCaching(false).start();
   aiClient = appInsights.defaultClient;
 }
 var EventPublisherBase = class {
@@ -96,8 +93,7 @@ function logEvent(publisher2, event, region) {
   const properties = {
     publisher: publisher2,
     event,
-    region,
-    sampling: process.env.SamplingLevel
+    region
   };
   logMessage(1, "Event dispatched to platform", properties);
 }
@@ -303,8 +299,7 @@ async function defaultPublisher(azureFunctionContext, serviceBusMessage, source,
 async function processMessage(message, log2, platformPublisher, trigger) {
   const logProperties = {
     source: platformPublisher.source,
-    data: JSON.stringify(message),
-    sampling: process.env.Sampling
+    data: JSON.stringify(message)
   };
   const publishers = trigger(message, log2);
   if (!publishers.length) {
@@ -482,6 +477,97 @@ var facebook = {
   }
 };
 
+// src/utils/tokens/googleAdsToken.ts
+var tokenCache = null;
+var tokenPromise = null;
+async function fetchGoogleAdsToken(config) {
+  if (tokenCache && tokenCache.createdAt + 3500 * 1e3 > 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"
+        })
+      });
+      const parsedTokenResponse = await tokenResponse.json();
+      const createdAt = Date.now();
+      tokenCache = { token: parsedTokenResponse.access_token, createdAt };
+      tokenPromise = null;
+      return tokenCache;
+    })();
+  }
+  return tokenPromise;
+}
+
+// src/publishers/googleAds.ts
+var googleAds = {
+  source: "GoogleAds",
+  /**
+   *Publishes data to Google Ads
+   * @param log Azure Function context.log
+   * @param config Publisher configuration
+   * @param data Data in publisher-friendly format to be published
+   * @param event Event for which the function is triggered
+   */
+  async publish(log2, config, data, event) {
+    if (!data.gclid && !data.wbraid && !data.gbraid && !data.user_identifiers) {
+      logMessage(1, `Excluded ${event.event} due to lack of identifiers`);
+      return;
+    }
+    const tokenData = await fetchGoogleAdsToken(config);
+    data.conversionAction = `customers/${config.customerId}/conversionActions/${config.conversionId}`;
+    const body = {
+      conversions: [data],
+      partialFailure: true,
+      validateOnly: false,
+      debugEnabled: false
+    };
+    const requestOptions = {
+      method: "POST",
+      headers: {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        Authorization: `Bearer ${tokenData.token}`,
+        "developer-token": config.client.developerToken
+      },
+      body: JSON.stringify(body)
+    };
+    const baseUrl = `https://googleads.googleapis.com/v17/customers/${config.customerId}:uploadClickConversions`;
+    const response = await fetch(baseUrl, requestOptions);
+    const responseJson = 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"
+    ];
+    if (responseJson.partialFailureError) {
+      logMessage(1, responseJson.partialFailureError.message);
+      if (!knownErrors.includes(responseJson.partialFailureError.message)) {
+        throw new Error(responseJson.partialFailureError.message);
+      }
+    } else if (responseJson.error) {
+      throw new Error(responseJson.error.message);
+    } else {
+      logEvent(this.source, event.event, event.region);
+    }
+  }
+};
+
 // src/publishers/googleAnalytics4.ts
 var googleAnalytics4 = {
   source: "GoogleAnalytics4",
@@ -648,6 +734,8 @@ var publisher = {
   // eslint-disable-next-line @typescript-eslint/naming-convention
   CJ: cj,
   // eslint-disable-next-line @typescript-eslint/naming-convention
+  GoogleAds: googleAds,
+  // eslint-disable-next-line @typescript-eslint/naming-convention
   GoogleAnalytics4: googleAnalytics4,
   // eslint-disable-next-line @typescript-eslint/naming-convention
   UniversalAnalytics: universalAnalytics,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mhubcloud/tms_core",
-  "version": "3.3.0-beta.2",
+  "version": "3.3.0-beta.3",
   "description": "Core function for mHub Cloud TMS publishers",
   "homepage": "https://mhubcloud.com/",
   "license": "Apache 2.0",
@@ -40,6 +40,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 node18"
+    "build": "tsup ./src/index.ts --format cjs --target node20"
   }
 }

package/publishers/TableStorage.js

@@ -4,8 +4,8 @@ const SOURCE = "f_TableStorage";
 
 module.exports = {
     /**
-     * Processed data comming from EventHub to data for further processing
-     * @param {Object} data The data comming from EventHub
+     * Processed data coming from EventHub to data for further processing
+     * @param {Object} data The data coming from EventHub
      * @returns {Object} Data for further processing
      */
     parse: function parse(data, context) {

package/src/defaultPublisher.ts

@@ -8,7 +8,7 @@ import { TypeSafeObject } from './types/UtilTypes';
 import * as utils from './utils/utils';
 
 /**
- * Implements the Azure Function, called for set of events received via Event Hub
+ * Implements the Azure Function, called for set of events received via Service Bus
  * @deprecated Udelat novou metodu, ktera bude spravne a bude inicializovat classu
  * @param azureFunctionContext Azure Function Context
  * @param serviceBusMessage Message received from Service Bus
@@ -75,7 +75,6 @@ async function processMessage(
   const logProperties: Telemetry['properties'] = {
     source: platformPublisher.source,
     data: JSON.stringify(message),
-    sampling: process.env.Sampling,
   };
   const publishers = trigger(message, log);
   if (!publishers.length) {

package/src/index.ts

@@ -2,6 +2,7 @@ import { defaultPublisher } from './defaultPublisher';
 import { affiliatePort } from './publishers/affiliatePort';
 import { cj } from './publishers/cj';
 import { facebook } from './publishers/facebook';
+import { googleAds } from './publishers/googleAds';
 import { googleAnalytics4 } from './publishers/googleAnalytics4';
 import { piano } from './publishers/piano';
 import { universalAnalytics } from './publishers/universalAnalytics';
@@ -14,6 +15,8 @@ export const publisher = {
   // eslint-disable-next-line @typescript-eslint/naming-convention
   CJ: cj,
   // eslint-disable-next-line @typescript-eslint/naming-convention
+  GoogleAds: googleAds,
+  // eslint-disable-next-line @typescript-eslint/naming-convention
   GoogleAnalytics4: googleAnalytics4,
   // eslint-disable-next-line @typescript-eslint/naming-convention
   UniversalAnalytics: universalAnalytics,

package/src/publishers/googleAds.ts

@@ -0,0 +1,96 @@
+import * as utils from './../utils/utils';
+import {
+  PlatformPublisher,
+  PlatformRequestOptions,
+} from '../types/PlatformPublisher';
+import {
+  fetchGoogleAdsToken,
+  GoogleAdsConfig,
+} from '../utils/tokens/googleAdsToken';
+
+interface GoogleAdsData {
+  gclid?: string;
+  wbraid?: string;
+  gbraid?: string;
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  user_identifiers: Record<string, unknown>[];
+  conversionAction?: string;
+  [x: string]: unknown;
+}
+
+export const googleAds: PlatformPublisher = {
+  source: 'GoogleAds',
+  /**
+   *Publishes data to Google Ads
+   * @param log Azure Function context.log
+   * @param config Publisher configuration
+   * @param data Data in publisher-friendly format to be published
+   * @param event Event for which the function is triggered
+   */
+  async publish(log, config, data, event) {
+    if (
+      !(data as GoogleAdsData).gclid &&
+      !(data as GoogleAdsData).wbraid &&
+      !(data as GoogleAdsData).gbraid &&
+      !(data as GoogleAdsData).user_identifiers
+    ) {
+      utils.logMessage(1, `Excluded ${event.event} due to lack of identifiers`);
+      return;
+    }
+
+    const tokenData = await fetchGoogleAdsToken(config);
+
+    data.conversionAction = `customers/${config.customerId}/conversionActions/${config.conversionId}`;
+
+    const body = {
+      conversions: [data],
+      partialFailure: true,
+      validateOnly: false,
+      debugEnabled: false,
+    };
+
+    const requestOptions = {
+      method: 'POST',
+      headers: {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        Authorization: `Bearer ${tokenData.token}`,
+        'developer-token': config.client.developerToken,
+      },
+      body: JSON.stringify(body),
+    };
+
+    const baseUrl = `https://googleads.googleapis.com/v17/customers/${config.customerId}:uploadClickConversions`;
+
+    const response = await fetch(baseUrl, requestOptions);
+    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",
+    ];
+
+    if (responseJson.partialFailureError) {
+      utils.logMessage(1, responseJson.partialFailureError.message);
+      if (!knownErrors.includes(responseJson.partialFailureError.message)) {
+        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);
+    }
+  },
+};
+
+interface GoogleAdsResponse {
+  partialFailureError?: {
+    message: string;
+  };
+  error?: {
+    message: string;
+  };
+}

package/src/utils/tokens/googleAdsToken.ts

@@ -0,0 +1,66 @@
+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;
+}

package/src/utils/utils.ts

@@ -16,8 +16,6 @@ if (
   process.env.APPLICATIONINSIGHTS_CONNECTION_STRING ||
   process.env.APPINSIGHTS_INSTRUMENTATIONKEY
 ) {
-  const samplingLevel = process.env.SamplingLevel ?? '12.5';
-
   appInsights
     .setup() // Set environment variable APPLICATIONINSIGHTS_CONNECTION_STRING, so setup() can be called w/o parameters
     .setAutoCollectDependencies(false)
@@ -25,10 +23,8 @@ if (
     .setSendLiveMetrics(false)
     .setAutoCollectRequests(false)
     .setAutoCollectPerformance(false)
-    .setUseDiskRetryCaching(false);
-  appInsights.defaultClient.config.samplingPercentage =
-    parseFloat(samplingLevel);
-  appInsights.start();
+    .setUseDiskRetryCaching(false)
+    .start();
   aiClient = appInsights.defaultClient;
 }
 
@@ -82,10 +78,9 @@ export function logEvent(
   region: string,
 ): void {
   const properties: Telemetry['properties'] = {
-    publisher,
-    event,
-    region,
-    sampling: process.env.SamplingLevel,
+    publisher: publisher,
+    event: event,
+    region: region,
   };
   logMessage(1, 'Event dispatched to platform', properties);
 }
@@ -343,7 +338,9 @@ export async function handlePlatformRequest({
       rawPlatformResponse,
       event.event,
     );
+
     logEvent(source, event.event, event.region);
+
     return processedPlatformResponse;
   } else {
     logEvent(source, event.event, event.region);

package/tests/AffiliatePort.js

@@ -109,7 +109,7 @@ class AffiliatePortPurchasePublisher extends utils.EventPublisherBase {
   /**
    * Maps `purchase` event data to AffiliatePort payload
    * @param {Object} data `purchase` event data
-   * @returns {Object} Data mapped from incomming Event Hub message to platform payload
+   * @returns {Object} Data mapped from incoming Service Bus message to platform payload
    */
   map(data) {
     return {

package/tests/CJ.js

@@ -131,7 +131,7 @@ class CJPurchasePublisher extends utils.EventPublisherBase {
   /**
    * Converts input data to publishing payload data understood by the publisher
    * @param {Object} data `purchase` event data
-   * @returns {Object} Data mapped from incomming Event Hub message to platform payload
+   * @returns {Object} Data mapped from incoming Service Bus message to platform payload
    */
   map(data, log) {
     const ret = {

package/tests/Facebook.js

@@ -86,7 +86,7 @@ class FBPurchasePublisher extends utils.EventPublisherBase {
   /**
    * Maps `purchase` event data to Facebook payload
    * @param {Object} data `purchase` event data
-   * @returns {Object} Data mapped from incomming Event Hub message to platform payload
+   * @returns {Object} Data mapped from incoming Service Bus message to platform payload
    */
   map(data) {
     return {

package/tests/GoogleAds.js

@@ -0,0 +1,127 @@
+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 () {
+    const serviceBusMessage = {
+      currencyCode: 'CZK',
+      event: {
+        region: 'MAIN',
+        id: '115169112-4870.1657003407533',
+        code: 'purchase',
+      },
+      session: {
+        userAgent:
+          'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36',
+        ip: '89.177.126.237',
+        referrer: 'https://crossmasters.com/',
+      },
+      referrer: 'https://crossmasters.com/',
+      permissions: [],
+      identity: {
+        piano: {
+          id: '1657003393413.319297501',
+        },
+      },
+      publisher: {
+        code: 'mhubcloud.com',
+        tm: 'GTM-N7K9L4X',
+        tmv: '494',
+      },
+      $schema: '/mhub/purchase',
+      id: '20162351',
+      revenue: 440,
+      products: [
+        {
+          id: 'Car',
+          price: 440,
+          quantity: 1,
+        },
+      ],
+      enqueuedAt: 1657003409370,
+      ads: [
+        {
+          adPlatform: 'googleads',
+          adCodes: {
+            gclid: 'mhubcloud',
+          },
+          visitAt: 1727173492000,
+        },
+      ],
+    };
+    await test(serviceBusMessage);
+  });
+});
+
+/**
+ * Test function
+ * @param [object] object obsahující nastavení testovací parametry
+ */
+async function test(serviceBusMessage) {
+  await defaultPublisher(
+    testUtils.context,
+    serviceBusMessage,
+    'GoogleAds',
+    publisher,
+    trigger,
+  );
+}
+
+function trigger(data) {
+  const publishers = [];
+  let publisher;
+
+  // Dummy config, replace with your own
+  const config = {
+    client: {
+      id: process.env.Publisher_GoogleAds_ClientID,
+      secret: process.env.Publisher_GoogleAds_ClientSecret,
+      developerToken: process.env.Publisher_GoogleAds_DeveloperToken,
+    },
+    refreshToken:
+      // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
+      process.env['Publisher_GoogleAds_RefreshToken_' + data.event.region],
+    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,
+  };
+
+  switch (data.event?.code) {
+    case 'purchase':
+      publisher = new GoogleAdsPurchasePublisher(config);
+      publishers.push(publisher);
+      break;
+  }
+  return publishers;
+}
+
+class GoogleAdsPurchasePublisher extends utils.EventPublisherBase {
+  /**
+   * Maps `purchase` event data to GoogleAds payload
+   * @param {Object} data `purchase` event data
+   * @returns {Object} Data mapped from incoming Service Bus message to platform payload
+   */
+  map(data) {
+    const dateTime = new Date(data.enqueuedAt);
+    const dateString =
+      dateTime.toISOString().replace('T', ' ').split('.')[0] + '+00:00';
+    const gclid = utils.extractAdCode(data, 'googleads', 'gclid')?.code;
+    const wbraid = utils.extractAdCode(data, 'googleads', 'wbraid')?.code;
+    const gbraid = utils.extractAdCode(data, 'googleads', 'gbraid')?.code;
+
+    return {
+      gclid: gclid,
+      wbraid: gclid || gbraid ? undefined : wbraid,
+      gbraid: gclid || wbraid ? undefined : gbraid,
+      orderId: data.event.id,
+      conversionDateTime: dateString,
+      currencyCode: data.currencyCode, // e.g. EUR
+      conversionValue: data.value ? data.value : 0.01, // e.g. 142.52
+    };
+  }
+}

package/tests/Piano.js

@@ -80,7 +80,7 @@ class PianoPurchasePublisher extends utils.EventPublisherBase {
   /**
    * Converts input data to publishing payload data understood by the publisher
    * @param {Object} data `purchase` event data
-   * @returns {Object} Data mapped from incomming Event Hub message to platform payload
+   * @returns {Object} Data mapped from incoming Service Bus message to platform payload
    */
   map(data) {
     return {