@hubot-friends/hubot-slack 3.0.3 → 3.1.0

package/.github/workflows/ci-build.yml

@@ -62,8 +62,7 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - '20.x'
-          - '22.x'
+          - '23.x'
     if: github.ref == 'refs/heads/main' && ${{ success() }}
     steps:
       - name: Checkout

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubot-friends/hubot-slack",
-  "version": "3.0.3",
+  "version": "3.1.0",
   "description": "A new Slack adapter for Hubot",
   "homepage": "https://github.com/hubot-friends/hubot-slack#readme",
   "main": "./index.mjs",

package/src/SlackAdapter.mjs

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

package/src/SlackAdapter.test.mjs

@@ -5,7 +5,9 @@ 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
@@ -22,10 +24,27 @@ 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: 'U123ABC456',
+    id: SOME_USER_ID,
     team_id: 'TASDASDFSDD',
     name: 'bossdog',
     deleted: false,
@@ -90,6 +109,61 @@ 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',
@@ -103,7 +177,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 ?? 'U123ABC456',
+            user: event?.user ?? SOME_USER_ID,
             ts: event?.ts ?? '1688420854.574989',
             blocks: event?.blocks ?? [],
             team: event?.team ?? 'TASDASDFSDD',
@@ -122,7 +196,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 ?? 'U123ABC456',
+        user: event?.user ?? SOME_USER_ID,
         ts: event?.ts ?? '1688420854.574989',
         blocks: event?.blocks ?? [],
         team: event?.team ?? 'TASDASDFSDD',
@@ -142,7 +216,7 @@ const authenticatedPerson = obj => ({
         name: 'Team Name'
     },
     self: {
-        id: BOT_ID,
+        id: SOME_USER_ID,
         token: 'fake-token',
     }
 })
@@ -150,9 +224,9 @@ const authenticatedPerson = obj => ({
 const token = 'some-fake-token'
 const makeRobot = (delegate, webClientMock = {}) => {
     const robot = new Robot('Slack', false, 'hubot')
-    robot.brain.data.users['U123ABC456'] = {
-        id: 'U123ABC456',
-        name: 'hubot',
+    robot.brain.data.users[SOME_USER_ID] = {
+        id: SOME_USER_ID,
+        name: 'not hubot',
         room: 'CASDFASDFASDSD'
     }
 
@@ -235,6 +309,12 @@ describe('Listen to messages', async () => {
             async start(adapter) {
                 adapter.emit('authenticated', authenticatedPerson(), null)
             }
+        }, {
+            users: {
+                info(params) {
+                    return buildATestUser()
+                }
+            }
         })
         await robot.run()
     })
@@ -257,11 +337,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)
@@ -337,4 +417,57 @@ 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)
+    })
 })