@hazeljs/distributed-lock 0.4.0

package/LICENSE

@@ -0,0 +1,192 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2024 HazelJS Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+---
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+   Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+   stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+   that You distribute, all copyright, patent, trademark, and
+   attribution notices from the Source form of the Work,
+   excluding those notices that do not pertain to any part of
+   the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+   distribution, then any Derivative Works that You distribute must
+   include a readable copy of the attribution notices contained
+   within such NOTICE file, excluding those notices that do not
+   pertain to any part of the Derivative Works, in at least one
+   of the following places: within a NOTICE text file distributed
+   as part of the Derivative Works; within the Source form or
+   documentation, if provided along with the Derivative Works; or,
+   within a display generated by the Derivative Works, if and
+   wherever such third-party notices normally appear. The contents
+   of the NOTICE file are for informational purposes only and
+   do not modify the License. You may add Your own attribution
+   notices within Derivative Works that You distribute, alongside
+   or as an addendum to the NOTICE text from the Work, provided
+   that such additional attribution notices cannot be construed
+   as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,184 @@
+# @hazeljs/distributed-lock
+
+**Distributed Locking for HazelJS. Mutual exclusion across all your nodes, simplified.**
+
+Ensure that your critical code paths are only executed by one instance at a time. HazelJS Distributed Lock provides a unified interface for multiple backends (Redis, In-Memory) and a powerful decorator-based API with dynamic key resolution.
+
+[![npm version](https://img.shields.io/npm/v/@hazeljs/distributed-lock.svg)](https://www.npmjs.com/package/@hazeljs/distributed-lock)
+[![npm downloads](https://img.shields.io/npm/dm/@hazeljs/distributed-lock)](https://www.npmjs.com/package/@hazeljs/distributed-lock)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+## Features
+
+- 🔒 **Decorator-Based API** — Use `@DistributedLock()` for declarative, method-level locking across your distributed system.
+- 📂 **Multiple Backends** — First-class support for **Redis** (production) and **Memory** (local development/testing).
+- 🔢 **Dynamic Key Resolution** — Support for template placeholders (e.g., `{id}`, `{user.token}`) that automatically resolve from method arguments.
+- ⚖️ **Atomic Mutual Exclusion** — Guarantees that exactly one process executes a given snippet at any moment across all nodes.
+- 🔄 **Wait & Retry Strategies** — Highly configurable lock acquisition logic, including retry counts, delays, and TTLs.
+- 🧹 **Automatic Cleanup** — Locks are automatically released upon method completion, regardless of success or failure.
+
+---
+
+## Installation
+
+```bash
+npm install @hazeljs/distributed-lock
+```
+
+### Optional Peer Dependencies
+
+For production environments using Redis, you'll need the following:
+
+```bash
+npm install redis
+```
+
+---
+
+## Quick Start (Decorator)
+
+The easiest way to use distributed locking is through the `@DistributedLock` decorator.
+
+### 1. Simple Locking
+
+Lock a method for a specific user based on an argument.
+
+```typescript
+import { DistributedLock } from '@hazeljs/distributed-lock';
+
+class UserProfileService {
+  @DistributedLock({ 
+    key: 'update-profile-{userId}', 
+    ttl: 10000, 
+    wait: true 
+  })
+  async updateProfile(userId: string, data: any) {
+    // This code is now thread-safe across all distributed nodes
+    // for this specific userId.
+    return await this.saveProfile(userId, data);
+  }
+}
+```
+
+### 2. Manual Programmatic API
+
+You can also acquire and release locks manually using the `LockManager`.
+
+```typescript
+import { LockManager } from '@hazeljs/distributed-lock';
+
+const lockManager = LockManager.getInstance();
+
+async function myTask() {
+  const lock = await lockManager.acquire({
+    key: 'manual-task-lock',
+    ttl: 5000,
+  });
+
+  if (!lock) return; // Could not acquire lock
+
+  try {
+    // Perform critical task...
+  } finally {
+    // Always release in finally block
+    await lock.release();
+  }
+}
+```
+
+---
+
+## Lock Backends
+
+Choose the backend that fits your deployment strategy.
+
+### In-Memory (Default)
+
+Great for development or single-node deployments.
+
+```typescript
+import { LockManager } from '@hazeljs/distributed-lock';
+
+const lockManager = LockManager.getInstance();
+lockManager.setDefaultBackend('memory');
+```
+
+### Redis (Production)
+
+Recommended for multi-node production systems.
+
+```typescript
+import { LockManager } from '@hazeljs/distributed-lock';
+
+const lockManager = LockManager.getInstance();
+
+lockManager.setupRedis({
+  url: 'redis://localhost:6379',
+}, 'redis-prod');
+
+lockManager.setDefaultBackend('redis-prod');
+```
+
+---
+
+## Backend Comparison
+
+| | In-Memory | Redis | Custom |
+|---|:---:|:---:|:---:|
+| **Distributed** | ❌ (Single node) | ✅ (All nodes) | ✅ (Interface-based) |
+| **Setup** | None | Required | Custom impl |
+| **Best For** | Development / Testing | Production / High Load | Specialized systems |
+| **Performance** | Nano-seconds | Milli-seconds | Backend-dependent |
+
+---
+
+## Configuration Options
+
+| Option | Type | Description |
+| --- | --- | --- |
+| `key` | `string` | The unique lock identifier. Supports `{param}` placeholders from method args. |
+| `ttl` | `number` | Time-To-Live in milliseconds. Default: `5000`. |
+| `wait` | `boolean` | If true, will wait for the lock if held. Default: `false`. |
+| `retryCount`| `number` | Number of retries if `wait` is true. Default: `3`. |
+| `retryDelay`| `number` | Time between retries in milliseconds. Default: `100`. |
+| `backend` | `string` | Override the default backend (e.g., `'memory'`, `'redis'`). |
+
+---
+
+## API Reference
+
+### `LockManager` (Singleton)
+
+```typescript
+class LockManager {
+  static getInstance(): LockManager;
+  registerBackend(name: string, backend: ILockBackend): void;
+  setDefaultBackend(name: string): void;
+  acquire(options: LockOptions): Promise<ILock | null>;
+  setupRedis(redisOptions: any, name?: string): void;
+}
+```
+
+### `Interfaces`
+
+- **`ILock`** — An acquired lock. Contains `release(): Promise<void>`.
+- **`ILockBackend`** — The interface for implementing custom lock providers.
+
+---
+
+## Use Cases
+
+- 💰 **Payment Processing** — Preventing double-charging on concurrent requests.
+- 📦 **Inventory Management** — Ensuring stock counts remain accurate across multiple instances.
+- 👤 **Global Singletons** — Guaranteeing that only one cron job or worker runs a task globally.
+- 🏗️ **Resource Provisioning** — Atomically creating cloud resources like databases or VMs.
+
+---
+
+## License
+
+Apache-2.0
+
+## Contributing
+
+Contributions are welcome! See [CONTRIBUTING.md](../../CONTRIBUTING.md) for details.

package/dist/backends/index.d.ts

@@ -0,0 +1,2 @@
+export * from './memory-backend';
+export * from './redis-backend';

package/dist/backends/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./memory-backend"), exports);
+__exportStar(require("./redis-backend"), exports);
+//# sourceMappingURL=index.js.map

package/dist/backends/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/backends/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,kDAAgC"}

package/dist/backends/memory-backend.d.ts

@@ -0,0 +1,17 @@
+import { ILock, ILockBackend, LockOptions } from '../interfaces';
+export declare class MemoryLock implements ILock {
+    private readonly backend;
+    private readonly key;
+    private readonly identifier;
+    private expiration;
+    constructor(backend: MemoryLockBackend, key: string, identifier: string, expiration: number);
+    release(): Promise<void>;
+    extend(ttl: number): Promise<boolean>;
+}
+export declare class MemoryLockBackend implements ILockBackend {
+    private readonly locks;
+    acquire(options: LockOptions): Promise<ILock | null>;
+    release(key: string, identifier: string): Promise<void>;
+    extend(key: string, identifier: string, ttl: number): Promise<boolean>;
+    close(): Promise<void>;
+}

package/dist/backends/memory-backend.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoryLockBackend = exports.MemoryLock = void 0;
+class MemoryLock {
+    constructor(backend, key, identifier, expiration) {
+        this.backend = backend;
+        this.key = key;
+        this.identifier = identifier;
+        this.expiration = expiration;
+    }
+    async release() {
+        return this.backend.release(this.key, this.identifier);
+    }
+    async extend(ttl) {
+        return this.backend.extend(this.key, this.identifier, ttl);
+    }
+}
+exports.MemoryLock = MemoryLock;
+class MemoryLockBackend {
+    constructor() {
+        this.locks = new Map();
+    }
+    async acquire(options) {
+        const { key, ttl = 30000, retry } = options;
+        const identifier = Math.random().toString(36).substring(2);
+        const attempt = async () => {
+            const current = this.locks.get(key);
+            const now = Date.now();
+            if (!current || current.expiration < now) {
+                if (current?.timer) {
+                    clearTimeout(current.timer);
+                }
+                const expiration = now + ttl;
+                const timer = setTimeout(() => {
+                    this.release(key, identifier);
+                }, ttl);
+                this.locks.set(key, { identifier, expiration, timer });
+                return new MemoryLock(this, key, identifier, expiration);
+            }
+            return null;
+        };
+        let lock = await attempt();
+        if (lock)
+            return lock;
+        if (retry) {
+            for (let i = 0; i < retry.attempts; i++) {
+                await new Promise((resolve) => setTimeout(resolve, retry.delay));
+                lock = await attempt();
+                if (lock)
+                    return lock;
+            }
+        }
+        return null;
+    }
+    async release(key, identifier) {
+        const current = this.locks.get(key);
+        if (current && current.identifier === identifier) {
+            if (current.timer) {
+                clearTimeout(current.timer);
+            }
+            this.locks.delete(key);
+        }
+    }
+    async extend(key, identifier, ttl) {
+        const current = this.locks.get(key);
+        if (current && current.identifier === identifier) {
+            if (current.timer) {
+                clearTimeout(current.timer);
+            }
+            const expiration = Date.now() + ttl;
+            const timer = setTimeout(() => {
+                this.release(key, identifier);
+            }, ttl);
+            this.locks.set(key, { identifier, expiration, timer });
+            return true;
+        }
+        return false;
+    }
+    async close() {
+        for (const lock of this.locks.values()) {
+            if (lock.timer) {
+                clearTimeout(lock.timer);
+            }
+        }
+        this.locks.clear();
+    }
+}
+exports.MemoryLockBackend = MemoryLockBackend;
+//# sourceMappingURL=memory-backend.js.map

package/dist/backends/memory-backend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory-backend.js","sourceRoot":"","sources":["../../src/backends/memory-backend.ts"],"names":[],"mappings":";;;AAEA,MAAa,UAAU;IACrB,YACmB,OAA0B,EAC1B,GAAW,EACX,UAAkB,EAC3B,UAAkB;QAHT,YAAO,GAAP,OAAO,CAAmB;QAC1B,QAAG,GAAH,GAAG,CAAQ;QACX,eAAU,GAAV,UAAU,CAAQ;QAC3B,eAAU,GAAV,UAAU,CAAQ;IACzB,CAAC;IAEJ,KAAK,CAAC,OAAO;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;CACF;AAfD,gCAeC;AAED,MAAa,iBAAiB;IAA9B;QACmB,UAAK,GAAG,IAAI,GAAG,EAG7B,CAAC;IA4EN,CAAC;IA1EC,KAAK,CAAC,OAAO,CAAC,OAAoB;QAChC,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,KAAK,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAE3D,MAAM,OAAO,GAAG,KAAK,IAA2B,EAAE;YAChD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAEvB,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC;gBACzC,IAAI,OAAO,EAAE,KAAK,EAAE,CAAC;oBACnB,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC9B,CAAC;gBAED,MAAM,UAAU,GAAG,GAAG,GAAG,GAAG,CAAC;gBAC7B,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;oBAC5B,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;gBAChC,CAAC,EAAE,GAAG,CAAC,CAAC;gBAER,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;gBACvD,OAAO,IAAI,UAAU,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;YAC3D,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;QAEF,IAAI,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;QAC3B,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC;QAEtB,IAAI,KAAK,EAAE,CAAC;YACV,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC;gBACxC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;gBACjE,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;gBACvB,IAAI,IAAI;oBAAE,OAAO,IAAI,CAAC;YACxB,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,UAAkB;QAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,OAAO,IAAI,OAAO,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;YACjD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;gBAClB,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC;YACD,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,UAAkB,EAAE,GAAW;QACvD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,OAAO,IAAI,OAAO,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;YACjD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;gBAClB,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC;YAED,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC;YACpC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;YAChC,CAAC,EAAE,GAAG,CAAC,CAAC;YAER,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;YACvD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,KAAK;QACT,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;YACvC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;CACF;AAhFD,8CAgFC"}

package/dist/backends/redis-backend.d.ts

@@ -0,0 +1,17 @@
+import { ILock, ILockBackend, LockOptions } from '../interfaces';
+export declare class RedisLock implements ILock {
+    private readonly backend;
+    private readonly key;
+    private readonly identifier;
+    constructor(backend: RedisLockBackend, key: string, identifier: string);
+    release(): Promise<void>;
+    extend(ttl: number): Promise<boolean>;
+}
+export declare class RedisLockBackend implements ILockBackend {
+    private readonly redis;
+    constructor(redisOptions: unknown);
+    acquire(options: LockOptions): Promise<ILock | null>;
+    release(key: string, identifier: string): Promise<void>;
+    extend(key: string, identifier: string, ttl: number): Promise<boolean>;
+    close(): Promise<void>;
+}

package/dist/backends/redis-backend.js

@@ -0,0 +1,80 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisLockBackend = exports.RedisLock = void 0;
+const ioredis_1 = __importDefault(require("ioredis"));
+class RedisLock {
+    constructor(backend, key, identifier) {
+        this.backend = backend;
+        this.key = key;
+        this.identifier = identifier;
+    }
+    async release() {
+        return this.backend.release(this.key, this.identifier);
+    }
+    async extend(ttl) {
+        return this.backend.extend(this.key, this.identifier, ttl);
+    }
+}
+exports.RedisLock = RedisLock;
+class RedisLockBackend {
+    constructor(redisOptions) {
+        if (redisOptions && typeof redisOptions.set === 'function') {
+            this.redis = redisOptions;
+        }
+        else {
+            this.redis = new ioredis_1.default(redisOptions);
+        }
+    }
+    async acquire(options) {
+        const { key, ttl = 30000, retry } = options;
+        const identifier = Math.random().toString(36).substring(2);
+        const attempt = async () => {
+            const result = await this.redis.set(key, identifier, 'PX', ttl, 'NX');
+            if (result === 'OK') {
+                return new RedisLock(this, key, identifier);
+            }
+            return null;
+        };
+        let lock = await attempt();
+        if (lock)
+            return lock;
+        if (retry) {
+            for (let i = 0; i < retry.attempts; i++) {
+                await new Promise((resolve) => setTimeout(resolve, retry.delay));
+                lock = await attempt();
+                if (lock)
+                    return lock;
+            }
+        }
+        return null;
+    }
+    async release(key, identifier) {
+        const script = `
+      if redis.call("get", KEYS[1]) == ARGV[1] then
+        return redis.call("del", KEYS[1])
+      else
+        return 0
+      end
+    `;
+        await this.redis.eval(script, 1, key, identifier);
+    }
+    async extend(key, identifier, ttl) {
+        const script = `
+      if redis.call("get", KEYS[1]) == ARGV[1] then
+        return redis.call("pexpire", KEYS[1], ARGV[2])
+      else
+        return 0
+      end
+    `;
+        const result = await this.redis.eval(script, 1, key, identifier, ttl);
+        return result === 1;
+    }
+    async close() {
+        await this.redis.quit();
+    }
+}
+exports.RedisLockBackend = RedisLockBackend;
+//# sourceMappingURL=redis-backend.js.map

package/dist/backends/redis-backend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-backend.js","sourceRoot":"","sources":["../../src/backends/redis-backend.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA4B;AAG5B,MAAa,SAAS;IACpB,YACmB,OAAyB,EACzB,GAAW,EACX,UAAkB;QAFlB,YAAO,GAAP,OAAO,CAAkB;QACzB,QAAG,GAAH,GAAG,CAAQ;QACX,eAAU,GAAV,UAAU,CAAQ;IAClC,CAAC;IAEJ,KAAK,CAAC,OAAO;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;CACF;AAdD,8BAcC;AAED,MAAa,gBAAgB;IAG3B,YAAY,YAAqB;QAC/B,IAAI,YAAY,IAAI,OAAQ,YAAwC,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;YACxF,IAAI,CAAC,KAAK,GAAG,YAAqB,CAAC;QACrC,CAAC;aAAM,CAAC;YAEN,IAAI,CAAC,KAAK,GAAG,IAAI,iBAAK,CAAC,YAAmB,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAoB;QAChC,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,KAAK,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAE3D,MAAM,OAAO,GAAG,KAAK,IAA2B,EAAE;YAEhD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YACtE,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBACpB,OAAO,IAAI,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;YAC9C,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;QAEF,IAAI,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;QAC3B,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC;QAEtB,IAAI,KAAK,EAAE,CAAC;YACV,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC;gBACxC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;gBACjE,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;gBACvB,IAAI,IAAI;oBAAE,OAAO,IAAI,CAAC;YACxB,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,UAAkB;QAE3C,MAAM,MAAM,GAAG;;;;;;KAMd,CAAC;QACF,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,UAAkB,EAAE,GAAW;QACvD,MAAM,MAAM,GAAG;;;;;;KAMd,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;QACtE,OAAO,MAAM,KAAK,CAAC,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;CACF;AAlED,4CAkEC"}

package/dist/backends/redis-backend.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/backends/redis-backend.test.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const redis_backend_1 = require("./redis-backend");
+describe('RedisLockBackend', () => {
+    let backend;
+    let redis;
+    beforeEach(() => {
+        redis = {
+            set: jest.fn(),
+            eval: jest.fn(),
+            quit: jest.fn().mockResolvedValue('OK'),
+        };
+        backend = new redis_backend_1.RedisLockBackend(redis);
+    });
+    it('should acquire a lock', async () => {
+        redis.set.mockResolvedValue('OK');
+        const lock = await backend.acquire({ key: 'test-lock', ttl: 1000 });
+        expect(lock).not.toBeNull();
+        expect(redis.set).toHaveBeenCalledWith('test-lock', expect.any(String), 'PX', 1000, 'NX');
+    });
+    it('should return null if lock acquisition fails', async () => {
+        redis.set.mockResolvedValue(null);
+        const lock = await backend.acquire({ key: 'test-lock', ttl: 1000 });
+        expect(lock).toBeNull();
+    });
+    it('should release a lock using eval', async () => {
+        redis.set.mockResolvedValue('OK');
+        const lock = await backend.acquire({ key: 'test-lock', ttl: 1000 });
+        await lock?.release();
+        expect(redis.eval).toHaveBeenCalled();
+    });
+    it('should extend a lock using eval', async () => {
+        redis.set.mockResolvedValue('OK');
+        const lock = await backend.acquire({ key: 'test-lock', ttl: 1000 });
+        redis.eval.mockResolvedValue(1);
+        const extended = await lock?.extend(2000);
+        expect(extended).toBe(true);
+        expect(redis.eval).toHaveBeenCalled();
+    });
+});
+//# sourceMappingURL=redis-backend.test.js.map

package/dist/backends/redis-backend.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-backend.test.js","sourceRoot":"","sources":["../../src/backends/redis-backend.test.ts"],"names":[],"mappings":";;AAAA,mDAAmD;AAEnD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,IAAI,OAAyB,CAAC;IAC9B,IAAI,KAAU,CAAC;IAEf,UAAU,CAAC,GAAG,EAAE;QACd,KAAK,GAAG;YACN,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;YACd,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;YACf,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC;SACxC,CAAC;QACF,OAAO,GAAG,IAAI,gCAAgB,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAMH,EAAE,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;QACrC,KAAK,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAElC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QAEpE,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC5B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,KAAK,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAElC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QAEpE,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAChD,KAAK,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QAEpE,MAAM,IAAI,EAAE,OAAO,EAAE,CAAC;QAEtB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,KAAK,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QAEpE,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,QAAQ,GAAG,MAAM,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAE1C,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}