Skip to content
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,11 @@
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": "latest",
"project": "./tsconfig.json"
"project": "./tsconfig.eslint.json"
},
"plugins": [
"import", "prettier"
"import",
"prettier"
],
"rules": {
"no-plusplus": [
Expand All @@ -27,12 +28,26 @@
"allowForLoopAfterthoughts": true
}
],
"import/extensions": [
2,
"ignorePackages"
],
"prettier/prettier": [
"error"
]
},
"ignorePatterns": [
"jest.*",
"dist/*"
]
],
"settings": {
"import/resolver": {
"node": {
"extensions": [
".js",
".ts"
]
}
}
}
}
34 changes: 18 additions & 16 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,22 @@
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [

{
"type": "node",
"request": "launch",
"name": "Jest Tests",
"program": "${workspaceRoot}/node_modules/jest/bin/jest.js",
"args": [
"-i", "--verbose", "--no-cache"
],
// "preLaunchTask": "build",
// "internalConsoleOptions": "openOnSessionStart",
// "outFiles": [
// "${workspaceRoot}/dist/**/*"
// ],
// "envFile": "${workspaceRoot}/.env"
}]
{
"type": "node",
"request": "launch",
"name": "Jest Tests",
"program": "${workspaceRoot}/node_modules/jest/bin/jest.js",
"args": [
"-i",
"--verbose",
"--no-cache"
],
// "preLaunchTask": "build",
// "internalConsoleOptions": "openOnSessionStart",
// "outFiles": [
// "${workspaceRoot}/dist/**/*"
// ],
// "envFile": "${workspaceRoot}/.env"
}
]
}
32 changes: 19 additions & 13 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,26 @@
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
},
"eslint.workingDirectories": [
"./*"
],
"editor.formatOnSave": true,
"configurations": [{
"type": "node",
"request": "launch",
"name": "Jest Tests",
"program": "${workspaceRoot}\\node_modules\\jest\\bin\\jest.js",
"args": [
"configurations": [
{
"type": "node",
"request": "launch",
"name": "Jest Tests",
"program": "${workspaceRoot}\\node_modules\\jest\\bin\\jest.js",
"args": [
"-i"
],
// "preLaunchTask": "build",
"internalConsoleOptions": "openOnSessionStart",
"outFiles": [
],
// "preLaunchTask": "build",
"internalConsoleOptions": "openOnSessionStart",
"outFiles": [
"${workspaceRoot}/dist/**/*"
],
"envFile": "${workspaceRoot}/.env"
}]
],
"envFile": "${workspaceRoot}/.env"
}
],
"jest.jestCommandLine": "npm t --",
}
14 changes: 13 additions & 1 deletion jest.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,19 @@ const config: Config.InitialOptions = {
roots: ['./test'],
preset: 'ts-jest',
testEnvironment: 'node',
moduleFileExtensions: ['js', 'ts'],
// moduleFileExtensions: ['js', 'ts'],
transform: {
'\\.[jt]s?$': 'ts-jest',
},
globals: {
'ts-jest': {
useESM: true,
},
},
moduleNameMapper: {
'(.+)\\.js': '$1',
},
extensionsToTreatAsEsm: ['.ts'],
};

