exported types for succesful typescript build.

Author: shalarewicz

.eslintrc.json

@@ -26,5 +26,5 @@
             "error"
         ]
     }, 
-    "ignorePatterns": ["jest.*"]
+    "ignorePatterns": ["jest.*", "build/*"]
 }

.gitignore

@@ -102,3 +102,5 @@ dist
 
 # TernJS port file
 .tern-port
+
+build/*

src/@types/buildTypeWeights.d.ts

@@ -1,19 +1,16 @@
-interface Fields {
+export interface Fields {
     [index: string]: FieldWeight;
 }
-type WeightFunction = (args: ArgumentNode[]) => number;
-type FieldWeight = number | WeightFunction;
-
-interface Type {
+export type WeightFunction = (args: ArgumentNode[]) => number;
+export type FieldWeight = number | WeightFunction;
+export interface Type {
     readonly weight: number;
     readonly fields: Fields;
 }
-
-interface TypeWeightObject {
+export interface TypeWeightObject {
     [index: string]: Type;
 }
-
-interface TypeWeightConfig {
+export interface TypeWeightConfig {
     mutation?: number;
     query?: number;
     object?: number;

src/@types/rateLimit.d.ts

@@ -1,4 +1,4 @@
-interface RateLimiter {
+export 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
@@ -13,17 +13,17 @@ interface RateLimiter {
     ) => Promise<RateLimiterResponse>;
 }
 
-interface RateLimiterResponse {
+export interface RateLimiterResponse {
     success: boolean;
     tokens: number;
 }
 
-interface RedisBucket {
+export interface RedisBucket {
     tokens: number;
     timestamp: number;
 }
 
-type RateLimiterSelection =
+export type RateLimiterSelection =
     | 'TOKEN_BUCKET'
     | 'LEAKY_BUCKET'
     | 'FIXED_WINDOW'
@@ -34,12 +34,12 @@ type RateLimiterSelection =
  * @type {number} bucketSize - Size of the token bucket
  * @type {number} refillRate - Rate at which tokens are added to the bucket in seconds
  */
