mirror of
https://github.com/xtr-dev/payload-automation.git
synced 2025-12-11 01:03:23 +00:00
Compare commits
14 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 397559079f | |||
| c352da91fa | |||
| d6aedbc59d | |||
| cd85f90ef1 | |||
| 38fbb1922a | |||
| dfcc5c0fce | |||
| 089e12ac7a | |||
| 8ff65ca7c3 | |||
| bdfc311009 | |||
| 3c54f00f57 | |||
| cbb74206e9 | |||
| 41c4d8bdcb | |||
| 46c9f11534 | |||
| 08a4022a41 |
38
CHANGELOG.md
Normal file
38
CHANGELOG.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to the PayloadCMS Automation Plugin will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [0.0.16] - 2025-09-01
|
||||
|
||||
### Fixed
|
||||
- **Critical Bug**: Removed problematic `hooksInitialized` flag that prevented proper hook registration in development environments
|
||||
- **Silent Failures**: Added comprehensive error logging with "AUTOMATION PLUGIN:" prefix for easier debugging
|
||||
- **Hook Execution**: Added try/catch blocks in hook execution to prevent silent failures and ensure workflow execution continues
|
||||
- **Development Mode**: Fixed issue where workflows would not execute even when properly configured due to hook registration being skipped
|
||||
|
||||
### Changed
|
||||
- Enhanced logging throughout the hook execution pipeline for better debugging visibility
|
||||
- Improved error handling to prevent workflow execution failures from breaking other hooks
|
||||
|
||||
### Migration Notes
|
||||
- No breaking changes - this is a critical bug fix release
|
||||
- Existing workflows should now execute properly after updating to this version
|
||||
- Enhanced logging will provide better visibility into workflow execution
|
||||
|
||||
## [0.0.15] - 2025-08-XX
|
||||
|
||||
### Changed
|
||||
- Updated workflow condition evaluation to use JSONPath expressions
|
||||
- Changed step configuration from `type`/`inputs` to `step`/`input`
|
||||
- Updated workflow collection schema for improved flexibility
|
||||
|
||||
## [0.0.14] - 2025-08-XX
|
||||
|
||||
### Added
|
||||
- Initial workflow automation functionality
|
||||
- Collection trigger support
|
||||
- Step execution engine
|
||||
- Basic workflow management
|
||||
@@ -1,67 +0,0 @@
|
||||
// Debug script to identify customer-side configuration issues
|
||||
// Run this in your environment to pinpoint the problem
|
||||
|
||||
console.log('🔍 === CUSTOMER ENVIRONMENT DEBUGGING ===')
|
||||
|
||||
// This script needs to be run in your actual environment
|
||||
// Copy this logic into your own debugging script
|
||||
|
||||
const debugChecklist = {
|
||||
"Plugin Version": "Check package.json for @xtr-dev/payload-automation version",
|
||||
"Plugin Configuration": "Verify automationPlugin() is called with correct collections array",
|
||||
"Database Collections": "Confirm 'workflows' and 'workflow-runs' collections exist",
|
||||
"Hook Registration": "Check if afterChange hooks are actually registered on orders collection",
|
||||
"Workflow Status": "Verify workflow document has _status: 'published'",
|
||||
"Workflow Structure": "Confirm triggers array and steps array are populated",
|
||||
"Order Collection": "Verify orders collection exists and is configured in plugin",
|
||||
"PayloadCMS Version": "Check if you're using compatible Payload version",
|
||||
"Environment": "Development vs Production database differences"
|
||||
}
|
||||
|
||||
console.log('\n📋 Debugging Checklist for Your Environment:')
|
||||
Object.entries(debugChecklist).forEach(([check, description], i) => {
|
||||
console.log(`${i + 1}. ${check}: ${description}`)
|
||||
})
|
||||
|
||||
console.log('\n🔍 Specific Things to Check in YOUR Environment:')
|
||||
|
||||
console.log('\n1. Plugin Configuration (payload.config.ts):')
|
||||
console.log(` automationPlugin({
|
||||
collections: ['orders', 'users', 'products'], // <- Must include 'orders'
|
||||
// ... other config
|
||||
})`)
|
||||
|
||||
console.log('\n2. Database Query (run this in your environment):')
|
||||
console.log(` const workflows = await payload.find({
|
||||
collection: 'workflows',
|
||||
depth: 2
|
||||
})
|
||||
console.log('Found workflows:', workflows.docs.length)
|
||||
console.log('Workflow details:', JSON.stringify(workflows.docs, null, 2))`)
|
||||
|
||||
console.log('\n3. Hook Registration Check:')
|
||||
console.log(` const orderCollection = payload.collections.orders
|
||||
console.log('afterChange hooks:', orderCollection.config.hooks?.afterChange?.length)`)
|
||||
|
||||
console.log('\n4. Manual Hook Trigger Test:')
|
||||
console.log(` // Manually call the executor method
|
||||
const executor = // get executor instance somehow
|
||||
await executor.executeTriggeredWorkflows('orders', 'update', updatedDoc, previousDoc, req)`)
|
||||
|
||||
console.log('\n5. Most Likely Issues:')
|
||||
console.log(' - Plugin not configured with "orders" in collections array')
|
||||
console.log(' - Workflow is in draft status (not published)')
|
||||
console.log(' - Database connection issue (different DB in dev vs prod)')
|
||||
console.log(' - PayloadCMS version compatibility issue')
|
||||
console.log(' - Hook execution order (automation hook not running last)')
|
||||
|
||||
console.log('\n💡 Quick Test - Add this to your order update code:')
|
||||
console.log(` console.log('🔍 DEBUG: About to update order')
|
||||
const result = await payload.update({ ... })
|
||||
console.log('🔍 DEBUG: Order updated, hooks should have fired')
|
||||
|
||||
// Check immediately after
|
||||
const runs = await payload.find({ collection: 'workflow-runs' })
|
||||
console.log('🔍 DEBUG: Workflow runs after update:', runs.docs.length)`)
|
||||
|
||||
process.exit(0)
|
||||
@@ -1,210 +0,0 @@
|
||||
// Enhanced debugging script for workflow execution issues
|
||||
const { getPayload } = require('payload')
|
||||
const { JSONPath } = require('jsonpath-plus')
|
||||
|
||||
async function debugWorkflowExecution() {
|
||||
const payload = await getPayload({
|
||||
config: require('./dev/payload.config.ts').default
|
||||
})
|
||||
|
||||
console.log('🔍 === WORKFLOW EXECUTION DEBUGGING ===')
|
||||
|
||||
// Step 1: Verify workflow exists and has correct structure
|
||||
console.log('\n📋 Step 1: Finding workflows...')
|
||||
const workflows = await payload.find({
|
||||
collection: 'workflows',
|
||||
depth: 2,
|
||||
limit: 100
|
||||
})
|
||||
|
||||
console.log(`Found ${workflows.docs.length} workflows:`)
|
||||
|
||||
for (const workflow of workflows.docs) {
|
||||
console.log(`\n Workflow: "${workflow.name}" (ID: ${workflow.id})`)
|
||||
console.log(` Enabled: ${workflow.enabled !== false}`)
|
||||
console.log(` Triggers: ${JSON.stringify(workflow.triggers, null, 4)}`)
|
||||
console.log(` Steps: ${JSON.stringify(workflow.steps, null, 4)}`)
|
||||
}
|
||||
|
||||
// Step 2: Create test order and simulate the trigger context
|
||||
console.log('\n📦 Step 2: Creating test order...')
|
||||
|
||||
const testOrder = await payload.create({
|
||||
collection: 'orders',
|
||||
data: {
|
||||
orderName: 'Debug Test Order - ' + Date.now(),
|
||||
status: 'Unpaid',
|
||||
customerEmail: 'debug@example.com',
|
||||
totalPrice: 1500,
|
||||
items: [
|
||||
{
|
||||
name: 'Debug Item',
|
||||
quantity: 1,
|
||||
price: 1500
|
||||
}
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
console.log(`Created test order: ${testOrder.id} with status: "${testOrder.status}"`)
|
||||
|
||||
// Step 3: Test JSONPath condition evaluation directly
|
||||
console.log('\n🧪 Step 3: Testing JSONPath condition evaluation...')
|
||||
|
||||
// Simulate the execution context that would be created during hook execution
|
||||
const simulatedContext = {
|
||||
steps: {},
|
||||
trigger: {
|
||||
type: 'collection',
|
||||
collection: 'orders',
|
||||
doc: { ...testOrder, status: 'Paid' }, // Simulating the updated status
|
||||
operation: 'update',
|
||||
previousDoc: testOrder, // Original order with 'Unpaid' status
|
||||
}
|
||||
}
|
||||
|
||||
console.log('Simulated context:')
|
||||
console.log(' - Trigger type:', simulatedContext.trigger.type)
|
||||
console.log(' - Collection:', simulatedContext.trigger.collection)
|
||||
console.log(' - Doc status:', simulatedContext.trigger.doc.status)
|
||||
console.log(' - Previous doc status:', simulatedContext.trigger.previousDoc.status)
|
||||
|
||||
// Test the condition used in workflow
|
||||
const condition = '$.doc.status == "Paid"'
|
||||
console.log(`\nTesting condition: ${condition}`)
|
||||
|
||||
try {
|
||||
// Test left side JSONPath resolution
|
||||
const leftResult = JSONPath({
|
||||
json: simulatedContext,
|
||||
path: '$.trigger.doc.status',
|
||||
wrap: false
|
||||
})
|
||||
console.log(` - Left side ($.trigger.doc.status): ${JSON.stringify(leftResult)} (type: ${typeof leftResult})`)
|
||||
|
||||
// Test the comparison manually
|
||||
const comparisonMatch = condition.match(/^(.+?)\s*(==|!=|>|<|>=|<=)\s*(.+)$/)
|
||||
if (comparisonMatch) {
|
||||
const [, leftExpr, operator, rightExpr] = comparisonMatch
|
||||
console.log(` - Left expression: "${leftExpr.trim()}"`)
|
||||
console.log(` - Operator: "${operator}"`)
|
||||
console.log(` - Right expression: "${rightExpr.trim()}"`)
|
||||
|
||||
// Parse right side (remove quotes if it's a string literal)
|
||||
let rightValue = rightExpr.trim()
|
||||
if (rightValue.startsWith('"') && rightValue.endsWith('"')) {
|
||||
rightValue = rightValue.slice(1, -1)
|
||||
}
|
||||
console.log(` - Right value: "${rightValue}" (type: ${typeof rightValue})`)
|
||||
|
||||
const conditionResult = leftResult === rightValue
|
||||
console.log(` - Condition result: ${conditionResult} (${leftResult} === ${rightValue})`)
|
||||
}
|
||||
|
||||
} catch (error) {
|
||||
console.error('❌ JSONPath evaluation failed:', error.message)
|
||||
}
|
||||
|
||||
// Step 4: Test workflow trigger matching logic
|
||||
console.log('\n🎯 Step 4: Testing trigger matching logic...')
|
||||
|
||||
for (const workflow of workflows.docs) {
|
||||
console.log(`\nChecking workflow: "${workflow.name}"`)
|
||||
|
||||
const triggers = workflow.triggers
|
||||
if (!triggers || !Array.isArray(triggers)) {
|
||||
console.log(' ❌ No triggers found')
|
||||
continue
|
||||
}
|
||||
|
||||
for (const trigger of triggers) {
|
||||
console.log(` Trigger details:`)
|
||||
console.log(` - Type: ${trigger.type}`)
|
||||
console.log(` - Collection: ${trigger.collection}`)
|
||||
console.log(` - CollectionSlug: ${trigger.collectionSlug}`)
|
||||
console.log(` - Operation: ${trigger.operation}`)
|
||||
console.log(` - Condition: ${trigger.condition}`)
|
||||
|
||||
// Check basic matching criteria
|
||||
const typeMatch = trigger.type === 'collection-trigger'
|
||||
const collectionMatch = trigger.collection === 'orders' || trigger.collectionSlug === 'orders'
|
||||
const operationMatch = trigger.operation === 'update'
|
||||
|
||||
console.log(` - Type match: ${typeMatch}`)
|
||||
console.log(` - Collection match: ${collectionMatch}`)
|
||||
console.log(` - Operation match: ${operationMatch}`)
|
||||
|
||||
if (typeMatch && collectionMatch && operationMatch) {
|
||||
console.log(` ✅ Basic trigger criteria match!`)
|
||||
|
||||
if (trigger.condition) {
|
||||
console.log(` Testing condition: ${trigger.condition}`)
|
||||
// Note: We'd need to call the actual evaluateCondition method here
|
||||
// but we're simulating the logic
|
||||
} else {
|
||||
console.log(` ✅ No condition required - this trigger should fire!`)
|
||||
}
|
||||
} else {
|
||||
console.log(` ❌ Basic trigger criteria don't match`)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Step 5: Update order and trace hook execution
|
||||
console.log('\n🔄 Step 5: Updating order status to trigger workflow...')
|
||||
|
||||
console.log('Before update - checking existing workflow runs:')
|
||||
const beforeRuns = await payload.find({
|
||||
collection: 'workflow-runs'
|
||||
})
|
||||
console.log(` Existing workflow runs: ${beforeRuns.docs.length}`)
|
||||
|
||||
console.log('\nUpdating order status to "Paid"...')
|
||||
const updatedOrder = await payload.update({
|
||||
collection: 'orders',
|
||||
id: testOrder.id,
|
||||
data: {
|
||||
status: 'Paid'
|
||||
}
|
||||
})
|
||||
|
||||
console.log(`Order updated successfully. New status: "${updatedOrder.status}"`)
|
||||
|
||||
// Wait a moment for async processing
|
||||
await new Promise(resolve => setTimeout(resolve, 3000))
|
||||
|
||||
console.log('\nAfter update - checking for new workflow runs:')
|
||||
const afterRuns = await payload.find({
|
||||
collection: 'workflow-runs'
|
||||
})
|
||||
console.log(` Total workflow runs: ${afterRuns.docs.length}`)
|
||||
console.log(` New runs created: ${afterRuns.docs.length - beforeRuns.docs.length}`)
|
||||
|
||||
if (afterRuns.docs.length > beforeRuns.docs.length) {
|
||||
const newRuns = afterRuns.docs.slice(0, afterRuns.docs.length - beforeRuns.docs.length)
|
||||
for (const run of newRuns) {
|
||||
console.log(` - Run ID: ${run.id}`)
|
||||
console.log(` - Workflow: ${run.workflow}`)
|
||||
console.log(` - Status: ${run.status}`)
|
||||
console.log(` - Context: ${JSON.stringify(run.context, null, 2)}`)
|
||||
}
|
||||
}
|
||||
|
||||
// Step 6: Check job queue
|
||||
console.log('\n⚙️ Step 6: Checking job queue...')
|
||||
const jobs = await payload.find({
|
||||
collection: 'payload-jobs',
|
||||
sort: '-createdAt',
|
||||
limit: 10
|
||||
})
|
||||
|
||||
console.log(`Recent jobs in queue: ${jobs.docs.length}`)
|
||||
for (const job of jobs.docs.slice(0, 5)) {
|
||||
console.log(` - Job ${job.id}: ${job.taskSlug} (${job.processingError ? 'ERROR' : 'OK'})`)
|
||||
}
|
||||
|
||||
console.log('\n✨ Debugging complete!')
|
||||
process.exit(0)
|
||||
}
|
||||
|
||||
debugWorkflowExecution().catch(console.error)
|
||||
@@ -1,177 +0,0 @@
|
||||
// Enhanced debugging patch for workflow executor
|
||||
// This temporarily patches the workflow executor to add comprehensive logging
|
||||
|
||||
import { getPayload } from 'payload'
|
||||
|
||||
async function patchAndTestWorkflow() {
|
||||
const payload = await getPayload({
|
||||
config: (await import('./dev/payload.config.ts')).default
|
||||
})
|
||||
|
||||
console.log('🔧 === COMPREHENSIVE WORKFLOW DEBUGGING ===')
|
||||
|
||||
// Step 1: Check workflow collection structure and versioning
|
||||
console.log('\n📋 Step 1: Analyzing workflow collection configuration...')
|
||||
|
||||
const workflowCollection = payload.collections.workflows
|
||||
console.log('Workflow collection config:')
|
||||
console.log(' - Slug:', workflowCollection.config.slug)
|
||||
console.log(' - Versions enabled:', !!workflowCollection.config.versions)
|
||||
console.log(' - Drafts enabled:', !!workflowCollection.config.versions?.drafts)
|
||||
|
||||
// Step 2: Test different query approaches for workflows
|
||||
console.log('\n🔍 Step 2: Testing workflow queries...')
|
||||
|
||||
// Query 1: Default query (what the plugin currently uses)
|
||||
console.log('Query 1: Default query (no status filter)')
|
||||
try {
|
||||
const workflows1 = await payload.find({
|
||||
collection: 'workflows',
|
||||
depth: 2,
|
||||
limit: 100
|
||||
})
|
||||
console.log(` - Found: ${workflows1.docs.length} workflows`)
|
||||
for (const wf of workflows1.docs) {
|
||||
console.log(` - "${wf.name}" (ID: ${wf.id}) Status: ${wf._status || 'no-status'}`)
|
||||
}
|
||||
} catch (error) {
|
||||
console.log(` - Error: ${error.message}`)
|
||||
}
|
||||
|
||||
// Query 2: Only published workflows
|
||||
console.log('\nQuery 2: Only published workflows')
|
||||
try {
|
||||
const workflows2 = await payload.find({
|
||||
collection: 'workflows',
|
||||
depth: 2,
|
||||
limit: 100,
|
||||
where: {
|
||||
_status: {
|
||||
equals: 'published'
|
||||
}
|
||||
}
|
||||
})
|
||||
console.log(` - Found: ${workflows2.docs.length} published workflows`)
|
||||
for (const wf of workflows2.docs) {
|
||||
console.log(` - "${wf.name}" (ID: ${wf.id}) Status: ${wf._status}`)
|
||||
console.log(` Triggers: ${JSON.stringify(wf.triggers, null, 2)}`)
|
||||
}
|
||||
} catch (error) {
|
||||
console.log(` - Error: ${error.message}`)
|
||||
}
|
||||
|
||||
// Query 3: All workflows with explicit status
|
||||
console.log('\nQuery 3: All workflows with status field')
|
||||
try {
|
||||
const workflows3 = await payload.find({
|
||||
collection: 'workflows',
|
||||
depth: 2,
|
||||
limit: 100,
|
||||
where: {
|
||||
_status: {
|
||||
exists: true
|
||||
}
|
||||
}
|
||||
})
|
||||
console.log(` - Found: ${workflows3.docs.length} workflows with status`)
|
||||
for (const wf of workflows3.docs) {
|
||||
console.log(` - "${wf.name}" Status: ${wf._status}`)
|
||||
}
|
||||
} catch (error) {
|
||||
console.log(` - Error: ${error.message}`)
|
||||
}
|
||||
|
||||
// Step 3: Create a test order and manually trigger the evaluation
|
||||
console.log('\n📦 Step 3: Creating test order...')
|
||||
|
||||
const testOrder = await payload.create({
|
||||
collection: 'orders',
|
||||
data: {
|
||||
orderName: 'Debug Comprehensive Test - ' + Date.now(),
|
||||
status: 'Unpaid',
|
||||
customerEmail: 'debug@example.com',
|
||||
totalPrice: 1000,
|
||||
items: [{
|
||||
name: 'Debug Item',
|
||||
quantity: 1,
|
||||
price: 1000
|
||||
}]
|
||||
}
|
||||
})
|
||||
|
||||
console.log(`Created order: ${testOrder.id} with status: ${testOrder.status}`)
|
||||
|
||||
// Step 4: Test the WorkflowExecutor.executeTriggeredWorkflows method directly
|
||||
console.log('\n🎯 Step 4: Testing executeTriggeredWorkflows directly...')
|
||||
|
||||
// Access the workflow executor (this might require accessing internal plugin state)
|
||||
// For now, let's simulate what should happen
|
||||
|
||||
console.log('Simulating executeTriggeredWorkflows call...')
|
||||
console.log(' - Collection: orders')
|
||||
console.log(' - Operation: update')
|
||||
console.log(' - Doc: { ...order, status: "Paid" }')
|
||||
console.log(' - PreviousDoc:', JSON.stringify(testOrder, null, 2))
|
||||
|
||||
// Step 5: Update the order and capture all logs
|
||||
console.log('\n🔄 Step 5: Updating order with comprehensive logging...')
|
||||
|
||||
// First, let's check what hooks are actually registered
|
||||
const orderCollection = payload.collections.orders
|
||||
console.log('Order collection hooks:')
|
||||
console.log(' - afterChange hooks:', orderCollection.config.hooks?.afterChange?.length || 0)
|
||||
|
||||
// Count current workflow runs before
|
||||
const beforeRuns = await payload.find({ collection: 'workflow-runs' })
|
||||
console.log(`Current workflow runs: ${beforeRuns.docs.length}`)
|
||||
|
||||
// Update the order
|
||||
console.log('\nUpdating order status to "Paid"...')
|
||||
const updatedOrder = await payload.update({
|
||||
collection: 'orders',
|
||||
id: testOrder.id,
|
||||
data: { status: 'Paid' }
|
||||
})
|
||||
|
||||
console.log(`Order updated: ${updatedOrder.status}`)
|
||||
|
||||
// Wait and check for workflow runs
|
||||
console.log('Waiting 5 seconds for async processing...')
|
||||
await new Promise(resolve => setTimeout(resolve, 5000))
|
||||
|
||||
const afterRuns = await payload.find({ collection: 'workflow-runs' })
|
||||
console.log(`Workflow runs after: ${afterRuns.docs.length}`)
|
||||
console.log(`New runs created: ${afterRuns.docs.length - beforeRuns.docs.length}`)
|
||||
|
||||
if (afterRuns.docs.length > beforeRuns.docs.length) {
|
||||
console.log('✅ New workflow runs found!')
|
||||
const newRuns = afterRuns.docs.slice(0, afterRuns.docs.length - beforeRuns.docs.length)
|
||||
for (const run of newRuns) {
|
||||
console.log(` - Run ${run.id}: ${run.status}`)
|
||||
}
|
||||
} else {
|
||||
console.log('❌ No new workflow runs created')
|
||||
|
||||
// Additional debugging
|
||||
console.log('\n🕵️ Deep debugging - checking plugin state...')
|
||||
|
||||
// Check if the plugin is actually loaded
|
||||
console.log('Available collections:', Object.keys(payload.collections))
|
||||
|
||||
// Check for recent jobs
|
||||
const recentJobs = await payload.find({
|
||||
collection: 'payload-jobs',
|
||||
sort: '-createdAt',
|
||||
limit: 5
|
||||
})
|
||||
console.log(`Recent jobs: ${recentJobs.docs.length}`)
|
||||
for (const job of recentJobs.docs) {
|
||||
console.log(` - ${job.taskSlug} (${job.processingError ? 'ERROR' : 'OK'})`)
|
||||
}
|
||||
}
|
||||
|
||||
console.log('\n✨ Comprehensive debugging complete!')
|
||||
process.exit(0)
|
||||
}
|
||||
|
||||
patchAndTestWorkflow().catch(console.error)
|
||||
@@ -217,7 +217,7 @@ export interface Workflow {
|
||||
/**
|
||||
* Collection that triggers the workflow
|
||||
*/
|
||||
collectionSlug?: 'posts' | null;
|
||||
collectionSlug?: ('posts' | 'media') | null;
|
||||
/**
|
||||
* Collection operation that triggers the workflow
|
||||
*/
|
||||
|
||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "@xtr-dev/payload-workflows",
|
||||
"version": "0.0.16",
|
||||
"version": "0.0.22",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@xtr-dev/payload-workflows",
|
||||
"version": "0.0.16",
|
||||
"version": "0.0.22",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"jsonpath-plus": "^10.3.0",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@xtr-dev/payload-automation",
|
||||
"version": "0.0.16",
|
||||
"version": "0.0.22",
|
||||
"description": "PayloadCMS Automation Plugin - Comprehensive workflow automation system with visual workflow building, execution tracking, and step types",
|
||||
"license": "MIT",
|
||||
"type": "module",
|
||||
|
||||
@@ -197,11 +197,17 @@ export const createWorkflowCollection: <T extends string>(options: WorkflowsPlug
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
name: 'input',
|
||||
type: 'json',
|
||||
required: false
|
||||
},
|
||||
...(steps || []).flatMap(step => (step.inputSchema || []).map(field => ({
|
||||
...field,
|
||||
admin: {
|
||||
...(field.admin || {}),
|
||||
condition: (...args) => args[1]?.step === step.slug && (
|
||||
field.admin?.condition ?
|
||||
field.admin.condition.call(this, ...args) :
|
||||
true
|
||||
),
|
||||
},
|
||||
} as Field))),
|
||||
{
|
||||
name: 'dependencies',
|
||||
type: 'text',
|
||||
|
||||
@@ -787,6 +787,13 @@ export class WorkflowExecutor {
|
||||
previousDoc: unknown,
|
||||
req: PayloadRequest
|
||||
): Promise<void> {
|
||||
console.log('🚨 EXECUTOR: executeTriggeredWorkflows called!')
|
||||
console.log('🚨 EXECUTOR: Collection =', collection)
|
||||
console.log('🚨 EXECUTOR: Operation =', operation)
|
||||
console.log('🚨 EXECUTOR: Doc ID =', (doc as any)?.id)
|
||||
console.log('🚨 EXECUTOR: Has payload?', !!this.payload)
|
||||
console.log('🚨 EXECUTOR: Has logger?', !!this.logger)
|
||||
|
||||
this.logger.info({
|
||||
collection,
|
||||
operation,
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import type {Config} from 'payload'
|
||||
|
||||
import type {WorkflowsPluginConfig} from "./config-types.js"
|
||||
import type {WorkflowsPluginConfig, CollectionTriggerConfigCrud} from "./config-types.js"
|
||||
|
||||
import {createWorkflowCollection} from '../collections/Workflow.js'
|
||||
import {WorkflowRunsCollection} from '../collections/WorkflowRuns.js'
|
||||
@@ -15,6 +15,24 @@ import {getConfigLogger, initializeLogger} from './logger.js'
|
||||
|
||||
export {getLogger} from './logger.js'
|
||||
|
||||
// Global executor registry for config-phase hooks
|
||||
let globalExecutor: WorkflowExecutor | null = null
|
||||
|
||||
const setWorkflowExecutor = (executor: WorkflowExecutor) => {
|
||||
console.log('🚨 SETTING GLOBAL EXECUTOR')
|
||||
globalExecutor = executor
|
||||
|
||||
// Also set on global object as fallback
|
||||
if (typeof global !== 'undefined') {
|
||||
(global as any).__workflowExecutor = executor
|
||||
console.log('🚨 EXECUTOR ALSO SET ON GLOBAL OBJECT')
|
||||
}
|
||||
}
|
||||
|
||||
const getWorkflowExecutor = (): WorkflowExecutor | null => {
|
||||
return globalExecutor
|
||||
}
|
||||
|
||||
const applyCollectionsConfig = <T extends string>(pluginOptions: WorkflowsPluginConfig<T>, config: Config) => {
|
||||
// Add workflow collections
|
||||
if (!config.collections) {
|
||||
@@ -27,6 +45,8 @@ const applyCollectionsConfig = <T extends string>(pluginOptions: WorkflowsPlugin
|
||||
)
|
||||
}
|
||||
|
||||
// Removed config-phase hook registration - user collections don't exist during config phase
|
||||
|
||||
|
||||
export const workflowsPlugin =
|
||||
<TSlug extends string>(pluginOptions: WorkflowsPluginConfig<TSlug>) =>
|
||||
@@ -37,6 +57,92 @@ 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
|
||||
|
||||
// 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 = {}
|
||||
}
|
||||
if (!collection.hooks.afterChange) {
|
||||
collection.hooks.afterChange = []
|
||||
}
|
||||
|
||||
// Create a properly bound hook function that doesn't rely on closures
|
||||
// Use a simple function that PayloadCMS can definitely execute
|
||||
const automationHook = Object.assign(
|
||||
async function payloadAutomationHook(args: any) {
|
||||
try {
|
||||
// Use global console to ensure output
|
||||
global.console.log('🔥🔥🔥 AUTOMATION HOOK EXECUTED! 🔥🔥🔥')
|
||||
global.console.log('Collection:', args?.collection?.slug)
|
||||
global.console.log('Operation:', args?.operation)
|
||||
global.console.log('Doc ID:', args?.doc?.id)
|
||||
|
||||
// Try multiple ways to get the executor
|
||||
let executor = null
|
||||
|
||||
// Method 1: Global registry
|
||||
if (typeof getWorkflowExecutor === 'function') {
|
||||
executor = getWorkflowExecutor()
|
||||
}
|
||||
|
||||
// Method 2: Global variable fallback
|
||||
if (!executor && typeof global !== 'undefined' && (global as any).__workflowExecutor) {
|
||||
executor = (global as any).__workflowExecutor
|
||||
global.console.log('Got executor from global variable')
|
||||
}
|
||||
|
||||
if (executor) {
|
||||
global.console.log('✅ Executor found - executing workflows!')
|
||||
await executor.executeTriggeredWorkflows(
|
||||
args.collection.slug,
|
||||
args.operation,
|
||||
args.doc,
|
||||
args.previousDoc,
|
||||
args.req
|
||||
)
|
||||
global.console.log('✅ Workflow execution completed!')
|
||||
} else {
|
||||
global.console.log('⚠️ No executor available')
|
||||
}
|
||||
} catch (error) {
|
||||
global.console.error('❌ Hook execution error:', error)
|
||||
// Don't throw - just log
|
||||
}
|
||||
|
||||
// Always return undefined to match other hooks
|
||||
return undefined
|
||||
},
|
||||
{
|
||||
// Add metadata to help debugging
|
||||
__isAutomationHook: true,
|
||||
__version: '0.0.21'
|
||||
}
|
||||
)
|
||||
|
||||
// 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}`)
|
||||
}
|
||||
}
|
||||
|
||||
if (!config.jobs) {
|
||||
config.jobs = {tasks: []}
|
||||
@@ -79,11 +185,16 @@ export const workflowsPlugin =
|
||||
logger.info(`Plugin configuration: ${Object.keys(pluginOptions.collectionTriggers || {}).length} collection triggers, ${pluginOptions.steps?.length || 0} steps`)
|
||||
|
||||
// Create workflow executor instance
|
||||
console.log('🚨 CREATING WORKFLOW EXECUTOR INSTANCE')
|
||||
const executor = new WorkflowExecutor(payload, logger)
|
||||
console.log('🚨 EXECUTOR CREATED:', typeof executor)
|
||||
console.log('🚨 EXECUTOR METHODS:', Object.getOwnPropertyNames(Object.getPrototypeOf(executor)))
|
||||
|
||||
// Register executor globally
|
||||
setWorkflowExecutor(executor)
|
||||
|
||||
// Initialize hooks
|
||||
logger.info('Initializing collection hooks...')
|
||||
initCollectionHooks(pluginOptions, payload, logger, executor)
|
||||
// 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)
|
||||
|
||||
@@ -39,14 +39,27 @@ export function initCollectionHooks<T extends string>(pluginOptions: WorkflowsPl
|
||||
collection.config.hooks.afterChange = collection.config.hooks.afterChange || []
|
||||
collection.config.hooks.afterChange.push(async (change) => {
|
||||
const operation = change.operation as 'create' | 'update'
|
||||
|
||||
// AGGRESSIVE LOGGING - this should ALWAYS appear
|
||||
console.log('🚨 AUTOMATION PLUGIN HOOK CALLED! 🚨')
|
||||
console.log('Collection:', change.collection.slug)
|
||||
console.log('Operation:', operation)
|
||||
console.log('Doc ID:', change.doc?.id)
|
||||
console.log('Has executor?', !!executor)
|
||||
console.log('Executor type:', typeof executor)
|
||||
|
||||
logger.info({
|
||||
slug: change.collection.slug,
|
||||
operation,
|
||||
docId: change.doc?.id,
|
||||
previousDocId: change.previousDoc?.id,
|
||||
hasExecutor: !!executor,
|
||||
executorType: typeof executor
|
||||
}, 'AUTOMATION PLUGIN: Collection hook triggered')
|
||||
|
||||
try {
|
||||
console.log('🚨 About to call executeTriggeredWorkflows')
|
||||
|
||||
// Execute workflows for this trigger
|
||||
await executor.executeTriggeredWorkflows(
|
||||
change.collection.slug,
|
||||
@@ -55,12 +68,17 @@ export function initCollectionHooks<T extends string>(pluginOptions: WorkflowsPl
|
||||
change.previousDoc,
|
||||
change.req
|
||||
)
|
||||
|
||||
console.log('🚨 executeTriggeredWorkflows completed without error')
|
||||
|
||||
logger.info({
|
||||
slug: change.collection.slug,
|
||||
operation,
|
||||
docId: change.doc?.id
|
||||
}, 'AUTOMATION PLUGIN: executeTriggeredWorkflows completed successfully')
|
||||
} catch (error) {
|
||||
console.log('🚨 AUTOMATION PLUGIN ERROR:', error)
|
||||
|
||||
logger.error({
|
||||
slug: change.collection.slug,
|
||||
operation,
|
||||
|
||||
@@ -1,115 +0,0 @@
|
||||
// Isolated JSONPath condition testing
|
||||
import { JSONPath } from 'jsonpath-plus'
|
||||
|
||||
function testJSONPathCondition() {
|
||||
console.log('🧪 Testing JSONPath condition evaluation in isolation')
|
||||
|
||||
// Simulate the exact context structure from workflow execution
|
||||
const testContext = {
|
||||
steps: {},
|
||||
trigger: {
|
||||
type: 'collection',
|
||||
collection: 'orders',
|
||||
doc: {
|
||||
id: '12345',
|
||||
orderName: 'Test Order',
|
||||
status: 'Paid', // This is the updated status
|
||||
customerEmail: 'test@example.com',
|
||||
totalPrice: 2500
|
||||
},
|
||||
operation: 'update',
|
||||
previousDoc: {
|
||||
id: '12345',
|
||||
orderName: 'Test Order',
|
||||
status: 'Unpaid', // This was the previous status
|
||||
customerEmail: 'test@example.com',
|
||||
totalPrice: 2500
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
console.log('Test context:')
|
||||
console.log(' - trigger.doc.status:', testContext.trigger.doc.status)
|
||||
console.log(' - trigger.previousDoc.status:', testContext.trigger.previousDoc.status)
|
||||
|
||||
// Test different JSONPath expressions
|
||||
const testCases = [
|
||||
'$.trigger.doc.status',
|
||||
'$.doc.status', // This is what your condition uses but might be wrong!
|
||||
'$.trigger.doc.status == "Paid"',
|
||||
'$.trigger.doc.status == "Unpaid"'
|
||||
]
|
||||
|
||||
console.log('\n📋 Testing JSONPath expressions:')
|
||||
|
||||
for (const expression of testCases) {
|
||||
try {
|
||||
const result = JSONPath({
|
||||
json: testContext,
|
||||
path: expression,
|
||||
wrap: false
|
||||
})
|
||||
|
||||
console.log(` ✅ ${expression} => ${JSON.stringify(result)} (${typeof result})`)
|
||||
} catch (error) {
|
||||
console.log(` ❌ ${expression} => ERROR: ${error.message}`)
|
||||
}
|
||||
}
|
||||
|
||||
// Test comparison logic manually
|
||||
console.log('\n🔍 Testing comparison logic:')
|
||||
|
||||
const condition = '$.doc.status == "Paid"' // Your original condition
|
||||
const correctCondition = '$.trigger.doc.status == "Paid"' // Likely correct path
|
||||
|
||||
console.log(`\nTesting: ${condition}`)
|
||||
try {
|
||||
const leftResult = JSONPath({
|
||||
json: testContext,
|
||||
path: '$.doc.status',
|
||||
wrap: false
|
||||
})
|
||||
console.log(` - Left side result: ${JSON.stringify(leftResult)}`)
|
||||
console.log(` - Is undefined/null? ${leftResult === undefined || leftResult === null}`)
|
||||
console.log(` - Comparison result: ${leftResult === 'Paid'}`)
|
||||
} catch (error) {
|
||||
console.log(` - Error: ${error.message}`)
|
||||
}
|
||||
|
||||
console.log(`\nTesting: ${correctCondition}`)
|
||||
try {
|
||||
const leftResult = JSONPath({
|
||||
json: testContext,
|
||||
path: '$.trigger.doc.status',
|
||||
wrap: false
|
||||
})
|
||||
console.log(` - Left side result: ${JSON.stringify(leftResult)}`)
|
||||
console.log(` - Comparison result: ${leftResult === 'Paid'}`)
|
||||
} catch (error) {
|
||||
console.log(` - Error: ${error.message}`)
|
||||
}
|
||||
|
||||
// Test regex parsing
|
||||
console.log('\n📝 Testing regex parsing:')
|
||||
const testConditions = [
|
||||
'$.trigger.doc.status == "Paid"',
|
||||
'$.doc.status == "Paid"',
|
||||
'$.trigger.doc.status=="Paid"', // No spaces
|
||||
"$.trigger.doc.status == 'Paid'" // Single quotes
|
||||
]
|
||||
|
||||
for (const cond of testConditions) {
|
||||
const comparisonMatch = cond.match(/^(.+?)\s*(==|!=|>|<|>=|<=)\s*(.+)$/)
|
||||
if (comparisonMatch) {
|
||||
const [, leftExpr, operator, rightExpr] = comparisonMatch
|
||||
console.log(` ✅ ${cond}`)
|
||||
console.log(` - Left: "${leftExpr.trim()}"`)
|
||||
console.log(` - Operator: "${operator}"`)
|
||||
console.log(` - Right: "${rightExpr.trim()}"`)
|
||||
} else {
|
||||
console.log(` ❌ ${cond} - No regex match`)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
testJSONPathCondition()
|
||||
@@ -1,44 +0,0 @@
|
||||
// Test script to verify published workflow filtering
|
||||
console.log('🔍 Testing published workflow filtering...')
|
||||
|
||||
// This will be run from the dev environment
|
||||
// Start the dev server first: pnpm dev
|
||||
// Then in another terminal: node test-published-workflows.js
|
||||
|
||||
const testData = {
|
||||
// Simulate what the workflow executor should find
|
||||
allWorkflows: [
|
||||
{
|
||||
id: 1,
|
||||
name: 'Draft Workflow',
|
||||
_status: 'draft',
|
||||
triggers: [{ type: 'collection-trigger', collectionSlug: 'orders', operation: 'update' }]
|
||||
},
|
||||
{
|
||||
id: 2,
|
||||
name: 'Published Workflow',
|
||||
_status: 'published',
|
||||
triggers: [{ type: 'collection-trigger', collectionSlug: 'orders', operation: 'update' }]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
// Test filtering logic
|
||||
const publishedOnly = testData.allWorkflows.filter(wf => wf._status === 'published')
|
||||
|
||||
console.log('All workflows:', testData.allWorkflows.length)
|
||||
console.log('Published workflows:', publishedOnly.length)
|
||||
console.log('Published workflow names:', publishedOnly.map(wf => wf.name))
|
||||
|
||||
console.log('\n✅ The published status filter should work!')
|
||||
console.log('💡 Make sure your workflow has _status: "published" in the database')
|
||||
|
||||
// Instructions for manual verification
|
||||
console.log('\n📋 Manual verification steps:')
|
||||
console.log('1. Start dev server: pnpm dev')
|
||||
console.log('2. Go to http://localhost:3000/admin/collections/workflows')
|
||||
console.log('3. Find your workflow and ensure it shows as "Published" (not "Draft")')
|
||||
console.log('4. If it shows as "Draft", click it and click "Publish"')
|
||||
console.log('5. Then test your order status change again')
|
||||
|
||||
process.exit(0)
|
||||
@@ -1,113 +0,0 @@
|
||||
// Test script to create workflow with correct v0.0.15 schema structure
|
||||
const { getPayload } = require('payload')
|
||||
|
||||
async function testWorkflowCreation() {
|
||||
const payload = await getPayload({
|
||||
config: require('./dev/payload.config.ts').default
|
||||
})
|
||||
|
||||
console.log('🚀 Creating workflow with v0.0.15 schema...')
|
||||
|
||||
try {
|
||||
const workflow = await payload.create({
|
||||
collection: 'workflows',
|
||||
data: {
|
||||
name: 'Test Order Status Workflow v0.0.15',
|
||||
description: 'Test workflow that triggers when order status changes to Paid',
|
||||
enabled: true,
|
||||
triggers: [
|
||||
{
|
||||
type: 'collection-trigger',
|
||||
collectionSlug: 'orders',
|
||||
operation: 'update',
|
||||
// v0.0.15 uses 'condition' (singular) with JSONPath expressions
|
||||
// instead of 'conditions' array
|
||||
condition: '$.doc.status == "Paid"'
|
||||
}
|
||||
],
|
||||
steps: [
|
||||
{
|
||||
// v0.0.15 uses 'step' field instead of 'type'
|
||||
step: 'uppercaseText',
|
||||
name: 'Test Uppercase Step',
|
||||
// v0.0.15 uses 'input' (singular) instead of 'inputs'
|
||||
input: {
|
||||
inputText: 'Order {{$.trigger.doc.orderName}} has been paid!'
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
console.log('✅ Workflow created successfully!')
|
||||
console.log('📋 Workflow details:')
|
||||
console.log(' - ID:', workflow.id)
|
||||
console.log(' - Name:', workflow.name)
|
||||
console.log(' - Triggers:', JSON.stringify(workflow.triggers, null, 2))
|
||||
console.log(' - Steps:', JSON.stringify(workflow.steps, null, 2))
|
||||
|
||||
// Now test with an order update
|
||||
console.log('\n🔄 Testing order status change...')
|
||||
|
||||
// First create a test order
|
||||
const order = await payload.create({
|
||||
collection: 'orders',
|
||||
data: {
|
||||
orderName: 'Test Order - ' + Date.now(),
|
||||
status: 'Unpaid',
|
||||
customerEmail: 'test@example.com',
|
||||
totalPrice: 2500,
|
||||
items: [
|
||||
{
|
||||
name: 'Test Item',
|
||||
quantity: 1,
|
||||
price: 2500
|
||||
}
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
console.log('📦 Test order created:', order.id)
|
||||
|
||||
// Update order status to trigger workflow
|
||||
const updatedOrder = await payload.update({
|
||||
collection: 'orders',
|
||||
id: order.id,
|
||||
data: {
|
||||
status: 'Paid'
|
||||
}
|
||||
})
|
||||
|
||||
console.log('💰 Order status updated to:', updatedOrder.status)
|
||||
|
||||
// Wait a moment for async workflow execution
|
||||
await new Promise(resolve => setTimeout(resolve, 2000))
|
||||
|
||||
// Check for workflow runs
|
||||
const workflowRuns = await payload.find({
|
||||
collection: 'workflow-runs',
|
||||
where: {
|
||||
workflow: {
|
||||
equals: workflow.id
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
console.log(`\n📊 Workflow runs found: ${workflowRuns.docs.length}`)
|
||||
|
||||
if (workflowRuns.docs.length > 0) {
|
||||
const run = workflowRuns.docs[0]
|
||||
console.log(' - Run ID:', run.id)
|
||||
console.log(' - Status:', run.status)
|
||||
console.log(' - Context:', JSON.stringify(run.context, null, 2))
|
||||
}
|
||||
|
||||
} catch (error) {
|
||||
console.error('❌ Error:', error.message)
|
||||
console.error('Stack:', error.stack)
|
||||
}
|
||||
|
||||
process.exit(0)
|
||||
}
|
||||
|
||||
testWorkflowCreation()
|
||||
Reference in New Issue
Block a user