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/stores/ChannelStore.js

@@ -0,0 +1,46 @@
+const DataStore = require('./DataStore');
+const DMChannel = require('../structures/DMChannel');
+const GroupDMChannel = require('../structures/GroupDMChannel');
+const Constants = require('../util/Constants');
+
+/**
+ * Stores channels.
+ * @private
+ * @extends {DataStore}
+ */
+class ChannelStore extends DataStore {
+  create(data, guild, cache = true) {
+    const existing = this.get(data.id);
+    if (existing) return existing;
+
+    let channel;
+    switch (data.type) {
+      case Constants.ChannelTypes.DM:
+        channel = new DMChannel(this.client, data);
+        break;
+      case Constants.ChannelTypes.GROUP:
+        channel = new GroupDMChannel(this.client, data);
+        break;
+      default: // eslint-disable-line no-case-declarations
+        guild = guild || this.client.guilds.get(data.guild_id);
+        if (!guild) {
+          this.client.emit(Constants.Events.DEBUG, `Failed to find guild for channel ${data.id} ${data.type}`);
+          return null;
+        }
+        channel = guild.channels.create(data, cache);
+        break;
+    }
+
+    if (cache) this.set(channel.id, channel);
+
+    return channel;
+  }
+
+  remove(id) {
+    const channel = this.get(id);
+    if (channel.guild) channel.guild.channels.remove(id);
+    super.remove(id);
+  }
+}
+
+module.exports = ChannelStore;

src/stores/DataStore.js

@@ -0,0 +1,19 @@
+const Collection = require('../util/Collection');
+
+/**
+ * Manages the creation, retrieval and deletion of a specific data model.
+ * @extends {Collection}
+ */
+class DataStore extends Collection {
+  constructor(client, iterable) {
+    super();
+    if (iterable) for (const item of iterable) this.create(item);
+    Object.defineProperty(this, 'client', { value: client });
+  }
+
+  // Stubs
+  create() { return undefined; }
+  remove(key) { return this.delete(key); }
+}
+
+module.exports = DataStore;

src/stores/EmojiStore.js

@@ -0,0 +1,27 @@
+const DataStore = require('./DataStore');
+const Emoji = require('../structures/Emoji');
+/**
+ * Stores emojis.
+ * @private
+ * @extends {DataStore}
+ */
+class EmojiStore extends DataStore {
+  constructor(guild, iterable) {
+    super(guild.client, iterable);
+    this.guild = guild;
+  }
+
+  create(data) {
+    const guild = this.guild;
+
+    const existing = guild.emojis.get(data.id);
+    if (existing) return existing;
+
+    const emoji = new Emoji(guild, data);
+    guild.emojis.set(emoji.id, emoji);
+
+    return emoji;
+  }
+}
+
+module.exports = EmojiStore;

src/stores/GuildChannelStore.js

@@ -0,0 +1,28 @@
+const DataStore = require('./DataStore');
+const TextChannel = require('../structures/TextChannel');
+const VoiceChannel = require('../structures/VoiceChannel');
+const Constants = require('../util/Constants');
+/**
+ * Stores guild channels.
+ * @private
+ * @extends {DataStore}
+ */
+class GuildChannelStore extends DataStore {
+  constructor(guild, iterable) {
+    super(guild.client, iterable);
+    this.guild = guild;
+  }
+
+  create(data, cache = true) {
+    const existing = this.get(data.id);
+    if (existing) return existing;
+
+    const ChannelModel = data.type === Constants.ChannelTypes.TEXT ? TextChannel : VoiceChannel;
+    const channel = new ChannelModel(this.guild, data);
+    if (cache) this.set(channel.id, channel);
+
+    return channel;
+  }
+}
+
+module.exports = GuildChannelStore;

src/stores/GuildMemberStore.js

@@ -0,0 +1,25 @@
+const DataStore = require('./DataStore');
+const GuildMember = require('../structures/GuildMember');
+/**
+ * Stores guild members.
+ * @private
+ * @extends {DataStore}
+ */
+class GuildMemberStore extends DataStore {
+  constructor(guild, iterable) {
+    super(guild.client, iterable);
+    this.guild = guild;
+  }
+
+  create(data) {
+    const existing = this.has(data.user.id);
+    if (existing) return existing;
+
+    const member = new GuildMember(this.guild, data);
+    this.set(member.id, member);
+
+    return member;
+  }
+}
+
+module.exports = GuildMemberStore;

src/stores/GuildStore.js

@@ -0,0 +1,20 @@
+const DataStore = require('./DataStore');
+const Guild = require('../structures/Guild');
+/**
+ * Stores guilds.
+ * @private
+ * @extends {DataStore}
+ */
+class GuildStore extends DataStore {
+  create(data) {
+    const existing = this.get(data.id);
+    if (existing) return existing;
+
+    const guild = new Guild(this.client, data);
+    this.set(guild.id, guild);
+
+    return guild;
+  }
+}
+
+module.exports = GuildStore;

src/stores/MessageStore.js

