xtr.dev/payload-automation
1
0
Fork 0
mirror of https://github.com/xtr-dev/payload-automation.git synced 2025-12-10 08:53:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add trigger builder helpers to improve DX for custom triggers

Browse Source 
- Add createTrigger() and createAdvancedTrigger() helpers
- Add preset builders: webhookTrigger, cronTrigger, eventTrigger, etc.
- Implement virtual fields with JSON backing for trigger parameters
- Eliminate 90% of boilerplate when creating custom triggers
- Add /helpers export path for trigger builders
- Fix field name clashing between built-in and custom trigger parameters
- Add comprehensive examples and documentation
- Maintain backward compatibility with existing triggers

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Bas van den Aakster
2025-09-07 15:30:10 +02:00
parent 0a036752ea
commit c47197223c
18 changed files with 1185 additions and 623 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
src/plugin/cron-scheduler.ts
View File

@@ -54,14 +54,17 @@ export function generateCronTasks(config: Config): void {
// Find the matching cron trigger and check its condition if present
const triggers = workflow.triggers as Array<{
condition?: string
cronExpression?: string
timezone?: string
parameters?: {
cronExpression?: string
timezone?: string
[key: string]: any
}
type: string
}>
const matchingTrigger = triggers?.find(trigger =>
trigger.type === 'cron-trigger' &&
trigger.cronExpression === cronExpression
trigger.parameters?.cronExpression === cronExpression
)
// Check trigger condition if present
@@ -183,8 +186,11 @@ export async function registerCronJobs(payload: Payload, logger: Payload['logger
for (const workflow of workflows.docs) {
const triggers = workflow.triggers as Array<{
cronExpression?: string
timezone?: string
parameters?: {
cronExpression?: string
timezone?: string
[key: string]: any
}
type: string
}>
@@ -192,12 +198,12 @@ export async function registerCronJobs(payload: Payload, logger: Payload['logger
const cronTriggers = triggers?.filter(t => t.type === 'cron-trigger') || []
for (const trigger of cronTriggers) {
if (trigger.cronExpression) {
if (trigger.parameters?.cronExpression) {
try {
// Validate cron expression before queueing
if (!validateCronExpression(trigger.cronExpression)) {
if (!validateCronExpression(trigger.parameters.cronExpression)) {
logger.error({
cronExpression: trigger.cronExpression,
cronExpression: trigger.parameters.cronExpression,
workflowId: workflow.id,
workflowName: workflow.name
}, 'Invalid cron expression format')
@@ -205,13 +211,13 @@ export async function registerCronJobs(payload: Payload, logger: Payload['logger
}
// Validate timezone if provided
if (trigger.timezone) {
if (trigger.parameters?.timezone) {
try {
// Test if timezone is valid by trying to create a date with it
new Intl.DateTimeFormat('en', { timeZone: trigger.timezone })
new Intl.DateTimeFormat('en', { timeZone: trigger.parameters.timezone })
} catch {
logger.error({
timezone: trigger.timezone,
timezone: trigger.parameters.timezone,
workflowId: workflow.id,
workflowName: workflow.name
}, 'Invalid timezone specified')
@@ -220,27 +226,27 @@ export async function registerCronJobs(payload: Payload, logger: Payload['logger
}
// Calculate next execution time
const nextExecution = getNextCronTime(trigger.cronExpression, trigger.timezone)
const nextExecution = getNextCronTime(trigger.parameters.cronExpression, trigger.parameters?.timezone)
// Queue the job
await payload.jobs.queue({
input: { cronExpression: trigger.cronExpression, timezone: trigger.timezone, workflowId: workflow.id },
input: { cronExpression: trigger.parameters.cronExpression, timezone: trigger.parameters?.timezone, workflowId: workflow.id },
task: 'workflow-cron-executor',
waitUntil: nextExecution
})
logger.info({
cronExpression: trigger.cronExpression,
cronExpression: trigger.parameters.cronExpression,
nextExecution: nextExecution.toISOString(),
timezone: trigger.timezone || 'UTC',
timezone: trigger.parameters?.timezone || 'UTC',
workflowId: workflow.id,
workflowName: workflow.name
}, 'Queued initial cron job for workflow')
} catch (error) {
logger.error({
cronExpression: trigger.cronExpression,
cronExpression: trigger.parameters.cronExpression,
error: error instanceof Error ? error.message : 'Unknown error',
timezone: trigger.timezone,
timezone: trigger.parameters?.timezone,
workflowId: workflow.id,
workflowName: workflow.name
}, 'Failed to queue cron job')
@@ -508,8 +514,11 @@ export async function updateWorkflowCronJobs(
}
const triggers = workflow.triggers as Array<{
cronExpression?: string
timezone?: string
parameters?: {
cronExpression?: string
timezone?: string
[key: string]: any
}
type: string
}>
@@ -524,12 +533,12 @@ export async function updateWorkflowCronJobs(
let scheduledJobs = 0
for (const trigger of cronTriggers) {
if (trigger.cronExpression) {
if (trigger.parameters?.cronExpression) {
try {
// Validate cron expression before queueing
if (!validateCronExpression(trigger.cronExpression)) {
if (!validateCronExpression(trigger.parameters.cronExpression)) {
logger.error({
cronExpression: trigger.cronExpression,
cronExpression: trigger.parameters.cronExpression,
workflowId,
workflowName: workflow.name
}, 'Invalid cron expression format')
@@ -537,12 +546,12 @@ export async function updateWorkflowCronJobs(
}
// Validate timezone if provided
if (trigger.timezone) {
if (trigger.parameters?.timezone) {
try {
new Intl.DateTimeFormat('en', { timeZone: trigger.timezone })
new Intl.DateTimeFormat('en', { timeZone: trigger.parameters.timezone })
} catch {
logger.error({
timezone: trigger.timezone,
timezone: trigger.parameters.timezone,
workflowId,
workflowName: workflow.name
}, 'Invalid timezone specified')
@@ -551,11 +560,11 @@ export async function updateWorkflowCronJobs(
}
// Calculate next execution time
const nextExecution = getNextCronTime(trigger.cronExpression, trigger.timezone)
const nextExecution = getNextCronTime(trigger.parameters.cronExpression, trigger.parameters?.timezone)
// Queue the job
await payload.jobs.queue({
input: { cronExpression: trigger.cronExpression, timezone: trigger.timezone, workflowId },
input: { cronExpression: trigger.parameters.cronExpression, timezone: trigger.parameters?.timezone, workflowId },
task: 'workflow-cron-executor',
waitUntil: nextExecution
})
@@ -563,17 +572,17 @@ export async function updateWorkflowCronJobs(
scheduledJobs++
logger.info({
cronExpression: trigger.cronExpression,
cronExpression: trigger.parameters.cronExpression,
nextExecution: nextExecution.toISOString(),
timezone: trigger.timezone || 'UTC',
timezone: trigger.parameters?.timezone || 'UTC',
workflowId,
workflowName: workflow.name
}, 'Scheduled cron job for workflow')
} catch (error) {
logger.error({
cronExpression: trigger.cronExpression,
cronExpression: trigger.parameters?.cronExpression,
error: error instanceof Error ? error.message : 'Unknown error',
timezone: trigger.timezone,
timezone: trigger.parameters?.timezone,
workflowId,
workflowName: workflow.name
}, 'Failed to schedule cron job')

122
src/plugin/index.ts
View File

@@ -1,6 +1,6 @@
import type {Config} from 'payload'
import type {WorkflowsPluginConfig, CollectionTriggerConfigCrud} from "./config-types.js"
import type {CollectionTriggerConfigCrud, WorkflowsPluginConfig} from "./config-types.js"
import {createWorkflowCollection} from '../collections/Workflow.js'
import {WorkflowRunsCollection} from '../collections/WorkflowRuns.js'
@@ -17,22 +17,22 @@ export {getLogger} from './logger.js'
// Improved executor registry with proper error handling and logging
interface ExecutorRegistry {
executor: WorkflowExecutor | null
logger: any | null
executor: null | WorkflowExecutor
isInitialized: boolean
logger: any | null
}
const executorRegistry: ExecutorRegistry = {
executor: null,
logger: null,
isInitialized: false
isInitialized: false,
logger: null
}
const setWorkflowExecutor = (executor: WorkflowExecutor, logger: any) => {
executorRegistry.executor = executor
executorRegistry.logger = logger
executorRegistry.isInitialized = true
logger.info('Workflow executor initialized and registered successfully')
}
@@ -47,68 +47,68 @@ const createFailedWorkflowRun = async (args: any, errorMessage: string, logger:
if (!args?.req?.payload || !args?.collection?.slug) {
return
}
// Find workflows that should have been triggered
const workflows = await args.req.payload.find({
collection: 'workflows',
limit: 10,
req: args.req,
where: {
'triggers.type': {
equals: 'collection-trigger'
},
'triggers.collectionSlug': {
equals: args.collection.slug
},
'triggers.operation': {
equals: args.operation
},
'triggers.type': {
equals: 'collection-trigger'
}
},
limit: 10,
req: args.req
}
})
// Create failed workflow runs for each matching workflow
for (const workflow of workflows.docs) {
await args.req.payload.create({
collection: 'workflow-runs',
data: {
workflow: workflow.id,
workflowVersion: 1,
status: 'failed',
startedAt: new Date().toISOString(),
completedAt: new Date().toISOString(),
error: `Hook execution failed: ${errorMessage}`,
triggeredBy: args?.req?.user?.email || 'system',
context: {
steps: {},
trigger: {
type: 'collection',
collection: args.collection.slug,
operation: args.operation,
doc: args.doc,
operation: args.operation,
previousDoc: args.previousDoc,
triggeredAt: new Date().toISOString()
},
steps: {}
}
},
error: `Hook execution failed: ${errorMessage}`,
inputs: {},
outputs: {},
steps: [],
logs: [{
level: 'error',
message: `Hook execution failed: ${errorMessage}`,
timestamp: new Date().toISOString()
}]
}],
outputs: {},
startedAt: new Date().toISOString(),
status: 'failed',
steps: [],
triggeredBy: args?.req?.user?.email || 'system',
workflow: workflow.id,
workflowVersion: 1
},
req: args.req
})
}
if (workflows.docs.length > 0) {
logger.info({
workflowCount: workflows.docs.length,
errorMessage
errorMessage,
workflowCount: workflows.docs.length
}, 'Created failed workflow runs for hook execution error')
}
} catch (error) {
// Don't let workflow run creation failures break the original operation
logger.warn({
@@ -141,26 +141,26 @@ export const workflowsPlugin =
}
applyCollectionsConfig<TSlug>(pluginOptions, config)
// CRITICAL: Modify existing collection configs BEFORE PayloadCMS processes them
// This is the ONLY time we can add hooks that will actually work
const logger = getConfigLogger()
logger.info('Attempting to modify collection configs before PayloadCMS initialization...')
if (config.collections && pluginOptions.collectionTriggers) {
for (const [triggerSlug, triggerConfig] of Object.entries(pluginOptions.collectionTriggers)) {
if (!triggerConfig) continue
if (!triggerConfig) {continue}
// Find the collection config that matches
const collectionIndex = config.collections.findIndex(c => c.slug === triggerSlug)
if (collectionIndex === -1) {
logger.warn(`Collection '${triggerSlug}' not found in config.collections`)
continue
}
const collection = config.collections[collectionIndex]
logger.info(`Found collection '${triggerSlug}' - modifying its hooks...`)
// Initialize hooks if needed
if (!collection.hooks) {
collection.hooks = {}
@@ -168,35 +168,35 @@ export const workflowsPlugin =
if (!collection.hooks.afterChange) {
collection.hooks.afterChange = []
}
// Create a reliable hook function with proper dependency injection
const automationHook = Object.assign(
async function payloadAutomationHook(args: any) {
const registry = getExecutorRegistry()
// Use proper logger if available, fallback to args.req.payload.logger
const logger = registry.logger || args?.req?.payload?.logger || console
try {
logger.info({
collection: args?.collection?.slug,
operation: args?.operation,
docId: args?.doc?.id,
hookType: 'automation'
hookType: 'automation',
operation: args?.operation
}, 'Collection automation hook triggered')
if (!registry.isInitialized) {
logger.warn('Workflow executor not yet initialized, skipping execution')
return undefined
}
if (!registry.executor) {
logger.error('Workflow executor is null despite being marked as initialized')
// Create a failed workflow run to track this issue
await createFailedWorkflowRun(args, 'Executor not available', logger)
return undefined
}
logger.debug('Executing triggered workflows...')
await registry.executor.executeTriggeredWorkflows(
args.collection.slug,
@@ -205,24 +205,24 @@ export const workflowsPlugin =
args.previousDoc,
args.req
)
logger.info({
collection: args?.collection?.slug,
operation: args?.operation,
docId: args?.doc?.id
docId: args?.doc?.id,
operation: args?.operation
}, 'Workflow execution completed successfully')
} catch (error) {
const errorMessage = error instanceof Error ? error.message : 'Unknown error'
logger.error({
collection: args?.collection?.slug,
docId: args?.doc?.id,
error: errorMessage,
errorStack: error instanceof Error ? error.stack : undefined,
collection: args?.collection?.slug,
operation: args?.operation,
docId: args?.doc?.id
operation: args?.operation
}, 'Hook execution failed')
// Create a failed workflow run to track this error
try {
await createFailedWorkflowRun(args, errorMessage, logger)
@@ -231,10 +231,10 @@ export const workflowsPlugin =
error: createError instanceof Error ? createError.message : 'Unknown error'
}, 'Failed to create workflow run for hook error')
}
// Don't throw to prevent breaking the original operation
}
return undefined
},
{
@@ -242,7 +242,7 @@ export const workflowsPlugin =
__version: '0.0.22'
}
)
// Add the hook to the collection config
collection.hooks.afterChange.push(automationHook)
logger.info(`Added automation hook to '${triggerSlug}' - hook count: ${collection.hooks.afterChange.length}`)
@@ -275,7 +275,7 @@ export const workflowsPlugin =
const incomingOnInit = config.onInit
config.onInit = async (payload) => {
configLogger.info(`onInit called - collections: ${Object.keys(payload.collections).length}`)
// Execute any existing onInit functions first
if (incomingOnInit) {
configLogger.debug('Executing existing onInit function')
@@ -294,19 +294,19 @@ export const workflowsPlugin =
const executor = new WorkflowExecutor(payload, logger)
console.log('🚨 EXECUTOR CREATED:', typeof executor)
console.log('🚨 EXECUTOR METHODS:', Object.getOwnPropertyNames(Object.getPrototypeOf(executor)))
// Register executor with proper dependency injection
setWorkflowExecutor(executor, logger)
// Hooks are now registered during config phase - just log status
logger.info('Hooks were registered during config phase - executor now available')
logger.info('Initializing global hooks...')
initGlobalHooks(payload, logger, executor)
logger.info('Initializing workflow hooks...')
initWorkflowHooks(payload, logger)
logger.info('Initializing step tasks...')
initStepTasks(pluginOptions, payload, logger)

7
src/plugin/init-webhook.ts
View File

@@ -67,12 +67,15 @@ export function initWebhookEndpoint(config: Config, webhookPrefix = 'webhook'):
const triggers = workflow.triggers as Array<{
condition?: string
type: string
webhookPath?: string
parameters?: {
webhookPath?: string
[key: string]: any
}
}>
const matchingTrigger = triggers?.find(trigger =>
trigger.type === 'webhook-trigger' &&
trigger.webhookPath === path
trigger.parameters?.webhookPath === path
)
// Check trigger condition if present