Merge pull request #30 from codeforequity-at/develop

botium-connector-directline3 0.0.15

Author: Botium

README.md

@@ -76,6 +76,19 @@ To check the configuration, run the emulator (Botium CLI required) to bring up a
 
 Botium setup is ready, you can begin to write your [BotiumScript](https://github.com/codeforequity-at/botium-core/wiki/Botium-Scripting) files.
 
+## Finetuning Directline3 Activity
+
+For finetuning the [Activity object](https://docs.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference?view=azure-bot-service-4.0#activity-object) sent to your bot, you can use the [UPDATE_CUSTOM logic hook](https://botium.atlassian.net/wiki/spaces/BOTIUM/pages/48660497/Integrated+Logic+Hooks). This example will add some custom values to the [channelData](https://docs.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-channeldata?view=azure-bot-service-4.0):
+
+    #me
+    do some channel specific thingy ...
+    UPDATE_CUSTOM SET_ACTIVITY_VALUE|channelData|{"channelData1": "botium", "channelData2": "something else"}
+
+The parameters are:
+1. SET_ACTIVITY_VALUE
+2. The path to the activity field
+3. The value of the activity field
+
 ## Supported Capabilities
 
 Set the capability __CONTAINERMODE__ to __directline3__ to activate this connector.

index.js

@@ -1,4 +1,3 @@
-const util = require('util')
 const uuidv4 = require('uuid/v4')
 const mime = require('mime-types')
 const _ = require('lodash')
@@ -37,7 +36,7 @@ const Defaults = {
   [Capabilities.DIRECTLINE3_BUTTON_VALUE_FIELD]: 'name',
   [Capabilities.DIRECTLINE3_HANDLE_ACTIVITY_TYPES]: 'message',
   [Capabilities.DIRECTLINE3_ACTIVITY_VALUE_MAP]: {
-    'event': 'name'
+    event: 'name'
   }
 }
 
@@ -50,12 +49,12 @@ class BotiumConnectorDirectline3 {
   Validate () {
     debug('Validate called')
 
-    this.caps = Object.assign({}, Defaults, _.pickBy(this.caps, (value, key) => !Defaults.hasOwnProperty(key) || !_.isString(value) || value !== ''))
+    this.caps = Object.assign({}, Defaults, _.pickBy(this.caps, (value, key) => !Object.prototype.hasOwnProperty.call(Defaults, key) || !_.isString(value) || value !== ''))
 
-    if (!this.caps['DIRECTLINE3_SECRET']) throw new Error('DIRECTLINE3_SECRET capability required')
-    if (!this.caps['DIRECTLINE3_BUTTON_TYPE']) throw new Error('DIRECTLINE3_BUTTON_TYPE capability required')
-    if (!this.caps['DIRECTLINE3_BUTTON_VALUE_FIELD']) throw new Error('DIRECTLINE3_BUTTON_VALUE_FIELD capability required')
-    if (!this.caps['DIRECTLINE3_HANDLE_ACTIVITY_TYPES']) throw new Error('DIRECTLINE3_HANDLE_ACTIVITY_TYPES capability required')
+    if (!this.caps.DIRECTLINE3_SECRET) throw new Error('DIRECTLINE3_SECRET capability required')
+    if (!this.caps.DIRECTLINE3_BUTTON_TYPE) throw new Error('DIRECTLINE3_BUTTON_TYPE capability required')
+    if (!this.caps.DIRECTLINE3_BUTTON_VALUE_FIELD) throw new Error('DIRECTLINE3_BUTTON_VALUE_FIELD capability required')
+    if (!this.caps.DIRECTLINE3_HANDLE_ACTIVITY_TYPES) throw new Error('DIRECTLINE3_HANDLE_ACTIVITY_TYPES capability required')
 
     return Promise.resolve()
   }
@@ -69,20 +68,20 @@ class BotiumConnectorDirectline3 {
     debug('Start called')
     this._stopSubscription()
     this.directLine = new DirectLine({
-      secret: this.caps['DIRECTLINE3_SECRET'],
-      webSocket: this.caps['DIRECTLINE3_WEBSOCKET'],
-      domain: this.caps['DIRECTLINE3_DOMAIN'],
-      pollingInterval: this.caps['DIRECTLINE3_POLLINGINTERVAL']
+      secret: this.caps.DIRECTLINE3_SECRET,
+      webSocket: this.caps.DIRECTLINE3_WEBSOCKET,
+      domain: this.caps.DIRECTLINE3_DOMAIN,
+      pollingInterval: this.caps.DIRECTLINE3_POLLINGINTERVAL
     })
 
-    if (this.caps['DIRECTLINE3_GENERATE_USERNAME']) {
+    if (this.caps.DIRECTLINE3_GENERATE_USERNAME) {
       this.me = uuidv4()
     } else {
       this.me = 'me'
     }
 
     const isValidActivityType = (activityType) => {
-      const filter = this.caps['DIRECTLINE3_HANDLE_ACTIVITY_TYPES']
+      const filter = this.caps.DIRECTLINE3_HANDLE_ACTIVITY_TYPES
       if (_.isString(filter)) {
         return filter.indexOf(activityType) >= 0
       } else if (_.isArray(filter)) {
@@ -202,7 +201,7 @@ class BotiumConnectorDirectline3 {
                 }
               }
             } else {
-              const valueMap = this.caps['DIRECTLINE3_ACTIVITY_VALUE_MAP']
+              const valueMap = this.caps.DIRECTLINE3_ACTIVITY_VALUE_MAP
               if (valueMap && valueMap[message.type]) {
                 botMsg.messageText = message[valueMap[message.type]]
               } else {
@@ -243,7 +242,7 @@ class BotiumConnectorDirectline3 {
 
   UserSays (msg) {
     debug('UserSays called')
-    return new Promise(async (resolve, reject) => {
+    return new Promise(async (resolve, reject) => { // eslint-disable-line no-async-promise-executor
       const activity = msg.sourceData || {}
       if (msg.buttons && msg.buttons.length > 0 && (msg.buttons[0].text || msg.buttons[0].payload)) {
         let payload = msg.buttons[0].payload || msg.buttons[0].text
@@ -272,14 +271,22 @@ class BotiumConnectorDirectline3 {
         })
       }
 
+      if (msg.SET_ACTIVITY_VALUE) {
+        _.keys(msg.SET_ACTIVITY_VALUE).forEach(key => {
+          _.set(activity, key, msg.SET_ACTIVITY_VALUE[key])
+        })
+      }
+
       if (msg.media && msg.media.length > 0) {
         debug('Posting activity with attachments ', JSON.stringify(activity, null, 2))
         const formData = new FormData()
 
-        formData.append('activity', Buffer.from(JSON.stringify(activity)), {
-          contentType: 'application/vnd.microsoft.activity',
-          filename: 'blob'
-        })
+        if (activity.text) {
+          formData.append('activity', Buffer.from(JSON.stringify(activity)), {
+            contentType: 'application/vnd.microsoft.activity',
+            filename: 'blob'
+          })
+        }
 
         for (let i = 0; i < msg.media.length; i++) {
           const attachment = msg.media[i]
@@ -294,30 +301,33 @@ class BotiumConnectorDirectline3 {
             const { body } = await fetch(attachment.mediaUri)
 
             formData.append('file', body, {
-              filename: attachmentName
+              filename: attachmentName,
+              contentType: 'image/png'
             })
           }
         }
 
-        // Ensure directline is connected!
         await this.directLine.checkConnection(true)
-        fetch(`${this.directLine.domain}/conversations/${this.directLine.conversationId}/upload?userId=${activity.from.id}`, {
+        const uploadUrl = `${this.directLine.domain}/conversations/${this.directLine.conversationId}/upload?userId=${activity.from.id}`
+        debug(`Uploading attachments to ${uploadUrl}`)
+        fetch(uploadUrl, {
           method: 'POST',
           headers: {
-            'Authorization': `Bearer ${this.directLine.token}`
+            Authorization: `Bearer ${this.directLine.token}`,
+            'Content-Type': 'multipart/form-data'
           },
           body: formData
-        }).catch(err => {
-          debug('Error posting activity with attachments', err)
-          reject(new Error(`Error posting activity: ${err}`))
         }).then(async (res) => {
           const json = await res.json()
-          if (json.id) {
+          if (json && json.id) {
             debug('Posted activity with attachments, assigned ID:', json.id)
             resolve()
           } else {
-            reject(new Error(`Error posting activity with attachments: ${util.inspect(json)}`))
+            reject(new Error('Error posting activity with attachments, no activity id returned'))
           }
+        }).catch(err => {
+          debug('Error posting activity with attachments', err)
+          reject(new Error(`Error posting activity: ${err.message}`))
         })
       } else {
         debug('Posting activity ', JSON.stringify(activity, null, 2))
@@ -359,6 +369,11 @@ class BotiumConnectorDirectline3 {
       this.connSubscription.unsubscribe()
       this.connSubscription = null
     }
+    if (this.directLine) {
+      debug('ending directline connection')
+      this.directLine.end()
+      this.directLine = null
+    }
   }
 
   _deepFilter (item, selectFn, filterFn) {

package.json

@@ -1,12 +1,13 @@
 {
   "name": "botium-connector-directline3",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "description": "Botium Connector for Bot Framework Direct Line 3 API",
   "main": "dist/botium-connector-directline3-cjs.js",
   "module": "dist/botium-connector-directline3-es.js",
   "scripts": {
     "build": "npm run eslint && rollup -c",
-    "eslint": "eslint index.js"
+    "eslint": "eslint index.js",
+    "eslint-fix": "eslint --fix index.js"
   },
   "repository": {
     "type": "git",
@@ -19,31 +20,31 @@
   },
   "homepage": "https://github.com/codeforequity-at/botium-connector-directline3#readme",
   "devDependencies": {
-    "@babel/core": "^7.2.2",
-    "@babel/node": "^7.2.2",
-    "@babel/plugin-transform-runtime": "^7.2.0",
-    "@babel/preset-env": "^7.2.3",
-    "eslint": "^5.12.0",
-    "eslint-config-standard": "^12.0.0",
-    "eslint-plugin-import": "^2.14.0",
-    "eslint-plugin-node": "^8.0.1",
-    "eslint-plugin-promise": "^4.0.1",
-    "eslint-plugin-standard": "^4.0.0",
-    "rollup": "^0.58.2",
-    "rollup-plugin-babel": "^4.3.2",
-    "rollup-plugin-commonjs": "^9.1.3",
-    "rollup-plugin-json": "^2.3.0",
-    "rollup-plugin-node-resolve": "^3.3.0"
+    "@babel/core": "^7.6.0",
+    "@babel/node": "^7.6.1",
+    "@babel/plugin-transform-runtime": "^7.6.0",
+    "@babel/preset-env": "^7.6.0",
+    "eslint": "^6.3.0",
+    "eslint-config-standard": "^14.1.0",
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-node": "^10.0.0",
+    "eslint-plugin-promise": "^4.2.1",
+    "eslint-plugin-standard": "^4.0.1",
+    "rollup": "^1.21.2",
+    "rollup-plugin-babel": "^4.3.3",
+    "rollup-plugin-commonjs": "^10.1.0",
+    "rollup-plugin-json": "^4.0.0",
+    "rollup-plugin-node-resolve": "^5.2.0"
   },
   "dependencies": {
-    "@babel/runtime": "^7.2.0",
-    "botframework-directlinejs": "^0.9.17",
-    "debug": "^3.1.0",
-    "form-data": "^2.3.3",
-    "lodash": "^4.17.11",
-    "mime-types": "^2.1.20",
-    "node-fetch": "^2.3.0",
-    "uuid": "^3.3.2",
-    "xhr2": "^0.1.4"
+    "@babel/runtime": "^7.6.0",
+    "botframework-directlinejs": "^0.11.4",
+    "debug": "^4.1.1",
+    "form-data": "^2.5.1",
+    "lodash": "^4.17.15",
+    "mime-types": "^2.1.24",
+    "node-fetch": "^2.6.0",
+    "uuid": "^3.3.3",
+    "xhr2": "^0.2.0"
   }
 }

samples/convo/botium.json

@@ -4,8 +4,6 @@
       "PROJECTNAME": "Directline3 Plugin Sample",
       "CONTAINERMODE": "directline3",
       "DIRECTLINE3_SECRET": "my-directline-secret",
-      "DIRECTLINE3_WEBSOCKET": true,
-      "DIRECTLINE3_POLLINGINTERVAL": 1000,
       "DIRECTLINE3_BUTTON_TYPE": "message",
       "DIRECTLINE3_BUTTON_VALUE_FIELD": "text",
       "DIRECTLINE3_HANDLE_ACTIVITY_TYPES": "message,event"

samples/convo/spec/convo/adaptive.convo.txt

@@ -3,8 +3,5 @@ adaptive
 #me
 BUTTON card bingsports
 
-#bot
-Welcome to Mockbot v4!
-
 #bot
 BUTTONS Image action|Column action|Container action

samples/convo/spec/convo/button.convo.txt

@@ -3,8 +3,5 @@ button
 #me
 BUTTON card markdown
 
-#bot
-Welcome to Mockbot v4!
-
 #bot
 Showing  markdown

samples/convo/spec/convo/card.convo.txt

@@ -3,9 +3,6 @@ card
 #me
 BUTTON thumbnailcard
 
-#bot
-Welcome to Mockbot v4!
-
 #bot
 Microsoft Surface Pro
 MEDIA surface1.jpg

samples/convo/spec/convo/channeldata.convo.txt

@@ -0,0 +1,9 @@
+channeldata
+
+#me
+channel-data
+UPDATE_CUSTOM SET_ACTIVITY_VALUE|channelData|{"channelData1": "botium", "channelData2": "something else"}
+
+#bot
+Dump of the channel data from the activity sent by the user.
+JSON_PATH $.attachments

samples/convo/spec/convo/event.convo.txt

@@ -3,9 +3,6 @@ event
 #me
 sample:backchannel
 
-#bot
-Welcome to Mockbot v4!
-
 #bot
 I am sending an `event` activity like below
 

samples/convo/spec/convo/form.convo.txt

@@ -3,9 +3,6 @@ form
 #me
 BUTTON card inputs
 
-#bot
-Welcome to Mockbot v4!
-
 #bot
 BUTTONS Open Url|Submit|Show Card