Add events to workflows
This commit is contained in:
Dries Augustyns
@@ -599,6 +599,197 @@ describe('EventService', () => {
|
||||
});
|
||||
});
|
||||
|
||||
// ========================================
|
||||
// FIELD DISCOVERY
|
||||
// ========================================
|
||||
describe('getAvailableEventFields', () => {
|
||||
it('should discover fields from event data', async () => {
|
||||
const contact = await factories.createContact({projectId});
|
||||
|
||||
// Create events with various fields
|
||||
await EventService.trackEvent(projectId, 'email.opened', contact.id, undefined, {
|
||||
subject: 'Welcome',
|
||||
from: 'hello@example.com',
|
||||
openedAt: new Date().toISOString(),
|
||||
});
|
||||
|
||||
await EventService.trackEvent(projectId, 'email.opened', contact.id, undefined, {
|
||||
subject: 'Newsletter',
|
||||
from: 'news@example.com',
|
||||
isFirstOpen: true,
|
||||
opens: 1,
|
||||
});
|
||||
|
||||
const fields = await EventService.getAvailableEventFields(projectId, 'email.opened');
|
||||
|
||||
expect(fields).toContain('event.subject');
|
||||
expect(fields).toContain('event.from');
|
||||
expect(fields).toContain('event.openedAt');
|
||||
expect(fields).toContain('event.isFirstOpen');
|
||||
expect(fields).toContain('event.opens');
|
||||
expect(fields).toHaveLength(5);
|
||||
});
|
||||
|
||||
it('should filter fields by event name', async () => {
|
||||
const contact = await factories.createContact({projectId});
|
||||
|
||||
// Create email.opened events
|
||||
await EventService.trackEvent(projectId, 'email.opened', contact.id, undefined, {
|
||||
subject: 'Test',
|
||||
openedAt: new Date().toISOString(),
|
||||
});
|
||||
|
||||
// Create email.clicked events
|
||||
await EventService.trackEvent(projectId, 'email.clicked', contact.id, undefined, {
|
||||
subject: 'Test',
|
||||
link: 'https://example.com',
|
||||
clickedAt: new Date().toISOString(),
|
||||
});
|
||||
|
||||
// Get fields for email.opened only
|
||||
const openedFields = await EventService.getAvailableEventFields(projectId, 'email.opened');
|
||||
|
||||
expect(openedFields).toContain('event.subject');
|
||||
expect(openedFields).toContain('event.openedAt');
|
||||
expect(openedFields).not.toContain('event.link');
|
||||
expect(openedFields).not.toContain('event.clickedAt');
|
||||
});
|
||||
|
||||
it('should return all event fields when no event name specified', async () => {
|
||||
const contact = await factories.createContact({projectId});
|
||||
|
||||
await EventService.trackEvent(projectId, 'email.opened', contact.id, undefined, {
|
||||
openedAt: new Date().toISOString(),
|
||||
});
|
||||
|
||||
await EventService.trackEvent(projectId, 'email.clicked', contact.id, undefined, {
|
||||
link: 'https://example.com',
|
||||
});
|
||||
|
||||
const allFields = await EventService.getAvailableEventFields(projectId);
|
||||
|
||||
expect(allFields).toContain('event.openedAt');
|
||||
expect(allFields).toContain('event.link');
|
||||
});
|
||||
|
||||
it('should return empty array when no events exist', async () => {
|
||||
const fields = await EventService.getAvailableEventFields(projectId, 'nonexistent.event');
|
||||
|
||||
expect(fields).toHaveLength(0);
|
||||
});
|
||||
|
||||
it('should ignore events with null data', async () => {
|
||||
const contact = await factories.createContact({projectId});
|
||||
|
||||
// Event without data
|
||||
await EventService.trackEvent(projectId, 'simple.event', contact.id);
|
||||
|
||||
// Event with data
|
||||
await EventService.trackEvent(projectId, 'simple.event', contact.id, undefined, {
|
||||
field1: 'value1',
|
||||
});
|
||||
|
||||
const fields = await EventService.getAvailableEventFields(projectId, 'simple.event');
|
||||
|
||||
expect(fields).toEqual(['event.field1']);
|
||||
});
|
||||
|
||||
it('should handle nested field structures', async () => {
|
||||
const contact = await factories.createContact({projectId});
|
||||
|
||||
await EventService.trackEvent(projectId, 'complex.event', contact.id, undefined, {
|
||||
user: {
|
||||
name: 'John',
|
||||
email: 'john@example.com',
|
||||
},
|
||||
metadata: {
|
||||
source: 'web',
|
||||
},
|
||||
});
|
||||
|
||||
const fields = await EventService.getAvailableEventFields(projectId, 'complex.event');
|
||||
|
||||
// Should return top-level keys
|
||||
expect(fields).toContain('event.user');
|
||||
expect(fields).toContain('event.metadata');
|
||||
});
|
||||
|
||||
it('should deduplicate fields across multiple events', async () => {
|
||||
const contact = await factories.createContact({projectId});
|
||||
|
||||
// Create 5 events with same fields
|
||||
for (let i = 0; i < 5; i++) {
|
||||
await EventService.trackEvent(projectId, 'test.event', contact.id, undefined, {
|
||||
field1: `value${i}`,
|
||||
field2: `value${i}`,
|
||||
});
|
||||
}
|
||||
|
||||
const fields = await EventService.getAvailableEventFields(projectId, 'test.event');
|
||||
|
||||
expect(fields).toEqual(['event.field1', 'event.field2']);
|
||||
});
|
||||
|
||||
it('should respect 100 event sample limit for performance', async () => {
|
||||
const contact = await factories.createContact({projectId});
|
||||
|
||||
// Create 150 events with different fields
|
||||
for (let i = 0; i < 150; i++) {
|
||||
await EventService.trackEvent(projectId, 'test.event', contact.id, undefined, {
|
||||
[`field${i}`]: `value${i}`,
|
||||
});
|
||||
}
|
||||
|
||||
const fields = await EventService.getAvailableEventFields(projectId, 'test.event');
|
||||
|
||||
// Should sample only last 100 events (most recent)
|
||||
// So we should see field50-field149 (100 fields)
|
||||
expect(fields.length).toBeLessThanOrEqual(100);
|
||||
});
|
||||
|
||||
it('should return fields in alphabetical order', async () => {
|
||||
const contact = await factories.createContact({projectId});
|
||||
|
||||
await EventService.trackEvent(projectId, 'test.event', contact.id, undefined, {
|
||||
zebra: 'last',
|
||||
apple: 'first',
|
||||
middle: 'middle',
|
||||
});
|
||||
|
||||
const fields = await EventService.getAvailableEventFields(projectId, 'test.event');
|
||||
|
||||
expect(fields).toEqual(['event.apple', 'event.middle', 'event.zebra']);
|
||||
});
|
||||
|
||||
it('should handle email event data structure', async () => {
|
||||
const contact = await factories.createContact({projectId});
|
||||
const email = await factories.createEmail(projectId, contact.id);
|
||||
|
||||
// Simulate actual email.sent event data
|
||||
await EventService.trackEvent(projectId, 'email.sent', contact.id, email.id, {
|
||||
subject: 'Welcome Email',
|
||||
from: 'hello@example.com',
|
||||
fromName: 'Example Team',
|
||||
messageId: 'msg-123',
|
||||
templateId: 'tpl-456',
|
||||
campaignId: null,
|
||||
sourceType: 'TRANSACTIONAL',
|
||||
sentAt: new Date().toISOString(),
|
||||
});
|
||||
|
||||
const fields = await EventService.getAvailableEventFields(projectId, 'email.sent');
|
||||
|
||||
expect(fields).toContain('event.subject');
|
||||
expect(fields).toContain('event.from');
|
||||
expect(fields).toContain('event.fromName');
|
||||
expect(fields).toContain('event.messageId');
|
||||
expect(fields).toContain('event.templateId');
|
||||
expect(fields).toContain('event.campaignId');
|
||||
expect(fields).toContain('event.sourceType');
|
||||
expect(fields).toContain('event.sentAt');
|
||||
});
|
||||
});
|
||||
|
||||
describe('Event Data - Persistent vs Non-Persistent', () => {
|
||||
it('should store all event data (persistent + non-persistent) in event record', async () => {
|
||||
const contact = await factories.createContact({projectId});
|
||||
|
||||
@@ -954,4 +954,299 @@ describe('WorkflowExecutionService - Integration Tests', () => {
|
||||
expect(savedContact?.data).not.toHaveProperty('trackingUrl');
|
||||
});
|
||||
});
|
||||
|
||||
// ========================================
|
||||
// EVENT DATA IN WORKFLOW CONDITIONS
|
||||
// ========================================
|
||||
describe('Event Data in Workflow Conditions', () => {
|
||||
it('should evaluate conditions using event.* fields', async () => {
|
||||
const contact = await factories.createContact({projectId});
|
||||
const workflow = await factories.createWorkflow({projectId});
|
||||
|
||||
const triggerStep = await prisma.workflowStep.findFirst({
|
||||
where: {workflowId: workflow.id, type: 'TRIGGER'},
|
||||
});
|
||||
|
||||
// Create condition step that checks event data
|
||||
const conditionStep = await prisma.workflowStep.create({
|
||||
data: {
|
||||
workflowId: workflow.id,
|
||||
type: WorkflowStepType.CONDITION,
|
||||
name: 'Check if first open',
|
||||
position: {x: 100, y: 0},
|
||||
config: {
|
||||
field: 'event.isFirstOpen',
|
||||
operator: 'equals',
|
||||
value: true, // Use boolean, not string
|
||||
} as Prisma.InputJsonValue,
|
||||
},
|
||||
});
|
||||
|
||||
const yesStep = await prisma.workflowStep.create({
|
||||
data: {
|
||||
workflowId: workflow.id,
|
||||
type: WorkflowStepType.EXIT,
|
||||
name: 'First Open',
|
||||
position: {x: 200, y: 0},
|
||||
config: {reason: 'first_open'} as Prisma.InputJsonValue,
|
||||
},
|
||||
});
|
||||
|
||||
const noStep = await prisma.workflowStep.create({
|
||||
data: {
|
||||
workflowId: workflow.id,
|
||||
type: WorkflowStepType.EXIT,
|
||||
name: 'Not First Open',
|
||||
position: {x: 200, y: 100},
|
||||
config: {reason: 'not_first_open'} as Prisma.InputJsonValue,
|
||||
},
|
||||
});
|
||||
|
||||
// Connect steps
|
||||
await prisma.workflowTransition.create({
|
||||
data: {fromStepId: triggerStep!.id, toStepId: conditionStep.id},
|
||||
});
|
||||
await prisma.workflowTransition.create({
|
||||
data: {fromStepId: conditionStep.id, toStepId: yesStep.id, condition: {branch: 'yes'} as Prisma.InputJsonValue},
|
||||
});
|
||||
await prisma.workflowTransition.create({
|
||||
data: {fromStepId: conditionStep.id, toStepId: noStep.id, condition: {branch: 'no'} as Prisma.InputJsonValue},
|
||||
});
|
||||
|
||||
// Create execution with event data
|
||||
const execution = await prisma.workflowExecution.create({
|
||||
data: {
|
||||
workflowId: workflow.id,
|
||||
contactId: contact.id,
|
||||
status: WorkflowExecutionStatus.RUNNING,
|
||||
currentStepId: triggerStep!.id,
|
||||
context: {
|
||||
subject: 'Welcome Email',
|
||||
from: 'hello@example.com',
|
||||
isFirstOpen: true,
|
||||
openedAt: new Date().toISOString(),
|
||||
} as Prisma.InputJsonValue,
|
||||
},
|
||||
});
|
||||
|
||||
// Process the workflow
|
||||
await WorkflowExecutionService.processStepExecution(execution.id, triggerStep!.id);
|
||||
|
||||
// Verify it followed YES branch (first open)
|
||||
const completedExecution = await prisma.workflowExecution.findUnique({
|
||||
where: {id: execution.id},
|
||||
include: {stepExecutions: true},
|
||||
});
|
||||
|
||||
expect(completedExecution?.status).toBe(WorkflowExecutionStatus.COMPLETED);
|
||||
expect(completedExecution?.exitReason).toBe('first_open');
|
||||
});
|
||||
|
||||
it('should evaluate conditions using event.subject field', async () => {
|
||||
const contact = await factories.createContact({projectId});
|
||||
const workflow = await factories.createWorkflow({projectId});
|
||||
|
||||
const triggerStep = await prisma.workflowStep.findFirst({
|
||||
where: {workflowId: workflow.id, type: 'TRIGGER'},
|
||||
});
|
||||
|
||||
const conditionStep = await prisma.workflowStep.create({
|
||||
data: {
|
||||
workflowId: workflow.id,
|
||||
type: WorkflowStepType.CONDITION,
|
||||
name: 'Check subject',
|
||||
position: {x: 100, y: 0},
|
||||
config: {
|
||||
field: 'event.subject',
|
||||
operator: 'contains',
|
||||
value: 'Welcome',
|
||||
} as Prisma.InputJsonValue,
|
||||
},
|
||||
});
|
||||
|
||||
const exitStep = await prisma.workflowStep.create({
|
||||
data: {
|
||||
workflowId: workflow.id,
|
||||
type: WorkflowStepType.EXIT,
|
||||
name: 'Done',
|
||||
position: {x: 200, y: 0},
|
||||
config: {reason: 'matched'} as Prisma.InputJsonValue,
|
||||
},
|
||||
});
|
||||
|
||||
await prisma.workflowTransition.create({
|
||||
data: {fromStepId: triggerStep!.id, toStepId: conditionStep.id},
|
||||
});
|
||||
await prisma.workflowTransition.create({
|
||||
data: {fromStepId: conditionStep.id, toStepId: exitStep.id, condition: {branch: 'yes'} as Prisma.InputJsonValue},
|
||||
});
|
||||
|
||||
const execution = await prisma.workflowExecution.create({
|
||||
data: {
|
||||
workflowId: workflow.id,
|
||||
contactId: contact.id,
|
||||
status: WorkflowExecutionStatus.RUNNING,
|
||||
currentStepId: triggerStep!.id,
|
||||
context: {
|
||||
subject: 'Welcome to Plunk!',
|
||||
from: 'team@plunk.com',
|
||||
} as Prisma.InputJsonValue,
|
||||
},
|
||||
});
|
||||
|
||||
await WorkflowExecutionService.processStepExecution(execution.id, triggerStep!.id);
|
||||
|
||||
const completedExecution = await prisma.workflowExecution.findUnique({
|
||||
where: {id: execution.id},
|
||||
});
|
||||
|
||||
expect(completedExecution?.status).toBe(WorkflowExecutionStatus.COMPLETED);
|
||||
expect(completedExecution?.exitReason).toBe('matched');
|
||||
});
|
||||
|
||||
it('should handle numeric event fields in conditions', async () => {
|
||||
const contact = await factories.createContact({projectId});
|
||||
const workflow = await factories.createWorkflow({projectId});
|
||||
|
||||
const triggerStep = await prisma.workflowStep.findFirst({
|
||||
where: {workflowId: workflow.id, type: 'TRIGGER'},
|
||||
});
|
||||
|
||||
const conditionStep = await prisma.workflowStep.create({
|
||||
data: {
|
||||
workflowId: workflow.id,
|
||||
type: WorkflowStepType.CONDITION,
|
||||
name: 'Check opens count',
|
||||
position: {x: 100, y: 0},
|
||||
config: {
|
||||
field: 'event.opens',
|
||||
operator: 'greaterThan',
|
||||
value: '3',
|
||||
} as Prisma.InputJsonValue,
|
||||
},
|
||||
});
|
||||
|
||||
const exitStep = await prisma.workflowStep.create({
|
||||
data: {
|
||||
workflowId: workflow.id,
|
||||
type: WorkflowStepType.EXIT,
|
||||
name: 'Done',
|
||||
position: {x: 200, y: 0},
|
||||
config: {reason: 'engaged'} as Prisma.InputJsonValue,
|
||||
},
|
||||
});
|
||||
|
||||
await prisma.workflowTransition.create({
|
||||
data: {fromStepId: triggerStep!.id, toStepId: conditionStep.id},
|
||||
});
|
||||
await prisma.workflowTransition.create({
|
||||
data: {fromStepId: conditionStep.id, toStepId: exitStep.id, condition: {branch: 'yes'} as Prisma.InputJsonValue},
|
||||
});
|
||||
|
||||
const execution = await prisma.workflowExecution.create({
|
||||
data: {
|
||||
workflowId: workflow.id,
|
||||
contactId: contact.id,
|
||||
status: WorkflowExecutionStatus.RUNNING,
|
||||
currentStepId: triggerStep!.id,
|
||||
context: {
|
||||
subject: 'Newsletter',
|
||||
opens: 5,
|
||||
} as Prisma.InputJsonValue,
|
||||
},
|
||||
});
|
||||
|
||||
await WorkflowExecutionService.processStepExecution(execution.id, triggerStep!.id);
|
||||
|
||||
const completedExecution = await prisma.workflowExecution.findUnique({
|
||||
where: {id: execution.id},
|
||||
});
|
||||
|
||||
expect(completedExecution?.status).toBe(WorkflowExecutionStatus.COMPLETED);
|
||||
expect(completedExecution?.exitReason).toBe('engaged');
|
||||
});
|
||||
});
|
||||
|
||||
// ========================================
|
||||
// EVENT DATA IN WEBHOOK CALLS
|
||||
// ========================================
|
||||
describe('Event Data in Webhook Calls', () => {
|
||||
it('should include event data in webhook payload', async () => {
|
||||
// Mock fetch to capture webhook calls
|
||||
const mockFetch = vi.fn(async () => ({
|
||||
ok: true,
|
||||
status: 200,
|
||||
text: async () => JSON.stringify({success: true}),
|
||||
}));
|
||||
global.fetch = mockFetch as any;
|
||||
|
||||
const contact = await factories.createContact({
|
||||
projectId,
|
||||
email: 'test@example.com',
|
||||
});
|
||||
const workflow = await factories.createWorkflow({projectId});
|
||||
|
||||
const triggerStep = await prisma.workflowStep.findFirst({
|
||||
where: {workflowId: workflow.id, type: 'TRIGGER'},
|
||||
});
|
||||
|
||||
const webhookStep = await prisma.workflowStep.create({
|
||||
data: {
|
||||
workflowId: workflow.id,
|
||||
type: WorkflowStepType.WEBHOOK,
|
||||
name: 'Send Webhook',
|
||||
position: {x: 100, y: 0},
|
||||
config: {
|
||||
url: 'https://webhook.example.com/test',
|
||||
method: 'POST',
|
||||
} as Prisma.InputJsonValue,
|
||||
},
|
||||
});
|
||||
|
||||
await prisma.workflowTransition.create({
|
||||
data: {fromStepId: triggerStep!.id, toStepId: webhookStep.id},
|
||||
});
|
||||
|
||||
const execution = await prisma.workflowExecution.create({
|
||||
data: {
|
||||
workflowId: workflow.id,
|
||||
contactId: contact.id,
|
||||
status: WorkflowExecutionStatus.RUNNING,
|
||||
currentStepId: triggerStep!.id,
|
||||
context: {
|
||||
subject: 'Welcome Email',
|
||||
from: 'hello@example.com',
|
||||
messageId: 'msg-123',
|
||||
isFirstOpen: true,
|
||||
openedAt: '2024-01-15T10:00:00Z',
|
||||
} as Prisma.InputJsonValue,
|
||||
},
|
||||
});
|
||||
|
||||
await WorkflowExecutionService.processStepExecution(execution.id, triggerStep!.id);
|
||||
|
||||
// Verify webhook was called with event data
|
||||
expect(mockFetch).toHaveBeenCalledWith(
|
||||
'https://webhook.example.com/test',
|
||||
expect.objectContaining({
|
||||
method: 'POST',
|
||||
body: expect.stringContaining('"event"'),
|
||||
}),
|
||||
);
|
||||
|
||||
// Parse the body to verify event data structure
|
||||
const callArgs = mockFetch.mock.calls[0];
|
||||
const body = JSON.parse(callArgs[1].body);
|
||||
|
||||
expect(body.event).toMatchObject({
|
||||
subject: 'Welcome Email',
|
||||
from: 'hello@example.com',
|
||||
messageId: 'msg-123',
|
||||
isFirstOpen: true,
|
||||
openedAt: '2024-01-15T10:00:00Z',
|
||||
});
|
||||
|
||||
expect(body.contact.email).toBe('test@example.com');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user