feat: polls overhaul (#10328)

* feat(Managers): add PollAnswerVoterManager

* feat(Partials): make Polls partial-safe

* types: add typings

* chore: add tests

* fix: use fetch method in manager instead

* chore: add tests for manager

* feat: add partial support to poll actions

* style: formatting

* fix: change all .users references to .voters

* refactor: add additional logic for partials

* fix: actually add the partials

* fix: fixed issue where event does not emit on first event

* fix: align property type with DAPI documentation

* fix: resolve additional bugs with partials

* typings: update typings to reflect property type change

* fix: tests

* fix: adjust tests

* refactor: combine partials logic into one statement

* docs: mark getter as readonly

* refactor: apply suggestions

Co-authored-by: Almeida <[email protected]>

* refactor(Actions): apply suggestions

* refactor(PollAnswerVoterManager): apply suggestions

* refactor(Message): check for existing poll before creating a poll

* refactor(Polls): apply suggestions

* revert(types): remove unused method from Poll class

* refactor(Actions): consolidate poll creation logic into action class

* refactor(PollAnswerVoterManager): set default for fetch parameter

* refactor(Message): apply suggestion

* fix: remove partial setter

* refactor(Polls): apply suggestions

* types: apply suggestions

* refactor: remove clones

* docs: spacing

* refactor: move setters from constructor to _patch

* types: adjust partials for poll classes

* test: add more tests for polls

* refactor: move updates around, more correct partial types

* fix: handle more cases

* refactor: requested changes

* fix: missing imports

* fix: update imports

* fix: require file extensions

---------

Co-authored-by: Almeida <[email protected]>
Co-authored-by: Qjuh <[email protected]>

Author: 3 people

packages/discord.js/src/client/actions/Action.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const { Poll } = require('../../structures/Poll.js');
+const { PollAnswer } = require('../../structures/PollAnswer.js');
 const { Partials } = require('../../util/Partials.js');
 
 /*
@@ -63,6 +65,23 @@ class Action {
     );
   }
 
+  getPoll(data, message, channel) {
+    const includePollPartial = this.client.options.partials.includes(Partials.Poll);
+    const includePollAnswerPartial = this.client.options.partials.includes(Partials.PollAnswer);
+    if (message.partial && (!includePollPartial || !includePollAnswerPartial)) return null;
+
+    if (!message.poll && includePollPartial) {
+      message.poll = new Poll(this.client, data, message, channel);
+    }
+
+    if (message.poll && !message.poll.answers.has(data.answer_id) && includePollAnswerPartial) {
+      const pollAnswer = new PollAnswer(this.client, data, message.poll);
+      message.poll.answers.set(data.answer_id, pollAnswer);
+    }
+
+    return message.poll;
+  }
+
   getReaction(data, message, user) {
     const id = data.emoji.id ?? decodeURIComponent(data.emoji.name);
     return this.getPayload(

packages/discord.js/src/client/actions/MessagePollVoteAdd.js

@@ -11,11 +11,18 @@ class MessagePollVoteAddAction extends Action {
     const message = this.getMessage(data, channel);
     if (!message) return false;
 
-    const { poll } = message;
+    const poll = this.getPoll(data, message, channel);
+    if (!poll) return false;
 
-    const answer = poll?.answers.get(data.answer_id);
+    const answer = poll.answers.get(data.answer_id);
     if (!answer) return false;
 
+    const user = this.getUser(data);
+
+    if (user) {
+      answer.voters._add(user);
+    }
+
     answer.voteCount++;
 
     /**

packages/discord.js/src/client/actions/MessagePollVoteRemove.js

@@ -11,12 +11,17 @@ class MessagePollVoteRemoveAction extends Action {
     const message = this.getMessage(data, channel);
     if (!message) return false;
 
-    const { poll } = message;
+    const poll = this.getPoll(data, message, channel);
+    if (!poll) return false;
 
-    const answer = poll?.answers.get(data.answer_id);
+    const answer = poll.answers.get(data.answer_id);
     if (!answer) return false;
 
-    answer.voteCount--;
+    answer.voters.cache.delete(data.user_id);
+
+    if (answer.voteCount > 0) {
+      answer.voteCount--;
+    }
 
     /**
      * Emitted whenever a user removes their vote in a poll.

packages/discord.js/src/index.js

@@ -81,6 +81,7 @@ exports.GuildStickerManager = require('./managers/GuildStickerManager.js').Guild
 exports.GuildTextThreadManager = require('./managers/GuildTextThreadManager.js').GuildTextThreadManager;
 exports.MessageManager = require('./managers/MessageManager.js').MessageManager;
 exports.PermissionOverwriteManager = require('./managers/PermissionOverwriteManager.js').PermissionOverwriteManager;
+exports.PollAnswerVoterManager = require('./managers/PollAnswerVoterManager.js').PollAnswerVoterManager;
 exports.PresenceManager = require('./managers/PresenceManager.js').PresenceManager;
 exports.ReactionManager = require('./managers/ReactionManager.js').ReactionManager;
 exports.ReactionUserManager = require('./managers/ReactionUserManager.js').ReactionUserManager;

packages/discord.js/src/managers/PollAnswerVoterManager.js

@@ -0,0 +1,50 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const { makeURLSearchParams } = require('@discordjs/rest');
+const { Routes } = require('discord-api-types/v10');
+const { CachedManager } = require('./CachedManager.js');
+const { User } = require('../structures/User.js');
+
+/**
+ * Manages API methods for users who voted on a poll and stores their cache.
+ * @extends {CachedManager}
+ */
+class PollAnswerVoterManager extends CachedManager {
+  constructor(answer) {
+    super(answer.client, User);
+
+    /**
+     * The poll answer that this manager belongs to
+     * @type {PollAnswer}
+     */
+    this.answer = answer;
+  }
+
+  /**
+   * The cache of this manager
+   * @type {Collection<Snowflake, User>}
+   * @name PollAnswerVoterManager#cache
+   */
+
+  /**
+   * Fetches the users that voted on this poll answer. Resolves with a collection of users, mapped by their ids.
+   * @param {BaseFetchPollAnswerVotersOptions} [options={}] Options for fetching the users
+   * @returns {Promise<Collection<Snowflake, User>>}
+   */
+  async fetch({ after, limit } = {}) {
+    const poll = this.answer.poll;
+    const query = makeURLSearchParams({ limit, after });
+    const data = await this.client.rest.get(Routes.pollAnswerVoters(poll.channelId, poll.messageId, this.answer.id), {
+      query,
+    });
+
+    return data.users.reduce((coll, rawUser) => {
+      const user = this.client.users._add(rawUser);
+      this.cache.set(user.id, user);
+      return coll.set(user.id, user);
+    }, new Collection());
+  }
+}
+
+exports.PollAnswerVoterManager = PollAnswerVoterManager;

packages/discord.js/src/structures/Message.js

@@ -414,11 +414,15 @@ class Message extends Base {
     }
 
     if (data.poll) {
-      /**
-       * The poll that was sent with the message
-       * @type {?Poll}
-       */
-      this.poll = new Poll(this.client, data.poll, this);
+      if (this.poll) {
+        this.poll._patch(data.poll);
+      } else {
+        /**
+         * The poll that was sent with the message
+         * @type {?Poll}
+         */
+        this.poll = new Poll(this.client, data.poll, this, this.channel);
+      }
     } else {
       this.poll ??= null;
     }

packages/discord.js/src/structures/Poll.js

@@ -10,58 +10,38 @@ const { DiscordjsError, ErrorCodes } = require('../errors/index.js');
  * @extends {Base}
  */
 class Poll extends Base {
-  constructor(client, data, message) {
+  constructor(client, data, message, channel) {
     super(client);
 
     /**
-     * The message that started this poll
-     * @name Poll#message
-     * @type {Message}
-     * @readonly
+     * The id of the channel that this poll is in
+     * @type {Snowflake}
      */
-
-    Object.defineProperty(this, 'message', { value: message });
+    this.channelId = data.channel_id ?? channel.id;
 
     /**
-     * The media for a poll's question
-     * @typedef {Object} PollQuestionMedia
-     * @property {string} text The text of this question
-     */
-
-    /**
-     * The media for this poll's question
-     * @type {PollQuestionMedia}
+     * The channel that this poll is in
+     * @name Poll#channel
+     * @type {TextBasedChannel}
+     * @readonly
      */
-    this.question = {
-      text: data.question.text,
-    };
 
-    /**
-     * The answers of this poll
-     * @type {Collection<number, PollAnswer>}
-     */
-    this.answers = data.answers.reduce(
-      (acc, answer) => acc.set(answer.answer_id, new PollAnswer(this.client, answer, this)),
-      new Collection(),
-    );
+    Object.defineProperty(this, 'channel', { value: channel });
 
     /**
-     * The timestamp when this poll expires
-     * @type {number}
+     * The id of the message that started this poll
+     * @type {Snowflake}
      */
-    this.expiresTimestamp = Date.parse(data.expiry);
+    this.messageId = data.message_id ?? message.id;
 
     /**
-     * Whether this poll allows multiple answers
-     * @type {boolean}
+     * The message that started this poll
+     * @name Poll#message
+     * @type {Message}
+     * @readonly
      */
-    this.allowMultiselect = data.allow_multiselect;
 
-    /**
-     * The layout type of this poll
-     * @type {PollLayoutType}
-     */
-    this.layoutType = data.layout_type;
+    Object.defineProperty(this, 'message', { value: message });
 
     this._patch(data);
   }
@@ -81,15 +61,101 @@ class Poll extends Base {
     } else {
       this.resultsFinalized ??= false;
     }
+
+    if ('allow_multiselect' in data) {
+      /**
+       * Whether this poll allows multiple answers
+       * @type {boolean}
+       */
+      this.allowMultiselect = data.allow_multiselect;
+    } else {
+      this.allowMultiselect ??= null;
+    }
+
+    if ('layout_type' in data) {
+      /**
+       * The layout type of this poll
+       * @type {PollLayoutType}
+       */
+      this.layoutType = data.layout_type;
+    } else {
+      this.layoutType ??= null;
+    }
+
+    if ('expiry' in data) {
+      /**
+       * The timestamp when this poll expires
+       * @type {?number}
+       */
+      this.expiresTimestamp = data.expiry && Date.parse(data.expiry);
+    } else {
+      this.expiresTimestamp ??= null;
+    }
+
+    if (data.question) {
+      /**
+       * The media for a poll's question
+       * @typedef {Object} PollQuestionMedia
+       * @property {?string} text The text of this question
+       */
+
+      /**
+       * The media for this poll's question
+       * @type {PollQuestionMedia}
+       */
+      this.question = {
+        text: data.question.text,
+      };
+    } else {
+      this.question ??= {
+        text: null,
+      };
+    }
+
+    /**
+     * The answers of this poll
+     * @type {Collection<number, PollAnswer|PartialPollAnswer>}
+     */
+    this.answers ??= new Collection();
+
+    if (data.answers) {
+      for (const answer of data.answers) {
+        const existing = this.answers.get(answer.answer_id);
+        if (existing) {
+          existing._patch(answer);
+        } else {
+          this.answers.set(answer.answer_id, new PollAnswer(this.client, answer, this));
+        }
+      }
+    }
   }
 
   /**
    * The date when this poll expires
-   * @type {Date}
+   * @type {?Date}
    * @readonly
    */
   get expiresAt() {
-    return new Date(this.expiresTimestamp);
+    return this.expiresTimestamp && new Date(this.expiresTimestamp);
+  }
+
+  /**
+   * Whether this poll is a partial
+   * @type {boolean}
+   * @readonly
+   */
+  get partial() {
+    return this.allowMultiselect === null;
+  }
+
+  /**
+   * Fetches the message that started this poll, then updates the poll from the fetched message.
+   * @returns {Promise<Poll>}
+   */
+  async fetch() {
+    await this.channel.messages.fetch(this.messageId);
+
+    return this;
   }
 
   /**
@@ -101,7 +167,7 @@ class Poll extends Base {
       throw new DiscordjsError(ErrorCodes.PollAlreadyExpired);
     }
 
-    return this.message.channel.messages.endPoll(this.message.id);
+    return this.channel.messages.endPoll(this.messageId);
   }
 }