botium-core 1.14.0 → 1.14.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "botium-core",
-  "version": "1.14.0",
+  "version": "1.14.1",
   "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.22.15",
-    "async": "^3.2.4",
+    "@babel/runtime": "^7.23.2",
+    "async": "^3.2.5",
     "body-parser": "^1.20.2",
     "boolean": "^3.2.0",
     "bottleneck": "^2.19.5",
-    "csv-parse": "^5.5.0",
+    "csv-parse": "^5.5.2",
     "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.1",
+    "markdown-it": "^13.0.2",
     "mime-types": "^2.1.35",
     "mkdirp": "^3.0.1",
     "moment": "^2.29.4",
@@ -55,7 +55,7 @@
     "promise.allsettled": "^1.0.7",
     "randomatic": "^3.1.1",
     "request": "^2.88.2",
-    "rimraf": "^5.0.1",
+    "rimraf": "^5.0.5",
     "sanitize-filename": "^1.6.3",
     "slugify": "^1.6.6",
     "socket.io": "^4.7.2",
@@ -63,31 +63,31 @@
     "socketio-auth": "^0.1.1",
     "swagger-jsdoc": "^6.2.8",
     "swagger-ui-express": "^5.0.0",
-    "uuid": "^9.0.0",
+    "uuid": "^9.0.1",
     "word-error-rate": "0.0.7",
     "write-yaml": "^1.0.0",
     "xlsx": "^0.18.5",
     "xregexp": "^5.1.1",
