botium-core 1.15.5 → 1.15.8

package/package.json

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

package/src/Capabilities.js

@@ -104,6 +104,22 @@ module.exports = {
   SIMPLEREST_INBOUND_ORDER_UNSETTLED_EVENTS_JSONPATH: 'SIMPLEREST_INBOUND_ORDER_UNSETTLED_EVENTS_JSONPATH',
   SIMPLEREST_INBOUND_DEBOUNCE_TIMEOUT: 'SIMPLEREST_INBOUND_DEBOUNCE_TIMEOUT',
   SIMPLEREST_COOKIE_REPLICATION: 'SIMPLEREST_COOKIE_REPLICATION',
+  SIMPLEREST_NLP_INTENT_JSONPATH: 'SIMPLEREST_NLP_INTENT_JSONPATH',
+  SIMPLEREST_NLP_CONFIDENCE_JSONPATH: 'SIMPLEREST_NLP_CONFIDENCE_JSONPATH',
+  SIMPLEREST_NLP_CONFIDENCE_DIVIDEBY100: 'SIMPLEREST_NLP_CONFIDENCE_DIVIDEBY100',
+  SIMPLEREST_NLP_FALLBACK_INTENTS: 'SIMPLEREST_NLP_FALLBACK_INTENTS',
+  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 = []
@@ -496,6 +501,76 @@ module.exports = class SimpleRestContainer {
         })
         debug(`found response cards: ${util.inspect(cards)}`)
 
