murlock 1.0.0 → 1.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Alex
+Copyright (c) 2023 Eyüp furkan Özmen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -7,7 +7,8 @@ MurLock is a distributed lock solution designed for the NestJS framework. It pro
 - **Redis-Based**: Implements a fast and effective lock mechanism using Redis.
 - **Parameter-Based Locking**: Creates locks based on request parameters or bodies.
 - **Highly Customizable**: Customize many parameters, such as lock duration.
-- **Logging Support**: Detailed logging with internal nestjs-logger.
+- **Retry Mechanism**: Implements an exponential back-off strategy if the lock is not obtained.
+- **Logging: Provides**: logging options for debugging and monitoring.
 - **OOP and Generic Structure**: Easily integratable and expandable due to its OOP and generic design.
 
 ## Installation
@@ -33,6 +34,7 @@ import { MurLockModule } from 'murlock';
       redisOptions: { host: 'localhost', port: 6379 },
       wait: 1000,
       maxAttempts: 3,
+      logLevel: 'log',
     }),
   ],
 })
@@ -72,6 +74,7 @@ import { MurLockModule } from 'murlock';
         redisOptions: configService.get('REDIS_OPTIONS'),
         wait: configService.get('MURLOCK_WAIT'),
         maxAttempts: configService.get('MURLOCK_MAX_ATTEMPTS'),
+        logLevel: configService.get('LOG_LEVEL')
       }),
       inject: [ConfigService],
     }),
@@ -86,17 +89,38 @@ For more details on usage and configuration, please refer to the API documentati
 
 ## API Documentation
 
-For more detailed API documentation, please see the source code, which is thoroughly commented and should provide enough information for most use cases. The key classes and interfaces to be aware of are:
+### MurLock(releaseTime: number, ...keyParams: string[])
 
-- `MurLockService`: A service that provides methods for locking and unlocking. Normally you would not use this directly, but it is provided for more complex use cases.
+A method decorator to indicate that a particular method should be locked.
 
-- `MurLockModuleOptions`: An interface for the options that can be passed to `MurLockModule.registerSync()`.
+- `releaseTime`: Time in milliseconds after which the lock should be automatically released.
+- `...keyParams`: Method parameters based on which the lock should be made. The format is `paramName.attribute`. If just `paramName` is provided, it will use the `toString` method of that parameter.
 
-- `MurLockModuleAsyncOptions`: An interface for the options that can be passed to `MurLockModule.registerAsync()`.
+### Configuration Options
 
-- `MurLock()`: A decorator that provides distributed locking functionality.
+- **redisOptions:** Configuration options for the Redis client.
+- **wait:** Time (in milliseconds) to wait before retrying if a lock isn't obtained.
+- **maxAttempts:** Maximum number of attempts to obtain a lock.
+- **logLevel:** Logging level. Can be one of 'none', 'error', 'warn', 'log', or 'debug'.
 
-- `MurLockMetadata`: An interface for the metadata associated with a `@MurLock()` method.
+### MurLockService
+
+A NestJS injectable service to interact with the locking mechanism directly.
+
+## Best Practices
+
+- **Short-lived Locks:** Ensure that locks are short-lived to prevent deadlocks and increase the efficiency of your application.
+- **Error Handling:** Always handle errors gracefully. If a lock isn't obtained, it's often better to return a failure or retry after some time.
+- **Logging:** Adjust the `logLevel` based on your environment. Use 'debug' for development and 'error' or 'warn' for production.
+
+## Limitations
+
+- **Redis Persistence:** Ensure that your Redis instance has RDB persistence enabled. This ensures that in case of a crash, locks are not lost.
+- **Single Redis Instance:** MurLock is not designed to work with Redis cluster mode. It's essential to ensure that locks are always set to a single instance.
+
+## Contributions & Support
+
+We welcome contributions! Please see our contributing guide for more information. For support, raise an issue on our GitHub repository.
 
 ## License
 
@@ -104,4 +128,10 @@ This project is licensed under the [MIT License](LICENSE_FILE_URL).
 
 ## Contact
 
-If you have any questions or feedback, feel free to contact me at ozmen.eyupfurkan@gmail.com.
+If you have any questions or feedback, feel free to contact me at ozmen.eyupfurkan@gmail.com.
+
+---
+
+We hope you find MurLock useful in your projects. Don't forget to star our repo if you find it helpful!
+
+Happy coding! 🚀