-    "yaml": "^2.3.2"
+    "yaml": "^2.3.4"
   },
   "devDependencies": {
-    "@babel/core": "^7.22.17",
-    "@babel/node": "^7.22.15",
-    "@babel/plugin-transform-runtime": "^7.22.15",
-    "@babel/preset-env": "^7.22.15",
-    "chai": "^4.3.8",
+    "@babel/core": "^7.23.3",
+    "@babel/node": "^7.22.19",
+    "@babel/plugin-transform-runtime": "^7.23.3",
+    "@babel/preset-env": "^7.23.3",
+    "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
     "cross-env": "^7.0.3",
-    "eslint": "^8.49.0",
+    "eslint": "^8.53.0",
     "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-mocha": "^10.1.0",
-    "eslint-plugin-n": "^16.1.0",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-mocha": "^10.2.0",
+    "eslint-plugin-n": "^16.3.1",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-standard": "^4.1.0",
     "mocha": "^10.2.0",
-    "nock": "^13.3.3",
-    "npm-check-updates": "^16.13.3",
+    "nock": "^13.3.8",
+    "npm-check-updates": "^16.14.6",
     "nyc": "^15.1.0",
     "rollup": "2.79.1",
     "rollup-plugin-babel": "^4.4.0",

package/src/scripting/Convo.js

@@ -275,6 +275,8 @@ class Convo {
       let botMsg = null
       let waitForBotSays = true
       let skipTranscriptStep = false
+      let conditionalGroupId = null
+      let conditionMetInGroup = false
       for (let i = 0; i < this.conversation.length; i++) {
         const convoStep = this.conversation[i]
         const currentStepIndex = i
@@ -356,7 +358,6 @@ class Convo {
               throw failErr
             }
           } else if (convoStep.sender === 'bot') {
-            const previousWaitForBotSays = waitForBotSays
             if (waitForBotSays) {
               botMsg = null
             } else {
@@ -406,22 +407,38 @@ class Convo {
             }
 
             if (convoStep.conditional) {
+              waitForBotSays = false
+              let endOfConditionalGroup = false
+              conditionalGroupId = convoStep.logicHooks.find(lh => lh.name.startsWith('CONDITIONAL_STEP')).args[1]
               const nextConvoStep = this.conversation[i + 1]
 
-              if (!previousWaitForBotSays) {
-                skipTranscriptStep = true
-              }
-              waitForBotSays = false
               if (!nextConvoStep || nextConvoStep.sender !== 'bot' || !nextConvoStep.logicHooks || !nextConvoStep.logicHooks.some(lh => lh.name.toUpperCase().startsWith('CONDITIONAL_STEP'))) {
-                waitForBotSays = true
+                endOfConditionalGroup = true
               } else {
-                const conditionalLogicHook = convoStep.logicHooks.find(lh => lh.name.startsWith('CONDITIONAL_STEP'))
                 const nextConditionalLogicHook = nextConvoStep.logicHooks.find(lh => lh.name.startsWith('CONDITIONAL_STEP'))
-                waitForBotSays = conditionalLogicHook.args[1] !== nextConditionalLogicHook.args[1]
+                endOfConditionalGroup = conditionalGroupId !== nextConditionalLogicHook.args[1]
               }
 
-              if (convoStep.conditional.skip) {
+              if (convoStep.conditional.skip || conditionMetInGroup) {
+                skipTranscriptStep = true
+                if (endOfConditionalGroup && !conditionMetInGroup && !convoStep.optional) {
+                  const failErr = new BotiumError(`${this.header.name}/${convoStep.stepTag}: Non of the conditions are met in ${conditionalGroupId ? `'${conditionalGroupId}' ` : ''}condition group`)
+                  debug(failErr)
+                  throw failErr
+                }
+                if (endOfConditionalGroup) {
+                  waitForBotSays = !convoStep.optional
+                  conditionalGroupId = undefined
+                  conditionMetInGroup = false
+                }
                 continue
+              } else {
+                conditionMetInGroup = true
+                if (endOfConditionalGroup) {
+                  waitForBotSays = !convoStep.optional
+                  conditionalGroupId = undefined
+                  conditionMetInGroup = false
+                }
               }
             }
 

package/src/scripting/logichook/logichooks/ConditionalBusinessHoursLogicHook.js

@@ -51,6 +51,6 @@ module.exports = class ConditionalBusinessHoursLogicHook {
     }
     params.now = moment()
     convoStep.conditional.skip = !this._isBetween(params)
-    debug(`ConditionalBusinessHoursLogicHook onBotPrepare ${convo.header.name}/${convoStep.stepTag}, args: ${util.inspect(args)}, convoStep.conditional: ${convoStep.conditional}`)
+    debug(`ConditionalBusinessHoursLogicHook onBotPrepare ${convo.header.name}/${convoStep.stepTag}, args: ${util.inspect(args)}, convoStep.conditional: ${util.inspect(convoStep.conditional)}`)
   }
 }

package/src/scripting/logichook/logichooks/ConditionalCapabilityValueBasedLogicHook.js

@@ -32,6 +32,6 @@ module.exports = class ConditionalCapabilityValueBasedLogicHook {
       conditionGroupId
     }
     convoStep.conditional.skip = !this._isCapabilityValueEqual(params)
-    debug(`ConditionalCapabilityValueBasedLogicHook onBotPrepare ${convo.header.name}/${convoStep.stepTag}, args: ${util.inspect(args)}, convoStep.conditional: ${convoStep.conditional}`)
+    debug(`ConditionalCapabilityValueBasedLogicHook onBotPrepare ${convo.header.name}/${convoStep.stepTag}, args: ${util.inspect(args)}, convoStep.conditional: ${util.inspect(convoStep.conditional)}`)
   }
 }

package/src/scripting/logichook/logichooks/ConditionalJsonPathBasedLogicHook.js

@@ -26,6 +26,6 @@ module.exports = class ConditionalJsonPathBasedLogicHook {
       skip = !(values && values.length > 0 && values.includes(params.value))
     }
     convoStep.conditional.skip = skip
-    debug(`ConditionalJsonPathBasedLogicHook onBotPrepare ${convo.header.name}/${convoStep.stepTag}, args: ${util.inspect(args)}, convoStep.conditional: ${convoStep.conditional}`)
+    debug(`ConditionalJsonPathBasedLogicHook onBotPrepare ${convo.header.name}/${convoStep.stepTag}, args: ${util.inspect(args)}, convoStep.conditional: ${util.inspect(convoStep.conditional)}`)
   }
 }

