@hubot-friends/hubot-slack 3.5.0 → 3.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubot-friends/hubot-slack",
-  "version": "3.5.0",
+  "version": "3.7.0",
   "description": "A new Slack adapter for Hubot",
   "homepage": "https://github.com/hubot-friends/hubot-slack#readme",
   "main": "./index.mjs",
@@ -25,7 +25,7 @@
     "url": "https://github.com/hubot-friends/hubot-slack/issues"
   },
   "dependencies": {
-    "@slack/socket-mode": "^1.3.2",
+    "@slack/socket-mode": "^2.0.4",
     "@slack/web-api": "^6.11.2"
   },
   "engines": {

package/src/Bot.mjs

@@ -31,7 +31,7 @@ class SlackClient {
 
     // Event handling
     // NOTE: add channel join and leave events
-    this.socket.on('authenticated', this.eventWrapper, this);
+    this.socket.on("authenticated", this.eventWrapper, this);
     this.socket.on("message", this.eventWrapper, this);
     this.socket.on("reaction_added", this.eventWrapper, this);
     this.socket.on("reaction_removed", this.eventWrapper, this);
@@ -203,8 +203,7 @@ class SlackBot extends Adapter {
     }
 
     this.client.socket.on("open", this.open.bind(this));
-    this.client.socket.on("close", this.close.bind(this));
-    this.client.socket.on("disconnect", this.disconnect.bind(this));
+    this.client.socket.on("close", this.onSocketClose.bind(this));
     this.client.socket.on("error", this.error.bind(this));
     this.client.socket.on("authenticated", this.authenticated.bind(this));
     this.client.onEvent(this.eventHandler.bind(this));
@@ -358,16 +357,23 @@ class SlackBot extends Adapter {
    * Slack client has closed the connection
    * @private
    */
-  close() {
-    // NOTE: not confident that @options.autoReconnect works
-    if (this.options.autoReconnect) {
+  onSocketClose() {
+    if (this.socket.autoReconnectEnabled && !this.socket.shuttingDown) {
       this.robot.logger.info("Disconnected from Slack Socket");
       return this.robot.logger.info("Waiting for reconnect...");
     } else {
-      return this.disconnect();
+      return this.robot.logger.info("Disconnected from Slack Socket");
     }
   }
 
+  /**
+   * Close the connection
+   * @private
+   */
+  close() {
+    this.disconnect();
+  }
+
   /**
    * Slack client has closed the connection and will not reconnect
    * @private
@@ -432,10 +438,11 @@ class SlackBot extends Adapter {
    */
   async eventHandler(message) {
     this.robot.logger.debug(`eventHandler ${JSON.stringify(message, null, 2)}`);
+    if (message?.ack) {
+      await message?.ack();
+    }
+
     if(!message?.body?.event?.user) {
-      if (message?.ack) {
-        return await message?.ack();
-      }
       return;
     }
 
@@ -455,9 +462,7 @@ class SlackBot extends Adapter {
 
     // Ignore anything we sent
     if (from?.id === this.self.user_id) { 
-      if (message?.ack) {
-        return await message?.ack();
-      }
+      return ;
     }
     
     this.robot.logger.debug(`event ${JSON.stringify(message, null, 2)} user = ${user}`);
@@ -468,7 +473,7 @@ class SlackBot extends Adapter {
     //   // Skip events generated by other workspace users in a shared channel
     //   if ((event_team_id != null) && (event_team_id !== this.self.installed_team_id)) {
     //     this.robot.logger.debug(`Skipped an event generated by an other workspace user (team: ${event_team_id}) in shared channel (channel: ${channel})`);
-    //     return await message?.ack();
+    //     return;
     //   }
     // }
 
@@ -487,8 +492,7 @@ class SlackBot extends Adapter {
     // Ignore messages we've already seen
     if (this.seenMessages.has(message.body.event.client_msg_id)) {
       this.robot.logger.debug(`Ignoring message ${message.body.event.client_msg_id}`);
-      if (!message?.ack) return;
-      return await message.ack();
+      return;
     }
 
     this.seenMessages.add(message.body.event.client_msg_id);
@@ -542,10 +546,6 @@ class SlackBot extends Adapter {
       this.robot.logger.debug(`Removing message ${message.body.event.client_msg_id}`);
       this.seenMessages.delete(message.body.event.client_msg_id);
     }
-
-    if (message?.ack) {
-      return await message?.ack();
-    }
   }
 
   /**

package/test/Bot.mjs

@@ -1,4 +1,4 @@
-import { describe, it, beforeEach } from 'node:test'
+import { describe, it, beforeEach, mock } from 'node:test'
 import assert from 'node:assert/strict'
 import { SlackBot } from '../src/Bot.mjs'
 import hubotSlackMock from '../index.mjs'
@@ -76,6 +76,65 @@ describe('Authenticate', () => {
   })
 })
 
+describe('Socket', () => {
+  let stubs, slackbot
+  beforeEach(async () => {
+    ({stubs, slackbot} = (await import('./Stubs.mjs')).default())
+    slackbot.socket.disconnect = mock.fn(() => {
+      slackbot.socket.shuttingDown = true
+      slackbot.socket.emit('close')
+    })
+  })
+
+  it('Should socket.disconnect() once', async () => {
+    slackbot.socket.autoReconnectEnabled = false
+
+    await slackbot.run()
+    await slackbot.socket.disconnect()
+    assert.equal(slackbot.socket.disconnect.mock.callCount(), 1)
+  })
+
+  it('Should log socket close event when we call socket.disconnect()', async () => {
+    const { logger } = slackbot.robot
+    
+    slackbot.socket.autoReconnectEnabled = true
+
+    await slackbot.run()
+    await slackbot.socket.disconnect()
+    assert.deepEqual(logger.logs.info.slice(-1), ['Disconnected from Slack Socket'])
+  })
+
+  it('Should log waiting for reconnect on socket close event', async () => {
+    const { logger } = slackbot.robot
+    // Skip socket.disconnect() because it overrides automatic reconnect
+    slackbot.socket.websocket = {
+      disconnect: mock.fn(() => {
+        slackbot.socket.emit('close')
+      })
+    }
+    slackbot.socket.autoReconnectEnabled = true
+
+    await slackbot.run()
+    await slackbot.socket.websocket.disconnect()
+    assert.deepEqual(logger.logs.info.slice(-2), ['Disconnected from Slack Socket', 'Waiting for reconnect...'])
+  })
+
+  it('Should log socket close event', async () => {
+    const { logger } = slackbot.robot
+    // Skip socket.disconnect() because it overrides automatic reconnect
+    slackbot.socket.websocket = {
+      disconnect: mock.fn(() => {
+        slackbot.socket.emit('close')
+      })
+    }
+    slackbot.socket.autoReconnectEnabled = false
+
+    await slackbot.run()
+    await slackbot.socket.websocket.disconnect()
+    assert.deepEqual(logger.logs.info.slice(-1), ['Disconnected from Slack Socket'])
+  })
+})
+
 describe('Logger', () => {
   let stubs, slackbot
   beforeEach(async () => {