feat(payload-cloud): set up cron jobs on init

packages/payload-cloud/package.json

@@ -57,6 +57,7 @@
     "ts-jest": "^29.1.0"
   },
   "peerDependencies": {
+    "croner": "9.0.0",
     "payload": "workspace:*"
   },
   "publishConfig": {

packages/payload-cloud/src/plugin.ts

@@ -1,5 +1,7 @@
 import type { Config } from 'payload'
 
+import { Cron } from 'croner'
+
 import type { PluginOptions } from './types.js'
 
 import { payloadCloudEmail } from './email.js'
@@ -93,5 +95,59 @@ export const payloadCloudPlugin =
       })
     }
 
-    return config
+    // If the user has tasks configured, we set up cron jobs on init.
+    // We also make sure to only run on one instance using a instance identifier stored in a global.
+    if (config.jobs?.tasks) {
+      config.globals = [
+        ...(config.globals || []),
+        {
+          slug: 'payload-cloud-instance',
+          admin: {
+            hidden: true,
+          },
+          fields: [
+            {
+              name: 'instance',
+              type: 'text',
+              required: true,
+            },
+          ],
+        },
+      ]
+      config.onInit = async (payload) => {
+        if (config.onInit) {
+          await config.onInit(payload)
+        }
+        const instance = generateRandomString()
+
+        await payload.updateGlobal({
+          slug: 'payload-cloud-instance',
+          data: {
+            instance,
+          },
+        })
+
+        const cloudInstance = await payload.findGlobal({
+          slug: 'payload-cloud-instance',
+        })
+
+        if (cloudInstance.instance === instance) {
+          pluginOptions?.jobs?.forEach((cronConfig) => {
+            new Cron(cronConfig.cron ?? '* * * * *', async () => {
+              await payload.jobs.run({
+                limit: cronConfig.limit ?? 100,
+                queue: cronConfig.queue,
+              })
+            })
+          })
+        }
+      }
+
+      return config
+    }
   }
+
+function generateRandomString(): string {
+  const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
+  return Array.from({ length: 24 }, () => chars[Math.floor(Math.random() * chars.length)]).join('')
+}

packages/payload-cloud/src/types.ts

@@ -53,6 +53,36 @@ export interface PayloadCloudEmailOptions {
   skipVerify?: boolean
 }
 
+export type CronConfig = {
+  /**
+   * The cron schedule for the job. Defaults to '* * * * *' (every minute).
+   *
+   * @example
+   *      ┌───────────── minute (0 - 59)
+   *      │ ┌───────────── hour (0 - 23)
+   *      │ │ ┌───────────── day of the month (1 - 31)
+   *      │ │ │ ┌───────────── month (1 - 12)
+   *      │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday)
+   *      │ │ │ │ │                                   OR sun, mon, tue, wed, thu, fri, sat
+   *      │ │ │ │ │
+   *      │ │ │ │ │
+   *   - '0 * * * *' every hour at minute 0
+   *   - '0 0 * * *' daily at midnight
+   *   - '0 0 * * 0' weekly at midnight on Sundays
+   *   - '0 0 1 * *' monthly at midnight on the 1st day of the month
+   *   - '0/5 * * * *' every 5 minutes
+   */
+  cron?: string
+  /**
+   * The limit for the job. This can be overridden by the user. Defaults to 100.
+   */
+  limit?: number
+  /**
+   * The queue name for the job.
+   */
+  queue?: string
+}
+
 export interface PluginOptions {
   /** Payload Cloud Email
    * @default true
@@ -72,6 +102,11 @@ export interface PluginOptions {
    */
   endpoint?: string
 
+  /**
+   * Jobs configuration
+   */
+  jobs?: CronConfig[]
+
   /** Payload Cloud Storage
    * @default true
    */