botium-core 1.13.3 → 1.13.4

package/package.json

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

package/src/Capabilities.js

@@ -133,6 +133,8 @@ module.exports = {
   SCRIPTING_UTTEXPANSION_MODE: 'SCRIPTING_UTTEXPANSION_MODE',
   SCRIPTING_UTTEXPANSION_RANDOM_COUNT: 'SCRIPTING_UTTEXPANSION_RANDOM_COUNT',
   SCRIPTING_UTTEXPANSION_INCOMPREHENSION: 'SCRIPTING_UTTEXPANSION_INCOMPREHENSION',
+  SCRIPTING_UTTEXPANSION_INCOMPREHENSIONINTENTS: 'SCRIPTING_UTTEXPANSION_INCOMPREHENSIONINTENTS',
+  SCRIPTING_UTTEXPANSION_INCOMPREHENSIONUTTS: 'SCRIPTING_UTTEXPANSION_INCOMPREHENSIONUTTS',
   SCRIPTING_UTTEXPANSION_USENAMEASINTENT: 'SCRIPTING_UTTEXPANSION_USENAMEASINTENT',
   // justLineTag, utterance
   SCRIPTING_UTTEXPANSION_NAMING_MODE: 'SCRIPTING_UTTEXPANSION_NAMING_MODE',

package/src/Defaults.js

@@ -49,6 +49,10 @@ module.exports = {
     [Capabilities.SCRIPTING_UTTEXPANSION_RANDOM_COUNT]: 1,
     [Capabilities.SCRIPTING_UTTEXPANSION_NAMING_MODE]: 'justLineTag',
     [Capabilities.SCRIPTING_UTTEXPANSION_NAMING_UTTERANCE_MAX]: '16',
+    [Capabilities.SCRIPTING_UTTEXPANSION_INCOMPREHENSION]: null,
+    [Capabilities.SCRIPTING_UTTEXPANSION_INCOMPREHENSIONINTENTS]: [],
+    [Capabilities.SCRIPTING_UTTEXPANSION_INCOMPREHENSIONUTTS]: [],
+    [Capabilities.SCRIPTING_UTTEXPANSION_USENAMEASINTENT]: false,
     [Capabilities.SCRIPTING_MEMORYEXPANSION_KEEP_ORIG]: false,
     [Capabilities.SCRIPTING_ENABLE_SKIP_ASSERT_ERRORS]: false,
     [Capabilities.SCRIPTING_FORCE_BOT_CONSUMED]: false,

package/src/mocks/BotiumMockScripting.js

@@ -4,6 +4,7 @@ class BotiumMockAsserter {
   constructor (fromJson = {}) {
     this.name = fromJson.name
     this.args = _.cloneDeep(fromJson.args)
+    this.not = fromJson.not
   }
 }
 class BotiumMockUserInput {

package/src/scripting/ScriptingProvider.js

@@ -770,31 +770,79 @@ module.exports = class ScriptingProvider {
     this._sortConvos()
   }
 
-  ExpandUtterancesToConvos ({ useNameAsIntent, incomprehensionUtt } = {}) {
+  ExpandUtterancesToConvos ({ useNameAsIntent, incomprehensionIntents, incomprehensionUtts, incomprehensionUtt } = {}) {
     const expandedConvos = []
 
     if (_.isUndefined(useNameAsIntent)) {
       useNameAsIntent = !!this.caps[Capabilities.SCRIPTING_UTTEXPANSION_USENAMEASINTENT]
     }
+    if (_.isUndefined(incomprehensionIntents)) {
+      incomprehensionIntents = this.caps[Capabilities.SCRIPTING_UTTEXPANSION_INCOMPREHENSIONINTENTS]
+    }
+    if (_.isUndefined(incomprehensionUtts)) {
+      incomprehensionUtts = this.caps[Capabilities.SCRIPTING_UTTEXPANSION_INCOMPREHENSIONUTTS]
+    }
     if (_.isUndefined(incomprehensionUtt)) {
       incomprehensionUtt = this.caps[Capabilities.SCRIPTING_UTTEXPANSION_INCOMPREHENSION]
     }
 
-    if (useNameAsIntent && incomprehensionUtt) {
-      throw new Error('ExpandUtterancesToConvos - SCRIPTING_UTTEXPANSION_USENAMEASINTENT and SCRIPTING_UTTEXPANSION_INCOMPREHENSION are incompatible')
+    if (incomprehensionUtt && (!incomprehensionUtts || incomprehensionUtts.length === 0) && !this.utterances[incomprehensionUtt]) {
+      throw new Error(`ExpandUtterancesToConvos - incomprehension utterance '${incomprehensionUtt}' undefined (and no user examples given)`)
     }
-    if (incomprehensionUtt && !this.utterances[incomprehensionUtt]) {
-      throw new Error(`ExpandUtterancesToConvos - incomprehension utterance '${incomprehensionUtt}' undefined`)
+    if (incomprehensionUtts && incomprehensionUtts.length > 0) {
+      if (!incomprehensionUtt) {
+        incomprehensionUtt = 'UTT_INCOMPREHENSION'
+      }
+      if (this.utterances[incomprehensionUtt]) {
+        this.utterances[incomprehensionUtt].utterances.push(...incomprehensionUtts)
+      } else {
+        this.utterances[incomprehensionUtt] = {
+          name: incomprehensionUtt,
+          utterances: [...incomprehensionUtts]
+        }
+      }
     }
 
     if (useNameAsIntent) {
       debug('ExpandUtterancesToConvos - Using utterance name as NLU intent')
-    } else if (incomprehensionUtt) {
-      debug(`ExpandUtterancesToConvos - Using incomprehension utterance expansion mode: ${incomprehensionUtt}`)
+    }
+    if (incomprehensionIntents && incomprehensionIntents.length > 0) {
+      debug(`ExpandUtterancesToConvos - Using ${incomprehensionIntents.length} incomprehension NLU intent(s)`)
+    }
+    if (incomprehensionUtt) {
+      debug(`ExpandUtterancesToConvos - Using incomprehension utterance expansion mode: ${incomprehensionUtt}, ${this.utterances[incomprehensionUtt].utterances.length} user example(s)`)
     }
 
     _.keys(this.utterances).filter(u => u !== incomprehensionUtt).forEach(uttName => {
       const utt = this.utterances[uttName]
+
+      const responseStep = {
+        sender: 'bot',
+        messageText: '',
+        asserters: [],
+        stepTag: 'Step 2 - check bot response',
+        not: false
+      }
+      if (useNameAsIntent) {
+        responseStep.asserters.push({
+          name: 'INTENT',
+          args: [utt.name]
+        })
+      }
+      if (incomprehensionIntents && incomprehensionIntents.length > 0) {
+        incomprehensionIntents.forEach(ii => {
+          responseStep.asserters.push({
+            name: 'INTENT',
+            args: [ii],
+            not: true
+          })
+        })
+      }
+      if (incomprehensionUtt) {
+        responseStep.messageText = incomprehensionUtt
+        responseStep.not = true
+      }
+
       expandedConvos.push(new Convo(this._buildScriptContext(), {
         header: {
           name: utt.name,
@@ -811,31 +859,7 @@ module.exports = class ScriptingProvider {
             messageText: utt.name,
             stepTag: 'Step 1 - tell utterance'
           },
-          useNameAsIntent
-            ? {
-                sender: 'bot',
-                asserters: [
-                  {
-                    name: 'INTENT',
-                    args: [utt.name]
-                  }
-                ],
-                stepTag: 'Step 2 - check intent',
-                not: false
-              }
-            : incomprehensionUtt
-              ? {
-                  sender: 'bot',
-                  messageText: incomprehensionUtt,
-                  stepTag: 'Step 2 - check incomprehension',
-                  not: true
-                }
-              : {
-                  sender: 'bot',
-                  messageText: '',
-                  stepTag: 'Step 2 - check bot response',
-                  not: false
-                }
+          responseStep
         ],
         sourceTag: Object.assign({}, utt.sourceTag, { origUttName: utt.name })
       }))

package/test/scripting/scriptingProvider.spec.js

@@ -692,6 +692,63 @@ describe('scripting.scriptingProvider', function () {
         assert.isTrue(err.message.indexOf('incomprehension utterance \'INCOMPREHENSION\' undefined') > 0)
       }
     })
+    it('should add incomprehension utterances to new utterance list', async function () {
+      const scriptingProvider = new ScriptingProvider(Object.assign({}, DefaultCapabilities))
+      await scriptingProvider.Build()
+      scriptingProvider.AddUtterances({
+        name: 'utt1',
+        utterances: ['TEXT1', 'TEXT2']
+      })
+
+      scriptingProvider.ExpandUtterancesToConvos({ incomprehensionUtt: 'INCOMPREHENSION', incomprehensionUtts: ['INCOMPREHENSION3', 'INCOMPREHENSION4'] })
+      assert.lengthOf(scriptingProvider.utterances.INCOMPREHENSION.utterances, 2)
+    })
+    it('should add incomprehension utterances to new default utterance list', async function () {
+      const scriptingProvider = new ScriptingProvider(Object.assign({}, DefaultCapabilities))
+      await scriptingProvider.Build()
+      scriptingProvider.AddUtterances({
+        name: 'utt1',
+        utterances: ['TEXT1', 'TEXT2']
+      })
+
+      scriptingProvider.ExpandUtterancesToConvos({ incomprehensionUtts: ['INCOMPREHENSION3', 'INCOMPREHENSION4'] })
+      assert.lengthOf(scriptingProvider.utterances.UTT_INCOMPREHENSION.utterances, 2)
+    })
+    it('should add incomprehension utterances to existing utterance list', async function () {
+      const scriptingProvider = new ScriptingProvider(Object.assign({}, DefaultCapabilities))
+      await scriptingProvider.Build()
+      scriptingProvider.AddUtterances({
+        name: 'utt1',
+        utterances: ['TEXT1', 'TEXT2']
+      })
+      scriptingProvider.AddUtterances({
+        name: 'INCOMPREHENSION',
+        utterances: ['INCOMPREHENSION1', 'INCOMPREHENSION2']
+      })
+
+      scriptingProvider.ExpandUtterancesToConvos({ incomprehensionUtt: 'INCOMPREHENSION', incomprehensionUtts: ['INCOMPREHENSION3', 'INCOMPREHENSION4'] })
+      assert.lengthOf(scriptingProvider.utterances.INCOMPREHENSION.utterances, 4)
+    })
+    it('should add incomprehension intent to asserter list', async function () {
+      const scriptingProvider = new ScriptingProvider(Object.assign({}, DefaultCapabilities))
+      await scriptingProvider.Build()
+      scriptingProvider.AddUtterances({
+        name: 'utt1',
+        utterances: ['TEXT1', 'TEXT2']
+      })
+
+      scriptingProvider.ExpandUtterancesToConvos({ incomprehensionIntents: ['FALLBACK1', 'FALLBACK2'] })
+      assert.equal(scriptingProvider.convos.length, 1)
+      assert.equal(scriptingProvider.convos[0].conversation.length, 2)
+      assert.equal(scriptingProvider.convos[0].conversation[0].messageText, 'utt1')
+      assert.equal(scriptingProvider.convos[0].conversation[1].asserters.length, 2)
+      assert.equal(scriptingProvider.convos[0].conversation[1].asserters[0].name, 'INTENT')
+      assert.equal(scriptingProvider.convos[0].conversation[1].asserters[0].args[0], 'FALLBACK1')
+      assert.equal(scriptingProvider.convos[0].conversation[1].asserters[0].not, true)
+      assert.equal(scriptingProvider.convos[0].conversation[1].asserters[1].name, 'INTENT')
+      assert.equal(scriptingProvider.convos[0].conversation[1].asserters[1].args[0], 'FALLBACK2')
+      assert.equal(scriptingProvider.convos[0].conversation[1].asserters[1].not, true)
+    })
   })
 
   describe('assertBotResponse', function () {