@hubot-friends/hubot-slack 3.4.0 → 3.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubot-friends/hubot-slack",
-  "version": "3.4.0",
+  "version": "3.6.0",
   "description": "A new Slack adapter for Hubot",
   "homepage": "https://github.com/hubot-friends/hubot-slack#readme",
   "main": "./index.mjs",
@@ -8,7 +8,7 @@
     "test": "node --test",
     "test:watch": "node --test --watch",
     "test:integration": "node --test --env-file=.env",
-    "start:local": "node --watch --env-file=.env node_modules/hubot/bin/hubot --adapter ../../../index.mjs --name jbot"
+    "start:local": "node --watch --env-file=.env node_modules/hubot/bin/hubot --adapter ../../../index.mjs --name gbot"
   },
   "keywords": [
     "hubot",
@@ -25,15 +25,15 @@
     "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"
   },
-  "peerDependencies": {
-    "hubot": "^11.6.0"
-  },
   "engines": {
     "node": ">= 18"
   },
+  "peerDependencies": {
+    "hubot": "^12.0.0"
+  },
   "devDependencies": {
     "pino-pretty": "^10.0.1"
   },

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

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 () => {