chore(release): 1.14.1 [skip ci]

## [1.14.1](v1.14.0...v1.14.1) (2021-02-01) ### Bug Fixes * job finish queue events race condition ([355bca5](355bca5))
taskforcesh · Feb 1, 2021 · a14e1ad · a14e1ad
1 parent 355bca5
commit a14e1ad
Show file tree

Hide file tree

Showing 44 changed files with 123 additions and 37 deletions.
diff --git a/docs/gitbook/CHANGELOG.md b/docs/gitbook/CHANGELOG.md
@@ -0,0 +1,6 @@
+## [1.14.1](https://github.com/taskforcesh/bullmq/compare/v1.14.0...v1.14.1) (2021-02-01)
+
+
+### Bug Fixes
+
+* job finish queue events race condition ([355bca5](https://github.com/taskforcesh/bullmq/commit/355bca5ee128bf4ff37608746f9c6f7cca580eb0))
diff --git a/docs/gitbook/api/bullmq.advancedoptions.backoffstrategies.md b/docs/gitbook/api/bullmq.advancedoptions.backoffstrategies.md
@@ -4,6 +4,8 @@
 
 ## AdvancedOptions.backoffStrategies property
 
+A set of custom backoff strategies keyed by name.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.advancedoptions.md b/docs/gitbook/api/bullmq.advancedoptions.md
@@ -14,5 +14,5 @@ export interface AdvancedOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [backoffStrategies?](./bullmq.advancedoptions.backoffstrategies.md) | {} | <i>(Optional)</i> |
+|  [backoffStrategies?](./bullmq.advancedoptions.backoffstrategies.md) | {} | <i>(Optional)</i> A set of custom backoff strategies keyed by name. |
 
diff --git a/docs/gitbook/api/bullmq.backoffoptions.delay.md b/docs/gitbook/api/bullmq.backoffoptions.delay.md
@@ -4,6 +4,8 @@
 
 ## BackoffOptions.delay property
 
+Delay in milliseconds.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.backoffoptions.md b/docs/gitbook/api/bullmq.backoffoptions.md
@@ -4,6 +4,8 @@
 
 ## BackoffOptions interface
 
+Settings for backing off failed jobs.
+
 <b>Signature:</b>
 
 ```typescript
@@ -14,6 +16,6 @@ export interface BackoffOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [delay?](./bullmq.backoffoptions.delay.md) | number | <i>(Optional)</i> |
-|  [type](./bullmq.backoffoptions.type.md) | string |  |
+|  [delay?](./bullmq.backoffoptions.delay.md) | number | <i>(Optional)</i> Delay in milliseconds. |
+|  [type](./bullmq.backoffoptions.type.md) | string | Name of the backoff strategy. |
 
diff --git a/docs/gitbook/api/bullmq.backoffoptions.type.md b/docs/gitbook/api/bullmq.backoffoptions.type.md
@@ -4,6 +4,8 @@
 
 ## BackoffOptions.type property
 
+Name of the backoff strategy.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.jobsoptions.attempts.md b/docs/gitbook/api/bullmq.jobsoptions.attempts.md
@@ -4,6 +4,8 @@
 
 ## JobsOptions.attempts property
 
+The total number of attempts to try the job until it completes.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.jobsoptions.backoff.md b/docs/gitbook/api/bullmq.jobsoptions.backoff.md
@@ -4,6 +4,8 @@
 
 ## JobsOptions.backoff property
 
+Backoff setting for automatic retries if the job fails
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.jobsoptions.delay.md b/docs/gitbook/api/bullmq.jobsoptions.delay.md
@@ -4,6 +4,8 @@
 
 ## JobsOptions.delay property
 
+An amount of miliseconds to wait until this job can be processed. Note that for accurate delays, worker and producers should have their clocks synchronized.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.jobsoptions.jobid.md b/docs/gitbook/api/bullmq.jobsoptions.jobid.md
@@ -4,6 +4,8 @@
 
 ## JobsOptions.jobId property
 
+Override the job ID - by default, the job ID is a unique integer, but you can use this setting to override it. If you use this option, it is up to you to ensure the jobId is unique. If you attempt to add a job with an id that already exists, it will not be added.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.jobsoptions.lifo.md b/docs/gitbook/api/bullmq.jobsoptions.lifo.md
@@ -4,6 +4,8 @@
 
 ## JobsOptions.lifo property
 
+If true, adds the job to the right of the queue instead of the left (default false)
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.jobsoptions.md b/docs/gitbook/api/bullmq.jobsoptions.md
@@ -14,17 +14,17 @@ export interface JobsOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [attempts?](./bullmq.jobsoptions.attempts.md) | number | <i>(Optional)</i> |
-|  [backoff?](./bullmq.jobsoptions.backoff.md) | number \| [BackoffOptions](./bullmq.backoffoptions.md) | <i>(Optional)</i> |
-|  [delay?](./bullmq.jobsoptions.delay.md) | number | <i>(Optional)</i> |
-|  [jobId?](./bullmq.jobsoptions.jobid.md) | string | <i>(Optional)</i> |
-|  [lifo?](./bullmq.jobsoptions.lifo.md) | boolean | <i>(Optional)</i> |
-|  [priority?](./bullmq.jobsoptions.priority.md) | number | <i>(Optional)</i> |
-|  [rateLimiterKey?](./bullmq.jobsoptions.ratelimiterkey.md) | string | <i>(Optional)</i> |
-|  [removeOnComplete?](./bullmq.jobsoptions.removeoncomplete.md) | boolean \| number | <i>(Optional)</i> |
-|  [removeOnFail?](./bullmq.jobsoptions.removeonfail.md) | boolean \| number | <i>(Optional)</i> |
-|  [repeat?](./bullmq.jobsoptions.repeat.md) | [RepeatOptions](./bullmq.repeatoptions.md) | <i>(Optional)</i> |
-|  [stackTraceLimit?](./bullmq.jobsoptions.stacktracelimit.md) | number | <i>(Optional)</i> |
-|  [timeout?](./bullmq.jobsoptions.timeout.md) | number | <i>(Optional)</i> |
-|  [timestamp?](./bullmq.jobsoptions.timestamp.md) | number | <i>(Optional)</i> |
+|  [attempts?](./bullmq.jobsoptions.attempts.md) | number | <i>(Optional)</i> The total number of attempts to try the job until it completes. |
+|  [backoff?](./bullmq.jobsoptions.backoff.md) | number \| [BackoffOptions](./bullmq.backoffoptions.md) | <i>(Optional)</i> Backoff setting for automatic retries if the job fails |
+|  [delay?](./bullmq.jobsoptions.delay.md) | number | <i>(Optional)</i> An amount of miliseconds to wait until this job can be processed. Note that for accurate delays, worker and producers should have their clocks synchronized. |
+|  [jobId?](./bullmq.jobsoptions.jobid.md) | string | <i>(Optional)</i> Override the job ID - by default, the job ID is a unique integer, but you can use this setting to override it. If you use this option, it is up to you to ensure the jobId is unique. If you attempt to add a job with an id that already exists, it will not be added. |
+|  [lifo?](./bullmq.jobsoptions.lifo.md) | boolean | <i>(Optional)</i> If true, adds the job to the right of the queue instead of the left (default false) |
+|  [priority?](./bullmq.jobsoptions.priority.md) | number | <i>(Optional)</i> Ranges from 1 (highest priority) to MAX\_INT (lowest priority). Note that using priorities has a slight impact on performance, so do not use it if not required. |
+|  [rateLimiterKey?](./bullmq.jobsoptions.ratelimiterkey.md) | string | <i>(Optional)</i> Rate limiter key to use if rate limiter enabled. |
+|  [removeOnComplete?](./bullmq.jobsoptions.removeoncomplete.md) | boolean \| number | <i>(Optional)</i> If true, removes the job when it successfully completes When given an number, it specifies the maximum amount of jobs to keep. Default behavior is to keep the job in the completed set. |
+|  [removeOnFail?](./bullmq.jobsoptions.removeonfail.md) | boolean \| number | <i>(Optional)</i> If true, removes the job when it fails after all attempts. When given an number, it specifies the maximum amount of jobs to keep. |
+|  [repeat?](./bullmq.jobsoptions.repeat.md) | [RepeatOptions](./bullmq.repeatoptions.md) | <i>(Optional)</i> Repeat this job, for example based on a <code>cron</code> schedule. |
+|  [stackTraceLimit?](./bullmq.jobsoptions.stacktracelimit.md) | number | <i>(Optional)</i> Limits the amount of stack trace lines that will be recorded in the stacktrace. |
+|  [timeout?](./bullmq.jobsoptions.timeout.md) | number | <i>(Optional)</i> The number of milliseconds after which the job should be fail with a timeout error. |
+|  [timestamp?](./bullmq.jobsoptions.timestamp.md) | number | <i>(Optional)</i> Defaults to <code>Date.now()</code> |
 
diff --git a/docs/gitbook/api/bullmq.jobsoptions.priority.md b/docs/gitbook/api/bullmq.jobsoptions.priority.md
@@ -4,6 +4,8 @@
 
 ## JobsOptions.priority property
 
+Ranges from 1 (highest priority) to MAX\_INT (lowest priority). Note that using priorities has a slight impact on performance, so do not use it if not required.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.jobsoptions.ratelimiterkey.md b/docs/gitbook/api/bullmq.jobsoptions.ratelimiterkey.md
@@ -4,6 +4,8 @@
 
 ## JobsOptions.rateLimiterKey property
 
+Rate limiter key to use if rate limiter enabled.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.jobsoptions.removeoncomplete.md b/docs/gitbook/api/bullmq.jobsoptions.removeoncomplete.md
@@ -4,6 +4,8 @@
 
 ## JobsOptions.removeOnComplete property
 
+If true, removes the job when it successfully completes When given an number, it specifies the maximum amount of jobs to keep. Default behavior is to keep the job in the completed set.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.jobsoptions.removeonfail.md b/docs/gitbook/api/bullmq.jobsoptions.removeonfail.md
@@ -4,6 +4,8 @@
 
 ## JobsOptions.removeOnFail property
 
+If true, removes the job when it fails after all attempts. When given an number, it specifies the maximum amount of jobs to keep.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.jobsoptions.repeat.md b/docs/gitbook/api/bullmq.jobsoptions.repeat.md
@@ -4,6 +4,8 @@
 
 ## JobsOptions.repeat property
 
+Repeat this job, for example based on a `cron` schedule.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.jobsoptions.stacktracelimit.md b/docs/gitbook/api/bullmq.jobsoptions.stacktracelimit.md
@@ -4,6 +4,8 @@
 
 ## JobsOptions.stackTraceLimit property
 
+Limits the amount of stack trace lines that will be recorded in the stacktrace.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.jobsoptions.timeout.md b/docs/gitbook/api/bullmq.jobsoptions.timeout.md
@@ -4,6 +4,8 @@
 
 ## JobsOptions.timeout property
 
+The number of milliseconds after which the job should be fail with a timeout error.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.jobsoptions.timestamp.md b/docs/gitbook/api/bullmq.jobsoptions.timestamp.md
@@ -4,6 +4,8 @@
 
 ## JobsOptions.timestamp property
 
+Defaults to `Date.now()`
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.md b/docs/gitbook/api/bullmq.md
@@ -33,17 +33,17 @@
 |  Interface | Description |
 |  --- | --- |
 |  [AdvancedOptions](./bullmq.advancedoptions.md) |  |
-|  [BackoffOptions](./bullmq.backoffoptions.md) |  |
+|  [BackoffOptions](./bullmq.backoffoptions.md) | Settings for backing off failed jobs. |
 |  [ChildProcessExt](./bullmq.childprocessext.md) |  |
 |  [JobJson](./bullmq.jobjson.md) |  |
 |  [JobsOptions](./bullmq.jobsoptions.md) |  |
 |  [QueueBaseOptions](./bullmq.queuebaseoptions.md) |  |
 |  [QueueEvents](./bullmq.queueevents.md) |  |
 |  [QueueEventsOptions](./bullmq.queueeventsoptions.md) |  |
 |  [QueueOptions](./bullmq.queueoptions.md) |  |
-|  [QueueSchedulerOptions](./bullmq.queuescheduleroptions.md) |  |
+|  [QueueSchedulerOptions](./bullmq.queuescheduleroptions.md) | Options for customizing the behaviour of the scheduler. |
 |  [RateLimiterOptions](./bullmq.ratelimiteroptions.md) |  |
-|  [RepeatOptions](./bullmq.repeatoptions.md) |  |
+|  [RepeatOptions](./bullmq.repeatoptions.md) | Settings for repeatable jobs |
 |  [SandboxedJob](./bullmq.sandboxedjob.md) |  |
 |  [Strategies](./bullmq.strategies.md) |  |
 |  [WorkerOptions](./bullmq.workeroptions.md) |  |
@@ -62,7 +62,7 @@
 |  --- | --- |
 |  [BackoffFunction](./bullmq.backofffunction.md) |  |
 |  [ConnectionOptions](./bullmq.connectionoptions.md) |  |
-|  [Processor](./bullmq.processor.md) |  |
+|  [Processor](./bullmq.processor.md) | An async function that receives <code>Job</code>s and handles them. |
 |  [RedisOptions](./bullmq.redisoptions.md) |  |
 |  [SandboxedJobProcessor](./bullmq.sandboxedjobprocessor.md) |  |
 
diff --git a/docs/gitbook/api/bullmq.processor.md b/docs/gitbook/api/bullmq.processor.md
@@ -4,6 +4,8 @@
 
 ## Processor type
 
+An async function that receives `Job`<!-- -->s and handles them.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.queuebaseoptions.md b/docs/gitbook/api/bullmq.queuebaseoptions.md
@@ -16,5 +16,5 @@ export interface QueueBaseOptions
 |  --- | --- | --- |
 |  [client?](./bullmq.queuebaseoptions.client.md) | Redis | <i>(Optional)</i> |
 |  [connection?](./bullmq.queuebaseoptions.connection.md) | [ConnectionOptions](./bullmq.connectionoptions.md) | <i>(Optional)</i> |
-|  [prefix?](./bullmq.queuebaseoptions.prefix.md) | string | <i>(Optional)</i> |
+|  [prefix?](./bullmq.queuebaseoptions.prefix.md) | string | <i>(Optional)</i> Prefix for all queue keys. |
 
diff --git a/docs/gitbook/api/bullmq.queuebaseoptions.prefix.md b/docs/gitbook/api/bullmq.queuebaseoptions.prefix.md
@@ -4,6 +4,8 @@
 
 ## QueueBaseOptions.prefix property
 
+Prefix for all queue keys.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.queuescheduleroptions.maxstalledcount.md b/docs/gitbook/api/bullmq.queuescheduleroptions.maxstalledcount.md
@@ -4,6 +4,8 @@
 
 ## QueueSchedulerOptions.maxStalledCount property
 
+Amount of times a job can be recovered from a stalled state to the `wait` state. If this is exceeded, the job is moved to `failed`<!-- -->.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.queuescheduleroptions.md b/docs/gitbook/api/bullmq.queuescheduleroptions.md
@@ -4,6 +4,8 @@
 
 ## QueueSchedulerOptions interface
 
+Options for customizing the behaviour of the scheduler.
+
 <b>Signature:</b>
 
 ```typescript
@@ -15,6 +17,6 @@ export interface QueueSchedulerOptions extends QueueBaseOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [maxStalledCount?](./bullmq.queuescheduleroptions.maxstalledcount.md) | number | <i>(Optional)</i> |
-|  [stalledInterval?](./bullmq.queuescheduleroptions.stalledinterval.md) | number | <i>(Optional)</i> |
+|  [maxStalledCount?](./bullmq.queuescheduleroptions.maxstalledcount.md) | number | <i>(Optional)</i> Amount of times a job can be recovered from a stalled state to the <code>wait</code> state. If this is exceeded, the job is moved to <code>failed</code>. |
+|  [stalledInterval?](./bullmq.queuescheduleroptions.stalledinterval.md) | number | <i>(Optional)</i> Number of milliseconds between stallness checks. |
 
diff --git a/docs/gitbook/api/bullmq.queuescheduleroptions.stalledinterval.md b/docs/gitbook/api/bullmq.queuescheduleroptions.stalledinterval.md
@@ -4,6 +4,8 @@
 
 ## QueueSchedulerOptions.stalledInterval property
 
+Number of milliseconds between stallness checks.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.ratelimiteroptions.duration.md b/docs/gitbook/api/bullmq.ratelimiteroptions.duration.md
@@ -4,6 +4,8 @@
 
 ## RateLimiterOptions.duration property
 
+Time in milliseconds. During this time, a maximum of `max` jobs will be processed.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.ratelimiteroptions.groupkey.md b/docs/gitbook/api/bullmq.ratelimiteroptions.groupkey.md
@@ -4,6 +4,8 @@
 
 ## RateLimiterOptions.groupKey property
 
+It is possible to define a rate limiter based on group keys, for example you may want to have a rate limiter per customer instead of a global rate limiter for all customers
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.ratelimiteroptions.max.md b/docs/gitbook/api/bullmq.ratelimiteroptions.max.md
@@ -4,6 +4,8 @@
 
 ## RateLimiterOptions.max property
 
+Max number of jobs to process in the time period specified in `duration`<!-- -->.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.ratelimiteroptions.md b/docs/gitbook/api/bullmq.ratelimiteroptions.md
@@ -14,7 +14,7 @@ export interface RateLimiterOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [duration](./bullmq.ratelimiteroptions.duration.md) | number |  |
-|  [groupKey?](./bullmq.ratelimiteroptions.groupkey.md) | string | <i>(Optional)</i> |
-|  [max](./bullmq.ratelimiteroptions.max.md) | number |  |
+|  [duration](./bullmq.ratelimiteroptions.duration.md) | number | Time in milliseconds. During this time, a maximum of <code>max</code> jobs will be processed. |
+|  [groupKey?](./bullmq.ratelimiteroptions.groupkey.md) | string | <i>(Optional)</i> It is possible to define a rate limiter based on group keys, for example you may want to have a rate limiter per customer instead of a global rate limiter for all customers |
+|  [max](./bullmq.ratelimiteroptions.max.md) | number | Max number of jobs to process in the time period specified in <code>duration</code>. |
 
diff --git a/docs/gitbook/api/bullmq.redisconnection.waituntilready.md b/docs/gitbook/api/bullmq.redisconnection.waituntilready.md
@@ -9,7 +9,7 @@ Waits for a redis client to be ready.
 <b>Signature:</b>
 
 ```typescript
-static waitUntilReady(client: IORedis.Redis): Promise<unknown>;
+static waitUntilReady(client: IORedis.Redis): Promise<void>;
 ```
 
 ## Parameters
@@ -20,5 +20,5 @@ static waitUntilReady(client: IORedis.Redis): Promise<unknown>;
 
 <b>Returns:</b>
 
-Promise&lt;unknown&gt;
+Promise&lt;void&gt;
 
diff --git a/docs/gitbook/api/bullmq.repeatoptions.count.md b/docs/gitbook/api/bullmq.repeatoptions.count.md
@@ -4,6 +4,8 @@
 
 ## RepeatOptions.count property
 
+The start value for the repeat iteration count.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.repeatoptions.cron.md b/docs/gitbook/api/bullmq.repeatoptions.cron.md
@@ -4,6 +4,8 @@
 
 ## RepeatOptions.cron property
 
+A cron pattern
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.repeatoptions.enddate.md b/docs/gitbook/api/bullmq.repeatoptions.enddate.md
@@ -4,6 +4,8 @@
 
 ## RepeatOptions.endDate property
 
+End date when the repeat job should stop repeating.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.repeatoptions.every.md b/docs/gitbook/api/bullmq.repeatoptions.every.md
@@ -4,6 +4,8 @@
 
 ## RepeatOptions.every property
 
+Repeat after this amount of milliseconds (`cron` setting cannot be used together with this setting.)
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/gitbook/api/bullmq.repeatoptions.limit.md b/docs/gitbook/api/bullmq.repeatoptions.limit.md
@@ -4,6 +4,8 @@
 
 ## RepeatOptions.limit property
 
+Number of times the job should repeat at max.
+
 <b>Signature:</b>
 
 ```typescript