@hubot-friends/hubot-slack 3.1.1 → 3.1.3

package/README.md

@@ -71,8 +71,6 @@ Need to following events:
 - message.groups
 - message.mpim
 
-Then you'll have to install the Bot to your workspace. It's under the "OAuth Tokens" section on the same page. That's the Bot Token you'll need.
-
 ## Sample YAML
 The following YAML manifest will work.
 

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@hubot-friends/hubot-slack",
-  "version": "3.1.1",
+  "version": "3.1.3",
   "description": "A new Slack adapter for Hubot",
   "homepage": "https://github.com/hubot-friends/hubot-slack#readme",
   "main": "./index.mjs",
   "scripts": {
     "test": "node --test",
-    "test:watch": "node --test --watch"
+    "test:watch": "node --test --watch",
+    "test:integration": "node --test --env-file=.env"
   },
   "keywords": [
     "hubot",

package/src/Bot.mjs

@@ -237,7 +237,8 @@ class SlackBot extends Adapter {
     }
 
     this.client.socket.on('connected', () => {
-      this.robot.emit('connected');
+      this.emit('connected');
+      this.robot.emit('connected')
     });
 
     // Start logging in

package/src/SlackAdapter.mjs

@@ -172,16 +172,15 @@ class SlackAdapter extends Adapter {
     }
     async mapToHubotMessage(event) {
         // console.error(event)
-        const getUser = event.user ? this.#webClient.users.info.bind(this.#webClient.users.info) : this.#webClient.bots.info.bind(this.#webClient.bots.info)
-        const lookUpId = event.user ?? event.bot_id
-        const queryParameter = event.user ? { user: event.user } : { bot: event.bot_id }
-        const fromBrain = this.robot.brain.users()[lookUpId]
+        const fromBrain = this.robot.brain.users()[event.user]
         if(!fromBrain) {
-            const response = await getUser(queryParameter)
-            this.robot.brain.userForId(lookUpId, response.user ?? response.bot)
+            const response = await this.#webClient.users.info({
+                user: event.user
+            })
+            this.robot.brain.userForId(event.user, response.user)
         }
