wingbot 3.60.0 → 3.61.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.60.0",
+  "version": "3.61.1",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "scripts": {
@@ -9,7 +9,7 @@
     "doc": "npm run doc:gql && node ./bin/makeApiDoc.js && cpy ./CHANGELOG.md ./doc && gitbook install ./doc && gitbook build ./doc && rimraf -rf ./docs && rimraf --rf ./doc/CHANGELOG.md && move-cli ./doc/_book ./docs",
     "test": "npm run test:lint && npm run test:coverage && npm run test:coverage:threshold",
     "test:coverage": "nyc --reporter=html mocha ./test && nyc report",
-    "test:coverage:threshold": "nyc check-coverage --lines 90 --functions 89 --branches 80",
+    "test:coverage:threshold": "nyc check-coverage --lines 89 --functions 89 --branches 80",
     "test:backend": "mocha ./test",
     "test:lint": "eslint --ext .js src test *.js plugins"
   },

package/plugins/ai.wingbot.trackingEvent/plugin.js

@@ -1,10 +1,62 @@
+const { default: fetch } = require('node-fetch');
 const { compileWithState } = require('../../src/utils');
 
+function transformEvent (c, a, l, v, req, res) {
+    switch (c) {
+        case 'generate_lead':
+            return {
+                name: 'generate_lead',
+                params: {
+                    currency: l || 'USD',
+                    value: v
+                }
+            };
+        case 'view_item':
+            return {
+                name: 'view_item',
+                params: {
+                    currency: l || 'USD',
+                    value: v,
+                    items: [
+                        {
+                            item_name: res.currentAction(),
+                            item_category: a || ''
+                        }
+                    ]
+                }
+            };
+        case 'purchase':
+            return {
+                name: 'purchase',
+                params: {
+                    currency: l || 'USD',
+                    transaction_id: `${req.pageId}.${req.senderId}.${req.timestamp}`,
+                    value: v,
+                    items: [
+                        {
+                            item_name: res.currentAction(),
+                            item_category: a || ''
+                        }
+                    ]
+                }
+            };
+        case 'tutorial_begin':
+        case 'tutorial_complete':
+        case 'sign_up':
+        case 'share':
+            return {
+                name: c
+            };
+        default:
+            return null;
+    }
+}
+
 /**
  * @param {import('../../src/Request')} req
  * @param {import('../../src/Responder')} res
  */
-function trackingEvent (req, res) {
+async function trackingEvent (req, res) {
     const {
         category = '',
         action = '',
@@ -13,12 +65,53 @@ function trackingEvent (req, res) {
         type
     } = req.params;
 
-    const c = compileWithState(req, res, category);
-    const a = compileWithState(req, res, action);
-    const l = compileWithState(req, res, label);
+    const c = compileWithState(req, res, category).trim();
+    const a = compileWithState(req, res, action).trim();
+    const l = compileWithState(req, res, label).trim();
     const v = parseFloat(compileWithState(req, res, value)
         .replace(/[^0-9.]+/, '')) || 0;
 
+    const {
+        '§gi': clientId,
+        '§gc': gclid
+    } = req.state;
+
+    const {
+        gaMeasurementId,
+        gaApiSecret
+    } = req.configuration;
+
+    if (clientId && gaMeasurementId && gaApiSecret) {
+
+        const ev = transformEvent(c, a, l, v, req, res);
+
+        const body = {
+            client_id: clientId,
+            timestamp_micros: req.timestamp * 1000,
+            non_personalized_ads: false,
+            ...(a ? {
+                user_properties: {
+                    [a]: {
+                        value: v || 1
+                    }
+                }
+            } : {}),
+            events: ev ? [ev] : []
+        };
+
+        const params = {
+            method: 'POST',
+            body: JSON.stringify(body)
+        };
+
+        try {
+            await fetch(`https://www.google-analytics.com/mp/collect?api_secret=${encodeURIComponent(gaApiSecret)}&measurement_id=${encodeURIComponent(gaMeasurementId)}`, params);
+        } catch (e) {
+            // eslint-disable-next-line no-console
+            console.error('GA FAILED', e, body);
+        }
+    }
+
     res.trackEvent(type || 'report', c, a, l, v);
 }
 

package/plugins/plugins.json

@@ -162,17 +162,17 @@
                 {
                     "name": "category",
                     "type": "text",
-                    "label": "Event category"
+                    "label": "Event category (generate_lead,view_item,purchase,tutorial_begin,tutorial_complete,sign_up,share)"
                 },
                 {
                     "name": "action",
                     "type": "text",
-                    "label": "Event action"
+                    "label": "Event action (item category)"
                 },
                 {
                     "name": "label",
                     "type": "text",
-                    "label": "Event label"
+                    "label": "Event label (currency)"
                 },
                 {
                     "name": "value",

package/src/analytics/onInteractionHandler.js

@@ -109,6 +109,12 @@ const {
  * @prop {string} [osName]
  * @prop {string} [skill]
  * @prop {string} [prevSkill]
+ * @prop {string|null} cs
+ * @prop {string|null} cm
+ * @prop {string|null} cn
+ * @prop {string|null} ck
+ * @prop {string|null} cc
+ * @prop {string|null} dr
  */
 
 /**
@@ -333,6 +339,15 @@ function onInteractionHandler (
             const useSkill = (skill && webalize(skill)) || noneAction;
             const usePrevSkill = (prevSkill && webalize(prevSkill)) || noneAction;
 
+            const {
+                '§cs': cs = null,
+                '§cm': cm = null,
+                '§cn': cn = null,
+                '§ck': ck = null,
+                '§cc': cc = null,
+                '§dr': dr = null
+            } = req.state;
+
             const metadata = {
                 sessionCount,
                 lang,
@@ -351,7 +366,16 @@ function onInteractionHandler (
                 deviceType: ua.device.type || null,
                 osName: ua.os.name || null,
                 skill: useSkill,
-                prevSkill: usePrevSkill
+                prevSkill: usePrevSkill,
+
+                cs,
+                cm,
+                cn,
+                ck,
+                cc,
+                dr: dr
+                    ? `${dr}`.toLowerCase().replace(/^[a-z0-9]:\/\//, '').replace(/(?<=\.[a-z]+)\/.*$/, '')
+                    : null
             };
 
             let sessionPromise;