export default config;
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"name": "graphql-limiter",
"version": "1.3.0",
"description": "A GraphQL rate limiting library using query complexity analysis.",
"main": "./dist/src/index.js",
"types": "./dist/src/index.d.ts",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
"type": "module",
"scripts": {
"test": "jest --passWithNoTests --coverage --detectOpenHandles",
Expand Down Expand Up @@ -70,4 +70,4 @@
"graphql": "^16.5.0",
"ioredis": "^5.0.5"
}
}
}
2 changes: 1 addition & 1 deletion src/analysis/QueryParser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {
DirectiveNode,
SelectionNode,
} from 'graphql';
import { FieldWeight, TypeWeightObject, Variables } from '../@types/buildTypeWeights';
import { FieldWeight, TypeWeightObject, Variables } from '../@types/buildTypeWeights.js';
/**
* The AST node functions call each other following the nested structure below
* Each function handles a specific GraphQL AST node type
Expand Down
6 changes: 2 additions & 4 deletions src/analysis/buildTypeWeights.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import {
Type,
Fields,
FieldMap,
} from '../@types/buildTypeWeights';
} from '../@types/buildTypeWeights.js';

export const KEYWORDS = ['first', 'last', 'limit'];

Expand Down Expand Up @@ -409,7 +409,7 @@ function parseTypes(
* @param enforceBoundedLists Defaults to false
* @param typeWeightsConfig Defaults to {mutation: 10, object: 1, field: 0, connection: 2}
*/
function buildTypeWeightsFromSchema(
export default function buildTypeWeightsFromSchema(
schema: GraphQLSchema,
typeWeightsConfig: TypeWeightConfig = defaultTypeWeightsConfig,
enforceBoundedLists = false
Expand Down Expand Up @@ -437,5 +437,3 @@ function buildTypeWeightsFromSchema(
throw new Error(`Error in expressGraphQLRateLimiter when parsing schema object: ${err}`);
}
}

export default buildTypeWeightsFromSchema;
14 changes: 8 additions & 6 deletions src/middleware/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@ import EventEmitter from 'events';
import { parse, validate } from 'graphql';
import { GraphQLSchema } from 'graphql/type/schema';
import { Request, Response, NextFunction, RequestHandler } from 'express';
import buildTypeWeightsFromSchema, { defaultTypeWeightsConfig } from '../analysis/buildTypeWeights';
import setupRateLimiter from './rateLimiterSetup';
import { ExpressMiddlewareConfig, ExpressMiddlewareSet } from '../@types/expressMiddleware';
import { RateLimiterResponse } from '../@types/rateLimit';
import { connect } from '../utils/redis';
import QueryParser from '../analysis/QueryParser';
import buildTypeWeightsFromSchema, {
defaultTypeWeightsConfig,
} from '../analysis/buildTypeWeights.js';
import setupRateLimiter from './rateLimiterSetup.js';
import { ExpressMiddlewareConfig, ExpressMiddlewareSet } from '../@types/expressMiddleware.js';
import { RateLimiterResponse } from '../@types/rateLimit.js';
import { connect } from '../utils/redis.js';
import QueryParser from '../analysis/QueryParser.js';

/**
* Primary entry point for adding GraphQL Rate Limiting middleware to an Express Server
Expand Down
10 changes: 5 additions & 5 deletions src/middleware/rateLimiterSetup.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import Redis from 'ioredis';
import { RateLimiterConfig } from '../@types/rateLimit';
import TokenBucket from '../rateLimiters/tokenBucket';
import SlidingWindowCounter from '../rateLimiters/slidingWindowCounter';
import SlidingWindowLog from '../rateLimiters/slidingWindowLog';
import FixedWindow from '../rateLimiters/fixedWindow';
import { RateLimiterConfig } from '../@types/rateLimit.js';
import TokenBucket from '../rateLimiters/tokenBucket.js';
import SlidingWindowCounter from '../rateLimiters/slidingWindowCounter.js';
import SlidingWindowLog from '../rateLimiters/slidingWindowLog.js';
import FixedWindow from '../rateLimiters/fixedWindow.js';

/**
* Instatieate the rateLimiting algorithm class based on the developer selection and options
Expand Down
2 changes: 1 addition & 1 deletion src/rateLimiters/fixedWindow.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Redis from 'ioredis';
import { RateLimiter, RateLimiterResponse, FixedWindow as Window } from '../@types/rateLimit';
import { RateLimiter, RateLimiterResponse, FixedWindow as Window } from '../@types/rateLimit.js';

/**
* The FixedWindow instance of a RateLimiter limits requests based on a unique user ID and a fixed time window.
Expand Down
2 changes: 1 addition & 1 deletion src/rateLimiters/slidingWindowCounter.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Redis from 'ioredis';
import { RateLimiter, RateLimiterResponse, RedisWindow } from '../@types/rateLimit';
import { RateLimiter, RateLimiterResponse, RedisWindow } from '../@types/rateLimit.js';

/**
* The SlidingWindowCounter instance of a RateLimiter limits requests based on a unique user ID.
Expand Down
2 changes: 1 addition & 1 deletion src/rateLimiters/slidingWindowLog.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Redis from 'ioredis';
import { RateLimiter, RateLimiterResponse, RedisBucket, RedisLog } from '../@types/rateLimit';
import { RateLimiter, RateLimiterResponse, RedisLog } from '../@types/rateLimit.js';

/**
* The SlidingWindowLog instance of a RateLimiter limits requests based on a unique user ID.
Expand Down
2 changes: 1 addition & 1 deletion src/rateLimiters/tokenBucket.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Redis from 'ioredis';
import { RateLimiter, RateLimiterResponse, RedisBucket } from '../@types/rateLimit';
import { RateLimiter, RateLimiterResponse, RedisBucket } from '../@types/rateLimit.js';

/**
* The TokenBucket instance of a RateLimiter limits requests based on a unique user ID.
Expand Down
2 changes: 1 addition & 1 deletion test/analysis/buildTypeWeights.test.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import 'ts-jest';
import { buildSchema } from 'graphql';
import { GraphQLSchema } from 'graphql/type/schema';
import buildTypeWeightsFromSchema from '../../src/analysis/buildTypeWeights';
import buildTypeWeightsFromSchema from '../../src/analysis/buildTypeWeights.js';

// these types allow the tests to overwite properties on the typeWeightObject

Expand Down
4 changes: 2 additions & 2 deletions test/analysis/typeComplexityAnalysis.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { parse } from 'graphql';
import QueryParser from '../../src/analysis/QueryParser';
import { TypeWeightObject, Variables } from '../../src/@types/buildTypeWeights';
import QueryParser from '../../src/analysis/QueryParser.js';
import { TypeWeightObject, Variables } from '../../src/@types/buildTypeWeights.js';

/**
* Here is the schema that creates the following 'typeWeightsObject' used for the tests
Expand Down
6 changes: 3 additions & 3 deletions test/analysis/weightFunction.test.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import 'ts-jest';
import { buildSchema, DocumentNode, parse } from 'graphql';
import { TypeWeightObject } from '../../src/@types/buildTypeWeights';
import buildTypeWeightsFromSchema from '../../src/analysis/buildTypeWeights';
import QueryParser from '../../src/analysis/QueryParser';
import { TypeWeightObject } from '../../src/@types/buildTypeWeights.js';
import buildTypeWeightsFromSchema from '../../src/analysis/buildTypeWeights.js';
import QueryParser from '../../src/analysis/QueryParser.js';
// Test the weight function generated by the typeweights object when a limiting keyword is provided

// Test cases:
Expand Down
4 changes: 2 additions & 2 deletions test/middleware/express.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ import 'ts-jest';
import { Request, Response, NextFunction, RequestHandler } from 'express';
import { GraphQLSchema, buildSchema } from 'graphql';
import * as ioredis from 'ioredis';
import expressGraphQLRateLimiter from '../../src/middleware/index';
import expressGraphQLRateLimiter from '../../src/middleware/index.js';

import * as redis from '../../src/utils/redis';
import * as redis from '../../src/utils/redis.js';

const mockConnect = jest.spyOn(redis, 'connect');

Expand Down
4 changes: 2 additions & 2 deletions test/rateLimiters/fixedWindow.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as ioredis from 'ioredis';
import { FixedWindow as Window } from '../../src/@types/rateLimit';
import FixedWindow from '../../src/rateLimiters/fixedWindow';
import { FixedWindow as Window } from '../../src/@types/rateLimit.js';
import FixedWindow from '../../src/rateLimiters/fixedWindow.js';

// eslint-disable-next-line @typescript-eslint/no-var-requires
const RedisMock = require('ioredis-mock');
Expand Down
4 changes: 2 additions & 2 deletions test/rateLimiters/slidingWindowCounter.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as ioredis from 'ioredis';
import { RedisWindow } from '../../src/@types/rateLimit';
import SlidingWindowCounter from '../../src/rateLimiters/slidingWindowCounter';
import { RedisWindow } from '../../src/@types/rateLimit.js';
import SlidingWindowCounter from '../../src/rateLimiters/slidingWindowCounter.js';

// eslint-disable-next-line @typescript-eslint/no-var-requires
const RedisMock = require('ioredis-mock');
Expand Down
4 changes: 2 additions & 2 deletions test/rateLimiters/slidingWindowLog.test.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import 'ts-jest';
import * as ioredis from 'ioredis';
import { RateLimiterResponse, RedisLog } from '../../src/@types/rateLimit';
import SlidingWindowLog from '../../src/rateLimiters/slidingWindowLog';
import { RateLimiterResponse, RedisLog } from '../../src/@types/rateLimit.js';
import SlidingWindowLog from '../../src/rateLimiters/slidingWindowLog.js';

// eslint-disable-next-line @typescript-eslint/no-var-requires
const RedisMock = require('ioredis-mock');
Expand Down
4 changes: 2 additions & 2 deletions test/rateLimiters/tokenBucket.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as ioredis from 'ioredis';
import { RedisBucket } from '../../src/@types/rateLimit';
import TokenBucket from '../../src/rateLimiters/tokenBucket';
import { RedisBucket } from '../../src/@types/rateLimit.js';
import TokenBucket from '../../src/rateLimiters/tokenBucket.js';

// eslint-disable-next-line @typescript-eslint/no-var-requires
const RedisMock = require('ioredis-mock');
Expand Down
4 changes: 2 additions & 2 deletions tsconfig.eslint.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"extends": "tsconfig.json",
"extends": "./tsconfig.json",
"include": [
"test/*",
"test",
"src"
]
}
2 changes: 0 additions & 2 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@
"include": [
"src/**/*.ts",
"src/**/*.js",
"test/**/*.ts",
"test/**/*.js"
],
"exclude": [
"node_modules",
Expand Down