-        const fromUser = this.robot.brain.users()[lookUpId]
-        return new TextMessage(new User(lookUpId, {
+        const fromUser = this.robot.brain.users()[event.user]
+        return new TextMessage(new User(event.user, {
             room: event.channel,
             name: fromUser.name
         }), event.text, event.ts)

package/src/SlackAdapter.test.mjs

@@ -5,9 +5,7 @@ import { Robot, TextMessage } from 'hubot'
 import EventEmitter from 'node:events'
 
 const BOT_ID = 'U0AAATTTTTAAAAA'
-const SOME_USER_ID = 'U123ABC456'
-const WORKFLOW_BOT_ID = 'BB12033'
-const APP_ID = 'ASADFASDFASDDDS'
+
 class SlackClientMock extends EventEmitter {
     #useRtmConnect = false
     #delegate = null
@@ -24,27 +22,10 @@ class SlackClientMock extends EventEmitter {
         this.emit('authenticated', new Error('Not authenticated'))
     }
 }
-const buildATestBot = id => ({
-    ok: true,
-    bot: {
-        id: id,
-        deleted: false,
-        name: "beforebot",
-        updated: 1449272004,
-        app_id: "A123456",
-        user_id: "U123456",
-        icons: {
-            image_36: "https://...",
-            image_48: "https://...",
-            image_72: "https://..."
-        }
-    }
-})
-
 const buildATestUser = () => ({
   ok: true,
   user: {
-    id: SOME_USER_ID,
+    id: 'U123ABC456',
     team_id: 'TASDASDFSDD',
     name: 'bossdog',
     deleted: false,
@@ -109,61 +90,6 @@ const buildATestUser = () => ({
   }
 })
 
-const buildSlackMessageFromBot = (event, toBotId) => ({
-    ack: () => {},
-    envelope_id: 'e9b92395-bedd-4da7',
-    body: {
-        token: 'ASDFASFASDFASDFASDFASD',
-        team_id: 'TASDASDFSDD',
-        context_team_id: 'TASDASDFSDD',
-        context_enterprise_id: null,
-        api_app_id: 'ASADFASDFASDDDS',
-        event: {
-            subtype: 'bot_message',
-            text: event?.text ?? `<@${toBotId}> help`,
-            username: event?.username ?? 'Workflow',
-            type: event?.type ?? 'message',
-            bot_id: event?.bot_id ?? 'BB12033',
-            app_id: event?.app_id ?? APP_ID,
-            ts: event?.ts ?? '1688420854.574989',
-            blocks: event?.blocks ?? [],
-            channel: event?.channel ?? 'CASDFASDFASDSD',
-            event_ts: event?.ts ?? '1688420854.574989',
-            channel_type: event.channel_type ?? 'channel'
-        },
-        type: 'event_callback',
-        event_id: 'Ev05F9TNCNDB',
-        event_time: 1688420854,
-        authorizations: [
-            {
-                enterprise_id: null,
-                team_id: 'TASDASDFSDD',
-                user_id: toBotId,
-                is_bot: true,
-                is_enterprise_install: false
-            }
-        ],
-        is_ext_shared_channel: false,
-        event_context: '4-eyJldCI6Im'
-    },
-    event: {
-        subtype: 'bot_message',
-        text: event?.text ?? `<@${toBotId}> help`,
-        username: event?.username ?? 'Workflow',
-        type: event?.type ?? 'message',
-        bot_id: event?.bot_id ?? 'BB12033',
-        app_id: event?.app_id ?? APP_ID,
-        ts: event?.ts ?? '1688420854.574989',
-        blocks: event?.blocks ?? [],
-        channel: event?.channel ?? 'CASDFASDFASDSD',
-        event_ts: event?.ts ?? '1688420854.574989',
-        channel_type: event.channel_type ?? 'channel'
-    },
-    retry_num: 0,
-    retry_reason: '',
-    accepts_response_payload: false
-})
-
 const buildSlackMessage = event => ({
     ack: () => {},
     envelope_id: 'e9b92395-bedd-4da7',
@@ -177,7 +103,7 @@ const buildSlackMessage = event => ({
             client_msg_id: event?.messageId ?? 'be201e20-d035-44dc-a0e2',
             type: event?.type ?? 'message',
             text: event?.text ?? `<@${BOT_ID}> help`,
-            user: event?.user ?? SOME_USER_ID,
+            user: event?.user ?? 'U123ABC456',
             ts: event?.ts ?? '1688420854.574989',
             blocks: event?.blocks ?? [],
             team: event?.team ?? 'TASDASDFSDD',
@@ -196,7 +122,7 @@ const buildSlackMessage = event => ({
         client_msg_id: event?.messageId ?? 'be201e20-d035-44dc-a0e2-befc2b5bd13d',
         type: event?.type ?? 'message',
         text: event?.text ?? `<@${BOT_ID}> help`,
-        user: event?.user ?? SOME_USER_ID,
+        user: event?.user ?? 'U123ABC456',
         ts: event?.ts ?? '1688420854.574989',
         blocks: event?.blocks ?? [],
         team: event?.team ?? 'TASDASDFSDD',
@@ -216,7 +142,7 @@ const authenticatedPerson = obj => ({
         name: 'Team Name'
     },
     self: {
-        id: SOME_USER_ID,
+        id: BOT_ID,
         token: 'fake-token',
     }
 })
@@ -224,9 +150,9 @@ const authenticatedPerson = obj => ({
 const token = 'some-fake-token'
 const makeRobot = (delegate, webClientMock = {}) => {
     const robot = new Robot('Slack', false, 'hubot')
-    robot.brain.data.users[SOME_USER_ID] = {
-        id: SOME_USER_ID,
-        name: 'not hubot',
+    robot.brain.data.users['U123ABC456'] = {
+        id: 'U123ABC456',
+        name: 'hubot',
         room: 'CASDFASDFASDSD'
     }
 
@@ -309,12 +235,6 @@ describe('Listen to messages', async () => {
             async start(adapter) {
                 adapter.emit('authenticated', authenticatedPerson(), null)
             }
-        }, {
-            users: {
-                info(params) {
-                    return buildATestUser()
-                }
-            }
         })
         await robot.run()
     })
@@ -337,11 +257,11 @@ describe('Listen to messages', async () => {
             assert.ok(true, 'should be called for message')
         })
         const message = await robot.adapter.mapToHubotMessage(buildSlackMessage({
-            type: 'message',
-            channel: 'C123ABC456',
-            user: 'U123ABC456',
-            text: 'Hello world',
-            ts: 1355517523.000005
+            "type": "message",
+            "channel": "C123ABC456",
+            "user": "U123ABC456",
+            "text": "Hello world",
+            "ts": "1355517523.000005"
         }).event)
         await robot.receive(message)
         assert.deepEqual(wasCalled, true)
@@ -417,57 +337,4 @@ describe('Send messages back', async () => {
         assert.deepEqual(wasCalled, true)
         robot.shutdown()
     })
-
-    it('should reply to a message that was sent by a different bot, like Workflow situations', async () => {
-        let wasCalled = false
-        const robot = makeRobot({
-            async start(adapter) {
-                adapter.emit('authenticated', authenticatedPerson(), null)
-            }
-        }, {
-            chat: {
-                async postMessage({ channel, text }) {
-                    assert.deepEqual(channel, 'C123ABC456')
-                    assert.deepEqual(text, 'hi')
-                }
-            },
-            bots: {
-                info(params) {
-                    return buildATestBot(WORKFLOW_BOT_ID)
-                }
-            },
-            auth: {
-                test() {
-                    return {
-                        user_id: BOT_ID,
-                        user: 'hubot',
-                        team_id: 'T12345678',
-                        team: 'Team Name'
-                    }
-                }
-            }
-        })
-        robot.respond(/deploy (?<appName>.*) (?<environment>.*)/i, {id: 'message responder'},
-            context => {
-                console.log('called', context.message)
-                assert.deepEqual(context.message.text, '@hubot deploy redirector staging --version main-d349664')
-                context.reply('deploying')
-                robot.shutdown()
-                wasCalled = true
-            })
-        await robot.run()
-        const message = await robot.adapter.mapToHubotMessage(buildSlackMessageFromBot(
-            {
-                type: "message",
-                ts: 1355517523.000005,
-                text: `<@${BOT_ID}> deploy redirector staging --version main-d349664`,
-                bot_id: WORKFLOW_BOT_ID,
-                username: "github",
-                icons: {}
-            }, BOT_ID).event)
-        message.text = robot.adapter.replaceBotIdWithName(message)
-        await robot.receive(message)
-        robot.shutdown()
-        assert.deepEqual(wasCalled, true)
-    })
 })

package/test/Bot.mjs

@@ -747,4 +747,4 @@ describe('Users data', () => {
     slackbot.usersLoaded(null, stubs.wrongResponseUsersList)
     assert.deepEqual(slackbot.robot.brain.data.users[stubs.user.id], undefined)
   })
-})
+})

package/test/LongRunningTest.mjs

@@ -4,7 +4,9 @@ import { Robot, TextMessage, User } from 'hubot'
 
 import adapter from '../index.mjs'
 
-await test('long running script test', { timeout: 30 * 1000 }, async t => {
+// Skip this test because it requires real Slack tokens which I provide via a .env file
+// when testing locally. Not going to run this on CI for now.
+await test('long running script test', { timeout: 30 * 1000, skip: true }, async t => {
   await t.test('Should dedup messages', (t, done) => {
     const robot = new Robot(adapter, false, 'gbot')
     let counter = 0

package/test/Stubs.mjs

@@ -202,6 +202,7 @@ export default () => {
     connected: false,
     async start() {
       this.connected = true
+      this.emit('connected')
     },
     disconnect() {
       this.connected = false