fix(Action): Do not set `undefined` values #9755

Jiralite · 2023-08-06T18:52:24Z

Please describe the changes this PR makes and why it should be merged:
Resolves #9754.

The object being sent to GenericAction#getPayload() might contain keys that were undefined. In this specific case, an ephemeral message with the direct messages intent would not contain a guild_id.¹ In combination with the partial, this would lead to manager._add(data, cache) which would then lead to here:

discord.js/packages/discord.js/src/structures/GuildChannel.js

Lines 66 to 68 in 7295a3a

    
           if ('guild_id' in data) { 
        
             this.guildId = data.guild_id; 
        
           }

Causing guildId to lose its value.

Status and versioning classification:

Code changes have been tested against the Discord API, or there are no code changes
I know how to update typings and have done so, or typings don't need updating

https://discord.com/developers/docs/topics/gateway-events#messages ↩

vercel · 2023-08-06T18:52:30Z

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		Aug 11, 2023 7:17am
discord-js-guide	⬜️ Ignored (Inspect)	Visit Preview		Aug 11, 2023 7:17am

github-actions · 2023-08-08T14:26:28Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟠 Performance	69
🟢 Accessibility	97
🟢 Best practices	100
🟠 SEO	75
🔴 PWA	30

Lighthouse ran on https://discord-js-git-fix-guild-id-undefined-discordjs.vercel.app/

Markus-Rost · 2023-08-08T22:24:01Z

