wingbot 3.32.0-alpha.1 → 3.33.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.32.0-alpha.1",
+  "version": "3.33.0",
   "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 90 --branches 80",
+    "test:coverage:threshold": "nyc check-coverage --lines 91 --functions 90 --branches 82",
     "test:backend": "mocha ./test",
     "test:lint": "eslint --ext .js src test *.js plugins"
   },
@@ -57,14 +57,12 @@
     "graphql": "^15.8.0",
     "jsonwebtoken": "^8.5.1",
     "node-fetch": "^2.6.7",
-    "path-to-regexp": "^6.2.0",
+    "path-to-regexp": "^6.2.1",
     "uuid": "^8.3.2",
     "webalize": "^0.1.0"
   },
   "optionalDependencies": {
     "axios": "^0.21.1",
-    "handlebars": "^4.0.0",
-    "request": "^2.88.0",
-    "request-promise-native": "^1.0.7"
+    "handlebars": "^4.0.0"
   }
 }

package/src/BotApp.js

@@ -23,6 +23,7 @@ const DEFAULT_API_URL = 'https://orchestrator-api.wingbot.ai';
 
 /** @typedef {import('./CallbackAuditLog')} AuditLog */
 /** @typedef {import('./BotAppSender').TlsOptions} TlsOptions */
