botium-core 1.14.8 → 1.14.9

package/package.json

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

package/src/scripting/Convo.js

@@ -416,7 +416,7 @@ class Convo {
               await this.scriptingEvents.onBotStart({ convo: this, convoStep, container, scriptingMemory, transcript, transcriptStep })
               transcriptStep.botBegin = new Date()
               if (!botMsg) {
-                botMsg = await container.WaitBotSays(convoStep.channel)
+                botMsg = await container.WaitBotSays(convoStep.channel, convoStepParameters?.stepTimeout)
               }
               transcriptStep.botEnd = new Date()
               transcriptStep.actual = new BotiumMockMessage(botMsg)
@@ -426,6 +426,10 @@ class Convo {
             } catch (err) {
               transcriptStep.botEnd = new Date()
 
+              if (convoStep.optional) {
+                continue
+              }
+
               const failErr = botiumErrorFromErr(`${this.header.name}/${convoStep.stepTag}: error waiting for bot - ${err.message}`, err)
               debug(failErr)
               try {

package/src/scripting/helper.js

@@ -404,13 +404,6 @@ const validateConvo = (convo) => {
       if (optionalSet.size > 1) {
         validationResult.errors.push(new Error(`Step ${i + 1}: Failed to decompile conversation. Mixed optional flag is not allowed inside one step.`))
       }
-
-      if (optionalSet.size === 1 && optionalSet.has(true)) {
-        const nextStep = convo.conversation[i + 1]
-        if (!nextStep || nextStep.sender !== 'bot') {
-          validationResult.errors.push(new Error(`Step ${i + 1}: Optional bot convo step has to be followed by a bot convo step.`))
-        }
-      }
     }
     if (!validateSender(step.sender)) {
       validationResult.errors.push(new Error(`Step ${i + 1}: Sender #${step.sender} is invalid.`))
@@ -456,6 +449,10 @@ const convoStepToLines = (step) => {
   } else {
     if (step.messageText) {
       lines.push((step.optional ? '?' : '') + (step.not ? '!' : '') + step.messageText)
+    } else {
+      if (step.optional) {
+        lines.push('?')
+      }
     }
     if (step.buttons && step.buttons.length > 0) lines.push('BUTTONS' + _formatAppendArgs(step.buttons.filter(b => b.text).map(b => flatString(b.text))))
     if (step.media && step.media.length > 0) lines.push('MEDIA' + _formatAppendArgs(step.media.filter(m => !m.buffer && m.mediaUri).map(m => m.mediaUri)))

package/test/convo/convos/welcome_multiple_botsteps_opt.convo.txt

@@ -0,0 +1,22 @@
+welcome multiple botsteps opt
+
+#me
+Welcome
+
+#bot
+Welcome
+
+#bot
+?Select an option:
+CONVO_STEP_PARAMETERS {"stepTimeout": 300}
+
+#bot
+?
+?BUTTONS First Button|Second Button
+CONVO_STEP_PARAMETERS {"stepTimeout": 300}
+
+#me
+Thanks
+
+#bot
+Thanks

package/test/convo/transcript.spec.js

@@ -21,6 +21,34 @@ const echoConnector = ({ queueBotSays }) => {
   }
 }
 
+const echoConnectorMultipleBotMessages = ({ queueBotSays }) => {
+  return {
+    UserSays (msg) {
+      const botMsg = { sender: 'bot', sourceData: msg.sourceData, messageText: msg.messageText }
+      if (msg.messageText === 'Welcome') {
+        botMsg.messageText = 'Welcome'
+        queueBotSays(botMsg)
+
+        setTimeout(() => {
+          botMsg.messageText = 'Select an option:'
+          queueBotSays(botMsg)
+        }, 200)
+
+        setTimeout(() => {
+          botMsg.messageText = ''
+          botMsg.buttons = [
+            { text: 'First Button' },
+            { text: 'Second Button' }
+          ]
+          queueBotSays(botMsg)
+        }, 200)
+      } else {
+        queueBotSays(botMsg)
+      }
+    }
+  }
+}
+
 describe('convo.transcript', function () {
   beforeEach(async function () {
     const myCaps = {
@@ -54,6 +82,16 @@ describe('convo.transcript', function () {
     this.compilerSkipAssertErrors = this.driverSkipAssertErrors.BuildCompiler()
     this.containerSkipAssertErrors = await this.driverSkipAssertErrors.Build()
     await this.containerSkipAssertErrors.Start()
+
+    const myCapsMultipleBotMessages = {
+      [Capabilities.PROJECTNAME]: 'convo.transcript',
+      [Capabilities.CONTAINERMODE]: echoConnectorMultipleBotMessages,
+      [Capabilities.SCRIPTING_FORCE_BOT_CONSUMED]: true
+    }
+    this.driverMultipleBotmessages = new BotDriver(myCapsMultipleBotMessages)
+    this.compilerMultipleBotmessages = this.driverMultipleBotmessages.BuildCompiler()
+    this.containerMultipleBotmessages = await this.driverMultipleBotmessages.Build()
+    await this.containerMultipleBotmessages.Start()
   })
   afterEach(async function () {
     await this.container.Stop()
@@ -143,6 +181,22 @@ describe('convo.transcript', function () {
     assert.isDefined(transcript)
     assert.equal(transcript.steps.length, 2)
   })
+  it('should provide transcript optional multiple bot steps on getting all bot messages', async function () {
+    this.compiler.ReadScript(path.resolve(__dirname, 'convos'), 'welcome_multiple_botsteps_opt.convo.txt')
+    assert.equal(this.compiler.convos.length, 1)
+
+    const transcript = await this.compiler.convos[0].Run(this.containerMultipleBotmessages)
+    assert.isDefined(transcript)
+    assert.equal(transcript.steps.length, 6)
+  })
+  it('should provide transcript optional multiple bot steps on not getting all bot messages', async function () {
+    this.compiler.ReadScript(path.resolve(__dirname, 'convos'), 'welcome_multiple_botsteps_opt.convo.txt')
+    assert.equal(this.compiler.convos.length, 1)
+
+    const transcript = await this.compiler.convos[0].Run(this.container)
+    assert.isDefined(transcript)
+    assert.equal(transcript.steps.length, 6)
+  })
   it('should include pause in transcript steps', async function () {
     this.compiler.ReadScript(path.resolve(__dirname, 'convos'), '2stepsWithPause.convo.txt')
     assert.equal(this.compiler.convos.length, 1)

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

@@ -84,6 +84,12 @@ describe('scripting.asserters.convoStepParametersForAssert', function () {
 
       await this.compiler.convos[0].Run(this.container)
     })
+    it('should skip optional bot message', async function () {
+      this.compiler.ReadScript(path.resolve(__dirname, 'convos'), 'convo_step_parameter_optional_with_timeout.convo.txt')
+      assert.equal(this.compiler.convos.length, 1)
+
+      await this.compiler.convos[0].Run(this.container)
+    })
     it('should retry until succesful asserters', async function () {
       this.compiler.ReadScript(path.resolve(__dirname, 'convos'), 'convo_step_parameter_retry_asserters_good.convo.txt')
       assert.equal(this.compiler.convos.length, 1)

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

@@ -0,0 +1,16 @@
+convo_step_parameter_retry_main_good
+
+#me
+Hello
+
+#bot
+You said Hello
+
+#bot
+?Wrong answer
+
+#me
+Hello2
+
+#bot
+You said Hello2

package/test/scripting/txt/decompile.spec.js

@@ -126,31 +126,6 @@ botText2
 `
     )
   })
-  it('should fail decompile convo with optional step not followed bot step', async function () {
-    const scriptingProvider = new ScriptingProvider(DefaultCapabilities)
-    await scriptingProvider.Build()
-
-    const convo = {
-      header: {
-        name: 'test convo'
-      },
-      conversation: [
-        {
-          sender: 'bot',
-          messageText: 'botText',
-          not: true,
-          optional: true
-        }
-      ]
-    }
-
-    try {
-      scriptingProvider.Decompile([convo], 'SCRIPTING_FORMAT_TXT')
-      assert.fail('expected error')
-    } catch (err) {
-      assert.equal(err.message, 'Step 1: Optional bot convo step has to be followed by a bot convo step.')
-    }
-  })
   it('should fail decompile convo with mixed optional step', async function () {
     const scriptingProvider = new ScriptingProvider(DefaultCapabilities)
     await scriptingProvider.Build()