package/dist/constants/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/constants/index.ts"],"names":[],"mappings":";;;AAAa,QAAA,oBAAoB,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAEtD,QAAA,4BAA4B,GAAG,MAAM,CAAC,8BAA8B,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/constants/index.ts"],"names":[],"mappings":";;;AAGa,QAAA,oBAAoB,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAKtD,QAAA,4BAA4B,GAAG,MAAM,CAAC,8BAA8B,CAAC,CAAC"}

package/dist/decorators/murlock.decorator.d.ts

@@ -1,2 +1 @@
-import 'reflect-metadata';
 export declare function MurLock(releaseTime: number, ...keyParams: string[]): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/decorators/murlock.decorator.js

@@ -10,10 +10,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MurLock = void 0;
-require("reflect-metadata");
-const murlock_service_1 = require("../murlock.service");
 const constants_1 = require("../constants");
 const exceptions_1 = require("../exceptions");
+const murlock_service_1 = require("../murlock.service");
 function getParameterNames(func) {
     const STRIP_COMMENTS = /((\/\/.*$)|(\/\*[\s\S]*?\*\/))/mg;
     const ARGUMENT_NAMES = /([^\s,]+)/g;
@@ -25,42 +24,71 @@ function MurLock(releaseTime, ...keyParams) {
     return (target, propertyKey, descriptor) => {
         const originalMethod = descriptor.value;
         const methodParameterNames = getParameterNames(originalMethod);
+        function constructLockKey(args) {
+            const lockKeyElements = [
+                target.constructor.name,
+                propertyKey,
+                ...keyParams.map((keyParam) => {
+                    const [source, path] = keyParam.split('.');
+                    const parameterIndex = methodParameterNames.indexOf(source);
+                    if (parameterIndex >= 0) {
+                        const parameterValue = args[parameterIndex];
+                        if (typeof parameterValue === 'undefined' || parameterValue === null) {
+                            throw new Error(`Parameter ${source} is undefined or null.`);
+                        }
+                        if (path && typeof parameterValue === 'object' && parameterValue !== null && path in parameterValue) {
+                            return parameterValue[path];
+                        }
+                        return parameterValue instanceof Object ? parameterValue.toString() : parameterValue;
+                    }
+                    throw new Error(`Parameter ${source} not found in method arguments.`);
+                }),
+            ];
+            return lockKeyElements.join(':');
+        }
         descriptor.value = function (...args) {
             return __awaiter(this, void 0, void 0, function* () {
-                const lockKeyElements = [
-                    target.constructor.name,
-                    propertyKey,
-                    ...keyParams.map((keyParam) => {
-                        const [source, path] = keyParam.split('.');
-                        const parameterIndex = methodParameterNames.indexOf(source);
-                        if (parameterIndex >= 0) {
-                            const parameterValue = args[parameterIndex];
-                            if (path && typeof parameterValue === 'object' && parameterValue !== null && path in parameterValue) {
-                                return parameterValue[path];
-                            }
-                            return parameterValue instanceof Object ? parameterValue.toString() : parameterValue;
-                        }
-                    }),
-                ];
-                const lockKey = lockKeyElements.join(':');
+                const lockKey = constructLockKey(args);
                 const murLockService = Reflect.getMetadata(constants_1.MURLOCK_SERVICE_METADATA_KEY, murlock_service_1.MurLockService);
-                const isLockSuccessful = yield murLockService.lock(lockKey, releaseTime);
-                if (!isLockSuccessful) {
-                    throw new exceptions_1.MurLockException('Could not obtain lock');
+                if (!murLockService) {
+                    throw new Error('MurLockService is not available.');
                 }
-                let result;
+                yield acquireLock(lockKey, murLockService, releaseTime);
                 try {
-                    result = yield originalMethod.apply(this, args);
+                    return yield originalMethod.apply(this, args);
                 }
                 finally {
-                    yield murLockService.unlock(lockKey);
+                    yield releaseLock(lockKey, murLockService);
                 }
-                return result;
             });
         };
-        Reflect.defineMetadata('MURLOCK_KEY_METADATA', { releaseTime, keyParams }, descriptor.value);
+        Reflect.defineMetadata(constants_1.MURLOCK_KEY_METADATA, { releaseTime, keyParams }, descriptor.value);
         return descriptor;
     };
 }
 exports.MurLock = MurLock;
+function acquireLock(lockKey, murLockService, releaseTime) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let isLockSuccessful = false;
+        try {
+            isLockSuccessful = yield murLockService.lock(lockKey, releaseTime);
+        }
+        catch (error) {
+            throw new exceptions_1.MurLockException(`Failed to acquire lock for key ${lockKey}: ${error.message}`);
+        }
+        if (!isLockSuccessful) {
+            throw new exceptions_1.MurLockException(`Could not obtain lock for key ${lockKey}`);
+        }
+    });
+}
+function releaseLock(lockKey, murLockService) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            yield murLockService.unlock(lockKey);
+        }
+        catch (error) {
+            throw new exceptions_1.MurLockException(`Failed to release lock for key ${lockKey}: ${error.message}`);
+        }
+    });
+}
 //# sourceMappingURL=murlock.decorator.js.map

