@discordeno/rest 19.0.0-next.f6bd769 → 19.0.0-next.f98bb9b

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.d.ts CHANGED
@@ -1,4 +1,7 @@
1
+ export * from './typings/routes.js';
1
2
  export * from './invalidBucket.js';
2
3
  export * from './manager.js';
3
4
  export * from './queue.js';
5
+ export * from './routes.js';
6
+ export * from './types.js';
4
7
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA"}
package/dist/index.js CHANGED
@@ -1,2 +1,8 @@
1
- export*from"./invalidBucket.js";export*from"./manager.js";export*from"./queue.js";
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9pbmRleC50cyJdLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tICcuL2ludmFsaWRCdWNrZXQuanMnXG5leHBvcnQgKiBmcm9tICcuL21hbmFnZXIuanMnXG5leHBvcnQgKiBmcm9tICcuL3F1ZXVlLmpzJ1xuIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLFdBQWMsb0JBQW9CLEFBQ2xDLFlBQWMsY0FBYyxBQUM1QixZQUFjLFlBQVkifQ==
1
+ export * from './typings/routes.js';
2
+ export * from './invalidBucket.js';
3
+ export * from './manager.js';
4
+ export * from './queue.js';
5
+ export * from './routes.js';
6
+ export * from './types.js';
7
+
8
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './typings/routes.js'\nexport * from './invalidBucket.js'\nexport * from './manager.js'\nexport * from './queue.js'\nexport * from './routes.js'\nexport * from './types.js'\n"],"names":[],"mappings":"AAAA,cAAc,sBAAqB;AACnC,cAAc,qBAAoB;AAClC,cAAc,eAAc;AAC5B,cAAc,aAAY;AAC1B,cAAc,cAAa;AAC3B,cAAc,aAAY"}
@@ -1,4 +1,3 @@
1
- /// <reference types="node" />
2
1
  /**
3
2
  * 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
3
  * It's purpose is to make sure the bot does not hit the limit to getting a 1 hr ban.
@@ -14,8 +13,8 @@ export interface InvalidRequestBucketOptions {
14
13
  max?: number;
15
14
  /** The time that discord allows to make the max number of invalid requests. Defaults to 10 minutes */
16
15
  interval?: number;
17
- /** timer to reset to 0 */
18
- timeoutId?: NodeJS.Timeout;
16
+ /** When the timeout for the bucket has started at. */
17
+ resetAt?: number;
19
18
  /** how safe to be from max. Defaults to 1 */
20
19
  safety?: number;
21
20
  /** The request statuses that count as an invalid request. */
@@ -25,19 +24,19 @@ export interface InvalidRequestBucketOptions {
25
24
  }