I hope this can be merged in a patch release soon, per typings guild_id should never be undefined for TextChannel class.

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [discord.js](https://discord.js.org) ([source](https://github.com/discordjs/discord.js)) | dependencies | minor | [`14.11.0` -> `14.14.1`](https://renovatebot.com/diffs/npm/discord.js/14.11.0/14.14.1) | --- ### Release Notes <details> <summary>discordjs/discord.js (discord.js)</summary> ### [`v14.14.1`](https://github.com/discordjs/discord.js/blob/HEAD/packages/discord.js/CHANGELOG.md#14141---2023-11-12) [Compare Source](discordjs/discord.js@14.14.0...14.14.1) #### Bug Fixes - **Emoji:** `id` set as `undefined` edge case ([#9953](discordjs/discord.js#9953)) ([cc07a28](discordjs/discord.js@cc07a28)) - **BaseClient:** Default in objects properly ([#9952](discordjs/discord.js#9952)) ([f93abf7](discordjs/discord.js@f93abf7)) #### Documentation - Use preferred nullable syntax (`?T` over `T | null`) ([#9946](discordjs/discord.js#9946)) ([1e4ef35](discordjs/discord.js@1e4ef35)) #### Refactor - Use formatters ([#9956](discordjs/discord.js#9956)) ([40726db](discordjs/discord.js@40726db)) #### Typings - Use wrapper utilities ([#9945](discordjs/discord.js#9945)) ([4bc1dae](discordjs/discord.js@4bc1dae)) ### [`v14.14.0`](https://github.com/discordjs/discord.js/blob/HEAD/packages/discord.js/CHANGELOG.md#14140---2023-11-12) [Compare Source](discordjs/discord.js@14.13.0...14.14.0) #### Bug Fixes - **Client:** Ensure destroyed connections are not ready ([#9942](discordjs/discord.js#9942)) ([b5e23ec](discordjs/discord.js@b5e23ec)) - **Webhook:** Do not call `client.deleteWebhook` in `delete` ([#9786](discordjs/discord.js#9786)) ([31d914e](discordjs/discord.js@31d914e)) - **GuildManager#fetch:** Inject shard id ([#9921](discordjs/discord.js#9921)) ([85753a9](discordjs/discord.js@85753a9)) - Prevent 'undefined' debug message on intentional shard closure ([#9846](discordjs/discord.js#9846)) ([0e0b85b](discordjs/discord.js@0e0b85b)) - **Role:** Calculate position correctly when rawPositions are equal ([#9871](discordjs/discord.js#9871)) ([0529b2a](discordjs/discord.js@0529b2a)) - **GuildScheduledEvent:** Use `if...else` pattern and handle partials ([#9802](discordjs/discord.js#9802)) ([32d614c](discordjs/discord.js@32d614c)) #### Documentation - **Message:** Remove duplicated word 'of' in description ([#9923](discordjs/discord.js#9923)) ([85a78f9](discordjs/discord.js@85a78f9)) - **GuildMember:** Clarify display color ([#9891](discordjs/discord.js#9891)) ([e38d03f](discordjs/discord.js@e38d03f)) - Remove duplicate `APIEmoji` ([#9880](discordjs/discord.js#9880)) ([8cfadb6](discordjs/discord.js@8cfadb6)) - Consolidate API types ([#9881](discordjs/discord.js#9881)) ([44a3cbf](discordjs/discord.js@44a3cbf)) - Remove `FileOptions` ([#9855](discordjs/discord.js#9855)) ([eaabcdf](discordjs/discord.js@eaabcdf)) - **DiscordjsErrorCodes:** Deprecate unused properties ([#9790](discordjs/discord.js#9790)) ([4588e07](discordjs/discord.js@4588e07)) - **ApplicationCommandManager:** Id parameter can take options ([#9664](discordjs/discord.js#9664)) ([ed14135](discordjs/discord.js@ed14135)) - **Attachment:** Add MIME types link to `contentType` ([#9824](discordjs/discord.js#9824)) ([85b2498](discordjs/discord.js@85b2498)) - Fix "its" typo ([#9825](discordjs/discord.js#9825)) ([c50809e](discordjs/discord.js@c50809e)) - **GuildMember:** Clarify timeout parameter wording ([#9800](discordjs/discord.js#9800)) ([8d97e2d](discordjs/discord.js@8d97e2d)) - **create-discord-bot:** Support bun in create-discord-bot ([#9798](discordjs/discord.js#9798)) ([7157748](discordjs/discord.js@7157748)) #### Features - Default select menu values ([#9867](discordjs/discord.js#9867)) ([4ff3ea4](discordjs/discord.js@4ff3ea4)) - Mainlib docs on new website ([#9930](discordjs/discord.js#9930)) ([da455bc](discordjs/discord.js@da455bc)) - **cleanContent:** Add slash commands and emojis ([#9809](discordjs/discord.js#9809)) ([c2349d4](discordjs/discord.js@c2349d4)) - **Emoji:** Add `imageURL()` ([#9788](discordjs/discord.js#9788)) ([b6c762c](discordjs/discord.js@b6c762c)) - Onboarding mode and edit method ([#9647](discordjs/discord.js#9647)) ([7671a83](discordjs/discord.js@7671a83)) - Support new application properties and patch endpoint ([#9709](discordjs/discord.js#9709)) ([1fe7247](discordjs/discord.js@1fe7247)) - **BaseChannel:** Add `isThreadOnly()` ([#9847](discordjs/discord.js#9847)) ([699b232](discordjs/discord.js@699b232)) - **StageInstanceManager:** Add `guildScheduledEvent` to `create()` ([#8885](discordjs/discord.js#8885)) ([931c3ed](discordjs/discord.js@931c3ed)) - Support `default_thread_rate_limit_per_user` in channel creation ([#9273](discordjs/discord.js#9273)) ([1e5c14b](discordjs/discord.js@1e5c14b)) - Add media channels ([#9662](discordjs/discord.js#9662)) ([571aedd](discordjs/discord.js@571aedd)) - Support widget image URL ([#9782](discordjs/discord.js#9782)) ([b6a2441](discordjs/discord.js@b6a2441)) - **GuildAuditLogsEntry:** Expose extra integrationType in relevant log types ([#9796](discordjs/discord.js#9796)) ([3109798](discordjs/discord.js@3109798)) - Add support for teams update ([#9805](discordjs/discord.js#9805)) ([c66636d](discordjs/discord.js@c66636d)) - **Presence:** Expose sync_id in Activity ([#9766](discordjs/discord.js#9766)) ([485dd71](discordjs/discord.js@485dd71)) #### Refactor - **utils:** Remove `mergeDefault` ([#9938](discordjs/discord.js#9938)) ([5b0aa92](discordjs/discord.js@5b0aa92)) - Use proper variable names in callbacks ([#9840](discordjs/discord.js#9840)) ([11f6955](discordjs/discord.js@11f6955)) - **GuildAuditLogsEntry:** Abstract reduce logic into a new function ([#9845](discordjs/discord.js#9845)) ([19ea0ba](discordjs/discord.js@19ea0ba)) - Stickers are free (no more "premium" packs) ([#9791](discordjs/discord.js#9791)) ([e02a59b](discordjs/discord.js@e02a59b)) #### Typings - **Partials:** Add toString() method to supported Partials ([#9835](discordjs/discord.js#9835)) ([7422d9f](discordjs/discord.js@7422d9f)) - **MessageEditOptions:** Correct `attachments` type ([#9874](discordjs/discord.js#9874)) ([2aa3250](discordjs/discord.js@2aa3250)) - **UserContextMenuCommandInteraction:** Nullify `targetMember` ([#9844](discordjs/discord.js#9844)) ([3c043d8](discordjs/discord.js@3c043d8)) - Don't include dom types ([#9831](discordjs/discord.js#9831)) ([9dbc954](discordjs/discord.js@9dbc954)) - **Client:** Fix isReady narrowing ([#9828](discordjs/discord.js#9828)) ([6404c01](discordjs/discord.js@6404c01)) ### [`v14.13.0`](https://github.com/discordjs/discord.js/blob/HEAD/packages/discord.js/CHANGELOG.md#14130---2023-08-17) [Compare Source](discordjs/discord.js@14.12.1...14.13.0) #### Bug Fixes - **Action:** Do not add the client user as a recipient ([#9774](discordjs/discord.js#9774)) ([24fbb11](discordjs/discord.js@24fbb11)) - **DMChannel:** Correct partial typo ([#9773](discordjs/discord.js#9773)) ([c1ff545](discordjs/discord.js@c1ff545)) - **CachedManager:** Allow overriding constructor for makeCache ([#9763](discordjs/discord.js#9763)) ([346fa57](discordjs/discord.js@346fa57)) - **types:** Fixed CachedManager constructor arguments in type ([#9761](discordjs/discord.js#9761)) ([b3c85d3](discordjs/discord.js@b3c85d3)) - **Action:** Do not set `undefined` values ([#9755](discordjs/discord.js#9755)) ([d8e3755](discordjs/discord.js@d8e3755)) #### Documentation - **EmbedBuilder:** `@readonly` length ([#9778](discordjs/discord.js#9778)) ([8f572a6](discordjs/discord.js@8f572a6)) - **WebhookEditOptions:** Add all of the types ([#9776](discordjs/discord.js#9776)) ([d5be424](discordjs/discord.js@d5be424)) - Update Node.js requirement to 16.11.0 ([#9764](discordjs/discord.js#9764)) ([188877c](discordjs/discord.js@188877c)) #### Features - **Client:** Add deleteWebhook method ([#9777](discordjs/discord.js#9777)) ([d90ba8d](discordjs/discord.js@d90ba8d)) - **ClientPresence:** Allow setting activity state ([#9743](discordjs/discord.js#9743)) ([9ed1b59](discordjs/discord.js@9ed1b59)) - **ClientApplication:** Approximate guild count and new `GET` route ([#9713](discordjs/discord.js#9713)) ([632a9b4](discordjs/discord.js@632a9b4)) - **Role:** Add `flags` ([#9694](discordjs/discord.js#9694)) ([3b18e5b](discordjs/discord.js@3b18e5b)) - **Attachment:** Add `flags` ([#9686](discordjs/discord.js#9686)) ([692f0fc](discordjs/discord.js@692f0fc)) - Add `Client#webhooksUpdate` ([#9732](discordjs/discord.js#9732)) ([0de071d](discordjs/discord.js@0de071d)) #### Typings - **GuildInvitableChannelResolvable:** Allow forum channels ([#9775](discordjs/discord.js#9775)) ([727dc09](discordjs/discord.js@727dc09)) - Make activity name required ([#9765](discordjs/discord.js#9765)) ([0a9a3ed](discordjs/discord.js@0a9a3ed)) - **BaseButtonComponentData:** Narrow component type ([#9735](discordjs/discord.js#9735)) ([a30d46c](discordjs/discord.js@a30d46c)) ### [`v14.12.1`](https://github.com/discordjs/discord.js/blob/HEAD/packages/discord.js/CHANGELOG.md#14121---2023-08-01) [Compare Source](discordjs/discord.js@14.12.0...14.12.1) #### Bug Fixes - **BaseClient:** Fix destroy method ([#9742](discordjs/discord.js#9742)) ([1af7e5a](discordjs/discord.js@1af7e5a)) ### [`v14.12.0`](https://github.com/discordjs/discord.js/blob/HEAD/packages/discord.js/CHANGELOG.md#14120---2023-07-31) [Compare Source](discordjs/discord.js@14.11.0...14.12.0) #### Bug Fixes - **ChannelUpdate:** Check against unknown channels ([#9697](discordjs/discord.js#9697)) ([7fb91c5](discordjs/discord.js@7fb91c5)) - **Action:** Use existing recipients if available ([#9653](discordjs/discord.js#9653)) ([719e54a](discordjs/discord.js@719e54a)) - Everyone role members ([#9685](discordjs/discord.js#9685)) ([0803eb5](discordjs/discord.js@0803eb5)) - `awaitMessageComponent` with `MessageComponentInteraction`s ([#8598](discordjs/discord.js#8598)) ([b61e4fb](discordjs/discord.js@b61e4fb)) - **ThreadManager:** Fix internal crash upon conditionally resolving thread members ([#9648](discordjs/discord.js#9648)) ([a6dbe16](discordjs/discord.js@a6dbe16)) - **User:** Check global name in equals ([#9631](discordjs/discord.js#9631)) ([8f3bd38](discordjs/discord.js@8f3bd38)) - **WebSocketManager:** Await WebSocket destroy ([#9519](discordjs/discord.js#9519)) ([75308f2](discordjs/discord.js@75308f2)) - **Client:** Safe call for possibly null WebSocket ([#9600](discordjs/discord.js#9600)) ([24a6149](discordjs/discord.js@24a6149)) - **ThreadManager:** Ensure `fetchActive()` only returns active threads in a channel ([#9568](discordjs/discord.js#9568)) ([53aa24d](discordjs/discord.js@53aa24d)) - **LimitedCollection:** Allow items to be stored if keepOverLimit is true when maxSize is 0 ([#9534](discordjs/discord.js#9534)) ([9345d1b](discordjs/discord.js@9345d1b)) - **AutocompleteInteraction:** Prevent snake casing of locales ([#9565](discordjs/discord.js#9565)) ([7196fe3](discordjs/discord.js@7196fe3)) #### Documentation - Change `Channel` to `BaseChannel` ([#9718](discordjs/discord.js#9718)) ([e5effb6](discordjs/discord.js@e5effb6)) - **BaseChannel:** Remove `APIChannel` ([#9717](discordjs/discord.js#9717)) ([125405f](discordjs/discord.js@125405f)) - **BuildersSelectMenuOption:** Update link ([#9690](discordjs/discord.js#9690)) ([ede9f4e](discordjs/discord.js@ede9f4e)) - **ClientOptions:** Change default value of sweepers in docs ([#9591](discordjs/discord.js#9591)) ([911e6ef](discordjs/discord.js@911e6ef)) - **Client:** Correct invite gateway permission checks ([#9597](discordjs/discord.js#9597)) ([e1b6eee](discordjs/discord.js@e1b6eee)) - Fix broken links to new documentation ([#9563](discordjs/discord.js#9563)) ([d01e8aa](discordjs/discord.js@d01e8aa)) #### Features - Add ws option support for "buildIdentifyThrottler" ([#9728](discordjs/discord.js#9728)) ([6307f81](discordjs/discord.js@6307f81)) - **Client:** Add `guildAvailable` event ([#9692](discordjs/discord.js#9692)) ([3c85fb2](discordjs/discord.js@3c85fb2)) - User avatar decorations ([#8914](discordjs/discord.js#8914)) ([8d97017](discordjs/discord.js@8d97017)) - Add silent option to ShardingManager ([#9506](discordjs/discord.js#9506)) ([df40dcd](discordjs/discord.js@df40dcd)) - **EmbedBuilder:** Add `.length` ([#8682](discordjs/discord.js#8682)) ([53c17e0](discordjs/discord.js@53c17e0)) - Guild onboarding ([#9120](discordjs/discord.js#9120)) ([dc73c93](discordjs/discord.js@dc73c93)) - Add resume event in shard ([#9650](discordjs/discord.js#9650)) ([a73d54e](discordjs/discord.js@a73d54e)) - **presence:** Re-introduce image resolving for other platforms ([#9637](discordjs/discord.js#9637)) ([73c2f8a](discordjs/discord.js@73c2f8a)) - Add message to send resume event to shard ([#9626](discordjs/discord.js#9626)) ([a873ec1](discordjs/discord.js@a873ec1)) - Support new username system ([#9512](discordjs/discord.js#9512)) ([1ab60f9](discordjs/discord.js@1ab60f9)) - **GuildAuditLogsEntry#extra:** Add missing `channel` property ([#9518](discordjs/discord.js#9518)) ([2272321](discordjs/discord.js@2272321)) #### Performance - **Channel:** Linear speed position getter ([#9497](discordjs/discord.js#9497)) ([09b0382](discordjs/discord.js@09b0382)) - **Role:** Improve `members` getter ([#9529](discordjs/discord.js#9529)) ([37181ab](discordjs/discord.js@37181ab)) #### Refactor - **User:** Remove deprecation warning from tag ([#9660](discordjs/discord.js#9660)) ([cf8012c](discordjs/discord.js@cf8012c)) - **GuildMember:** Make `_roles` property non-enumerable ([#9387](discordjs/discord.js#9387)) ([46167a7](discordjs/discord.js@46167a7)) - **rest:** Switch api to fetch-like and provide strategies ([#9416](discordjs/discord.js#9416)) ([cdaa0a3](discordjs/discord.js@cdaa0a3)) - **BREAKING CHANGE:** NodeJS v18+ is required when using node due to the use of global `fetch` - **BREAKING CHANGE:** The raw method of REST now returns a web compatible `Respone` object. - **BREAKING CHANGE:** The `parseResponse` utility method has been updated to operate on a web compatible `Response` object. - **BREAKING CHANGE:** Many underlying internals have changed, some of which were exported. - **BREAKING CHANGE:** `DefaultRestOptions` used to contain a default `agent`, which is now set to `null` instead. #### Typings - **MessageManager:** Allow comparison of messages again ([#9612](discordjs/discord.js#9612)) ([a48d0ef](discordjs/discord.js@a48d0ef)) - **AutoModerationActionExecution:** Add forum channels as a possible type in `channel()` ([#9623](discordjs/discord.js#9623)) ([d64330a](discordjs/discord.js@d64330a)) - **ModalSubmitFields:** Components is an array ([#9406](discordjs/discord.js#9406)) ([1cab79f](discordjs/discord.js@1cab79f)) - Use `readonly` arrays and `const` type parameters in places ([#9641](discordjs/discord.js#9641)) ([cd69868](discordjs/discord.js@cd69868)) - **BaseInteraction:** `appPermissions` not `null` in guilds ([#9601](discordjs/discord.js#9601)) ([6c2242f](discordjs/discord.js@6c2242f)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/vylbot-app/pulls/351 Reviewed-by: Vylpes <ethan@vylpes.com> Co-authored-by: Renovate Bot <renovate@vylpes.com> Co-committed-by: Renovate Bot <renovate@vylpes.com>

fix(Action): do not set undefined values

a974d22

Jiralite added regression semver:patch packages:discord.js labels Aug 6, 2023

Jiralite requested a review from a team as a code owner August 6, 2023 18:52

Jiralite requested review from vladfrangu, iCrawl, kyranet and SpaceEEC August 6, 2023 18:52

Jiralite added this to the discord.js 14.13 milestone Aug 6, 2023

Jiralite changed the title ~~fix(Action): do not set undefined values~~ fix(Action): Do not set undefined values Aug 6, 2023

sdanialraza approved these changes Aug 6, 2023

View reviewed changes

Merge branch 'main' into fix/guild-id-undefined

44deaa9

vladfrangu approved these changes Aug 9, 2023

View reviewed changes

SpaceEEC approved these changes Aug 10, 2023

View reviewed changes

kyranet approved these changes Aug 11, 2023

View reviewed changes

Merge branch 'main' into fix/guild-id-undefined

ddb9d42

kodiakhq bot merged commit d8e3755 into main Aug 11, 2023
7 checks passed

kodiakhq bot deleted the fix/guild-id-undefined branch August 11, 2023 07:20

jaw0r3k added a commit to jaw0r3k/discord.js that referenced this pull request Aug 12, 2023

fix(Action): Do not set undefined values (discordjs#9755)

ec8f0d7

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>

jaw0r3k mentioned this pull request Aug 12, 2023

chore: Miscellaneous backports #9769

Merged

vladfrangu pushed a commit to jaw0r3k/discord.js that referenced this pull request Nov 4, 2023

fix(Action): Do not set undefined values (discordjs#9755)

f5bc779

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>

vladfrangu pushed a commit that referenced this pull request Nov 5, 2023

fix(Action): Do not set undefined values (#9755)

65bbed8

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(Action): Do not set `undefined` values #9755

fix(Action): Do not set `undefined` values #9755

Jiralite commented Aug 6, 2023

vercel bot commented Aug 6, 2023 •

edited

github-actions bot commented Aug 8, 2023 •

edited

Markus-Rost commented Aug 8, 2023

fix(Action): Do not set undefined values #9755

fix(Action): Do not set undefined values #9755

Conversation

Jiralite commented Aug 6, 2023

Footnotes

vercel bot commented Aug 6, 2023 • edited

github-actions bot commented Aug 8, 2023 • edited

Markus-Rost commented Aug 8, 2023

fix(Action): Do not set `undefined` values #9755

fix(Action): Do not set `undefined` values #9755

vercel bot commented Aug 6, 2023 •

edited

github-actions bot commented Aug 8, 2023 •

edited