botium-core 1.13.0 → 1.13.3

package/src/scripting/logichook/asserter/WerAsserter.js

@@ -0,0 +1,59 @@
+// const _ = require('lodash')
+const speechScorer = require('word-error-rate')
+const { BotiumError } = require('../../BotiumError')
+
+module.exports = class WerAsserter {
+  constructor (context, caps = {}) {
+    this.context = context
+    this.caps = caps
+    this.name = 'WerAsserter'
+  }
+
+  assertConvoStep ({ convo, convoStep, args, botMsg }) {
+    if (!args || args.length < 1) {
+      return Promise.reject(new BotiumError(`${convoStep.stepTag}: WerAsserter Missing argument`,
+        {
+          type: 'asserter',
+          subtype: 'wrong parameters',
+          source: this.name,
+          cause: { args }
+        }
+      ))
+    }
+    if (args.length > 2) {
+      return Promise.reject(new BotiumError(`${convoStep.stepTag}: WerAsserter Too much argument "${args}"`,
+        {
+          type: 'asserter',
+          subtype: 'wrong parameters',
+          source: this.name,
+          cause: { args }
+        }
+      ))
+    }
+
+    const utterance = args[0]
+    const threshold = args[1]
+
+    const wer = speechScorer.wordErrorRate(botMsg.messageText, utterance)
+    if (wer > threshold) {
+      return Promise.reject(new BotiumError(
+        `${convoStep.stepTag}: Word error rate ${wer} > ${threshold} for ${utterance}`,
+        {
+          type: 'asserter',
+          source: this.name,
+          context: {
+            params: {
+              args
+            }
+          },
+          cause: {
+            expected: `Word error rate <= ${threshold}`,
+            actual: `Word error rate = ${wer}`
+          }
+        }
+      ))
+    }
+
+    return Promise.resolve()
+  }
+}

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

@@ -1,5 +1,6 @@
 const util = require('util')
 const _ = require('lodash')
