Scheduled Tasks

import { cleanSessionsTask, DefaultSchedulerPlugin, VendureConfig } from '@vendure/core';export const config: VendureConfig = {    // ...    schedulerOptions: {        tasks: [            // Use the task as is            cleanSessionsTask,            // or further configure the task            cleanSessionsTask.configure({                // Run the task every day at 3:00am                // The default schedule is every day at 00:00am                schedule: cron => cron.everyDayAt(3, 0),                params: {                    // How many sessions to process in each batch                    // Default: 10_000                    batchSize: 5_000,                },            }),        ],    },    plugins: [DefaultSchedulerPlugin.init()],};

import { ScheduledTask, RequestContextService } from '@vendure/core';import { SitemapService } from '../services/sitemap.service';export const generateSitemapTask = new ScheduledTask({    // Give your task a unique ID    id: 'generate-sitemap',    // A human-readable description of the task    description: 'Generates a sitemap file',    // Params can be used to further configure aspects of the    // task. They get passed in to the `execute` function as the    // second argument.    // They can be later modified using the `.configure()` method on the instance    params: {        shopBaseUrl: 'https://www.myshop.com',    },    // Define a default schedule. This can be modified using the    // `.configure()` method on the instance later.    schedule: cron => cron.everyDayAt(0, 0),    // This is the function that will be executed per the schedule.    async execute({injector, params}) {        // Using `injector.get()` we can grab an instance of _any_ provider defined in the        // Vendure core as well as by our plugins.        const sitemapService = injector.get(SitemapService);        // For most service methods, we'll need to pass a RequestContext object.        // We can use the RequestContextService to create one.        const ctx = await injector.get(RequestContextService).create({            apiType: 'admin',        });        // Here's the actual work we want to perform.        const result = await sitemapService.generateSitemap(ctx);        // The return value from the `execute` function will be available        // as the `lastResult` property when viewing tasks.        return { result };    },});

import { cleanSessionsTask, DefaultSchedulerPlugin, VendureConfig } from '@vendure/core';import { SitemapPlugin, generateSitemapTask } from './plugins/sitemap'; // [!code highlight]export const config: VendureConfig = {    // ...    schedulerOptions: {        tasks: [            cleanSessionsTask,            // Here's an example of overriding the // [!code highlight]            // default params using the `configure()` method. // [!code highlight]            generateSitemapTask.configure({ // [!code highlight]                params: { // [!code highlight]                    shopBaseUrl: 'https://www.shoes.com' // [!code highlight]                } // [!code highlight]            }), // [!code highlight]        ],    },    plugins: [        SitemapPlugin, // [!code highlight]        DefaultSchedulerPlugin.init()    ],};

import { VendurePlugin, PluginCommonModule, Type, ScheduledTask, VendureConfig } from '@vendure/core';import { PLUGIN_OPTIONS } from './constants';import { SitemapPluginOptions } from './types';import { SitemapService } from './services/sitemap.service';import { generateSitemapTask } from './config/generate-sitemap-task';@VendurePlugin({    imports: [PluginCommonModule],    providers: [SitemapService],    configuration: (config: VendureConfig) => {        // Add the task to the schedulerOptions.tasks array // [!code highlight]        config.schedulerOptions.tasks.push( // [!code highlight]            generateSitemapTask.configure({ // [!code highlight]                params: { // [!code highlight]                    shopBaseUrl: SitemapPlugin.options.shopBaseUrl, // [!code highlight]                } // [!code highlight]            }) // [!code highlight]        ); // [!code highlight]        return config;    },})export class SitemapPlugin {    static options: SitemapPluginOptions;    static init(options?: SitemapPluginOptions) {        this.options = {            shopBaseUrl: '',            ...(options ?? {}),        }    }}

import { DefaultSchedulerPlugin, VendureConfig } from '@vendure/core';import { SitemapPlugin } from './plugins/sitemap'; // [!code highlight]export const config: VendureConfig = {    // ...    plugins: [        SitemapPlugin.init({ // [!code highlight]            shopBaseUrl: 'https://www.shoes.com' // [!code highlight]        }), // [!code highlight]        DefaultSchedulerPlugin.init()    ],};

import { ScheduledTask, VendureConfig } from '@vendure/core';export const config: VendureConfig = {    // ...    schedulerOptions: {        // All schedules are evaluated in this timezone...        timezone: 'Europe/Stockholm',        tasks: [            new ScheduledTask({                id: 'nightly-sync',                schedule: cron => cron.everyDayAt(2, 0),                // ...except for tasks that specify their own                timezone: 'America/New_York',                execute: async () => {                    /* ... */                },            }),        ],    },};

export const config: VendureConfig = {    // ...    schedulerOptions: {        tasks: [cleanSessionsTask.configure({ timezone: 'Europe/Stockholm' })], // [!code highlight]    },};

import { Injectable } from '@nestjs/common';import { Cron } from '@nestjs/schedule';@Injectable()export class SitemapService {    constructor(private processContext: ProcessContext) {}    @Cron('0 0 * * *')    async generateSitemap() {        if (this.processContext.isWorker) { // [!code highlight]            // Only run on the worker // [!code highlight]            await this.triggerGenerate(); // [!code highlight]        } // [!code highlight]    }}