added timestamp to processRequest for RateLimiters and overahauled TokenBucket test suite to accomodate

Author: shalarewicz

src/@types/rateLimit.d.ts

@@ -2,13 +2,23 @@ interface RateLimiter {
     /**
      * Checks if a request is allowed under the given conditions and withdraws the specified number of tokens
      * @param uuid Unique identifier for the user associated with the request
+     * @param timestamp UNIX format timestamp of when request was received
      * @param tokens Number of tokens being used in this request. Optional
-     * @returns true if the request is allowed
+     * @returns a RateLimiterResponse indicating with a sucess and tokens property indicating the number of tokens remaining
      */
-    processRequest: (uuid: string, tokens?: number) => boolean;
+    processRequest: (
+        uuid: string,
+        timestamp: number,
+        tokens?: number | undefined
+    ) => RateLimiterResponse;
 }
 
-interface RedisToken {
+interface RateLimiterResponse {
+    success: boolean;
+    tokens?: number;
+}
+
+interface RedisBucket {
     tokens: number;
     timestamp: number;
 }

src/rateLimiters/tokenBucket.ts

@@ -25,24 +25,23 @@ class TokenBucket implements RateLimiter {
         this.capacity = capacity;
         this.refillRate = refillRate;
         this.client = client;
+        if (refillRate <= 0 || capacity <= 0)
+            throw Error('TokenBucket refillRate and capacity must be positive');
     }
 
-    processRequest(uuid: string, tokens = 1): boolean {
+    processRequest(
+        uuid: string,
+        timestamp: number,
+        tokens: number | undefined
+    ): RateLimiterResponse {
         throw Error(`TokenBucket.processRequest not implemented, ${this}`);
     }
 
-    /**
-     * @returns current size of the token bucket in redis store or CAPACITY if user is not present
-     */
-    getSize(uuid: string): number {
-        throw Error(`TokenBucket.connect not implemented, ${this}`);
-    }
-
     /**
      * Resets the rate limiter to the intial state by clearing the redis store.
      */
     reset(): void {
-        throw Error(`TokenBucket.connect not implemented, ${this}`);
+        throw Error(`TokenBucket.reset not implemented, ${this}`);
     }
 }