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

Split record crud actions (#8930)

Browse Source 
Having a global record crud action adds complex logic.
We decided to split those actions. I only kept a common folder / module
in backend.

⚠️ this may break existing workflows if these were using previous
actions!
This commit is contained in:
Thomas Trompette
2024-12-06 16:58:57 +01:00
committed by GitHub
parent 229a93e41a
commit e1a0259154
26 changed files with 341 additions and 590 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
packages/twenty-front/src/modules/workflow/components/WorkflowDiagramStepNodeBase.tsx
View File

@ -76,8 +76,9 @@ export const WorkflowDiagramStepNodeBase = ({
</StyledStepNodeLabelIconContainer>
);
}
case 'RECORD_CRUD.UPDATE':
case 'RECORD_CRUD.CREATE': {
case 'CREATE_RECORD':
case 'UPDATE_RECORD':
case 'DELETE_RECORD': {
return (
<StyledStepNodeLabelIconContainer>
<IconAddressBook
@ -88,10 +89,6 @@ export const WorkflowDiagramStepNodeBase = ({
</StyledStepNodeLabelIconContainer>
);
}
case 'RECORD_CRUD.DELETE': {
return null;
}
}
}
}

64
packages/twenty-front/src/modules/workflow/components/WorkflowStepDetail.tsx
View File

@ -7,13 +7,10 @@ import {
} from '@/workflow/types/Workflow';
import { assertUnreachable } from '@/workflow/utils/assertUnreachable';
import { getStepDefinitionOrThrow } from '@/workflow/utils/getStepDefinitionOrThrow';
import { WorkflowEditActionFormRecordCreate } from '@/workflow/workflow-actions/components/WorkflowEditActionFormRecordCreate';
import { WorkflowEditActionFormRecordDelete } from '@/workflow/workflow-actions/components/WorkflowEditActionFormRecordDelete';
import { WorkflowEditActionFormRecordUpdate } from '@/workflow/workflow-actions/components/WorkflowEditActionFormRecordUpdate';
import { WorkflowEditActionFormCreateRecord } from '@/workflow/workflow-actions/components/WorkflowEditActionFormCreateRecord';
import { WorkflowEditActionFormDeleteRecord } from '@/workflow/workflow-actions/components/WorkflowEditActionFormDeleteRecord';
import { WorkflowEditActionFormSendEmail } from '@/workflow/workflow-actions/components/WorkflowEditActionFormSendEmail';
import { isWorkflowRecordCreateAction } from '@/workflow/workflow-actions/utils/isWorkflowRecordCreateAction';
import { isWorkflowRecordDeleteAction } from '@/workflow/workflow-actions/utils/isWorkflowRecordDeleteAction';
import { isWorkflowRecordUpdateAction } from '@/workflow/workflow-actions/utils/isWorkflowRecordUpdateAction';
import { WorkflowEditActionFormUpdateRecord } from '@/workflow/workflow-actions/components/WorkflowEditActionFormUpdateRecord';
import { lazy, Suspense } from 'react';
import { isDefined } from 'twenty-ui';
import { RightDrawerSkeletonLoader } from '~/loading/components/RightDrawerSkeletonLoader';
@ -107,42 +104,35 @@ export const WorkflowStepDetail = ({
/>
);
}
case 'RECORD_CRUD': {
if (isWorkflowRecordCreateAction(stepDefinition.definition)) {
return (
<WorkflowEditActionFormRecordCreate
action={stepDefinition.definition}
actionOptions={props}
/>
);
}
case 'CREATE_RECORD': {
return (
<WorkflowEditActionFormCreateRecord
action={stepDefinition.definition}
actionOptions={props}
/>
);
}
if (isWorkflowRecordUpdateAction(stepDefinition.definition)) {
return (
<WorkflowEditActionFormRecordUpdate
action={stepDefinition.definition}
actionOptions={props}
/>
);
}
case 'UPDATE_RECORD': {
return (
<WorkflowEditActionFormUpdateRecord
action={stepDefinition.definition}
actionOptions={props}
/>
);
}
if (isWorkflowRecordDeleteAction(stepDefinition.definition)) {
return (
<WorkflowEditActionFormRecordDelete
action={stepDefinition.definition}
actionOptions={props}
/>
);
}
return null;
case 'DELETE_RECORD': {
return (
<WorkflowEditActionFormDeleteRecord
action={stepDefinition.definition}
actionOptions={props}
/>
);
}
}
return assertUnreachable(
stepDefinition.definition,
`Expected the step to have an handler; ${JSON.stringify(stepDefinition)}`,
);
return null;
}
}