@@ -0,0 +1,97 @@
+const DataStore = require('./DataStore');
+const Collection = require('../util/Collection');
+let Message;
+
+/**
+ * Stores messages for text-based channels.
+ * @extends {DataStore}
+ */
+class MessageStore extends DataStore {
+  constructor(channel, iterable) {
+    super(channel.client, iterable);
+    this.channel = channel;
+    Message = require('../structures/Message');
+  }
+
+  create(data, cache = true) {
+    const existing = this.get(data.id);
+    if (existing) return existing;
+
+    const message = new Message(this.client.channels.get(data.channel_id), data, this.client);
+
+    if (cache) this.set(message.id, message);
+    return message;
+  }
+
+  set(key, value) {
+    const maxSize = this.client.options.messageCacheMaxSize;
+    if (maxSize === 0) return;
+    if (this.size >= maxSize && maxSize > 0) this.delete(this.firstKey());
+    super.set(key, value);
+  }
+
+  /**
+   * The parameters to pass in when requesting previous messages from a channel. `around`, `before` and
+   * `after` are mutually exclusive. All the parameters are optional.
+   * @typedef {Object} ChannelLogsQueryOptions
+   * @property {number} [limit=50] Number of messages to acquire
+   * @property {Snowflake} [before] ID of a message to get the messages that were posted before it
+   * @property {Snowflake} [after] ID of a message to get the messages that were posted after it
+   * @property {Snowflake} [around] ID of a message to get the messages that were posted around it
+   */
+
+  /**
+   * Gets a message, or messages, from this channel.
+   * @param {Snowflake|ChannelLogsQueryOptions} [message] The ID of the message to fetch, or query parameters.
+   * @returns {Promise<Message>|Promise<Collection<Snowflake, Message>>}
+   * @example
+   * // Get message
+   * channel.messages.fetch('99539446449315840')
+   *   .then(message => console.log(message.content))
+   *   .catch(console.error);
+   * @example
+   * // Get messages
+   * channel.messages.fetch({limit: 10})
+   *   .then(messages => console.log(`Received ${messages.size} messages`))
+   *   .catch(console.error);
+   */
+  fetch(message) {
+    return typeof message === 'string' ? this._fetchId(message) : this._fetchMany(message);
+  }
+
+  /**
+   * Fetches the pinned messages of this channel and returns a collection of them.
+   * @returns {Promise<Collection<Snowflake, Message>>}
+   */
+  fetchPinned() {
+    return this.client.api.channels[this.message.channel.id].pins.get().then(data => {
+      const messages = new Collection();
+      for (const message of data) messages.set(message.id, this.create(message));
+      return messages;
+    });
+  }
+
+  _fetchId(messageID) {
+    if (!this.client.user.bot) {
+      return this._fetchMany({ limit: 1, around: messageID })
+        .then(messages => {
+          const msg = messages.get(messageID);
+          if (!msg) throw new Error('MESSAGE_MISSING');
+          return msg;
+        });
+    }
+    return this.client.api.channels[this.channel.id].messages[messageID].get()
+      .then(data => this.create(data));
+  }
+
+  _fetchMany(options = {}) {
+    return this.client.api.channels[this.channel.id].messages.get({ query: options })
+      .then(data => {
+        const messages = new Collection();
+        for (const message of data) messages.set(message.id, this.create(message));
+        return messages;
+      });
+  }
+}
+
+module.exports = MessageStore;

src/stores/ReactionStore.js

@@ -0,0 +1,27 @@
+const DataStore = require('./DataStore');
+const MessageReaction = require('../structures/MessageReaction');
+/**
+ * Stores reactions.
+ * @private
+ * @extends {DataStore}
+ */
+class ReactionStore extends DataStore {
+  constructor(message, iterable) {
+    super(message.client, iterable);
+    this.message = message;
+  }
+
+  create(data) {
+    const emojiID = data.emoji.id || decodeURIComponent(data.emoji.name);
+
+    const existing = this.get(data.id);
+    if (existing) return existing;
+
+    const reaction = new MessageReaction(this.message, data.emoji, data.count, data.me);
+    this.set(emojiID, reaction);
+
+    return reaction;
+  }
+}
+
+module.exports = ReactionStore;

src/stores/RoleStore.js

@@ -0,0 +1,25 @@
+const DataStore = require('./DataStore');
+const Role = require('../structures/Role');
+/**
+ * Stores roles.
+ * @private
+ * @extends {DataStore}
+ */
+class RoleStore extends DataStore {
+  constructor(guild, iterable) {
+    super(guild.client, iterable);
+    this.guild = guild;
+  }
+
+  create(data) {
+    const existing = this.get(data.id);
+    if (existing) return existing;
+
+    const role = new Role(this.guild, data);
+    this.set(role.id, role);
+
+    return role;
+  }
+}
+
+module.exports = RoleStore;

src/stores/UserStore.js

@@ -0,0 +1,35 @@
+const DataStore = require('./DataStore');
+const User = require('../structures/User');
+
+/**
+ * A data store to store User models.
+ * @extends {DataStore}
+ */
+class UserStore extends DataStore {
+  create(data) {
+    const existing = this.get(data.id);
+    if (existing) return existing;
+
+    const user = new User(this.client, data);
+    this.set(user.id, user);
+    return user;
+  }
+
+  /**
+   * Obtains a user from Discord, or the user cache if it's already available.
+   * <warn>This is only available when using a bot account.</warn>
+   * @param {Snowflake} id ID of the user
+   * @param {boolean} [cache=true] Whether to cache the new user object if it isn't already
+   * @returns {Promise<User>}
+   */
+  fetch(id, cache = true) {
+    const existing = this.get(id);
+    if (existing) return Promise.resolve(existing);
+
+    return this.client.api.users(id).get().then(data =>
+      cache ? this.create(data) : new User(this.client, data)
+    );
+  }
+}
+
+module.exports = UserStore;