Merge pull request #24 from oslabs-beta/sh/middleware-framework

Initial tests for middleware functionality.

Author: shalarewicz

.eslintrc.json

@@ -19,10 +19,12 @@
     },
     "plugins": ["import", "prettier"],
     "rules": {
-        
+        "no-plusplus": [2, {
+            "allowForLoopAfterthoughts": true
+        }],
         "prettier/prettier": [
             "error"
         ]
     }, 
-    "ignorePatterns": ["jest.config.js"]
+    "ignorePatterns": ["jest.config.ts"]
 }

jest.config.js

@@ -0,0 +1,11 @@
+import type { Config } from '@jest/types';
+
+const config: Config.InitialOptions = {
+    verbose: true,
+    roots: ['./test'],
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    moduleFileExtensions: ['js', 'ts'],
+};
+
+export default config;

jest.config.ts

@@ -3,10 +3,11 @@
     "version": "1.0.0",
     "description": "A GraphQL rate limiting library using query complexity analysis.",
     "main": "index.js",
+    "type": "module",
     "scripts": {
         "test": "jest --passWithNoTests",
         "lint": "eslint src test",
-        "lint:fix": "eslint --fix src test",
+        "lint:fix": "eslint --fix src test @types",
         "prettier": "prettier --write .",
         "prepare": "husky install"
     },
@@ -43,6 +44,7 @@
         "prettier": "2.6.2",
         "redis-mock": "^0.56.3",
         "ts-jest": "^28.0.2",
+        "ts-node": "^10.8.0",
         "typescript": "^4.6.4"
     },
     "lint-staged": {

package-lock.json

@@ -40,4 +40,6 @@ interface TokenBucketOptions {
 }
 
 // TODO: This will be a union type where we can specify Option types for other Rate Limiters
-type RateLimiterOptions = TokenBucketOptions;
+// Record<string, never> represents the empty object for alogorithms that don't require settings
+// and might be able to be removed in the future.
+type RateLimiterOptions = TokenBucketOptions | Record<string, never>;

package.json

@@ -17,7 +17,8 @@ import { defaultTypeWeightsConfig } from '../analysis/buildTypeWeights';
  * Defaults to {mutation: 10, object: 1, field: 0, connection: 2}
  * @returns {RequestHandler} express middleware that computes the complexity of req.query and calls the next middleware
  * if the query is allowed or sends a 429 status if the request is blocked
- * @throws ValidationError if GraphQL Schema is invalid
+ * FIXME: How about the specific GraphQLError?
+ * @throws ValidationError if GraphQL Schema is invalid.
  */
 export function expressRateLimiter(
     rateLimiter: RateLimiterSelection,
@@ -31,7 +32,6 @@ export function expressRateLimiter(
     // TODO: Connect to Redis store using provided options. Default to localhost:6379
     // TODO: Configure the selected RateLimtier
     // TODO: Configure the complexity analysis algorithm to run for incoming requests
-
     const middleware: RequestHandler = (req: Request, res: Response, next: NextFunction) => {
         // TODO: Parse query from req.query, compute complexity and pass necessary info to rate limiter
         // TODO: Call next if query is successful, send 429 status if query blocked, call next(err) with any thrown errors