feat: expose Retry-After and sublimit timeouts in RatelimitData #9864

vladfrangu · 2023-10-01T00:50:28Z

Please describe the changes this PR makes and why it should be merged:

Expose Retry-After header in RatelimitData/RatelimitError, as well as sublimit timeouts, if any are present, which can be used in cases to report to users they'll need to wait (think for the /guilds/:id/emojis route and its ratelimit)

Also brings RatelimitData in sync with what we log for the debug event (unintentional enhancement)

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
This PR changes the library's interface (methods or parameters added)

vercel · 2023-10-01T00:50:34Z

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

Name	Status	Preview	Comments	Updated (UTC)
discord-js	❌ Failed (Inspect)			Nov 12, 2023 2:35pm
discord-js-guide	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 12, 2023 2:35pm

codecov · 2023-10-01T00:52:58Z

Codecov Report

Merging #9864 (390aeed) into main (62e6573) will increase coverage by 0.09%.
The diff coverage is 98.14%.

@@            Coverage Diff             @@
##             main    #9864      +/-   ##
==========================================
+ Coverage   59.23%   59.32%   +0.09%     
==========================================
  Files         237      237              
  Lines       16496    16536      +40     
  Branches     1237     1238       +1     
==========================================
+ Hits         9771     9810      +39     
- Misses       6680     6681       +1     
  Partials       45       45

