Bridge IRC join/part/quit messages to Discord #207

Throne3d · 2017-03-26T19:43:58Z

As in PR #40, this bridges the join/part/quit messages from IRC to Discord. It builds on that PR (thanks, @Ratismal), rebasing it onto master (and accidentally doing something stupid in the rebase, which a later commit fixes).

This adds two config settings:

~~disableJoinPartMsgs – if set to true, the bot won't announce any~~ ircStatusNotices – if set to true, the bot will announce join/part/quit messages (if not set, overrides below)
announceSelfJoin – if set to true, the bot will announce itself (by default it skips any join events involving itself)

There are tests to ensure it works appropriately, and manual testing seems to show it working well. I hope this PR has more of a chance of getting merged?

coveralls · 2017-03-26T19:45:26Z

Coverage decreased (-1.4%) to 95.954% when pulling 6f8e8fb on Throne3d:add/joinpart into 26626e5 on reactiflux:master.

Throne3d · 2017-03-26T19:45:52Z

Hmm, coverage decreased somewhere. I'll look into fixing that.

coveralls · 2017-03-26T19:58:37Z

Coverage decreased (-0.2%) to 97.11% when pulling 13ef998 on Throne3d:add/joinpart into 26626e5 on reactiflux:master.

Throne3d · 2017-03-26T20:02:19Z

