@diia-inhouse/redis 3.1.76 → 3.2.0

package/dist/interfaces/mutex.d.ts

@@ -11,6 +11,11 @@ type LockOptions = {
   * @defaultValue 500
   */
   retryInterval?: number;
+  /**
+  * Maximum time in milliseconds to keep trying to acquire a locked resource before giving up
+  * @defaultValue ttl * 2
+  */
+  acquireTimeout?: number;
 };
 //#endregion
 export { Lock, LockOptions, MutexStatusResult, RedlockMutex$1 as RedlockMutex };

package/dist/services/mutex.d.ts

@@ -11,9 +11,12 @@ declare class RedlockService implements OnHealthCheck, OnDestroy {
   constructor(storeConfig: RedisConfig, logger: Logger);
   onHealthCheck(): Promise<HealthCheckResult<MutexStatusResult>>;
   onDestroy(): Promise<void>;
-  lock(resource: string, ttl?: number, {
-    retryInterval
-  }?: LockOptions): Promise<RedlockMutex>;
+  lock(resource: string, ttl?: number, options?: LockOptions): Promise<RedlockMutex>;
+  /**
+  * Same as `lock`, but resolves with `null` instead of throwing when the resource is not acquired within `acquireTimeout`
+  */
+  tryLock(resource: string, ttl?: number, options?: LockOptions): Promise<RedlockMutex | null>;
+  private createMutex;
 }
 //#endregion
 export { RedlockService };

package/dist/services/mutex.js

@@ -37,15 +37,25 @@ var RedlockService = class {
 	async onDestroy() {
 		await this.clientRW.quit();
 	}
-	async lock(resource, ttl = 6e4, { retryInterval = 500 } = {}) {
+	async lock(resource, ttl = 6e4, options = {}) {
+		const mutex = this.createMutex(resource, ttl, options);
+		await mutex.acquire();
+		return mutex;
+	}
+	/**
+	* Same as `lock`, but resolves with `null` instead of throwing when the resource is not acquired within `acquireTimeout`
+	*/
+	async tryLock(resource, ttl = 6e4, options = {}) {
+		const mutex = this.createMutex(resource, ttl, options);
+		return await mutex.tryAcquire() ? mutex : null;
+	}
+	createMutex(resource, ttl, { retryInterval = 500, acquireTimeout = ttl * 2 }) {
 		this.logger.info(`Start LOCK resource [${resource}] for ttl [${ttl}]ms`);
-		const mutex = new RedlockMutex([this.clientRW], resource, {
+		return new RedlockMutex([this.clientRW], resource, {
 			lockTimeout: ttl,
-			acquireTimeout: ttl * 2,
+			acquireTimeout,
 			retryInterval
 		});
-		await mutex.acquire();
-		return mutex;
 	}
 };
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@diia-inhouse/redis",
-    "version": "3.1.76",
+    "version": "3.2.0",
     "type": "module",
     "description": "Redis services - redlock, pubsub, cache and store",
     "main": "dist/index.js",
@@ -49,7 +49,7 @@
     "devDependencies": {
         "@diia-inhouse/configs": "7.2.1",
         "@diia-inhouse/diia-logger": "4.4.71",
-        "@diia-inhouse/env": "3.3.62",
+        "@diia-inhouse/env": "3.3.63",
         "@diia-inhouse/errors": "2.2.31",
         "@diia-inhouse/oxc-config": "2.1.6",
         "@diia-inhouse/test": "8.3.18",