wingbot 3.66.0-alpha.1 → 3.66.1

package/package.json

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

package/src/BotApp.js

@@ -39,6 +39,7 @@ const DEFAULT_API_URL = 'https://orchestrator-api.wingbot.ai';
  * @prop {Function} [fetch]
  * @prop {ChatLogStorage} [chatLogStorage]
  * @prop {boolean} [preferSynchronousResponse]
+ * @prop {boolean} [deferLogs]
  * @prop {AuditLog} [auditLog]
  * @prop {TlsOptions} [tls]
  *
@@ -91,6 +92,7 @@ class BotApp {
         } = options;
 
         this._returnSenderOptions = {
+            dontWaitForDeferredOps: processorOptions.deferLogs,
             textFilter,
             logStandbyEvents,
             confidentInputFilter
@@ -312,8 +314,8 @@ class BotApp {
             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);
-
+            sender.defer(this._processSenderResponses(sender, senderId, pageId, headers));
+            await sender.waitForDeferredOps();
             return {
                 status: res.status,
                 // yes, it should be just mid
@@ -337,7 +339,8 @@ class BotApp {
 
         const sender = await this.createSender(senderId, pageId, message, secret, appId);
         const res = await this._processor.processMessage(message, pageId, sender, { appId });
-        await this._processSenderResponses(sender, senderId, pageId, headers);
+        sender.defer(this._processSenderResponses(sender, senderId, pageId, headers));
+        await sender.waitForDeferredOps();
 
         return {
             status: res.status,

package/src/BuildRouter.js

@@ -111,17 +111,21 @@ const DUMMY_ROUTE = { id: 0, path: null, resolvers: [] };
  * @param {object} state
  * @param {string} pageId
  * @returns {string}
- */
+*/
 
 /**
  * @template {BaseConfiguration} [C=object]
- * @typedef {object} BotContext
+ * @typedef {object} BuildRouterContext
  * @prop {LinkTranslator} [linksTranslator] - function, that translates links globally
  * @prop {ConfigStorage} [configStorage] - function, that translates links globally
  * @prop {boolean} [allowForbiddenSnippetWords] - disable security rule
  * @prop {Middleware} [defaultPlugin] - to be able to test configurations without plugins
  * @prop {RouteConfig[]} [routeConfigs] - list of disabled routes
  * @prop {C} [configuration] - context data
+ */
+
+/**
+ * @typedef {object} BotContextExtention
  * @prop {LinksMap} [linksMap]
  * @prop {boolean} [isLastIndex]
  * @prop {boolean} [isLastMessage]
@@ -140,6 +144,11 @@ const DUMMY_ROUTE = { id: 0, path: null, resolvers: [] };
  * @prop {string|number} [resolverId] - only for text messages with random characters
  */
 
+/**
+ * @template {BaseConfiguration} [C=object]
+ * @typedef {BotContextExtention & BuildRouterContext<C>} BotContext
+ */
+
 /**
  * Build bot from Wingbot configuration file or snapshot url
  *
@@ -156,12 +165,7 @@ class BuildRouter extends Router {
      * @constructor
      * @param {BotConfig|Block} block
      * @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 {C} [context.configuration]
+     * @param {BuildRouterContext<C>} context - the building context
      * @param {fetch} [fetchFn] - override a request function
      * @example
      *

package/src/Processor.js

@@ -403,7 +403,7 @@ class Processor extends EventEmitter {
         const result = await this
             ._dispatch(message, pageId, messageSender, responderData, preloadPromise);
 
-        await preloadPromise;
+        messageSender.defer(preloadPromise, this.options.log);
         return result;
     }
 
@@ -419,7 +419,7 @@ class Processor extends EventEmitter {
             } = await this
                 ._processMessage(message, pageId, messageSender, responderData, preloadPromise));
 
-            await this._emitInteractionEvent(req, res, messageSender, state, data);
+            messageSender.defer(this._emitInteractionEvent(req, res, messageSender, state, data));
 
             return messageSender.finished(req, res, null, errorHandler);
         } catch (e) {
@@ -579,7 +579,7 @@ class Processor extends EventEmitter {
         let req;
         let res;
 
-        let emitPromise = Promise.resolve();
+        // let emitPromise = Promise.resolve();
 
         try {
             // ensure the request was not processed
@@ -776,7 +776,7 @@ class Processor extends EventEmitter {
                 }
 
                 if (fromEvent) {
-                    emitPromise = this._emitEvent(req, res);
+                    messageSender.defer(this._emitEvent(req, res), this.options.log);
                 }
             }
 
@@ -822,13 +822,22 @@ class Processor extends EventEmitter {
 
         } catch (e) {
             await this.stateStorage.saveState(originalState);
-            await emitPromise;
+            // await emitPromise;
             Object.assign(e, { req, res });
             throw e;
         }
 
+        if (postbackAcumulator.length === 0) {
+            messageSender.defer(this.stateStorage.saveState(stateObject));
+            return {
+                req, res, data: res.data, state: stateObject.state
+            };
+        }
+
         try {
+
             await this.stateStorage.saveState(stateObject);
+
             // process postbacks
             const {
                 state = stateObject.state,
@@ -842,7 +851,7 @@ class Processor extends EventEmitter {
                 res.senderMeta
             );
 
-            await emitPromise; // probably has been resolved this time
+            // await emitPromise; // probably has been resolved this time
 
             return {
                 req, res, data, state

package/src/ReturnSender.js

@@ -31,6 +31,7 @@ const extractText = require('./transcript/extractText');
 
 /**
  * @typedef {object} ReturnSenderOptions
+ * @prop {boolean} [dontWaitForDeferredOps]
  * @prop {textFilter} [textFilter] - filter for saving the texts
  * @prop {boolean} [logStandbyEvents] - log the standby events
  * @prop {textFilter} [confidentInputFilter] - filter for confident input (@CONFIDENT)
@@ -42,6 +43,16 @@ const extractText = require('./transcript/extractText');
  * @prop {string|number} [attachmentId]
  */
 
+/**
+ * @callback DeferOperation
+ * @returns {Promise<any>}
+ */
+
+/**
+ * @typedef {object} ErrorLogger
+ * @prop {Function} error
+ */
+
 /**
  * Text filter function
  *
@@ -147,6 +158,44 @@ class ReturnSender {
         this._gotAnotherEventDefer = null;
         this._anotherEventPromise = null;
         this._gotAnotherEvent();
+
+        this._skipWaitForDeferred = options.dontWaitForDeferredOps;
+        this._opQueue = new Set();
+    }
+
+    async waitForDeferredOps () {
+        if (this._skipWaitForDeferred) {
+            return;
+        }
+        await Promise.all(Array.from(this._opQueue.values()));
+        if (this._throwAtTheEnd) {
+            const e = this._throwAtTheEnd;
+            this._throwAtTheEnd = null;
+            throw e;
+        }
+    }
+
+    /**
+     *
+     * @param {DeferOperation|Promise} operation
+     * @param {ErrorLogger} logger
+     */
+    defer (operation, logger = console) {
+        const promise = (typeof operation === 'function'
+            ? Promise.resolve(operation())
+            : operation
+        )
+            .catch((e) => {
+                if (this._skipWaitForDeferred === false) {
+                    this._throwAtTheEnd = e;
+                }
+                // eslint-disable-next-line no-console
+                logger.error('DEFER# - op failed', e);
+            })
+            .then(() => {
+                this._opQueue.delete(promise);
+            });
+        this._opQueue.add(promise);
     }
 
     set simulatesOptIn (value) {
@@ -578,27 +627,29 @@ class ReturnSender {
             if (!this._logger || meta.flag === ResponseFlag.DO_NOT_LOG) {
                 // noop
             } else if (error) {
-                await Promise.resolve(this._logger
-                    .error(error, this._senderId, sent, incomming, meta));
+                this.defer(Promise.resolve(this._logger
+                    .error(error, this._senderId, sent, incomming, meta)));
             } else if (this._sendLogs) {
                 this._sendLogs = false;
-                await Promise.resolve(this._logger
-                    .log(this._senderId, sent, incomming, meta));
+                this.defer(Promise.resolve(this._logger
+                    .log(this._senderId, sent, incomming, meta)));
             }
         } catch (e) {
             console.log('meta', meta); // eslint-disable-line no-console
-            await Promise.resolve(reportError(e, this._incommingMessage, this._senderId));
+            this.defer(Promise.resolve(reportError(e, this._incommingMessage, this._senderId)));
         }
 
         if (error) {
             // @ts-ignore
             const { code = 500, message } = error;
-            await Promise.resolve(reportError(error, this._incommingMessage, this._senderId));
+            this.defer(Promise.resolve(reportError(error, this._incommingMessage, this._senderId)));
+            await this.waitForDeferredOps();
             return { status: code, error: message, results: this.results };
         }
 
         const somethingSent = this._results.length > 0;
 
+        await this.waitForDeferredOps();
         return {
             status: somethingSent ? 200 : 204,
             results: this._results

package/src/Tester.js

@@ -227,7 +227,10 @@ class Tester {
             Object.assign(message, { features: this.features });
         }
 
-        const messageSender = new ReturnSender({}, senderId, message, this.senderLogger);
+        const messageSender = new ReturnSender({
+            dontWaitForDeferredOps: false
+        }, senderId, message, this.senderLogger);
+
         messageSender.simulatesOptIn = true;
 
         const res = await this.processor

package/src/responderFactory.js

@@ -1,32 +0,0 @@
-/*
- * @author Vašek Strnad
- */
-'use strict';
-
-const Responder = require('./Responder');
-const { senderFactory } = require('./tools');
-
-function responderFactory (options = { token: null }, senderLogger = console, sender = undefined) {
-
-    const senderFnFactory = senderFactory(
-        options.token,
-        senderLogger,
-        undefined,
-        sender
-    );
-
-    const factoryFn = function factory (
-        senderId,
-        senderFn = null,
-        pageId = undefined,
-        senderHandler = undefined
-    ) {
-
-        const sendFn = senderFn || senderFnFactory(null, pageId, senderHandler);
-        return new Responder(false, senderId, sendFn, options.token, options);
-    };
-
-    return factoryFn;
-}
-
-module.exports = responderFactory;