@anchan828/nest-redlock 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018-2022 anchan828
+
+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.

package/README.md

@@ -0,0 +1,123 @@
+# @anchan828/nest-redlock
+
+![npm](https://img.shields.io/npm/v/@anchan828/nest-redlock.svg)
+![NPM](https://img.shields.io/npm/l/@anchan828/nest-redlock.svg)
+
+This is a [Nest](https://github.com/nestjs/nest) implementation of the redlock algorithm for distributed redis.
+
+This package uses [node-redlock](https://github.com/mike-marcacci/node-redlock).
+
+## Installation
+
+```bash
+$ npm i --save @anchan828/nest-redlock ioredis
+```
+
+## Quick Start
+
+### 1. Import module
+
+```ts
+import { RedisRedlockModule } from "@anchan828/nest-redlock";
+import Redis from "ioredis";
+
+@Module({
+  imports: [
+    RedisRedlockModule.register({
+      clients: [new Redis({ host: "localhost" })],
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### 2. Add `RedisRedlock` decorator
+
+```ts
+import { RedisRedlock } from "@anchan828/nest-redlock";
+
+@Injectable()
+export class ExampleService {
+  @RedisRedlock("lock-key")
+  public async addComment(projectId: number, comment: string): Promise<void> {}
+}
+```
+
+This is complete. redlock is working correctly!
+See [node-redlock](https://github.com/mike-marcacci/node-redlock) for more information on redlock.
+
+## Define complex resources (lock keys)
+
+If you use a constant, it will be locked on all calls. Let's make the range a little smaller.
+
+In this example, only certain projects are now locked.
+
+```ts
+import { RedisRedlock } from "@anchan828/nest-redlock";
+
+@Injectable()
+export class ExampleService {
+  // The arguments define the class object to which the decorator is being added and the method arguments in order.
+  @RedisRedlock((target: ExampleService, projectId: number, comment: string) => `projects/${projectId}/comments`)
+  public async addComment(projectId: number, comment: string): Promise<void> {}
+}
+```
+
+Of course, you can lock multiple keys.
+
+```ts
+@Injectable()
+export class ExampleService {
+  @RedisRedlock((target: ExampleService, projectId: number, args: Array<{ commentId: number; comment: string }>) =>
+    args.map((arg) => `projects/${projectId}/comments/${arg.commentId}`),
+  )
+  public async updateComments(projectId: number, args: Array<{ commentId: number; comment: string }>): Promise<void> {}
+}
+```
+
+## Using Redlock service
+
+If you want to use node-redlock as is, use RedisRedlockService.
+
+```ts
+import { RedisRedlockService } from "@anchan828/nest-redlock";
+
+@Injectable()
+export class ExampleService {
+  constructor(private readonly redlock: RedisRedlockService) {}
+
+  public async addComment(projectId: number, comment: string): Promise<void> {
+    await this.redlock.using([`projects/${projectId}/comments`], 5000, (signal) => {
+      // Do something...
+
+      if (signal.aborted) {
+        throw signal.error;
+      }
+    });
+  }
+}
+```
+
+## Troubleshooting
+
+### Nest can't resolve dependencies of the XXX. Please make sure that the "@redisRedlockService" property is available in the current context.
+
+This is the error output when using the RedisRedlock decorator without importing the RedisRedlockModule.
+
+```ts
+import { RedisRedlockModule } from "@anchan828/nest-redlock";
+import Redis from "ioredis";
+
+@Module({
+  imports: [
+    RedisRedlockModule.register({
+      clients: [new Redis({ host: "localhost" })],
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+## License
+
+[MIT](LICENSE)

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@anchan828/nest-redlock",
+  "version": "0.0.1",
+  "description": "This is a [Nest](https://github.com/nestjs/nest) implementation of the redlock algorithm for distributed redis locks.",
+  "homepage": "https://github.com/anchan828/nest-redlock#readme",
+  "bugs": {
+    "url": "https://github.com/anchan828/nest-redlock/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anchan828/nest-redlock.git"
+  },
+  "license": "MIT",
+  "author": "anchan828 <anchan828@gmail.com>",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "format": "prettier --write '**/*.{js,json,yml,yaml,md}'",
+    "postinstall": "husky install",
+    "lint": "TIMING=1 eslint --ignore-path .eslintignore '**/*.ts'",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "jest --coverage --runInBand"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "17.0.3",
+    "@commitlint/config-conventional": "17.0.3",
+    "@nestjs/common": "9.0.11",
+    "@nestjs/core": "9.0.11",
+    "@nestjs/platform-express": "9.0.11",
+    "@nestjs/testing": "9.0.11",
+    "@types/jest": "28.1.7",
+    "@types/node": "17.0.42",
+    "@types/supertest": "2.0.12",
+    "@typescript-eslint/eslint-plugin": "5.34.0",
+    "@typescript-eslint/parser": "5.34.0",
+    "eslint": "8.22.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "husky": "8.0.1",
+    "ioredis": "5.2.2",
+    "jest": "28.1.3",
+    "lint-staged": "13.0.3",
+    "prettier": "2.7.1",
+    "redlock": "5.0.0-beta.2",
+    "reflect-metadata": "0.1.13",
+    "rxjs": "7.5.6",
+    "supertest": "6.2.4",
+    "ts-jest": "28.0.8",
+    "ts-node": "10.9.1",
+    "typescript": "4.7.4"
+  },
+  "volta": {
+    "node": "18.4.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}