feat(Interactions): member objects for uncached guilds #10195

advaith1 · 2024-03-29T03:47:38Z

Please describe the changes this PR makes and why it should be merged:
fixes #10010
Discord thread

Currently, when an interaction is received from a guild that isn't cached*, raw API member objects are returned instead of a d.js GuildMember object. This PR creates a new UncachedGuildMember object that is returned instead of raw API member objects.

This new object tries to be compatible with GuildMember, but retains backwards compatibility with APIGuildMember as to not make this a breaking change. Therefore it is still somewhat awkward and not great, but it is much better than just receiving an APIGuildMember. Hopefully in v15 we can remove the backwards compatibility and align it better with GuildMember.

This has not been fully tested and likely needs changes - please thoroughly review!

* This was always possible by adding apps with only the applications.commands scope, but user apps makes this a much more common appearance. This PR is based on the discord.js patch AdvaithBot is running to properly handle user app commands.

Status and versioning classification:

I know how to update typings and have done so, or typings don't need updating
This PR changes the library's interface (methods or parameters added)

vercel · 2024-03-29T03:47:42Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments

Name	Status	Preview	Comments	Updated (UTC)
discord-js	⬜️ Ignored (Inspect)	Visit Preview		Apr 4, 2024 11:00pm
discord-js-guide	⬜️ Ignored (Inspect)	Visit Preview		Apr 4, 2024 11:00pm

vladfrangu

There's a LOT of inconsistencies between trying to make this a non-semver major change (by also having snake_case properties) and a semver-major change (by not exposing all values under the same name). Let's pick one side (and gut says you want this in a sem-minor 👀) and roll with it!

nick isn't exposed as nick, only nickname
data.roles isn't exposed at all, only as roleIds
- this one I understand why, but I'd at least try to make uncachedMember.roles be our role manager (it should work)

vladfrangu · 2024-03-29T08:15:20Z

packages/discord.js/src/structures/UncachedGuildMember.js