+const { ConvoStepLogicHook } = require('../../Convo')
 
 module.exports = class UpdateCustomLogicHook {
   constructor (context, caps = {}, globalArgs = {}) {
@@ -14,10 +15,10 @@ module.exports = class UpdateCustomLogicHook {
     const validConvoSteps = convo.conversation.filter(s => s.sender === 'me')
     for (const convoStep of validConvoSteps) {
       convoStep.logicHooks = (convoStep.logicHooks || [])
-      convoStep.logicHooks.push({
+      convoStep.logicHooks.push(new ConvoStepLogicHook({
         name: 'UPDATE_CUSTOM',
         args
-      })
+      }))
     }
   }
 

package/test/compiler/compilercsv.spec.js

@@ -24,6 +24,41 @@ const buildContext = () => {
   return result
 }
 
+const assertLivepersonV2 = (context) => {
+  assert.lengthOf(context.utterances, 4)
+  assert.lengthOf(context.convos, 0)
+  assert.deepEqual(context.utterances[0], {
+    name: 'Cancel Pre-Authorized Payment',
+    utterances: [
+      'Can I call back to re-start the payment',
+      'Can I stop a direct debit',
+      'Can you cancel a preauthorized payment for me',
+      'Can you help me cancel my pre authorized payment'
+    ]
+  })
+  assert.deepEqual(context.utterances[1], {
+    name: 'Payee - Correct/Modify',
+    utterances: [
+      'Can I modify my existing payee?',
+      'Can you change the name of the payee?'
+    ]
+  })
+  assert.deepEqual(context.utterances[2], {
+    name: 'Pre-Authorized Payment - Correct/Modify',
+    utterances: [
+      'Can I delay my payment to (company)?'
+    ]
+  })
+  assert.deepEqual(context.utterances[3], {
+    name: 'E-Transfer Recipient – Delete',
+    utterances: [
+      'Can you delete my friend as an e-transfer recipient?',
+      'Can you delete this e-transfer recipient',
+      'Can you delete this recipient'
+    ]
+  })
+}
+
 describe('compiler.compilercsv', function () {
   describe('ROW_PER_MESSAGE mode, full', function () {
     it('should read basic case', async function () {
@@ -357,7 +392,7 @@ describe('compiler.compilercsv', function () {
             assert.equal(err.message, 'Failed to parse conversation. Section "goodbye" unknown.')
           }
         })
-        it('should not parse multi column uttrances as convos ???', async function () {
+        it('should not parse multi column uttrances as convos ??? 2', async function () {
           const scriptBuffer = fs.readFileSync(path.resolve(__dirname, CONVOS_DIR, 'utterances_multicolumn5col.csv'))
           const context = buildContext()
 
@@ -459,7 +494,6 @@ describe('compiler.compilercsv', function () {
             ]
           })
         })
-        // maybe we could read it
         it('should read liveperson format with SCRIPTING_CSV_STARTROW', async function () {
           const scriptBuffer = fs.readFileSync(path.resolve(__dirname, CONVOS_DIR, 'utterances_liveperson.csv'))
           const context = buildContext()
@@ -482,6 +516,20 @@ describe('compiler.compilercsv', function () {
             ]
           })
         })
+        it('should read liveperson format 2 with SCRIPTING_CSV_STARTROW', async function () {
+          const scriptBuffer = fs.readFileSync(path.resolve(__dirname, CONVOS_DIR, 'utterances_liveperson2.csv'))
+          const context = buildContext()
+
+          const caps = {
+            [Capabilities.SCRIPTING_CSV_UTTERANCE_STARTROW]: 9,
+            [Capabilities.SCRIPTING_CSV_UTTERANCE_STOP_ON_EMPTY]: true,
+            [Capabilities.SCRIPTING_CSV_LEGACY_MODE_OFF]: true
+          }
+          const compiler = new Compiler(context, Object.assign({}, DefaultCapabilities, caps))
+
+          compiler.Compile(scriptBuffer, 'SCRIPTING_TYPE_UTTERANCES')
+          assertLivepersonV2(context)
+        })
         it('should read liveperson format with SCRIPTING_CSV_STARTROW without stop', async function () {
           const scriptBuffer = fs.readFileSync(path.resolve(__dirname, CONVOS_DIR, 'utterances_liveperson.csv'))
           const context = buildContext()
@@ -501,7 +549,45 @@ describe('compiler.compilercsv', function () {
           const context = buildContext()
 
           const caps = {
-            [Capabilities.SCRIPTING_CSV_UTTERANCE_STARTROW]: 12,
+            [Capabilities.SCRIPTING_CSV_UTTERANCE_STARTROW_HEADER]: 'SampleSentences',
+            [Capabilities.SCRIPTING_CSV_UTTERANCE_STOP_ON_EMPTY]: true,
+            [Capabilities.SCRIPTING_CSV_LEGACY_MODE_OFF]: true
+          }
+
+          const compiler = new Compiler(context, Object.assign({}, DefaultCapabilities, caps))
+
+          compiler.Compile(scriptBuffer, 'SCRIPTING_TYPE_UTTERANCES')
+          assert.lengthOf(context.utterances, 18)
+          assert.lengthOf(context.convos, 0)
+          assert.deepEqual(context.utterances[0], {
+            name: 'ask about installation',
+            utterances: [
+              'about my appointment',
+              'book service installation appointment'
+            ]
+          })
+        })
+        it('should read liveperson format 2 with SCRIPTING_CSV_STARTROWHEADER', async function () {
+          const scriptBuffer = fs.readFileSync(path.resolve(__dirname, CONVOS_DIR, 'utterances_liveperson2.csv'))
+          const context = buildContext()
+
+          const caps = {
+            [Capabilities.SCRIPTING_CSV_UTTERANCE_STARTROW_HEADER]: 'SampleSentences',
+            [Capabilities.SCRIPTING_CSV_UTTERANCE_STOP_ON_EMPTY]: true,
+            [Capabilities.SCRIPTING_CSV_LEGACY_MODE_OFF]: true
+          }
+
+          const compiler = new Compiler(context, Object.assign({}, DefaultCapabilities, caps))
+
+          compiler.Compile(scriptBuffer, 'SCRIPTING_TYPE_UTTERANCES')
+          assertLivepersonV2(context)
+        })
+        it('should read liveperson format with SCRIPTING_CSV_STARTROWHEADER 2', async function () {
+          const scriptBuffer = fs.readFileSync(path.resolve(__dirname, CONVOS_DIR, 'utterances_liveperson.csv'))
+          const context = buildContext()
+
+          const caps = {
+            [Capabilities.SCRIPTING_CSV_UTTERANCE_STARTROW_HEADER]: 'SampleSentences',
             [Capabilities.SCRIPTING_CSV_UTTERANCE_STOP_ON_EMPTY]: true,
             [Capabilities.SCRIPTING_CSV_LEGACY_MODE_OFF]: true
           }
@@ -519,6 +605,21 @@ describe('compiler.compilercsv', function () {
             ]
           })
         })
+        it('should read liveperson format 2 with SCRIPTING_CSV_STARTROWHEADER 2', async function () {
+          const scriptBuffer = fs.readFileSync(path.resolve(__dirname, CONVOS_DIR, 'utterances_liveperson2.csv'))
+          const context = buildContext()
+
+          const caps = {
+            [Capabilities.SCRIPTING_CSV_UTTERANCE_STARTROW_HEADER]: 'SampleSentences',
+            [Capabilities.SCRIPTING_CSV_UTTERANCE_STOP_ON_EMPTY]: true,
+            [Capabilities.SCRIPTING_CSV_LEGACY_MODE_OFF]: true
+          }
+
+          const compiler = new Compiler(context, Object.assign({}, DefaultCapabilities, caps))
+
+          compiler.Compile(scriptBuffer, 'SCRIPTING_TYPE_UTTERANCES')
+          assertLivepersonV2(context)
+        })
         it('should work with variable length csv', async function () {
           const scriptBuffer = fs.readFileSync(path.resolve(__dirname, CONVOS_DIR, 'utterances_variable_row_len.csv'))
           const context = buildContext()

package/test/compiler/compilerjson.spec.js

@@ -109,9 +109,7 @@ describe('compiler.compilerjson', function () {
     assert.equal(context.scriptingMemories[0].header.name, 'scenario1')
     assert.equal(context.scriptingMemories[0].values.$var1, 'var1_1')
   })
-})
 
-describe('compiler.decompilerjson', function () {
   it('should decompile convos', async function () {
     const scriptBuffer = fs.readFileSync(path.resolve(__dirname, CONVOS_DIR, 'convos_and_utterances.json'))
     const context = buildContext()

package/test/compiler/compilerxlsx.spec.js

@@ -473,7 +473,7 @@ describe('compiler.compilerxlsx', function () {
 
     assert.lengthOf(context.utterances, 0)
   })
-  it('should read 3 convos without name (forced)', async function () {
+  it('should read 3 convos without name (forced) 2', async function () {
     const scriptBuffer = fs.readFileSync(path.resolve(__dirname, CONVOS_DIR, 'convos_2convos_without_names_noheader.xlsx'))
     const context = buildContext()
 

package/test/compiler/convos/csv/utterances_liveperson2.csv

@@ -0,0 +1,12 @@
+Cancel Pre-Authorized Payment,Payee - Correct/Modify,Pre-Authorized Payment - Correct/Modify,E-Transfer Recipient – Delete
+DisplayName,DisplayName,DisplayName,DisplayName
+Cancel Pre-Authorized Payment,Payee - Correct/Modify,Pre-Authorized Payment - Correct/Modify,E-Transfer Recipient – Delete
+KeyPhrases,KeyPhrases,KeyPhrases,KeyPhrases
+,,,
+MetaIntent,MetaIntent,MetaIntent,MetaIntent
+,,,
+SampleSentences,SampleSentences,SampleSentences,SampleSentences
+Can I call back to re-start the payment,Can I modify my existing payee?,Can I delay my payment to (company)?,Can you delete my friend as an e-transfer recipient?
+Can I stop a direct debit,Can you change the name of the payee?,,Can you delete this e-transfer recipient
+Can you cancel a preauthorized payment for me,,,Can you delete this recipient
+Can you help me cancel my pre authorized payment,,,