It looks like the only lines missed now are if (discordChannelName) { (a branch, [[27,1]]) and .filter(c => c.type === 'text'), same as in the regular sendToDiscord function.

coveralls · 2017-03-26T20:09:53Z

Coverage decreased (-0.3%) to 97.093% when pulling 9b4cfa2 on Throne3d:add/joinpart into 26626e5 on reactiflux:master.

coveralls · 2017-03-26T20:24:19Z

Coverage increased (+0.3%) to 97.674% when pulling 5c8c57f on Throne3d:add/joinpart into 26626e5 on reactiflux:master.

Throne3d · 2017-03-26T20:26:22Z

The test description of should not send messages to discord if the channel isn't in the channel mapping was inaccurate, seeing as how "#notinchannel": "#otherIRC" is in fact in the channel mapping. I've updated the test name and created an actual test for a channel not in the mapping (#no-irc). (This has a side benefit of testing getDiscordChannelFor more thoroughly and hence overall increasing coverage.)

ekmartin · 2017-03-29T19:13:20Z

lib/bot.js

@@ -98,6 +100,24 @@ class Bot {
      this.sendToDiscord(author, to, `*${text}*`);
    });

+    this.ircClient.on('join', (channel, nick) => {
+      if (this.disableJoinPartMsgs) return;
+      if (nick === this.nickname && !this.announceSelfJoin) return;


Didn't know you'd receive join events for yourself. Do we need a configuration option for this though? There's already quite a lot of configuration possible, so maybe it would be better to just keep this off.

Personally, I found this useful to have on. If the bot had to reconnect for some reason (e.g. config change, lost connection to IRC), the self join message acts as a ping to others in the channel, that the IRC bridge is re-established and ready.

That said, it's currently only half-useful as disconnects are not mentioned in-channel, meaning users won't be aware that the bridge is suddenly unavailable for whatever reason. ^1

Edit: I suppose this could be handled as a separate feature, where the bot can itself announce when the bridge is up or down...

^1 This is not obvious in Discord; users don't think to check that the bot is online in the right sidebar

I see. Could keep it as a non-documented option, but as you're saying I think it might make more sense to print something like The bot has joined the IRC channel. then. Not sure how you'd be able to announce if the bridge is down though, as I think most issues with crashes have been on the Discord side (i.e. timing out and not reconnecting), but I guess you could at least print if the IRC connection goes offline. Seems a bit of an edge case though.

Indeed; in my edge case, I want to avoid the rare instances where users may start having one-sided conversations into the void. But, so far, that has yet to happen. So maybe it is not a big enough deal :)

In that case, wouldn't it make more sense to save up messages and send them when the IRC connection comes online? Maybe not if it's more than say 10 messages, but in your case I guess it could be a useful feature. Might not be worth the extra code though.

I'm not sure what to do in response to this – should I leave it as is for now, or…?

ekmartin · 2017-03-29T19:16:42Z

lib/bot.js

+  }
+
+  /* Sends a message to Discord exactly as it appears */
+  sendSpecialToDiscord(channel, text) {


Hm, is there any reason this can't just use sendToDiscord as well?

I was mostly just doing this since the other PR did – should I add a boolean flag to display it differently, or…?

Never mind, I was a bit confused since I forgot that we append usernames to the messages even when sent to discord (slack-irc doesn't). The current approach makes sense. Could maybe call it something like sendExactToDiscord though. Also, getDiscordChannelFor -> findDiscordChannel/getDiscordChannel or something like that?

Renamed to sendExactToDiscord and findDiscordChannel.

ekmartin · 2017-03-29T19:19:51Z

lib/bot.js

@@ -32,6 +32,8 @@ class Bot {
    this.commandCharacters = options.commandCharacters || [];
    this.ircNickColor = options.ircNickColor !== false; // default to true
    this.channels = _.values(options.channelMapping);
+    this.disableJoinPartMsgs = options.disableJoinPartMsgs;


Thanks for adding a configuration option! I think it would be better to default it to off though, as that's the current behavior. slack-irc uses an object for this, so you can choose to enable joins and leaves selectively:

I'm not sure if that's really necessary though, a single option might be more than enough. Maybe just ircStatusNotices: true.

I've converted it to a single ircStatusNotices config.

Throne3d · 2017-03-29T21:03:13Z

(Rebased onto master, rebased to change the config disableJoinPartMsgs → (!)ircStatusNotices everywhere, committed a change for sendSpecialToDiscord → sendExactToDiscord and getDiscordChannelFor → findDiscordChannel.)

coveralls · 2017-03-29T21:06:30Z

Coverage increased (+0.2%) to 98.039% when pulling 12ae0fc on Throne3d:add/joinpart into 9915db1 on reactiflux:master.

ekmartin · 2017-03-30T14:18:00Z

Looks good! Wanna add a line to the advanced example configuration in the README with ircStatusNotices?

- Do not discard reason from part messages - Output to each channel in the quit messages - Add tests for join/part/quit events - Add test that sendSpecialToDiscord doesn't send messages to outside the channel mapping

Throne3d · 2017-03-30T14:25:45Z

Done (and fixed a merge conflict after #204 was merged).

coveralls · 2017-03-30T14:27:14Z

Coverage increased (+0.2%) to 98.14% when pulling f996405 on Throne3d:add/joinpart into 1a7ea2d on reactiflux:master.

Throne3d · 2017-03-30T14:30:34Z

Partially solves #92?

ekmartin · 2017-03-30T21:33:23Z

Thanks! I'll publish a release with the recent changes in the next few days.

Throne3d mentioned this pull request Mar 26, 2017

IRC Users joining/parting/quiting #40

Closed

ekmartin requested changes Mar 29, 2017

View reviewed changes

Throne3d force-pushed the add/joinpart branch from 5c8c57f to 12ae0fc Compare March 29, 2017 20:59

Ratismal and others added 17 commits March 30, 2017 15:22

Added IRC users joining/parting/leaving

79ecf68

Fixed some line spacing?

b163759

Missed a function rename

c4944a4

Fixed formatting

3384c32

Fixed spacing, hopefully lint is happier

eb1e56f

More line indents. Frigg, please

9439b93

Fixed undefined variables and string concatenation

3356e99

Fixed functions being broken

89ec812

Fixed trailing spaces

b60c86c

Fix merge

352065b

Cleanup rebase to match newer code

4322ed5

Update part/quit messages and add tests

611aa6b

- Do not discard reason from part messages - Output to each channel in the quit messages - Add tests for join/part/quit events - Add test that sendSpecialToDiscord doesn't send messages to outside the channel mapping

Add ability to disable join/part messages and test for this

0633c32

Bot should not announce itself joining IRC

c39d751

Allow users to have bot announce itself joining IRC to Discord

607cb68

Add test to ensure special messages send

de68c48

Extract getDiscordChannelFor from send(Special)ToDiscord

2b85b8f

Throne3d added 3 commits March 30, 2017 15:24

Add tests for not-in-channel vs channel-not-in-mapping

99e3a0f

Rename special->exact and getDiscordChannelFor->findDiscordChannel

215c33b

Add example to README for ircStatusNotices

f996405

Throne3d force-pushed the add/joinpart branch from 12ae0fc to f996405 Compare March 30, 2017 14:25

ekmartin approved these changes Mar 30, 2017

View reviewed changes

ekmartin merged commit c9fa8ba into reactiflux:master Mar 30, 2017

ekmartin mentioned this pull request Mar 30, 2017

show who is on IRC from discord and vice versa #92

Closed

Throne3d deleted the add/joinpart branch March 30, 2017 23:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bridge IRC join/part/quit messages to Discord #207

Bridge IRC join/part/quit messages to Discord #207

Throne3d commented Mar 26, 2017 •

edited

Loading

coveralls commented Mar 26, 2017

Throne3d commented Mar 26, 2017

coveralls commented Mar 26, 2017

Throne3d commented Mar 26, 2017

coveralls commented Mar 26, 2017

coveralls commented Mar 26, 2017

Throne3d commented Mar 26, 2017

ekmartin Mar 29, 2017

RoyCurtis Mar 29, 2017 •

edited

Loading

ekmartin Mar 29, 2017

RoyCurtis Mar 29, 2017

ekmartin Mar 29, 2017

Throne3d Mar 29, 2017

ekmartin Mar 29, 2017

Throne3d Mar 29, 2017

ekmartin Mar 29, 2017

Throne3d Mar 29, 2017

ekmartin Mar 29, 2017

Throne3d Mar 29, 2017

Throne3d commented Mar 29, 2017

coveralls commented Mar 29, 2017 •

edited

Loading

ekmartin commented Mar 30, 2017

Throne3d commented Mar 30, 2017

coveralls commented Mar 30, 2017 •

edited

Loading

Throne3d commented Mar 30, 2017

ekmartin commented Mar 30, 2017

Bridge IRC join/part/quit messages to Discord #207

Bridge IRC join/part/quit messages to Discord #207

Conversation

Throne3d commented Mar 26, 2017 • edited Loading

coveralls commented Mar 26, 2017

Throne3d commented Mar 26, 2017

coveralls commented Mar 26, 2017

Throne3d commented Mar 26, 2017

coveralls commented Mar 26, 2017

coveralls commented Mar 26, 2017

Throne3d commented Mar 26, 2017

Choose a reason for hiding this comment

RoyCurtis Mar 29, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Throne3d commented Mar 29, 2017

coveralls commented Mar 29, 2017 • edited Loading

ekmartin commented Mar 30, 2017

Throne3d commented Mar 30, 2017

coveralls commented Mar 30, 2017 • edited Loading

Throne3d commented Mar 30, 2017

ekmartin commented Mar 30, 2017

Throne3d commented Mar 26, 2017 •

edited

Loading

RoyCurtis Mar 29, 2017 •

edited

Loading

coveralls commented Mar 29, 2017 •

edited

Loading

coveralls commented Mar 30, 2017 •

edited

Loading