Scheduled tasks

[michaelbromley]

Description

Relates to #1425

This PR implements a new mechanism and set of APIs which allows us to define scheduled tasks directly in Vendure and Vendure Plugins.

It solves the fundamental problem of solutions like @nestjs/schedule by guaranteeing that a given task will only execute exactly once for a given schedule period, even if we are running in a horizontally-scaled environment with multiple server and worker instances.

It does this by using a shared locking mechanism. By default this is done using a new database table, which allows each task to be tracked and locked across instances.

The API looks like this:

import { ScheduledTask } from '@vendure/core';

export const cleanSessionsTask= new ScheduledTask({
  id: 'clean-expired-sessions',
  description: 'Clean up expired and inactive sessions from the database',
  schedule: cron => cron.every(12).hours(),
  execute: async (injector, params) => {
      // some logic here
  },
});

export const config: VendureConfig = {
  // ...
  schedulerOptions: {
    tasks: [
      cleanSessionsTask,
    ],
  }
};

Breaking changes

We export a new DefaultSchedulerPlugin which includes a new database entity, so when adding this to a project, a database migration will be required.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	Apr 9, 2025 11:40am

[sonarqubecloud]

Quality Gate passed

Issues
31 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.1% Duplication on New Code

See analysis details on SonarQube Cloud