Use sets instead of arrays for user membership in channels

Author: Throne3d

lib/bot.js

@@ -130,7 +130,7 @@ class Bot {
       if (nick === this.nickname && !this.announceSelfJoin) return;
       // self-join is announced before names (which includes own nick)
       // so don't add nick to channelUsers
-      if (nick !== this.nickname) this.channelUsers[channel].push(nick);
+      if (nick !== this.nickname) this.channelUsers[channel].add(nick);
       this.sendExactToDiscord(channel, `*${nick}* has joined the channel`);
     });
 
@@ -141,23 +141,21 @@ class Bot {
         delete this.channelUsers[channel];
         return;
       }
-      this.channelUsers[channel].splice(this.channelUsers[channel].indexOf(nick), 1);
+      this.channelUsers[channel].delete(nick);
       this.sendExactToDiscord(channel, `*${nick}* has left the channel (${reason})`);
     });
 
     this.ircClient.on('quit', (nick, reason, channels) => {
       if (!this.ircStatusNotices || nick === this.nickname) return;
       channels.forEach((channel) => {
-        const index = this.channelUsers[channel].indexOf(nick);
-        if (index === -1) return;
-        this.channelUsers[channel].splice(index, 1);
+        if (!this.channelUsers[channel].delete(nick)) return;
         this.sendExactToDiscord(channel, `*${nick}* has quit (${reason})`);
       });
     });
 
     this.ircClient.on('names', (channel, nicks) => {
       if (!this.ircStatusNotices) return;
-      this.channelUsers[channel] = Object.keys(nicks);
+      this.channelUsers[channel] = new Set(Object.keys(nicks));
     });
 
     this.ircClient.on('action', (author, to, text) => {

test/bot-events.test.js

@@ -131,7 +131,8 @@ describe('Bot Events', function () {
     // nick => '' means the user is not a special user
     const nicks = { [bot.nickname]: '', user: '', user2: '@', user3: '+' };
     bot.ircClient.emit('names', channel, nicks);
-    bot.channelUsers.should.deep.equal({ '#channel': [bot.nickname, 'user', 'user2', 'user3'] });
+    const channelNicks = new Set([bot.nickname, 'user', 'user2', 'user3']);
+    bot.channelUsers.should.deep.equal({ '#channel': channelNicks });
   });
 
   it('should send join messages to discord when config enabled', function () {
@@ -143,7 +144,8 @@ describe('Bot Events', function () {
     const text = `*${nick}* has joined the channel`;
     bot.ircClient.emit('join', channel, nick);
     bot.sendExactToDiscord.should.have.been.calledWithExactly(channel, text);
-    bot.channelUsers.should.deep.equal({ '#channel': [bot.nickname, nick] });
+    const channelNicks = new Set([bot.nickname, nick]);
+    bot.channelUsers.should.deep.equal({ '#channel': channelNicks });
   });
 
   it('should not announce itself joining by default', function () {
@@ -154,7 +156,8 @@ describe('Bot Events', function () {
     const nick = bot.nickname;
     bot.ircClient.emit('join', channel, nick);
     bot.sendExactToDiscord.should.not.have.been.called;
-    bot.channelUsers.should.deep.equal({ '#channel': [bot.nickname] });
+    const channelNicks = new Set([bot.nickname]);
+    bot.channelUsers.should.deep.equal({ '#channel': channelNicks });
   });
 
   it('should announce the bot itself when config enabled', function () {
@@ -175,21 +178,24 @@ describe('Bot Events', function () {
     const channel = '#channel';
     const nick = 'user';
     bot.ircClient.emit('names', channel, { [bot.nickname]: '', [nick]: '' });
-    bot.channelUsers.should.deep.equal({ '#channel': [bot.nickname, nick] });
+    const originalNicks = new Set([bot.nickname, nick]);
+    bot.channelUsers.should.deep.equal({ '#channel': originalNicks });
     const reason = 'Leaving';
     const text = `*${nick}* has left the channel (${reason})`;
     bot.ircClient.emit('part', channel, nick, reason);
     bot.sendExactToDiscord.should.have.been.calledWithExactly(channel, text);
     // it should remove the nickname from the channelUsers list
-    bot.channelUsers.should.deep.equal({ '#channel': [bot.nickname] });
+    const channelNicks = new Set([bot.nickname]);
+    bot.channelUsers.should.deep.equal({ '#channel': channelNicks });
   });
 
   it('should not announce itself leaving a channel', function () {
     const bot = createBot({ ...config, ircStatusNotices: true });
     bot.connect();
     const channel = '#channel';
     bot.ircClient.emit('names', channel, { [bot.nickname]: '', user: '' });
-    bot.channelUsers.should.deep.equal({ '#channel': [bot.nickname, 'user'] });
+    const originalNicks = new Set([bot.nickname, 'user']);
+    bot.channelUsers.should.deep.equal({ '#channel': originalNicks });
     const reason = 'Leaving';
     bot.ircClient.emit('part', channel, bot.nickname, reason);
     bot.sendExactToDiscord.should.not.have.been.called;