wingbot 3.46.0-alpha.5 → 3.46.0-alpha.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.46.0-alpha.5",
+  "version": "3.46.0-alpha.7",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "scripts": {

package/src/analytics/consts.js

@@ -62,12 +62,12 @@ const TrackingCategory = { // max length 3
 
     // TRAINING: 'train'
     INTENT_DETECTION: 'int',
-    HANDOVER_OCCURRED: 'hum',
     DISAMBIGUATION_SELECTED: 'dis',
     DISAMBIGUATION_OFFERED: 'dio',
 
     // REPORT: 'report'
-    REPORT_FEEDBACK: 'fdb'
+    REPORT_FEEDBACK: 'fdb',
+    HANDOVER_OCCURRED: 'hum'
 };
 
 /**
@@ -94,12 +94,12 @@ const CATEGORY_LABELS = {
 
     // TRAINING: 'train'
     [TrackingCategory.INTENT_DETECTION]: 'Intent: Detection',
-    [TrackingCategory.HANDOVER_OCCURRED]: 'Bot: Handover out',
     [TrackingCategory.DISAMBIGUATION_SELECTED]: 'Disambiguation: selected',
     [TrackingCategory.DISAMBIGUATION_OFFERED]: 'Disambiguation: offered',
 
     // REPORT: 'report'
-    [TrackingCategory.REPORT_FEEDBACK]: 'User: Feedback'
+    [TrackingCategory.REPORT_FEEDBACK]: 'User: Feedback',
+    [TrackingCategory.HANDOVER_OCCURRED]: 'Bot: Handover out'
 };
 
 module.exports = {

package/src/analytics/onInteractionHandler.js

@@ -37,6 +37,7 @@ const {
 
 /**
  * @typedef {object} ConversationEventExtension
+ * @prop {string} [lastAction]
  * @prop {string} [skill]
  * @prop {string} [text]
  * @prop {string} [expected]
@@ -70,7 +71,23 @@ const {
  */
 
 /**
- * @typedef {ConversationEvent | Event} TrackingEvent
+ * @typedef {object} PageViewEventExtension
+ * @prop {string} [lastAction]
+ * @prop {string} [prevAction]
+ * @prop {string} [skill]
+ * @prop {number} sessionDuration
+ * @prop {string[]|string} allActions
+ * @prop {boolean} nonInteractive
+ * @prop {boolean} isGoto
+ * @prop {boolean} withUser
+ * @prop {string} [snapshot]
+ * @prop {string} [botId]
+ *
+ * @typedef {Event & PageViewEventExtension} PageViewEvent
+ */
+
+/**
+ * @typedef {ConversationEvent | Event | PageViewEvent} TrackingEvent
  */
 
 /**
@@ -208,7 +225,7 @@ function onInteractionHandler (
     const asArray = (data = []) => (supportsArrays ? data : data.join(','));
     const asCategory = (cat) => (useDescriptiveCategories && CATEGORY_LABELS[cat]) || cat;
     const noneAction = useExtendedScalars ? null : '(none)';
-    const noneValue = useExtendedScalars ? -1 : 0;
+    const noneValue = useExtendedScalars ? null : 0;
 
     /**
      * @param {InteractionEvent} params
@@ -243,8 +260,31 @@ function onInteractionHandler (
                 lang
             } = req.state;
 
+            const trackEvents = [];
+
             const [action = noneAction, ...otherActions] = actions;
 
+            const feedbackEvent = events.find((e) => e.type === TrackingType.REPORT
+                && e.category === TrackingCategory.REPORT_FEEDBACK);
+            const feedback = feedbackEvent
+                ? feedbackEvent.value
+                : noneValue;
+            let didHandover = flag === ResponseFlag.HANDOVER;
+            const hasHandoverEvent = events
+                .some((e) => e.category === TrackingCategory.HANDOVER_OCCURRED);
+
+            if (didHandover && !hasHandoverEvent) {
+                trackEvents.push({
+                    type: TrackingType.REPORT,
+                    category: asCategory(TrackingCategory.HANDOVER_OCCURRED),
+                    action: null,
+                    label: null,
+                    value: noneValue
+                });
+            } else if (hasHandoverEvent) {
+                didHandover = true;
+            }
+
             let sessionPromise;
             if (createSession) {
                 const metadata = {
@@ -252,7 +292,9 @@ function onInteractionHandler (
                     lang,
                     action,
                     snapshot,
-                    botId
+                    botId,
+                    didHandover,
+                    feedback
                 };
 
                 sessionPromise = analyticsStorage.createUserSession(
@@ -281,6 +323,7 @@ function onInteractionHandler (
                 : anonymize(
                     replaceDiacritics(req.text()).replace(/\s+/g, ' ').toLowerCase().trim()
                 );
+            const useSkill = (skill && webalize(skill)) || noneAction;
 
             let winnerAction = '';
             let winnerScore = 0;
@@ -301,14 +344,6 @@ function onInteractionHandler (
             }
 
             const expected = req.expected() ? req.expected().action : '';
-
-            const feedbackEvent = events.find((e) => e.type === TrackingType.REPORT
-                && e.category === TrackingCategory.REPORT_FEEDBACK);
-            const feedback = feedbackEvent
-                ? feedbackEvent.value
-                : noneValue;
-            const didHandover = flag === ResponseFlag.HANDOVER;
-
             const user = userExtractor(req.state);
 
             const isContextUpdate = req.isSetContext();
@@ -322,12 +357,12 @@ function onInteractionHandler (
             const allActions = asArray(actions);
             const requestAction = req.action();
 
-            const trackEvents = [];
-
             const langsExtension = hasExtendedEvents
                 ? { lang }
                 : { cd1: lang };
 
+            const withUser = user !== null && !!user.id;
+
             const actionMeta = {
                 requestAction: req.action() || noneAction,
                 expected,
@@ -340,11 +375,11 @@ function onInteractionHandler (
                 isText,
                 isPostback,
                 didHandover,
-                withUser: user !== null && !!user.id,
+                withUser,
                 sessionStart,
                 sessionDuration: sessionTs - sessionStart,
                 feedback,
-                skill: (skill && webalize(skill)) || noneAction,
+                skill: useSkill,
                 snapshot,
                 botId,
                 winnerAction,
@@ -371,12 +406,16 @@ function onInteractionHandler (
                 allActions,
                 nonInteractive,
                 lastAction,
+                // @ts-ignore
                 prevAction: lastAction,
-                skill,
-                lang,
-                cd1: req.state.lang,
+                skill: useSkill,
                 isGoto: false,
                 sessionStart,
+                sessionDuration: timestamp - sessionStart,
+                withUser,
+                snapshot,
+                botId,
+                ...langsExtension,
                 ...(hasExtendedEvents ? {} : actionMeta)
             });
 
@@ -393,9 +432,12 @@ function onInteractionHandler (
                         nonInteractive: false,
                         lastAction,
                         prevAction,
-                        skill,
+                        skill: useSkill,
                         isGoto: true,
                         sessionStart,
+                        sessionDuration: timestamp - sessionStart,
+                        snapshot,
+                        botId,
                         ...langsExtension
                     };
 
@@ -410,7 +452,7 @@ function onInteractionHandler (
                 }) => ({
                     lastAction,
                     type,
-                    category,
+                    category: asCategory(category),
                     action: eventAction,
                     label,
                     value: eVal,
@@ -474,7 +516,6 @@ function onInteractionHandler (
                 trackEvents.push({
                     ...(analyticsStorage.hasExtendedEvents ? actionMeta : {}),
                     type: TrackingType.CONVERSATION_EVENT,
-                    // @ts-ignore
                     lastAction,
                     category: asCategory(actionCategory),
                     action,