DefaultJobQueuePlugin
DefaultJobQueuePlugin
A plugin which configures Vendure to use the SQL database to persist the JobQueue jobs using the SqlJobQueueStrategy. If you add this plugin to an existing Vendure installation, you’ll need to run a database migration, since this plugin will add a new “job_record” table to the database.
Example
import { DefaultJobQueuePlugin, VendureConfig } from '@vendure/core';
export const config: VendureConfig = {
// Add an instance of the plugin to the plugins array
plugins: [
DefaultJobQueuePlugin,
],
};
Configuration
It is possible to configure the behaviour of the SqlJobQueueStrategy by passing options to the static init()
function:
pollInterval
The interval in ms between polling for new jobs. The default is 200ms. Using a longer interval reduces load on the database but results in a slight delay in processing jobs.
concurrency
The number of jobs to process concurrently per worker. Defaults to 1.
backoffStrategy
Defines the backoff strategy used when retrying failed jobs. In other words, if a job fails and is configured to be re-tried, how long should we wait before the next attempt?
By default a job will be retried as soon as possible, but in some cases this is not desirable. For example, a job may interact with an unreliable 3rd-party API which is sensitive to too many requests. In this case, an exponential backoff may be used which progressively increases the delay between each subsequent retry.
Example
export const config: VendureConfig = {
plugins: [
DefaultJobQueuePlugin.init({
pollInterval: 5000,
concurrency: 2
backoffStrategy: (queueName, attemptsMade, job) => {
if (queueName === 'transcode-video') {
// exponential backoff example
return (attemptsMade ** 2) * 1000;
}
// A default delay for all other queues
return 1000;
},
}),
],
};
Signature
class DefaultJobQueuePlugin {
static init(options: {
pollInterval?: number;
concurrency?: number;
backoffStrategy?: BackoffStrategy;
}) => Type<DefaultJobQueuePlugin>;
}
Members
init
(options: { pollInterval?: number; concurrency?: number; backoffStrategy?: BackoffStrategy; }) => Type<DefaultJobQueuePlugin>