Store and Model Refactor (#1618)

* UserStore refactor

* Create ChannelStore, remove redundant methods in ClientDataManager

* Create GuildStore

* Emoji stuff

* Use a Base class where possible to reduce code duplication

* Remove unnecessary comments from ChannelStore

* Add Base._clone();

* Remove unused ClientDataManager methods

* Refactor some more stuff

* ESLint

* Move Client#fetchUser to client.users.fetch

* Remove .has checks and just see if .get is truthy

* Fix guild member chunk error

* ESLint

* Fix typo

* Fix channel storing for user bots

* Remove ClientDataManager

* GuildChannelStore

* Reduce use of Util.cloneObject

* and this one too

* update typings

* Fix MessageUpdate handling (#1507)

* Fix role updates (probably fixes #1525)

* fix for eslint

* Address some of appell's comments

* Use debug constant

* start message store crap if it's ugly tell me later k

* fix that

* message store but works™️

* clean up guild stuff

* clean up channel store stuff

* clean up channel event handling

* does this message stuff work? find out soon in the next episode of dIsCoRd.Js

* eslint

* emojis

* emojis and reactions

* hi my name is eslint and im A LIL SHIT

* so i forgot this huh

* user stuff

* Fix @class

* Fix message stuff

* Fix user store docs

* Document all the bases

* fix the super things

* tidy up remove

* fix textbasedchannel

* fix that too

* fix emoji store

* make voice state stuff less ugly

* make voice states even less ugly

* make members less bad

* fix bug

* fix that too

* fix reactions

* how was this broken for so long

* role store

* remove super._patch from UserConnection

* Rename UserProfile#setup to _patch

* remove unnecessary super calls

* update docgen dep (pls fix travis thx)

* doc messagestore

* fix docs

* message store docs

* things

* DOCS PLS

* more things

* Document TextBasedChannel#messages as a MessageStore

* Rebase

* All the stores!

src/client/websocket/packets/handlers/ChannelCreate.js

@@ -2,9 +2,7 @@ const AbstractHandler = require('./AbstractHandler');
 
 class ChannelCreateHandler extends AbstractHandler {
   handle(packet) {
-    const client = this.packetManager.client;
-    const data = packet.d;
-    client.actions.ChannelCreate.handle(data);
+    this.packetManager.client.actions.ChannelCreate.handle(packet.d);
   }
 }
 

src/client/websocket/packets/handlers/ChannelDelete.js

@@ -1,20 +1,9 @@
 const AbstractHandler = require('./AbstractHandler');
 
-const Constants = require('../../../../util/Constants');
-
 class ChannelDeleteHandler extends AbstractHandler {
   handle(packet) {
-    const client = this.packetManager.client;
-    const data = packet.d;
-    const response = client.actions.ChannelDelete.handle(data);
-    if (response.channel) client.emit(Constants.Events.CHANNEL_DELETE, response.channel);
+    this.packetManager.client.actions.ChannelDelete.handle(packet.d);
   }
 }
 
-/**
- * Emitted whenever a channel is deleted.
- * @event Client#channelDelete
- * @param {Channel} channel The channel that was deleted
- */
-
 module.exports = ChannelDeleteHandler;

src/client/websocket/packets/handlers/ChannelUpdate.js

@@ -1,11 +1,20 @@
 const AbstractHandler = require('./AbstractHandler');
+const Constants = require('../../../../util/Constants');
 
 class ChannelUpdateHandler extends AbstractHandler {
   handle(packet) {
-    const client = this.packetManager.client;
-    const data = packet.d;
-    client.actions.ChannelUpdate.handle(data);
+    const { old, updated } = this.packetManager.client.actions.ChannelUpdate.handle(packet.d);
+    if (old && updated) {
+      this.packetManager.client.emit(Constants.Events.CHANNEL_UPDATE, old, updated);
+    }
   }
 }
 
 module.exports = ChannelUpdateHandler;
+
+/**
+ * Emitted whenever a channel is updated - e.g. name change, topic change.
+ * @event Client#channelUpdate
+ * @param {Channel} oldChannel The channel before the update
+ * @param {Channel} newChannel The channel after the update
+ */

src/client/websocket/packets/handlers/GuildCreate.js

@@ -1,20 +1,31 @@
 const AbstractHandler = require('./AbstractHandler');
+const Constants = require('../../../../util/Constants');
 
 class GuildCreateHandler extends AbstractHandler {
-  handle(packet) {
+  async handle(packet) {
     const client = this.packetManager.client;
     const data = packet.d;
 
-    const guild = client.guilds.get(data.id);
+    let guild = client.guilds.get(data.id);
     if (guild) {
       if (!guild.available && !data.unavailable) {
         // A newly available guild
-        guild.setup(data);
+        guild._patch(data);
         this.packetManager.ws.checkIfReady();
       }
     } else {
       // A new guild
-      client.dataManager.newGuild(data);
+      guild = client.guilds.create(data);
+      const emitEvent = client.ws.connection.status === Constants.Status.READY;
+      if (emitEvent) {
+        /**
+         * Emitted whenever the client joins a guild.
+         * @event Client#guildCreate
+         * @param {Guild} guild The created guild
+         */
+        if (client.options.fetchAllMembers) await guild.fetchMembers();
+        client.emit(Constants.Events.GUILD_CREATE, guild);
+      }
     }
   }
 }

src/client/websocket/packets/handlers/GuildDelete.js

@@ -1,12 +1,9 @@
 const AbstractHandler = require('./AbstractHandler');
-const Constants = require('../../../../util/Constants');
 
 class GuildDeleteHandler extends AbstractHandler {
   handle(packet) {
     const client = this.packetManager.client;
-    const data = packet.d;
-    const response = client.actions.GuildDelete.handle(data);
-    if (response.guild) client.emit(Constants.Events.GUILD_DELETE, response.guild);
+    client.actions.GuildDelete.handle(packet.d);
   }
 }
 

src/client/websocket/packets/handlers/GuildMemberAdd.js

@@ -1,6 +1,7 @@
 // ##untested handler##
 
 const AbstractHandler = require('./AbstractHandler');
+const Constants = require('../../../../util/Constants');
 
 class GuildMemberAddHandler extends AbstractHandler {
   handle(packet) {
@@ -9,9 +10,18 @@ class GuildMemberAddHandler extends AbstractHandler {
     const guild = client.guilds.get(data.guild_id);
     if (guild) {
       guild.memberCount++;
-      guild._addMember(data);
+      const member = guild.members.create(data);
+      if (client.ws.connection.status === Constants.Status.READY) {
+        client.emit(Constants.Events.GUILD_MEMBER_ADD, member);
+      }
     }
   }
 }
 
 module.exports = GuildMemberAddHandler;
+
+/**
+ * Emitted whenever a user joins a guild.
+ * @event Client#guildMemberAdd
+ * @param {GuildMember} member The member that has joined a guild
+ */

src/client/websocket/packets/handlers/GuildMemberUpdate.js

@@ -1,16 +1,27 @@
 // ##untested handler##
 
 const AbstractHandler = require('./AbstractHandler');
+const Constants = require('../../../../util/Constants');
 
 class GuildMemberUpdateHandler extends AbstractHandler {
   handle(packet) {
     const client = this.packetManager.client;
     const data = packet.d;
-
     const guild = client.guilds.get(data.guild_id);
     if (guild) {
       const member = guild.members.get(data.user.id);
-      if (member) guild._updateMember(member, data);
+      if (member) {
+        const old = member._update(data);
+        if (client.ws.connection.status === Constants.Status.READY) {
+          /**
+           * Emitted whenever a guild member changes - i.e. new role, removed role, nickname.
+           * @event Client#guildMemberUpdate
+           * @param {GuildMember} oldMember The member before the update
+           * @param {GuildMember} newMember The member after the update
+           */
+          client.emit(Constants.Events.GUILD_MEMBER_UPDATE, old, member);
+        }
+      }
     }
   }
 }

src/client/websocket/packets/handlers/GuildMembersChunk.js

@@ -10,7 +10,7 @@ class GuildMembersChunkHandler extends AbstractHandler {
     if (!guild) return;
     const members = new Collection();
 
-    for (const member of data.members) members.set(member.user.id, guild._addMember(member, false));
+    for (const member of data.members) members.set(member.user.id, guild.members.create(member));
 
     client.emit(Constants.Events.GUILD_MEMBERS_CHUNK, members, guild);
 

src/client/websocket/packets/handlers/MessageCreate.js

@@ -1,19 +1,9 @@
 const AbstractHandler = require('./AbstractHandler');
-const Constants = require('../../../../util/Constants');
 
 class MessageCreateHandler extends AbstractHandler {
   handle(packet) {
-    const client = this.packetManager.client;
-    const data = packet.d;
-    const response = client.actions.MessageCreate.handle(data);
-    if (response.message) client.emit(Constants.Events.MESSAGE_CREATE, response.message);
+    this.packetManager.client.actions.MessageCreate.handle(packet.d);
   }
 }
 
-/**
- * Emitted whenever a message is created.
- * @event Client#message
- * @param {Message} message The created message
- */
-
 module.exports = MessageCreateHandler;

src/client/websocket/packets/handlers/MessageDelete.js

@@ -10,10 +10,4 @@ class MessageDeleteHandler extends AbstractHandler {
   }
 }
 
-/**
- * Emitted whenever a message is deleted.
- * @event Client#messageDelete
- * @param {Message} message The deleted message
- */
-
 module.exports = MessageDeleteHandler;

src/client/websocket/packets/handlers/MessageDeleteBulk.js

@@ -2,16 +2,8 @@ const AbstractHandler = require('./AbstractHandler');
 
 class MessageDeleteBulkHandler extends AbstractHandler {
   handle(packet) {
-    const client = this.packetManager.client;
-    const data = packet.d;
-    client.actions.MessageDeleteBulk.handle(data);
+    this.packetManager.client.actions.MessageDeleteBulk.handle(packet.d);
   }
 }
 
-/**
- * Emitted whenever messages are deleted in bulk.
- * @event Client#messageDeleteBulk
- * @param {Collection<Snowflake, Message>} messages The deleted messages, mapped by their ID
- */
-
 module.exports = MessageDeleteBulkHandler;

src/client/websocket/packets/handlers/MessageReactionAdd.js

@@ -1,10 +1,12 @@
 const AbstractHandler = require('./AbstractHandler');
+const Constants = require('../../../../util/Constants');
 
 class MessageReactionAddHandler extends AbstractHandler {
   handle(packet) {
     const client = this.packetManager.client;
     const data = packet.d;
-    client.actions.MessageReactionAdd.handle(data);
+    const { user, reaction } = client.actions.MessageReactionAdd.handle(data);
+    if (reaction) client.emit(Constants.Events.MESSAGE_REACTION_ADD, reaction, user);
   }
 }
 

src/client/websocket/packets/handlers/MessageUpdate.js

@@ -1,10 +1,12 @@
 const AbstractHandler = require('./AbstractHandler');
+const Constants = require('../../../../util/Constants');
 
 class MessageUpdateHandler extends AbstractHandler {
   handle(packet) {
-    const client = this.packetManager.client;
-    const data = packet.d;
-    client.actions.MessageUpdate.handle(data);
+    const { old, updated } = this.packetManager.client.actions.MessageUpdate.handle(packet.d);
+    if (old && updated) {
+      this.packetManager.client.emit(Constants.Events.MESSAGE_UPDATE, old, updated);
+    }
   }
 }
 

src/client/websocket/packets/handlers/PresenceUpdate.js

@@ -12,14 +12,13 @@ class PresenceUpdateHandler extends AbstractHandler {
     // Step 1
     if (!user) {
       if (data.user.username) {
-        user = client.dataManager.newUser(data.user);
+        user = client.users.create(data.user);
       } else {
         return;
       }
     }
 
-    const oldUser = Util.cloneObject(user);
-    user.patch(data.user);
+    const oldUser = user._update(data.user);
     if (!user.equals(oldUser)) {
       client.emit(Constants.Events.USER_UPDATE, oldUser, user);
     }
@@ -27,12 +26,12 @@ class PresenceUpdateHandler extends AbstractHandler {
     if (guild) {
       let member = guild.members.get(user.id);
       if (!member && data.status !== 'offline') {
-        member = guild._addMember({
+        member = guild.members.create({
           user,
           roles: data.roles,
           deaf: false,
           mute: false,
-        }, false);
+        });
         client.emit(Constants.Events.GUILD_MEMBER_AVAILABLE, member);
       }
       if (member) {
@@ -40,7 +39,7 @@ class PresenceUpdateHandler extends AbstractHandler {
           guild._setPresence(user.id, data);
           return;
         }
-        const oldMember = Util.cloneObject(member);
+        const oldMember = member._clone();
         if (member.presence) {
           oldMember.frozenPresence = Util.cloneObject(member.presence);
         }

src/client/websocket/packets/handlers/Ready.js

@@ -17,11 +17,11 @@ class ReadyHandler extends AbstractHandler {
     client.readyAt = new Date();
     client.users.set(clientUser.id, clientUser);
 
-    for (const guild of data.guilds) client.dataManager.newGuild(guild);
-    for (const privateDM of data.private_channels) client.dataManager.newChannel(privateDM);
+    for (const guild of data.guilds) client.guilds.create(guild);
+    for (const privateDM of data.private_channels) client.channels.create(privateDM);
 
     for (const relation of data.relationships) {
-      const user = client.dataManager.newUser(relation.user);
+      const user = client.users.create(relation.user);
       if (relation.type === 1) {
         client.user.friends.set(user.id, user);
       } else if (relation.type === 2) {
@@ -31,7 +31,7 @@ class ReadyHandler extends AbstractHandler {
 
     data.presences = data.presences || [];
     for (const presence of data.presences) {
-      client.dataManager.newUser(presence.user);
+      client.users.create(presence.user);
       client._setPresence(presence.user.id, presence);
     }
 
@@ -45,7 +45,7 @@ class ReadyHandler extends AbstractHandler {
     }
 
     if (!client.users.has('1')) {
-      client.dataManager.newUser({
+      client.users.create({
         id: '1',
         username: 'Clyde',
         discriminator: '0000',

src/client/websocket/packets/handlers/VoiceStateUpdate.js

@@ -1,7 +1,6 @@
 const AbstractHandler = require('./AbstractHandler');
 
 const Constants = require('../../../../util/Constants');
-const Util = require('../../../../util/Util');
 
 class VoiceStateUpdateHandler extends AbstractHandler {
   handle(packet) {
@@ -12,28 +11,16 @@ class VoiceStateUpdateHandler extends AbstractHandler {
     if (guild) {
       const member = guild.members.get(data.user_id);
       if (member) {
-        const oldVoiceChannelMember = Util.cloneObject(member);
-        if (member.voiceChannel && member.voiceChannel.id !== data.channel_id) {
-          member.voiceChannel.members.delete(oldVoiceChannelMember.id);
-        }
-
-        // If the member left the voice channel, unset their speaking property
-        if (!data.channel_id) member.speaking = null;
+        const oldMember = member._clone();
+        oldMember._frozenVoiceState = oldMember.voiceState;
 
         if (member.user.id === client.user.id && data.channel_id) {
           client.emit('self.voiceStateUpdate', data);
         }
 
-        const newChannel = client.channels.get(data.channel_id);
-        if (newChannel) newChannel.members.set(member.user.id, member);
+        guild.voiceStates.set(member.user.id, data);
 
-        member.serverMute = data.mute;
-        member.serverDeaf = data.deaf;
-        member.selfMute = data.self_mute;
-        member.selfDeaf = data.self_deaf;
-        member.voiceSessionID = data.session_id;
-        member.voiceChannelID = data.channel_id;
-        client.emit(Constants.Events.VOICE_STATE_UPDATE, oldVoiceChannelMember, member);
+        client.emit(Constants.Events.VOICE_STATE_UPDATE, oldMember, member);
       }
     }
   }