added some comments ofr easiser draft review

Author: evanmcneely

src/middleware/index.ts

@@ -39,6 +39,7 @@ export function expressRateLimiter(
     const redisClient = new Redis(redisClientOptions); // Default port is 6379 automatically
     const rateLimiter = setupRateLimiter(rateLimiterAlgo, rateLimiterOptions, redisClient);
 
+    // return the rate limiting middleware
     return async (req: Request, res: Response, next: NextFunction): Promise<void> => {
         const requestTimestamp = new Date().valueOf();
         const { query }: { query: string } = req.body;
@@ -57,11 +58,15 @@ export function expressRateLimiter(
          *
          * req.ip and req.ips will worx in express but not with other frameworks
          */
+        // check for a proxied ip address before using the ip address on request
         const ip: string = req.ips[0] || req.ip;
+
         // FIXME: this will only work with type complexity
         const queryComplexity = getQueryTypeComplexity(query, typeWeightObject);
 
         try {
+            // process the request and conditinoally respond to client with status code 429 o
+            // r pass the request onto the next middleware function
             const rateLimiterResponse = await rateLimiter.processRequest(
                 ip,
                 requestTimestamp,

src/middleware/rateLimiterSetup.ts

@@ -1,6 +1,15 @@
 import Redis from 'ioredis';
 import TokenBucket from '../rateLimiters/tokenBucket';
 
+/**
+ * Instatieate the rateLimiting algorithm class based on the developer selection and options
+ *
+ * @export
+ * @param {RateLimiterSelection} selection
+ * @param {RateLimiterOptions} options
+ * @param {Redis} client
+ * @return {*}
+ */
 export default function setupRateLimiter(
     selection: RateLimiterSelection,
     options: RateLimiterOptions,
@@ -24,6 +33,7 @@ export default function setupRateLimiter(
             throw new Error('Sliding Window Counter algonithm has not be implemented.');
             break;
         default:
+            // typescript should never let us invoke this function with anything other than the options above
             throw new Error('Selected rate limiting algorithm is not suppported');
             break;
     }