+
+    /**
+     * The guild that this member is part of
+     * @type {Guild}


Its a string, not a Guild. You can add in a guild getter

oops will fix

vladfrangu · 2024-03-29T08:15:55Z

packages/discord.js/src/structures/UncachedGuildMember.js

+     */
+    this.guildId = guildId;
+
+    if ('user' in data) {


Can user ever be missing? 👀

I was going off the member docs where it's optional, but actually as far as we are concerned here (in interactions) it'll always be present. will change that

vladfrangu · 2024-03-29T08:16:56Z

packages/discord.js/src/structures/UncachedGuildMember.js

+    /**
+     * Whether the user is deafened in voice channels
+     * @type {?boolean}
+     * @deprecated


Why is this deprecated, and what't the alternative?

packages/discord.js/typings/index.d.ts

Qjuh · 2024-03-29T14:03:30Z

packages/discord.js/typings/index.d.ts

@@ -1642,6 +1642,38 @@ export class GuildMember extends Base {
  public valueOf(): string;
 }

+export class UncachedGuildMember extends Base {
+  private constructor(client: Client<true>, data: RawGuildMemberData, guildId: Snowflake);


According to your current implementation the type for data here is wrong, as it only takes APIInteractionGuildMember | APIInteractionDataResolvedGuildMember and not all the other UnionMembers RawGuildMemberData contains.

Qjuh · 2024-03-29T14:08:04Z

packages/discord.js/src/structures/UncachedGuildMember.js

+ *   .catch(console.error);
+ */
+
+TextBasedChannel.applyToClass(UncachedGuildMember);


This won’t work without additional changes in TextBasedChannel#send(), because that method uses a (granted very hacky) check to find out if it‘s called on a User/GuildMember or a Channel. Without changes it would currently treat UncachedGuildMember like it was a channel and fail miserably.

ah thanks, will look into that

Qjuh · 2024-03-29T14:16:36Z

packages/discord.js/src/structures/UncachedGuildMember.js

+
+  toJSON() {
+    const json = super.toJSON({
+      guild: 'guildId',


There is no property named guild in this class, needs to be

Suggested change

guild: 'guildId',

guildId: true,

Qjuh · 2024-03-29T14:17:56Z

packages/discord.js/src/structures/UncachedGuildMember.js

+      this.avatar === member.avatar &&
+      this.pending === member.pending &&
+      this.communicationDisabledUntilTimestamp === member.communicationDisabledUntilTimestamp &&
+      this.parsedFlags.bitfield === member.parsedFlags.bitfield &&


Suggested change

this.parsedFlags.bitfield === member.parsedFlags.bitfield &&

this.flags === member.flags &&

.flags is deprecated so I didn't want to use it; I want to rename parsedFlags to flags in v15

Qjuh · 2024-03-29T14:27:51Z

packages/discord.js/src/structures/UncachedGuildMember.js

+  }
+
+  /**
+   * Deletes any DMs with this member.


It only deletes the DMChannel, not the DMs contained within. I know you just copied this from GuildMember where it‘s wrong too. But it’s correct in User.

NotSugden · 2024-03-29T23:35:42Z

packages/discord.js/src/structures/UncachedGuildMember.js

+     * @deprecated Use {@link UncachedGuildMember#premiumSinceTimestamp}
+     * or {@link UncachedGuildMember#premiumSince} instead


Suggested change

* @deprecated Use {@link UncachedGuildMember#premiumSinceTimestamp}

* or {@link UncachedGuildMember#premiumSince} instead

* @deprecated Use {@link UncachedGuildMember#premiumSinceTimestamp} or {@link UncachedGuildMember#premiumSince} instead

this is what I had originally, but it fails prettier due to the line length, so I split it up.

packages/discord.js/src/structures/UncachedGuildMember.js

Co-Authored-By: Vlad Frangu <me@vladfrangu.dev> Co-Authored-By: Qjuh <76154676+Qjuh@users.noreply.github.com>

vladfrangu · 2024-04-04T23:02:09Z

Marking the PR as both sem minor and major until I test it out and ensure this is a sem-minor PR 👀

Qjuh · 2024-04-05T10:29:41Z

packages/discord.js/src/structures/UncachedGuildMember.js

+     * The user that this guild member instance represents
+     * @type {User}
+     */
+    this.user = this.client.users._add(data.user, true);


Isn’t this a breaking change? APIInteractionGuildMember#user is APIUser and thus has snakecase properties. Now it doesn’t anymore.

Yep, that is a breaking change indeed... @advaith1 can you solve that too?

ugh, good catch. so I think the options here are

add (deprecated, maybe undocumented) getters for global_name, accent_color, and public_flags to User

make a new class extending User that adds those, and make UncachedGuildMember construct one of those instead

for simplicity I'd prefer to do the former tbh... what do people think

NotSugden · 2024-04-09T00:52:37Z

packages/discord.js/src/structures/UncachedGuildMember.js

+
+  /**
+   * The nickname of this member, or their user display name if they don't have one
+   * @type {?string}


would they not always have a display name, or is this something to do with partials?

hm yeah, why is this nullable in GuildMember? also user is nullable in GuildMember but id (which just returns this.user.id) isn't
are both of those just incorrectly marked as nullable

it would seem so

Is the user being nullable related to the

The field user won't be included in the member object attached to MESSAGE_CREATE and MESSAGE_UPDATE gateway events.

note that is under the Guild Member object table in the DAPI docs?

this sounds like something we need to investigate.... possibly seperately
but that would mean the docs on here could be wrong until investigation
complete

re posted because email replies dont work properly

In those two events the message.author field contains the user and is patched into the GuildMember accordingly so won’t be null either

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

Line 339 in de14c92

this.guild.members._add(Object.assign(data.member, { user: this.author }));

so in conclusion: the docs are wrong

NotSugden · 2024-04-09T00:54:09Z

packages/discord.js/src/structures/UncachedGuildMember.js

+ * @example
+ * // Send a direct message
+ * UncachedGuildMember.send('Hello!')
+ *   .then(message => console.log(`Sent message: ${message.content} to ${guildMember.displayName}`))


Suggested change

* .then(message => console.log(`Sent message: ${message.content} to ${guildMember.displayName}`))

* .then(message => console.log(`Sent message: ${message.content} to ${uncachedGuildMember.displayName}`))

Feels a bit silly but eh

NotSugden · 2024-04-09T00:56:37Z

packages/discord.js/typings/index.d.ts

+  );
+  public avatar: string | null;
+  public get dmChannel(): DMChannel | null;
+  public get displayName(): string;


i note infact from my previous comment that this is marked as always present but in the jsdoc it is not

packages/discord.js/src/structures/UncachedGuildMember.js

vladfrangu

Thoughts on an AnyGuildMember type which is union of both Uncached and GuildMember and we have functions that assert whether a member instance is the uncached one?

feat(Interactions): member objects for uncached guilds

85025d6

advaith1 requested a review from a team as a code owner March 29, 2024 03:47

advaith1 requested review from vladfrangu, iCrawl, kyranet and SpaceEEC March 29, 2024 03:47

github-actions bot added the packages:discord.js label Mar 29, 2024

vladfrangu added refactor semver:major labels Mar 29, 2024

vladfrangu requested changes Mar 29, 2024

View reviewed changes

Qjuh suggested changes Mar 29, 2024

View reviewed changes

NotSugden suggested changes Mar 29, 2024

View reviewed changes

advaith1 and others added 2 commits April 2, 2024 21:34

fix: fix review issues

e205862

Co-Authored-By: Vlad Frangu <me@vladfrangu.dev> Co-Authored-By: Qjuh <76154676+Qjuh@users.noreply.github.com>

refactor: default export

e9cb300

vladfrangu added semver:minor in review labels Apr 4, 2024

Qjuh reviewed Apr 5, 2024

View reviewed changes

Jiralite added this to the discord.js 14.15 milestone Apr 6, 2024

Jiralite added the blocked label Apr 7, 2024

Jiralite mentioned this pull request Apr 7, 2024

ci: Ensure reviews in progress label do not merge #10208

Merged

Jiralite removed the blocked label Apr 7, 2024

NotSugden suggested changes Apr 9, 2024

View reviewed changes

Jiralite reviewed Apr 10, 2024

View reviewed changes

packages/discord.js/src/structures/UncachedGuildMember.js Show resolved Hide resolved

vladfrangu reviewed Apr 30, 2024

View reviewed changes

Jiralite modified the milestones: discord.js 14.15, discord.js 14.16 Apr 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(Interactions): member objects for uncached guilds #10195

feat(Interactions): member objects for uncached guilds #10195

advaith1 commented Mar 29, 2024

vercel bot commented Mar 29, 2024 •

edited

vladfrangu left a comment

vladfrangu Mar 29, 2024

advaith1 Mar 29, 2024

vladfrangu Mar 29, 2024

advaith1 Mar 29, 2024 •

edited

vladfrangu Mar 29, 2024

Qjuh Mar 29, 2024

Qjuh Mar 29, 2024

advaith1 Mar 29, 2024

Qjuh Mar 29, 2024

Qjuh Mar 29, 2024

advaith1 Mar 29, 2024

Qjuh Mar 29, 2024

NotSugden Mar 29, 2024

This comment was marked as spam.

advaith1 Apr 3, 2024

vladfrangu commented Apr 4, 2024

Qjuh Apr 5, 2024

vladfrangu Apr 7, 2024

advaith1 Apr 9, 2024

NotSugden Apr 9, 2024

advaith1 Apr 9, 2024

NotSugden Apr 9, 2024

tipakA Apr 10, 2024

NotSugden Apr 10, 2024

Qjuh Apr 10, 2024

NotSugden Apr 10, 2024

NotSugden Apr 9, 2024

NotSugden Apr 9, 2024

vladfrangu left a comment

	this.parsedFlags.bitfield === member.parsedFlags.bitfield &&
	this.flags === member.flags &&

		* @deprecated Use {@link UncachedGuildMember#premiumSinceTimestamp}
		* or {@link UncachedGuildMember#premiumSince} instead

	* .then(message => console.log(`Sent message: ${message.content} to ${guildMember.displayName}`))
	* .then(message => console.log(`Sent message: ${message.content} to ${uncachedGuildMember.displayName}`))

feat(Interactions): member objects for uncached guilds #10195

Are you sure you want to change the base?

feat(Interactions): member objects for uncached guilds #10195

Conversation

advaith1 commented Mar 29, 2024

vercel bot commented Mar 29, 2024 • edited

vladfrangu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

advaith1 Mar 29, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as spam.

Choose a reason for hiding this comment

vladfrangu commented Apr 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vladfrangu left a comment

Choose a reason for hiding this comment

vercel bot commented Mar 29, 2024 •

edited

advaith1 Mar 29, 2024 •

edited