Flag	Coverage Δ
brokers	`63.16% <ø> (ø)`
builders	`98.69% <ø> (ø)`
collection	`99.28% <ø> (ø)`
formatters	`99.45% <ø> (ø)`
guide	`0.00% <ø> (ø)`
next	`∅ <ø> (∅)`
proxy	`75.00% <ø> (ø)`
rest	`92.82% <98.14%> (+0.07%)`	⬆️
util	`70.70% <ø> (ø)`
utilities	`100.00% <ø> (ø)`
voice	`63.64% <ø> (ø)`
website	`0.00% <ø> (ø)`
ws	`52.63% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
packages/rest/src/lib/errors/RateLimitError.ts	`100.00% <100.00%> (ø)`
packages/rest/src/lib/handlers/BurstHandler.ts	`91.27% <100.00%> (+0.24%)`	⬆️
packages/rest/src/lib/utils/types.ts	`100.00% <100.00%> (ø)`
...ackages/rest/src/lib/handlers/SequentialHandler.ts	`87.71% <93.75%> (-0.01%)`	⬇️

📣 Codecov offers a browser extension for seamless coverage viewing on GitHub. Try it in Chrome or Firefox today!

packages/rest/src/lib/utils/types.ts

ckohen

So close

packages/rest/src/lib/utils/types.ts

Co-authored-by: ckohen <chaikohen@gmail.com>

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@discordjs/rest](https://discord.js.org) ([source](https://github.com/discordjs/discord.js)) | dependencies | minor | [`2.0.1` -> `2.2.0`](https://renovatebot.com/diffs/npm/@discordjs%2frest/2.0.1/2.2.0) | --- ### Release Notes <details> <summary>discordjs/discord.js (@discordjs/rest)</summary> ### [`v2.2.0`](https://github.com/discordjs/discord.js/blob/HEAD/packages/rest/CHANGELOG.md#discordjsrest220---2023-11-17) [Compare Source](https://github.com/discordjs/discord.js/compare/@discordjs/rest@2.1.0...@discordjs/rest@2.2.0) #### Bug Fixes - Minify mainlib docs json ([#9963](discordjs/discord.js#9963)) ([4b88306](discordjs/discord.js@4b88306)) #### Features - Present x-ratelimit-scope for 429s hit ([#9973](discordjs/discord.js#9973)) ([6df233d](discordjs/discord.js@6df233d)) #### Typings - Use wrapper utilities ([#9945](discordjs/discord.js#9945)) ([4bc1dae](discordjs/discord.js@4bc1dae)) ### [`v2.1.0`](https://github.com/discordjs/discord.js/blob/HEAD/packages/rest/CHANGELOG.md#discordjsrest210---2023-11-12) [Compare Source](https://github.com/discordjs/discord.js/compare/@discordjs/rest@2.0.1...@discordjs/rest@2.1.0) #### Bug Fixes - **REST:** Strip webhook tokens ([#9723](discordjs/discord.js#9723)) ([cf49f40](discordjs/discord.js@cf49f40)) #### Documentation - Fix "its" typo ([#9825](discordjs/discord.js#9825)) ([c50809e](discordjs/discord.js@c50809e)) - **create-discord-bot:** Support bun in create-discord-bot ([#9798](discordjs/discord.js#9798)) ([7157748](discordjs/discord.js@7157748)) #### Features - Expose Retry-After and sublimit timeouts in RatelimitData ([#9864](discordjs/discord.js#9864)) ([81e7866](discordjs/discord.js@81e7866)) - **CDN:** Support emoji size ([#9787](discordjs/discord.js#9787)) ([778df45](discordjs/discord.js@778df45)) </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/External/card-drop/pulls/101 Reviewed-by: Vylpes <ethan@vylpes.com> Co-authored-by: Renovate Bot <renovate@vylpes.com> Co-committed-by: Renovate Bot <renovate@vylpes.com>

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@discordjs/rest](https://discord.js.org) ([source](https://github.com/discordjs/discord.js)) | dependencies | minor | [`2.0.1` -> `2.2.0`](https://renovatebot.com/diffs/npm/@discordjs%2frest/2.0.1/2.2.0) | --- ### Release Notes <details> <summary>discordjs/discord.js (@discordjs/rest)</summary> ### [`v2.2.0`](https://github.com/discordjs/discord.js/blob/HEAD/packages/rest/CHANGELOG.md#discordjsrest220---2023-11-17) [Compare Source](https://github.com/discordjs/discord.js/compare/@discordjs/rest@2.1.0...@discordjs/rest@2.2.0) #### Bug Fixes - Minify mainlib docs json ([#9963](discordjs/discord.js#9963)) ([4b88306](discordjs/discord.js@4b88306)) #### Features - Present x-ratelimit-scope for 429s hit ([#9973](discordjs/discord.js#9973)) ([6df233d](discordjs/discord.js@6df233d)) #### Typings - Use wrapper utilities ([#9945](discordjs/discord.js#9945)) ([4bc1dae](discordjs/discord.js@4bc1dae)) ### [`v2.1.0`](https://github.com/discordjs/discord.js/blob/HEAD/packages/rest/CHANGELOG.md#discordjsrest210---2023-11-12) [Compare Source](https://github.com/discordjs/discord.js/compare/@discordjs/rest@2.0.1...@discordjs/rest@2.1.0) #### Bug Fixes - **REST:** Strip webhook tokens ([#9723](discordjs/discord.js#9723)) ([cf49f40](discordjs/discord.js@cf49f40)) #### Documentation - Fix "its" typo ([#9825](discordjs/discord.js#9825)) ([c50809e](discordjs/discord.js@c50809e)) - **create-discord-bot:** Support bun in create-discord-bot ([#9798](discordjs/discord.js#9798)) ([7157748](discordjs/discord.js@7157748)) #### Features - Expose Retry-After and sublimit timeouts in RatelimitData ([#9864](discordjs/discord.js#9864)) ([81e7866](discordjs/discord.js@81e7866)) - **CDN:** Support emoji size ([#9787](discordjs/discord.js#9787)) ([778df45](discordjs/discord.js@778df45)) </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/375 Reviewed-by: Vylpes <ethan@vylpes.com> Co-authored-by: Renovate Bot <renovate@vylpes.com> Co-committed-by: Renovate Bot <renovate@vylpes.com>

feat: expose Retry-After and sublimit timeouts in RatelimitData

6228549

vladfrangu added ratelimits semver:minor labels Oct 1, 2023

vladfrangu requested a review from a team as a code owner October 1, 2023 00:50

vladfrangu requested review from ckohen, iCrawl, kyranet, didinele and Jiralite October 1, 2023 00:50

github-actions bot added the packages:rest label Oct 1, 2023

ckohen reviewed Oct 1, 2023

View reviewed changes

packages/rest/src/lib/utils/types.ts Show resolved Hide resolved

packages/rest/src/lib/utils/types.ts Outdated Show resolved Hide resolved

Jiralite added this to the rest 2.1.0 milestone Oct 3, 2023

ckohen linked an issue Oct 18, 2023 that may be closed by this pull request

using rejectOnRateLimit, the RateLimitError.timeToReset property does not provide useful data when updating a channel name is rate limited #9572

Closed

chore: better docs?

aca1ad0

Jiralite approved these changes Nov 11, 2023

View reviewed changes

ckohen requested changes Nov 12, 2023

View reviewed changes

packages/rest/src/lib/utils/types.ts Outdated Show resolved Hide resolved

packages/rest/src/lib/utils/types.ts Outdated Show resolved Hide resolved

Apply suggestions from code review

0d35bf8

Co-authored-by: ckohen <chaikohen@gmail.com>

kyranet approved these changes Nov 12, 2023

View reviewed changes

ckohen approved these changes Nov 12, 2023

View reviewed changes

Merge branch 'main' into chore/add-reset-after-to-ratelimit-data

390aeed

vercel bot had a problem deploying to Preview – discord-js November 12, 2023 14:34 Failure

vercel bot deployed to Preview – discord-js-guide November 12, 2023 14:35 View deployment

kodiakhq bot merged commit 81e7866 into main Nov 12, 2023
21 checks passed

kodiakhq bot deleted the chore/add-reset-after-to-ratelimit-data branch November 12, 2023 14:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: expose Retry-After and sublimit timeouts in RatelimitData #9864

feat: expose Retry-After and sublimit timeouts in RatelimitData #9864

vladfrangu commented Oct 1, 2023 •

edited

Loading

vercel bot commented Oct 1, 2023 •

edited

Loading

codecov bot commented Oct 1, 2023 •

edited

Loading

ckohen left a comment

feat: expose Retry-After and sublimit timeouts in RatelimitData #9864

feat: expose Retry-After and sublimit timeouts in RatelimitData #9864

Conversation

vladfrangu commented Oct 1, 2023 • edited Loading

vercel bot commented Oct 1, 2023 • edited Loading

codecov bot commented Oct 1, 2023 • edited Loading

Codecov Report

ckohen left a comment

Choose a reason for hiding this comment

vladfrangu commented Oct 1, 2023 •

edited

Loading

vercel bot commented Oct 1, 2023 •

edited

Loading

codecov bot commented Oct 1, 2023 •

edited

Loading