@mhubcloud/tms_core 1.4.0 → 1.5.0

package/index.js

@@ -1,6 +1,6 @@
-const utils = require('lib/utils');
-const DefaultPublisher = require('lib/DefaultPublisher');
-const  Piano = require('publishers/Piano');
+const utils = require('./lib/utils');
+const DefaultPublisher = require('./lib/DefaultPublisher');
+const  Piano = require('./publishers/Piano');
 
 module.exports = {
     utils : utils,

package/lib/defaultPublisher.js

@@ -12,7 +12,7 @@ const utils = require("./utils");
  */
 module.exports = async function DefaultPublisher(context, eventHubMessages, source, publisher, trigger) {
     context.log(`JavaScript eventhub trigger function called for message array [${eventHubMessages.length}]`);
-    global.console.log = context.log.warn;
+    global.console.log = context.log.warn || context.log;
 
     let ret = context.test ? [] : undefined;
     let mi = 0;

package/lib/utils.js

@@ -223,6 +223,10 @@ module.exports = {
     logException: function logException(exception) {
         console.log(exception);
         aiClient?.trackException({ exception: exception });
+        //raise exception if it is running under mocha test
+        if(typeof global.it === 'function'){
+            throw(exception);
+        }
     },
 
     /**

package/package.json

@@ -1,11 +1,11 @@
 {
     "name": "@mhubcloud/tms_core",
-    "version": "1.4.0",
+    "version": "1.5.0",
     "description": "Core function for mHub Cloud TMS publishers",
     "homepage": "https://mhubcloud.com/",
     "license": "Apache 2.0",
-    "email" : "info@crossmasters.com",
-    "author" : "Jan Brzobohatý",
+    "email": "info@crossmasters.com",
+    "author": "Jan Brzobohatý",
     "main": "index.js",
     "keywords": [
         "mHub Cloud",
@@ -15,9 +15,15 @@
         "server side measurement",
         "conversion API"
     ],
+    "scripts": {
+        "test": "mocha ./tests/*.js"
+    },
     "dependencies": {
         "ajv": "^8.8.2",
         "applicationinsights": "^2.2.0",
         "node-fetch": "^2.6.7"
-    }    
-}
+    },
+    "devDependencies": {
+        "mocha": "^10.0.0"
+    }
+}

package/publishers/Piano.js

@@ -1,4 +1,4 @@
-const utils = require("../utils");
+const utils = require("../lib/utils");
 const fetch = require('node-fetch');
 const SOURCE = "f_Piano";
 
@@ -15,7 +15,7 @@ module.exports = {
     },
 
     /**
-     * Publishes data to Facebook
+     * Publishes data to Piano
      * @param {{collectionDomain: string, siteId: string|number}} config Publisher configuration
      * @param {{pianoData: {events: {name: string, data: {[key: string]: any}}[]}, aux: {visitorId: string, ref: string, userAgent?: string, referer?: string, forwardedFor?: string}}} data Data in publisher-friendly format to be published
      * @returns {*} Data returned by platform, if possible JSON-deserialized (otherwise as string)

package/tests/PianoPublisher.js

@@ -0,0 +1,114 @@
+const publisher = require("../index.js").publisher.Piano;
+const defaultPublisher = require("../index.js").DefaultPublisher;
+const utils = require("../index.js").utils;
+var assert = require('assert');
+
+describe('test Piano publisher', function () {
+    it('purchase', async function () {
+        var eventHubMessages = [
+            {
+                "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": []
+              }
+        ];
+        await test(eventHubMessages);
+    });
+})
+
+/**
+ * Test function
+ * @param [object] object obsahující nastavení testovací parametry
+ */
+async function test(eventHubMessages) {
+    try{
+        await defaultPublisher(console, eventHubMessages, "Piano", publisher, trigger);
+    }catch(err){
+        assert.equal(err.toString(), "FetchError: request to https://xxxxx.xiti.com/?s=12345&idclient=1657003393413.319297501&ref=https://crossmasters.com/ failed, reason: getaddrinfo ENOTFOUND xxxxx.xiti.com");
+    }
+}
+
+function trigger(data) {
+    const publishers = [];
+    const config = {
+        collectionDomain: "xxxxx.xiti.com", //Secured collection domain
+        siteId: "12345" //site-id
+    }
+    
+    if (data.event.code === "purchase") {
+        const publisher = PianoPurchasePublisher;
+        publisher.register(publishers, config);
+    }
+    return publishers;
+};
+
+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
+     */
+    map(data) {
+        return {
+            pianoData: { //This willbe sent to Piano as payload
+                events: [
+                    {
+                        name: "purchase",
+                        data: {
+                            event_collection_platform: "api",
+                            event_collection_version: 2,
+                            event_time_ts: Math.floor(data.enqueuedAt / 1000), // convert to seconds
+                            event_id: data.id,
+                            event_source_url: data.location
+                            //https://developers.atinternet-solutions.com/piano-analytics-tagging-en/event-tagging-piano-analytics-en/events-pattern-en/#common-contextual-properties_9
+                            //Any properties can go here (name must be [a-z][a-z_0-9]+; prohibited names m_…, visit_…, events)
+                            //There are some specifically understood properties
+                            //Type of property if not obvious from JSON can be forcec by prefix: 's:' string, 'n:' integer, 'f:' float, 'd:' date, 'b:' boolean, 'a:s:' array of strings, 'a:n:' array of integers, 'a:f:' array of floats
+                            //or by suffix '_date', '_utc', '_ts' date in RFC 3339 format (YYYY-MM-DDTHH:mm:ssZ); '_timestamp' - timestamp in seconds
+                        }
+                    }
+                ]
+            },
+            aux: { //Additional data understood by Piano publisher and passed specificaly (in headers and query string)
+                visitorId: data.identity?.piano?.id, //Mandatory idclient=<visitor-id>
+                ref: data.referrer, //Mandatory ref=<previous-url>
+                //Optional:
+                userAgent: data.session?.userAgent,
+                referer: data.session?.referrer,
+                forwardedFor: data.session?.ip,
+            }
+        };
+    }
+};