Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-19 13:03:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* feat: expose Retry-After and sublimit timeouts in RatelimitData

* chore: better docs?

* Apply suggestions from code review

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

---------

Co-authored-by: ckohen <chaikohen@gmail.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
Vlad Frangu
2023-11-12 16:36:12 +02:00
committed by GitHub
parent 62e6573296
commit 81e7866903
4 changed files with 54 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
packages/rest/src/lib/handlers/BurstHandler.ts
View File

@@ -102,16 +102,20 @@ export class BurstHandler implements IHandler {
} else if (status === 429) {
// Unexpected ratelimit
const isGlobal = res.headers.has('X-RateLimit-Global');
await onRateLimit(this.manager, {
timeToReset: retryAfter,
limit: Number.POSITIVE_INFINITY,
global: isGlobal,
method,
hash: this.hash,
url,
route: routeId.bucketRoute,
majorParameter: this.majorParameter,
global: isGlobal,
hash: this.hash,
limit: Number.POSITIVE_INFINITY,
timeToReset: retryAfter,
retryAfter,
sublimitTimeout: 0,
});
this.debug(
[
'Encountered unexpected 429 rate limit',

24
packages/rest/src/lib/handlers/SequentialHandler.ts
View File

@@ -227,19 +227,23 @@ export class SequentialHandler implements IHandler {
}
const rateLimitData: RateLimitData = {
timeToReset: timeout,
limit,
global: isGlobal,
method: options.method ?? 'get',
hash: this.hash,
url,
route: routeId.bucketRoute,
majorParameter: this.majorParameter,
global: isGlobal,
hash: this.hash,
limit,
timeToReset: timeout,
retryAfter: timeout,
sublimitTimeout: 0,
};
// Let library users know they have hit a rate limit
this.manager.emit(RESTEvents.RateLimited, rateLimitData);
// Determine whether a RateLimitError should be thrown
await onRateLimit(this.manager, rateLimitData);
// When not erroring, emit debug for what is happening
if (isGlobal) {
this.debug(`Global rate limit hit, blocking all requests for ${timeout}ms`);
@@ -345,15 +349,18 @@ export class SequentialHandler implements IHandler {
}
await onRateLimit(this.manager, {
timeToReset: timeout,
limit,
global: isGlobal,
method,
hash: this.hash,
url,
route: routeId.bucketRoute,
majorParameter: this.majorParameter,
global: isGlobal,
hash: this.hash,
limit,
timeToReset: timeout,
retryAfter,
sublimitTimeout: sublimitTimeout ?? 0,
});
this.debug(
[
'Encountered unexpected 429 rate limit',
@@ -368,6 +375,7 @@ export class SequentialHandler implements IHandler {
` Sublimit : ${sublimitTimeout ? `${sublimitTimeout}ms` : 'None'}`,
].join('\n'),
);
// If caused by a sublimit, wait it out here so other requests on the route can be handled
if (sublimitTimeout) {
// Normally the sublimit queue will not exist, however, if a sublimit is hit while in the sublimit queue, it will