feat: Initial commit with working prototype

.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+lib

.eslintrc.js

@@ -0,0 +1,35 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier',
+    'prettier/@typescript-eslint',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    'max-len': ['warn', {
+      code: 100,
+      tabWidth: 2,
+      ignoreComments: false,
+      ignoreTrailingComments: true,
+      ignoreUrls: true,
+      ignoreStrings: true,
+      ignoreTemplateLiterals: true,
+      ignoreRegExpLiterals: true
+    }],
+    'comma-dangle': ['warn', 'always-multiline'],
+  },
+};

.gitignore

@@ -0,0 +1,38 @@
+# compiled output
+dist
+node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# VIM
+*.swp
+*.swo

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "printWidth": 100,
+  "singleQuote": true,
+  "trailingComma": "all"
+}

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "cSpell.words": [
+    "ratelimit"
+  ]
+}

LICENSE

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright 2019 Jay McDoniel, contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,24 @@
+# NestJS Throttler Redis Storage Package
+
+This package provides the Redis storage for the
+[nestjs-throttler](nestjs-throttler) package.
+
+# Usage
+
+```ts
+import { ThrottlerModule } from 'nestjs-throttler';
+import { ThrottlerStorageRedisService } from 'nestjs-throttler-storage-redis';
+
+@Module({
+  imports: [
+    ThrottlerModule.forRoot({
+      limit: 5,
+      ttl: 60,
+      storage: new ThrottlerStorageRedisService(),
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+[nestjs-throttler]: https://github.com/jmcdo29/nestjs-throttler

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = {extends: ['@commitlint/config-conventional']}

nest-cli.json

@@ -0,0 +1,4 @@
+{
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src"
+}

package.json

@@ -0,0 +1,83 @@
+{
+  "name": "nestjs-throttler-storage-redis",
+  "version": "0.0.1",
+  "description": "",
+  "author": "",
+  "private": false,
+  "license": "MIT",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start:dev": "nodemon --watch '{src,test/app}/**/*.ts' --ignore '**/*.spec.ts' --exec 'ts-node' test/app/main.ts",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "test:e2e:dev": "yarn test:e2e --watchAll"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@commitlint/cli": "^8.3.5",
+    "@commitlint/config-conventional": "^8.3.4",
+    "@nestjs/cli": "^7.0.0",
+    "@nestjs/platform-express": "^7.0.0",
+    "@nestjs/platform-fastify": "^7.1.1",
+    "@nestjs/schematics": "^7.0.0",
+    "@nestjs/testing": "^7.0.0",
+    "@types/express": "^4.17.3",
+    "@types/jest": "25.1.4",
+    "@types/node": "^13.9.1",
+    "@types/supertest": "^2.0.8",
+    "@typescript-eslint/eslint-plugin": "^2.23.0",
+    "@typescript-eslint/parser": "^2.23.0",
+    "eslint": "^6.8.0",
+    "eslint-config-prettier": "^6.10.0",
+    "eslint-plugin-import": "^2.20.1",
+    "husky": "^4.2.5",
+    "jest": "^25.1.0",
+    "nodemon": "^2.0.4",
+    "prettier": "^1.19.1",
+    "rimraf": "^3.0.2",
+    "rxjs": "^6.5.4",
+    "supertest": "^4.0.2",
+    "ts-jest": "25.2.1",
+    "ts-loader": "^6.2.1",
+    "ts-node": "^8.6.2",
+    "tsconfig-paths": "^3.9.0",
+    "typescript": "^3.7.4",
+    "@nestjs/common": "^7.0.0",
+    "@nestjs/core": "^7.0.0"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^7.0.0",
+    "@nestjs/core": "^7.0.0"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".spec.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "yarn format && yarn lint",
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  }
+}

src/index.ts

@@ -0,0 +1 @@
+export * from './throttler-storage-redis.service';

src/throttler-storage-redis.interface.ts

@@ -0,0 +1,21 @@
+import * as Redis from 'ioredis';
+
+export interface ThrottlerStorageRedis {
+  /**
+   * The redis instance.
+   */
+  storage: Redis.Redis;
+
+  /**
+   * Get a record via its key and return all its request ttls.
+   */
+  getRecord(key: string): Promise<number[]>;
+
+  /**
+   * Add a record to the storage. The record will automatically be removed from
+   * the storage once its TTL has been reached.
+   */
+  addRecord(key: string, ttl: number): Promise<void>;
+}
+
+export const ThrottlerStorageRedis = Symbol('ThrottlerStorageRedis');

src/throttler-storage-redis.service.ts

@@ -0,0 +1,22 @@
+import { Injectable } from '@nestjs/common';
+import * as Redis from 'ioredis';
+import { ThrottlerStorageRedis } from './throttler-storage-redis.interface';
+
+@Injectable()
+export class ThrottlerStorageRedisService implements ThrottlerStorageRedis {
+  storage: Redis.Redis;
+
+  constructor(options?: Redis.RedisOptions) {
+    this.storage = new Redis(options);
+  }
+
+  async getRecord(key: string): Promise<number[]> {
+    const ttls = (await this.storage.scan(0, 'MATCH', `${key}:*`)).pop();
+    return (ttls as string[]).map(k => parseInt(k.split(':').pop())).sort();
+  }
+
+  async addRecord(key: string, ttl: number): Promise<void> {
+    const ttlTime = Date.now() + ttl * 1000;
+    this.storage.set(`${key}:${ttlTime}`, ttlTime, 'EX', ttlTime);
+  }
+}

src/type.ts

@@ -0,0 +1,3 @@
+import { ThrottlerStorageRedis } from './throttler-storage-redis.interface';
+
+export type Type<T extends ThrottlerStorageRedis> = { new (...args: any[]): T };

test/app/app.controller.ts

@@ -0,0 +1,20 @@
+import { Controller, Get } from '@nestjs/common';
+import { SkipThrottle, Throttle } from 'nestjs-throttler';
+import { AppService } from './app.service';
+
+@Controller()
+@Throttle(2, 10)
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Get()
+  async test() {
+    return this.appService.success();
+  }
+
+  @Get('ignored')
+  @SkipThrottle()
+  async ignored() {
+    return this.appService.ignored();
+  }
+}

test/app/app.module.ts

@@ -0,0 +1,18 @@
+import { Module } from '@nestjs/common';
+import { ThrottlerModule } from 'nestjs-throttler';
+import { ThrottlerStorageRedisService } from '../../src';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+@Module({
+  imports: [
+    ThrottlerModule.forRoot({
+      limit: 5,
+      ttl: 60,
+      storage: new ThrottlerStorageRedisService(),
+    }),
+    AppController,
+  ],
+  providers: [AppService],
+})
+export class AppModule {}

test/app/app.service.ts

@@ -0,0 +1,12 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class AppService {
+  success() {
+    return { success: true };
+  }
+
+  ignored() {
+    return { ignored: true };
+  }
+}

test/app/main.ts

@@ -0,0 +1,9 @@
+import { NestFactory } from '@nestjs/core';
+import { ExpressAdapter } from '@nestjs/platform-express';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule, new ExpressAdapter());
+  await app.listen(3000);
+}
+bootstrap();

test/jest-e2e.json

@@ -0,0 +1,9 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "rootDir": "..",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  }
+}

tsconfig.build.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "outDir": "lib"
+  },
+  "extends": "./tsconfig.json",
+  "include": ["src"],
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+}

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "target": "es2017",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "incremental": true
+  },
+  "exclude": ["node_modules", "dist"]
+}