package/dist/decorators/murlock.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"murlock.decorator.js","sourceRoot":"","sources":["../../lib/decorators/murlock.decorator.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAC1B,wDAAoD;AACpD,4CAA4D;AAC5D,8CAAiD;AAEjD,SAAS,iBAAiB,CAAC,IAAI;IAC7B,MAAM,cAAc,GAAG,kCAAkC,CAAC;IAC1D,MAAM,cAAc,GAAG,YAAY,CAAC;IAEpC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAC7F,OAAO,MAAM,IAAI,EAAE,CAAC;AACtB,CAAC;AAED,SAAgB,OAAO,CAAC,WAAmB,EAAE,GAAG,SAAmB;IACjE,OAAO,CACL,MAAW,EACX,WAAmB,EACnB,UAA8B,EAC9B,EAAE;QACF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QACxC,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC;QAG/D,UAAU,CAAC,KAAK,GAAG,UAAgB,GAAG,IAAW;;gBAC/C,MAAM,eAAe,GAAG;oBACtB,MAAM,CAAC,WAAW,CAAC,IAAI;oBACvB,WAAW;oBACX,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;wBAC5B,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;wBAC3C,MAAM,cAAc,GAAG,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;wBAC5D,IAAI,cAAc,IAAI,CAAC,EAAE;4BACvB,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;4BAC5C,IAAI,IAAI,IAAI,OAAO,cAAc,KAAK,QAAQ,IAAI,cAAc,KAAK,IAAI,IAAI,IAAI,IAAI,cAAc,EAAE;gCACnG,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC;6BAC7B;4BACD,OAAO,cAAc,YAAY,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC;yBACtF;oBACH,CAAC,CAAC;iBACH,CAAC;gBACF,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAE1C,MAAM,cAAc,GAAmB,OAAO,CAAC,WAAW,CAAC,wCAA4B,EAAE,gCAAc,CAAC,CAAC;gBAEzG,MAAM,gBAAgB,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;gBACzE,IAAI,CAAC,gBAAgB,EAAE;oBACrB,MAAM,IAAI,6BAAgB,CAAC,uBAAuB,CAAC,CAAC;iBACrD;gBAED,IAAI,MAAM,CAAC;gBACX,IAAI;oBACF,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;iBACjD;wBAAS;oBACR,MAAM,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;iBACtC;gBAED,OAAO,MAAM,CAAC;YAChB,CAAC;SAAA,CAAC;QAEF,OAAO,CAAC,cAAc,CACpB,sBAAsB,EACtB,EAAE,WAAW,EAAE,SAAS,EAAE,EAC1B,UAAU,CAAC,KAAK,CACjB,CAAC;QAEF,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AArDD,0BAqDC"}
+{"version":3,"file":"murlock.decorator.js","sourceRoot":"","sources":["../../lib/decorators/murlock.decorator.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAAkF;AAClF,8CAAiD;AACjD,wDAAoD;AAOpD,SAAS,iBAAiB,CAAC,IAAc;IACvC,MAAM,cAAc,GAAG,kCAAkC,CAAC;IAC1D,MAAM,cAAc,GAAG,YAAY,CAAC;IAEpC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAC7F,OAAO,MAAM,IAAI,EAAE,CAAC;AACtB,CAAC;AAQD,SAAgB,OAAO,CAAC,WAAmB,EAAE,GAAG,SAAmB;IACjE,OAAO,CACL,MAAW,EACX,WAAmB,EACnB,UAA8B,EAC9B,EAAE;QACF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QACxC,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC;QAE/D,SAAS,gBAAgB,CAAC,IAAW;YACnC,MAAM,eAAe,GAAG;gBACtB,MAAM,CAAC,WAAW,CAAC,IAAI;gBACvB,WAAW;gBACX,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;oBAC5B,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAC3C,MAAM,cAAc,GAAG,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;oBAC5D,IAAI,cAAc,IAAI,CAAC,EAAE;wBACvB,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;wBAC5C,IAAI,OAAO,cAAc,KAAK,WAAW,IAAI,cAAc,KAAK,IAAI,EAAE;4BACpE,MAAM,IAAI,KAAK,CAAC,aAAa,MAAM,wBAAwB,CAAC,CAAC;yBAC9D;wBACD,IAAI,IAAI,IAAI,OAAO,cAAc,KAAK,QAAQ,IAAI,cAAc,KAAK,IAAI,IAAI,IAAI,IAAI,cAAc,EAAE;4BACnG,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC;yBAC7B;wBACD,OAAO,cAAc,YAAY,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC;qBACtF;oBACD,MAAM,IAAI,KAAK,CAAC,aAAa,MAAM,iCAAiC,CAAC,CAAC;gBACxE,CAAC,CAAC;aACH,CAAC;YACF,OAAO,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC;QAED,UAAU,CAAC,KAAK,GAAG,UAAgB,GAAG,IAAW;;gBAC/C,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBAEvC,MAAM,cAAc,GAAmB,OAAO,CAAC,WAAW,CAAC,wCAA4B,EAAE,gCAAc,CAAC,CAAC;gBACzG,IAAI,CAAC,cAAc,EAAE;oBACnB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;iBACrD;gBAED,MAAM,WAAW,CAAC,OAAO,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;gBACxD,IAAI;oBACF,OAAO,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;iBAC/C;wBAAS;oBACR,MAAM,WAAW,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;iBAC5C;YACH,CAAC;SAAA,CAAC;QAEF,OAAO,CAAC,cAAc,CACpB,gCAAoB,EACpB,EAAC,WAAW,EAAE,SAAS,EAAC,EACxB,UAAU,CAAC,KAAK,CACf,CAAC;QAEJ,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAxDD,0BAwDC;AAED,SAAe,WAAW,CAAC,OAAe,EAAE,cAA8B,EAAE,WAAmB;;QAC7F,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAC7B,IAAI;YACF,gBAAgB,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;SACpE;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,6BAAgB,CAAC,kCAAkC,OAAO,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;SAC3F;QAED,IAAI,CAAC,gBAAgB,EAAE;YACrB,MAAM,IAAI,6BAAgB,CAAC,iCAAiC,OAAO,EAAE,CAAC,CAAC;SACxE;IACH,CAAC;CAAA;AAED,SAAe,WAAW,CAAC,OAAe,EAAE,cAA8B;;QACxE,IAAI;YACF,MAAM,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;SACtC;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,6BAAgB,CAAC,kCAAkC,OAAO,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;SAC3F;IACH,CAAC;CAAA"}

package/dist/index.d.ts

@@ -1,3 +1,5 @@
 export * from './murlock.service';
 export * from './murlock.module';
 export * from './decorators';
+export * from './interfaces';
+export * from './exceptions';

package/dist/index.js

@@ -17,4 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./murlock.service"), exports);
 __exportStar(require("./murlock.module"), exports);
 __exportStar(require("./decorators"), exports);
+__exportStar(require("./interfaces"), exports);
+__exportStar(require("./exceptions"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,mDAAiC;AACjC,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,mDAAiC;AACjC,+CAA6B;AAC7B,+CAA6B;AAC7B,+CAA6B"}

package/dist/interfaces/murlock-options.interface.d.ts

@@ -1,9 +1,9 @@
 import { ClientOpts } from 'redis';
 export interface MurLockModuleOptions {
     redisOptions: ClientOpts;
-    ttl: number;
     wait: number;
     maxAttempts: number;
+    logLevel: 'none' | 'error' | 'warn' | 'log' | 'debug';
 }
 export interface MurLockModuleAsyncOptions {
     imports?: any[];

package/dist/murlock.module.js

@@ -12,6 +12,7 @@ const common_1 = require("@nestjs/common");
 const murlock_service_1 = require("./murlock.service");
 require("reflect-metadata");
 const constants_1 = require("./constants");
+const nestjs_cls_1 = require("nestjs-cls");
 let MurLockModule = exports.MurLockModule = MurLockModule_1 = class MurLockModule {
     static registerSync(options) {
         return {
@@ -64,6 +65,7 @@ let MurLockModule = exports.MurLockModule = MurLockModule_1 = class MurLockModul
 exports.MurLockModule = MurLockModule = MurLockModule_1 = __decorate([
     (0, common_1.Global)(),
     (0, common_1.Module)({
+        imports: [nestjs_cls_1.ClsModule],
         providers: [murlock_service_1.MurLockService],
         exports: [murlock_service_1.MurLockService],
     })

package/dist/murlock.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"murlock.module.js","sourceRoot":"","sources":["../lib/murlock.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAyE;AACzE,uDAAmD;AACnD,4BAA0B;AAE1B,2CAA2D;AAOpD,IAAM,aAAa,6CAAnB,MAAM,aAAa;IACxB,MAAM,CAAC,YAAY,CAAC,OAA6B;QAC/C,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,iBAAiB;oBAC1B,QAAQ,EAAE,OAAO;iBAClB;gBACD,gCAAc;gBACd;oBACE,OAAO,EAAE,wCAA4B;oBACrC,UAAU,EAAE,CAAC,cAA8B,EAAE,EAAE;wBAC7C,OAAO,CAAC,cAAc,CAAC,wCAA4B,EAAE,cAAc,EAAE,gCAAc,CAAC,CAAC;wBACrF,OAAO,cAAc,CAAC;oBACxB,CAAC;oBACD,MAAM,EAAE,CAAC,gCAAc,CAAC;iBACzB;aACF;YACD,OAAO,EAAE,CAAC,gCAAc,CAAC;SAC1B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,OAAkC;QACrD,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;YAC9B,SAAS,EAAE;gBACT,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC;gBACxC,gCAAc;gBACd;oBACE,OAAO,EAAE,wCAA4B;oBACrC,UAAU,EAAE,CAAC,cAA8B,EAAE,EAAE;wBAC7C,OAAO,CAAC,cAAc,CAAC,wCAA4B,EAAE,cAAc,EAAE,gCAAc,CAAC,CAAC;wBACrF,OAAO,cAAc,CAAC;oBACxB,CAAC;oBACD,MAAM,EAAE,CAAC,gCAAc,CAAC;iBACzB;aACF;YACD,OAAO,EAAE,CAAC,gCAAc,CAAC;SAC1B,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,0BAA0B,CAAC,OAAkC;QAC1E,OAAO;YACL,OAAO,EAAE,iBAAiB;YAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;SAC7B,CAAC;IACJ,CAAC;CACF,CAAA;wBAlDY,aAAa;IALzB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,SAAS,EAAE,CAAC,gCAAc,CAAC;QAC3B,OAAO,EAAE,CAAC,gCAAc,CAAC;KAC1B,CAAC;GACW,aAAa,CAkDzB"}
+{"version":3,"file":"murlock.module.js","sourceRoot":"","sources":["../lib/murlock.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAyE;AACzE,uDAAmD;AACnD,4BAA0B;AAE1B,2CAA2D;AAC3D,2CAAuC;AAQhC,IAAM,aAAa,6CAAnB,MAAM,aAAa;IACxB,MAAM,CAAC,YAAY,CAAC,OAA6B;QAC/C,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,iBAAiB;oBAC1B,QAAQ,EAAE,OAAO;iBAClB;gBACD,gCAAc;gBACd;oBACE,OAAO,EAAE,wCAA4B;oBACrC,UAAU,EAAE,CAAC,cAA8B,EAAE,EAAE;wBAC7C,OAAO,CAAC,cAAc,CAAC,wCAA4B,EAAE,cAAc,EAAE,gCAAc,CAAC,CAAC;wBACrF,OAAO,cAAc,CAAC;oBACxB,CAAC;oBACD,MAAM,EAAE,CAAC,gCAAc,CAAC;iBACzB;aACF;YACD,OAAO,EAAE,CAAC,gCAAc,CAAC;SAC1B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,OAAkC;QACrD,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;YAC9B,SAAS,EAAE;gBACT,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC;gBACxC,gCAAc;gBACd;oBACE,OAAO,EAAE,wCAA4B;oBACrC,UAAU,EAAE,CAAC,cAA8B,EAAE,EAAE;wBAC7C,OAAO,CAAC,cAAc,CAAC,wCAA4B,EAAE,cAAc,EAAE,gCAAc,CAAC,CAAC;wBACrF,OAAO,cAAc,CAAC;oBACxB,CAAC;oBACD,MAAM,EAAE,CAAC,gCAAc,CAAC;iBACzB;aACF;YACD,OAAO,EAAE,CAAC,gCAAc,CAAC;SAC1B,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,0BAA0B,CAAC,OAAkC;QAC1E,OAAO;YACL,OAAO,EAAE,iBAAiB;YAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;SAC7B,CAAC;IACJ,CAAC;CACF,CAAA;wBAlDY,aAAa;IANzB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,sBAAS,CAAC;QACpB,SAAS,EAAE,CAAC,gCAAc,CAAC;QAC3B,OAAO,EAAE,CAAC,gCAAc,CAAC;KAC1B,CAAC;GACW,aAAa,CAkDzB"}

package/dist/murlock.service.d.ts

@@ -1,13 +1,21 @@
 import { OnApplicationShutdown, OnModuleInit } from '@nestjs/common';
 import { MurLockModuleOptions } from './interfaces';
-export declare class MurLockService implements OnApplicationShutdown, OnModuleInit {
+import { ClsService } from 'nestjs-cls';
+export declare class MurLockService implements OnModuleInit, OnApplicationShutdown {
     protected readonly options: MurLockModuleOptions;
+    private readonly clsService;
     private readonly logger;
     private redisClient;
-    constructor(options: MurLockModuleOptions);
+    private readonly lockScript;
+    private readonly unlockScript;
+    private runScriptAsync;
+    constructor(options: MurLockModuleOptions, clsService: ClsService);
     onModuleInit(): void;
     onApplicationShutdown(signal?: string): void;
+    private generateUuid;
+    private getClientId;
     private sleep;
-    lock(lockKey: string, releaseTime: number): Promise<boolean>;
+    private log;
+    lock(lockKey: string, releaseTime: number, attemptsRemaining?: number): Promise<boolean>;
     unlock(lockKey: string): Promise<void>;
 }

package/dist/murlock.service.js

@@ -25,39 +25,74 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MurLockService = void 0;
 const common_1 = require("@nestjs/common");
 const redis_1 = require("redis");
+const util_1 = require("util");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const nestjs_cls_1 = require("nestjs-cls");
 let MurLockService = exports.MurLockService = MurLockService_1 = class MurLockService {
-    constructor(options) {
+    constructor(options, clsService) {
         this.options = options;
+        this.clsService = clsService;
         this.logger = new common_1.Logger(MurLockService_1.name);
+        this.lockScript = (0, fs_1.readFileSync)((0, path_1.join)(__dirname, './lua/lock.lua')).toString();
+        this.unlockScript = (0, fs_1.readFileSync)((0, path_1.join)(__dirname, './lua/unlock.lua')).toString();
     }
     onModuleInit() {
         this.redisClient = new redis_1.RedisClient(this.options.redisOptions);
-        this.logger.debug('MurLock Redis Connected.');
-        this.redisClient.on('error', (err) => this.logger.log('MurLock Redis Client Error', err));
+        this.runScriptAsync = (0, util_1.promisify)(this.redisClient.eval).bind(this.redisClient);
+        this.redisClient.on('error', (err) => this.log('error', 'MurLock Redis Client Error', err));
     }
     onApplicationShutdown(signal) {
-        this.logger.log('MurLock Redis Connected.');
+        this.log('log', 'MurLock Redis Disconnected.');
         this.redisClient.quit();
     }
+    generateUuid() {
+        let d = Date.now();
+        return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
+            const r = (d + Math.random() * 16) % 16 | 0;
+            d = Math.floor(d / 16);
+            return (c === 'x' ? r : (r & 0x3) | 0x8).toString(16);
+        });
+    }
+    getClientId() {
+        let clientId = this.clsService.get('clientId');
+        if (!clientId) {
+            clientId = this.generateUuid();
+            this.clsService.set('clientId', clientId);
+        }
+        return clientId;
+    }
     sleep(ms) {
         return new Promise((resolve) => setTimeout(resolve, ms));
     }
-    lock(lockKey, releaseTime) {
+    log(level, message, context) {
+        const levels = ['debug', 'log', 'warn', 'error'];
+        if (levels.indexOf(level) >= levels.indexOf(this.options.logLevel)) {
+            this.logger[level](message, context);
+        }
+    }
+    lock(lockKey, releaseTime, attemptsRemaining = this.options.maxAttempts) {
         return __awaiter(this, void 0, void 0, function* () {
+            const clientId = this.getClientId();
+            this.log('debug', `MurLock Client ID is ${clientId}`);
             const attemptLock = (attemptsRemaining) => __awaiter(this, void 0, void 0, function* () {
-                if (attemptsRemaining === 0)
-                    return false;
+                if (attemptsRemaining === 0) {
+                    throw new Error(`Failed to obtain lock for key ${lockKey} after ${this.options.maxAttempts} attempts.`);
+                }
                 try {
-                    const isLockSuccessful = yield this.redisClient.set(lockKey, 'LOCKED', 'EX', releaseTime, 'NX');
-                    if (isLockSuccessful) {
-                        this.logger.log(`Successfully obtained lock for key ${lockKey}`);
+                    const isLockSuccessful = yield this.runScriptAsync(this.lockScript, 1, lockKey, clientId, releaseTime);
+                    if (isLockSuccessful === 1) {
+                        this.log('log', `Successfully obtained lock for key ${lockKey}`);
                         return true;
                     }
-                    yield this.sleep(this.options.wait);
-                    return attemptLock(attemptsRemaining - 1);
+                    else {
+                        this.log('warn', `Failed to obtain lock for key ${lockKey}, retrying in ${this.options.wait} ms...`);
+                        yield this.sleep(this.options.wait * (this.options.maxAttempts - attemptsRemaining + 1));
+                        return attemptLock(attemptsRemaining - 1);
+                    }
                 }
                 catch (error) {
-                    this.logger.error(`Could not obtain lock for key ${lockKey}`, error);
+                    this.log('error', `Unexpected error when trying to obtain lock for key ${lockKey}:`, error);
                     return false;
                 }
             });
@@ -66,14 +101,17 @@ let MurLockService = exports.MurLockService = MurLockService_1 = class MurLockSe
     }
     unlock(lockKey) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.redisClient.del(lockKey);
-            this.logger.log(`Lock released for key ${lockKey}`);
+            const clientId = this.getClientId();
+            const result = yield this.runScriptAsync(this.unlockScript, 1, lockKey, clientId);
+            if (result === 0) {
+                throw new Error(`Failed to release lock for key ${lockKey}`);
+            }
         });
     }
 };
 exports.MurLockService = MurLockService = MurLockService_1 = __decorate([
     (0, common_1.Injectable)(),
     __param(0, (0, common_1.Inject)('MURLOCK_OPTIONS')),
-    __metadata("design:paramtypes", [Object])
+    __metadata("design:paramtypes", [Object, nestjs_cls_1.ClsService])
 ], MurLockService);
 //# sourceMappingURL=murlock.service.js.map

package/dist/murlock.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"murlock.service.js","sourceRoot":"","sources":["../lib/murlock.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAAgG;AAChG,iCAAoC;AAK7B,IAAM,cAAc,+CAApB,MAAM,cAAc;IAGzB,YAC6B,OAAgD;QAA7B,YAAO,GAAP,OAAO,CAAsB;QAH5D,WAAM,GAAG,IAAI,eAAM,CAAC,gBAAc,CAAC,IAAI,CAAC,CAAC;IAIvD,CAAC;IACJ,YAAY;QACV,IAAI,CAAC,WAAW,GAAG,IAAI,mBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAE9D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAE9C,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,4BAA4B,EAAE,GAAG,CAAC,CAAC,CAAC;IAC5F,CAAC;IACD,qBAAqB,CAAC,MAAe;QACnC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;QAC5C,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;IAEO,KAAK,CAAC,EAAU;QACtB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3D,CAAC;IAEK,IAAI,CAAC,OAAe,EAAE,WAAmB;;YAC7C,MAAM,WAAW,GAAG,CAAO,iBAAyB,EAAoB,EAAE;gBACxE,IAAI,iBAAiB,KAAK,CAAC;oBAAE,OAAO,KAAK,CAAC;gBAE1C,IAAI;oBACF,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;oBAChG,IAAI,gBAAgB,EAAE;wBACpB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,sCAAsC,OAAO,EAAE,CAAC,CAAC;wBACjE,OAAO,IAAI,CAAC;qBACb;oBACD,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBACpC,OAAO,WAAW,CAAC,iBAAiB,GAAG,CAAC,CAAC,CAAC;iBAC3C;gBACD,OAAO,KAAK,EAAE;oBACZ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iCAAiC,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC;oBACrE,OAAO,KAAK,CAAC;iBACd;YACH,CAAC,CAAA,CAAC;YAEF,OAAO,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC/C,CAAC;KAAA;IAEK,MAAM,CAAC,OAAe;;YAC1B,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACpC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yBAAyB,OAAO,EAAE,CAAC,CAAC;QACtD,CAAC;KAAA;CACF,CAAA;yBAhDY,cAAc;IAD1B,IAAA,mBAAU,GAAE;IAKR,WAAA,IAAA,eAAM,EAAC,iBAAiB,CAAC,CAAA;;GAJjB,cAAc,CAgD1B"}
+{"version":3,"file":"murlock.service.js","sourceRoot":"","sources":["../lib/murlock.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAAiG;AACjG,iCAAoC;AACpC,+BAAiC;AACjC,2BAAkC;AAClC,+BAA4B;AAE5B,2CAAwC;AAMjC,IAAM,cAAc,+CAApB,MAAM,cAAc;IAOzB,YAC6B,OAAgD,EAC1D,UAAsB;QADO,YAAO,GAAP,OAAO,CAAsB;QAC1D,eAAU,GAAV,UAAU,CAAY;QARxB,WAAM,GAAG,IAAI,eAAM,CAAC,gBAAc,CAAC,IAAI,CAAC,CAAC;QAEzC,eAAU,GAAG,IAAA,iBAAY,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QACxE,iBAAY,GAAG,IAAA,iBAAY,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAM1F,CAAC;IAEJ,YAAY;QACV,IAAI,CAAC,WAAW,GAAG,IAAI,mBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,IAAA,gBAAS,EAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAE9E,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAC,4BAA4B,EAAE,GAAG,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED,qBAAqB,CAAC,MAAe;QACnC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAC,6BAA6B,CAAC,CAAC;QAC9C,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;IAEO,YAAY;QAClB,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACnB,OAAO,sCAAsC,CAAC,OAAO,CACnD,OAAO,EACP,CAAC,CAAS,EAAE,EAAE;YACZ,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YAC5C,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;YACvB,OAAO,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACxD,CAAC,CACF,CAAC;IACJ,CAAC;IAEO,WAAW;QACjB,IAAI,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,EAAE;YACb,QAAQ,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YAC/B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;SAC3C;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,EAAU;QACpB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IAC7D,CAAC;IAEO,GAAG,CAAC,KAAuC,EAAE,OAAY,EAAE,OAAgB;QACjF,MAAM,MAAM,GAAuC,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QACrF,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAClE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SACtC;IACH,CAAC;IAQK,IAAI,CAAC,OAAe,EAAE,WAAmB,EAAE,iBAAiB,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW;;YAC3F,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YACpC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAC,wBAAwB,QAAQ,EAAE,CAAC,CAAC;YAErD,MAAM,WAAW,GAAG,CAAO,iBAAyB,EAAoB,EAAE;gBACxE,IAAI,iBAAiB,KAAK,CAAC,EAAE;oBAC3B,MAAM,IAAI,KAAK,CAAC,iCAAiC,OAAO,UAAU,IAAI,CAAC,OAAO,CAAC,WAAW,YAAY,CAAC,CAAC;iBACzG;gBACD,IAAI;oBACF,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;oBACvG,IAAI,gBAAgB,KAAK,CAAC,EAAE;wBAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAC,sCAAsC,OAAO,EAAE,CAAC,CAAC;wBAChE,OAAO,IAAI,CAAC;qBACb;yBAAM;wBACL,IAAI,CAAC,GAAG,CAAC,MAAM,EAAC,iCAAiC,OAAO,iBAAiB,IAAI,CAAC,OAAO,CAAC,IAAI,QAAQ,CAAC,CAAC;wBACpG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,GAAG,iBAAiB,GAAG,CAAC,CAAC,CAAC,CAAC;wBACzF,OAAO,WAAW,CAAC,iBAAiB,GAAG,CAAC,CAAC,CAAC;qBAC3C;iBACF;gBAAC,OAAO,KAAK,EAAE;oBACd,IAAI,CAAC,GAAG,CAAC,OAAO,EAAC,uDAAuD,OAAO,GAAG,EAAE,KAAK,CAAC,CAAC;oBAC3F,OAAO,KAAK,CAAC;iBACd;YACH,CAAC,CAAA,CAAC;YAEF,OAAO,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC/C,CAAC;KAAA;IAOO,MAAM,CAAC,OAAe;;YAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;YAElF,IAAI,MAAM,KAAK,CAAC,EAAE;gBAChB,MAAM,IAAI,KAAK,CAAC,kCAAkC,OAAO,EAAE,CAAC,CAAC;aAC9D;QACL,CAAC;KAAA;CACF,CAAA;yBAtGY,cAAc;IAD1B,IAAA,mBAAU,GAAE;IASR,WAAA,IAAA,eAAM,EAAC,iBAAiB,CAAC,CAAA;6CACG,uBAAU;GAT9B,cAAc,CAsG1B"}