houseassassin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

22 branches 3 (#13181)

Browse Source 
This PR does not produce any functional changes for our users. It
prepares the branches for workflows by:

- decommissioning `output` and `context` fields or `workflowRun` records
and use newly created `state` field from front-end and back-end
- use `stepStatus` computed by `back-end` in `front-end`
- add utils and types in `twenty-shared/workflow` (not completed, a
follow-up is scheduled
https://github.com/twentyhq/core-team-issues/issues/1211)
- add concurrency to `workflowQueue` message queue to avoid weird branch
execution when using forms in workflow branches
- add a WithLock decorator for better dev experience of
`CacheLockService.withLock` usage

Here is an example of such a workflow running (front branch display is
not yet done that's why it looks ugly) ->
https://discord.com/channels/1130383047699738754/1258024460238192691/1392897615171158098
This commit is contained in:
martmull
2025-07-16 11:16:04 +02:00
committed by GitHub
parent bf6330469b
commit 47386e92a3
47 changed files with 5124 additions and 6380 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/twenty-server/src/modules/workflow/workflow-executor/types/workflow-run-step-info.type.ts
-13
View File
@@ -1,13 +0,0 @@
export enum StepStatus {
NOT_STARTED = 'NOT_STARTED',
RUNNING = 'RUNNING',
SUCCESS = 'SUCCESS',
FAILED = 'FAILED',
PENDING = 'PENDING',
}
export type WorkflowRunStepInfo = {
result?: object;
error?: string;
status: StepStatus;
};
packages/twenty-server/src/modules/workflow/workflow-executor/utils/__tests__/can-execute-step.util.spec.ts
+118 -15
View File
@@ -1,8 +1,10 @@
import { StepStatus } from 'twenty-shared/workflow';
import {
WorkflowAction,
WorkflowActionType,
} from 'src/modules/workflow/workflow-executor/workflow-actions/types/workflow-action.type';
import { canExecuteStep } from 'src/modules/workflow/workflow-executor/utils/can-execute-step.utils';
import { canExecuteStep } from 'src/modules/workflow/workflow-executor/utils/can-execute-step.util';
describe('canExecuteStep', () => {
const steps = [
@@ -42,13 +44,19 @@ describe('canExecuteStep', () => {
] as WorkflowAction[];
it('should return true if all parents succeeded', () => {
const context = {
trigger: 'trigger result',
'step-1': 'step-1 result',
'step-2': 'step-2 result',
const stepInfos = {
'step-1': {
status: StepStatus.SUCCESS,
},
'step-2': {
status: StepStatus.SUCCESS,
},
'step-3': {
status: StepStatus.NOT_STARTED,
},
};
const result = canExecuteStep({ context, steps, stepId: 'step-3' });
const result = canExecuteStep({ stepInfos, steps, stepId: 'step-3' });
expect(result).toBe(true);
});
@@ -56,9 +64,16 @@ describe('canExecuteStep', () => {
it('should return false if one parent is not succeeded', () => {
expect(
canExecuteStep({
context: {
trigger: 'trigger result',
'step-2': 'step-2 result',
stepInfos: {
'step-1': {
status: StepStatus.NOT_STARTED,
},
'step-2': {
status: StepStatus.SUCCESS,
},
'step-3': {
status: StepStatus.NOT_STARTED,
},
},
steps,
stepId: 'step-3',
@@ -67,9 +82,16 @@ describe('canExecuteStep', () => {
expect(
canExecuteStep({
context: {
trigger: 'trigger result',
'step-1': 'step-1 result',
stepInfos: {
'step-1': {
status: StepStatus.SUCCESS,
},
'step-2': {
status: StepStatus.NOT_STARTED,
},
'step-3': {
status: StepStatus.NOT_STARTED,
},
},
steps,
stepId: 'step-3',
@@ -78,9 +100,90 @@ describe('canExecuteStep', () => {
expect(
canExecuteStep({
context: {
trigger: 'trigger result',
'step-1': {},
stepInfos: {
'step-1': {
status: StepStatus.NOT_STARTED,
},
'step-2': {
status: StepStatus.NOT_STARTED,
},
'step-3': {
status: StepStatus.NOT_STARTED,
},
},
steps,
stepId: 'step-3',
}),
).toBe(false);
});
it('should return false if step has already ran', () => {
expect(
canExecuteStep({
stepInfos: {
'step-1': {
status: StepStatus.SUCCESS,
},
'step-2': {
status: StepStatus.SUCCESS,
},
'step-3': {
status: StepStatus.SUCCESS,
},
},
steps,
stepId: 'step-3',
}),
).toBe(false);
expect(
canExecuteStep({
stepInfos: {
'step-1': {
status: StepStatus.SUCCESS,
},
'step-2': {
status: StepStatus.SUCCESS,
},
'step-3': {
status: StepStatus.PENDING,
},
},
steps,
stepId: 'step-3',
}),
).toBe(false);
expect(
canExecuteStep({
stepInfos: {
'step-1': {
status: StepStatus.SUCCESS,
},
'step-2': {
status: StepStatus.SUCCESS,
},
'step-3': {
status: StepStatus.FAILED,
},
},
steps,
stepId: 'step-3',
}),
).toBe(false);
expect(
canExecuteStep({
stepInfos: {
'step-1': {
status: StepStatus.SUCCESS,
},
'step-2': {
status: StepStatus.SUCCESS,
},
'step-3': {
status: StepStatus.RUNNING,
},
},
steps,
stepId: 'step-3',
packages/twenty-server/src/modules/workflow/workflow-executor/utils/can-execute-step.utils.ts → packages/twenty-server/src/modules/workflow/workflow-executor/utils/can-execute-step.util.ts
+12 -5
View File
@@ -1,23 +1,30 @@
import { isDefined } from 'twenty-shared/utils';
import { StepStatus, WorkflowRunStepInfos } from 'twenty-shared/workflow';
import { WorkflowAction } from 'src/modules/workflow/workflow-executor/workflow-actions/types/workflow-action.type';
export const canExecuteStep = ({
context,
stepId,
steps,
stepInfos,
}: {
steps: WorkflowAction[];
context: Record<string, unknown>;
stepInfos: WorkflowRunStepInfos;
stepId: string;
}) => {
if (
isDefined(stepInfos[stepId]?.status) &&
stepInfos[stepId].status !== StepStatus.NOT_STARTED
) {
return false;
}
const parentSteps = steps.filter(
(parentStep) =>
isDefined(parentStep) && parentStep.nextStepIds?.includes(stepId),
);
// TODO use workflowRun.state to check if step status is not COMPLETED. Return false in this case
return parentSteps.every((parentStep) =>
Object.keys(context).includes(parentStep.id),
return parentSteps.every(
(parentStep) => stepInfos[parentStep.id]?.status === StepStatus.SUCCESS,
);
};
packages/twenty-server/src/modules/workflow/workflow-executor/workspace-services/__tests__/workflow-executor.workspace-service.spec.ts
+18 -12
View File
@@ -1,5 +1,7 @@
import { Test, TestingModule } from '@nestjs/testing';
import { getWorkflowRunContext, StepStatus } from 'twenty-shared/workflow';
import { BILLING_FEATURE_USED } from 'src/engine/core-modules/billing/constants/billing-feature-used.constant';
import { BILLING_WORKFLOW_EXECUTION_ERROR_MESSAGE } from 'src/engine/core-modules/billing/constants/billing-workflow-execution-error-message.constant';
import { BillingMeterEventName } from 'src/engine/core-modules/billing/enums/billing-meter-event-names';
@@ -12,15 +14,14 @@ import {
} from 'src/modules/workflow/workflow-executor/workflow-actions/types/workflow-action.type';
import { WorkflowExecutorWorkspaceService } from 'src/modules/workflow/workflow-executor/workspace-services/workflow-executor.workspace-service';
import { WorkflowRunWorkspaceService } from 'src/modules/workflow/workflow-runner/workflow-run/workflow-run.workspace-service';
import { StepStatus } from 'src/modules/workflow/workflow-executor/types/workflow-run-step-info.type';
import { WorkflowRunStatus } from 'src/modules/workflow/common/standard-objects/workflow-run.workspace-entity';
import { canExecuteStep } from 'src/modules/workflow/workflow-executor/utils/can-execute-step.utils';
import { canExecuteStep } from 'src/modules/workflow/workflow-executor/utils/can-execute-step.util';
jest.mock(
'src/modules/workflow/workflow-executor/utils/can-execute-step.utils',
'src/modules/workflow/workflow-executor/utils/can-execute-step.util',
() => {
const actual = jest.requireActual(
'src/modules/workflow/workflow-executor/utils/can-execute-step.utils',
'src/modules/workflow/workflow-executor/utils/can-execute-step.util',
);
return {
@@ -100,7 +101,6 @@ describe('WorkflowExecutorWorkspaceService', () => {
describe('execute', () => {
const mockWorkflowRunId = 'workflow-run-id';
const mockWorkspaceId = 'workspace-id';
const mockContext = { trigger: 'trigger-result' };
const mockSteps = [
{
id: 'step-1',
@@ -125,10 +125,12 @@ describe('WorkflowExecutorWorkspaceService', () => {
nextStepIds: [],
},
] as WorkflowAction[];
const mockStepInfos = {
trigger: { result: {}, status: StepStatus.SUCCESS },
};
mockWorkflowRunWorkspaceService.getWorkflowRun.mockReturnValue({
output: { flow: { steps: mockSteps } },
context: mockContext,
state: { flow: { steps: mockSteps }, stepInfos: mockStepInfos },
});
it('should execute a step and continue to the next step on success', async () => {
@@ -151,7 +153,7 @@ describe('WorkflowExecutorWorkspaceService', () => {
expect(mockWorkflowExecutor.execute).toHaveBeenCalledWith({
currentStepId: 'step-1',
steps: mockSteps,
context: mockContext,
context: getWorkflowRunContext(mockStepInfos),
});
expect(workspaceEventEmitter.emitCustomBatchEvent).toHaveBeenCalledWith(
@@ -319,8 +321,10 @@ describe('WorkflowExecutorWorkspaceService', () => {
] as WorkflowAction[];
mockWorkflowRunWorkspaceService.getWorkflowRun.mockReturnValueOnce({
output: { flow: { steps: stepsWithContinueOnFailure } },
context: mockContext,
state: {
flow: { steps: stepsWithContinueOnFailure },
stepInfos: mockStepInfos,
},
});
mockWorkflowExecutor.execute.mockResolvedValueOnce({
@@ -385,8 +389,10 @@ describe('WorkflowExecutorWorkspaceService', () => {
] as WorkflowAction[];
mockWorkflowRunWorkspaceService.getWorkflowRun.mockReturnValue({
output: { flow: { steps: stepsWithRetryOnFailure } },
context: mockContext,
state: {
flow: { steps: stepsWithRetryOnFailure },
stepInfos: mockStepInfos,
},
});
mockWorkflowExecutor.execute.mockResolvedValue({
packages/twenty-server/src/modules/workflow/workflow-executor/workspace-services/workflow-executor.workspace-service.ts
+14 -23
View File
@@ -1,6 +1,7 @@
import { Injectable } from '@nestjs/common';
import { isDefined } from 'twenty-shared/utils';
import { getWorkflowRunContext, StepStatus } from 'twenty-shared/workflow';
import { BILLING_FEATURE_USED } from 'src/engine/core-modules/billing/constants/billing-feature-used.constant';
import { BILLING_WORKFLOW_EXECUTION_ERROR_MESSAGE } from 'src/engine/core-modules/billing/constants/billing-workflow-execution-error-message.constant';
@@ -19,8 +20,7 @@ import {
WorkflowBranchExecutorInput,
WorkflowExecutorInput,
} from 'src/modules/workflow/workflow-executor/types/workflow-executor-input';
import { StepStatus } from 'src/modules/workflow/workflow-executor/types/workflow-run-step-info.type';
import { canExecuteStep } from 'src/modules/workflow/workflow-executor/utils/can-execute-step.utils';
import { canExecuteStep } from 'src/modules/workflow/workflow-executor/utils/can-execute-step.util';
import { WorkflowRunWorkspaceService } from 'src/modules/workflow/workflow-runner/workflow-run/workflow-run.workspace-service';
const MAX_RETRIES_ON_FAILURE = 3;
@@ -57,7 +57,7 @@ export class WorkflowExecutorWorkspaceService {
workspaceId,
}: WorkflowBranchExecutorInput) {
const workflowRunInfo = await this.getWorkflowRunInfoOrEndWorkflowRun({
stepId: stepId,
stepId,
workflowRunId,
workspaceId,
});
@@ -66,9 +66,9 @@ export class WorkflowExecutorWorkspaceService {
return;
}
const { stepToExecute, steps, context } = workflowRunInfo;
const { stepToExecute, steps, stepInfos } = workflowRunInfo;
if (!canExecuteStep({ stepId: stepToExecute.id, steps, context })) {
if (!canExecuteStep({ stepId, steps, stepInfos })) {
return;
}
@@ -98,7 +98,7 @@ export class WorkflowExecutorWorkspaceService {
actionOutput = await workflowAction.execute({
currentStepId: stepId,
steps,
context,
context: getWorkflowRunContext(stepInfos),
});
} catch (error) {
actionOutput = {
@@ -219,31 +219,18 @@ export class WorkflowExecutorWorkspaceService {
return;
}
const steps = workflowRun.output?.flow.steps;
const context = workflowRun.context;
if (!isDefined(steps)) {
if (!isDefined(workflowRun?.state)) {
await this.workflowRunWorkspaceService.endWorkflowRun({
workflowRunId,
workspaceId,
status: WorkflowRunStatus.FAILED,
error: 'Steps undefined',
error: `WorkflowRun ${workflowRunId} doesn't have any state`,
});
return;
}
if (!isDefined(context)) {
await this.workflowRunWorkspaceService.endWorkflowRun({
workflowRunId,
workspaceId,
status: WorkflowRunStatus.FAILED,
error: 'Context not found',
});
return;
}
const steps = workflowRun.state.flow.steps;
const stepToExecute = steps.find((step) => step.id === stepId);
@@ -258,7 +245,11 @@ export class WorkflowExecutorWorkspaceService {
return;
}
return { stepToExecute, steps, context };
return {
stepToExecute,
steps,
stepInfos: workflowRun.state.stepInfos,
};
}
private sendWorkflowNodeRunEvent(workspaceId: string) {