botium-core 1.13.0 → 1.13.1

package/dist/botium-cjs.js

@@ -14,7 +14,7 @@ var randomatic = require('randomatic');
 var lodash = require('lodash');
 var boolean$1 = require('boolean');
 var events = require('events');
-var debug$l = require('debug');
+var debug$m = require('debug');
 var vm2 = require('vm2');
 var isClass = require('is-class');
 var crypto = require('crypto');
@@ -53,7 +53,7 @@ var randomatic__default = /*#__PURE__*/_interopDefaultLegacy(randomatic);
 var lodash__default = /*#__PURE__*/_interopDefaultLegacy(lodash);
 var boolean__default = /*#__PURE__*/_interopDefaultLegacy(boolean$1);
 var events__default = /*#__PURE__*/_interopDefaultLegacy(events);
-var debug__default = /*#__PURE__*/_interopDefaultLegacy(debug$l);
+var debug__default = /*#__PURE__*/_interopDefaultLegacy(debug$m);
 var vm2__default = /*#__PURE__*/_interopDefaultLegacy(vm2);
 var isClass__default = /*#__PURE__*/_interopDefaultLegacy(isClass);
 var crypto__default = /*#__PURE__*/_interopDefaultLegacy(crypto);
@@ -79,7 +79,7 @@ var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
 var bodyParser__default = /*#__PURE__*/_interopDefaultLegacy(bodyParser);
 
 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$1 = "dist/botium-es.js";
@@ -111,17 +111,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",
@@ -129,7 +129,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",
@@ -144,33 +144,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",
@@ -1231,7 +1231,7 @@ LogicHookConsts.DEFAULT_USER_INPUTS;
 const {
   NodeVM: NodeVM$2
 } = vm2__default["default"];
-const debug$k = debug__default["default"]('botium-core-asserterUtils');
+const debug$l = debug__default["default"]('botium-core-asserterUtils');
 const {
   BotiumError: BotiumError$6
 } = BotiumError_1;
@@ -1296,7 +1296,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');
@@ -1310,7 +1310,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');
@@ -1324,7 +1324,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');
@@ -1467,7 +1467,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`);
@@ -1558,7 +1558,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 ...`);
@@ -2417,7 +2417,7 @@ var helper = {
   linesToScriptingMemories: linesToScriptingMemories$2
 };
 
-const debug$j = debug__default["default"]('botium-core-ScriptingMemory');
+const debug$k = debug__default["default"]('botium-core-ScriptingMemory');
 const {
   v1: uuidv1
 } = uuid__default["default"];
@@ -2675,7 +2675,7 @@ const extractVarNames = text => {
 };
 
 const fill = (container, scriptingMemory, result, utterance, scriptingEvents) => {
-  debug$j(`fill start: ${util__default["default"].inspect(scriptingMemory)}`);
+  debug$k(`fill start: ${util__default["default"].inspect(scriptingMemory)}`);
   let varRegex;
 
   switch (container.caps[Capabilities.SCRIPTING_MEMORY_MATCHING_MODE]) {
@@ -2719,14 +2719,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__default["default"].inspect(scriptingMemory)}`);
+    debug$k(`fill end: ${util__default["default"].inspect(scriptingMemory)}`);
   }
 };
 
@@ -2745,6 +2745,47 @@ ScriptingMemory.extractVarNames;
 ScriptingMemory.RESERVED_WORDS;
 ScriptingMemory.SCRIPTING_FUNCTIONS;
 
+const debug$j = debug__default["default"]('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__default["default"].isArray(onErrorRegexp)) {
+        onErrorRegexp.forEach(r => {
+          if (lodash__default["default"].isString(r)) this.retryErrorPatterns.push(new RegExp(r, 'i'));else this.retryErrorPatterns.push(r);
+        });
+      } else if (lodash__default["default"].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__default["default"].isNil(options.numRetries) ? options.numRetries : this.retryErrorPatterns.length === 0 ? 0 : 1),
+      factor: caps[`RETRY_${section.toUpperCase()}_FACTOR`] || (lodash__default["default"].isNil(options.factor) ? 1 : options.factor),
+      minTimeout: caps[`RETRY_${section.toUpperCase()}_MINTIMEOUT`] || (lodash__default["default"].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__default["default"].inspect(err);
+
+    for (const re of this.retryErrorPatterns) {
+      if (errString.match(re)) return true;
+    }
+
+    return false;
+  }
+
+};
+
 const debug$i = debug__default["default"]('botium-core-Convo');
 const {
   BotiumError: BotiumError$4,
@@ -2970,6 +3011,26 @@ class Convo$6 {
   }
 
   async Run(container) {
+    const retryHelper = new RetryHelper_1(container.caps, 'CONVO');
+    return promiseRetry__default["default"](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: [],
@@ -3641,42 +3702,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__default["default"].isArray(onErrorRegexp)) {
-        onErrorRegexp.forEach(r => {
-          if (lodash__default["default"].isString(r)) this.retryErrorPatterns.push(new RegExp(r, 'i'));else this.retryErrorPatterns.push(r);
-        });
-      } else if (lodash__default["default"].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__default["default"].inspect(err);
-
-    for (const re of this.retryErrorPatterns) {
-      if (errString.match(re)) return true;
-    }
-
-    return false;
-  }
-
-};
-
 const {
   toString,
   quoteRegexpString