c08b2aea89
Adds a new `schedule` property to workflow and task configs that can be used to have Payload automatically _queue_ jobs following a certain _schedule_. Docs: https://payloadcms.com/docs/dynamic/jobs-queue/schedules?branch=feat/schedule-jobs ## API Example ```ts export default buildConfig({ // ... jobs: { // ... scheduler: 'manual', // Or `cron` if you're not using serverless. If `manual` is used, then user needs to set up running /api/payload-jobs/handleSchedules or payload.jobs.handleSchedules in regular intervals tasks: [ { schedule: [ { cron: '* * * * * *', queue: 'autorunSecond', // Hooks are optional hooks: { // Not an array, as providing and calling `defaultBeforeSchedule` would be more error-prone if this was an array beforeSchedule: async (args) => { // Handles verifying that there are no jobs already scheduled or processing. // You can override this behavior by not calling defaultBeforeSchedule, e.g. if you wanted // to allow a maximum of 3 scheduled jobs in the queue instead of 1, or add any additional conditions const result = await args.defaultBeforeSchedule(args) return { ...result, input: { message: 'This task runs every second', }, } }, afterSchedule: async (args) => { await args.defaultAfterSchedule(args) // Handles updating the payload-jobs-stats global args.req.payload.logger.info( 'EverySecond task scheduled: ' + (args.status === 'success' ? args.job.id : 'skipped or failed to schedule'), ) }, }, }, ], slug: 'EverySecond', inputSchema: [ { name: 'message', type: 'text', required: true, }, ], handler: ({ input, req }) => { req.payload.logger.info(input.message) return { output: {}, } }, } ] } }) ``` --- - To see the specific tasks where the Asana app for GitHub is being used, see below: - https://app.asana.com/0/0/1210495300843759
63 lines
1.6 KiB
TypeScript
63 lines
1.6 KiB
TypeScript
import {
|
|
_internal_jobSystemGlobals,
|
|
countRunnableOrActiveJobsForQueue,
|
|
createLocalReq,
|
|
type Payload,
|
|
} from 'payload'
|
|
|
|
export async function waitUntilAutorunIsDone({
|
|
payload,
|
|
queue,
|
|
onlyScheduled = false,
|
|
}: {
|
|
onlyScheduled?: boolean
|
|
payload: Payload
|
|
queue: string
|
|
}): Promise<void> {
|
|
const req = await createLocalReq({}, payload)
|
|
|
|
return new Promise((resolve) => {
|
|
const interval = setInterval(async () => {
|
|
const count = await countRunnableOrActiveJobsForQueue({
|
|
queue,
|
|
req,
|
|
onlyScheduled,
|
|
})
|
|
if (count === 0) {
|
|
clearInterval(interval)
|
|
resolve()
|
|
}
|
|
}, 200)
|
|
})
|
|
}
|
|
|
|
export function timeFreeze() {
|
|
const curDate = new Date()
|
|
_internal_jobSystemGlobals.getCurrentDate = () => curDate
|
|
}
|
|
|
|
export function timeTravel(seconds: number) {
|
|
const curDate = _internal_jobSystemGlobals.getCurrentDate()
|
|
_internal_jobSystemGlobals.getCurrentDate = () => new Date(curDate.getTime() + seconds * 1000)
|
|
}
|
|
|
|
export async function withoutAutoRun<T>(fn: () => Promise<T>): Promise<T> {
|
|
const originalValue = _internal_jobSystemGlobals.shouldAutoRun
|
|
_internal_jobSystemGlobals.shouldAutoRun = false
|
|
try {
|
|
return await fn()
|
|
} finally {
|
|
_internal_jobSystemGlobals.shouldAutoRun = originalValue
|
|
}
|
|
}
|
|
|
|
export async function withoutAutoSchedule<T>(fn: () => Promise<T>): Promise<T> {
|
|
const originalValue = _internal_jobSystemGlobals.shouldAutoSchedule
|
|
_internal_jobSystemGlobals.shouldAutoSchedule = false
|
|
try {
|
|
return await fn()
|
|
} finally {
|
|
_internal_jobSystemGlobals.shouldAutoSchedule = originalValue
|
|
}
|
|
}
|