botium-core 1.13.0 → 1.13.1

package/dist/botium-es.js

@@ -10,7 +10,7 @@ import randomatic from 'randomatic';
 import lodash from 'lodash';
 import boolean$1 from 'boolean';
 import events from 'events';
-import debug$l from 'debug';
+import debug$m from 'debug';
 import vm2 from 'vm2';
 import isClass from 'is-class';
 import crypto from 'crypto';
@@ -36,7 +36,7 @@ import express from 'express';
 import bodyParser from 'body-parser';
 
 var name = "botium-core";
-var version$1 = "1.13.0";
+var version$1 = "1.13.1";
 var description = "The Selenium for Chatbots";
 var main = "index.js";
 var module = "dist/botium-es.js";
@@ -68,17 +68,17 @@ var bugs = {
 };
 var homepage = "https://www.botium.ai";
 var dependencies = {
-	"@babel/runtime": "^7.18.3",
+	"@babel/runtime": "^7.18.6",
 	async: "^3.2.4",
 	"body-parser": "^1.20.0",
 	boolean: "^3.2.0",
 	bottleneck: "^2.19.5",
-	"csv-parse": "^5.2.0",
+	"csv-parse": "^5.3.0",
 	debug: "^4.3.4",
 	esprima: "^4.0.1",
 	express: "^4.18.1",
 	globby: "11.0.4",
-	ioredis: "^5.0.6",
+	ioredis: "^5.1.0",
 	"is-class": "^0.0.9",
 	"is-json": "^2.0.1",
 	jsonpath: "^1.1.1",
@@ -86,7 +86,7 @@ var dependencies = {
 	"markdown-it": "^13.0.1",
 	"mime-types": "^2.1.35",
 	mkdirp: "^1.0.4",
-	moment: "^2.29.3",
+	moment: "^2.29.4",
 	mustache: "^4.2.0",
 	"promise-retry": "^2.0.1",
 	"promise.allsettled": "^1.0.5",
@@ -101,33 +101,33 @@ var dependencies = {
 	"swagger-jsdoc": "^6.2.1",
 	"swagger-ui-express": "^4.4.0",
 	uuid: "^8.3.2",
-	vm2: "^3.9.9",
+	vm2: "^3.9.10",
 	"write-yaml": "^1.0.0",
 	xlsx: "^0.18.5",
 	xregexp: "^5.1.1",
 	yaml: "^2.1.1"
 };
 var devDependencies = {
-	"@babel/core": "^7.18.5",
-	"@babel/node": "^7.18.5",
-	"@babel/plugin-transform-runtime": "^7.18.5",
-	"@babel/preset-env": "^7.18.2",
+	"@babel/core": "^7.18.6",
+	"@babel/node": "^7.18.6",
+	"@babel/plugin-transform-runtime": "^7.18.6",
+	"@babel/preset-env": "^7.18.6",
 	chai: "^4.3.6",
 	"chai-as-promised": "^7.1.1",
 	"cross-env": "^7.0.3",
-	eslint: "^8.18.0",
+	eslint: "^8.19.0",
 	"eslint-config-standard": "^17.0.0",
 	"eslint-plugin-import": "^2.26.0",
-	"eslint-plugin-n": "^15.2.3",
+	"eslint-plugin-n": "^15.2.4",
 	"eslint-plugin-promise": "^6.0.0",
 	"eslint-plugin-standard": "^4.1.0",
 	"license-checker": "^25.0.1",
 	"license-compatibility-checker": "^0.3.5",
 	mocha: "^10.0.0",
-	nock: "^13.2.7",
-	"npm-check-updates": "^14.0.1",
+	nock: "^13.2.8",
+	"npm-check-updates": "^15.2.6",
 	nyc: "^15.1.0",
-	rollup: "^2.75.6",
+	rollup: "^2.76.0",
 	"rollup-plugin-babel": "^4.4.0",
 	"rollup-plugin-commonjs": "^10.1.0",
 	"rollup-plugin-json": "^4.0.0",
@@ -1188,7 +1188,7 @@ LogicHookConsts.DEFAULT_USER_INPUTS;
 const {
   NodeVM: NodeVM$2
 } = vm2;
-const debug$k = debug$l('botium-core-asserterUtils');
+const debug$l = debug$m('botium-core-asserterUtils');
 const {
   BotiumError: BotiumError$6
 } = BotiumError_1;
@@ -1253,7 +1253,7 @@ var LogicHookUtils_1 = class LogicHookUtils {
   _fetchAsserters() {
     this.caps[Capabilities.ASSERTERS].forEach(asserter => {
       if (this.asserters[asserter.ref]) {
-        debug$k(`${asserter.ref} asserter already exists, overwriting.`);
+        debug$l(`${asserter.ref} asserter already exists, overwriting.`);
       }
 
       this.asserters[asserter.ref] = this._loadClass(asserter, 'asserter');
@@ -1267,7 +1267,7 @@ var LogicHookUtils_1 = class LogicHookUtils {
   _fetchLogicHooks() {
     this.caps[Capabilities.LOGIC_HOOKS].forEach(logicHook => {
       if (this.logicHooks[logicHook.ref]) {
-        debug$k(`${logicHook.ref} logic hook already exists, overwriting.`);
+        debug$l(`${logicHook.ref} logic hook already exists, overwriting.`);
       }
 
       this.logicHooks[logicHook.ref] = this._loadClass(logicHook, 'logichook');
@@ -1281,7 +1281,7 @@ var LogicHookUtils_1 = class LogicHookUtils {
   _fetchUserInputs() {
     this.caps[Capabilities.USER_INPUTS].forEach(userInput => {
       if (this.userInputs[userInput.ref]) {
-        debug$k(`${userInput.ref} userinput already exists, overwriting.`);
+        debug$l(`${userInput.ref} userinput already exists, overwriting.`);
       }
 
       this.userInputs[userInput.ref] = this._loadClass(userInput, 'userinput');
@@ -1424,7 +1424,7 @@ var LogicHookUtils_1 = class LogicHookUtils {
                 });
                 return vm.run(script);
               } catch (err) {
-                throw new Error(`${err.message || err}`);
+                throw new Error(`Script ${key} is not valid - ${err.message || err}`);
               }
             } else {
               throw new Error(`Script "${key}" is not valid - only functions and javascript code accepted`);
@@ -1515,7 +1515,7 @@ var LogicHookUtils_1 = class LogicHookUtils {
         }
       }
 
-      loadErr.forEach(debug$k);
+      loadErr.forEach(debug$l);
     }
 
     throw new Error(`Failed to fetch ${ref} ${hookType}, no idea how to load ...`);
@@ -2374,7 +2374,7 @@ var helper = {
   linesToScriptingMemories: linesToScriptingMemories$2
 };
 
-const debug$j = debug$l('botium-core-ScriptingMemory');
+const debug$k = debug$m('botium-core-ScriptingMemory');
 const {
   v1: uuidv1
 } = uuid;
@@ -2632,7 +2632,7 @@ const extractVarNames = text => {
 };
 
 const fill = (container, scriptingMemory, result, utterance, scriptingEvents) => {
-  debug$j(`fill start: ${util.inspect(scriptingMemory)}`);
+  debug$k(`fill start: ${util.inspect(scriptingMemory)}`);
   let varRegex;
 
   switch (container.caps[Capabilities.SCRIPTING_MEMORY_MATCHING_MODE]) {
@@ -2676,14 +2676,14 @@ const fill = (container, scriptingMemory, result, utterance, scriptingEvents) =>
           const varName = varMatches[i - 1];
 
           if (RESERVED_WORDS.indexOf(varName) >= 0) {
-            debug$j(`fill Variable "${varName}" is not overwritten, because it is reserved word. `);
+            debug$k(`fill Variable "${varName}" is not overwritten, because it is reserved word. `);
           } else {
             scriptingMemory[varName] = resultMatches[i];
           }
         }
       }
     });
-    debug$j(`fill end: ${util.inspect(scriptingMemory)}`);
+    debug$k(`fill end: ${util.inspect(scriptingMemory)}`);
   }
 };
 
@@ -2702,7 +2702,48 @@ ScriptingMemory.extractVarNames;
 ScriptingMemory.RESERVED_WORDS;
 ScriptingMemory.SCRIPTING_FUNCTIONS;
 
-const debug$i = debug$l('botium-core-Convo');
+const debug$j = debug$m('botium-core-RetryHelper');
+var RetryHelper_1 = class RetryHelper {
+  constructor(caps, section, options = {}) {
+    this.retryErrorPatterns = [];
+    const onErrorRegexp = caps[`RETRY_${section.toUpperCase()}_ONERROR_REGEXP`] || [];
+
+    if (onErrorRegexp) {
+      if (lodash.isArray(onErrorRegexp)) {
+        onErrorRegexp.forEach(r => {
+          if (lodash.isString(r)) this.retryErrorPatterns.push(new RegExp(r, 'i'));else this.retryErrorPatterns.push(r);
+        });
+      } else if (lodash.isString(onErrorRegexp)) {
+        this.retryErrorPatterns.push(new RegExp(onErrorRegexp, 'i'));
+      } else {
+        this.retryErrorPatterns.push(onErrorRegexp);
+      }
+    } // to turn on retries, NUMRETRIES or ONERROR_REGEXP has to be set
+
+
+    this.retrySettings = {
+      retries: caps[`RETRY_${section.toUpperCase()}_NUMRETRIES`] || (!lodash.isNil(options.numRetries) ? options.numRetries : this.retryErrorPatterns.length === 0 ? 0 : 1),
+      factor: caps[`RETRY_${section.toUpperCase()}_FACTOR`] || (lodash.isNil(options.factor) ? 1 : options.factor),
+      minTimeout: caps[`RETRY_${section.toUpperCase()}_MINTIMEOUT`] || (lodash.isNil(options.minTimeout) ? 1000 : options.minTimeout)
+    };
+    debug$j(`Retry for ${section} is ${this.retrySettings.retries > 0 ? 'enabled' : 'disabled'}. Settings: ${JSON.stringify(this.retrySettings)} Patterns: ${JSON.stringify(this.retryErrorPatterns.map(r => r.toString()))}`);
+  }
+
+  shouldRetry(err) {
+    if (!err) return false;
+    if (this.retryErrorPatterns.length === 0) return true;
+    const errString = util.inspect(err);
+
+    for (const re of this.retryErrorPatterns) {
+      if (errString.match(re)) return true;
+    }
+
+    return false;
+  }
+
+};
+
+const debug$i = debug$m('botium-core-Convo');
 const {
   BotiumError: BotiumError$4,
   botiumErrorFromErr: botiumErrorFromErr$1,
@@ -2927,6 +2968,26 @@ class Convo$6 {
   }
 
   async Run(container) {
+    const retryHelper = new RetryHelper_1(container.caps, 'CONVO');
+    return promiseRetry(async (retry, number) => {
+      return this.RunImpl(container).catch(err => {
+        const retryRemaining = retryHelper.retrySettings.retries - number + 1;
+
+        if (retryHelper.shouldRetry(err)) {
+          debug$i(`Convo failed with error "${err.message || JSON.stringify(err)}". Retry ${retryRemaining > 0 ? 'enabled' : 'disabled'} (remaining #${retryRemaining}/${retryHelper.retrySettings.retries}, criterion matches)`);
+          retry(err);
+        } else {
+          if (retryHelper.retryErrorPatterns.length > 0) {
+            debug$i(`Convo failed with error "${err.message || JSON.stringify(err)}". Retry 'disabled' (remaining (#${retryRemaining}/${retryHelper.retrySettings.retries}), criterion does not match)`);
+          }
+
+          throw err;
+        }
+      });
+    }, retryHelper.retrySettings);
+  }
+
+  async RunImpl(container) {
     const transcript = new Transcript({
       steps: [],
       attachments: [],
@@ -3598,42 +3659,6 @@ var Convo_1 = {
   ConvoStep: ConvoStep$1
 };
 
-var RetryHelper_1 = class RetryHelper {
-  constructor(caps, section) {
-    this.retrySettings = {
-      retries: caps[`RETRY_${section.toUpperCase()}_NUMRETRIES`] || 1,
-      factor: caps[`RETRY_${section.toUpperCase()}_FACTOR`] || 1,
-      minTimeout: caps[`RETRY_${section.toUpperCase()}_MINTIMEOUT`] || 1000
-    };
-    this.retryErrorPatterns = [];
-    const onErrorRegexp = caps[`RETRY_${section.toUpperCase()}_ONERROR_REGEXP`] || [];
-
-    if (onErrorRegexp) {
-      if (lodash.isArray(onErrorRegexp)) {
-        onErrorRegexp.forEach(r => {
-          if (lodash.isString(r)) this.retryErrorPatterns.push(new RegExp(r, 'i'));else this.retryErrorPatterns.push(r);
-        });
-      } else if (lodash.isString(onErrorRegexp)) {
-        this.retryErrorPatterns.push(new RegExp(onErrorRegexp, 'i'));
-      } else {
-        this.retryErrorPatterns.push(onErrorRegexp);
-      }
-    }
-  }
-
-  shouldRetry(err) {
-    if (!err || this.retryErrorPatterns.length === 0) return false;
-    const errString = util.inspect(err);
-
-    for (const re of this.retryErrorPatterns) {
-      if (errString.match(re)) return true;
-    }
-
-    return false;
-  }
-
-};
-
 const {
   toString,
   quoteRegexpString
@@ -3956,7 +3981,7 @@ var JsonToJson = {
 const {
   NodeVM
 } = vm2;
-const debug$h = debug$l('botium-core-HookUtils');
+const debug$h = debug$m('botium-core-HookUtils');
 const {
   BotiumError: BotiumError$3
 } = BotiumError_1;
@@ -4106,7 +4131,7 @@ var Script = {
   precompile: precompile$1
 };
 
-const debug$g = debug$l('botium-core-PrecompilerMarkdownRasa');
+const debug$g = debug$m('botium-core-PrecompilerMarkdownRasa');
 const htmlCommentRegexp = /(<!--.*?-->)/g;
 
 var precompile = (caps, scriptBuffer, options, filename) => {
@@ -4222,7 +4247,7 @@ var MarkdownRasa = {
   precompile: precompile
 };
 
-const debug$f = debug$l('botium-core-CapabilitiesUtils');
+const debug$f = debug$m('botium-core-CapabilitiesUtils');
 const {
   toJsonWeak
 } = Utils;
@@ -4334,7 +4359,7 @@ var CapabilitiesUtils = {
   flatCababilities: flatCababilities$1
 };
 
-const debug$e = debug$l('botium-core-Precompilers');
+const debug$e = debug$m('botium-core-Precompilers');
 const {
   isJsonObject
 } = Utils;
@@ -4484,7 +4509,7 @@ var Utterance_1 = class Utterance {
 
 };
 
-const debug$d = debug$l('botium-core-CompilerXlsx');
+const debug$d = debug$m('botium-core-CompilerXlsx');
 const {
   E_SCRIPTING_MEMORY_COLUMN_MODE
 } = Enums;
@@ -5257,7 +5282,7 @@ var CompilerTxt_1 = class CompilerTxt extends CompilerBase_1 {
 const {
   parse
 } = sync;
-const debug$c = debug$l('botium-core-CompilerCsv');
+const debug$c = debug$m('botium-core-CompilerCsv');
 const {
   Convo: Convo$3
 } = Convo_1;
@@ -5520,7 +5545,7 @@ var CompilerCsv_1 = class CompilerCsv extends CompilerBase_1 {
 
 };
 
-const debug$b = debug$l('botium-core-CompilerObject');
+const debug$b = debug$m('botium-core-CompilerObject');
 const {
   Convo: Convo$2
 } = Convo_1;
@@ -5697,7 +5722,7 @@ var CompilerJson_1 = class CompilerJson extends CompilerObjectBase_1 {
 
 };
 
-const debug$a = debug$l('botium-core-CompilerMarkdown');
+const debug$a = debug$m('botium-core-CompilerMarkdown');
 const md = new markdownIt();
 const {
   Convo: Convo$1
@@ -5828,7 +5853,7 @@ var CompilerMarkdown_1 = class CompilerMarkdown extends CompilerBase_1 {
 };
 
 promise.shim();
-const debug$9 = debug$l('botium-core-ScriptingProvider');
+const debug$9 = debug$m('botium-core-ScriptingProvider');
 const {
   Convo,
   ConvoStep
@@ -7398,7 +7423,7 @@ var NoRepo_1 = class NoRepo extends BaseRepo_1 {
 };
 
 var ProcessUtils = createCommonjsModule(function (module) {
-  const debug = debug$l('botium-core-ProcessUtils');
+  const debug = debug$m('botium-core-ProcessUtils');
   module.exports = {
     childCommandLineRun: (cmd, ignoreErrors = false, processOptions = {}) => {
       const cmdOptions = cmd.split(' ');
@@ -7450,7 +7475,7 @@ var ProcessUtils = createCommonjsModule(function (module) {
 ProcessUtils.childCommandLineRun;
 ProcessUtils.childProcessRun;
 
-const debug$8 = debug$l('botium-core-GitRepo');
+const debug$8 = debug$m('botium-core-GitRepo');
 var GitRepo_1 = class GitRepo extends BaseRepo_1 {
   Validate() {
     return super.Validate().then(() => {
@@ -7621,7 +7646,7 @@ var Queue_1 = class Queue {
 
 };
 
-const debug$7 = debug$l('botium-connector-BaseContainer');
+const debug$7 = debug$m('botium-connector-BaseContainer');
 const {
   executeHook: executeHook$1,
   getHook: getHook$1
@@ -7852,7 +7877,7 @@ var BaseContainer_1 = class BaseContainer {
 
 };
 
-const debug$6 = debug$l('botium-connector-GridContainer');
+const debug$6 = debug$m('botium-connector-GridContainer');
 var GridContainer_1 = class GridContainer extends BaseContainer_1 {
   Validate() {
     return super.Validate().then(() => {
@@ -8076,7 +8101,7 @@ var InProcessContainer_1 = class InProcessContainer extends BaseContainer_1 {
 
 };
 
-const debug$5 = debug$l('botium-core-inbound-proxy');
+const debug$5 = debug$m('botium-core-inbound-proxy');
 
 const buildRedisHandler = (redisurl, topic) => {
   const redis = new ioredis(redisurl);
@@ -8159,7 +8184,7 @@ proxy.startProxy;
 const {
   v4: uuidv4
 } = uuid;
-const debug$4 = debug$l('botium-connector-simplerest');
+const debug$4 = debug$m('botium-connector-simplerest');
 const {
   startProxy
 } = proxy;
@@ -9189,7 +9214,7 @@ var SimpleRestContainer_1 = class SimpleRestContainer {
 
 };
 
-const debug$3 = debug$l('botium-connector-PluginConnectorContainer-helper');
+const debug$3 = debug$m('botium-connector-PluginConnectorContainer-helper');
 const {
   BotiumError
 } = BotiumError_1;
@@ -9358,7 +9383,7 @@ var plugins = {
   tryLoadPlugin: tryLoadPlugin$1
 };
 
-const debug$2 = debug$l('botium-connector-PluginConnectorContainer');
+const debug$2 = debug$m('botium-connector-PluginConnectorContainer');
 const {
   tryLoadPlugin
 } = plugins;
@@ -9516,7 +9541,7 @@ var require$$2 = getCjsExportFromNamespace(_package$1);
 const {
   boolean
 } = boolean$1;
-const debug$1 = debug$l('botium-core-BotDriver');
+const debug$1 = debug$m('botium-core-BotDriver');
 const {
   version
 } = require$$2;
@@ -9885,7 +9910,7 @@ var BotDriver_1 = class BotDriver {
 
 };
 
-const debug = debug$l('botium-core-Plugins');
+const debug = debug$m('botium-core-Plugins');
 const PLUGIN_TYPE_CONNECTOR = 'PLUGIN_TYPE_CONNECTOR';
 const PLUGIN_TYPE_ASSERTER = 'PLUGIN_TYPE_ASSERTER';
 const PLUGIN_TYPE_LOGICHOOK = 'PLUGIN_TYPE_LOGICHOOK';