botium-core 1.14.1 → 1.14.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "botium-core",
-  "version": "1.14.1",
+  "version": "1.14.4",
   "description": "The Selenium for Chatbots",
   "main": "index.js",
   "module": "dist/botium-es.js",
@@ -31,12 +31,12 @@
   },
   "homepage": "https://www.botium.ai",
   "dependencies": {
-    "@babel/runtime": "^7.23.2",
+    "@babel/runtime": "^7.23.5",
     "async": "^3.2.5",
     "body-parser": "^1.20.2",
     "boolean": "^3.2.0",
     "bottleneck": "^2.19.5",
-    "csv-parse": "^5.5.2",
+    "csv-parse": "^5.5.3",
     "debug": "^4.3.4",
     "express": "^4.18.2",
     "globby": "11.0.4",
@@ -45,7 +45,7 @@
     "is-json": "^2.0.1",
     "jsonpath": "^1.1.1",
     "lodash": "^4.17.21",
-    "markdown-it": "^13.0.2",
+    "markdown-it": "^14.0.0",
     "mime-types": "^2.1.35",
     "mkdirp": "^3.0.1",
     "moment": "^2.29.4",
@@ -71,23 +71,23 @@
     "yaml": "^2.3.4"
   },
   "devDependencies": {
-    "@babel/core": "^7.23.3",
+    "@babel/core": "^7.23.5",
     "@babel/node": "^7.22.19",
-    "@babel/plugin-transform-runtime": "^7.23.3",
-    "@babel/preset-env": "^7.23.3",
+    "@babel/plugin-transform-runtime": "^7.23.4",
+    "@babel/preset-env": "^7.23.5",
     "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
     "cross-env": "^7.0.3",
-    "eslint": "^8.53.0",
+    "eslint": "^8.55.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.29.0",
     "eslint-plugin-mocha": "^10.2.0",
-    "eslint-plugin-n": "^16.3.1",
+    "eslint-plugin-n": "^16.4.0",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-standard": "^4.1.0",
     "mocha": "^10.2.0",
-    "nock": "^13.3.8",
-    "npm-check-updates": "^16.14.6",
+    "nock": "^13.4.0",
+    "npm-check-updates": "^16.14.11",
     "nyc": "^15.1.0",
     "rollup": "2.79.1",
     "rollup-plugin-babel": "^4.4.0",

package/src/Capabilities.js

@@ -157,6 +157,8 @@ module.exports = {
   // varnames, testcasenames
   SCRIPTING_MEMORY_COLUMN_MODE: 'SCRIPTING_MEMORY_COLUMN_MODE',
   // Botium Lifecycle Hooks
+  SCRIPTING_CONVO_STEP_PARAMETERS: 'SCRIPTING_CONVO_STEP_PARAMETERS',
+  // Botium Lifecycle Hooks
   CUSTOMHOOK_ONBUILD: 'CUSTOMHOOK_ONBUILD',
   CUSTOMHOOK_ONSTART: 'CUSTOMHOOK_ONSTART',
   CUSTOMHOOK_ONUSERSAYS: 'CUSTOMHOOK_ONUSERSAYS',

package/src/scripting/BotiumError.js

@@ -90,6 +90,43 @@ const BotiumError = class BotiumError extends Error {
       return null
     }
   }
+
+  hasError ({ type, source }) {
+    if (this.context) {
+      const errArr = _.isArray(this.context) ? this.context : [this.context]
+      for (const err of errArr) {
+        if (err.type === 'list') {
+          for (const internal of err.errors) {
+            if ((!type || internal.type === type) && (!source || internal.source === source)) {
+              return true
+            }
+          }
+        }
+        if ((!type || err.type === type) && (!source || err.source === source)) {
+          return true
+        }
+      }
+    } else {
+      return false
+    }
+  }
+
+  toArray () {
+    if (this.context) {
+      let result = []
+      const errArr = _.isArray(this.context) ? this.context : [this.context]
+      for (const err of errArr) {
+        if (err.type === 'list') {
+          result = result.concat(err.errors)
+        } else {
+          result.push(err)
+        }
+      }
+      return result
+    } else {
+      return []
+    }
+  }
 }
 
 const _getChildErrorsFromContext = (context) => {
@@ -99,11 +136,11 @@ const _getChildErrorsFromContext = (context) => {
   return false
 }
 
-const botiumErrorFromErr = (message, err) => {
+const botiumErrorFromErr = (message, err, context = {}) => {
   if (err instanceof BotiumError) {
-    return new BotiumError(message, err.context, true)
+    return new BotiumError(message, { ...err.context, ...context }, true)
   } else {
-    return new BotiumError(message, { err }, true)
+    return new BotiumError(message, { err, ...context }, true)
   }
 }
 

package/src/scripting/CompilerMarkdown.js

@@ -89,7 +89,8 @@ module.exports = class CompilerMarkdown extends CompilerBase {
                   stepTag: 'Line ' + (step.map[0] + 1)
                 },
                 linesToConvoStep(step.children.map(child => child.content +
-                  (child.children ? ' ' + child.children.map(child => child.content).join('|') : '')), sender, this.context, this.eol)
+                  (child.children && child.children.length > 0 ? ' ' + child.children.map(child => child.content).join('|') : '')
+                ), sender, this.context, this.eol)
               ))
             } else {
               debug(`Expected sender ${validSenders.map(s => `'${s}'`).join(' or ')} but found ${sender}`)

package/src/scripting/CompilerTxt.js

@@ -1,5 +1,3 @@
-const _ = require('lodash')
-
 const Capabilities = require('../Capabilities')
 const Constants = require('./Constants')
 const CompilerBase = require('./CompilerBase')
@@ -37,7 +35,7 @@ module.exports = class CompilerTxt extends CompilerBase {
     let scriptData = scriptBuffer
     if (Buffer.isBuffer(scriptBuffer)) scriptData = scriptData.toString()
 
-    const lines = _.map(scriptData.split(this.eol), (line) => line.trim())
+    const lines = scriptData.split(this.eol)
 
     if (scriptType === Constants.SCRIPTING_TYPE_CONVO) {
       return this._compileConvo(lines, false)
@@ -94,7 +92,6 @@ module.exports = class CompilerTxt extends CompilerBase {
 
     lines.forEach((line) => {
       currentLineIndex++
-      line = line.trim()
       if (isValidTagLine(line)) {
         pushPrev()
 

package/src/scripting/Convo.js

@@ -277,8 +277,55 @@ class Convo {
       let skipTranscriptStep = false
       let conditionalGroupId = null
       let conditionMetInGroup = false
-      for (let i = 0; i < this.conversation.length; i++) {
+      let globalConvoStepParameters = container.caps[Capabilities.SCRIPTING_CONVO_STEP_PARAMETERS] || {}
+      let retryBotMessageTimeoutEnd = null
+      let retryBotMessageConvoId = null
+      let retryBotMessageDropBotResponse = false
+      for (let i = 0; i < this.conversation.length; i = (retryBotMessageDropBotResponse ? i : i + 1)) {
+        retryBotMessageDropBotResponse = false
         const convoStep = this.conversation[i]
+        const rawConvoStepParameters = convoStep.logicHooks.find(lh => lh.name === 'CONVO_STEP_PARAMETERS')?.args
+        let convoStepParameters = {}
+        if (rawConvoStepParameters && rawConvoStepParameters.length) {
+          let params
+          if (rawConvoStepParameters[0].trim().startsWith('{')) {
+            try {
+              params = JSON.parse(rawConvoStepParameters[0])
+            } catch (e) {
+              debug(`${this.header.name}/${convoStep.stepTag}: Failed to parse convo step parameters from JSON ${rawConvoStepParameters[0]}`)
+            }
+          }
+          if (!params || !Object.keys(params).length) {
+            params = {}
+            for (const param of rawConvoStepParameters) {
+              const semicolon = param.indexOf(':')
+              if (semicolon) {
+                try {
+                  const name = param.substring(0, semicolon)
+                  const value = param.substring(semicolon + 1)
+                  params[name] = value
+                } catch (e) {
+                  debug(`${this.header.name}/${convoStep.stepTag}: Failed to parse convo step parameter from arg ${param}`)
+                }
+              }
+            }
+          }
+
+          if (convoStep.sender === 'begin') {
+            globalConvoStepParameters = Object.assign({}, globalConvoStepParameters || {}, params)
+          } else {
+            convoStepParameters = Object.assign({}, globalConvoStepParameters || {}, params)
+          }
+        } else {
+          if (convoStep.sender !== 'begin') {
+            convoStepParameters = globalConvoStepParameters
+          }
+        }
+
+        if (Object.keys(convoStepParameters).length) {
+          debug(`${this.header.name}: using convo step parameters ${JSON.stringify(convoStepParameters)}`)
+        }
+
         const currentStepIndex = i
         container.eventEmitter.emit(Events.CONVO_STEP_NEXT, container, convoStep, i)
         skipTranscriptStep = false
@@ -319,8 +366,8 @@ class Convo {
               const coreMsg = _.omit(removeBuffers(meMsg), ['sourceData'])
               debug(`${this.header.name}/${convoStep.stepTag}: user says (cleaned by binary and base64 data and sourceData) ${JSON.stringify(coreMsg, null, 2)}`)
               await new Promise(resolve => {
-                if (container.caps.SIMULATE_WRITING_SPEED && meMsg.messageText && meMsg.messageText.length) {
-                  setTimeout(() => resolve(), container.caps.SIMULATE_WRITING_SPEED * meMsg.messageText.length)
+                if (container.caps[Capabilities.SIMULATE_WRITING_SPEED] && meMsg.messageText && meMsg.messageText.length) {
+                  setTimeout(() => resolve(), container.caps[Capabilities.SIMULATE_WRITING_SPEED] * meMsg.messageText.length)
                 } else {
                   resolve()
                 }
@@ -453,11 +500,32 @@ class Convo {
             }
             const isErrorHandledWithOptionConvoStep = (err) => {
               const nextConvoStep = this.conversation[i + 1]
+              const retryConfig = convoStepParameters?.ignoreNotMatchedBotResponses
+              const retryOn = convoStep.sender === 'bot' && retryConfig && retryConfig.timeout && retryConfig.mainAsserter
               if (convoStep.optional && nextConvoStep && nextConvoStep.sender === 'bot') {
+                if (retryOn) {
+                  debug(`${this.header.name}/${convoStep.stepTag}: Retry failed asserter is ignored on optional convo`)
+                }
                 waitForBotSays = false
                 skipTranscriptStep = true
                 return true
+              } else if (retryOn) {
+                if (!retryBotMessageTimeoutEnd || retryBotMessageConvoId !== convoStep.stepTag) {
+                  retryBotMessageTimeoutEnd = transcriptStep.stepBegin.getTime() + +retryConfig.timeout
+                  retryBotMessageConvoId = convoStep.stepTag
+                }
+
+                const now = new Date().getTime()
+                const timeoutRemaining = retryBotMessageTimeoutEnd - now
+                if (timeoutRemaining > 0) {
+                  debug(`${this.header.name}/${convoStep.stepTag}: Convo step retry on, timeout remaining: ${timeoutRemaining}, error: "${err.message}"`)
+                  retryBotMessageDropBotResponse = true
+                  return false
+                } else {
+                  debug(`${this.header.name}/${convoStep.stepTag}: Convo step retry on, but timeout is over. error: "${err.message}"`)
+                }
               }
+
               if (container.caps[Capabilities.SCRIPTING_ENABLE_MULTIPLE_ASSERT_ERRORS]) {
                 assertErrors.push(err)
                 return false
@@ -474,7 +542,7 @@ class Convo {
               const tomatch = this._resolveUtterancesToMatch(container, Object.assign({}, scriptingMemoryUpdate, scriptingMemory), messageText, botMsg)
               if (convoStep.not) {
                 try {
-                  this.scriptingEvents.assertBotNotResponse(response, tomatch, `${this.header.name}/${convoStep.stepTag}`, lastMeConvoStep)
+                  this.scriptingEvents.assertBotNotResponse(response, tomatch, `${this.header.name}/${convoStep.stepTag}`, lastMeConvoStep, convoStepParameters)
                 } catch (err) {
                   if (isErrorHandledWithOptionConvoStep(err)) {
                     continue
@@ -482,7 +550,7 @@ class Convo {
                 }
               } else {
                 try {
-                  this.scriptingEvents.assertBotResponse(response, tomatch, `${this.header.name}/${convoStep.stepTag}`, lastMeConvoStep)
+                  this.scriptingEvents.assertBotResponse(response, tomatch, `${this.header.name}/${convoStep.stepTag}`, lastMeConvoStep, convoStepParameters)
                 } catch (err) {
                   if (isErrorHandledWithOptionConvoStep(err)) {
                     continue
@@ -491,7 +559,7 @@ class Convo {
               }
             } else if (convoStep.sourceData) {
               try {
-                this._compareObject(container, scriptingMemory, convoStep, botMsg.sourceData, convoStep.sourceData, botMsg)
+                this._compareObject(container, scriptingMemory, convoStep, botMsg.sourceData, convoStep.sourceData, botMsg, convoStepParameters)
               } catch (err) {
                 if (isErrorHandledWithOptionConvoStep(err)) {
                   continue
@@ -509,20 +577,46 @@ class Convo {
                 skipTranscriptStep = true
                 continue
               }
-              const failErr = botiumErrorFromErr(`${this.header.name}/${convoStep.stepTag}: assertion error - ${err.message || err}`, err)
-              debug(failErr)
-              try {
-                this.scriptingEvents.fail && this.scriptingEvents.fail(failErr, lastMeConvoStep)
-              } catch (failErr) {
+
+              const errors = err.toArray ? err.toArray() : []
+              const retryConfig = convoStepParameters?.ignoreNotMatchedBotResponses
+              const retryOn =
+                convoStep.sender === 'bot' &&
+                retryConfig &&
+                retryConfig.timeout &&
+                errors.length &&
+                errors.filter(({ type, source, asserter }) => type === 'asserter' && (retryConfig.allAsserters || (retryConfig.asserters && retryConfig.asserters.includes(asserter)))).length
+              if (retryOn && (!retryBotMessageTimeoutEnd || retryBotMessageConvoId !== convoStep.stepTag)) {
+                retryBotMessageTimeoutEnd = transcriptStep.stepBegin.getTime() + +retryConfig.timeout
+                retryBotMessageConvoId = convoStep.stepTag
               }
-              if (container.caps[Capabilities.SCRIPTING_ENABLE_MULTIPLE_ASSERT_ERRORS] && err instanceof BotiumError) {
-                assertErrors.push(err)
+
+              const now = new Date().getTime()
+              const timeoutRemaining = retryOn && (retryBotMessageTimeoutEnd - now)
+              if (retryOn && timeoutRemaining > 0) {
+                debug(`${this.header.name}/${convoStep.stepTag}: Convo step retry on, timeout remaining: ${timeoutRemaining}, error: "${err.message}"`)
+                retryBotMessageDropBotResponse = true
               } else {
-                throw failErr
+                if (retryOn && timeoutRemaining <= 0) {
+                  debug(`${this.header.name}/${convoStep.stepTag}: Convo step retry on, but timeout is over. error: "${err.message}"`)
+                }
+                const failErr = botiumErrorFromErr(`${this.header.name}/${convoStep.stepTag}: assertion error - ${err.message || err}`, err)
+                debug(failErr)
+                try {
+                  this.scriptingEvents.fail && this.scriptingEvents.fail(failErr, lastMeConvoStep)
+                } catch (failErr) {
+                }
+                if (container.caps[Capabilities.SCRIPTING_ENABLE_MULTIPLE_ASSERT_ERRORS] && err instanceof BotiumError) {
+                  assertErrors.push(err)
+                } else {
+                  throw failErr
+                }
               }
             }
             if (container.caps[Capabilities.SCRIPTING_ENABLE_MULTIPLE_ASSERT_ERRORS]) {
               if (assertErrors.length > 0) {
+                // this has no effect, but logically it has to be false
+                retryBotMessageDropBotResponse = false
                 throw botiumErrorFromList(assertErrors, {})
               }
             } else {
@@ -580,7 +674,7 @@ class Convo {
     }
   }
 
-  _compareObject (container, scriptingMemory, convoStep, result, expected, botMsg) {
+  _compareObject (container, scriptingMemory, convoStep, result, expected, botMsg, convoStepParameters) {
     if (expected === null || expected === undefined) return
 
     if (_.isArray(expected)) {
@@ -591,12 +685,12 @@ class Convo {
         throw new BotiumError(`${this.header.name}/${convoStep.stepTag}: bot response expected array length ${expected.length}, got ${result.length}`)
       }
       for (let i = 0; i < expected.length; i++) {
-        this._compareObject(container, scriptingMemory, convoStep, result[i], expected[i])
+        this._compareObject(container, scriptingMemory, convoStep, result[i], expected[i], null, convoStepParameters)
       }
     } else if (_.isObject(expected)) {
       _.forOwn(expected, (value, key) => {
         if (Object.prototype.hasOwnProperty.call(result, key)) {
-          this._compareObject(container, scriptingMemory, convoStep, result[key], expected[key])
+          this._compareObject(container, scriptingMemory, convoStep, result[key], expected[key], null, convoStepParameters)
         } else {
           throw new BotiumError(`${this.header.name}/${convoStep.stepTag}: bot response "${result}" missing expected property: ${key}`)
         }
@@ -605,7 +699,7 @@ class Convo {
       ScriptingMemory.fill(container, scriptingMemory, result, expected, this.scriptingEvents)
       const response = this._checkNormalizeText(container, result)
       const tomatch = this._resolveUtterancesToMatch(container, scriptingMemory, expected, botMsg)
-      this.scriptingEvents.assertBotResponse(response, tomatch, `${this.header.name}/${convoStep.stepTag}`)
+      this.scriptingEvents.assertBotResponse(response, tomatch, `${this.header.name}/${convoStep.stepTag}`, null, convoStepParameters)
     }
   }
 
@@ -673,7 +767,7 @@ class Convo {
   }
 
   _checkBotRepliesConsumed (container) {
-    if (container.caps.SCRIPTING_FORCE_BOT_CONSUMED) {
+    if (container.caps[Capabilities.SCRIPTING_FORCE_BOT_CONSUMED]) {
       const queueLength = container._QueueLength()
       if (queueLength === 1) {
         throw new Error('There is an unread bot reply in queue')

package/src/scripting/MatchFunctions.js

@@ -1,8 +1,12 @@
 const _ = require('lodash')
+const debug = require('debug')('botium-core-MatchFunctions')
 
 const { toString, quoteRegexpString, calculateWer } = require('./helper')
 
-const _normalize = (botresponse) => {
+const _normalize = (botresponse, args, convoStepParameters) => {
+  if (!convoStepParameters) {
+    debug('Convo step parameters might be missing!')
+  }
   if (_.isUndefined(botresponse) || _.isNil(botresponse)) return ''
   if (_.isObject(botresponse) && _.has(botresponse, 'messageText')) {
     return toString(botresponse.messageText) || ''
@@ -10,7 +14,10 @@ const _normalize = (botresponse) => {
   return toString(botresponse)
 }
 
-const regexp = (ignoreCase) => (botresponse, utterance) => {
+const regexp = (ignoreCase) => (botresponse, utterance, args, convoStepParameters) => {
+  if (!convoStepParameters) {
+    debug('Convo step parameters might be missing!')
+  }
   if (_.isUndefined(botresponse)) return false
   utterance = toString(utterance)
   botresponse = _normalize(botresponse)
@@ -19,7 +26,10 @@ const regexp = (ignoreCase) => (botresponse, utterance) => {
   return regexp.test(botresponse)
 }
 
-const wildcard = (ignoreCase) => (botresponse, utterance) => {
+const wildcard = (ignoreCase) => (botresponse, utterance, args, convoStepParameters) => {
+  if (!convoStepParameters) {
+    debug('Convo step parameters might be missing!')
+  }
   if (_.isUndefined(botresponse)) {
     if (utterance.trim() === '*') return true
     else return false
@@ -37,7 +47,10 @@ const wildcard = (ignoreCase) => (botresponse, utterance) => {
   return regexp.test(botresponse)
 }
 
-const wildcardExact = (ignoreCase) => (botresponse, utterance) => {
+const wildcardExact = (ignoreCase) => (botresponse, utterance, args, convoStepParameters) => {
+  if (!convoStepParameters) {
+    debug('Convo step parameters might be missing!')
+  }
   if (_.isUndefined(botresponse)) {
     if (utterance.trim() === '*') return true
     else return false
@@ -55,7 +68,10 @@ const wildcardExact = (ignoreCase) => (botresponse, utterance) => {
   return regexp.test(botresponse)
 }
 
-const include = (ignoreCase) => (botresponse, utterance) => {
+const include = (ignoreCase) => (botresponse, utterance, args, convoStepParameters) => {
+  if (!convoStepParameters) {
+    debug('Convo step parameters might be missing!')
+  }
   if (_.isUndefined(botresponse)) return false
   utterance = toString(utterance)
   botresponse = _normalize(botresponse)
@@ -67,7 +83,10 @@ const include = (ignoreCase) => (botresponse, utterance) => {
   return botresponse.indexOf(utterance) >= 0
 }
 
-const equals = (ignoreCase) => (botresponse, utterance) => {
+const equals = (ignoreCase) => (botresponse, utterance, args, convoStepParameters) => {
+  if (!convoStepParameters) {
+    debug('Convo step parameters might be missing!')
+  }
   if (_.isUndefined(botresponse)) return false
   utterance = toString(utterance)
   botresponse = _normalize(botresponse)
@@ -79,11 +98,14 @@ const equals = (ignoreCase) => (botresponse, utterance) => {
   return botresponse === utterance
 }
 
-const wer = () => (botresponse, utterance, args) => {
+const wer = () => (botresponse, utterance, args, convoStepParameters) => {
+  if (!convoStepParameters) {
+    debug('Convo step parameters might be missing!')
+  }
   botresponse = _normalize(botresponse || '')
   utterance = toString(utterance || '')
 
-  const threshold = ([',', '.'].find(p => `${args[0]}`.includes(p)) ? parseFloat(args[0]) : parseInt(args[0]) / 100)
+  const threshold = !_.isNil(convoStepParameters?.matchingModeWer) ? (convoStepParameters?.matchingModeWer / 100) : ([',', '.'].find(p => `${args[0]}`.includes(p)) ? parseFloat(args[0]) : parseInt(args[0]) / 100)
   return calculateWer(botresponse, utterance) <= threshold
 }
 

package/src/scripting/ScriptingMemory.js

@@ -261,6 +261,13 @@ const _apply = (scriptingMemory, str, caps, mockMsg) => {
                 return arg
               }
             })
+            args = args.map(arg => {
+              const argStr = `${arg}`
+              if (argStr.startsWith('$')) {
+                return scriptingMemory[argStr.substring(1)] || arg
+              }
+              return arg
+            })
             str = str.replace(match, SCRIPTING_FUNCTIONS[key].handler(caps, ...args, mockMsg))
           } else {
             str = str.replace(match, SCRIPTING_FUNCTIONS[key].handler(caps))