better-lock 1.0.0 → 2.0.1-beta

package/README.md

@@ -6,6 +6,7 @@ A (better) node.js lock library.
 
 ### Features
 
+- Typescript-ready
 - Named and keyed locks
 - Queue and execution timeouts
 - Queue size limit
@@ -29,28 +30,25 @@ npm install --save better-lock
 
 ```javascript
 const lock = new BetterLock();
-//...
-lock
-  .acquire(() => {
-    // Inside the lock. Just make sure you return a promise
-    return doSomethingThatReturnsPromise()
-      .then(() => {
-         return 'my result';
-      });
-  })
-  .then(
-    res => {
-      // Outside the lock. You will get whatever the promise chain has returned.
-      console.log(res); // my result		
-    },
-    err => {
-      // Either your or BetterLock's error 
+
+try {
+  const res = await lock.acquire(async () => {
+    // Inside the lock. It will stay closed until the promise you return resolves or rejects.
+    await doSomeAsyncTask();
+    return 'my result';
   });
+
+  // Outside the lock. You will get whatever the promise chain has returned.
+  console.log(res); // "my result"
+}
+catch (err) {
+  // Either your or BetterLock's error
+}
 ```
 
 ##### Advanced example
 
-```javascript
+```typescript
 const lock = new BetterLock({
   name: 'FileLock',                  // To be used in error reporting and logging
   log: winstonLogger.debug,          // Give it your logger with appropeiate level
@@ -59,28 +57,30 @@ const lock = new BetterLock({
   queue_size: 1,                     // At most one pending job
 });
 
-function processFile(filename, callback) {
-  lock.acquire(filename, () => {
-    return appendToFile(filename)
-      .then(result => {
-        return updateDb(result);
-      });
-  }).then(result => {
-    callback(null, {
-      status: true,
-      result,
+async function processFile(filename) {
+  try {
+    const result = await lock.acquire(filename, async () => {
+      const appended = await appendToFile(filename);
+      return updateDb(appended);
     });
-  }).catch(err => {
+    return {
+      status: true,
+      result
+    };
+  }
+  catch (err) {
     if (err instanceof BetterLock.QueueOverflowError) {
-      return callback(null, {
-        status: false, // The job was discarded
-      });
+      // The job was discarded
+      return {
+        status: false
+      };
     }
+
     if (err instanceof BetterLock.ExecutionTimeoutError) {
       winstonLogger.warn('Potential swallowed callback! Stack trace to the entry site:', err.stack);
     }
-    return callback(err);
-  });
+    throw err;
+  }
 }
 
 ```
@@ -129,7 +129,7 @@ lock.acquire(done => {
   // Outside the lock
   if (err) {
     // Either your or BetterLock's error
-    console.error(err); 
+    console.error(err);
   }
 });
 ```
@@ -139,16 +139,17 @@ You can see a bunch more usage examples in the spec file, [here](spec/better_loc
 ### API
 
 - `new BetterLock(options)`  
-  Create a new instance of `BetterLock`. Options should match interface of `BetterLockOptions`. See below for details.
+  Create a new instance of `BetterLock`. Options should match interface `BetterLockOptions`. See below for details.
 
 - `BetterLock.acquire([key], executor, [callback], [jobOptions])`  
-  The main method you'll want to call. For each `key`, given `executor` will be called only one at a time. Returns a promise that will be resolved with whatever `executor` returns.
+  The main method you'll want to call. For each `key`, given `executor` will be called only one at a time. If you don't provide `callback`, it will return a promise that will be resolved with whatever `executor` returns.
+
   - `key`: Arbitrary string under which to lock. It allows you to use the same lock instance for multiple parallel concerns. Eg. this might be a database record id or filename.
   - `executor`: Function that will be called within the lock. This function should have one of two forms.
-    1. *Without arguments*, in which case it should return a promise. Lock will remain locked until the promise resolves.
-    2. *With single `done`* argument. In this case, the executor should call `done(err, res)` once it is done. Arguments passed to done will be passed to the callback of the lock.
+    1. _Without arguments_, in which case it should return a promise. Lock will remain locked until the promise resolves.
+    2. _With single `done`_ argument. In this case, the executor should call `done(err, res)` once it is done. Arguments passed to done will be passed to the callback of the lock.
   - `callback`: Optional callback that will be called once executor exits. Results from executor (resolved/rejected value or arguments given to `done`) will be passed along. This can be used in addition to the returned promise.
-  - `jobOptions`: An object that should match interface of `LockJobOptions`. A subset of main options that will serve as overrides for this particular job (for example, timeout settings).
+  - `jobOptions`: An object that should match interface `BetterLockJobOptions`. A subset of main options that will serve as overrides for this particular job (for example, timeout settings).
 
 - `BetterLock.canAcquire([key])`  
   Returns true if given key can be acquired.
@@ -159,10 +160,9 @@ You can see a bunch more usage examples in the spec file, [here](spec/better_loc
 - `BetterLock.abortAll()`  
   Abort all jobs for all keys. This is suitable to be called during shutdown of your app.
 
-
 ### Options
 
-All available options with defaults can be seen [here](src/options.js).
+All available options can be seen [here](src/options.ts).
 
 `BetterLockOptions` are provided when you construct a lock instance. A subset of options given in `LockJobOptions` can be provided when you call `lock.acquire`, as the last argument.
 
@@ -188,13 +188,13 @@ Most commonly used options are:
 
 Options are presented using `snake_case`, but you can also provide them using `camelCase` keys, if that better suits your code style (eg. `extend_stack_traces` becomes `extendStackTraces`).
 
-During runtime, you can change the defaults like this:
+Default options are a static member `DEFAULT_OPTIONS` on the `BetterLock` class. That can be seen [here](src/better_lock.ts). During runtime, you can change the defaults like this:
 
 ```javascript
-const BetterLock = require('better-lock');
+import BetterLock from 'better-lock';
 
 BetterLock.DEFAULT_OPTIONS.wait_timeout = 1000;
-``` 
+```
 
 ### Motivation
 
@@ -223,20 +223,69 @@ Following features are present in `async-lock`, but not here:
 
 ### Change log
 
-Date|Version|Change
-----|-------|------
-2018/06/04|0.1.1|You can now use a Number as job name
-2018/09/27|0.2.0|Code reformat, better pattern for loading options. No feature upgrades.
-2018/09/27|0.2.1|Better and customizable Promise detection. Restored DEFAULT_OPTIONS.
-2018/10/01|0.3.0|Can abort jobs waiting in queue.
-2018/10/01|0.3.1|Updated CI to use the current node versions (0.8 & 0.10). Older node versions should continue to work, but are no longer tested. Also, README updates.
-2019/01/28|1.0.0|Major update. Added multi-key locks and refactored a bunch of internals. Removed `OVERFLOW_STRATEGIES` and related options, which is mostly the reason for the major version bump. The library should otherwise work the same.
+#### **0.1.1** (_2018/06/04_)
+
+You can now use a Number as job name
+
+#### **0.2.0** (_2018/09/27_)
+
+Code reformat, better pattern for loading options. No feature upgrades.
+
+#### **0.2.1** (_2018/09/27_)
+
+- Better and customizable Promise detection.
+- Restored DEFAULT_OPTIONS.
+
+#### **0.3.0** (_2018/10/01_)
+
+Can abort jobs waiting in queue.
+
+#### **0.3.1** (_2018/10/01_)
+
+Updated CI to use the current node versions (0.8 & 0.10). Older node versions should continue to work, but are no longer tested. Also, README updates.
+
+#### **1.0.0** (_2019/01/28_)
+
+Major version bump.
+
+- Added multi-key locks and refactored a bunch of internals.
+- Removed `OVERFLOW_STRATEGIES` and related options, which is mostly the reason for the major version bump. The library should otherwise work the same.
+
+#### **1.0.1** (_2019/01/28_)
+
+Handle empty key list
+
+#### **2.0.0** (_2021/05/30_)
+
+Major update. The entire library was rewritten in typescript, so you should now get typings in most editors. We also had to switch tests from mocha + chai to jest (easier ts integration).
+
+The API and features have remained largely the same, just a bit of a refresh.
+
+Non-breaking and internal changes:
+
+- We now export all error names as a type script type. A few other types as well.
+- Errors now have `name` parameter, which matches these names.
+
+Breaking changes:
+
+- You can no longer use camel case versions of external-facing objects. Eg. you can no longer pass `waitTimeout` instead of `wait_timeout`. In retrospect, this was a pretty flaky API to maintain.
+
+- Internal `LockJob` class is no longer exported.
+
+- Also, errors no longer expose internal `LockJob` instances (`err.job`). We now instead provide the most important fields from the job (`id` and `keys`).
+
+- Error names have been renamed to have `BetterLock` prefix. Eg. `WaitTimeoutError` -> `BetterLockWaitTimeoutError`. This will influence `err.name` and `err.message` parameters. The idea here is, if you see `BetterLock` error in the wild, you will know what generated it.
+
+- We have renamed `BetterLock.BetterLockError` to `BetterLock.BaseError` and `BetterLock.BetterLockInternalError` to `BetterLock.InternalError` to better match the naming scheme.
+
+- Since Options are no longer a class but interface, we are no longer exporting them under `BetterLock.Options`. You can do `import {BetterLockOptions} from 'better-lock';` to get the typescript type.
 
 ### Development
 
 Fork, then git clone. The project is already set up with a WebStorm project, if that's your cup of tee.
 
 To run tests, with coverage:
+
 ```
 npm run test
 ```
@@ -245,4 +294,4 @@ If you want to contribute, create a branch off master, do your work and then mak
 
 ## License
 
-[MIT](./LICENSE)
+[MIT](./LICENSE)

package/dist/better_lock.d.ts

@@ -0,0 +1,50 @@
+import { ILockJobOptions, IOptions } from './options';
+import { ICallback, ICallbackExecutor, ILockKey, IPromiseExecutor } from './types';
+/**
+ * Create a better lock object.
+ */
+export declare class BetterLock {
+    /**
+     * Default options to be used when creating BetterLock instances.
+     */
+    static DEFAULT_OPTIONS: IOptions;
+    private options;
+    private log;
+    private queues;
+    constructor(options?: IOptions);
+    /**
+     * Return or create a key queue for given key
+     */
+    private getQueue;
+    /**
+     * Returns true if the caller can *immediately* acquire the lock. There is nothing holding the key and nothing in the queue.
+     */
+    canAcquire(key?: string): boolean;
+    private normalizeAndValidateKey;
+    acquire<TResult>(executor: IPromiseExecutor<TResult>, jobOptions?: ILockJobOptions): Promise<TResult>;
+    acquire<TResult>(executor: ICallbackExecutor<TResult>, jobOptions?: ILockJobOptions): Promise<TResult>;
+    acquire<TResult>(executor: ICallbackExecutor<TResult>, callback: ICallback<TResult>, jobOptions?: ILockJobOptions): void;
+    acquire<TResult>(key: ILockKey | Array<ILockKey>, executor: IPromiseExecutor<TResult>, jobOptions?: ILockJobOptions): Promise<TResult>;
+    acquire<TResult>(key: ILockKey | Array<ILockKey>, executor: ICallbackExecutor<TResult>, jobOptions?: ILockJobOptions): Promise<TResult>;
+    acquire<TResult>(key: ILockKey | Array<ILockKey>, executor: ICallbackExecutor<TResult>, callback: ICallback<TResult>, jobOptions?: ILockJobOptions): void;
+    /**
+     * Update state of given list of queues.
+     */
+    private update;
+    private executeJob;
+    private onWaitTimeout;
+    private onExecutionTimeout;
+    private endJob;
+    /**
+     * Abort all jobs for a given key (or from the default job queue, if no key is given).
+     * Job executors will not be called. Callbacks will be called with JobAbortedError.
+     * Currently executing job will not be interrupted.
+     * @param [key]
+     */
+    abort(key?: ILockKey): void;
+    /**
+     * Abort all pending jobs from all queues.
+     * Currently executing jobs will not be interrupted.
+     */
+    abortAll(): void;
+}

package/dist/better_lock.js

@@ -0,0 +1,317 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BetterLock = void 0;
+var errors_1 = require("./errors");
+var internals_1 = require("./internals");
+var tools = require("./tools");
+/**
+ * Create a better lock object.
+ */
+var BetterLock = /** @class */ (function () {
+    function BetterLock(options) {
+        this.options = tools.assign({}, [BetterLock.DEFAULT_OPTIONS, options]);
+        this.log = tools.makeLog(this.options.name, this.options.log);
+        this.queues = {};
+    }
+    /**
+     * Return or create a key queue for given key
+     */
+    BetterLock.prototype.getQueue = function (key) {
+        if (key === undefined || key === null) {
+            key = internals_1.KeyQueue.DEFAULT_QUEUE_KEY;
+        }
+        var queue = this.queues[key];
+        if (!queue) {
+            queue = this.queues[key] = new internals_1.KeyQueue(String(key));
+        }
+        return queue;
+    };
+    /**
+     * Returns true if the caller can *immediately* acquire the lock. There is nothing holding the key and nothing in the queue.
+     */
+    BetterLock.prototype.canAcquire = function (key) {
+        var queue = this.getQueue(key);
+        return !queue.active && !queue.jobs.length;
+    };
+    BetterLock.prototype.normalizeAndValidateKey = function (key) {
+        if (key === undefined) {
+            return null;
+        }
+        if (key === null) {
+            return null;
+        }
+        if (tools.isString(key)) {
+            return key;
+        }
+        if (tools.isNumber(key)) {
+            return String(key);
+        }
+        // Invalid key value
+        throw new errors_1.BetterLockInvalidArgumentError(this.options.name, 'key', 'an instance of ILockKey: string, number, undefined or null', key);
+    };
+    /**
+     * Acquire the lock for given key or list of keys. If waiting on a list, keys will be acquired in order,
+     * as they become free. Any deadlock prevention must be handled by the caller.
+     *
+     * Once the lock is acquired, we will call the executor function, with a "done" method.
+     * You must call "done" to release the lock. Alternatively, return a Promise; lock will be released
+     * once promise resolves or rejects.
+     *
+     * Return values from your executor will be passed to callback (or the resulting promise).
+     *
+     * @param key Named key or array of keys for this particular call. Calls with different keys will be run in parallel. Not required.
+     * @param executor Function that will run inside the lock. Required.
+     * @param callback Function to be called after the executor finishes or if we never enter the lock (timeout, queue depletion). Leave out to use promises.
+     * @param jobOptions Options to be applied on this job only
+     */
+    BetterLock.prototype.acquire = function (key, executor, callback, jobOptions) {
+        var _this = this;
+        if (tools.isFunction(key) || tools.isObject(key)) {
+            // Presume we weren't given a key (first form)
+            jobOptions = callback;
+            callback = executor;
+            executor = key;
+            key = null;
+        }
+        // Repackage "key" into an array of keys
+        var keys = [];
+        if (Array.isArray(key)) {
+            var arrayOfKeys = key;
+            // Make sure we don't add duplicates
+            var seenKeys = new Set();
+            for (var i = 0; i < arrayOfKeys.length; i++) {
+                var normalizedKey = this.normalizeAndValidateKey(arrayOfKeys[i]);
+                if (!seenKeys.has(normalizedKey)) {
+                    keys.push(normalizedKey);
+                    seenKeys.add(normalizedKey);
+                }
+            }
+        }
+        else {
+            keys.push(this.normalizeAndValidateKey(key));
+        }
+        // Create callback wrapper for promise interface
+        if (!tools.isFunction(callback)) {
+            if (jobOptions === undefined) {
+                jobOptions = callback;
+            }
+            callback = tools.callbackWithPromise();
+        }
+        // Validate other options
+        if (!tools.isFunction(executor)) {
+            throw new errors_1.BetterLockInvalidArgumentError(this.options.name, 'executor', 'a function', executor);
+        }
+        if (!tools.isFunction(callback)) {
+            throw new errors_1.BetterLockInvalidArgumentError(this.options.name, 'callback', 'a function', callback);
+        }
+        // Prepare job options
+        var effectiveJobOptions = jobOptions
+            ? tools.assign({}, [this.options, jobOptions])
+            : // No need to create new object since these will be read-only and are subset of global options
+                this.options;
+        var job = new internals_1.LockJob(keys, executor, callback, effectiveJobOptions);
+        // Set incoming stack
+        if (effectiveJobOptions.extend_stack_traces) {
+            var tempErr = new Error();
+            Error.captureStackTrace(tempErr, this.acquire);
+            job.incoming_stack = tempErr.stack;
+        }
+        // Add job to its key queues
+        var queuesToUpdate = [];
+        for (var i = 0; i < keys.length; i++) {
+            var queue = this.getQueue(keys[i]);
+            queue.jobs.push(job);
+            queuesToUpdate.push(queue);
+        }
+        // Start wait timer, if enabled
+        if (tools.isNumber(job.options.wait_timeout)) {
+            job.wait_timeout_id = setTimeout(function () { return _this.onWaitTimeout(job); }, job.options.wait_timeout);
+            // NOTE: timeout of 0 will NOT trigger error if lock can be acquired immediately.
+        }
+        this.log("Enqueued " + job);
+        // Perform update of queues this job has modified. We don't do this in next tick or something,
+        // because we want canAcquire to immediately return false
+        if (queuesToUpdate.length) {
+            this.update(queuesToUpdate);
+        }
+        else {
+            // Special case. We are given empty list of keys. We will immediately execute jobs like this.
+            this.executeJob(job);
+        }
+        return callback.promise;
+    };
+    /**
+     * Update state of given list of queues.
+     */
+    BetterLock.prototype.update = function (queues) {
+        for (var i = 0; i < queues.length; i++) {
+            var queue = queues[i];
+            // If key is available, have next job grab it
+            if (!queue.active && queue.jobs.length) {
+                var job = queue.jobs.splice(0, 1)[0];
+                queue.active = job;
+                job.waiting_count--;
+                if (job.waiting_count <= 0) {
+                    // This job can be executed now.
+                    this.executeJob(job);
+                }
+            }
+            // Handle wait queue overflow
+            if (tools.isNumber(this.options.queue_size) && this.options.queue_size < queue.jobs.length) {
+                // Overflow. Reject the most recent job
+                var mostRecentJob = queue.jobs[queue.jobs.length - 1];
+                this.log(queue.toString() + " has overflown, so most recent job (" + mostRecentJob + ") was kicked out");
+                this.endJob(mostRecentJob, [
+                    new errors_1.BetterLockQueueOverflowError(this.options.name, queue.key, queue.jobs.length, mostRecentJob),
+                ]);
+            }
+        }
+    };
+    BetterLock.prototype.executeJob = function (job) {
+        var _this = this;
+        this.log("Executing " + job);
+        // Clear wait timeout
+        clearTimeout(job.wait_timeout_id);
+        job.wait_timeout_id = null;
+        // We want to do the rest of this in a separate context, because we don't want user executor code
+        // to ever interfere with the code calling acquire().
+        setImmediate(function () {
+            // Make sure job hasn't been ended in the meantime
+            if (job.executed_at || job.ended_at) {
+                return;
+            }
+            // Validate this job is holding all queues it needs
+            for (var i = 0; i < job.keys.length; i++) {
+                var queue = _this.getQueue(job.keys[i]);
+                if (queue.active !== job) {
+                    // This should never happen
+                    return _this.endJob(job, [
+                        new errors_1.BetterLockInternalError(_this.options.name, "Corrupted wait queue state for " + queue.key),
+                    ]);
+                }
+            }
+            // Mark job as having started executing
+            job.executed_at = new Date();
+            if (tools.isNumber(job.options.execution_timeout)) {
+                job.execution_timeout_id = setTimeout(function () { return _this.onExecutionTimeout(job); }, job.options.execution_timeout);
+            }
+            var lockDone = function () {
+                var args = [];
+                for (var _i = 0; _i < arguments.length; _i++) {
+                    args[_i] = arguments[_i];
+                }
+                _this.log("Done called for " + job);
+                _this.endJob(job, args);
+            };
+            if (job.executor.length > 0) {
+                // Callback interface
+                job.executor(lockDone);
+                return;
+            }
+            // Promise interface
+            var executorResult;
+            try {
+                executorResult = job.executor();
+            }
+            catch (err) {
+                // Error thrown directly from executor
+                lockDone(err);
+            }
+            // Promise sniffing
+            if (_this.options.promise_tester(executorResult)) {
+                executorResult.then(function (res) { return lockDone(null, res); }, function (err) { return lockDone(err); });
+            }
+            else {
+                // "promise" is just some random value. We don't have to wait
+                lockDone(null, executorResult);
+            }
+        });
+    };
+    BetterLock.prototype.onWaitTimeout = function (job) {
+        this.log(job + " has timed out after waiting in queue for " + (new Date().valueOf() - job.enqueued_at.valueOf()) + "ms");
+        this.endJob(job, [new errors_1.BetterLockWaitTimeoutError(this.options.name, job)]);
+    };
+    BetterLock.prototype.onExecutionTimeout = function (job) {
+        this.log(job + " has timed out after executing for " + (new Date().valueOf() - job.executed_at.valueOf()) + "ms");
+        this.endJob(job, [new errors_1.BetterLockExecutionTimeoutError(this.options.name, job)]);
+    };
+    BetterLock.prototype.endJob = function (job, callbackArgs) {
+        var _this = this;
+        if (job.ended_at) {
+            this.log("WARNING: " + job + " is trying to end, but it has already ended at " + job.ended_at.toISOString() + ". Called with arguments: " + callbackArgs);
+            return;
+        }
+        clearTimeout(job.wait_timeout_id);
+        job.wait_timeout_id = null;
+        clearTimeout(job.execution_timeout_id);
+        job.execution_timeout_id = null;
+        job.ended_at = new Date();
+        var queuesToUpdate = [];
+        for (var i = 0; i < job.keys.length; i++) {
+            var queue = this.getQueue(job.keys[i]);
+            queuesToUpdate.push(queue);
+            if (queue.active === job) {
+                // This job was holding on the queue's key
+                queue.active = null;
+            }
+            else {
+                // This job was still in wait list for this queue
+                var index = queue.jobs.indexOf(job);
+                if (index >= 0) {
+                    // Remove from queue
+                    queue.jobs.splice(index, 1);
+                }
+                else {
+                    // Something is wrong. Where did this job come from?
+                    this.log("WARNING: " + job + " is ending, but it is not found anywhere in the queue for " + queue.key);
+                }
+            }
+        }
+        // Call the callback
+        try {
+            job.callback.apply(null, callbackArgs);
+        }
+        finally {
+            // Whatever happens, schedule a queue update
+            setImmediate(function () { return _this.update(queuesToUpdate); });
+        }
+    };
+    /**
+     * Abort all jobs for a given key (or from the default job queue, if no key is given).
+     * Job executors will not be called. Callbacks will be called with JobAbortedError.
+     * Currently executing job will not be interrupted.
+     * @param [key]
+     */
+    BetterLock.prototype.abort = function (key) {
+        var _this = this;
+        var queue = this.getQueue(key);
+        queue.jobs.slice().forEach(function (job) {
+            _this.endJob(job, [new errors_1.BetterLockJobAbortedError(_this.options.name, job)]);
+        });
+        if (queue.active && !queue.active.executed_at) {
+            // If we have a job holding this queue that hasn't been executed yet, abort it as well
+            this.endJob(queue.active, [new errors_1.BetterLockJobAbortedError(this.options.name, queue.active)]);
+        }
+    };
+    /**
+     * Abort all pending jobs from all queues.
+     * Currently executing jobs will not be interrupted.
+     */
+    BetterLock.prototype.abortAll = function () {
+        this.abort(null);
+        for (var key in this.queues) {
+            // noinspection JSUnfilteredForInLoop
+            this.abort(key);
+        }
+    };
+    /**
+     * Default options to be used when creating BetterLock instances.
+     */
+    BetterLock.DEFAULT_OPTIONS = {
+        extend_stack_traces: true,
+        promise_tester: function (p) { return p && typeof p.then === 'function'; },
+    };
+    return BetterLock;
+}());
+exports.BetterLock = BetterLock;
+//# sourceMappingURL=better_lock.js.map

package/dist/better_lock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"better_lock.js","sourceRoot":"","sources":["../src/better_lock.ts"],"names":[],"mappings":";;;AAAA,mCAOkB;AAClB,yCAAgD;AAEhD,+BAAiC;AAGjC;;GAEG;AACH;IAaE,oBAAY,OAAkB;QAC5B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9D,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IACnB,CAAC;IAED;;OAEG;IACK,6BAAQ,GAAhB,UAAiB,GAAa;QAC5B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACrC,GAAG,GAAG,oBAAQ,CAAC,iBAAiB,CAAC;SAClC;QACD,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,KAAK,EAAE;YACV,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,oBAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;SACtD;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,+BAAU,GAAjB,UAAkB,GAAY;QAC5B,IAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACjC,OAAO,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;IAC7C,CAAC;IAEO,4CAAuB,GAA/B,UAAgC,GAAa;QAC3C,IAAI,GAAG,KAAK,SAAS,EAAE;YACrB,OAAO,IAAI,CAAC;SACb;QACD,IAAI,GAAG,KAAK,IAAI,EAAE;YAChB,OAAO,IAAI,CAAC;SACb;QACD,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACvB,OAAO,GAAG,CAAC;SACZ;QACD,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACvB,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;SACpB;QACD,oBAAoB;QACpB,MAAM,IAAI,uCAA8B,CACtC,IAAI,CAAC,OAAO,CAAC,IAAI,EACjB,KAAK,EACL,4DAA4D,EAC5D,GAAG,CACJ,CAAC;IACJ,CAAC;IA+BD;;;;;;;;;;;;;;OAcG;IACI,4BAAO,GAAd,UAAe,GAAG,EAAE,QAAS,EAAE,QAAS,EAAE,UAAW;QAArD,iBA+FC;QA9FC,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAChD,8CAA8C;YAC9C,UAAU,GAAG,QAAQ,CAAC;YACtB,QAAQ,GAAG,QAAQ,CAAC;YACpB,QAAQ,GAAG,GAAG,CAAC;YACf,GAAG,GAAG,IAAI,CAAC;SACZ;QAED,wCAAwC;QACxC,IAAM,IAAI,GAAG,EAAE,CAAC;QAChB,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,IAAM,WAAW,GAAG,GAAG,CAAC;YACxB,oCAAoC;YACpC,IAAM,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;YAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC3C,IAAM,aAAa,GAAG,IAAI,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE;oBAChC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;oBACzB,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;iBAC7B;aACF;SACF;aAAM;YACL,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC;SAC9C;QAED,gDAAgD;QAChD,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YAC/B,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC5B,UAAU,GAAG,QAAQ,CAAC;aACvB;YAED,QAAQ,GAAG,KAAK,CAAC,mBAAmB,EAAE,CAAC;SACxC;QAED,yBAAyB;QACzB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YAC/B,MAAM,IAAI,uCAA8B,CACtC,IAAI,CAAC,OAAO,CAAC,IAAI,EACjB,UAAU,EACV,YAAY,EACZ,QAAQ,CACT,CAAC;SACH;QACD,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YAC/B,MAAM,IAAI,uCAA8B,CACtC,IAAI,CAAC,OAAO,CAAC,IAAI,EACjB,UAAU,EACV,YAAY,EACZ,QAAQ,CACT,CAAC;SACH;QAED,sBAAsB;QACtB,IAAM,mBAAmB,GAAG,UAAU;YACpC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YAC9C,CAAC,CAAC,8FAA8F;gBAC9F,IAAI,CAAC,OAAO,CAAC;QAEjB,IAAM,GAAG,GAAG,IAAI,mBAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,mBAAmB,CAAC,CAAC;QAEvE,qBAAqB;QACrB,IAAI,mBAAmB,CAAC,mBAAmB,EAAE;YAC3C,IAAM,OAAO,GAAG,IAAI,KAAK,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAC/C,GAAG,CAAC,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC;SACpC;QAED,4BAA4B;QAC5B,IAAM,cAAc,GAAG,EAAE,CAAC;QAC1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACpC,IAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACrC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrB,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SAC5B;QAED,+BAA+B;QAC/B,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YAC5C,GAAG,CAAC,eAAe,GAAG,UAAU,CAAC,cAAM,OAAA,KAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAvB,CAAuB,EAAE,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YAE1F,iFAAiF;SAClF;QAED,IAAI,CAAC,GAAG,CAAC,cAAY,GAAK,CAAC,CAAC;QAE5B,8FAA8F;QAC9F,yDAAyD;QACzD,IAAI,cAAc,CAAC,MAAM,EAAE;YACzB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;SAC7B;aAAM;YACL,6FAA6F;YAC7F,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SACtB;QAED,OAAQ,QAAgB,CAAC,OAAO,CAAC;IACnC,CAAC;IAED;;OAEG;IACK,2BAAM,GAAd,UAAe,MAAkB;QAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACtC,IAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YAExB,6CAA6C;YAC7C,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE;gBACtC,IAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvC,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC;gBACnB,GAAG,CAAC,aAAa,EAAE,CAAC;gBAEpB,IAAI,GAAG,CAAC,aAAa,IAAI,CAAC,EAAE;oBAC1B,gCAAgC;oBAChC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;iBACtB;aACF;YAED,6BAA6B;YAC7B,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE;gBAC1F,uCAAuC;gBACvC,IAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBACxD,IAAI,CAAC,GAAG,CACH,KAAK,CAAC,QAAQ,EAAE,4CAAuC,aAAa,qBAAkB,CAC1F,CAAC;gBAEF,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;oBACzB,IAAI,qCAA4B,CAC9B,IAAI,CAAC,OAAO,CAAC,IAAI,EACjB,KAAK,CAAC,GAAG,EACT,KAAK,CAAC,IAAI,CAAC,MAAM,EACjB,aAAa,CACd;iBACF,CAAC,CAAC;aACJ;SACF;IACH,CAAC;IAEO,+BAAU,GAAlB,UAAmB,GAAiB;QAApC,iBAwEC;QAvEC,IAAI,CAAC,GAAG,CAAC,eAAa,GAAK,CAAC,CAAC;QAE7B,qBAAqB;QACrB,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAClC,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC;QAE3B,iGAAiG;QACjG,qDAAqD;QAErD,YAAY,CAAC;YACX,kDAAkD;YAClD,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,QAAQ,EAAE;gBACnC,OAAO;aACR;YAED,mDAAmD;YACnD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACxC,IAAM,KAAK,GAAG,KAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBACzC,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,EAAE;oBACxB,2BAA2B;oBAC3B,OAAO,KAAI,CAAC,MAAM,CAAC,GAAG,EAAE;wBACtB,IAAI,gCAAuB,CACzB,KAAI,CAAC,OAAO,CAAC,IAAI,EACjB,oCAAkC,KAAK,CAAC,GAAK,CAC9C;qBACF,CAAC,CAAC;iBACJ;aACF;YAED,uCAAuC;YACvC,GAAG,CAAC,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC;YAE7B,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE;gBACjD,GAAG,CAAC,oBAAoB,GAAG,UAAU,CACnC,cAAM,OAAA,KAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAA5B,CAA4B,EAClC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAC9B,CAAC;aACH;YAED,IAAM,QAAQ,GAAG;gBAAC,cAAO;qBAAP,UAAO,EAAP,qBAAO,EAAP,IAAO;oBAAP,yBAAO;;gBACvB,KAAI,CAAC,GAAG,CAAC,qBAAmB,GAAK,CAAC,CAAC;gBAEnC,KAAI,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACzB,CAAC,CAAC;YAEF,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC3B,qBAAqB;gBACrB,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBACvB,OAAO;aACR;YAED,oBAAoB;YACpB,IAAI,cAAc,CAAC;YACnB,IAAI;gBACF,cAAc,GAAI,GAAG,CAAC,QAAgB,EAAE,CAAC;aAC1C;YAAC,OAAO,GAAG,EAAE;gBACZ,sCAAsC;gBACtC,QAAQ,CAAC,GAAG,CAAC,CAAC;aACf;YAED,mBAAmB;YACnB,IAAI,KAAI,CAAC,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE;gBAC/C,cAAc,CAAC,IAAI,CACjB,UAAA,GAAG,IAAI,OAAA,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,EAAnB,CAAmB,EAC1B,UAAA,GAAG,IAAI,OAAA,QAAQ,CAAC,GAAG,CAAC,EAAb,CAAa,CACrB,CAAC;aACH;iBAAM;gBACL,6DAA6D;gBAC7D,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;aAChC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,kCAAa,GAArB,UAAsB,GAAiB;QACrC,IAAI,CAAC,GAAG,CACH,GAAG,mDACJ,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC,WAAW,CAAC,OAAO,EAAE,QAC9C,CACL,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,mCAA0B,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IAEO,uCAAkB,GAA1B,UAA2B,GAAiB;QAC1C,IAAI,CAAC,GAAG,CACH,GAAG,4CACJ,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC,WAAW,CAAC,OAAO,EAAE,QAC9C,CACL,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,wCAA+B,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAClF,CAAC;IAEO,2BAAM,GAAd,UAAe,GAAiB,EAAE,YAAmB;QAArD,iBA8CC;QA7CC,IAAI,GAAG,CAAC,QAAQ,EAAE;YAChB,IAAI,CAAC,GAAG,CACN,cAAY,GAAG,uDAAkD,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,iCAA4B,YAAc,CACtI,CAAC;YACF,OAAO;SACR;QAED,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAClC,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC;QAE3B,YAAY,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QACvC,GAAG,CAAC,oBAAoB,GAAG,IAAI,CAAC;QAEhC,GAAG,CAAC,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC;QAE1B,IAAM,cAAc,GAAG,EAAE,CAAC;QAC1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACxC,IAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACzC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAE3B,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,EAAE;gBACxB,0CAA0C;gBAC1C,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;aACrB;iBAAM;gBACL,iDAAiD;gBACjD,IAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACtC,IAAI,KAAK,IAAI,CAAC,EAAE;oBACd,oBAAoB;oBACpB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;iBAC7B;qBAAM;oBACL,oDAAoD;oBACpD,IAAI,CAAC,GAAG,CACN,cAAY,GAAG,kEAA6D,KAAK,CAAC,GAAK,CACxF,CAAC;iBACH;aACF;SACF;QAED,oBAAoB;QACpB,IAAI;YACF,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;SACxC;gBAAS;YACR,4CAA4C;YAC5C,YAAY,CAAC,cAAM,OAAA,KAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAA3B,CAA2B,CAAC,CAAC;SACjD;IACH,CAAC;IAED;;;;;OAKG;IACI,0BAAK,GAAZ,UAAa,GAAc;QAA3B,iBASC;QARC,IAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACjC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,UAAA,GAAG;YAC5B,KAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,kCAAyB,CAAC,KAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;QACH,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE;YAC7C,sFAAsF;YACtF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,kCAAyB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SAC7F;IACH,CAAC;IAED;;;OAGG;IACI,6BAAQ,GAAf;QACE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACjB,KAAK,IAAM,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE;YAC7B,qCAAqC;YACrC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SACjB;IACH,CAAC;IA3ZD;;OAEG;IACI,0BAAe,GAAa;QACjC,mBAAmB,EAAE,IAAI;QACzB,cAAc,EAAE,UAAA,CAAC,IAAI,OAAA,CAAC,IAAI,OAAO,CAAC,CAAC,IAAI,KAAK,UAAU,EAAjC,CAAiC;KACvD,CAAC;IAsZJ,iBAAC;CAAA,AA7ZD,IA6ZC;AA7ZY,gCAAU"}

package/dist/errors.d.ts

@@ -0,0 +1,44 @@
+import { LockJob } from './internals';
+import { IErrorName } from './types';
+export declare class BetterLockError extends Error {
+    /**
+     * Name of the lock that caused the error
+     */
+    lock_name: string;
+    /**
+     * Error name, maps to error's class name. Eg. BetterLockError.
+     */
+    name: IErrorName;
+    constructor(lockName: any, message: any, incomingStack?: any);
+}
+export declare class BetterLockInternalError extends BetterLockError {
+    constructor(lockName: any, message: any);
+}
+export declare class BetterLockInvalidArgumentError extends BetterLockError {
+    argument: any;
+    constructor(lockName: any, argument: any, expected: any, actual: any);
+}
+export declare class BetterLockWaitTimeoutError extends BetterLockError {
+    job_id: number;
+    keys: string[];
+    enqueued_at: Date;
+    constructor(lockName: any, job: LockJob<any>);
+}
+export declare class BetterLockExecutionTimeoutError extends BetterLockError {
+    job_id: number;
+    keys: string[];
+    executed_at: Date;
+    constructor(lockName: any, job: LockJob<any>);
+}
+export declare class BetterLockQueueOverflowError extends BetterLockError {
+    job_id: number;
+    keys: string[];
+    job_count: number;
+    kicked_out_job_id: number;
+    constructor(lockName: any, key: any, count: any, job: LockJob<any>);
+}
+export declare class BetterLockJobAbortedError extends BetterLockError {
+    job_id: number;
+    keys: string[];
+    constructor(lockName: any, job: any);
+}