botium-core 1.15.6 → 1.15.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "botium-core",
-  "version": "1.15.6",
+  "version": "1.15.9",
   "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/Capabilities.js

@@ -111,6 +111,15 @@ module.exports = {
   SIMPLEREST_NLP_LIST_JSONPATH: 'SIMPLEREST_NLP_LIST_JSONPATH',
   SIMPLEREST_NLP_LIST_INTENT_JSONPATH: 'SIMPLEREST_NLP_LIST_INTENT_JSONPATH',
   SIMPLEREST_NLP_LIST_CONFIDENCE_JSONPATH: 'SIMPLEREST_NLP_LIST_CONFIDENCE_JSONPATH',
+  /**
+   * Single response can contain a list of messages. This capability defines how to merge the list into a single message.
+   * It can be 'OFF' (default), 'MERGE_TEXT'
+   * @type {string}
+   * @default 'OFF'
+   * @description Merge message list into single message
+   */
+  SIMPLEREST_MESSAGE_LIST_MERGE: 'SIMPLEREST_MESSAGE_LIST_MERGE',
+
   // Script Compiler
   SCRIPTING_TXT_EOL: 'SCRIPTING_TXT_EOL',
   // ROW_PER_MESSAGE or QUESTION_ANSWER

package/src/containers/plugins/SimpleRestContainer.js

@@ -369,7 +369,7 @@ module.exports = class SimpleRestContainer {
       return
     }
 
-    const result = []
+    let result = []
     if (isFromUser) {
       const _extractFrom = (root, jsonPaths, acceptFn = null) => {
         const result = []
@@ -402,6 +402,11 @@ module.exports = class SimpleRestContainer {
         jsonPathRoots.push(body)
       }
 
+      if (jsonPathRoots.length === 0 && !this.caps[Capabilities.SIMPLEREST_IGNORE_EMPTY]) {
+        debug(`found empty body, and processed because of SIMPLEREST_IGNORE_EMPTY capability: ${util.inspect(body)}`)
+        result.push({ messageText: '', sourceData: body })
+      }
+
       for (const jsonPathRoot of jsonPathRoots) {
         const _retrieveMedia = (jsonPathMediaRoot, jsonPathsMedia) => {
           const retrievedMedia = []
@@ -590,8 +595,13 @@ module.exports = class SimpleRestContainer {
           const beforeHookKeys = Object.keys(botMsg)
           await executeHook(this.caps, this.responseHook, Object.assign({ botMsg, botMsgRoot: jsonPathRoot }, this.view))
           const afterHookKeys = Object.keys(botMsg)
-          if (beforeHookKeys.length !== afterHookKeys.length || !!(botMsg.messageText && botMsg.messageText.length > 0) || botMsg.media.length > 0 || botMsg.buttons.length > 0 || botMsg.cards.length > 0 || botMsg.nlp || !this.caps[Capabilities.SIMPLEREST_IGNORE_EMPTY]) {
+          if (beforeHookKeys.length !== afterHookKeys.length || !!(botMsg.messageText && botMsg.messageText.length > 0) || botMsg.media.length > 0 || botMsg.buttons.length > 0 || botMsg.cards.length > 0 || botMsg.nlp) {
+            result.push(botMsg)
+          } else if (!this.caps[Capabilities.SIMPLEREST_IGNORE_EMPTY]) {
+            debug(`found empty message, and processed because of SIMPLEREST_IGNORE_EMPTY capability: ${util.inspect(botMsg)}`)
             result.push(botMsg)
+          } else {
+            debug(`found empty message, and ignored because of SIMPLEREST_IGNORE_EMPTY capability: ${util.inspect(botMsg)}`)
           }
         }
       }
@@ -604,6 +614,23 @@ module.exports = class SimpleRestContainer {
 
       setTimeout(() => this._doRequest({ messageText: '' }, true, true), 0)
     }
+
+    if (this.caps[Capabilities.SIMPLEREST_MESSAGE_LIST_MERGE] === 'MERGE_TEXT') {
+      const isTextMsg = (msg) => msg.messageText && (!msg.media || msg.media.length === 0) && (!msg.buttons || msg.buttons.length === 0) && (!msg.cards || msg.cards.length === 0)
+
+      result = result.reduce((acc, currentMsg) => {
+        if (acc.length > 0) {
+          const last = acc[acc.length - 1]
+          if (isTextMsg(last)) {
+            currentMsg.messageText = [last.messageText, currentMsg.messageText].filter(t => t).join('\n')
+            acc[acc.length - 1] = currentMsg
+            return acc
+          }
+        }
+        acc.push(currentMsg)
+        return acc
+      }, [])
+    }
     return result
   }
 
@@ -620,8 +647,7 @@ module.exports = class SimpleRestContainer {
           fetch(requestOptions.uri, requestOptions).then(async (bodyRaw) => {
             let body
             try {
-              const contentType = bodyRaw.headers.get('content-type')
-              if (contentType && contentType.includes('application/json')) {
+              if (bodyRaw?.headers?.get('content-type') && bodyRaw.headers.get('content-type').includes('application/json')) {
                 try {
                   body = await bodyRaw.json()
                 } catch (err) {

package/src/scripting/ScriptingProvider.js

@@ -377,7 +377,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 +393,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

package/test/connectors/simplerest.spec.js

@@ -810,6 +810,7 @@ describe('connectors.simplerest', function () {
 
       await container.Clean()
     })
+
     it('should parse jsonmessage from sourcedata if it enabled', async function () {
       const msgJSON = {
         sourceData: {
@@ -837,6 +838,7 @@ describe('connectors.simplerest', function () {
 
       await container.Clean()
     })
+
     it('should fall back to text message if using jsonmessage from sourcedata is enabled, but sourcedata is not set', async function () {
       const myCaps = Object.assign({}, myCapsPost)
       myCaps[Capabilities.SIMPLEREST_BODY_FROM_JSON] = true
@@ -855,6 +857,7 @@ describe('connectors.simplerest', function () {
 
       await container.Clean()
     })
+
     it('should handle somehow if jsonmessage from sourcedata is enabled, and booth json, and text are set in the user message (impossible state)', async function () {
       // this is not a valid state. In case there is a json as message in a convo.txt, text parser parses it into the sourceData field, and keeps messageText empty
       const msgTextAndJSONIllegal = {
@@ -903,6 +906,81 @@ describe('connectors.simplerest', function () {
       await container.Clean()
     })
 
+    it('should merge text responses', async function () {
+      const myCaps = Object.assign({}, myCapsGet, {
+        [Capabilities.SIMPLEREST_BODY_JSONPATH]: '$.responses[*]',
+        [Capabilities.SIMPLEREST_RESPONSE_JSONPATH]: '$.text',
+        [Capabilities.SIMPLEREST_BUTTONS_JSONPATH]: '$.buttons[*]',
+        [Capabilities.SIMPLEREST_BUTTONS_TEXT_SUBJSONPATH]: '$.text',
+        [Capabilities.SIMPLEREST_MEDIA_JSONPATH]: '$.media[*]',
+        [Capabilities.SIMPLEREST_MESSAGE_LIST_MERGE]: 'MERGE_TEXT'
+      })
+      const driver = new BotDriver(myCaps)
+      const container = await driver.Build()
+      await container.Start()
+      const msgs = await container.pluginInstance._processBodyAsyncImpl({
+        responses: [
+          { text: 'text 1' },
+          { text: 'text 2' },
+          { text: 'text 3', buttons: [{ text: 'button' }] },
+          { text: 'text 4' },
+          { media: ['some.jpg'] },
+          { text: 'text 5' },
+          { text: 'text 6' }
+        ]
+      }, {}, true)
+
+      assert.exists(msgs)
+      assert.equal(msgs.length, 3)
+      assert.equal(msgs[0].messageText, 'text 1\ntext 2\ntext 3')
+      assert.exists(msgs[0].buttons)
+      assert.equal(msgs[0].buttons.length, 1)
+      assert.equal(msgs[0].media.length, 0)
+      assert.equal(msgs[1].messageText, 'text 4')
+      assert.equal(msgs[1].buttons.length, 0)
+      assert.equal(msgs[1].media.length, 1)
+      assert.equal(msgs[2].messageText, 'text 5\ntext 6')
+      assert.equal(msgs[2].buttons.length, 0)
+      assert.equal(msgs[2].media.length, 0)
+      await container.Clean()
+    })
+
+    it('should not merge text responses', async function () {
+      const myCaps = Object.assign({}, myCapsGet, {
+        [Capabilities.SIMPLEREST_BODY_JSONPATH]: '$.responses[*]',
+        [Capabilities.SIMPLEREST_RESPONSE_JSONPATH]: '$.text',
+        [Capabilities.SIMPLEREST_BUTTONS_JSONPATH]: '$.buttons[*]',
+        [Capabilities.SIMPLEREST_BUTTONS_TEXT_SUBJSONPATH]: '$.text',
+        [Capabilities.SIMPLEREST_MEDIA_JSONPATH]: '$.media[*]'
+      })
+      const driver = new BotDriver(myCaps)
+      const container = await driver.Build()
+      await container.Start()
+      const msgs = await container.pluginInstance._processBodyAsyncImpl({
+        responses: [
+          { text: 'text 1' },
+          { text: 'text 2' },
+          { text: 'text 3', buttons: [{ text: 'button' }] },
+          { text: 'text 4' },
+          { media: ['some.jpg'] },
+          { text: 'text 5' },
+          { text: 'text 6' }
+        ]
+      }, {}, true)
+
+      assert.exists(msgs)
+      assert.equal(msgs.length, 7)
+      assert.equal(msgs[0].messageText, 'text 1')
+      assert.equal(msgs[1].messageText, 'text 2')
+      assert.equal(msgs[2].messageText, 'text 3')
+      assert.equal(msgs[3].messageText, 'text 4')
+      assert.equal(msgs[4].messageText, '')
+      assert.equal(msgs[5].messageText, 'text 5')
+      assert.equal(msgs[6].messageText, 'text 6')
+
+      await container.Clean()
+    })
+
     it('should ignore empty response', async function () {
       const myCaps = Object.assign({}, myCapsGet, {
         [Capabilities.SIMPLEREST_BODY_JSONPATH]: '$.responses[*]',

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()