26
25
  export interface InvalidRequestBucket {
27
26
  /** current invalid amount */
28
- current: number;
27
+ invalidRequests: number;
29
28
  /** max invalid requests allowed until ban. Defaults to 10,000 */
30
29
  max: number;
31
30
  /** The time that discord allows to make the max number of invalid requests. Defaults to 10 minutes */
32
31
  interval: number;
33
- /** timer to reset to 0 */
34
- timeoutId: NodeJS.Timeout | undefined;
32
+ /** When the timeout for this bucket has started at. */
33
+ resetAt: number | undefined;
35
34
  /** how safe to be from max. Defaults to 1 */
36
35
  safety: number;
37
36
  /** The request statuses that count as an invalid request. */
38
37
  errorStatuses: number[];
39
38
  /** The amount of requests that were requested from this bucket. */
40
- requested: number;
39
+ activeRequests: number;
41
40
  /** The requests that are currently pending. */
42
41
  waiting: Array<(value: void | PromiseLike<void>) => void>;
43
42
  /** Whether or not the waiting queue is already processing. */
@@ -1 +1 @@
1
- {"version":3,"file":"invalidBucket.d.ts","sourceRoot":"","sources":["../src/invalidBucket.ts"],"names":[],"mappings":";AAEA;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,2BAA2B,GACnC,oBAAoB,CAkFtB;AAED,MAAM,WAAW,2BAA2B;IAC1C,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iEAAiE;IACjE,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,sGAAsG;IACtG,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC,OAAO,CAAA;IAC1B,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,6DAA6D;IAC7D,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,mEAAmE;IACnE,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,iEAAiE;IACjE,GAAG,EAAE,MAAM,CAAA;IACX,sGAAsG;IACtG,QAAQ,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAA;IACrC,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,6DAA6D;IAC7D,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,mEAAmE;IACnE,SAAS,EAAE,MAAM,CAAA;IACjB,+CAA+C;IAC/C,OAAO,EAAE,KAAK,CAAC,CAAC,KAAK,EAAE,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,CAAA;IACzD,8DAA8D;IAC9D,UAAU,EAAE,OAAO,CAAA;IAEnB,+DAA+D;IAC/D,eAAe,EAAE,MAAM,MAAM,CAAA;IAC7B,mDAAmD;IACnD,gBAAgB,EAAE,MAAM,OAAO,CAAA;IAC/B,yCAAyC;IACzC,yBAAyB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9C,uDAAuD;IACvD,cAAc,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACnC,iIAAiI;IACjI,sBAAsB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,KAAK,IAAI,CAAA;CACrE"}
1
+ {"version":3,"file":"invalidBucket.d.ts","sourceRoot":"","sources":["../src/invalidBucket.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,2BAA2B,GAAG,oBAAoB,CAmFrG;AAED,MAAM,WAAW,2BAA2B;IAC1C,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iEAAiE;IACjE,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,sGAAsG;IACtG,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,6DAA6D;IAC7D,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,mEAAmE;IACnE,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,6BAA6B;IAC7B,eAAe,EAAE,MAAM,CAAA;IACvB,iEAAiE;IACjE,GAAG,EAAE,MAAM,CAAA;IACX,sGAAsG;IACtG,QAAQ,EAAE,MAAM,CAAA;IAChB,uDAAuD;IACvD,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,6DAA6D;IAC7D,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,mEAAmE;IACnE,cAAc,EAAE,MAAM,CAAA;IACtB,+CAA+C;IAC/C,OAAO,EAAE,KAAK,CAAC,CAAC,KAAK,EAAE,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,CAAA;IACzD,8DAA8D;IAC9D,UAAU,EAAE,OAAO,CAAA;IAEnB,+DAA+D;IAC/D,eAAe,EAAE,MAAM,MAAM,CAAA;IAC7B,mDAAmD;IACnD,gBAAgB,EAAE,MAAM,OAAO,CAAA;IAC/B,yCAAyC;IACzC,yBAAyB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9C,uDAAuD;IACvD,cAAc,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACnC,iIAAiI;IACjI,sBAAsB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,KAAK,IAAI,CAAA;CACrE"}
@@ -1,2 +1,82 @@
1
- import{delay as e,logger as t}from"@discordeno/utils";export function createInvalidRequestBucket(i){let r={current:i.current??0,max:i.max??1e4,interval:i.interval??6e5,timeoutId:i.timeoutId,safety:i.safety??1,errorStatuses:i.errorStatuses??[401,403,429],requested:i.requested??0,processing:!1,waiting:[],requestsAllowed:function(){return r.max-r.current-r.requested-r.safety},isRequestAllowed:function(){return r.requestsAllowed()>0},waitUntilRequestAvailable:async function(){return await new Promise(async e=>{r.isRequestAllowed()?(r.requested++,e()):(r.waiting.push(e),await r.processWaiting())})},processWaiting:async function(){if(!r.processing){for(r.processing=!0;r.waiting.length>0;)t.info(`[InvalidBucket] processing waiting queue while loop ran with ${r.waiting.length} remaining.`),r.isRequestAllowed()?(r.requested++,r.waiting.shift()?.()):await e(1e3);r.processing=!1}},handleCompletedRequest:function(e,t){r.requested--,r.errorStatuses.includes(e)&&(429===e&&t||(r.current++,void 0===r.timeoutId&&(r.timeoutId=setTimeout(()=>{r.current=0,r.timeoutId=void 0},r.interval))))}};return r}
2
- //# sourceMappingURL=data:application/json;base64,{"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 (\n  options: InvalidRequestBucketOptions\n): 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,OAASA,SAAAA,CAAK,CAAEC,UAAAA,CAAM,KAAQ,mBAAmB,AASjD,QAAO,SAASC,2BACdC,CAAoC,CACd,CACtB,IAAMC,EAA+B,CACnCC,QAASF,EAAQE,OAAO,EAAI,EAC5BC,IAAKH,EAAQG,GAAG,EAAI,IACpBC,SAAUJ,EAAQI,QAAQ,EAAI,IAC9BC,UAAWL,EAAQK,SAAS,CAC5BC,OAAQN,EAAQM,MAAM,EAAI,EAC1BC,cAAeP,EAAQO,aAAa,EAAI,CAAC,IAAK,IAAK,IAAI,CACvDC,UAAWR,EAAQQ,SAAS,EAAI,EAChCC,WAAY,CAAA,EAEZC,QAAS,EAAE,CAEXC,gBAAiB,UAAY,CAC3B,OAAOV,EAAOE,GAAG,CAAGF,EAAOC,OAAO,CAAGD,EAAOO,SAAS,CAAGP,EAAOK,MAAM,AACvE,EAEAM,iBAAkB,UAAY,CAC5B,OAAOX,EAAOU,eAAe,GAAK,CACpC,EAEAE,0BAA2B,gBAAkB,CAE3C,OAAO,MAAM,IAAIC,QAAQ,MAAOC,GAAY,CAEtCd,EAAOW,gBAAgB,IACzBX,EAAOO,SAAS,GAChBO,MAEAd,EAAOS,OAAO,CAACM,IAAI,CAACD,GACpB,MAAMd,EAAOgB,cAAc,GAE/B,EACF,EAEAA,eAAgB,gBAAkB,CAEhC,IAAIhB,EAAOQ,UAAU,EAOrB,IAFAR,EAAOQ,UAAU,CAAG,CAAA,EAEbR,EAAOS,OAAO,CAACQ,MAAM,CAAG,GAC7BpB,EAAOqB,IAAI,CAAC,CAAC,6DAA6D,EAAElB,EAAOS,OAAO,CAACQ,MAAM,CAAC,WAAW,CAAC,EAC1GjB,EAAOW,gBAAgB,IACzBX,EAAOO,SAAS,GAEhBP,EAAOS,OAAO,CAACU,KAAK,QAEpB,MAAMvB,EAAM,IAKhBI,CAAAA,EAAOQ,UAAU,CAAG,CAAA,EAjBnB,AAkBH,EAEAY,uBAAwB,SAAUC,CAAI,CAAEC,CAAW,CAAE,CAEnDtB,EAAOO,SAAS,GAEXP,EAAOM,aAAa,CAACiB,QAAQ,CAACF,KAEtB,MAATA,GAAgBC,IAKpBtB,EAAOC,OAAO,GAEWuB,KAAAA,IAArBxB,EAAOI,SAAS,EAClBJ,CAAAA,EAAOI,SAAS,CAAGqB,WAAW,IAAM,CAClCzB,EAAOC,OAAO,CAAG,EACjBD,EAAOI,SAAS,CAAGoB,KAAAA,CACrB,EAAGxB,EAAOG,QAAQ,CAAA,GAEtB,CACF,EAEA,OAAOH,CACT,CAAC"}
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
+ invalidRequests: options.current ?? 0,
11
+ max: options.max ?? 10000,
12
+ interval: options.interval ?? 600_000,
13
+ resetAt: options.resetAt,
14
+ safety: options.safety ?? 1,
15
+ errorStatuses: options.errorStatuses ?? [
16
+ 401,
17
+ 403,
18
+ 429
19
+ ],
20
+ activeRequests: options.requested ?? 0,
21
+ processing: false,
22
+ waiting: [],
23
+ requestsAllowed: function() {
24
+ if (bucket.resetAt !== undefined && Date.now() >= bucket.resetAt) {
25
+ bucket.invalidRequests = 0;
26
+ bucket.resetAt = Date.now() + bucket.interval;
27
+ }
28
+ return bucket.max - bucket.invalidRequests - bucket.activeRequests - bucket.safety;
29
+ },
30
+ isRequestAllowed: function() {
31
+ return bucket.requestsAllowed() > 0;
32
+ },
33
+ waitUntilRequestAvailable: async function() {
34
+ // eslint-disable-next-line no-async-promise-executor
35
+ return await new Promise(async (resolve)=>{
36
+ // If whatever amount of requests is left is more than the safety margin, allow the request
37
+ if (bucket.isRequestAllowed()) {
38
+ bucket.activeRequests += 1;
39
+ resolve();
40
+ } else {
41
+ bucket.waiting.push(resolve);
42
+ await bucket.processWaiting();
43
+ }
44
+ });
45
+ },
46
+ processWaiting: async function() {
47
+ // If already processing, that loop will handle all waiting requests.
48
+ if (bucket.processing) return;
49
+ // Mark as processing so other loops don't start
50
+ bucket.processing = true;
51
+ while(bucket.waiting.length > 0){
52
+ logger.info(`[InvalidBucket] processing waiting queue while loop ran with ${bucket.waiting.length} pending requests to be made. ${JSON.stringify(bucket)}`);
53
+ if (!bucket.isRequestAllowed() && bucket.resetAt !== undefined) {
54
+ logger.warn(`[InvalidBucket] processing waiting queue is now paused until more requests are available. ${bucket.waiting.length} pending requests. ${JSON.stringify(bucket)}`);
55
+ await delay(bucket.resetAt - Date.now());
56
+ }
57
+ bucket.activeRequests += 1;
58
+ // Resolve the next item in the queue
59
+ bucket.waiting.shift()?.();
60
+ }
61
+ // Mark as false so next pending request can be triggered by new loop.
62
+ bucket.processing = false;
63
+ },
64
+ handleCompletedRequest: function(code, sharedScope) {
65
+ // Since request is complete, we can remove one from requested.
66
+ bucket.activeRequests -= 1;
67
+ // Since it is as a valid request, we don't need to do anything
68
+ if (!bucket.errorStatuses.includes(code)) return;
69
+ // Shared scope is not considered invalid
70
+ if (code === 429 && sharedScope) return;
71
+ // INVALID REQUEST WAS MADE
72
+ if (bucket.resetAt === undefined) {
73
+ bucket.resetAt = Date.now() + bucket.interval;
74
+ }
75
+ bucket.invalidRequests += 1;
76
+ logger.warn(`[InvalidBucket] an invalid request was made. Increasing invalidRequests count to ${bucket.invalidRequests}`);
77
+ }
78
+ };
79
+ return bucket;
80
+ }
81
+
82
+ //# 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 invalidRequests: options.current ?? 0,\n max: options.max ?? 10000,\n interval: options.interval ?? 600_000, // 10 minutes\n resetAt: options.resetAt,\n safety: options.safety ?? 1,\n errorStatuses: options.errorStatuses ?? [401, 403, 429],\n activeRequests: options.requested ?? 0,\n processing: false,\n\n waiting: [],\n\n requestsAllowed: function () {\n if (bucket.resetAt !== undefined && Date.now() >= bucket.resetAt) {\n bucket.invalidRequests = 0\n bucket.resetAt = Date.now() + bucket.interval\n }\n\n return bucket.max - bucket.invalidRequests - bucket.activeRequests - 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.activeRequests += 1\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) return\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} pending requests to be made. ${JSON.stringify(bucket)}`)\n\n if (!bucket.isRequestAllowed() && bucket.resetAt !== undefined) {\n logger.warn(`[InvalidBucket] processing waiting queue is now paused until more requests are available. ${bucket.waiting.length} pending requests. ${JSON.stringify(bucket)}`)\n await delay(bucket.resetAt - Date.now())\n }\n\n bucket.activeRequests += 1\n // Resolve the next item in the queue\n bucket.waiting.shift()?.()\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.activeRequests -= 1\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 if (bucket.resetAt === undefined) {\n bucket.resetAt = Date.now() + bucket.interval\n }\n\n bucket.invalidRequests += 1\n logger.warn(`[InvalidBucket] an invalid request was made. Increasing invalidRequests count to ${bucket.invalidRequests}`)\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 /** When the timeout for the bucket has started at. */\n resetAt?: number\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 invalidRequests: 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 /** When the timeout for this bucket has started at. */\n resetAt: number | 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 activeRequests: 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","invalidRequests","current","max","interval","resetAt","safety","errorStatuses","activeRequests","requested","processing","waiting","requestsAllowed","undefined","Date","now","isRequestAllowed","waitUntilRequestAvailable","Promise","resolve","push","processWaiting","length","info","JSON","stringify","warn","shift","handleCompletedRequest","code","sharedScope","includes"],"mappings":"AAAA,SAASA,KAAK,EAAEC,MAAM,QAAQ,oBAAmB;AAEjD;;;;;;CAMC,GACD,OAAO,SAASC,2BAA2BC,OAAoC,EAAwB;IACrG,MAAMC,SAA+B;QACnCC,iBAAiBF,QAAQG,OAAO,IAAI;QACpCC,KAAKJ,QAAQI,GAAG,IAAI;QACpBC,UAAUL,QAAQK,QAAQ,IAAI;QAC9BC,SAASN,QAAQM,OAAO;QACxBC,QAAQP,QAAQO,MAAM,IAAI;QAC1BC,eAAeR,QAAQQ,aAAa,IAAI;YAAC;YAAK;YAAK;SAAI;QACvDC,gBAAgBT,QAAQU,SAAS,IAAI;QACrCC,YAAY,KAAK;QAEjBC,SAAS,EAAE;QAEXC,iBAAiB,WAAY;YAC3B,IAAIZ,OAAOK,OAAO,KAAKQ,aAAaC,KAAKC,GAAG,MAAMf,OAAOK,OAAO,EAAE;gBAChEL,OAAOC,eAAe,GAAG;gBACzBD,OAAOK,OAAO,GAAGS,KAAKC,GAAG,KAAKf,OAAOI,QAAQ;YAC/C,CAAC;YAED,OAAOJ,OAAOG,GAAG,GAAGH,OAAOC,eAAe,GAAGD,OAAOQ,cAAc,GAAGR,OAAOM,MAAM;QACpF;QAEAU,kBAAkB,WAAY;YAC5B,OAAOhB,OAAOY,eAAe,KAAK;QACpC;QAEAK,2BAA2B,iBAAkB;YAC3C,qDAAqD;YACrD,OAAO,MAAM,IAAIC,QAAQ,OAAOC,UAAY;gBAC1C,2FAA2F;gBAC3F,IAAInB,OAAOgB,gBAAgB,IAAI;oBAC7BhB,OAAOQ,cAAc,IAAI;oBACzBW;gBACF,OAAO;oBACLnB,OAAOW,OAAO,CAACS,IAAI,CAACD;oBACpB,MAAMnB,OAAOqB,cAAc;gBAC7B,CAAC;YACH;QACF;QAEAA,gBAAgB,iBAAkB;YAChC,qEAAqE;YACrE,IAAIrB,OAAOU,UAAU,EAAE;YAEvB,gDAAgD;YAChDV,OAAOU,UAAU,GAAG,IAAI;YAExB,MAAOV,OAAOW,OAAO,CAACW,MAAM,GAAG,EAAG;gBAChCzB,OAAO0B,IAAI,CAAC,CAAC,6DAA6D,EAAEvB,OAAOW,OAAO,CAACW,MAAM,CAAC,8BAA8B,EAAEE,KAAKC,SAAS,CAACzB,QAAQ,CAAC;gBAE1J,IAAI,CAACA,OAAOgB,gBAAgB,MAAMhB,OAAOK,OAAO,KAAKQ,WAAW;oBAC9DhB,OAAO6B,IAAI,CAAC,CAAC,0FAA0F,EAAE1B,OAAOW,OAAO,CAACW,MAAM,CAAC,mBAAmB,EAAEE,KAAKC,SAAS,CAACzB,QAAQ,CAAC;oBAC5K,MAAMJ,MAAMI,OAAOK,OAAO,GAAGS,KAAKC,GAAG;gBACvC,CAAC;gBAEDf,OAAOQ,cAAc,IAAI;gBACzB,qCAAqC;gBACrCR,OAAOW,OAAO,CAACgB,KAAK;YACtB;YAEA,sEAAsE;YACtE3B,OAAOU,UAAU,GAAG,KAAK;QAC3B;QAEAkB,wBAAwB,SAAUC,IAAI,EAAEC,WAAW,EAAE;YACnD,+DAA+D;YAC/D9B,OAAOQ,cAAc,IAAI;YACzB,+DAA+D;YAC/D,IAAI,CAACR,OAAOO,aAAa,CAACwB,QAAQ,CAACF,OAAO;YAC1C,yCAAyC;YACzC,IAAIA,SAAS,OAAOC,aAAa;YAEjC,2BAA2B;YAC3B,IAAI9B,OAAOK,OAAO,KAAKQ,WAAW;gBAChCb,OAAOK,OAAO,GAAGS,KAAKC,GAAG,KAAKf,OAAOI,QAAQ;YAC/C,CAAC;YAEDJ,OAAOC,eAAe,IAAI;YAC1BJ,OAAO6B,IAAI,CAAC,CAAC,iFAAiF,EAAE1B,OAAOC,eAAe,CAAC,CAAC;QAC1H;IACF;IAEA,OAAOD;AACT,CAAC"}