+/** @typedef {import('./ReturnSender').ReturnSenderOptions} ReturnSenderOptions */
 
 /**
  * @typedef {object} BotAppOptions
@@ -35,7 +36,7 @@ const DEFAULT_API_URL = 'https://orchestrator-api.wingbot.ai';
  * @prop {AuditLog} [auditLog]
  * @prop {TlsOptions} [tls]
  *
- * @typedef {ProcessorOptions & BotAppOptions} Options
+ * @typedef {ProcessorOptions & BotAppOptions & ReturnSenderOptions} Options
  */
 
 /**
@@ -66,9 +67,20 @@ class BotApp {
             preferSynchronousResponse = false,
             auditLog = null,
             tls = null,
+
+            textFilter,
+            logStandbyEvents,
+            confidentInputFilter,
+
             ...processorOptions
         } = options;
 
+        this._returnSenderOptions = {
+            textFilter,
+            logStandbyEvents,
+            confidentInputFilter
+        };
+
         this._secret = Promise.resolve(secret);
         this._fetch = fetch; // mock
         this._appId = appId;
@@ -197,16 +209,18 @@ class BotApp {
         sync = false,
         headers = {}
     ) {
-        const { mid = null } = message;
+        const setResponseToMid = message.response_to_mid || message.mid;
 
         if (sync || this._preferSynchronousResponse) {
-            const sender = new ReturnSender({}, senderId, message, this._senderLogger);
+            const options = this._returnSenderOptions;
+            const sender = new ReturnSender(options, senderId, message, this._senderLogger);
             sender.propagatesWaitEvent = true;
             const res = await this._processor.processMessage(message, pageId, sender, { appId });
             await this._processSenderResponses(sender, senderId, pageId, headers);
 
             return {
                 status: res.status,
+                // yes, it should be just mid
                 response_to_mid: message.mid,
                 messaging: sender.responses
                     .map((response) => {
@@ -216,8 +230,8 @@ class BotApp {
                         }
 
                         // attach response_to_mid
-                        if (typeof response.response_to_mid === 'undefined' && mid) {
-                            Object.assign(response, { response_to_mid: mid });
+                        if (typeof response.response_to_mid === 'undefined' && setResponseToMid) {
+                            Object.assign(response, { response_to_mid: setResponseToMid });
                         }
 
                         return response;
@@ -226,11 +240,12 @@ class BotApp {
         }
 
         const options = {
+            ...this._returnSenderOptions,
             apiUrl: this._apiUrl,
             pageId,
             appId,
             secret,
-            mid,
+            mid: setResponseToMid,
             fetch: this._fetch,
             tls: this._tls
         };

package/src/BuildRouter.js

@@ -159,7 +159,6 @@ class BuildRouter extends Router {
      * @param {ConfigStorage} [context.configStorage] - function, that translates links globally
      * @param {boolean} [context.allowForbiddenSnippetWords] - disable security rule
      * @param {RouteConfig[]} [context.routeConfigs] - list of disabled routes
-     * @param {object} [context.config] - context data
      * @param {object} [context.configuration]
      * @param {fetch} [fetchFn] - override a request function
      * @example
@@ -427,7 +426,8 @@ class BuildRouter extends Router {
             this._configTs = 0;
         }
         if (this._prebuiltGlobalIntents !== null) {
-            this.globalIntents = new Map(this._prebuiltGlobalIntents);
+            this.globalIntents.clear();
+            this._prebuiltGlobalIntents.forEach(([k, v]) => this.globalIntents.set(k, v));
         }
     }
 
@@ -449,7 +449,8 @@ class BuildRouter extends Router {
         if (this._prebuiltGlobalIntents === null) {
             this._prebuiltGlobalIntents = Array.from(this.globalIntents.entries());
         } else {
-            this.globalIntents = new Map(this._prebuiltGlobalIntents);
+            this.globalIntents.clear();
+            this._prebuiltGlobalIntents.forEach(([k, v]) => this.globalIntents.set(k, v));
         }
 
         if (this._prebuiltRoutesCount === null) {
@@ -754,15 +755,21 @@ class BuildRouter extends Router {
                 nextRouteIsSameResponder = nextRoute.respondsToRouteId === route.respondsToRouteId;
             }
 
+            const buildInfo = {
+                expectedToAddResolver: !!route.expectedPath,
+                attachedRouter: false
+            };
+
             const resolvers = [
                 ...this._buildRouteHead(route, nextRouteIsSameResponder),
-                ...this.buildResolvers(route.resolvers, route, route.expectedPath)
+                ...this.buildResolvers(route.resolvers, route, buildInfo)
             ];
 
             if (route.expectedPath) {
                 // attach expected before last message, if there is
                 resolvers.push(expected({
-                    path: route.expectedPath
+                    path: route.expectedPath,
+                    attachedRouter: buildInfo.attachedRouter
                 }, {
                     isLastIndex: true
                 }));
@@ -790,10 +797,10 @@ class BuildRouter extends Router {
      *
      * @param {Resolver[]} resolvers
      * @param {TransformedRoute} route
-     * @param {*} expectedToAddResolver
+     * @param {*} buildInfo
      * @returns {Middleware[]}
      */