-interface TokenBucketOptions {
+export interface TokenBucketOptions {
     bucketSize: number;
     refillRate: number;
 }
 
 // TODO: This will be a union type where we can specify Option types for other Rate Limiters
 // 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>;
+export type RateLimiterOptions = TokenBucketOptions | Record<string, never>;

src/analysis/ASTnodefunctions.ts

@@ -8,6 +8,7 @@ import {
     SelectionNode,
     ArgumentNode,
 } from 'graphql';
+import { FieldWeight, TypeWeightObject } from '../@types/buildTypeWeights';
 
 // TODO: handle variables and arguments
 // ! this is not functional

src/analysis/buildTypeWeights.ts

@@ -19,6 +19,7 @@ import {
 import { Maybe } from 'graphql/jsutils/Maybe';
 import { ObjMap } from 'graphql/jsutils/ObjMap';
 import { GraphQLSchema } from 'graphql/type/schema';
+import { TypeWeightConfig, TypeWeightObject } from '../@types/buildTypeWeights';
 
 export const KEYWORDS = ['first', 'last', 'limit'];
 
@@ -81,6 +82,7 @@ function parseQuery(
         queryFields[field].args.forEach((arg: GraphQLArgument) => {
             // If query has an argument matching one of the limiting keywords and resolves to a list then the weight of the query
             // should be dependent on both the weight of the resolved type and the limiting argument.
+            // FIXME: Can nonnull wrap list types?
             if (KEYWORDS.includes(arg.name) && isListType(resolveType)) {
                 // Get the type that comprises the list
                 const listType = resolveType.ofType;
@@ -125,7 +127,7 @@ function parseQuery(
             }
         });
 
-        // if the field is a scalar or an enum set weight accordingly
+        // if the field is a scalar or an enum set weight accordingly. It is not a list in this case
         if (isScalarType(resolveType) || isEnumType(resolveType)) {
             result.query.fields[field] = typeWeights.scalar || DEFAULT_SCALAR_WEIGHT;
         }
@@ -152,7 +154,7 @@ function parseTypes(
 
     // Handle Object, Interface, Enum and Union types
     Object.keys(typeMap).forEach((type) => {
-        const typeName = type.toLowerCase();
+        const typeName: string = type.toLowerCase();
 
         const currentType: GraphQLNamedType = typeMap[type];
         // Get all types that aren't Query or Mutation or a built in type that starts with '__'
@@ -219,7 +221,7 @@ function buildTypeWeightsFromSchema(
         ...typeWeightsConfig,
     };
 
-    // Confirm that any custom weights are positive
+    // Confirm that any custom weights are non-negative
     Object.entries(typeWeights).forEach((value: [string, number]) => {
         if (value[1] < 0) {
             throw new Error(`Type weights cannot be negative. Received: ${value[0]}: ${value[1]} `);

src/analysis/typeComplexityAnalysis.ts

@@ -1,4 +1,5 @@
 import { DocumentNode } from 'graphql';
+import { TypeWeightObject } from '../@types/buildTypeWeights';
 import { documentNode } from './ASTnodefunctions';
 
 /**

src/middleware/index.ts

@@ -6,6 +6,8 @@ import { Request, Response, NextFunction, RequestHandler } from 'express';
 import buildTypeWeightsFromSchema, { defaultTypeWeightsConfig } from '../analysis/buildTypeWeights';
 import setupRateLimiter from './rateLimiterSetup';
 import getQueryTypeComplexity from '../analysis/typeComplexityAnalysis';
+import { RateLimiterOptions, RateLimiterSelection } from '../@types/rateLimit';
+import { TypeWeightConfig } from '../@types/buildTypeWeights';
 
 // FIXME: Will the developer be responsible for first parsing the schema from a file?
 // Can consider accepting a string representing a the filepath to a schema
@@ -50,7 +52,6 @@ export function expressRateLimiter(
             console.log('There is no query on the request');
             return next();
         }
-
         /**
          * There are numorous ways to get the ip address off of the request object.
          * - the header 'x-forward-for' will hold the originating ip address if a proxy is placed infront of the server. This would be commen for a production build.
@@ -68,10 +69,12 @@ export function expressRateLimiter(
         // validate the query against the schema. The GraphQL validation function returns an array of errors.
         const validationErrors = validate(schema, queryAST);
         // check if the length of the returned GraphQL Errors array is greater than zero. If it is, there were errors. Call next so that the GraphQL server can handle those.
-        if (validationErrors.length > 0) return next();
+        if (validationErrors.length > 0) {
+            // FIXME: Customize this error to throw the GraphQLError
+            return next(Error('invalid query'));
+        }
 
         const queryComplexity = getQueryTypeComplexity(queryAST, variables, typeWeightObject);
-
         try {
             // process the request and conditinoally respond to client with status code 429 o
             // r pass the request onto the next middleware function
@@ -83,14 +86,15 @@ export function expressRateLimiter(
             if (rateLimiterResponse.success === false) {
                 // TODO: add a header 'Retry-After' with the time to wait untill next query will succeed
                 // FIXME: send information about query complexity, tokens, etc, to the client on rejected query
-                res.status(429).send();
+                res.status(429).json({ graphqlGate: rateLimiterResponse });
+            } else {
+                res.locals.graphqlGate = {
+                    timestamp: requestTimestamp,
+                    complexity: queryComplexity,
+                    tokens: rateLimiterResponse.tokens,
+                };
+                return next();
             }
-            res.locals.graphqlGate = {
-                timestamp: requestTimestamp,
-                complexity: queryComplexity,
-                tokens: rateLimiterResponse.tokens,
-            };
-            return next();
         } catch (err) {
             return next(err);
         }

src/middleware/rateLimiterSetup.ts

@@ -1,4 +1,5 @@
 import Redis from 'ioredis';
+import { RateLimiterOptions, RateLimiterSelection } from '../@types/rateLimit';
 import TokenBucket from '../rateLimiters/tokenBucket';
 
 /**

src/rateLimiters/tokenBucket.ts

@@ -1,4 +1,5 @@
 import Redis from 'ioredis';
+import { RateLimiter, RateLimiterResponse, RedisBucket } from '../@types/rateLimit';
 
 /**
  * The TokenBucket instance of a RateLimiter limits requests based on a unique user ID.
@@ -98,7 +99,7 @@ class TokenBucket implements RateLimiter {
         timestamp: number
     ): number => {
         const timeSinceLastQueryInSeconds: number = Math.floor(
-            (timestamp - bucket.timestamp) / 1000 // 1000 ms in a second
+            (timestamp - bucket.timestamp) / 1000 // 1000 ms in a second FIXME: magic number if specifying custom timeframe
         );
         const tokensToAdd = timeSinceLastQueryInSeconds * this.refillRate;
         const updatedTokenCount = bucket.tokens + tokensToAdd;