wingbot 3.46.0-alpha.1 → 3.46.0-alpha.3

package/package.json

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

package/src/analytics/consts.js

@@ -42,6 +42,10 @@ const TrackingType = { // max length 12
  * @enum {string} TrackingCategory
  */
 const TrackingCategory = { // max length 3
+    // PAGE_VIEW: 'page_view'
+    PAGE_VIEW_FIRST: 'pf',
+    PAGE_VIEW_SUBSEQUENT: 'pp',
+
     // CONVERSATION_EVENT: 'conversation'
     STICKER: 'sti',
     IMAGE: 'img',
@@ -70,6 +74,10 @@ const TrackingCategory = { // max length 3
  * @type {Object<TrackingCategory,string>}
  */
 const CATEGORY_LABELS = {
+    // PAGE_VIEW: 'page_view'
+    [TrackingCategory.PAGE_VIEW_FIRST]: 'Bot: Interaction',
+    [TrackingCategory.PAGE_VIEW_SUBSEQUENT]: 'Bot: Sub-interaction',
+
     // CONVERSATION_EVENT: 'conversation'
     [TrackingCategory.STICKER]: 'User: Sticker',
     [TrackingCategory.IMAGE]: 'User: Image',

package/src/analytics/onInteractionHandler.js

@@ -31,6 +31,46 @@ const {
  * @prop {string} [action]
  * @prop {string} [label]
  * @prop {number} [value]
+ * @prop {string} [lang]
+ */
+
+/**
+ * @typedef {object} ConversationEventExtension
+ * @prop {string} [skill]
+ * @prop {string} [text]
+ * @prop {string} [expected]
+ * @prop {boolean} expectedTaken
+ * @prop {boolean} isContextUpdate
+ * @prop {boolean} isAttachment
+ * @prop {boolean} isNotification
+ * @prop {boolean} isQuickReply
+ * @prop {boolean} isPassThread
+ * @prop {boolean} isPostback
+ * @prop {boolean} isText
+ * @prop {boolean} didHandover
+ * @prop {boolean} withUser
+ * @prop {string} [userId]
+ * @prop {number} [feedback]
+ * @prop {number} sessionStart
+ * @prop {number} sessionDuration
+ * @prop {string} [winnerAction]
+ * @prop {string} [winnerIntent]
+ * @prop {string[]|string} [winnerEntities]
+ * @prop {number} [winnerScore]
+ * @prop {boolean} [winnerTaken]
+ * @prop {string} [intent]
+ * @prop {number} [intentScore]
+ * @prop {string[]|string} [entities]
+ * @prop {string[]|string} allActions
+ * @prop {boolean} nonInteractive
+ * @prop {string} [snapshot]
+ * @prop {string} [botId]
+ *
+ * @typedef {Event & ConversationEventExtension} ConversationEvent
+ */
+
+/**
+ * @typedef {ConversationEvent | Event} TrackingEvent
  */
 
 /**
@@ -59,7 +99,7 @@ const {
  * @param {string} pageId
  * @param {string} senderId
  * @param {string} sessionId
- * @param {Event[]} events
+ * @param {TrackingEvent[]} events
  * @param {GAUser} [user]
  * @param {number} [ts]
  * @param {boolean} [nonInteractive]
@@ -82,6 +122,7 @@ const {
  * @prop {boolean} [supportsArrays]
  * @prop {boolean} [useDescriptiveCategories]
  * @prop {boolean} [useExtendedScalars]
+ * @prop {boolean} [parallelSessionInsert]
  */
 
 /**
@@ -98,7 +139,7 @@ const {
 
 /**
  * @typedef {object} TrackingEvents
- * @prop {Event[]} events
+ * @prop {TrackingEvent[]} events
  */
 
 /**
@@ -160,7 +201,8 @@ function onInteractionHandler (
         supportsArrays = false,
         useExtendedScalars = false,
         hasExtendedEvents = false,
-        useDescriptiveCategories = true
+        useDescriptiveCategories = true,
+        parallelSessionInsert = false
     } = analyticsStorage;
 
     const asArray = (data = []) => (supportsArrays ? data : data.join(','));
@@ -203,6 +245,7 @@ function onInteractionHandler (
 
             const [action = noneAction, ...otherActions] = actions;
 
+            let sessionPromise;
             if (createSession) {
                 const metadata = {
                     sessionCount,
@@ -212,7 +255,7 @@ function onInteractionHandler (
                     botId
                 };
 
-                await analyticsStorage.createUserSession(
+                sessionPromise = analyticsStorage.createUserSession(
                     pageId,
                     senderId,
                     sessionId,
@@ -221,6 +264,11 @@ function onInteractionHandler (
                     nonInteractive,
                     timeZone
                 );
+
+                if (!parallelSessionInsert) {
+                    await sessionPromise;
+                    sessionPromise = null;
+                }
             }
 
             const [{
@@ -313,6 +361,7 @@ function onInteractionHandler (
 
             trackEvents.push({
                 type: TrackingType.PAGE_VIEW,
+                category: asCategory(TrackingCategory.PAGE_VIEW_FIRST),
                 action,
                 allActions,
                 nonInteractive,
@@ -330,6 +379,7 @@ function onInteractionHandler (
                 ...otherActions.map((a) => {
                     const r = {
                         type: TrackingType.PAGE_VIEW,
+                        category: asCategory(TrackingCategory.PAGE_VIEW_SUBSEQUENT),
                         action: a,
                         allActions,
                         nonInteractive: false,
@@ -408,7 +458,7 @@ function onInteractionHandler (
                     actionCategory = TrackingCategory.REFERRAL;
                 } else if (isPostback) {
                     actionCategory = TrackingCategory.POSTBACK_BUTTON;
-                    label = req.data.postback.title || '(unknown)';
+                    label = req.event.postback.title || '(unknown)';
                 } else {
                     actionCategory = TrackingCategory.OTHER;
                 }
@@ -426,18 +476,21 @@ function onInteractionHandler (
                 });
             }
 
-            await analyticsStorage.storeEvents(
-                pageId,
-                senderId,
-                sessionId,
-                // @ts-ignore
-                trackEvents,
-                user,
-                timestamp,
-                nonInteractive,
-                createSession,
-                timeZone
-            );
+            await Promise.all([
+                analyticsStorage.storeEvents(
+                    pageId,
+                    senderId,
+                    sessionId,
+                    // @ts-ignore
+                    trackEvents,
+                    user,
+                    timestamp,
+                    nonInteractive,
+                    createSession,
+                    timeZone
+                ),
+                sessionPromise
+            ]);
         } catch (e) {
             if (throwException) {
                 throw e;