Merge pull request #2278 from botpress/sp_slack-users

fix(channel-slack): added user info to messages

modules/channel-slack/README.md

@@ -23,11 +23,14 @@
 1. Edit `data/bots/YOUR_BOT_ID/config/channel-slack.json` (or create it) and set
 
 - enabled: Set to `true`
-- signingSecret: Take the value `Signing Secret` on the page `Basic Information`
-- botToken: Take the value `Bot User OAuth Access Token` on the page `OAuth & Permissions`
+- signingSecret: Take the value `Signing Secret` on the page **`Basic Information`**
+- botToken: Take the value `Bot User OAuth Access Token` on the page **`OAuth & Permissions`**
 
 2. Restart Botpress
 
+![botToken](./assets/botToken.png)
+![signingSecret](./assets/secret.png)
+
 ### Configure Callback on Slack
 
 These steps are required so users can click on quick reply buttons, select dropdown options or any other interactive method.

modules/channel-slack/package.json

@@ -22,6 +22,8 @@
     "@slack/interactive-messages": "^1.1.1",
     "@slack/rtm-api": "^5.0.1",
     "@slack/web-api": "^5.0.1",
-    "axios": "^0.19.0"
+    "axios": "^0.19.0",
+    "lru-cache": "^5.1.1",
+    "ms": "^2.1.2"
   }
 }

modules/channel-slack/src/backend/client.ts

@@ -4,6 +4,8 @@ import { WebClient } from '@slack/web-api'
 import axios from 'axios'
 import * as sdk from 'botpress/sdk'
 import _ from 'lodash'
+import LRU from 'lru-cache'
+import ms from 'ms'
 
 import { Config } from '../config'
 
@@ -15,6 +17,8 @@ const debugOutgoing = debug.sub('outgoing')
 
 const outgoingTypes = ['text', 'image', 'actions', 'typing', 'carousel']
 
+const userCache = new LRU({ max: 1000, maxAge: ms('1h') })
+
 export class SlackClient {
   private client: WebClient
   private rtm: RTMClient
@@ -86,11 +90,31 @@ export class SlackClient {
       debugIncoming(`Received real time payload %o`, payload)
 
       if (!discardedSubtypes.includes(payload.subtype)) {
-        await this.sendEvent(payload, { type: 'text', text: payload.text })
+        await this.sendEvent(payload, {
+          type: 'text',
+          text: _.find(_.at(payload, ['text', 'files.0.name', 'files.0.title']), x => x && x.length) || 'N/A'
+        })
       }
     })
 
-    await this.rtm.start()
+    return this.rtm.start()
+  }
+
+  private async _getUserInfo(userId: string) {
+    if (!userCache.has(userId)) {
+      const data = await new Promise((resolve, reject) => {
+        this.client.users
+          .info({ user: userId })
+          .then(data => resolve(data && data.user))
+          .catch(err => {
+            debug('error fetching user info:', err)
+            resolve({})
+          })
+      })
+      userCache.set(userId, data)
+    }
+
+    return userCache.get(userId) || {}
   }
 
   async handleOutgoingEvent(event: sdk.IO.Event, next: sdk.IO.MiddlewareNextCallback) {
@@ -133,13 +157,20 @@ export class SlackClient {
   private async sendEvent(ctx: any, payload: any) {
     const threadId = _.get(ctx, 'channel.id') || _.get(ctx, 'channel')
     const target = _.get(ctx, 'user.id') || _.get(ctx, 'user')
+    let user = {}
+
+    if (target && this.config.fetchUserInfo) {
+      try {
+        user = await this._getUserInfo(target.toString())
+      } catch (err) {}
+    }
 
     this.bp.events.sendEvent(
       this.bp.IO.Event({
         botId: this.botId,
         channel: 'slack',
         direction: 'incoming',
-        payload,
+        payload: { ...ctx, ...payload, user_info: user },
         type: payload.type,
         preview: payload.text,
         threadId: threadId && threadId.toString(),

modules/channel-slack/src/config.ts

@@ -14,4 +14,11 @@ export interface Config {
    * @default signin_secret
    */
   signingSecret: string
+
+  /**
+   * Fetch or not the user information when receiving a message.
+   * This uses caching for efficiency.
+   * @default true
+   */
+  fetchUserInfo: boolean
 }

modules/channel-slack/yarn.lock

@@ -3706,7 +3706,7 @@ ms@2.0.0:
   resolved "https://registry.yarnpkg.com/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8"
   integrity sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=
 
-ms@^2.1.1:
+ms@^2.1.1, ms@^2.1.2:
   version "2.1.2"
   resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009"
   integrity sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==