@hubot-friends/hubot-slack 1.0.11 → 3.0.0

package/.github/issue_template.md

@@ -11,8 +11,8 @@ Describe your issue here.
 - [ ] discussion
 
 ### Requirements (place an `x` in each of the `[ ]`)
-* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackapi/hubot-slack/blob/master/.github/contributing.md) and have done my best effort to follow them.
-* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
+* [ ] I've read and understood the [Contributing guidelines](./contributing.md) and have done my best effort to follow them.
+* [ ] I've read and agree to the [Code of Conduct](./CODE_OF_CONDUCT.md).
 * [ ] I've searched for any related issues and avoided creating a duplicate issue.
 
 ---

package/.github/pull_request_template.md

@@ -4,5 +4,4 @@ Describe the goal of this PR. Mention any related Issue numbers.
 
 ### Requirements (place an `x` in each `[ ]`)
 
-* [ ] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/hubot-slack/blob/master/.github/contributing.md) and have done my best effort to follow them.
-* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
+* [ ] I've read and understood the [Contributing Guidelines](./contributing.md) and have done my best effort to follow them.

package/index.mjs

@@ -0,0 +1,21 @@
+import { SlackBot } from './src/Bot.mjs'
+import './src/Extensions.mjs'
+export default {
+  use (robot) {
+    let e
+    const options = {
+      appToken: process.env.HUBOT_SLACK_APP_TOKEN,
+      botToken: process.env.HUBOT_SLACK_BOT_TOKEN,
+      disableUserSync: (process.env.DISABLE_USER_SYNC != null),
+      apiPageSize: process.env.API_PAGE_SIZE,
+      installedTeamOnly: (process.env.INSTALLED_TEAM_ONLY != null)
+    }
+    try {
+      options.socketModeOptions = JSON.parse(process.env.HUBOT_SLACK_SOCKET_MODE_OPTS || '{}')
+    } catch (error) {
+      e = error
+      console.error(e)
+    }
+    return new SlackBot(robot, options)
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubot-friends/hubot-slack",
-  "version": "1.0.11",
+  "version": "3.0.0",
   "description": "A new Slack adapter for Hubot",
   "homepage": "https://github.com/hubot-friends/hubot-slack#readme",
   "main": "./index.js",
@@ -24,14 +24,13 @@
   },
   "dependencies": {
     "@slack/socket-mode": "^1.3.2",
-    "@slack/web-api": "^6.8.1"
+    "@slack/web-api": "^6.9.1"
   },
   "peerDependencies": {
-    "hubot": ">= 7.0.0"
+    "hubot": ">= 11"
   },
   "engines": {
-    "node": ">= 18.16.0",
-    "npm": ">= 9.5.1"
+    "node": ">= 18"
   },
   "devDependencies": {
     "pino-pretty": "^10.0.1"

package/src/{bot.js → Bot.mjs}

@@ -1,10 +1,8 @@
-const {Adapter, TextMessage, EnterMessage, LeaveMessage, TopicMessage, CatchAllMessage, User}  = require.main.require("hubot/es2015.js");
-const {SlackTextMessage, ReactionMessage, FileSharedMessage, MeMessage} = require("./message");
-
-const SocketModeClient = require('@slack/socket-mode').SocketModeClient;
-const WebClient = require('@slack/web-api').WebClient;
-
-const pkg = require("../package.json");
+import { Adapter, EnterMessage, LeaveMessage } from 'hubot'
+import { SlackTextMessage, ReactionMessage, FileSharedMessage } from './Message.mjs'
+import { SocketModeClient } from '@slack/socket-mode' 
+import { WebClient } from '@slack/web-api'
+import pkg from '../package.json' assert { type: 'json' }
 
 class SlackClient {
   static CONVERSATION_CACHE_TTL_MS =
@@ -20,7 +18,7 @@ class SlackClient {
       this.apiPageSize = parseInt(options.apiPageSize, 10);
     }
 
-    this.robot.logger.debug(`SocketModeClient initialized with options: ${JSON.stringify(options.socketModeOptions)}`);
+    this.robot.logger.debug(`SocketModeClient initialized with options: ${JSON.stringify(options.socketModeOptions) ?? ''}`);
 
     // Map to convert bot user IDs (BXXXXXXXX) to user representations for events from custom
     // integrations and apps without a bot user
@@ -58,23 +56,21 @@ class SlackClient {
     return this.socket.removeAllListeners();
   }
 
-  setTopic(conversationId, topic) {
+  async setTopic(conversationId, topic) {
     this.robot.logger.debug(`SlackClient#setTopic() with topic ${topic}`);
-    return this.web.conversations.info({channel: conversationId})
-      .then(res => {
-        const conversation = res.channel;
-        if (!conversation.is_im && !conversation.is_mpim) {
-          return this.web.conversations.setTopic({channel: conversationId, topic});
-        } else {
-          return this.robot.logger.debug(`Conversation ${conversationId} is a DM or MPDM. ` +
-                              "These conversation types do not have topics."
-          );
-        }
-    }).catch(error => {
-        return this.robot.logger.error(error, `Error setting topic in conversation ${conversationId}: ${error.message}`);
-    });
+    try {
+      const res = await this.web.conversations.info({channel: conversationId})
+      const conversation = res.channel;
+      if (!conversation.is_im && !conversation.is_mpim) {
+        return this.web.conversations.setTopic({channel: conversationId, topic});
+      } else {
+        return this.robot.logger.debug(`Conversation ${conversationId} is a DM or MPDM. These conversation types do not have topics.`);
+      }
+    } catch (error) {
+      this.robot.logger.error(error, `Error setting topic in conversation ${conversationId}: ${error.message}`);
+    }
   }
-  send(envelope, message) {
+  async send(envelope, message) {
     const room = envelope.room || envelope.id;
     if (room == null) {
       this.robot.logger.error("Cannot send message without a valid room. Envelopes should contain a room property set to a Slack conversation ID.");
@@ -83,13 +79,19 @@ class SlackClient {
     this.robot.logger.debug(`SlackClient#send() room: ${room}, message: ${message}`);
     if (typeof message !== "string") {
       message.channel = room
-      return this.web.chat.postMessage(message).then(result => {
+      try {
+        const result = await this.web.chat.postMessage(message)
         this.robot.logger.debug(`Successfully sent message to ${room}`)
-      }).catch(e => this.robot.logger.error(e, `SlackClient#send(message) error: ${e.message}`))
+      } catch (e) {
+        this.robot.logger.error(e, `SlackClient#send(message) error: ${e.message}`)
+      }
     } else {
-      return this.web.chat.postMessage({ channel: room, text: message }).then(result => {
+      try {
+        const result = await this.web.chat.postMessage({ channel: room, text: message })
         this.robot.logger.debug(`Successfully sent message (string) to ${room}`)
-      }).catch(e => this.robot.logger.error(e, `SlackClient#send(string) error: ${e.message}`))
+      } catch (e) {
+        this.robot.logger.error(e, `SlackClient#send(string) error: ${e.message}`)
+      }
     }
   }
   loadUsers(callback) {
@@ -121,20 +123,19 @@ class SlackClient {
     this.updateUserInBrain(r.user);
     return r.user;
   }
-  fetchConversation(conversationId) {
+  async fetchConversation(conversationId) {
     const expiration = Date.now() - SlackClient.CONVERSATION_CACHE_TTL_MS;
     if (((this.channelData[conversationId] != null ? this.channelData[conversationId].channel : undefined) != null) &&
       (expiration < (this.channelData[conversationId] != null ? this.channelData[conversationId].updated : undefined))) { return Promise.resolve(this.channelData[conversationId].channel); }
     if (this.channelData[conversationId] != null) { delete this.channelData[conversationId]; }
-    return this.web.conversations.info({channel: conversationId}).then(r => {
-      if (r.channel != null) {
-        this.channelData[conversationId] = {
-          channel: r.channel,
-          updated: Date.now()
-        };
-      }
-      return r.channel;
-    });
+    const r = await this.web.conversations.info({channel: conversationId})
+    if (r.channel != null) {
+      this.channelData[conversationId] = {
+        channel: r.channel,
+        updated: Date.now()
+      };
+    }
+    return r.channel;
   }
   updateUserInBrain(event_or_user) {
     let key, value;
@@ -246,7 +247,7 @@ class SlackBot extends Adapter {
    * @param {Object} envelope - fully documented in SlackClient
    * @param {...(string|Object)} messages - fully documented in SlackClient
    */
-  send(envelope, ...messages) {
+  async send(envelope, ...messages) {
     this.robot.logger.debug('Sending message to Slack');
     let callback = function() {};
     if (typeof(messages[messages.length - 1]) === "function") {
@@ -257,7 +258,15 @@ class SlackBot extends Adapter {
       // NOTE: perhaps do envelope manipulation here instead of in the client (separation of concerns)
       if (message !== "") { return this.client.send(envelope, message); }
     });
-    return Promise.all(messagePromises).then(callback.bind(null, null), callback);
+    let results = [];
+    try {
+      results = await Promise.all(messagePromises)
+      callback(null, null)
+    } catch (e) {
+      this.robot.logger.error(e);
+      callback(e, null);
+    }
+    return results;
   }
 
   /**
@@ -266,7 +275,7 @@ class SlackBot extends Adapter {
    * @param {Object} envelope - fully documented in SlackClient
    * @param {...(string|Object)} messages - fully documented in SlackClient
    */
-  reply(envelope, ...messages) {
+  async reply(envelope, ...messages) {
     this.robot.logger.debug('replying to message');
     let callback = function() {};
     if (typeof(messages[messages.length - 1]) === "function") {
@@ -283,7 +292,15 @@ class SlackBot extends Adapter {
         return this.client.send(envelope, message);
       }
     });
-    return Promise.all(messagePromises).then(callback.bind(null, null), callback);
+    let results = [];
+    try {
+      results = await Promise.all(messagePromises)
+      callback(null, null)
+    } catch (e) {
+      this.robot.logger.error(e);
+      callback(e, null);
+    }
+    return results;
   }
 
   /**
@@ -292,10 +309,8 @@ class SlackBot extends Adapter {
    * @param {Object} envelope - fully documented in SlackClient
    * @param {...string} strings - strings that will be newline separated and set to the conversation topic
    */
-  setTopic(envelope, ...strings) {
-    // TODO: if the sender is interested in the completion, the last item in `messages` will be a function
-    // TODO: this will fail if sending an object as a value in strings
-    return this.client.setTopic(envelope.room, strings.join("\n"));
+  async setTopic(envelope, ...strings) {
+    return await this.client.setTopic(envelope.room, strings.join("\n"));
   }
 
   /**
@@ -457,16 +472,13 @@ class SlackBot extends Adapter {
     // Hubot expects all user objects to have a room property that is used in the envelope for the message after it
     // is received
     from.room = channel ?? '';
-    
-    // looks like sometimes the profile is not set
-    if (from.profile) {
-      from.name = from.profile.display_name;
-    }
+    from.name = from?.profile?.display_name ?? null;
 
     // add the bot id to the message if it's a direct message
     message.body.event.text = this.addBotIdToMessage(message.body.event);
     message.body.event.text = this.replaceBotIdWithName(message.body.event);
     this.robot.logger.debug(`Text = ${message.body.event.text}`);
+    this.robot.logger.debug(`Event subtype = ${message.body.event?.subtype}`);
     try {
       switch (message.event.type) {
         case "member_joined_channel":
@@ -474,13 +486,13 @@ class SlackBot extends Adapter {
           this.robot.logger.debug(`Received enter message for user: ${from.id}, joining: ${channel}`);
           msg = new EnterMessage(from);
           msg.ts = message.event.ts;
-          this.receive(msg);
+          await this.receive(msg);
           break;
         case "member_left_channel":
           this.robot.logger.debug(`Received leave message for user: ${from.id}, joining: ${channel}`);
           msg = new LeaveMessage(user);
           msg.ts = message.ts;
-          this.receive(msg);
+          await this.receive(msg);
           break;
         case "reaction_added": case "reaction_removed":
           // Once again Hubot expects all user objects to have a room property that is used in the envelope for the message
@@ -494,18 +506,20 @@ class SlackBot extends Adapter {
           const item_user = (message.body.event.item_user != null) ? this.robot.brain.userForId(message.body.event.item_user.id, message.body.event.item_user) : {};
   
           this.robot.logger.debug(`Received reaction message from: ${from.id}, reaction: ${message.body.event.reaction}, item type: ${message.body.event.item.type}`);
-          this.receive(new ReactionMessage(message.body.event.type, from, message.body.event.reaction, item_user, message.body.event.item, message.body.event.event_ts));
+          await this.receive(new ReactionMessage(message.body.event.type, from, message.body.event.reaction, item_user, message.body.event.item, message.body.event.event_ts));
           break;
         case "file_shared":  
           this.robot.logger.debug(`Received file_shared message from: ${message.body.event.user_id}, file_id: ${message.body.event.file_id}`);
-          this.receive(new FileSharedMessage(from, message.body.event.file_id, message.body.event.event_ts));
+          await this.receive(new FileSharedMessage(from, message.body.event.file_id, message.body.event.event_ts));
           break;
         default:
           this.robot.logger.debug(`Received generic message: ${message.event.type}`);
-          SlackTextMessage.makeSlackTextMessage(from, null, message?.body?.event.text, message?.body?.event, channel, this.robot.name, this.robot.alias, this.client, (error, message) => {
-            if (error) { return this.robot.logger.error(error, `Dropping message due to error ${error.message}`); }
-            return this.receive(message);
-          });
+          try {
+            const msg = await SlackTextMessage.makeSlackTextMessage(from, null, message?.body?.event.text, message?.body?.event, channel, this.robot.name, this.robot.alias, this.client)
+            await this.receive(msg);
+          } catch (error) {
+            this.robot.logger.error(error, `Dropping message due to error ${error.message}`);
+          }
           break;
       }
     } catch (e) {
@@ -532,5 +546,7 @@ class SlackBot extends Adapter {
     return res.members.map((member) => this.client.updateUserInBrain(member));
   }
 }
-
-module.exports = SlackBot;
+export { 
+  SlackClient,
+  SlackBot
+}

package/src/{extensions.js → Extensions.mjs}

@@ -1,5 +1,5 @@
-let {Robot} = require.main.require("hubot/es2015.js");
-const {ReactionMessage, FileSharedMessage, MeMessage} = require("./message");
+import { Robot } from 'hubot'
+import { ReactionMessage, FileSharedMessage, MeMessage } from './Message.mjs'
 
 /**
  * Adds a Listener for ReactionMessages with the provided matcher, options, and callback

package/src/{mention.js → Mention.mjs}

@@ -1,4 +1,4 @@
-class SlackMention {
+export class SlackMention {
 	/**
 	 * SlackMention is an instance of a mention within a SlackTextMessage.
 	 * @constructor
@@ -12,4 +12,3 @@ class SlackMention {
 		this.info = info ?? undefined;
 	}
 }
-module.exports = SlackMention;

package/src/{message.js → Message.mjs}

@@ -1,6 +1,6 @@
-const {Message, TextMessage}  = require.main.require("hubot/es2015.js");
-const SlackClient = require("./client");
-const SlackMention = require("./mention");
+import { Message, TextMessage, TopicMessage } from 'hubot'
+import { SlackClient } from './Bot.mjs'
+import { SlackMention } from './Mention.mjs'
 
 class ReactionMessage extends Message {
 
@@ -114,10 +114,9 @@ class SlackTextMessage extends TextMessage {
    * @param {SlackClient} client - a client that can be used to get more data needed to build the text
    * @param {function} cb - callback for the result
    */
-  buildText(client, cb) {
+  async buildText(client) {
     // base text
     let text = (this.rawMessage.text != null) ? this.rawMessage.text : "";
-
     // flatten any attachments into text
     if (this.rawMessage.attachments) {
       const attachment_text = this.rawMessage.attachments.map(a => a.fallback).join("\n");
@@ -128,19 +127,18 @@ class SlackTextMessage extends TextMessage {
     const mentionFormatting = this.replaceLinks(client, text);
     // Fetch conversation info
     const fetchingConversationInfo = client.fetchConversation(this._channel_id);
-    return Promise.all([mentionFormatting, fetchingConversationInfo])
-      .then(results => {
-        const [ replacedText, conversationInfo ] = results;
-        text = replacedText;
-        text = text.replace(/&lt;/g, "<");
-        text = text.replace(/&gt;/g, ">");
-        text = text.replace(/&amp;/g, "&");
-        this.text = text;
-        return cb();
-    }).catch(error => {
-        client.robot.logger.error(error, `An error occurred while building text: ${error.message}`);
-        return cb(error);
-    });
+    let results = [];
+    try {
+      results = await Promise.all([mentionFormatting, fetchingConversationInfo]);
+      const [ replacedText, conversationInfo ] = results;
+      text = replacedText;
+      text = text.replace(/&lt;/g, "<");
+      text = text.replace(/&gt;/g, ">");
+      text = text.replace(/&amp;/g, "&");
+    } catch (e) {
+      client.robot.logger.error(e, `An error occurred while building text: ${e.message}`);
+    }
+    return text;
   }
 
   /**
@@ -271,26 +269,19 @@ class SlackTextMessage extends TextMessage {
    * @param {SlackClient} client - client used to fetch more data
    * @param {function} cb - callback to return the result
    */
-  static makeSlackTextMessage(user, text, rawText, rawMessage, channel_id, robot_name, robot_alias, client, cb) {
-    const message = new SlackTextMessage(user, text, rawText, rawMessage, channel_id, robot_name, robot_alias);
-
-    // creates a completion function that consistently calls the callback after this function has returned
-    const done = message => setImmediate(() => cb(null, message));
-
-    if ((message.text == null)) {
-      return message.buildText(client, function(error) {
-        if (error) {
-          return cb(error);
-        }
-        return done(message);
-      });
-    } else {
-      return done(message);
+  static async makeSlackTextMessage(user, text, rawText, rawMessage, channel_id, robot_name, robot_alias, client) {
+    if(rawMessage?.subtype) {
+      return new TopicMessage(user, rawMessage.text, rawMessage.event_ts)
     }
+    const message = new SlackTextMessage(user, text, rawText, rawMessage, channel_id, robot_name, robot_alias);
+    if (message.text !== null) return message;
+    message.text = await message.buildText(client);
+    return message;
   }
 }
-
-exports.SlackTextMessage = SlackTextMessage;
-exports.ReactionMessage = ReactionMessage;
-exports.FileSharedMessage = FileSharedMessage;
-exports.MeMessage = MeMessage;
+export {
+  SlackTextMessage,
+  ReactionMessage,
+  FileSharedMessage,
+  MeMessage
+}

package/src/SlackAdapter.mjs

@@ -1,6 +1,4 @@
-import Adapter from 'hubot/src/adapter.js'
-import { TextMessage } from 'hubot/src/message.js'
-import User from 'hubot/src/user.js'
+import { TextMessage, Adapter, User } from 'hubot'
 import { SocketModeClient } from '@slack/socket-mode'
 import { WebClient } from '@slack/web-api'
 

package/src/SlackAdapter.test.mjs

@@ -1,8 +1,7 @@
 import { describe, it, beforeEach, afterEach } from 'node:test'
 import assert from 'node:assert/strict'
 import { SlackAdapter } from './SlackAdapter.mjs'
-import Robot from 'hubot/src/robot.js'
-import { TextMessage } from 'hubot/src/message.js'
+import { Robot, TextMessage } from 'hubot'
 import EventEmitter from 'node:events'
 
 const BOT_ID = 'U0AAATTTTTAAAAA'