Add tests for webhook usernames

Author: ekmartin

lib/bot.js

@@ -6,6 +6,10 @@ import { ConfigurationError } from './errors';
 import { validateChannelMapping } from './validators';
 import { formatFromDiscordToIRC, formatFromIRCToDiscord } from './formatting';
 
+// Usernames need to be between 2 and 32 characters for webhooks:
+const USERNAME_MIN_LENGTH = 2;
+const USERNAME_MAX_LENGTH = 32;
+
 const REQUIRED_FIELDS = ['server', 'nickname', 'channelMapping', 'discordToken'];
 const NICK_COLORS = ['light_blue', 'dark_blue', 'light_red', 'dark_red', 'light_green',
   'dark_green', 'magenta', 'light_magenta', 'orange', 'yellow', 'cyan', 'light_cyan'];
@@ -544,18 +548,17 @@ class Bot {
 
       // discord matches channel names case insensitively
       const chan = guild.channels.find(x => Bot.caseComp(x.name, channelName));
-      if (chan) return chan;
-
-      return match;
+      return chan || match;
     });
 
     // Webhooks first
     const webhook = this.findWebhook(channel);
     if (webhook) {
       logger.debug('Sending message to Discord via webhook', withMentions, channel, '->', `#${discordChannel.name}`);
       const avatarURL = this.getDiscordAvatar(author, channel);
+      const username = _.padEnd(author.substring(0, USERNAME_MAX_LENGTH), USERNAME_MIN_LENGTH, '_');
       webhook.client.sendMessage(withMentions, {
-        username: _.padEnd(author.substring(0, 32), 2, '_'),
+        username,
         text,
         avatarURL
       }).catch(logger.error);

test/bot.test.js

@@ -976,6 +976,32 @@ describe('Bot', function () {
     this.sendWebhookMessageStub.should.have.been.called;
   });
 
+  it('pads too short usernames for webhooks', function () {
+    const newConfig = { ...config, webhooks: { '#discord': 'https://discordapp.com/api/webhooks/id/token' } };
+    const bot = new Bot(newConfig);
+    const text = 'message';
+    bot.connect();
+    bot.sendToDiscord('n', '#irc', text);
+    this.sendWebhookMessageStub.should.have.been.calledWith(text, {
+      username: 'n_',
+      text,
+      avatarURL: null,
+    });
+  });
+
+  it('slices too long usernames for webhooks', function () {
+    const newConfig = { ...config, webhooks: { '#discord': 'https://discordapp.com/api/webhooks/id/token' } };
+    const bot = new Bot(newConfig);
+    const text = 'message';
+    bot.connect();
+    bot.sendToDiscord('1234567890123456789012345678901234567890', '#irc', text);
+    this.sendWebhookMessageStub.should.have.been.calledWith(text, {
+      username: '12345678901234567890123456789012',
+      text,
+      avatarURL: null,
+    });
+  });
+
   it('should find a matching username, case sensitive, when looking for an avatar', function () {
     const newConfig = { ...config, webhooks: { '#discord': 'https://discordapp.com/api/webhooks/id/token' } };
     const bot = new Bot(newConfig);

test/stubs/webhook-stub.js

@@ -6,8 +6,8 @@ export default function createWebhookStub(sendWebhookMessage) {
       this.token = token;
     }
 
-    sendMessage() {
-      sendWebhookMessage();
+    sendMessage(...args) {
+      sendWebhookMessage(...args);
       return new Promise(() => {});
     }
   };