Ratelimits

.vscode/extensions.json

@@ -7,4 +7,4 @@
     "aaron-bond.better-comments",
     "vitest.explorer"
   ]
-}
+}

README.md

@@ -5,7 +5,7 @@
 
 # Todo List for Reborn-ts
 
-- [ ] Add Ratelimiting back
+- [x] Add Ratelimiting back
 - [ ] Allow for queue mode. For when key is limited
 - [ ] Change how raw option works
 - [ ] Rewrtie SkyblockUtils

src/Client.ts

@@ -1,5 +1,6 @@
 import CacheHandler from './Private/CacheHandler';
 import { ClientOptions } from './typings/Client';
+import RateLimit from './Private/RateLimit';
 import Requests from './Private/Requests';
 import Updater from './Private/Updater';
 import Errors from './Errors';
@@ -13,20 +14,23 @@ class Client {
   declare cacheHandler: CacheHandler;
   declare updater: Updater;
   declare errors: Errors;
+  declare rateLimit: RateLimit;
 
   readonly key: string;
 
   declare interval: NodeJS.Timeout;
 
   constructor(key: string, options?: ClientOptions) {
+    this.key = key;
+    if (!this.key.length) throw new Error(this.errors.NO_API_KEY);
+
     this.options = this.parasOptions(options);
     this.requests = new Requests(this);
     this.cacheHandler = new CacheHandler(this);
     this.updater = new Updater(this);
     this.errors = new Errors();
-
-    this.key = key;
-    if (!this.key.length) throw new Error(this.errors.NO_API_KEY);
+    this.rateLimit = new RateLimit(this);
+    if ('NONE' !== this.options.rateLimit) this.rateLimit.initialize();
 
     for (const func in API) {
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -41,7 +45,12 @@ class Client {
       // eslint-disable-next-line no-console
       console.warn(this.errors.MULTIPLE_INSTANCES);
       const found = clients.find((x) => x.key === key);
-      if (found) return found;
+      if (found) {
+        this.destroy();
+        Object.assign(this, found);
+        return;
+      }
+      return;
     }
 
     if (this.options.checkForUpdates) {
@@ -60,6 +69,7 @@ class Client {
     const clientIndex = clients.findIndex((client) => client.key === this.key);
     if (-1 !== clientIndex) clients.splice(clientIndex, 1);
     if (this.interval) clearInterval(this.interval);
+    if (this.rateLimit.interval) clearInterval(this.rateLimit.interval);
   }
 
   private parasOptions(options?: ClientOptions): ClientOptions {

src/Errors.ts

@@ -34,6 +34,8 @@ class Errors {
   NO_SKYBLOCK_PROFILES: string = '[Hypixel-API-Reborn] The player has no skyblock profiles.';
   BAD_AUCTION_FILTER: string =
     '[Hypixel-API-Reborn] Unexpected filter for Client#getSkyblockAuction. Expected one of "PLAYER", "AUCTION", "PROFILE", but got something else.';
+  RATE_LIMIT_INIT_ERROR: string =
+    '[hypixel-api-reborn] An error happened whilst initializing rate limit. We strongly recommend restarting the code as this can lead to desynchronization.';
 }
 
 export default Errors;

src/Private/RateLimit.ts

@@ -0,0 +1,45 @@
+import Client from '../Client';
+
+class RateLimit {
+  readonly client: Client;
+  declare requests: number;
+  declare limit: number;
+  declare initialized: boolean;
+  declare interval: NodeJS.Timeout;
+  constructor(client: Client) {
+    this.client = client;
+
+    this.requests = 0;
+    this.limit = 0;
+    this.initialized = false;
+
+    this.interval = setInterval(() => this.reset(), 300000);
+  }
+
+  async sync() {
+    const { _headers: headers } = await this.client.requests.request('/boosters', { raw: true });
+    if (
+      headers?.['ratelimit-limit'] === undefined ||
+      headers?.['ratelimit-remaining'] === undefined ||
+      headers?.['ratelimit-reset'] === undefined
+    ) {
+      throw new Error(this.client.errors.RATE_LIMIT_INIT_ERROR);
+    }
+    this.requests = headers['ratelimit-limit'] - headers['ratelimit-remaining'];
+    this.limit = Number(headers['ratelimit-limit']);
+  }
+
+  reset() {
+    if (false === this.initialized) return;
+    this.requests = 0;
+  }
+
+  async initialize() {
+    if (this.initialized) return;
+    if ('AUTO' !== this.client.options.rateLimit) return;
+    await this.sync();
+    this.initialized = true;
+  }
+}
+
+export default RateLimit;

src/Private/Requests.ts

@@ -46,6 +46,7 @@ class Requests {
     if (!parsedRes.success && !endpoint.startsWith('/housing')) {
       throw new Error(this.client.errors.SOMETHING_WENT_WRONG.replace(/{cause}/, res.statusText));
     }
+    this.client.rateLimit.requests++;
 
     // eslint-disable-next-line no-underscore-dangle
     parsedRes._headers = res.headers;

tsconfig.json

@@ -10,8 +10,5 @@
     "target": "ES2022",
     "strict": true
   },
-  "include": [
-    "src",
-    "API"
-  ],
-}
+  "include": ["src", "API"]
+}