+        let nlp = { intent: {} }
+        const _normalizeIntent = (intent) => {
+          if ('name' in intent) {
+            if (!intent.name) {
+              intent.name = 'None'
+            }
+            const fallbackIntents = this.caps[Capabilities.SIMPLEREST_NLP_FALLBACK_INTENTS]
+            if (fallbackIntents) {
+              intent.incomprehension = this.caps[Capabilities.SIMPLEREST_NLP_FALLBACK_INTENTS].includes(intent.name) ? true : undefined
+            } else {
+              intent.incomprehension = intent.name.toLowerCase() === 'none' ? true : undefined
+            }
+          }
+
+          if (!_.isNil(intent.confidence)) {
+            if (typeof intent.confidence === 'string') {
+              intent.confidence = Number(intent.confidence)
+            }
+            if (_.isNil(this.caps[Capabilities.SIMPLEREST_NLP_CONFIDENCE_DIVIDEBY100]) ? intent.confidence > 1 : this.caps[Capabilities.SIMPLEREST_NLP_CONFIDENCE_DIVIDEBY100]) {
+              intent.confidence /= 100
+            }
+          }
+
+          return intent
+        }
+        const jsonPathIntent = this.caps[Capabilities.SIMPLEREST_NLP_INTENT_JSONPATH]
+        if (jsonPathIntent) {
+          const name = jp.query(jsonPathRoot, jsonPathIntent)
+          nlp.intent.name = name?.length ? name[0] : null
+        }
+        const jsonPathConfidence = this.caps[Capabilities.SIMPLEREST_NLP_CONFIDENCE_JSONPATH]
+        if (jsonPathConfidence) {
+          const confidence = jp.query(jsonPathRoot, jsonPathConfidence)
+          nlp.intent.confidence = confidence?.length ? confidence[0] : null
+        }
+        _normalizeIntent(nlp.intent)
+        const jsonPathList = this.caps[Capabilities.SIMPLEREST_NLP_LIST_JSONPATH]
+        const jsonPathListIntent = this.caps[Capabilities.SIMPLEREST_NLP_LIST_INTENT_JSONPATH]
+        const jsonPathListConfidence = this.caps[Capabilities.SIMPLEREST_NLP_LIST_CONFIDENCE_JSONPATH]
+        if (jsonPathList) {
+          const list = jp.query(jsonPathRoot, jsonPathList)
+          if (list?.length) {
+            const intentList = list[0].map(e => {
+              const name = jp.query(e, jsonPathListIntent)
+              const res = { name: name?.length ? name[0] : null }
+              if (jsonPathListConfidence) {
+                const confidence = jp.query(e, jsonPathListConfidence)
+                res.confidence = confidence?.length ? confidence[0] : null
+              }
+              _normalizeIntent(res)
+              return res
+            })
+            if (intentList.length > 0 && !nlp.intent.name) {
+              nlp.intent.name = intentList[0].name
+              nlp.intent.confidence = intentList[0].confidence
+            }
+
+            if (nlp.intent.name === intentList[0].name) {
+              intentList.shift()
+            }
+
+            nlp.intent.intents = intentList
+          }
+        }
+        if (Object.keys(nlp.intent).length > 0) {
+          debug(`found response nlp: ${util.inspect(nlp)}`)
+        } else {
+          nlp = null
+        }
+
         let hasMessageText = false
         const jsonPathsTexts = getAllCapValues(Capabilities.SIMPLEREST_RESPONSE_JSONPATH, this.caps)
         for (const jsonPath of jsonPathsTexts) {
@@ -509,19 +584,24 @@ module.exports = class SimpleRestContainer {
             if (!messageText) continue
 
             hasMessageText = true
-            const botMsg = { sourceData: body, messageText, media, buttons, cards }
+            const botMsg = { sourceData: body, messageText, media, buttons, nlp }
             await executeHook(this.caps, this.responseHook, Object.assign({ botMsg, botMsgRoot: jsonPathRoot, messageTextIndex }, this.view))
             result.push(botMsg)
           }
         }
 
         if (!hasMessageText) {
-          const botMsg = { messageText: '', sourceData: body, media, buttons, cards }
+          const botMsg = { messageText: '', sourceData: body, media, buttons, cards, nlp }
           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 || !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)}`)
           }
         }
       }
@@ -534,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
   }
 
@@ -550,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/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[*]',
@@ -1190,6 +1268,68 @@ describe('connectors.simplerest', function () {
 
       await container.Clean()
     })
+
+    it('should extract intent and confidence', async function () {
+      const myCaps = Object.assign({}, myCapsGet, {
+        [Capabilities.SIMPLEREST_NLP_INTENT_JSONPATH]: '$.intent.intentname',
+        [Capabilities.SIMPLEREST_NLP_CONFIDENCE_JSONPATH]: '$.intent.intentconfidence'
+      })
+      const driver = new BotDriver(myCaps)
+      const container = await driver.Build()
+      assert.equal(container.pluginInstance.constructor.name, 'SimpleRestContainer')
+
+      await container.Start()
+      const msgs = await container.pluginInstance._processBodyAsyncImpl({
+        intent: {
+          intentname: 'iname',
+          intentconfidence: '50'
+        }
+      }, {}, true)
+
+      assert.equal(msgs?.length, 1)
+      assert.exists(msgs[0].nlp)
+      assert.exists(msgs[0].nlp.intent)
+      assert.equal(msgs[0].nlp.intent.name, 'iname')
+      assert.equal(msgs[0].nlp.intent.confidence, 0.5)
+
+      await container.Clean()
+    })
+
+    it('should extract intent list', async function () {
+      const myCaps = Object.assign({}, myCapsGet, {
+        [Capabilities.SIMPLEREST_NLP_LIST_JSONPATH]: '$.intents',
+        [Capabilities.SIMPLEREST_NLP_LIST_INTENT_JSONPATH]: '$.intentname',
+        [Capabilities.SIMPLEREST_NLP_LIST_CONFIDENCE_JSONPATH]: '$.intentconfidence'
+      })
+      const driver = new BotDriver(myCaps)
+      const container = await driver.Build()
+      assert.equal(container.pluginInstance.constructor.name, 'SimpleRestContainer')
+
+      await container.Start()
+      const msgs = await container.pluginInstance._processBodyAsyncImpl({
+        intents: [
+          {
+            intentname: 'iname1',
+            intentconfidence: '50'
+          },
+          {
+            intentname: 'iname2',
+            intentconfidence: 25
+          }
+        ]
+      }, {}, true)
+
+      assert.equal(msgs?.length, 1)
+      assert.exists(msgs[0].nlp)
+      assert.exists(msgs[0].nlp.intent)
+      assert.equal(msgs[0].nlp.intent.name, 'iname1')
+      assert.equal(msgs[0].nlp.intent.confidence, 0.5)
+      assert.equal(msgs[0].nlp.intent.intents.length, 1)
+      assert.equal(msgs[0].nlp.intent.intents[0].name, 'iname2')
+      assert.equal(msgs[0].nlp.intent.intents[0].confidence, 0.25)
+
+      await container.Clean()
+    })
   })
 
   describe('parseCapabilities', function () {