wingbot 3.32.0-alpha.1 → 3.32.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.32.0-alpha.1",
+  "version": "3.32.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/Ai.js

@@ -229,7 +229,7 @@ class Ai {
      *
      * @param {string} path
      * @param {IntentRule|IntentRule[]} intents
-     * @param {string|Function} [title] - disambiguation title
+     * @param {string} [title] - disambiguation title
      * @param {object} [meta] - metadata for multibot environments
      * @param {object} [meta.targetAppId] - target application id
      * @param {object} [meta.targetAction] - target action
@@ -276,7 +276,7 @@ class Ai {
      *
      * @param {string} path
      * @param {IntentRule|IntentRule[]} intents
-     * @param {string|Function} [title] - disambiguation title
+     * @param {string} [title] - disambiguation title
      * @returns {object} - the middleware
      * @memberOf Ai
      * @example

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

@@ -17,67 +17,6 @@ const { shouldExecuteResolver } = require('./resolvers/resolverTags');
 
 const MESSAGE_RESOLVER_NAME = 'botbuild.message';
 
-/** @typedef {import('./Router').Middleware} Middleware */
-
-/**
- * @typedef {object} Resolver
- * @prop {string} type
- * @prop {object} params
- * @prop {string} [params.staticBlockId]
- * @prop {string} [tag]
- */
-
-/** @typedef {import('./resolvers/bounce').BounceAllow} BounceAllow */
-/** @typedef {import('./resolvers/bounce').BounceReturn} BounceReturn */
-
-/**
- * @typedef {object} Route
- * @prop {number} id
- * @prop {string|null} path
- * @prop {Resolver[]} resolvers
- * @prop {boolean} [isFallback]
- * @prop {string[]} [aiTags]
- * @prop {boolean} [isResponder]
- * @prop {number} [respondsToRouteId]
- * @prop {string|any[]} [aiTitle]
- * @prop {boolean} [aiGlobal]
- * @prop {BounceAllow} [bounceAllowedTo]
- * @prop {BounceReturn} [bounceReturn]
- * @prop {boolean} [isEntryPoint]
- */
-
-/**
- * @typedef {object} RouteTransformation
- * @prop {string} [expectedPath]
- *
- * @typedef {RouteTransformation & Route} TransformedRoute
- */
-
-/**
- * @typedef {Map<string|number,string>} LinksMap
- */
-
-/** @type {TransformedRoute} */
-const DUMMY_ROUTE = { id: 0, path: null, resolvers: [] };
-
-/**
- * @typedef {object} Block
- * @prop {string} staticBlockId
- * @prop {Route[]} routes
- * @prop {boolean} [isRoot]
- * @prop {boolean} [disabled]
- * @prop {string} [blockName]
- * @prop {string} [blockType]
- */
-
-/**
- * @typedef {object} BotConfig
- * @prop {string} botId - the ID of bot
- * @prop {string} snapshot - snapshot stage of bot
- * @prop {string|Promise<string>} token - authorization token for bot
- * @prop {string} [url] - specify alternative configuration resource
- */
-
 /**
  * @typedef {object} ConfigStorage
  * @prop {{():Promise}} invalidateConfig
@@ -86,61 +25,6 @@ const DUMMY_ROUTE = { id: 0, path: null, resolvers: [] };
  * @prop {{():Promise<Object>}} getConfig
  */
 
-/**
- * @typedef {object} RouteConfig
- * @prop {string} path
- * @prop {boolean} enabled
- * @prop {object} configuration
- */
-
-/**
- * @callback LinkTranslator
- * @param {string} senderId
- * @param {string} textLabel
- * @param {string} urlText
- * @param {boolean} [isExtUrl]
- * @param {object} [state]
- * @returns {string}
- */
-
-/**
- * @typedef {object} BotContext
- * @prop {LinkTranslator} [linksTranslator] - function, that translates links globally
- * @prop {ConfigStorage} [configStorage] - function, that translates links globally
- * @prop {boolean} [allowForbiddenSnippetWords] - disable security rule
- * @prop {RouteConfig[]} [routeConfigs] - list of disabled routes
- * @prop {object} [configuration] - context data
- * @prop {LinksMap} [linksMap]
- * @prop {boolean} [isLastIndex]
- * @prop {boolean} [isLastMessage]
- * @prop {BuildRouter} [router]
- * @prop {string} [path]
- * @prop {boolean} [isFallback]
- * @prop {string} [expectedPath]
- * @prop {boolean} [isResponder]
- * @prop {string|number} [routeId]
- * @prop {string} [blockName]
- * @prop {string} [blockType]
- * @prop {boolean} [isRoot]
- * @prop {string} [staticBlockId]
- * @prop {Block[]} [blocks]
- * @prop {object} [BuildRouter]
- */
-
-function deepFreeze (object) {
-    const propNames = Object.getOwnPropertyNames(object);
-
-    for (const name of propNames) {
-        const value = object[name];
-
-        if (value && typeof value === 'object') {
-            deepFreeze(value);
-        }
-    }
-
-    return Object.freeze(object);
-}
-
 /**
  * Build bot from Wingbot configuration file or snapshot url
  *
@@ -152,15 +36,16 @@ class BuildRouter extends Router {
      * Create new router from configuration
      *
      * @constructor
-     * @param {BotConfig|Block} block
+     * @param {object} block
+     * @param {string} [block.botId] - the ID of bot
+     * @param {string} [block.snapshot] - snapshot stage of bot
+     * @param {string|Promise<string>} [block.token] - authorization token for bot
+     * @param {string} [block.url] - specify alternative configuration resource
      * @param {Plugins} plugins - custom code blocks resource
      * @param {object} context - the building context
      * @param {object} [context.linksTranslator] - function, that translates links globally
      * @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
      *
@@ -191,10 +76,8 @@ class BuildRouter extends Router {
 
         this._plugins = plugins;
 
-        /** @type {BotContext} */
         this._context = context;
 
-        /** @type {LinksMap} */
         this._linksMap = new Map();
 
         this._loadBotUrl = null;
@@ -211,7 +94,7 @@ class BuildRouter extends Router {
 
         this.resources = defaultResourceMap();
 
-        this._loadBotAuthorization = 'token' in block ? block.token : null;
+        this._loadBotAuthorization = block.token || null;
 
         this._configStorage = context.configStorage;
 
@@ -229,7 +112,7 @@ class BuildRouter extends Router {
         this._snapshot = null;
         this._botId = null;
 
-        if ('routes' in block) {
+        if (typeof block.routes === 'object') {
             this._buildBot(block);
         } else if (typeof block.url === 'string') {
             this._loadBotUrl = block.url;
@@ -427,16 +310,11 @@ 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));
         }
     }
 
-    /**
-     *
-     * @param {Block} block
-     * @param {number} setConfigTimestamp
-     * @param {string} lastmod
-     */
     _buildBot (block, setConfigTimestamp = Number.MAX_SAFE_INTEGER, lastmod = '-') {
         try {
             if (setConfigTimestamp !== Number.MAX_SAFE_INTEGER) {
@@ -449,7 +327,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) {
@@ -511,13 +390,7 @@ class BuildRouter extends Router {
         });
     }
 
-    /**
-     *
-     * @param {Block} block
-     * @returns {LinksMap}
-     */
     _createLinksMap (block) {
-        /** @type {LinksMap} */
         const linksMap = new Map();
 
         block.routes
@@ -529,140 +402,35 @@ class BuildRouter extends Router {
         if (prevLinksMap) {
             for (const [from, to] of prevLinksMap.entries()) {
                 if (!linksMap.has(from)) {
-                    linksMap.set(from, this._joinPaths('..', to));
+
+                    (path.posix || path).join('..', to);
+
+                    linksMap.set(from, (path.posix || path).join('..', to));
                 }
             }
         }
 
         block.routes.forEach((route) => {
-            const enabledNestedBlock = this._getBlockById(this._getIncludedBlockId(route));
-            if (!enabledNestedBlock) {
-                return;
-            }
-            const routeConfig = this._getRouteConfig(route);
-            if (this._enabledByRouteConfig(routeConfig)) {
-                this._findEntryPointsInResolver(linksMap, enabledNestedBlock, route);
+            let resolver;
+            for (resolver of route.resolvers) {
+                if (resolver.type !== 'botbuild.include') {
+                    continue;
+                }
+                this._findEntryPointsInResolver(linksMap, resolver, route, this._context);
             }
         });
 
         return linksMap;
     }
 
-    /**
-     *
-     * @param {RouteConfig} routeConfig
-     */
-    _enabledByRouteConfig (routeConfig) {
-        return !this._context.routeConfigs || (routeConfig && routeConfig.enabled);
-    }
-
-    _joinPaths (...args) {
-        return (path.posix || path).join(...args);
-    }
-
-    _normalizeConfigPath (routePath, ctxPath = null) {
-        const joined = ctxPath
-            ? this._joinPaths(ctxPath, routePath)
-            : routePath;
-
-        return joined
-            .replace(/^\/?|(_responder)?\/?$/g, '/');
-    }
-
-    /**
-     *
-     * @param {Route} route
-     * @returns {string|null}
-     */
-    _getIncludedBlockId (route) {
-        const includeResolver = route.resolvers.find((r) => r.type === 'botbuild.include');
+    _findEntryPointsInResolver (linksMap, resolver, route, context) {
+        const includedBlock = (context.blocks || [])
+            .find((b) => b.staticBlockId === resolver.params.staticBlockId);
 
-        return includeResolver
-            ? includeResolver.params.staticBlockId
-            : null;
-    }
-
-    /**
-     *
-     * @param {string} staticBlockId
-     * @returns {Block|null}
-     */
-    _getBlockById (staticBlockId) {
-        if (!staticBlockId) {
-            return null;
-        }
-        const nestedBlock = (this._context.blocks || [])
-            .find((b) => b.staticBlockId === staticBlockId);
-
-        if (!nestedBlock || nestedBlock.disabled) {
-            return null;
-        }
-        return nestedBlock;
-    }
-
-    /**
-     *
-     * @param {TransformedRoute} route
-     * @returns {RouteConfig}
-     */
-    _getRouteConfig (route) {
-        const { path: ctxPath, routeConfigs } = this._context;
-        if (!routeConfigs || !route.path || route.isFallback) {
-            return null;
-        }
-
-        let rPath;
-        if (!route.isResponder) {
-            rPath = route.path;
-        } else if (route.expectedPath) {
-            rPath = route.expectedPath;
-        } else if (this._linksMap.has(route.respondsToRouteId)) {
-            rPath = this._linksMap.get(route.respondsToRouteId);
-        } else {
-            throw new Error('Illegal state');
-        }
-
-        const routePath = this._normalizeConfigPath(rPath, ctxPath);
-        return routeConfigs.find((config) => {
-            const configPath = this._normalizeConfigPath(config.path);
-
-            return configPath === routePath;
-        });
-    }
-
-    /**
-     *
-     * @param {string} routePath
-     * @returns {object}
-     */
-    getConfiguration (routePath) {
-        const { path: ctxPath, routeConfigs, configuration = {} } = this._context;
-        if (!routeConfigs || !routePath) {
-            return deepFreeze(configuration);
+        if (!includedBlock) {
+            return;
         }
-        const normalized = this._normalizeConfigPath(routePath, ctxPath);
-
-        const configs = routeConfigs
-            .filter((config) => {
-                const configPath = this._normalizeConfigPath(config.path);
-                return normalized.startsWith(configPath);
-            })
-            .sort((a, z) => a.path.length - z.path.length);
-
-        return deepFreeze(configs.reduce((cfg, config) => ({
-            ...cfg,
-            ...config.configuration
-        }), configuration));
-    }
 
-    /**
-     *
-     * @param {LinksMap} linksMap
-     * @param {Block} includedBlock
-     * @param {TransformedRoute} route
-     * @returns {void}
-     */
-    _findEntryPointsInResolver (linksMap, includedBlock, route) {
         let basePath = `${route.path}/`;
 
         if (route.isFallback) {
@@ -670,20 +438,14 @@ class BuildRouter extends Router {
         }
 
         includedBlock.routes.forEach((blockRoute) => {
-            if (!blockRoute.isEntryPoint) {
+            if (!blockRoute.isEntryPoint || blockRoute.isRoot) {
                 return;
             }
 
-            linksMap.set(blockRoute.id, `${basePath}${blockRoute.path}`);
+            linksMap.set(`${blockRoute.id}`, `${basePath}${blockRoute.path}`);
         });
     }
 
-    /**
-     *
-     * @param {TransformedRoute} route
-     * @param {boolean} nextRouteIsSameResponder
-     * @returns {Middleware[]}
-     */
     _buildRouteHead (route, nextRouteIsSameResponder) {
         const resolvers = [];
 
@@ -691,10 +453,10 @@ class BuildRouter extends Router {
             let aiResolver = null;
 
             if (route.aiTags && route.aiTags.length) {
-                let aiTitle = null;
+                let { aiTitle = null } = route;
 
-                if (route.aiTitle) {
-                    aiTitle = cachedTranslatedCompilator(route.aiTitle);
+                if (aiTitle) {
+                    aiTitle = cachedTranslatedCompilator(aiTitle);
                 }
 
                 if (route.aiGlobal) {
@@ -726,25 +488,8 @@ class BuildRouter extends Router {
         return resolvers;
     }
 
-    /**
-     *
-     * @param {TransformedRoute[]} routes
-     */
     _buildRoutes (routes) {
         routes.forEach((route, i) => {
-            const routeConfig = this._getRouteConfig(route);
-
-            if (routeConfig && !routeConfig.enabled) {
-                return;
-            }
-
-            const includedBlockId = this._getIncludedBlockId(route);
-            const nestedBlock = this._getBlockById(includedBlockId);
-
-            if (includedBlockId && (!nestedBlock || !this._enabledByRouteConfig(routeConfig))) {
-                return;
-            }
-
             const nextRoute = routes.length > (i + 1)
                 ? routes[i + 1]
                 : null;
@@ -754,15 +499,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
                 }));
@@ -772,11 +523,6 @@ class BuildRouter extends Router {
         });
     }
 
-    /**
-     *
-     * @param {Resolver[]} resolvers
-     * @returns {number}
-     */
     _lastMessageIndex (resolvers) {
         for (let i = resolvers.length - 1; i >= 0; i--) {
             if (resolvers[i].type === MESSAGE_RESOLVER_NAME) {
@@ -786,33 +532,18 @@ class BuildRouter extends Router {
         return -1;
     }
 
-    /**
-     *
-     * @param {Resolver[]} resolvers
-     * @param {TransformedRoute} route
-     * @param {*} expectedToAddResolver
-     * @returns {Middleware[]}
-     */
-    buildResolvers (resolvers, route = DUMMY_ROUTE, expectedToAddResolver = false) {
+    buildResolvers (resolvers, route = {}, buildInfo = {}) {
         const {
             path: ctxPath, isFallback, isResponder, expectedPath, id
         } = route;
 
-        const routeConfig = this._getRouteConfig(route);
-        const routeConfigData = routeConfig && routeConfig.configuration;
-
         const lastMessageIndex = this._lastMessageIndex(resolvers);
         const lastIndex = resolvers.length - 1;
 
         return resolvers.map((resolver, i) => {
-            const configuration = deepFreeze({
-                ...this._context.configuration,
-                ...routeConfigData
-            });
-
             const context = {
                 ...this._context,
-                isLastIndex: lastIndex === i && !expectedToAddResolver,
+                isLastIndex: lastIndex === i && !buildInfo.expectedToAddResolver,
                 isLastMessage: lastMessageIndex === i,
                 router: this,
                 linksMap: this._linksMap,
@@ -820,24 +551,14 @@ class BuildRouter extends Router {
                 isFallback,
                 isResponder,
                 expectedPath,
-                routeId: id,
-                configuration
+                routeId: id
             };
 
-            const resFn = this._resolverFactory(resolver, context);
-            // @ts-ignore
-            resFn.configuration = configuration;
-            return resFn;
+            return this._resolverFactory(resolver, context, buildInfo);
         });
     }
 
-    /**
-     *
-     * @param {Resolver} resolver
-     * @param {BotContext} context
-     * @returns {Middleware}
-     */
-    _resolverFactory (resolver, context) {
+    _resolverFactory (resolver, context, buildInfo) {
         const { type } = resolver;
 
         if (!this.resources.has(type)) {
@@ -848,9 +569,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;
         }
@@ -889,9 +618,9 @@ class BuildRouter extends Router {
 }
 
 /**
- * @param {Block[]} blocks - blocks list
+ * @param {object[]} blocks - blocks list
  * @param {Plugins} [plugins]
- * @param {BotContext} [context]
+ * @param {object} [context]
  */
 BuildRouter.fromData = function fromData (blocks, plugins = new Plugins(), context = {}) {