6
packages/twenty-front/src/modules/workflow/constants/Actions.ts
View File

@ -22,17 +22,17 @@ export const ACTIONS: Array<{
},
{
label: 'Create Record',
type: 'RECORD_CRUD.CREATE',
type: 'CREATE_RECORD',
icon: IconAddressBook,
},
{
label: 'Update Record',
type: 'RECORD_CRUD.UPDATE',
type: 'UPDATE_RECORD',
icon: IconAddressBook,
},
{
label: 'Delete Record',
type: 'RECORD_CRUD.DELETE',
type: 'DELETE_RECORD',
icon: IconAddressBook,
},
];

72
packages/twenty-front/src/modules/workflow/types/Workflow.ts
View File

@ -32,34 +32,26 @@ export type WorkflowSendEmailActionSettings = BaseWorkflowActionSettings & {
type ObjectRecord = Record<string, any>;
export type WorkflowCreateRecordActionInput = {
type: 'CREATE';
objectName: string;
objectRecord: ObjectRecord;
export type WorkflowCreateRecordActionSettings = BaseWorkflowActionSettings & {
input: {
objectName: string;
objectRecord: ObjectRecord;
};
};
export type WorkflowUpdateRecordActionInput = {
type: 'UPDATE';
objectName: string;
objectRecord: ObjectRecord;
objectRecordId: string;
export type WorkflowUpdateRecordActionSettings = BaseWorkflowActionSettings & {
input: {
objectName: string;
objectRecord: ObjectRecord;
objectRecordId: string;
};
};
export type WorkflowDeleteRecordActionInput = {
type: 'DELETE';
objectName: string;
objectRecordId: string;
};
export type WorkflowRecordCRUDActionInput =
| WorkflowCreateRecordActionInput
| WorkflowUpdateRecordActionInput
| WorkflowDeleteRecordActionInput;
export type WorkflowRecordCRUDType = WorkflowRecordCRUDActionInput['type'];
export type WorkflowRecordCRUDActionSettings = BaseWorkflowActionSettings & {
input: WorkflowRecordCRUDActionInput;
export type WorkflowDeleteRecordActionSettings = BaseWorkflowActionSettings & {
input: {
objectName: string;
objectRecordId: string;
};
};
type BaseWorkflowAction = {
@ -78,35 +70,33 @@ export type WorkflowSendEmailAction = BaseWorkflowAction & {
settings: WorkflowSendEmailActionSettings;
};
export type WorkflowRecordCRUDAction = BaseWorkflowAction & {
type: 'RECORD_CRUD';
settings: WorkflowRecordCRUDActionSettings;
export type WorkflowCreateRecordAction = BaseWorkflowAction & {
type: 'CREATE_RECORD';
settings: WorkflowCreateRecordActionSettings;
};
export type WorkflowRecordCreateAction = WorkflowRecordCRUDAction & {
settings: { input: { type: 'CREATE' } };
export type WorkflowUpdateRecordAction = BaseWorkflowAction & {
type: 'UPDATE_RECORD';
settings: WorkflowUpdateRecordActionSettings;
};
export type WorkflowRecordUpdateAction = WorkflowRecordCRUDAction & {
settings: { input: { type: 'UPDATE' } };
};
export type WorkflowRecordDeleteAction = WorkflowRecordCRUDAction & {
settings: { input: { type: 'DELETE' } };
export type WorkflowDeleteRecordAction = BaseWorkflowAction & {
type: 'DELETE_RECORD';
settings: WorkflowDeleteRecordActionSettings;
};
export type WorkflowAction =
| WorkflowCodeAction
| WorkflowSendEmailAction
| WorkflowRecordCRUDAction;
| WorkflowCreateRecordAction
| WorkflowUpdateRecordAction
| WorkflowDeleteRecordAction;
export type WorkflowActionType = WorkflowAction['type'];
export type WorkflowStep = WorkflowAction;
export type WorkflowActionType =
| Exclude<WorkflowAction['type'], WorkflowRecordCRUDAction['type']>
| `${WorkflowRecordCRUDAction['type']}.${WorkflowRecordCRUDType}`;
export type WorkflowStepType = WorkflowActionType;
export type WorkflowStepType = WorkflowStep['type'];
type BaseTrigger = {
name?: string;

23
packages/twenty-front/src/modules/workflow/utils/generateWorkflowDiagram.ts
View File

@ -1,9 +1,5 @@
import { TRIGGER_STEP_ID } from '@/workflow/constants/TriggerStepId';
import {
WorkflowActionType,
WorkflowStep,
WorkflowTrigger,
} from '@/workflow/types/Workflow';
import { WorkflowStep, WorkflowTrigger } from '@/workflow/types/Workflow';
import {
WorkflowDiagram,
WorkflowDiagramEdge,
@ -35,25 +31,12 @@ export const generateWorkflowDiagram = ({
) => {
const nodeId = step.id;
let nodeActionType: WorkflowActionType;
if (step.type === 'RECORD_CRUD') {
nodeActionType = `RECORD_CRUD.${step.settings.input.type}`;
} else {
nodeActionType = step.type;
}
let nodeLabel = step.name;
if (step.type === 'RECORD_CRUD') {
// FIXME: use activeObjectMetadataItems to get labelSingular
nodeLabel = `${capitalize(step.settings.input.type.toLowerCase())} ${capitalize(step.settings.input.objectName)}`;
}
nodes.push({
id: nodeId,
data: {
nodeType: 'action',
actionType: nodeActionType,
name: isDefined(step.name) ? step.name : nodeLabel,
actionType: step.type,
name: step.name,
},
position: {
x: xPos,

13
packages/twenty-front/src/modules/workflow/workflow-actions/components/WorkflowEditActionFormRecordCreate.tsx → packages/twenty-front/src/modules/workflow/workflow-actions/components/WorkflowEditActionFormCreateRecord.tsx
View File

@ -5,7 +5,7 @@ import { FormFieldInput } from '@/object-record/record-field/components/FormFiel
import { Select, SelectOption } from '@/ui/input/components/Select';
import { WorkflowEditGenericFormBase } from '@/workflow/components/WorkflowEditGenericFormBase';
import { WorkflowVariablePicker } from '@/workflow/components/WorkflowVariablePicker';
import { WorkflowRecordCreateAction } from '@/workflow/types/Workflow';
import { WorkflowCreateRecordAction } from '@/workflow/types/Workflow';
import { useTheme } from '@emotion/react';
import { useEffect, useState } from 'react';
import {
@ -18,15 +18,15 @@ import { JsonValue } from 'type-fest';
import { useDebouncedCallback } from 'use-debounce';
import { FieldMetadataType } from '~/generated/graphql';
type WorkflowEditActionFormRecordCreateProps = {
action: WorkflowRecordCreateAction;
type WorkflowEditActionFormCreateRecordProps = {
action: WorkflowCreateRecordAction;
actionOptions:
| {
readonly: true;
}
| {
readonly?: false;
onActionUpdate: (action: WorkflowRecordCreateAction) => void;
onActionUpdate: (action: WorkflowCreateRecordAction) => void;
};
};
@ -35,10 +35,10 @@ type CreateRecordFormData = {
[field: string]: unknown;
};
export const WorkflowEditActionFormRecordCreate = ({
export const WorkflowEditActionFormCreateRecord = ({
action,
actionOptions,
}: WorkflowEditActionFormRecordCreateProps) => {
}: WorkflowEditActionFormCreateRecordProps) => {
const theme = useTheme();
const { getIcon } = useIcons();
@ -118,7 +118,6 @@ export const WorkflowEditActionFormRecordCreate = ({
settings: {
...action.settings,
input: {
type: 'CREATE',
objectName: updatedObjectName,
objectRecord: updatedOtherFields,
},

13
packages/twenty-front/src/modules/workflow/workflow-actions/components/WorkflowEditActionFormRecordDelete.tsx → packages/twenty-front/src/modules/workflow/workflow-actions/components/WorkflowEditActionFormDeleteRecord.tsx
View File

@ -2,7 +2,7 @@ import { useFilteredObjectMetadataItems } from '@/object-metadata/hooks/useFilte
import { Select, SelectOption } from '@/ui/input/components/Select';
import { WorkflowEditGenericFormBase } from '@/workflow/components/WorkflowEditGenericFormBase';
import { WorkflowSingleRecordPicker } from '@/workflow/components/WorkflowSingleRecordPicker';
import { WorkflowRecordDeleteAction } from '@/workflow/types/Workflow';
import { WorkflowDeleteRecordAction } from '@/workflow/types/Workflow';
import { useTheme } from '@emotion/react';
import { useEffect, useState } from 'react';
import {
@ -15,15 +15,15 @@ import {
import { JsonValue } from 'type-fest';
import { useDebouncedCallback } from 'use-debounce';
type WorkflowEditActionFormRecordDeleteProps = {
action: WorkflowRecordDeleteAction;
type WorkflowEditActionFormDeleteRecordProps = {
action: WorkflowDeleteRecordAction;
actionOptions:
| {
readonly: true;
}
| {
readonly?: false;
onActionUpdate: (action: WorkflowRecordDeleteAction) => void;
onActionUpdate: (action: WorkflowDeleteRecordAction) => void;
};
};
@ -32,10 +32,10 @@ type DeleteRecordFormData = {
objectRecordId: string;
};
export const WorkflowEditActionFormRecordDelete = ({
export const WorkflowEditActionFormDeleteRecord = ({
action,
actionOptions,
}: WorkflowEditActionFormRecordDeleteProps) => {
}: WorkflowEditActionFormDeleteRecordProps) => {
const theme = useTheme();
const { getIcon } = useIcons();
@ -100,7 +100,6 @@ export const WorkflowEditActionFormRecordDelete = ({
settings: {
...action.settings,
input: {
type: 'DELETE',
objectName: updatedObjectName,
objectRecordId: updatedObjectRecordId ?? '',
},

13
packages/twenty-front/src/modules/workflow/workflow-actions/components/WorkflowEditActionFormRecordUpdate.tsx → packages/twenty-front/src/modules/workflow/workflow-actions/components/WorkflowEditActionFormUpdateRecord.tsx
View File

@ -2,7 +2,7 @@ import { useFilteredObjectMetadataItems } from '@/object-metadata/hooks/useFilte
import { Select, SelectOption } from '@/ui/input/components/Select';
import { WorkflowEditGenericFormBase } from '@/workflow/components/WorkflowEditGenericFormBase';
import { WorkflowSingleRecordPicker } from '@/workflow/components/WorkflowSingleRecordPicker';
import { WorkflowRecordUpdateAction } from '@/workflow/types/Workflow';
import { WorkflowUpdateRecordAction } from '@/workflow/types/Workflow';
import { useTheme } from '@emotion/react';
import { useEffect, useState } from 'react';
import {
@ -15,15 +15,15 @@ import {
import { JsonValue } from 'type-fest';
import { useDebouncedCallback } from 'use-debounce';
type WorkflowEditActionFormRecordUpdateProps = {
action: WorkflowRecordUpdateAction;
type WorkflowEditActionFormUpdateRecordProps = {
action: WorkflowUpdateRecordAction;
actionOptions:
| {
readonly: true;
}
| {
readonly?: false;
onActionUpdate: (action: WorkflowRecordUpdateAction) => void;
onActionUpdate: (action: WorkflowUpdateRecordAction) => void;
};
};
@ -33,10 +33,10 @@ type UpdateRecordFormData = {
[field: string]: unknown;
};
export const WorkflowEditActionFormRecordUpdate = ({
export const WorkflowEditActionFormUpdateRecord = ({
action,
actionOptions,
}: WorkflowEditActionFormRecordUpdateProps) => {
}: WorkflowEditActionFormUpdateRecordProps) => {
const theme = useTheme();
const { getIcon } = useIcons();
@ -104,7 +104,6 @@ export const WorkflowEditActionFormRecordUpdate = ({
settings: {
...action.settings,
input: {
type: 'UPDATE',
objectName: updatedObjectName,
objectRecordId: updatedObjectRecordId ?? '',
objectRecord: updatedOtherFields,

81
packages/twenty-front/src/modules/workflow/workflow-actions/utils/__tests__/isWorkflowRecordCreateAction.test.ts
View File

@ -1,81 +0,0 @@
import {
WorkflowCodeAction,
WorkflowRecordCRUDAction,
} from '@/workflow/types/Workflow';
import { isWorkflowRecordCreateAction } from '../isWorkflowRecordCreateAction';
describe('isWorkflowRecordCreateAction', () => {
it('returns false when providing an action that is not Record Create', () => {
const action: WorkflowCodeAction = {
type: 'CODE',
id: '',
name: '',
settings: {
errorHandlingOptions: {
continueOnFailure: {
value: false,
},
retryOnFailure: {
value: false,
},
},
input: {
serverlessFunctionId: '',
serverlessFunctionVersion: '',
serverlessFunctionInput: {},
},
outputSchema: {},
},
valid: true,
};
expect(isWorkflowRecordCreateAction(action)).toBe(false);
});
it('returns false for Record Update', () => {
const action: WorkflowRecordCRUDAction = {
type: 'RECORD_CRUD',
id: '',
name: '',
settings: {
errorHandlingOptions: {
continueOnFailure: { value: false },
retryOnFailure: { value: false },
},
input: {
type: 'UPDATE',
objectName: '',
objectRecord: {},
objectRecordId: '',
},
outputSchema: {},
},
valid: true,
};
expect(isWorkflowRecordCreateAction(action)).toBe(false);
});
it('returns true for Record Create', () => {
const action: WorkflowRecordCRUDAction = {
type: 'RECORD_CRUD',
id: '',
name: '',
settings: {
errorHandlingOptions: {
continueOnFailure: { value: false },
retryOnFailure: { value: false },
},
input: {
type: 'CREATE',
objectName: '',
objectRecord: {},
},
outputSchema: {},
},
valid: true,
};
expect(isWorkflowRecordCreateAction(action)).toBe(true);
});
});

81
packages/twenty-front/src/modules/workflow/workflow-actions/utils/__tests__/isWorkflowRecordDeleteAction.test.ts
View File

@ -1,81 +0,0 @@
import {
WorkflowCodeAction,
WorkflowRecordCRUDAction,
} from '@/workflow/types/Workflow';
import { isWorkflowRecordDeleteAction } from '../isWorkflowRecordDeleteAction';
describe('isWorkflowRecordDeleteAction', () => {
it('returns false when providing an action that is not Record Delete', () => {
const action: WorkflowCodeAction = {
type: 'CODE',
id: '',
name: '',
settings: {
errorHandlingOptions: {
continueOnFailure: {
value: false,
},
retryOnFailure: {
value: false,
},
},
input: {
serverlessFunctionId: '',
serverlessFunctionVersion: '',
serverlessFunctionInput: {},
},
outputSchema: {},
},
valid: true,
};
expect(isWorkflowRecordDeleteAction(action)).toBe(false);
});
it('returns false for Record Update', () => {
const action: WorkflowRecordCRUDAction = {
type: 'RECORD_CRUD',
id: '',
name: '',
settings: {
errorHandlingOptions: {
continueOnFailure: { value: false },
retryOnFailure: { value: false },
},
input: {
type: 'UPDATE',
objectName: '',
objectRecord: {},
objectRecordId: '',
},
outputSchema: {},
},
valid: true,
};
expect(isWorkflowRecordDeleteAction(action)).toBe(false);
});
it('returns true for Record Delete', () => {
const action: WorkflowRecordCRUDAction = {
type: 'RECORD_CRUD',
id: '',
name: '',
settings: {
errorHandlingOptions: {
continueOnFailure: { value: false },
retryOnFailure: { value: false },
},
input: {
type: 'DELETE',
objectName: '',
objectRecordId: '',
},
outputSchema: {},
},
valid: true,
};
expect(isWorkflowRecordDeleteAction(action)).toBe(true);
});
});

81
packages/twenty-front/src/modules/workflow/workflow-actions/utils/__tests__/isWorkflowRecordUpdateAction.test.ts
View File

@ -1,81 +0,0 @@
import {
WorkflowCodeAction,
WorkflowRecordCRUDAction,
} from '@/workflow/types/Workflow';
import { isWorkflowRecordUpdateAction } from '../isWorkflowRecordUpdateAction';
describe('isWorkflowRecordUpdateAction', () => {
it('returns false when providing an action that is not Record Create', () => {
const action: WorkflowCodeAction = {
type: 'CODE',
id: '',
name: '',
settings: {
errorHandlingOptions: {
continueOnFailure: {
value: false,
},
retryOnFailure: {
value: false,
},
},
input: {
serverlessFunctionId: '',
serverlessFunctionVersion: '',
serverlessFunctionInput: {},
},
outputSchema: {},
},
valid: true,
};
expect(isWorkflowRecordUpdateAction(action)).toBe(false);
});
it('returns true for Record Update', () => {
const action: WorkflowRecordCRUDAction = {
type: 'RECORD_CRUD',
id: '',
name: '',
settings: {
errorHandlingOptions: {
continueOnFailure: { value: false },
retryOnFailure: { value: false },
},
input: {
type: 'UPDATE',
objectName: '',
objectRecord: {},
objectRecordId: '',
},
outputSchema: {},
},
valid: true,
};
expect(isWorkflowRecordUpdateAction(action)).toBe(true);
});
it('returns false for Record Create', () => {
const action: WorkflowRecordCRUDAction = {
type: 'RECORD_CRUD',
id: '',
name: '',
settings: {
errorHandlingOptions: {
continueOnFailure: { value: false },
retryOnFailure: { value: false },
},
input: {
type: 'CREATE',
objectName: '',
objectRecord: {},
},
outputSchema: {},
},
valid: true,
};
expect(isWorkflowRecordUpdateAction(action)).toBe(false);
});
});

12
packages/twenty-front/src/modules/workflow/workflow-actions/utils/isWorkflowRecordCreateAction.ts
View File

@ -1,12 +0,0 @@
import {
WorkflowAction,
WorkflowRecordCreateAction,
} from '@/workflow/types/Workflow';
export const isWorkflowRecordCreateAction = (
action: WorkflowAction,
): action is WorkflowRecordCreateAction => {
return (
action.type === 'RECORD_CRUD' && action.settings.input.type === 'CREATE'
);
};

12
packages/twenty-front/src/modules/workflow/workflow-actions/utils/isWorkflowRecordDeleteAction.ts
View File

@ -1,12 +0,0 @@
import {
WorkflowAction,
WorkflowRecordDeleteAction,
} from '@/workflow/types/Workflow';
export const isWorkflowRecordDeleteAction = (
action: WorkflowAction,
): action is WorkflowRecordDeleteAction => {
return (
action.type === 'RECORD_CRUD' && action.settings.input.type === 'DELETE'
);
};

12
packages/twenty-front/src/modules/workflow/workflow-actions/utils/isWorkflowRecordUpdateAction.ts
View File

@ -1,12 +0,0 @@
import {
WorkflowAction,
WorkflowRecordUpdateAction,
} from '@/workflow/types/Workflow';
export const isWorkflowRecordUpdateAction = (
action: WorkflowAction,
): action is WorkflowRecordUpdateAction => {
return (
action.type === 'RECORD_CRUD' && action.settings.input.type === 'UPDATE'
);
};