Updated Logic and Tests for Slack SDK v3 support #309
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,7 @@ | ||
| {Robot, Adapter, EnterMessage, LeaveMessage, TopicMessage} = require 'hubot' | ||
| {SlackTextMessage, SlackRawMessage, SlackBotMessage} = require './message' | ||
| # {SlackRawListener, SlackBotListener} = require './listener' | ||
| {RtmClient, MemoryDataStore} = require '@slack/client' | ||
|
|
||
| class SlackBot extends Adapter | ||
| @MAX_MESSAGE_LENGTH: 4000 | ||
|
|
@@ -17,33 +15,31 @@ class SlackBot extends Adapter | |
| exitProcessOnDisconnect = !!process.env.HUBOT_SLACK_EXIT_ON_DISCONNECT | ||
|
|
||
| # Take our options from the environment, and set otherwise suitable defaults | ||
| @options = | ||
| autoMark: true | ||
| logLevel: 'error' | ||
| dataStore: new MemoryDataStore() | ||
| token: process.env.HUBOT_SLACK_TOKEN | ||
| autoReconnect: !exitProcessOnDisconnect | ||
|
|
||
| return @robot.logger.error "No services token provided to Hubot" unless @options.token | ||
| return @robot.logger.error "v2 services token provided, please follow the upgrade instructions" unless (@options.token.substring(0, 5) in ['xoxb-', 'xoxp-']) | ||
|
|
||
| # Create our slack client object | ||
| @client = new RtmClient @options.token, @options | ||
|
|
||
| # Setup event handlers | ||
| # TODO: Handle eventual events at (re-)connection time for unreads and provide a config for whether we want to process them | ||
| @client.on 'error', @error | ||
| @client.on 'loggedIn', @loggedIn | ||
| @client.on 'open', @open | ||
| @client.on 'close', @clientClose | ||
| @client.on 'message', @message | ||
| @client.on 'userChange', @userChange | ||
| @robot.brain.on 'loaded', @brainLoaded | ||
|
|
||
| @robot.on 'slack-attachment', @customMessage | ||
| @robot.on 'slack.attachment', @customMessage | ||
|
|
||
| # Start logging in | ||
| @client.login() | ||
|
|
@@ -62,12 +58,12 @@ class SlackBot extends Adapter | |
| # Provide our name to Hubot | ||
| @robot.name = self.name | ||
|
|
||
| for id, user of @client.dataStore.users | ||
| @userChange user | ||
|
|
||
| brainLoaded: => | ||
| # once the brain has loaded, reload all the users from the client | ||
| for id, user of @client.dataStore.users | ||
| @userChange user | ||
|
|
||
| # also wipe out any broken users stored under usernames instead of ids | ||
|
|
@@ -82,9 +78,9 @@ class SlackBot extends Adapter | |
| email_address: user.profile.email | ||
| slack: {} | ||
| for key, value of user | ||
| # don't store the RtmClient, because it'd cause a circular reference | ||
| # (it contains users and channels), and because it has sensitive information like the token | ||
| continue if value instanceof RtmClient | ||
| newUser.slack[key] = value | ||
|
|
||
| if user.id of @robot.brain.data.users | ||
|
|
@@ -103,23 +99,28 @@ class SlackBot extends Adapter | |
| clientClose: => | ||
| if @options.exitOnDisconnect | ||
| @robot.logger.info 'Slack client connection was closed, exiting hubot process' | ||
| @client.removeListener 'error', @error | ||
| @client.removeListener 'loggedIn', @loggedIn | ||
| @client.removeListener 'open', @open | ||
| @client.removeListener 'close', @clientClose | ||
| @client.removeListener 'message', @message | ||
| @client.removeListener 'userChange', @userChange | ||
| process.exit 1 | ||
| else | ||
| @robot.logger.info 'Slack client closed, waiting for reconnect' | ||
|
|
||
| message: (msg) => | ||
| # Ignore our own messages | ||
| return if msg.user and msg.user == @id | ||
|
|
||
| channel = @client.dataStore.getChannelGroupOrDMById msg.channel if msg.channel | ||
| user = @client.dataStore.getUserById msg.user if msg.user | ||
| user.room ?= msg.channel if channel and user | ||
|
|
||
| rawText = msg.getBody() | ||
|
There was a problem hiding this comment. Getting |
||
| text = @removeFormatting rawText | ||
|
|
||
| if msg.hidden or (not rawText and not msg.attachments) or msg.subtype is 'bot_message' or not msg.user or not channel | ||
| # use a raw message, so scripts that care can still see these things | ||
|
|
||
| if msg.user | ||
|
|
@@ -131,8 +132,6 @@ class SlackBot extends Adapter | |
| user.name = msg.username if msg.username? | ||
| user.room = channel.name if channel | ||
|
|
||
|
|
||
| if msg.subtype is 'bot_message' | ||
| @robot.logger.debug "Received bot message: '#{text}' in channel: #{channel?.name}, from: #{user?.name}" | ||
|
|
@@ -142,10 +141,6 @@ class SlackBot extends Adapter | |
| @receive new SlackRawMessage user, text, rawText, msg | ||
| return | ||
|
|
||
| # Test for enter/leave messages | ||
| if msg.subtype is 'channel_join' or msg.subtype is 'group_join' | ||
| @robot.logger.debug "#{user.name} has joined #{channel.name}" | ||
|
|
@@ -160,14 +155,10 @@ class SlackBot extends Adapter | |
| @receive new TopicMessage user, msg.topic, msg.ts | ||
|
|
||
| else | ||
| @robot.logger.debug "Received message: '#{text}' in channel: #{user.room}, from: #{user.name}" | ||
|
|
||
| # If this is a DM, pretend it was addressed to us | ||
| if msg.channel[0] == 'D' | ||
| text = "#{@robot.name} #{text}" | ||
|
|
||
| @receive new SlackTextMessage user, text, rawText, msg | ||
|
|
@@ -188,13 +179,13 @@ class SlackBot extends Adapter | |
|
|
||
| when '@' | ||
| if label then return label | ||
| user = @client.dataStore.getUserById link | ||
| if user | ||
| return "@#{user.name}" | ||
|
|
||
| when '#' | ||
| if label then return label | ||
| channel = @client.dataStore.getChannelById link | ||
| if channel | ||
| return "\##{channel.name}" | ||
|
|
||
|
|
@@ -214,21 +205,12 @@ class SlackBot extends Adapter | |
| text | ||
|
|
||
| send: (envelope, messages...) -> | ||
| for msg in messages | ||
| continue if msg.length < SlackBot.MIN_MESSAGE_LENGTH | ||
|
|
||
| # Replace @username with <@UXXXXX> for mentioning users and channels | ||
| msg = msg.replace /(?:^| )@([\w]+)/gm, (match, p1) => | ||
| user = @client.dataStore.getUserByName p1 | ||
| if user | ||
| match = match.replace /@[\w]+/, "<@#{user.id}>" | ||
| else if p1 in SlackBot.RESERVED_KEYWORDS | ||
|
|
@@ -237,9 +219,9 @@ class SlackBot extends Adapter | |
| match = match | ||
|
|
||
| @robot.logger.debug "Sending to #{envelope.room}: #{msg}" | ||
| if msg.length <= SlackBot.MAX_MESSAGE_LENGTH | ||
| @client.sendMessage msg, envelope.room | ||
|
|
||
|
There was a problem hiding this comment. Why did this logic get cut? Did I do that? There was a problem hiding this comment. Nope. I cut it because we're send from the client now, rather than the channel object. I didn't see where else we were using channel here and figured it could go. Very possible I missed something though. There was a problem hiding this comment. It looks like if it doesn't find a valid channel in the envelope, it opens a DM with the sending user. The reason and purpose of this logic isn't totally clear to me, but it is a a bit of functionality we probably shouldn't elide. |
||
| # If message is greater than MAX_MESSAGE_LENGTH, split it into multiple messages | ||
| else | ||
|
|
@@ -271,7 +253,7 @@ class SlackBot extends Adapter | |
|
|
||
| msg = msg.substring(breakIndex, msg.length) | ||
|
|
||
| @client.sendMessage(m, envelope.room) for m in submessages | ||
|
|
||
| reply: (envelope, messages...) -> | ||
| @robot.logger.debug "Sending reply" | ||
|
|
@@ -281,7 +263,7 @@ class SlackBot extends Adapter | |
| @send envelope, "<@#{envelope.user.id}>: #{msg}" | ||
|
|
||
| topic: (envelope, strings...) -> | ||
| channel = @client.dataStore.getChannelGroupOrDMByName envelope.room | ||
| channel.setTopic strings.join "\n" | ||
|
|
||
| customMessage: (data) => | ||
|
|
@@ -292,8 +274,8 @@ class SlackBot extends Adapter | |
| data.message.envelope.room | ||
| else data.message.room | ||
|
|
||
| channel = @client.dataStore.getChannelGroupOrDMByName channelName | ||
| channel = @client.dataStore.getChannelGroupOrDMById(channelName) unless channel | ||
| return unless channel | ||
|
|
||
| msg = {} | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| {SlackRawMessage, SlackBotMessage, SlackTextMessage} = require '../src/message' | ||
| {SlackBotListener, SlackRawListener} = require '../src/listener' | ||
| should = require 'should' | ||
|
|
||
|
|
||
| describe 'Listeners', -> | ||
|
|
||
| it 'Should fail on incorrect message type', -> | ||
| callback = (response) -> | ||
| matcher = (message) -> message.text.match /Hello/ | ||
|
|
||
| listener = new SlackRawListener(@stubs.robot, matcher, callback) | ||
| listener.call().should.be.false | ||
|
|
||
|
|
||
| it 'Should call a SlackRawListener', -> | ||
| callback = (response) -> | ||
| matcher = (message) -> message.text.match /Hello/ | ||
|
|
||
| message = new SlackRawMessage(@stubs.user.id, 'Hello world', 'Hello world', {ts: 1234}) | ||
| listener = new SlackRawListener(@stubs.robot, matcher, callback) | ||
| listener.call(message).should.be.true | ||
|
|
||
|
|
||
| it 'Should call a SlackBotListener', -> | ||
| callback = (response) -> | ||
| message = new SlackBotMessage(@stubs.user.id, 'Hello world', 'Hello world', {ts: 1234}) | ||
| listener = new SlackBotListener(@stubs.robot, /Hello/, callback) | ||
| listener.call(message).should.be.true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the change in the options means this qualifies as a breaking change, and hence will require us to bump the major version number.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also want to verify that the reconnection logic is working.