-    buildResolvers (resolvers, route = DUMMY_ROUTE, expectedToAddResolver = false) {
+    buildResolvers (resolvers, route = DUMMY_ROUTE, buildInfo = {}) {
         const {
             path: ctxPath, isFallback, isResponder, expectedPath, id
         } = route;
@@ -812,7 +819,7 @@ class BuildRouter extends Router {
 
             const context = {
                 ...this._context,
-                isLastIndex: lastIndex === i && !expectedToAddResolver,
+                isLastIndex: lastIndex === i && !buildInfo.expectedToAddResolver,
                 isLastMessage: lastMessageIndex === i,
                 router: this,
                 linksMap: this._linksMap,
@@ -824,7 +831,8 @@ class BuildRouter extends Router {
                 configuration
             };
 
-            const resFn = this._resolverFactory(resolver, context);
+            const resFn = this._resolverFactory(resolver, context, buildInfo);
+
             // @ts-ignore
             resFn.configuration = configuration;
             return resFn;
@@ -835,9 +843,10 @@ class BuildRouter extends Router {
      *
      * @param {Resolver} resolver
      * @param {BotContext} context
+     * @param {*} buildInfo
      * @returns {Middleware}
      */
-    _resolverFactory (resolver, context) {
+    _resolverFactory (resolver, context, buildInfo) {
         const { type } = resolver;
 
         if (!this.resources.has(type)) {
@@ -848,9 +857,17 @@ class BuildRouter extends Router {
 
         const fn = factoryFn(resolver.params, context, this._plugins);
 
+        if (fn.reduce) {
+            Object.assign(buildInfo, { attachedRouter: true });
+        }
+
         if ([
             'botbuild.include',
-            'botbuild.path'
+            'botbuild.path',
+            'botbuild.customCode',
+            'botbuild.inlineCode',
+            'botbuild.plugin',
+            'botbuild.postback'
         ].includes(type)) {
             return fn;
         }

package/src/ConversationTester.js

@@ -524,7 +524,7 @@ class ConversationTester {
                 await tester.text(textCase.text);
 
                 if (textCase.action) {
-                    tester.passedAction(textCase.action);
+                    tester.passedAction(textCase.action, true);
                 }
 
                 if (textCase.appId) {
@@ -623,7 +623,7 @@ class ConversationTester {
             if (!this._options.disableAssertActions) {
                 passedAction.split('\n')
                     .map((a) => (a.trim().match(/^[a-z\-0-9/_]+$/) ? a : tokenize(a)))
-                    .forEach((a) => a && t.passedAction(a));
+                    .forEach((a) => a && t.passedAction(a, true));
             }
 
             const any = t.any();

package/src/Request.js

@@ -16,6 +16,7 @@ const {
     FEATURE_SSML,
     FEATURE_PHRASES,
     FEATURE_TEXT,
+    FEATURE_TRACKING,
     getDefaultFeatureList
 } = require('./features');
 
@@ -259,6 +260,11 @@ class Request {
          */
         this.FEATURE_TEXT = FEATURE_TEXT;
 
+        /**
+         * @constant {string} FEATURE_TRACKING channel supports tracking protocol
+         */
+        this.FEATURE_TRACKING = FEATURE_TRACKING;
+
         /** @type {object} */
         this.configuration = Object.freeze({});
     }
@@ -837,7 +843,9 @@ class Request {
      * });
      */
     expectedContext (justOnce = false, includeKeywords = false) {
-        const { _expected: expected, _expectedConfidentInput: confident } = this.state;
+        const ad = this.actionData();
+        const expected = ad._useExpected || this.state._expected;
+        const confident = this.state._expectedConfidentInput;
 
         const ret = {};
 
@@ -1770,4 +1778,9 @@ Request.FEATURE_PHRASES = FEATURE_PHRASES;
  */
 Request.FEATURE_TEXT = FEATURE_TEXT;
 
+/**
+ * @constant {string} FEATURE_TRACKING channel supports tracking protocol
+ */
+Request.FEATURE_TRACKING = FEATURE_TRACKING;
+
 module.exports = Request;

package/src/Responder.js

@@ -528,6 +528,8 @@ class Responder {
         if (prepend) Object.assign(prep, { _prepend: true });
         if (justToExisting) Object.assign(prep, { _justToExisting: true });
 
+        const useCa = this.currentAction();
+
         if (actionIsObject) {
             this._quickReplyCollector.push({
                 ...prep,
@@ -535,7 +537,8 @@ class Responder {
                 data: {
                     ...prep.data,
                     ...data
-                }
+                },
+                useCa
             });
         } else {
             this._quickReplyCollector.push({
@@ -543,6 +546,7 @@ class Responder {
                 action: this.toAbsoluteAction(action),
                 title,
                 data,
+                useCa,
                 ...prep
             });
         }

package/src/ReturnSender.js

@@ -4,7 +4,7 @@
 'use strict';
 
 const ai = require('./Ai');
-const { FEATURE_PHRASES } = require('./features');
+const { FEATURE_PHRASES, FEATURE_TRACKING } = require('./features');
 const { FLAG_DO_NOT_LOG } = require('./flags');
 
 /** @typedef {import('./Request')} Request */
@@ -70,8 +70,10 @@ class ReturnSender {
 
         this._sequence = 0;
 
-        this._sendLastMessageWithFinish = Array.isArray(incommingMessage.features)
-            && incommingMessage.features.includes(FEATURE_PHRASES);
+        this._features = Array.isArray(incommingMessage.features) ? incommingMessage.features : ['text'];
+
+        this._sendLastMessageWithFinish = this._features.includes(FEATURE_PHRASES)
+            || this._features.includes(FEATURE_TRACKING);
 
         /**
          * @type {Function}
@@ -196,9 +198,22 @@ class ReturnSender {
             ? this.confidentInputFilter
             : this.textFilter;
 
+        let { message } = payload;
+
+        if (message && message.voice && message.voice.ssml) {
+            message = {
+                ...message,
+                text: message.text ? message.text : message.voice.ssml,
+                voice: {
+                    ...message.voice,
+                    ssml: filter(message.voice.ssml)
+                }
+            };
+        }
+
         // text message
-        if (payload.message && payload.message.text) {
-            let { text } = payload.message;
+        if (message && message.text) {
+            let { text } = message;
 
             if (req && req._anonymizedText) {
                 text = req._anonymizedText;
@@ -207,27 +222,27 @@ class ReturnSender {
             return {
                 ...payload,
                 message: {
-                    ...payload.message,
+                    ...message,
                     text: filter(text)
                 }
             };
         }
 
         // button message
-        if (payload.message && payload.message.attachment
-            && payload.message.attachment.type === 'template'
-            && payload.message.attachment.payload
-            && payload.message.attachment.payload.text) {
+        if (message && message.attachment
+            && message.attachment.type === 'template'
+            && message.attachment.payload
+            && message.attachment.payload.text) {
 
             return {
                 ...payload,
                 message: {
-                    ...payload.message,
+                    ...message,
                     attachment: {
-                        ...payload.message.attachment,
+                        ...message.attachment,
                         payload: {
-                            ...payload.message.attachment.payload,
-                            text: filter(payload.message.attachment.payload.text)
+                            ...message.attachment.payload,
+                            text: filter(message.attachment.payload.text)
                         }
                     }
                 }
@@ -246,9 +261,7 @@ class ReturnSender {
             payload = this._queue.shift();
 
             let lastInQueueForNow = this._queue.length === 0;
-            if (this._queue.length === 0
-                && (this._sendLastMessageWithFinish
-                    || this._intentsAndEntities.some((e) => e && e.type))) {
+            if (this._queue.length === 0 && this._sendLastMessageWithFinish) {
                 await Promise.race([
                     this._anotherEventPromise,
                     this._finishedPromise
@@ -279,8 +292,16 @@ class ReturnSender {
     }
 
     async _enrichPayload (payload, req, lastInQueueForNow) {
-        if (lastInQueueForNow && req && this._intentsAndEntities.length !== 0) {
-            const { phrases } = this._sendLastMessageWithFinish
+        if (!lastInQueueForNow) {
+            return;
+        }
+        if (this._features.includes(FEATURE_TRACKING)) {
+            const tracking = this._createTracking(req);
+            Object.assign(payload, { tracking });
+        }
+        if (req && this._intentsAndEntities.length !== 0) {
+            const supportsPhrases = this._features.includes(FEATURE_PHRASES);
+            const { phrases } = supportsPhrases
                 ? await ai.ai.getPhrases(req)
                 : { phrases: new Map() };
 
@@ -295,7 +316,7 @@ class ReturnSender {
                         input = aiObj;
                         return;
                     }
-                    if (!this._sendLastMessageWithFinish) {
+                    if (!supportsPhrases) {
                         return;
                     }
                     if (aiObj.startsWith('@')) {
@@ -349,6 +370,8 @@ class ReturnSender {
         }
         if (Array.isArray(payload.expectedIntentsAndEntities)) {
             this._intentsAndEntities.push(...payload.expectedIntentsAndEntities);
+            this._sendLastMessageWithFinish = this._sendLastMessageWithFinish
+                || this._intentsAndEntities.some((e) => e && e.type);
             return;
         }
 
@@ -403,6 +426,29 @@ class ReturnSender {
         };
     }
 
+    _createTracking (req = null, res = null) {
+        const payload = {};
+        const meta = {
+            actions: this._visitedInteractions.slice()
+        };
+
+        if (req) {
+            Object.assign(meta, {
+                intent: req.intent(ai.ai.confidence),
+                confidence: ai.ai.confidence,
+                intents: (req.intents || [])
+                    .map((i) => this._cleanupIntent(i)),
+                entities: this._cleanupEntities((req.entities || [])
+                    .filter((e) => e.score >= ai.ai.confidence))
+            });
+        }
+        if (res) {
+            Object.assign(payload, res.senderMeta);
+        }
+
+        return Object.assign(this._tracking, { payload, meta });
+    }
+
     /**
      * @private
      * @param {Request} req

package/src/Router.js

@@ -271,7 +271,7 @@ class Router extends ReducerWrapper {
     }
 
     // used as protected method
-    async processReducers (reducers, req, res, postBack, path, action, doNotTrack = false) {
+    async processReducers (reducers, req, res, postBack, action, doNotTrack = false) {
         const routeToReduce = {
             reducers,
             path: res.routePath

package/src/Tester.js

@@ -69,9 +69,21 @@ class Tester {
             info: e => console.info(e) // eslint-disable-line
         };
 
+        this._cachedGiMap = null;
+
         this._listener = (senderIdentifier, action, text, req, prevAction, doNotTrack) => {
+            const reqAction = req.action();
+            if (reqAction
+                && !this._actionMatches(action, reqAction)
+                && this._actionHasGlobalIntent(reqAction)) {
+
+                this._actionsCollector.push({
+                    action: reqAction, text, prevAction, doNotTrack, isReqAction: true
+                });
+            }
+
             this._actionsCollector.push({
-                action, text, prevAction, doNotTrack
+                action, text, prevAction, doNotTrack, isReqAction: false
             });
         };
 
@@ -127,10 +139,27 @@ class Tester {
         this.features = null;
     }
 
+    _actionHasGlobalIntent (action) {
+        if (!this.processor.reducer
+            || !('globalIntents' in this.processor.reducer)) {
+            return false;
+        }
+        if (this._cachedGiMap === null) {
+            this._cachedGiMap = new Set();
+
+            for (const value of this.processor.reducer.globalIntents.values()) {
+                this._cachedGiMap.add(value.action);
+            }
+        }
+
+        return this._cachedGiMap.has(action.replace(/^\/?/, '/'));
+    }
+
     dealloc () {
         this.processor.reducer
             .removeListener('_action', this._listener);
         this.processor.reducer = null;
+        this._cachedGiMap = null;
     }
 
     /**
@@ -255,22 +284,30 @@ class Tester {
         return new ResponseAssert(this.responses[this.responses.length - 1]);
     }
 
+    _actionMatches (botAction, path) {
+        return botAction === path
+            || (path === '*' && botAction === '/*')
+            || (!botAction.match(/\*/) && actionMatches(botAction, path));
+    }
+
     /**
-     * Checks, that app past the action
+     * Checks, that request passed an interaction
      *
      * @param {string} path
+     * @param {boolean} [matchRequestActions]
      * @returns {this}
      *
      * @memberOf Tester
      */
-    passedAction (path) {
+    passedAction (path, matchRequestActions = false) {
         const ok = this.actions
-            .some((action) => (action.action === path
-                || (!action.action.match(/\*/) && actionMatches(action.action, path))));
+            .some((action) => (!action.isReqAction || matchRequestActions)
+                && this._actionMatches(action.action, path));
         let actual;
         if (!ok) {
             const set = new Set();
             actual = this.actions
+                .filter((a) => !a.isReqAction || matchRequestActions)
                 .map((a) => (a.doNotTrack ? `(system interaction) ${a.action}` : a.action))
                 .filter((a) => !set.has(a) && set.add(a));
             assert.fail(asserts.ex('Interaction was not passed', path, actual));

package/src/features.js

@@ -23,6 +23,11 @@ const FEATURE_SSML = 'ssml';
  */
 const FEATURE_PHRASES = 'phrases';
 
+/**
+ * @constant {string} FEATURE_TRACKING channel supports tracking protocol
+ */
+const FEATURE_TRACKING = 'tracking';
+
 function getDefaultFeatureList () {
     return [FEATURE_TEXT];
 }
@@ -32,5 +37,6 @@ module.exports = {
     FEATURE_VOICE,
     FEATURE_SSML,
     FEATURE_PHRASES,
+    FEATURE_TRACKING,
     getDefaultFeatureList
 };

package/src/resolvers/expected.js

@@ -5,7 +5,16 @@
 
 const Router = require('../Router');
 
-function expected ({ path }, { isLastIndex }) {
+function expected ({ path, attachedRouter }, { isLastIndex }) {
+
+    if (attachedRouter) {
+        return (req, res, postBack) => postBack(path, {
+            _useExpected: {
+                action: res.toAbsoluteAction(path),
+                data: {}
+            }
+        }, true);
+    }
 
     return (req, res) => {
         res.expected(path);

package/src/utils/customFn.js

@@ -6,14 +6,6 @@
 const Router = require('../Router'); // eslint-disable-line
 const ai = require('../Ai'); // eslint-disable-line
 const fetch = require('node-fetch'); // eslint-disable-line
-let request;
-try {
-    // @ts-ignore
-    request = module.require('request-promise-native');
-} catch (e) {
-    // eslint-disable-next-line no-unused-vars
-    request = () => { throw new Error('To use request, you have to manually install request-promise-native into your bot.'); };
-}
 let axios;
 try {
     // @ts-ignore

package/src/utils/getUpdate.js

@@ -20,7 +20,7 @@ const UNSUBSCRIBE = '_$unsubscribe';
 
 function getUpdate (attr, value, currentState = {}) {
     let param;
-    let rest = attr;
+    let rest = attr && attr.replace(/\u2219/g, '.');
     let state = currentState;
     const ret = {};
     let up = ret;
@@ -53,7 +53,7 @@ function getUpdate (attr, value, currentState = {}) {
 
 function getValue (attr, currentState = {}) {
     let param;
-    let rest = attr;
+    let rest = attr && attr.replace(/\u2219/g, '.');
     let state = currentState;
 
     do {

package/src/utils/quickReplies.js

@@ -133,7 +133,8 @@ function makeQuickReplies (replies, path = '', translate = (w) => w, quickReplyC
                 data = {},
                 isLocation = false,
                 isEmail = false,
-                isPhone = false
+                isPhone = false,
+                useCa = currentAction
             } = reply;
             let {
                 setState = null
@@ -219,7 +220,7 @@ function makeQuickReplies (replies, path = '', translate = (w) => w, quickReplyC
                 payload = {
                     action: absoluteAction,
                     data: {
-                        _ca: currentAction,
+                        _ca: useCa,
                         ...data
                     }
                 };

package/src/utils/wrapPluginFunction.js

@@ -41,7 +41,7 @@ function wrapPluginFunction (
                     return true;
                 }
                 const reducers = preprocessedItems.get(codeBlockName);
-                return router.processReducers(reducers, req, res, postBack, path, action, true);
+                return router.processReducers(reducers, req, res, postBack, action, true);
             }
         });