botium-core 1.14.3 → 1.14.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "botium-core",
-  "version": "1.14.3",
+  "version": "1.14.5",
   "description": "The Selenium for Chatbots",
   "main": "index.js",
   "module": "dist/botium-es.js",

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,11 +1,9 @@
-const _ = require('lodash')
-
 const Capabilities = require('../Capabilities')
 const Constants = require('./Constants')
 const CompilerBase = require('./CompilerBase')
 const Utterance = require('./Utterance')
 const { ConvoHeader, Convo } = require('./Convo')
-const { linesToConvoStep, convoStepToLines, validateConvo, validSenders, linesToScriptingMemories } = require('./helper')
+const { linesToConvoStep, convoStepToLines, validateConvo, validSenders, linesToScriptingMemories, trimExceptSpaceEnd } = require('./helper')
 
 module.exports = class CompilerTxt extends CompilerBase {
   constructor (context, caps = {}) {
@@ -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()
 
@@ -123,7 +120,7 @@ module.exports = class CompilerTxt extends CompilerBase {
 
   _compileUtterances (lines) {
     if (lines && lines.length > 0) {
-      const result = [new Utterance({ name: lines[0], utterances: lines.length > 1 ? lines.slice(1) : [] })]
+      const result = [new Utterance({ name: lines[0].trim(), utterances: lines.length > 1 ? lines.slice(1).map(line => trimExceptSpaceEnd(line)) : [] })]
       this.context.AddUtterances(result)
       return result
     }

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/ScriptingProvider.js

@@ -130,19 +130,20 @@ module.exports = class ScriptingProvider {
       resolveUtterance: ({ utterance, resolveEmptyIfUnknown }) => {
         return this._resolveUtterance({ utterance, resolveEmptyIfUnknown })
       },
-      assertBotResponse: (botresponse, tomatch, stepTag, meMsg, convoStepParameters) => {
+      assertBotResponse: (botresponse, tomatch, stepTag, meMsg, convoStepParameters = {}) => {
         if (!_.isArray(tomatch)) {
           tomatch = [tomatch]
         }
         debug(`assertBotResponse ${stepTag} ${meMsg ? `(${meMsg}) ` : ''}BOT: ${botresponse} = ${tomatch} ...`)
         const matchFn = convoStepParameters.matchingMode ? (getMatchFunction(convoStepParameters.matchingMode) || this.matchFn) : this.matchFn
-        const found = _.find(tomatch, (utt) => matchFn(botresponse, utt, this.caps[Capabilities.SCRIPTING_MATCHING_MODE_ARGS]))
+        const found = _.find(tomatch, (utt) => matchFn(botresponse, utt, this.caps[Capabilities.SCRIPTING_MATCHING_MODE_ARGS], convoStepParameters))
         const asserterType = this.caps[Capabilities.SCRIPTING_MATCHING_MODE] === 'wer' ? 'Word Error Rate Asserter' : 'Text Match Asserter'
         if (_.isNil(found)) {
-          if (this.caps[Capabilities.SCRIPTING_MATCHING_MODE] === 'wer') {
+          const matchingMode = convoStepParameters.matchingMode || this.caps[Capabilities.SCRIPTING_MATCHING_MODE]
+          if (matchingMode === 'wer') {
             const wer = calculateWer(botresponse, tomatch[0])
             const werArgs = this.caps[Capabilities.SCRIPTING_MATCHING_MODE_ARGS]
-            const threshold = ([',', '.'].find(p => `${werArgs[0]}`.includes(p)) ? parseFloat(werArgs[0]) : parseInt(werArgs[0]) / 100)
+            const threshold = !_.isNil(convoStepParameters.matchingModeWer) ? (convoStepParameters.matchingModeWer / 100) : ([',', '.'].find(p => `${werArgs[0]}`.includes(p)) ? parseFloat(werArgs[0]) : parseInt(werArgs[0]) / 100)
             const message = `${stepTag}: Word Error Rate (${toPercent(wer)}) higher than accepted (${toPercent(threshold)})`
             throw new BotiumError(
               message,
@@ -150,7 +151,7 @@ module.exports = class ScriptingProvider {
                 type: 'asserter',
                 source: asserterType,
                 params: {
-                  matchingMode: this.caps[Capabilities.SCRIPTING_MATCHING_MODE],
+                  matchingMode,
                   args: this.caps[Capabilities.SCRIPTING_MATCHING_MODE_ARGS] || null
                 },
                 context: {
@@ -192,19 +193,20 @@ module.exports = class ScriptingProvider {
           }
         }
       },
-      assertBotNotResponse: (botresponse, nottomatch, stepTag, meMsg, convoStepParameters) => {
+      assertBotNotResponse: (botresponse, nottomatch, stepTag, meMsg, convoStepParameters = {}) => {
         if (!_.isArray(nottomatch)) {
           nottomatch = [nottomatch]
         }
         debug(`assertBotNotResponse ${stepTag} ${meMsg ? `(${meMsg}) ` : ''}BOT: ${botresponse} != ${nottomatch} ...`)
         const matchFn = convoStepParameters.matchingMode ? (getMatchFunction(convoStepParameters.matchingMode) || this.matchFn) : this.matchFn
-        const found = _.find(nottomatch, (utt) => matchFn(botresponse, utt, this.caps[Capabilities.SCRIPTING_MATCHING_MODE_ARGS]))
+        const found = _.find(nottomatch, (utt) => matchFn(botresponse, utt, this.caps[Capabilities.SCRIPTING_MATCHING_MODE_ARGS], convoStepParameters))
         const asserterType = this.caps[Capabilities.SCRIPTING_MATCHING_MODE] === 'wer' ? 'Word Error Rate Asserter' : 'Text Match Asserter'
         if (!_.isNil(found)) {
-          if (this.caps[Capabilities.SCRIPTING_MATCHING_MODE] === 'wer') {
+          const matchingMode = convoStepParameters.matchingMode || this.caps[Capabilities.SCRIPTING_MATCHING_MODE]
+          if (matchingMode === 'wer') {
             const wer = calculateWer(botresponse, nottomatch[0])
             const werArgs = this.caps[Capabilities.SCRIPTING_MATCHING_MODE_ARGS]
-            const threshold = ([',', '.'].find(p => `${werArgs[0]}`.includes(p)) ? parseFloat(werArgs[0]) : parseInt(werArgs[0]) / 100)
+            const threshold = !_.isNil(convoStepParameters.matchingModeWer) ? (convoStepParameters.matchingModeWer / 100) : ([',', '.'].find(p => `${werArgs[0]}`.includes(p)) ? parseFloat(werArgs[0]) : parseInt(werArgs[0]) / 100)
             const message = `${stepTag}: Word Error Rate (${toPercent(wer)}) lower than accepted (${toPercent(threshold)})`
             throw new BotiumError(
               message,
@@ -212,7 +214,7 @@ module.exports = class ScriptingProvider {
                 type: 'asserter',
                 source: asserterType,
                 params: {
-                  matchingMode: this.caps[Capabilities.SCRIPTING_MATCHING_MODE],
+                  matchingMode,
                   args: this.caps[Capabilities.SCRIPTING_MATCHING_MODE_ARGS] || null
                 },
                 context: {
@@ -1305,17 +1307,18 @@ module.exports = class ScriptingProvider {
     }
     if (utterances) {
       _.forEach(utterances, (utt) => {
-        const eu = this.utterances[utt.name]
+        const uttName = utt.name?.trim()
+        const eu = this.utterances[uttName]
         if (eu) {
           eu.utterances = _.uniq(_.concat(eu.utterances, utt.utterances))
         } else {
-          this.utterances[utt.name] = utt
+          this.utterances[uttName] = utt
         }
 
-        const { ambiguous, expected } = findAmbiguous(this.utterances[utt.name].utterances)
+        const { ambiguous, expected } = findAmbiguous(this.utterances[uttName].utterances)
 
         if (ambiguous && ambiguous.length > 0) {
-          debug(`Ambigous utterance "${utt.name}", expecting exact ${expected.length ? ('"' + expected.join(', ') + '"') : '<none>'} scripting memory variables in following user examples: ${ambiguous.map(d => `"${d}"`).join(', ')}`)
+          debug(`Ambigous utterance "${uttName}", expecting exact ${expected.length ? ('"' + expected.join(', ') + '"') : '<none>'} scripting memory variables in following user examples: ${ambiguous.map(d => `"${d}"`).join(', ')}`)
         }
       })
     }

package/src/scripting/helper.js

@@ -4,6 +4,7 @@ const speechScorer = require('word-error-rate')
 const debug = require('debug')('botium-core-scripting-helper')
 
 const { E_SCRIPTING_MEMORY_COLUMN_MODE } = require('../Enums')
+const WHITE_SPACES_EXCEPT_SPACE_CHAR_AT_THE_END = /[\n\t\r]+$/
 
 const normalizeText = (str, doCleanup) => {
   if (str && _.isArray(str)) {
@@ -247,7 +248,7 @@ const linesToConvoStep = (lines, sender, context, eol, singleLineMode = false) =
         if (eol === null) {
           throw new Error('eol cant be null')
         }
-        convoStep.messageText = textLines.join(eol).trim()
+        convoStep.messageText = trimExceptSpaceEnd(textLines.join(eol))
       }
     }
   } else {
@@ -270,6 +271,10 @@ const linesToConvoStep = (lines, sender, context, eol, singleLineMode = false) =
   return convoStep
 }
 
+const trimExceptSpaceEnd = (string) => {
+  return string?.replace(WHITE_SPACES_EXCEPT_SPACE_CHAR_AT_THE_END, '')
+}
+
 const convoStepToObject = (step) => {
   const result = []
   if (step.sender === 'me') {
@@ -473,7 +478,7 @@ const convoStepToLines = (step) => {
       lines.push(logicHook.name + _formatAppendArgs(logicHook.args))
     })
   }
-  return lines.map(l => l.trim())
+  return lines
 }
 
 const linesToScriptingMemories = (lines, columnMode = null) => {
@@ -607,5 +612,6 @@ module.exports = {
   validateConvo,
   linesToScriptingMemories,
   calculateWer,
-  toPercent
+  toPercent,
+  trimExceptSpaceEnd
 }

package/test/compiler/compilermarkdown.spec.js

@@ -161,7 +161,7 @@ describe('compiler.compilermarkdown', function () {
       const compiler = new Compiler(context, Object.assign({}, DefaultCapabilities, caps))
 
       compiler.Compile(scriptBuffer, 'SCRIPTING_TYPE_CONVO')
-      assert.equal(context.convos[0].conversation[1].messageText, 'hello meat bag \n!hello2')
+      assert.equal(context.convos[0].conversation[1].messageText, 'hello meat bag\n!hello2')
       assert.equal(context.convos[0].conversation[1].not, true)
     })
   })
@@ -191,7 +191,7 @@ describe('compiler.compilermarkdown', function () {
         compiler.Compile(scriptBuffer, 'SCRIPTING_TYPE_CONVO')
         assert.fail('expected error')
       } catch (err) {
-        assert.equal(err.message, 'Failed to parse conversation. All element in convo step has to be optional or not optional: ["?hello meat bag ","BUTTONS checkbutton|checkbutton2 "]')
+        assert.equal(err.message, 'Failed to parse conversation. All element in convo step has to be optional or not optional: ["?hello meat bag","BUTTONS checkbutton|checkbutton2"]')
       }
     })
     it('should read ?? as ?', async function () {
@@ -225,7 +225,7 @@ describe('compiler.compilermarkdown', function () {
       const compiler = new Compiler(context, Object.assign({}, DefaultCapabilities, caps))
 
       compiler.Compile(scriptBuffer, 'SCRIPTING_TYPE_CONVO')
-      assert.equal(context.convos[0].conversation[1].messageText, 'hello meat bag \n?hello2')
+      assert.equal(context.convos[0].conversation[1].messageText, 'hello meat bag\n?hello2')
       assert.equal(context.convos[0].conversation[1].optional, true)
     })
   })

package/test/compiler/compilertxt.spec.js

@@ -236,7 +236,7 @@ describe('compiler.compilertxt', function () {
     assert.equal(convo.conversation.length, 2)
     assert.equal(convo.conversation[0].messageText, '')
     assert.equal(convo.conversation[0].logicHooks.length, 0)
-    assert.equal(convo.conversation[1].messageText, 'Hi')
+    assert.equal(convo.conversation[1].messageText, 'Hi ')
   })
   it('should read nothing if there is nothing (even no separator)', async function () {
     const scriptBuffer = fs.readFileSync(path.resolve(__dirname, CONVOS_DIR, 'convos_emptyrow_no_separator_row.convo.txt'))

package/test/compiler/convos/txt/convos_emptyrow_just_emptyrow.convo.txt

@@ -2,6 +2,6 @@
 
 
 #bot
-Hi
+Hi 
 
 

package/test/scripting/asserters/convoStepParameters.spec.js

@@ -64,6 +64,17 @@ describe('scripting.asserters.convoStepParametersForAssert', function () {
         assert.isTrue(err.message.indexOf('"You said Hello" expected to match "Hello"') >= 0)
       }
     })
+    it('should not accept bad chatbot response on exact match defined on step even with WER asserter', async function () {
+      this.compiler.ReadScript(path.resolve(__dirname, 'convos'), 'convo_step_parameter_matchmode_failed_wer.convo.txt')
+      assert.equal(this.compiler.convos.length, 1)
+
+      try {
+        await this.compiler.convos[0].Run(this.container)
+        assert.fail('should have failed')
+      } catch (err) {
+        assert.isTrue(err.message.indexOf('Word Error Rate (50%) higher than accepted (25%)') >= 0)
+      }
+    })
   })
 
   describe('scripting.asserters.convoStepParametersForAssert.retry', function () {

package/test/scripting/asserters/convos/convo_step_parameter_matchmode_failed_wer.convo.txt

@@ -0,0 +1,9 @@
+convo_step_parameter_matchmode_failed_wer
+
+#me
+Hello1
+
+#bot
+You said Hello1 Hello2 Hello3 Hello4
+CONVO_STEP_PARAMETERS {"matchingMode":"wer","matchingModeWer":25}
+

package/test/scripting/logichooks/convos/scripting_memory_overwrite_and_check.convo.txt

@@ -7,7 +7,7 @@ this is a variable: VARVALUE1
 this is a variable: $myvar
 
 #me
-this is a variable: VARVALUE2 
+this is a variable: VARVALUE2
 
 #bot
-this is a variable: $myvar
+this is a variable: $myvar