wingbot 3.46.3 → 3.47.0

package/package.json

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

package/src/ConversationTester.js

@@ -35,6 +35,7 @@ const DEFAULT_TEXT_THRESHOLD = 0.8;
  * @prop {string} text
  * @prop {string} action
  * @prop {string} intent
+ * @prop {number} [rowNum]
  */
 
 /**
@@ -562,10 +563,37 @@ class ConversationTester {
             score: 0, intent: { intent: '-', score: 0 }, aboveConfidence: false, meta: null, action: null
         }] = actions;
 
-        const report = (error = '', ok = false) => ({
-            ok,
-            o: `${textCase.text.padEnd(longestText, ' ')}\t${(winner.intent ? winner.intent.score : 0).toFixed(2)}\t${winner.intent ? winner.intent.intent : '-'} | ${error}`
-        });
+        // textCase.rowNum?
+
+        const report = (error, ok = false) => {
+            let o = [
+                textCase.text.padEnd(longestText, ' '),
+                (winner.intent ? winner.intent.score : 0).toFixed(2),
+                winner.intent ? winner.intent.intent : '-'
+            ].join('\t');
+
+            if (ok || !error) {
+                if (error) {
+                    o += ` | ${error}`;
+                }
+                return { ok, o };
+            }
+
+            let err = error;
+
+            const prefix = typeof textCase.rowNum === 'number'
+                ? `  > FAILED on row ${textCase.rowNum}: `.padEnd(23, ' ')
+                : '  > FAILED: ';
+
+            if (Array.isArray(err)) {
+                const pad = ''.padEnd(prefix.length, ' ');
+                err = err.join(`\n${pad}`);
+            }
+
+            o += `\n${prefix}${err}`;
+
+            return { ok, o };
+        };
 
         if (actions.length === 0) {
             return report('no NLP result');
@@ -576,25 +604,40 @@ class ConversationTester {
         }
 
         if (textCase.intent && winner.intent.intent !== textCase.intent) {
-            return report(`expected intent "${textCase.intent}"`);
+            return report([
+                'intent mismatch',
+                `✓ expected: ${textCase.intent}`,
+                `✗ actual:   ${winner.intent.intent || '-'}`
+            ]);
         }
 
         if (textCase.appId) {
-
             if (!winner.meta || `${winner.meta.targetAppId}` !== `${textCase.appId}`) {
-                return report(`expected handover to "${textCase.appId}" - actual "${(winner.meta && winner.meta.targetAppId) || `action: ${winner.action || '*'}`}"`);
+                return report([
+                    'target appId mismatch',
+                    `✓ expected: ${textCase.appId}`,
+                    `✗ actual:   ${(winner.meta && winner.meta.targetAppId) || `action[ ${winner.action || '*'} ]`}`
+                ]);
             }
 
             if (textCase.action && !actionMatches(`${winner.meta.targetAction}`, `${textCase.action}`)) {
-                return report(`expected action "${textCase.action}" - actual "${winner.meta.targetAction || '-'}"`);
+                return report([
+                    'target action mismatch',
+                    `✓ expected: ${textCase.action}`,
+                    `✗ actual:   ${winner.meta.targetAction || '-'}`
+                ]);
             }
 
         } else if (textCase.action && !actionMatches(`${winner.action}`, `${textCase.action}`)) {
-            return report(`expected action "${textCase.action}" - actual "${winner.action || '-'}"`);
+            return report([
+                'action mismatch',
+                `✓ expected: ${textCase.action}`,
+                `✗ actual:   ${winner.action || '-'}`
+            ]);
         }
 
         if (!textCase.action && !textCase.appId && !textCase.intent) {
-            return report(`${textCase.action}`, true);
+            return report(winner.action, true);
         }
 
         return { ok: true, o: null };

package/src/Processor.js

@@ -63,6 +63,7 @@ const { mergeState, isUserInteraction } = require('./utils/stateVariables');
  * @prop {ResponseFlag|null} flag
  * @prop {boolean} nonInteractive
  * @prop {string[]} responseTexts
+ * @prop {boolean} doNotTrack
  */
 
 /**
@@ -421,12 +422,7 @@ class Processor extends EventEmitter {
      * @returns {Promise}
      */
     _emitInteractionEvent (req, res, messageSender, state, data) {
-        const shouldNotTrack = data._initialEventShouldNotBeTracked === true;
-
-        if (shouldNotTrack) {
-            return Promise.resolve();
-        }
-
+        const doNotTrack = data._initialEventShouldNotBeTracked === true;
         const { _lastAction: lastAction = null } = req.state;
         const actions = messageSender.visitedInteractions;
         const skill = typeof res.newState._trackAsSkill === 'undefined'
@@ -435,6 +431,7 @@ class Processor extends EventEmitter {
         const { events = [] } = messageSender.tracking;
 
         const event = {
+            doNotTrack,
             responseTexts: messageSender.responseTexts,
             req,
             actions,
@@ -445,7 +442,7 @@ class Processor extends EventEmitter {
             tracking: messageSender.tracking,
             events,
             flag: res.senderMeta.flag,
-            nonInteractive: !isUserInteraction(req)
+            nonInteractive: !isUserInteraction(req) || doNotTrack
         };
 
         return Promise.allSettled([
@@ -610,10 +607,10 @@ class Processor extends EventEmitter {
 
                 const interactive = isUserInteraction(req);
 
-                if ((isUserInteraction(req)
-                    && (sessionTs + this.options.sessionDuration) < Date.now())
-                        || !sessionId) {
+                const sessionExpired = interactive
+                    && (sessionTs + this.options.sessionDuration) < Date.now();
 
+                if (sessionExpired || !sessionId) {
                     sessionStart = timestamp;
                     sessionTs = timestamp;
                     sessionId = Processor._createSessionId(req.pageId, req.senderId, timestamp);

package/src/analytics/onInteractionHandler.js

@@ -239,7 +239,8 @@ function onInteractionHandler (
         events,
         flag,
         nonInteractive,
-        responseTexts
+        responseTexts,
+        doNotTrack = false
     }) {
         if (!enabled) {
             return;
@@ -321,7 +322,7 @@ function onInteractionHandler (
                 score = 0
             } = {}] = req.intents;
 
-            const text = req.isConfidentInput()
+            const text = req.isConfidentInput() || doNotTrack
                 ? '*****'
                 : anonymize(
                     replaceDiacritics(req.text()).replace(/\s+/g, ' ').toLowerCase().trim()
@@ -396,47 +397,49 @@ function onInteractionHandler (
             const notHandled = actions.some((a) => a.match(/\*$/)) && !req.isQuickReply();
             const value = notHandled ? 1 : 0;
 
-            trackEvents.push({
-                type: TrackingType.PAGE_VIEW,
-                category: asCategory(TrackingCategory.PAGE_VIEW_FIRST),
-                action,
-                label: (isText || isQuickReply ? text : null),
-                value,
-                allActions,
-                nonInteractive,
-                lastAction,
-                // @ts-ignore
-                prevAction: lastAction,
-                skill: useSkill,
-                isGoto: false,
-                withUser,
-                ...langsExtension,
-                ...(hasExtendedEvents ? {} : actionMeta)
-            });
-
-            let prevAction = action;
-
-            trackEvents.push(
-                ...otherActions.map((a) => {
-                    const r = {
-                        type: TrackingType.PAGE_VIEW,
-                        category: asCategory(TrackingCategory.PAGE_VIEW_SUBSEQUENT),
-                        action: a,
-                        value: 0,
-                        allActions,
-                        nonInteractive: false,
-                        lastAction,
-                        prevAction,
-                        skill: useSkill,
-                        isGoto: true,
-                        withUser,
-                        ...langsExtension
-                    };
+            if (!doNotTrack) {
+                trackEvents.push({
+                    type: TrackingType.PAGE_VIEW,
+                    category: asCategory(TrackingCategory.PAGE_VIEW_FIRST),
+                    action,
+                    label: (isText || isQuickReply ? text : null),
+                    value,
+                    allActions,
+                    nonInteractive,
+                    lastAction,
+                    // @ts-ignore
+                    prevAction: lastAction,
+                    skill: useSkill,
+                    isGoto: false,
+                    withUser,
+                    ...langsExtension,
+                    ...(hasExtendedEvents ? {} : actionMeta)
+                });
 
-                    prevAction = a;
-                    return r;
-                })
-            );
+                let prevAction = action;
+
+                trackEvents.push(
+                    ...otherActions.map((a) => {
+                        const r = {
+                            type: TrackingType.PAGE_VIEW,
+                            category: asCategory(TrackingCategory.PAGE_VIEW_SUBSEQUENT),
+                            action: a,
+                            value: 0,
+                            allActions,
+                            nonInteractive: false,
+                            lastAction,
+                            prevAction,
+                            skill: useSkill,
+                            isGoto: true,
+                            withUser,
+                            ...langsExtension
+                        };
+
+                        prevAction = a;
+                        return r;
+                    })
+                );
+            }
 
             trackEvents.push(
                 ...events.map(({
@@ -453,7 +456,6 @@ function onInteractionHandler (
             );
 
             if (!nonInteractive) {
-
                 if (req.isText()) {
                     trackEvents.push({
                         type: TrackingType.TRAINING,