@discordeno/rest 19.0.0-next.3ebcce8 → 19.0.0-next.40c19da
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +7 -2
- package/dist/index.js.map +1 -0
- package/dist/invalidBucket.js +84 -2
- package/dist/invalidBucket.js.map +1 -0
- package/dist/manager.d.ts.map +1 -1
- package/dist/manager.js +1464 -2
- package/dist/manager.js.map +1 -0
- package/dist/queue.js +153 -2
- package/dist/queue.js.map +1 -0
- package/dist/types.d.ts +13 -6
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +3 -2
- package/dist/types.js.map +1 -0
- package/dist/typings/routes.js +3 -2
- package/dist/typings/routes.js.map +1 -0
- package/package.json +16 -15
package/dist/index.js
CHANGED
|
@@ -1,2 +1,7 @@
|
|
|
1
|
-
export*from
|
|
2
|
-
|
|
1
|
+
export * from './typings/routes.js';
|
|
2
|
+
export * from './invalidBucket.js';
|
|
3
|
+
export * from './manager.js';
|
|
4
|
+
export * from './queue.js';
|
|
5
|
+
export * from './types.js';
|
|
6
|
+
|
|
7
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './typings/routes.js'\n\nexport * from './invalidBucket.js'\nexport * from './manager.js'\nexport * from './queue.js'\nexport * from './types.js'\n"],"names":[],"mappings":"AAAA,cAAc,sBAAqB;AAEnC,cAAc,qBAAoB;AAClC,cAAc,eAAc;AAC5B,cAAc,aAAY;AAC1B,cAAc,aAAY"}
|
package/dist/invalidBucket.js
CHANGED
|
@@ -1,2 +1,84 @@
|
|
|
1
|
-
import{delay
|
|
2
|
-
|
|
1
|
+
import { delay, logger } from '@discordeno/utils';
|
|
2
|
+
/**
|
|
3
|
+
* A invalid request bucket is used in a similar manner as a leaky bucket but a invalid request bucket can be refilled as needed.
|
|
4
|
+
* It's purpose is to make sure the bot does not hit the limit to getting a 1 hr ban.
|
|
5
|
+
*
|
|
6
|
+
* @param options The options used to configure this bucket.
|
|
7
|
+
* @returns RefillingBucket
|
|
8
|
+
*/ export function createInvalidRequestBucket(options) {
|
|
9
|
+
const bucket = {
|
|
10
|
+
current: options.current ?? 0,
|
|
11
|
+
max: options.max ?? 10000,
|
|
12
|
+
interval: options.interval ?? 600000,
|
|
13
|
+
timeoutId: options.timeoutId,
|
|
14
|
+
safety: options.safety ?? 1,
|
|
15
|
+
errorStatuses: options.errorStatuses ?? [
|
|
16
|
+
401,
|
|
17
|
+
403,
|
|
18
|
+
429
|
|
19
|
+
],
|
|
20
|
+
requested: options.requested ?? 0,
|
|
21
|
+
processing: false,
|
|
22
|
+
waiting: [],
|
|
23
|
+
requestsAllowed: function() {
|
|
24
|
+
return bucket.max - bucket.current - bucket.requested - bucket.safety;
|
|
25
|
+
},
|
|
26
|
+
isRequestAllowed: function() {
|
|
27
|
+
return bucket.requestsAllowed() > 0;
|
|
28
|
+
},
|
|
29
|
+
waitUntilRequestAvailable: async function() {
|
|
30
|
+
// eslint-disable-next-line no-async-promise-executor
|
|
31
|
+
return await new Promise(async (resolve)=>{
|
|
32
|
+
// If whatever amount of requests is left is more than the safety margin, allow the request
|
|
33
|
+
if (bucket.isRequestAllowed()) {
|
|
34
|
+
bucket.requested++;
|
|
35
|
+
resolve();
|
|
36
|
+
} else {
|
|
37
|
+
bucket.waiting.push(resolve);
|
|
38
|
+
await bucket.processWaiting();
|
|
39
|
+
}
|
|
40
|
+
});
|
|
41
|
+
},
|
|
42
|
+
processWaiting: async function() {
|
|
43
|
+
// If already processing, that loop will handle all waiting requests.
|
|
44
|
+
if (bucket.processing) {
|
|
45
|
+
return;
|
|
46
|
+
}
|
|
47
|
+
// Mark as processing so other loops don't start
|
|
48
|
+
bucket.processing = true;
|
|
49
|
+
while(bucket.waiting.length > 0){
|
|
50
|
+
logger.info(`[InvalidBucket] processing waiting queue while loop ran with ${bucket.waiting.length} remaining.`);
|
|
51
|
+
if (bucket.isRequestAllowed()) {
|
|
52
|
+
bucket.requested++;
|
|
53
|
+
// Resolve the next item in the queue
|
|
54
|
+
bucket.waiting.shift()?.();
|
|
55
|
+
} else {
|
|
56
|
+
await delay(1000);
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
// Mark as false so next pending request can be triggered by new loop.
|
|
60
|
+
bucket.processing = false;
|
|
61
|
+
},
|
|
62
|
+
handleCompletedRequest: function(code, sharedScope) {
|
|
63
|
+
// Since request is complete, we can remove one from requested.
|
|
64
|
+
bucket.requested--;
|
|
65
|
+
// Since it is as a valid request, we don't need to do anything
|
|
66
|
+
if (!bucket.errorStatuses.includes(code)) return;
|
|
67
|
+
// Shared scope is not considered invalid
|
|
68
|
+
if (code === 429 && sharedScope) return;
|
|
69
|
+
// INVALID REQUEST WAS MADE
|
|
70
|
+
// Mark a request has been invalid
|
|
71
|
+
bucket.current++;
|
|
72
|
+
// If a timeout was not started, start a timeout to reset this bucket
|
|
73
|
+
if (bucket.timeoutId === undefined) {
|
|
74
|
+
bucket.timeoutId = setTimeout(()=>{
|
|
75
|
+
bucket.current = 0;
|
|
76
|
+
bucket.timeoutId = undefined;
|
|
77
|
+
}, bucket.interval);
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
};
|
|
81
|
+
return bucket;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
//# sourceMappingURL=invalidBucket.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/invalidBucket.ts"],"sourcesContent":["import { delay, logger } from '@discordeno/utils'\n\n/**\n * A invalid request bucket is used in a similar manner as a leaky bucket but a invalid request bucket can be refilled as needed.\n * It's purpose is to make sure the bot does not hit the limit to getting a 1 hr ban.\n *\n * @param options The options used to configure this bucket.\n * @returns RefillingBucket\n */\nexport function createInvalidRequestBucket(options: InvalidRequestBucketOptions): InvalidRequestBucket {\n const bucket: InvalidRequestBucket = {\n current: options.current ?? 0,\n max: options.max ?? 10000,\n interval: options.interval ?? 600000,\n timeoutId: options.timeoutId,\n safety: options.safety ?? 1,\n errorStatuses: options.errorStatuses ?? [401, 403, 429],\n requested: options.requested ?? 0,\n processing: false,\n\n waiting: [],\n\n requestsAllowed: function () {\n return bucket.max - bucket.current - bucket.requested - bucket.safety\n },\n\n isRequestAllowed: function () {\n return bucket.requestsAllowed() > 0\n },\n\n waitUntilRequestAvailable: async function () {\n // eslint-disable-next-line no-async-promise-executor\n return await new Promise(async (resolve) => {\n // If whatever amount of requests is left is more than the safety margin, allow the request\n if (bucket.isRequestAllowed()) {\n bucket.requested++\n resolve()\n } else {\n bucket.waiting.push(resolve)\n await bucket.processWaiting()\n }\n })\n },\n\n processWaiting: async function () {\n // If already processing, that loop will handle all waiting requests.\n if (bucket.processing) {\n return\n }\n\n // Mark as processing so other loops don't start\n bucket.processing = true\n\n while (bucket.waiting.length > 0) {\n logger.info(`[InvalidBucket] processing waiting queue while loop ran with ${bucket.waiting.length} remaining.`)\n if (bucket.isRequestAllowed()) {\n bucket.requested++\n // Resolve the next item in the queue\n bucket.waiting.shift()?.()\n } else {\n await delay(1000)\n }\n }\n\n // Mark as false so next pending request can be triggered by new loop.\n bucket.processing = false\n },\n\n handleCompletedRequest: function (code, sharedScope) {\n // Since request is complete, we can remove one from requested.\n bucket.requested--\n // Since it is as a valid request, we don't need to do anything\n if (!bucket.errorStatuses.includes(code)) return\n // Shared scope is not considered invalid\n if (code === 429 && sharedScope) return\n\n // INVALID REQUEST WAS MADE\n\n // Mark a request has been invalid\n bucket.current++\n // If a timeout was not started, start a timeout to reset this bucket\n if (bucket.timeoutId === undefined) {\n bucket.timeoutId = setTimeout(() => {\n bucket.current = 0\n bucket.timeoutId = undefined\n }, bucket.interval)\n }\n },\n }\n\n return bucket\n}\n\nexport interface InvalidRequestBucketOptions {\n /** current invalid amount */\n current?: number\n /** max invalid requests allowed until ban. Defaults to 10,000 */\n max?: number\n /** The time that discord allows to make the max number of invalid requests. Defaults to 10 minutes */\n interval?: number\n /** timer to reset to 0 */\n timeoutId?: NodeJS.Timeout\n /** how safe to be from max. Defaults to 1 */\n safety?: number\n /** The request statuses that count as an invalid request. */\n errorStatuses?: number[]\n /** The amount of requests that were requested from this bucket. */\n requested?: number\n}\n\nexport interface InvalidRequestBucket {\n /** current invalid amount */\n current: number\n /** max invalid requests allowed until ban. Defaults to 10,000 */\n max: number\n /** The time that discord allows to make the max number of invalid requests. Defaults to 10 minutes */\n interval: number\n /** timer to reset to 0 */\n timeoutId: NodeJS.Timeout | undefined\n /** how safe to be from max. Defaults to 1 */\n safety: number\n /** The request statuses that count as an invalid request. */\n errorStatuses: number[]\n /** The amount of requests that were requested from this bucket. */\n requested: number\n /** The requests that are currently pending. */\n waiting: Array<(value: void | PromiseLike<void>) => void>\n /** Whether or not the waiting queue is already processing. */\n processing: boolean\n\n /** Gives the number of requests that are currently allowed. */\n requestsAllowed: () => number\n /** Checks if a request is allowed at this time. */\n isRequestAllowed: () => boolean\n /** Waits until a request is available */\n waitUntilRequestAvailable: () => Promise<void>\n /** Begins processing the waiting queue of requests. */\n processWaiting: () => Promise<void>\n /** Handler for whenever a request is validated. This should update the requested values or trigger any other necessary stuff. */\n handleCompletedRequest: (code: number, sharedScope: boolean) => void\n}\n"],"names":["delay","logger","createInvalidRequestBucket","options","bucket","current","max","interval","timeoutId","safety","errorStatuses","requested","processing","waiting","requestsAllowed","isRequestAllowed","waitUntilRequestAvailable","Promise","resolve","push","processWaiting","length","info","shift","handleCompletedRequest","code","sharedScope","includes","undefined","setTimeout"],"mappings":"AAAA,SAASA,KAAK,EAAEC,MAAM,QAAQ,oBAAmB;AAEjD;;;;;;CAMC,GACD,OAAO,SAASC,2BAA2BC,OAAoC,EAAwB;IACrG,MAAMC,SAA+B;QACnCC,SAASF,QAAQE,OAAO,IAAI;QAC5BC,KAAKH,QAAQG,GAAG,IAAI;QACpBC,UAAUJ,QAAQI,QAAQ,IAAI;QAC9BC,WAAWL,QAAQK,SAAS;QAC5BC,QAAQN,QAAQM,MAAM,IAAI;QAC1BC,eAAeP,QAAQO,aAAa,IAAI;YAAC;YAAK;YAAK;SAAI;QACvDC,WAAWR,QAAQQ,SAAS,IAAI;QAChCC,YAAY,KAAK;QAEjBC,SAAS,EAAE;QAEXC,iBAAiB,WAAY;YAC3B,OAAOV,OAAOE,GAAG,GAAGF,OAAOC,OAAO,GAAGD,OAAOO,SAAS,GAAGP,OAAOK,MAAM;QACvE;QAEAM,kBAAkB,WAAY;YAC5B,OAAOX,OAAOU,eAAe,KAAK;QACpC;QAEAE,2BAA2B,iBAAkB;YAC3C,qDAAqD;YACrD,OAAO,MAAM,IAAIC,QAAQ,OAAOC,UAAY;gBAC1C,2FAA2F;gBAC3F,IAAId,OAAOW,gBAAgB,IAAI;oBAC7BX,OAAOO,SAAS;oBAChBO;gBACF,OAAO;oBACLd,OAAOS,OAAO,CAACM,IAAI,CAACD;oBACpB,MAAMd,OAAOgB,cAAc;gBAC7B,CAAC;YACH;QACF;QAEAA,gBAAgB,iBAAkB;YAChC,qEAAqE;YACrE,IAAIhB,OAAOQ,UAAU,EAAE;gBACrB;YACF,CAAC;YAED,gDAAgD;YAChDR,OAAOQ,UAAU,GAAG,IAAI;YAExB,MAAOR,OAAOS,OAAO,CAACQ,MAAM,GAAG,EAAG;gBAChCpB,OAAOqB,IAAI,CAAC,CAAC,6DAA6D,EAAElB,OAAOS,OAAO,CAACQ,MAAM,CAAC,WAAW,CAAC;gBAC9G,IAAIjB,OAAOW,gBAAgB,IAAI;oBAC7BX,OAAOO,SAAS;oBAChB,qCAAqC;oBACrCP,OAAOS,OAAO,CAACU,KAAK;gBACtB,OAAO;oBACL,MAAMvB,MAAM;gBACd,CAAC;YACH;YAEA,sEAAsE;YACtEI,OAAOQ,UAAU,GAAG,KAAK;QAC3B;QAEAY,wBAAwB,SAAUC,IAAI,EAAEC,WAAW,EAAE;YACnD,+DAA+D;YAC/DtB,OAAOO,SAAS;YAChB,+DAA+D;YAC/D,IAAI,CAACP,OAAOM,aAAa,CAACiB,QAAQ,CAACF,OAAO;YAC1C,yCAAyC;YACzC,IAAIA,SAAS,OAAOC,aAAa;YAEjC,2BAA2B;YAE3B,kCAAkC;YAClCtB,OAAOC,OAAO;YACd,qEAAqE;YACrE,IAAID,OAAOI,SAAS,KAAKoB,WAAW;gBAClCxB,OAAOI,SAAS,GAAGqB,WAAW,IAAM;oBAClCzB,OAAOC,OAAO,GAAG;oBACjBD,OAAOI,SAAS,GAAGoB;gBACrB,GAAGxB,OAAOG,QAAQ;YACpB,CAAC;QACH;IACF;IAEA,OAAOH;AACT,CAAC"}
|
package/dist/manager.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"manager.d.ts","sourceRoot":"","sources":["../src/manager.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"manager.d.ts","sourceRoot":"","sources":["../src/manager.ts"],"names":[],"mappings":"AAqEA,OAAO,KAAK,EAAE,wBAAwB,EAAE,WAAW,EAAsB,MAAM,YAAY,CAAA;AAK3F,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,WAAW,CA8qDhF"}
|