package/src/scripting/logichook/logichooks/ConditionalTimeBasedLogicHook.js

@@ -41,6 +41,6 @@ module.exports = class ConditionalTimeBasedLogicHook {
     }
     params.now = moment()
     convoStep.conditional.skip = !this._isBetween(params)
-    debug(`ConditionalTimeBasedLogicHook onBotPrepare ${convo.header.name}/${convoStep.stepTag}, args: ${util.inspect(args)}, convoStep.conditional: ${convoStep.conditional}`)
+    debug(`ConditionalTimeBasedLogicHook onBotPrepare ${convo.header.name}/${convoStep.stepTag}, args: ${util.inspect(args)}, convoStep.conditional: ${util.inspect(convoStep.conditional)}`)
   }
 }

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

@@ -4,17 +4,17 @@ custom embedded
 hello
 
 #bot
-hello should not assert
-CONDITIONAL_STEP_LOGIC_HOOK { "skip":true }|G1
+hello
+CONDITIONAL_STEP_LOGIC_HOOK { "skip":false }|G1
 
 #bot
 hello should not assert
-CONDITIONAL_STEP_LOGIC_HOOK { "skip":true }|G1
+CONDITIONAL_STEP_LOGIC_HOOK { "skip":false }|G1
 
 #bot
-hello should not assert
-CONDITIONAL_STEP_LOGIC_HOOK { "skip":true }|G2
+hello
+CONDITIONAL_STEP_LOGIC_HOOK { "skip":false }|G2
 
 #bot
 hello should not assert
-CONDITIONAL_STEP_LOGIC_HOOK { "skip":true }|G2
+CONDITIONAL_STEP_LOGIC_HOOK { "skip":false }|G2

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

@@ -0,0 +1,20 @@
+custom embedded
+
+#me
+hello
+
+#bot
+hello should not assert
+CONDITIONAL_STEP_LOGIC_HOOK { "skip":true }|G1
+
+#bot
+hello
+CONDITIONAL_STEP_LOGIC_HOOK { "skip":false }|G1
+
+#bot
+hello should not assert
+CONDITIONAL_STEP_LOGIC_HOOK { "skip":true }|G2
+
+#bot
+hello should not assert
+CONDITIONAL_STEP_LOGIC_HOOK { "skip":true }|G2

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

@@ -0,0 +1,20 @@
+custom embedded
+
+#me
+hello
+
+#bot
+?hello
+CONDITIONAL_STEP_LOGIC_HOOK { "skip":false }|G1
+
+#bot
+?hello should not assert
+CONDITIONAL_STEP_LOGIC_HOOK { "skip":false }|G1
+
+#bot
+?hello 2
+CONDITIONAL_STEP_LOGIC_HOOK { "skip":false }|G2
+
+#bot
+?hello should not assert
+CONDITIONAL_STEP_LOGIC_HOOK { "skip":true }|G2

package/test/scripting/logichooks/customConditionalStepLogicHook.spec.js

@@ -101,5 +101,21 @@ describe('convo with custom conditional logichook', function () {
       const transript = await this.compiler.convos[0].Run(this.container)
       assert.equal(transript.steps.length, 3)
     })
+
+    it('should fail mandatory condition group if no condition met', async function () {
+      try {
+        this.compiler.ReadScript(path.resolve(__dirname, 'convos'), 'conditional_steps_multiple_mandatory_condition_groups.convo.txt')
+        await this.compiler.convos[0].Run(this.container)
+        assert.fail('it should have failed')
+      } catch (e) {
+        assert.equal(e.message, 'custom embedded/Line 18: Non of the conditions are met in \'G2\' condition group')
+      }
+    })
+
+    it('should not fail optional condition group if no condition met', async function () {
+      this.compiler.ReadScript(path.resolve(__dirname, 'convos'), 'conditional_steps_multiple_optional_condition_groups.convo.txt')
+      const transript = await this.compiler.convos[0].Run(this.container)
+      assert.equal(transript.steps.length, 2)
+    })
   })
 })