feat: prepare initial 0.1 version && add tests

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at koomen@protonmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributions
+
+Any and all contributions are welcome as long as they meet the contribution
+requirements.
+
+## How to Contribute
+
+1. Create a fork of the repository
+2. Clone the code to your local machine
+3. Create a new branch with the feature you are working on or with the issue number (e.g. issue/42)
+4. Run `yarn`
+5. Implement your changes, ensure tests are still passing, or add tests if it is a new feature
+6. Push back to your version on GitHub
+7. Raise a Pull Request to the main repository
+
+## Development
+
+All the source code is in `src` as expected. Most of the code should be rather
+self documented.
+
+## Testing
+
+To run a basic dev server you can use `start:dev` to run `nodemon` and
+`ts-node`. All tests should be running through `jest` using `test:e2e`
+otherwise.
+
+If you need to run tests for a specific context, use `yarn test:e2e <type>` e.g.
+`yarn test:e2e controller` will run the e2e tests for the HTTP guard.
+
+## Commits
+
+We are using [Conventional Commit](commitlint) to help keep
+commit messages aligned as development continues. The easiest way to get
+acquainted with what the commit should look like is to run `yarn commit` which
+will use the `git-cz` cli and walk you through the steps of committing. Once
+you've made your commit, prettier and eslint will run and ensure that the new
+code is up to the standards we have in place.
+
+## Issues
+
+Please raise an issue, or discuss with me at [Discord](https://discordapp.com) (kkoomen#3343) before opening a Pull Request so we can see if they align with the goals of the project.
+
+[commitlint]: https://github.com/conventional-changelog/commitlint

README.md

@@ -1,7 +1,6 @@
-# NestJS Throttler Redis Storage Package
+# NestJS Throttler Redis Storage
 
-This package provides the Redis storage for the
-[nestjs-throttler](nestjs-throttler) package.
+Redis storage provider for the [nestjs-throttler](nestjs-throttler) package.
 
 # Usage
 
@@ -21,4 +20,16 @@ import { ThrottlerStorageRedisService } from 'nestjs-throttler-storage-redis';
 export class AppModule {}
 ```
 
+# Issues
+
+Bugs and features related to the redis implementation are welcome in this
+repository.
+
+For any issues related to the nestjs-throttler, please submit an issue at the
+[nestjs-throttler](nestjs-throttler) repository.
+
+# License
+
+NestJS Throttler Redis Storage is licensed under the MIT license.
+
 [nestjs-throttler]: https://github.com/jmcdo29/nestjs-throttler

package.json

@@ -1,64 +1,86 @@
 {
   "name": "nestjs-throttler-storage-redis",
-  "version": "0.0.1",
-  "description": "",
+  "version": "0.1.0",
+  "description": "Redis storage provider for the nestjs-throttler package",
   "author": "",
+  "keywords": [
+    "nestjs",
+    "rate-limit",
+    "throttle",
+    "express",
+    "fastify",
+    "redis"
+  ],
   "private": false,
   "license": "MIT",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
-    "lib"
+    "dist"
   ],
   "scripts": {
     "prebuild": "rimraf dist",
+    "preversion": "yarn run format && yarn run lint && yarn build",
     "build": "nest build",
+    "commit": "git-cz",
     "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",
+    "lint": "eslint \"{src,apps,dist,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"
+    "test:e2e:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --config test/jest-e2e.json --runInBand",
+    "test:e2e:dev": "yarn test:e2e --watchAll",
+    "version": "conventional-changelog -p angular -i CHANGELOG.md -s && git add CHANGELOG.md"
   },
   "dependencies": {},
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^8.3.4",
     "@nestjs/cli": "^7.0.0",
+    "@nestjs/common": "^7.0.0",
+    "@nestjs/core": "^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/ioredis": "^4.16.4",
     "@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",
+    "conventional-changelog-cli": "^2.0.31",
+    "cz-conventional-changelog": "^3.1.0",
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.10.0",
     "eslint-plugin-import": "^2.20.1",
     "husky": "^4.2.5",
+    "ioredis": "^4.17.3",
     "jest": "^25.1.0",
+    "lint-staged": "^10.2.9",
+    "nestjs-throttler": "^0.1.1",
     "nodemon": "^2.0.4",
     "prettier": "^1.19.1",
+    "reflect-metadata": "^0.1.13",
     "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"
+    "typescript": "^3.7.4"
   },
   "peerDependencies": {
     "@nestjs/common": "^7.0.0",
-    "@nestjs/core": "^7.0.0"
+    "@nestjs/core": "^7.0.0",
+    "ioredis": "^4.17.3",
+    "nestjs-throttler": "^0.1.1",
+    "reflect-metadata": "^0.1.13"
   },
   "jest": {
     "moduleFileExtensions": [
@@ -76,8 +98,22 @@
   },
   "husky": {
     "hooks": {
-      "pre-commit": "yarn format && yarn lint",
+      "pre-commit": "lint-staged",
       "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
     }
+  },
+  "lint-staged": {
+    "*.ts": [
+      "prettier --write",
+      "eslint --ext ts"
+    ],
+    "*.{md,html,json,js}": [
+      "prettier --write"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
   }
 }

src/throttler-storage-redis.interface.ts

@@ -4,7 +4,7 @@ export interface ThrottlerStorageRedis {
   /**
    * The redis instance.
    */
-  storage: Redis.Redis;
+  redis: Redis.Redis;
 
   /**
    * Get a record via its key and return all its request ttls.

src/throttler-storage-redis.service.ts

@@ -4,19 +4,19 @@ import { ThrottlerStorageRedis } from './throttler-storage-redis.interface';
 
 @Injectable()
 export class ThrottlerStorageRedisService implements ThrottlerStorageRedis {
-  storage: Redis.Redis;
+  redis: Redis.Redis;
 
   constructor(options?: Redis.RedisOptions) {
-    this.storage = new Redis(options);
+    this.redis = new Redis(options);
   }
 
   async getRecord(key: string): Promise<number[]> {
-    const ttls = (await this.storage.scan(0, 'MATCH', `${key}:*`)).pop();
+    const ttls = (await this.redis.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);
+    this.redis.set(`${key}:${ttlTime}`, ttlTime, 'EX', ttlTime);
   }
 }

test/app/app.module.ts

@@ -1,8 +1,8 @@
 import { Module } from '@nestjs/common';
 import { ThrottlerModule } from 'nestjs-throttler';
 import { ThrottlerStorageRedisService } from '../../src';
-import { AppController } from './app.controller';
 import { AppService } from './app.service';
+import { ControllerModule } from './controllers/controller.module';
 
 @Module({
   imports: [
@@ -11,7 +11,7 @@ import { AppService } from './app.service';
       ttl: 60,
       storage: new ThrottlerStorageRedisService(),
     }),
-    AppController,
+    ControllerModule,
   ],
   providers: [AppService],
 })

test/app/app.controller.ts → test/app/controllers/app.controller.ts

@@ -1,6 +1,6 @@
 import { Controller, Get } from '@nestjs/common';
 import { SkipThrottle, Throttle } from 'nestjs-throttler';
-import { AppService } from './app.service';
+import { AppService } from '../app.service';
 
 @Controller()
 @Throttle(2, 10)

test/app/controllers/controller.module.ts

@@ -0,0 +1,18 @@
+import { Module } from '@nestjs/common';
+import { ThrottlerModule } from 'nestjs-throttler';
+import { AppService } from '../app.service';
+import { AppController } from './app.controller';
+import { DefaultController } from './default.controller';
+import { LimitController } from './limit.controller';
+
+@Module({
+  imports: [
+    ThrottlerModule.forRoot({
+      limit: 5,
+      ttl: 60,
+    }),
+  ],
+  controllers: [AppController, DefaultController, LimitController],
+  providers: [AppService],
+})
+export class ControllerModule {}

test/app/controllers/default.controller.ts

@@ -0,0 +1,11 @@
+import { Controller, Get } from '@nestjs/common';
+import { AppService } from '../app.service';
+
+@Controller('default')
+export class DefaultController {
+  constructor(private readonly appService: AppService) {}
+  @Get()
+  getDefault() {
+    return this.appService.success();
+  }
+}

test/app/controllers/limit.controller.ts

@@ -0,0 +1,19 @@
+import { Controller, Get } from '@nestjs/common';
+import { Throttle } from 'nestjs-throttler';
+import { AppService } from '../app.service';
+
+@Throttle(2, 10)
+@Controller('limit')
+export class LimitController {
+  constructor(private readonly appService: AppService) {}
+  @Get()
+  getThrottled() {
+    return this.appService.success();
+  }
+
+  @Throttle(5, 10)
+  @Get('higher')
+  getHigher() {
+    return this.appService.success();
+  }
+}