botium-core 1.15.8 → 1.15.10

package/package.json

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

package/src/BotDriver.js

@@ -241,8 +241,8 @@ module.exports = class BotDriver {
         if (_.isString(newCaps[capKey])) {
           try {
             caps[capKey] = JSON.parse(newCaps[capKey])
-            if (_.isFinite(caps[capKey])) {
-              caps[capKey] = caps[capKey].toString()
+            if (_.isFinite(Number(newCaps[capKey]))) {
+              caps[capKey] = newCaps[capKey].toString()
             }
           } catch (err) {
             caps[capKey] = newCaps[capKey]

package/src/helpers/TranscriptUtils.js

@@ -1,4 +1,70 @@
+const path = require('path')
+const fs = require('fs')
 const _ = require('lodash')
+const { parse: csvParseSync } = require('csv-parse/sync')
+
+/**
+ * Find transcription for an audio file: .txt same base name, or transcript.csv in parent dirs.
+ * @param {string} baseDir - Base directory for resolving paths
+ * @param {string} audioFile - Relative path to audio file
+ * @param {object} [options] - Optional: { csvCache: {}, onError: (msg) => {} }
+ * @returns {string|null} Transcription text or null
+ */
+module.exports.findTranscription = (baseDir, audioFile, options = {}) => {
+  const { csvCache = {}, onError } = options
+  const transcriptionFilename = `${audioFile.substring(0, audioFile.lastIndexOf('.'))}.txt`
+  const transcriptionFilenameAbs = path.resolve(baseDir, transcriptionFilename)
+  try {
+    if (fs.existsSync(transcriptionFilenameAbs)) {
+      return fs.readFileSync(transcriptionFilenameAbs, { encoding: 'utf-8' }).trim()
+    }
+  } catch (err) {
+    if (onError) onError(`Transcription File ${transcriptionFilenameAbs} not readable: ${err.message}`)
+    throw new Error(`Reading transcription file ${transcriptionFilename} for ${audioFile} failed`)
+  }
+  if (csvCache[audioFile]) {
+    return csvCache[audioFile]
+  }
+  const audioFileComponents = audioFile.split('/')
+  for (let parentIndex = audioFileComponents.length - 1; parentIndex >= 0; parentIndex--) {
+    const csvDirectory = audioFileComponents.slice(0, parentIndex)
+    const csvFilename = path.join(...csvDirectory, 'transcript.csv')
+    const csvFilenameAbs = path.resolve(baseDir, csvFilename)
+    try {
+      if (fs.existsSync(csvFilenameAbs)) {
+        const records = csvParseSync(fs.readFileSync(csvFilenameAbs, { encoding: 'utf-8' }).trim(), {
+          columns: ['filename', 'transcription'],
+          delimiter: [',', ';', ':', '\t'],
+          trim: true,
+          skip_empty_lines: true
+        })
+        if (records && records.length > 0) {
+          for (const record of records) {
+            const fnKey = path.join(...csvDirectory, record.filename)
+            csvCache[fnKey] = record.transcription
+          }
+        }
+      }
+    } catch (err) {
+      if (onError) onError(`Transcription CSV File ${csvFilenameAbs} not readable: ${err.message}`)
+      throw new Error(`Reading transcription CSV file for ${csvFilename} failed`)
+    }
+    if (csvCache[audioFile]) {
+      return csvCache[audioFile]
+    }
+  }
+  return null
+}
+
+/**
+ * Derive transcription text from audio filename (basename without extension, underscores/hyphens → spaces).
+ * @param {string} audioFile - Path or filename of audio file
+ * @returns {string}
+ */
+module.exports.transcriptionFromFilename = (audioFile) => {
+  const filename = path.basename(audioFile, path.extname(audioFile))
+  return filename.split(/[_-]+/).join(' ')
+}
 
 module.exports.hasWaitForBotTimeout = (transciptError) => {
   if (!transciptError) {

package/src/scripting/Convo.js

@@ -270,6 +270,7 @@ class Convo {
 
   async runConversation (container, scriptingMemory, transcript) {
     const transcriptSteps = []
+    transcript.steps = transcriptSteps
     try {
       let lastMeConvoStep = null
       let botMsg = null
@@ -416,6 +417,14 @@ class Convo {
               throw failErr
             }
           } else if (convoStep.sender === 'bot') {
+            if (this.scriptingEvents.executeBotStep) {
+              const executeBotStepResult = await this.scriptingEvents.executeBotStep({ convo: this, convoStep, container, scriptingMemory, transcript, transcriptStep, transcriptSteps })
+              if (executeBotStepResult) {
+                skipTranscriptStep = true
+                continue
+              }
+            }
+
             if (waitForBotSays) {
               botMsg = null
             } else {

package/src/scripting/ScriptingProvider.js

@@ -115,6 +115,25 @@ module.exports = class ScriptingProvider {
       onBotEnd: ({ convo, convoStep, scriptingMemory, ...rest }) => {
         return this._createLogicHookPromises({ hookType: 'onBotEnd', logicHooks: (convoStep?.logicHooks || []), convo, convoStep, scriptingMemory, ...rest })
       },
+      executeBotStep: ({ convo, convoStep, container, scriptingMemory, ...rest }) => {
+        const logicHooks = (convoStep?.logicHooks || [])
+        const executeBotStepHooks = logicHooks.filter(l => this.logicHooks[l.name] && typeof this.logicHooks[l.name].executeBotStep === 'function')
+        if (executeBotStepHooks.length > 1) {
+          throw new Error(`${convo?.header?.name}/${convoStep?.stepTag}: Multiple logic hooks implement executeBotStep: ${executeBotStepHooks.map(l => l.name).join(', ')}. Only one is allowed per step.`)
+        }
+        if (executeBotStepHooks.length === 1) {
+          const lh = executeBotStepHooks[0]
+          return this.logicHooks[lh.name].executeBotStep({
+            convo,
+            convoStep,
+            scriptingMemory,
+            container,
+            args: ScriptingMemory.applyToArgs(lh.args, scriptingMemory, container.caps),
+            ...rest
+          })
+        }
+        return null
+      },
       assertConvoBegin: ({ convo, convoStep, scriptingMemory, ...rest }) => {
         return this._createAsserterPromises({ asserterType: 'assertConvoBegin', asserters: (convo?.beginAsserter || []), convo, convoStep, scriptingMemory, ...rest })
       },
@@ -377,7 +396,15 @@ module.exports = class ScriptingProvider {
       throw Error(`Unknown hookType ${hookType}`)
     }
 
-    const localHooks = (logicHooks || []).filter(l => this.logicHooks[l.name][hookType])
+    let localHooks = (logicHooks || []).filter(l => this.logicHooks[l.name][hookType])
+    // Scripting memory file are injected via SET_SCRIPTING_MEMORY in the BEGIN step
+    // But there might be other logic hooks that need the scripting memory variables
+    // Order is important (SET_SCRIPTING_MEMORY in begin can be because the user added it,
+    // or because the scripting memory file added it. User one has to be the last one.
+    localHooks = [
+      ...localHooks.filter(l => l.name === 'SET_SCRIPTING_MEMORY'),
+      ...localHooks.filter(l => l.name !== 'SET_SCRIPTING_MEMORY')
+    ]
 
     const convoStepPromises = localHooks
       .map(l => p(this.retryHelperLogicHook, () => this.logicHooks[l.name][hookType]({
@@ -385,6 +412,7 @@ module.exports = class ScriptingProvider {
         convoStep,
         scriptingMemory,
         container,
+        // Do this more sensitve for SET_SCRIPTING_MEMORY? It can have scripting variables in the args
         args: ScriptingMemory.applyToArgs(l.args, scriptingMemory, container.caps, rest.botMsg),
         isGlobal: false,
         ...rest
@@ -471,6 +499,7 @@ module.exports = class ScriptingProvider {
         onBotStart: this.scriptingEvents.onBotStart.bind(this),
         onBotPrepare: this.scriptingEvents.onBotPrepare.bind(this),
         onBotEnd: this.scriptingEvents.onBotEnd.bind(this),
+        executeBotStep: this.scriptingEvents.executeBotStep.bind(this),
         setUserInput: this.scriptingEvents.setUserInput.bind(this),
         fail: this.scriptingEvents.fail && this.scriptingEvents.fail.bind(this)
       }
@@ -995,7 +1024,11 @@ module.exports = class ScriptingProvider {
       // use skip and keep, or justHeader
       justHeader: false,
       // drop unwanted convos
-      convoFilter: null
+      convoFilter: null,
+      mediaInput: {
+        // MESSAGE_TEXT_FROM_FILENAME or MESSAGE_TEXT_FROM_TRANSCRIPTION or falsy
+        messageTextMode: null
+      }
     }, options)
     const expandedConvos = []
     // The globalContext is going to keep the data even if the Object.assign which happening to create the myContext in _expandConvo function
@@ -1034,7 +1067,11 @@ module.exports = class ScriptingProvider {
   ExpandConvosIterable (options = {}) {
     options = Object.assign({
       // drop unwanted convos
-      convoFilter: null
+      convoFilter: null,
+      mediaInput: {
+        // MESSAGE_TEXT_FROM_FILENAME or MESSAGE_TEXT_FROM_TRANSCRIPTION or falsy
+        messageTextMode: null
+      }
     }, options)
     // The globalContext is going to keep the data even if the Object.assign which happening to create the myContext in _expandConvo function
     const context = {
@@ -1167,7 +1204,7 @@ module.exports = class ScriptingProvider {
             const ui = currentStep.userInputs[uiIndex]
             const userInput = this.userInputs[ui.name]
             if (userInput && userInput.expandConvo) {
-              const expandedUserInputs = userInput.expandConvo({ convo: currentConvo, convoStep: currentStep, args: ui.args })
+              const expandedUserInputs = userInput.expandConvo({ convo: currentConvo, convoStep: currentStep, args: ui.args, options })
               if (expandedUserInputs && expandedUserInputs.length > 0) {
                 // let sampleinputs = expandedUserInputs
                 const processSampleInputs = function * (sampleinputs, myContext, uiIndex) {
@@ -1176,10 +1213,13 @@ module.exports = class ScriptingProvider {
                   }
                 }
                 const processSampleInput = function * (sampleinput, length, index, myContext, uiIndex) {
+                  const { messageText, ...userInput } = sampleinput
                   const currentStepsStack = convoStepsStack.slice()
                   const currentStepMod = _.cloneDeep(currentStep)
-                  currentStepMod.userInputs[uiIndex] = sampleinput
-
+                  currentStepMod.userInputs[uiIndex] = userInput
+                  if (messageText) {
+                    currentStepMod.messageText = messageText
+                  }
                   currentStepsStack.push(currentStepMod)
                   const currentConvoLabeled = _.cloneDeep(currentConvo)
                   if (length > 1) {

package/src/scripting/logichook/userinput/MediaInput.js

@@ -8,6 +8,7 @@ const _ = require('lodash')
 const { BotiumMockMedia } = require('../../../../src/mocks/BotiumMockRichMessageTypes')
 const { BotiumError } = require('../../../../src/scripting/BotiumError')
 const Capabilities = require('../../../../src/Capabilities')
+const TranscriptUtils = require('../../../helpers/TranscriptUtils')
 
 const DEFAULT_BASE_SELECTOR = 'sourceTag.testSetId'
 
@@ -151,7 +152,7 @@ module.exports = class MediaInput {
     return mime.lookup(arg)
   }
 
-  expandConvo ({ convo, convoStep, args }) {
+  expandConvo ({ convo, convoStep, args, options }) {
     const hasWildcard = args.findIndex(a => this._isWildcard(a)) >= 0
 
     if (args && (args.length > 1 || hasWildcard)) {
@@ -161,10 +162,17 @@ module.exports = class MediaInput {
           // we need to escape brackets to find files
           const mediaFiles = globSync(arg.replace(/[()[\]{}]/g, '\\$&'), { cwd: baseDir })
           mediaFiles.forEach(mf => {
+            let messageText = null
+            if (options.mediaInput.messageTextMode === 'MESSAGE_TEXT_FROM_FILENAME') {
+              messageText = TranscriptUtils.transcriptionFromFilename(mf)
+            } else if (options.mediaInput.messageTextMode === 'MESSAGE_TEXT_FROM_TRANSCRIPTION') {
+              messageText = TranscriptUtils.findTranscription(baseDir, mf)
+            }
             e.push({
               name: 'MEDIA',
               args: [mf],
-              convoPostfix: _.last(mf.split('/'))
+              convoPostfix: _.last(mf.split('/')),
+              ...messageText ? { messageText } : {}
             })
           })
         } else {

package/test/driver/capabilities.spec.js

@@ -75,6 +75,15 @@ describe('driver.capabilities', function () {
       assert.isString(driver.caps.CAP_STRING_1)
       assert.isString(driver.caps.CAP_STRING_2)
     })
+    it('should merge string caps when there are numbers', function () {
+      const myCaps = {
+        CAP_STRING_1: 'Test',
+        CAP_STRING_2: '1234567892343434344'
+      }
+      const driver = new BotDriver(myCaps)
+      assert.strictEqual(driver.caps.CAP_STRING_1, myCaps.CAP_STRING_1)
+      assert.strictEqual(driver.caps.CAP_STRING_2, myCaps.CAP_STRING_2)
+    })
     it('should merge boolean envs', function () {
       process.env.BOTIUM_SIMPLEREST_PING_PROCESS_RESPONSE = 'NO'
       const driver = new BotDriver()