Add Record Create action in the frontend (#8514)

In this PR:

- Updated the front-end types for workflows to include CRUD actions and
global naming changes
- Allow users to create a Record Create action
- Scaffold the edit for Record Create action; for now, I render a
`<VariableTagInput />` component for every editable field; it's likely
we'll change it soon

Closes https://github.com/twentyhq/private-issues/issues/142

Demo:


https://github.com/user-attachments/assets/6f0b207a-b7d2-46d9-b5ab-9e32bde55d76
This commit is contained in:
Baptiste Devessier
2024-11-18 18:23:46 +01:00
committed by GitHub
parent 316537a68a
commit c17e18b1e9
15 changed files with 503 additions and 132 deletions

View File

@ -3,7 +3,13 @@ import { WorkflowDiagramStepNodeData } from '@/workflow/types/WorkflowDiagram';
import { assertUnreachable } from '@/workflow/utils/assertUnreachable';
import { useTheme } from '@emotion/react';
import styled from '@emotion/styled';
import { IconCode, IconHandMove, IconMail, IconPlaylistAdd } from 'twenty-ui';
import {
IconAddressBook,
IconCode,
IconHandMove,
IconMail,
IconPlaylistAdd,
} from 'twenty-ui';
const StyledStepNodeLabelIconContainer = styled.div`
align-items: center;
@ -70,6 +76,21 @@ export const WorkflowDiagramStepNodeBase = ({
</StyledStepNodeLabelIconContainer>
);
}
case 'RECORD_CRUD.CREATE': {
return (
<StyledStepNodeLabelIconContainer>
<IconAddressBook
size={theme.icon.size.lg}
color={theme.font.color.tertiary}
stroke={theme.icon.stroke.sm}
/>
</StyledStepNodeLabelIconContainer>
);
}
case 'RECORD_CRUD.DELETE':
case 'RECORD_CRUD.UPDATE': {
return null;
}
}
}
}

View File

@ -0,0 +1,167 @@
import { useFilteredObjectMetadataItems } from '@/object-metadata/hooks/useFilteredObjectMetadataItems';
import { FormFieldInput } from '@/object-record/record-field/components/FormFieldInput';
import { Select, SelectOption } from '@/ui/input/components/Select';
import { WorkflowEditGenericFormBase } from '@/workflow/components/WorkflowEditGenericFormBase';
import { WorkflowRecordCreateAction } from '@/workflow/types/Workflow';
import { useTheme } from '@emotion/react';
import { useEffect, useState } from 'react';
import {
HorizontalSeparator,
IconAddressBook,
isDefined,
useIcons,
} from 'twenty-ui';
import { useDebouncedCallback } from 'use-debounce';
import { FieldMetadataType } from '~/generated/graphql';
type WorkflowEditActionFormRecordCreateProps = {
action: WorkflowRecordCreateAction;
actionOptions:
| {
readonly: true;
}
| {
readonly?: false;
onActionUpdate: (action: WorkflowRecordCreateAction) => void;
};
};
type SendEmailFormData = {
objectName: string;
[field: string]: unknown;
};
export const WorkflowEditActionFormRecordCreate = ({
action,
actionOptions,
}: WorkflowEditActionFormRecordCreateProps) => {
const theme = useTheme();
const { getIcon } = useIcons();
const { activeObjectMetadataItems } = useFilteredObjectMetadataItems();
const availableMetadata: Array<SelectOption<string>> =
activeObjectMetadataItems.map((item) => ({
Icon: getIcon(item.icon),
label: item.labelPlural,
value: item.nameSingular,
}));
const [formData, setFormData] = useState<SendEmailFormData>({
objectName: action.settings.input.objectName,
...action.settings.input.objectRecord,
});
const isFormDisabled = actionOptions.readonly;
const handleFieldChange = (
fieldName: keyof SendEmailFormData,
updatedValue: string,
) => {
const newFormData: SendEmailFormData = {
...formData,
[fieldName]: updatedValue,
};
setFormData(newFormData);
saveAction(newFormData);
};
useEffect(() => {
setFormData({
objectName: action.settings.input.objectName,
...action.settings.input.objectRecord,
});
}, [action.settings.input]);
const selectedObjectMetadataItemNameSingular = formData.objectName;
const selectedObjectMetadataItem = activeObjectMetadataItems.find(
(item) => item.nameSingular === selectedObjectMetadataItemNameSingular,
);
if (!isDefined(selectedObjectMetadataItem)) {
throw new Error('Should have found the metadata item');
}
const editableFields = selectedObjectMetadataItem.fields.filter(
(field) =>
field.type !== FieldMetadataType.Relation &&
!field.isSystem &&
field.isActive,
);
const saveAction = useDebouncedCallback(
async (formData: SendEmailFormData) => {
if (actionOptions.readonly === true) {
return;
}
const { objectName: updatedObjectName, ...updatedOtherFields } = formData;
actionOptions.onActionUpdate({
...action,
settings: {
...action.settings,
input: {
type: 'CREATE',
objectName: updatedObjectName,
objectRecord: updatedOtherFields,
},
},
});
},
1_000,
);
useEffect(() => {
return () => {
saveAction.flush();
};
}, [saveAction]);
return (
<WorkflowEditGenericFormBase
HeaderIcon={
<IconAddressBook
color={theme.font.color.tertiary}
stroke={theme.icon.stroke.sm}
/>
}
headerTitle="Record Create"
headerType="Action"
>
<Select
dropdownId="workflow-edit-action-record-create-object-name"
label="Object"
fullWidth
disabled={isFormDisabled}
value={formData.objectName}
emptyOption={{ label: 'Select an option', value: '' }}
options={availableMetadata}
onChange={(updatedObjectName) => {
const newFormData: SendEmailFormData = {
objectName: updatedObjectName,
};
setFormData(newFormData);
saveAction(newFormData);
}}
/>
<HorizontalSeparator noMargin />
{editableFields.map((field) => (
<FormFieldInput
key={field.id}
recordFieldInputdId={field.id}
label={field.label}
value={formData[field.name] as string}
onChange={(value) => {
handleFieldChange(field.name, value);
}}
/>
))}
</WorkflowEditGenericFormBase>
);
};

View File

@ -7,7 +7,7 @@ import { Select, SelectOption } from '@/ui/input/components/Select';
import { WorkflowEditGenericFormBase } from '@/workflow/components/WorkflowEditGenericFormBase';
import { VariableTagInput } from '@/workflow/search-variables/components/VariableTagInput';
import { workflowIdState } from '@/workflow/states/workflowIdState';
import { WorkflowSendEmailStep } from '@/workflow/types/Workflow';
import { WorkflowSendEmailAction } from '@/workflow/types/Workflow';
import { useTheme } from '@emotion/react';
import { useEffect } from 'react';
import { Controller, useForm } from 'react-hook-form';
@ -15,16 +15,17 @@ import { useRecoilValue } from 'recoil';
import { IconMail, IconPlus, isDefined } from 'twenty-ui';
import { useDebouncedCallback } from 'use-debounce';
type WorkflowEditActionFormSendEmailProps =
| {
action: WorkflowSendEmailStep;
readonly: true;
}
| {
action: WorkflowSendEmailStep;
readonly?: false;
onActionUpdate: (action: WorkflowSendEmailStep) => void;
};
type WorkflowEditActionFormSendEmailProps = {
action: WorkflowSendEmailAction;
actionOptions:
| {
readonly: true;
}
| {
readonly?: false;
onActionUpdate: (action: WorkflowSendEmailAction) => void;
};
};
type SendEmailFormData = {
connectedAccountId: string;
@ -33,9 +34,10 @@ type SendEmailFormData = {
body: string;
};
export const WorkflowEditActionFormSendEmail = (
props: WorkflowEditActionFormSendEmailProps,
) => {
export const WorkflowEditActionFormSendEmail = ({
action,
actionOptions,
}: WorkflowEditActionFormSendEmailProps) => {
const theme = useTheme();
const currentWorkspaceMember = useRecoilValue(currentWorkspaceMemberState);
const { triggerApisOAuth } = useTriggerApisOAuth();
@ -50,7 +52,7 @@ export const WorkflowEditActionFormSendEmail = (
subject: '',
body: '',
},
disabled: props.readonly,
disabled: actionOptions.readonly,
});
const checkConnectedAccountScopes = async (
@ -77,23 +79,23 @@ export const WorkflowEditActionFormSendEmail = (
useEffect(() => {
form.setValue(
'connectedAccountId',
props.action.settings.input.connectedAccountId ?? '',
action.settings.input.connectedAccountId ?? '',
);
form.setValue('email', props.action.settings.input.email ?? '');
form.setValue('subject', props.action.settings.input.subject ?? '');
form.setValue('body', props.action.settings.input.body ?? '');
}, [props.action.settings, form]);
form.setValue('email', action.settings.input.email ?? '');
form.setValue('subject', action.settings.input.subject ?? '');
form.setValue('body', action.settings.input.body ?? '');
}, [action.settings, form]);
const saveAction = useDebouncedCallback(
async (formData: SendEmailFormData, checkScopes = false) => {
if (props.readonly === true) {
if (actionOptions.readonly === true) {
return;
}
props.onActionUpdate({
...props.action,
actionOptions.onActionUpdate({
...action,
settings: {
...props.action.settings,
...action.settings,
input: {
connectedAccountId: formData.connectedAccountId,
email: formData.email,
@ -132,12 +134,12 @@ export const WorkflowEditActionFormSendEmail = (
};
if (
isDefined(props.action.settings.input.connectedAccountId) &&
props.action.settings.input.connectedAccountId !== ''
isDefined(action.settings.input.connectedAccountId) &&
action.settings.input.connectedAccountId !== ''
) {
filter.or.push({
id: {
eq: props.action.settings.input.connectedAccountId,
eq: action.settings.input.connectedAccountId,
},
});
}

View File

@ -1,17 +1,17 @@
import { ReactNode } from 'react';
import styled from '@emotion/styled';
import { useGetManyServerlessFunctions } from '@/settings/serverless-functions/hooks/useGetManyServerlessFunctions';
import { setNestedValue } from '@/workflow/utils/setNestedValue';
import { Select, SelectOption } from '@/ui/input/components/Select';
import { WorkflowEditGenericFormBase } from '@/workflow/components/WorkflowEditGenericFormBase';
import VariableTagInput from '@/workflow/search-variables/components/VariableTagInput';
import { WorkflowCodeStep } from '@/workflow/types/Workflow';
import { useTheme } from '@emotion/react';
import { IconCode, isDefined, HorizontalSeparator } from 'twenty-ui';
import { useDebouncedCallback } from 'use-debounce';
import { getDefaultFunctionInputFromInputSchema } from '@/workflow/utils/getDefaultFunctionInputFromInputSchema';
import { FunctionInput } from '@/workflow/types/FunctionInput';
import { WorkflowCodeAction } from '@/workflow/types/Workflow';
import { getDefaultFunctionInputFromInputSchema } from '@/workflow/utils/getDefaultFunctionInputFromInputSchema';
import { mergeDefaultFunctionInputAndFunctionInput } from '@/workflow/utils/mergeDefaultFunctionInputAndFunctionInput';
import { setNestedValue } from '@/workflow/utils/setNestedValue';
import { useTheme } from '@emotion/react';
import styled from '@emotion/styled';
import { ReactNode } from 'react';
import { HorizontalSeparator, IconCode, isDefined } from 'twenty-ui';
import { useDebouncedCallback } from 'use-debounce';
const StyledContainer = styled.div`
display: inline-flex;
@ -37,20 +37,22 @@ const StyledInputContainer = styled.div`
position: relative;
`;
type WorkflowEditActionFormServerlessFunctionProps =
| {
action: WorkflowCodeStep;
readonly: true;
}
| {
action: WorkflowCodeStep;
readonly?: false;
onActionUpdate: (action: WorkflowCodeStep) => void;
};
type WorkflowEditActionFormServerlessFunctionProps = {
action: WorkflowCodeAction;
actionOptions:
| {
readonly: true;
}
| {
readonly?: false;
onActionUpdate: (action: WorkflowCodeAction) => void;
};
};
export const WorkflowEditActionFormServerlessFunction = (
props: WorkflowEditActionFormServerlessFunctionProps,
) => {
export const WorkflowEditActionFormServerlessFunction = ({
action,
actionOptions,
}: WorkflowEditActionFormServerlessFunctionProps) => {
const theme = useTheme();
const { serverlessFunctions } = useGetManyServerlessFunctions();
@ -66,8 +68,7 @@ export const WorkflowEditActionFormServerlessFunction = (
const defaultFunctionInput =
getDefaultFunctionInputFromInputSchema(inputSchema);
const existingFunctionInput =
props.action.settings.input.serverlessFunctionInput;
const existingFunctionInput = action.settings.input.serverlessFunctionInput;
return mergeDefaultFunctionInputAndFunctionInput({
defaultFunctionInput,
@ -76,21 +77,21 @@ export const WorkflowEditActionFormServerlessFunction = (
};
const functionInput = getFunctionInput(
props.action.settings.input.serverlessFunctionId,
action.settings.input.serverlessFunctionId,
);
const updateFunctionInput = useDebouncedCallback(
async (newFunctionInput: object) => {
if (props.readonly === true) {
if (actionOptions.readonly === true) {
return;
}
props.onActionUpdate({
...props.action,
actionOptions.onActionUpdate({
...action,
settings: {
...props.action.settings,
...action.settings,
input: {
...props.action.settings.input,
...action.settings.input,
serverlessFunctionInput: newFunctionInput,
},
},
@ -116,14 +117,18 @@ export const WorkflowEditActionFormServerlessFunction = (
];
const handleFunctionChange = (newServerlessFunctionId: string) => {
if (actionOptions.readonly === true) {
return;
}
const serverlessFunction = serverlessFunctions.find(
(f) => f.id === newServerlessFunctionId,
);
const newProps = {
...props.action,
...action,
settings: {
...props.action.settings,
...action.settings,
input: {
serverlessFunctionId: newServerlessFunctionId,
serverlessFunctionVersion:
@ -133,9 +138,7 @@ export const WorkflowEditActionFormServerlessFunction = (
},
};
if (!props.readonly) {
props.onActionUpdate(newProps);
}
actionOptions.onActionUpdate(newProps);
};
const renderFields = (
@ -203,10 +206,10 @@ export const WorkflowEditActionFormServerlessFunction = (
dropdownId="select-serverless-function-id"
label="Function"
fullWidth
value={props.action.settings.input.serverlessFunctionId}
value={action.settings.input.serverlessFunctionId}
options={availableFunctions}
emptyOption={{ label: 'None', value: '' }}
disabled={props.readonly}
disabled={actionOptions.readonly}
onChange={handleFunctionChange}
/>
{renderFields(functionInput)}

View File

@ -45,22 +45,22 @@ const StyledTriggerSettings = styled.div`
row-gap: ${({ theme }) => theme.spacing(4)};
`;
type WorkflowEditTriggerDatabaseEventFormProps =
| {
trigger: WorkflowDatabaseEventTrigger;
readonly: true;
onTriggerUpdate?: undefined;
}
| {
trigger: WorkflowDatabaseEventTrigger;
readonly?: false;
onTriggerUpdate: (trigger: WorkflowDatabaseEventTrigger) => void;
};
type WorkflowEditTriggerDatabaseEventFormProps = {
trigger: WorkflowDatabaseEventTrigger;
triggerOptions:
| {
readonly: true;
onTriggerUpdate?: undefined;
}
| {
readonly?: false;
onTriggerUpdate: (trigger: WorkflowDatabaseEventTrigger) => void;
};
};
export const WorkflowEditTriggerDatabaseEventForm = ({
trigger,
readonly,
onTriggerUpdate,
triggerOptions,
}: WorkflowEditTriggerDatabaseEventFormProps) => {
const theme = useTheme();
@ -112,16 +112,16 @@ export const WorkflowEditTriggerDatabaseEventForm = ({
dropdownId="workflow-edit-trigger-record-type"
label="Record Type"
fullWidth
disabled={readonly}
disabled={triggerOptions.readonly}
value={triggerEvent?.objectType}
emptyOption={{ label: 'Select an option', value: '' }}
options={availableMetadata}
onChange={(updatedRecordType) => {
if (readonly === true) {
if (triggerOptions.readonly === true) {
return;
}
onTriggerUpdate(
triggerOptions.onTriggerUpdate(
isDefined(trigger) && isDefined(triggerEvent)
? {
...trigger,
@ -147,13 +147,13 @@ export const WorkflowEditTriggerDatabaseEventForm = ({
value={triggerEvent?.event}
emptyOption={{ label: 'Select an option', value: '' }}
options={OBJECT_EVENT_TRIGGERS}
disabled={readonly}
disabled={triggerOptions.readonly}
onChange={(updatedEvent) => {
if (readonly === true) {
if (triggerOptions.readonly === true) {
return;
}
onTriggerUpdate(
triggerOptions.onTriggerUpdate(
isDefined(trigger) && isDefined(triggerEvent)
? {
...trigger,

View File

@ -10,22 +10,22 @@ import { getManualTriggerDefaultSettings } from '@/workflow/utils/getManualTrigg
import { useTheme } from '@emotion/react';
import { IconHandMove, isDefined, useIcons } from 'twenty-ui';
type WorkflowEditTriggerManualFormProps =
| {
trigger: WorkflowManualTrigger;
readonly: true;
onTriggerUpdate?: undefined;
}
| {
trigger: WorkflowManualTrigger;
readonly?: false;
onTriggerUpdate: (trigger: WorkflowManualTrigger) => void;
};
type WorkflowEditTriggerManualFormProps = {
trigger: WorkflowManualTrigger;
triggerOptions:
| {
readonly: true;
onTriggerUpdate?: undefined;
}
| {
readonly?: false;
onTriggerUpdate: (trigger: WorkflowManualTrigger) => void;
};
};
export const WorkflowEditTriggerManualForm = ({
trigger,
readonly,
onTriggerUpdate,
triggerOptions,
}: WorkflowEditTriggerManualFormProps) => {
const theme = useTheme();
const { getIcon } = useIcons();
@ -54,15 +54,15 @@ export const WorkflowEditTriggerManualForm = ({
dropdownId="workflow-edit-manual-trigger-availability"
label="Available"
fullWidth
disabled={readonly}
disabled={triggerOptions.readonly}
value={manualTriggerAvailability}
options={MANUAL_TRIGGER_AVAILABILITY_OPTIONS}
onChange={(updatedTriggerType) => {
if (readonly === true) {
if (triggerOptions.readonly === true) {
return;
}
onTriggerUpdate({
triggerOptions.onTriggerUpdate({
...trigger,
settings: getManualTriggerDefaultSettings({
availability: updatedTriggerType,
@ -79,13 +79,13 @@ export const WorkflowEditTriggerManualForm = ({
fullWidth
value={trigger.settings.objectType}
options={availableMetadata}
disabled={readonly}
disabled={triggerOptions.readonly}
onChange={(updatedObject) => {
if (readonly === true) {
if (triggerOptions.readonly === true) {
return;
}
onTriggerUpdate({
triggerOptions.onTriggerUpdate({
...trigger,
settings: {
objectType: updatedObject,

View File

@ -1,3 +1,4 @@
import { WorkflowEditActionFormRecordCreate } from '@/workflow/components/WorkflowEditActionFormRecordCreate';
import { WorkflowEditActionFormSendEmail } from '@/workflow/components/WorkflowEditActionFormSendEmail';
import { WorkflowEditActionFormServerlessFunction } from '@/workflow/components/WorkflowEditActionFormServerlessFunction';
import { WorkflowEditTriggerDatabaseEventForm } from '@/workflow/components/WorkflowEditTriggerDatabaseEventForm';
@ -9,6 +10,7 @@ import {
} from '@/workflow/types/Workflow';
import { assertUnreachable } from '@/workflow/utils/assertUnreachable';
import { getStepDefinitionOrThrow } from '@/workflow/utils/getStepDefinitionOrThrow';
import { isWorkflowRecordCreateAction } from '@/workflow/utils/isWorkflowRecordCreateAction';
import { isDefined } from 'twenty-ui';
type WorkflowStepDetailProps =
@ -53,8 +55,7 @@ export const WorkflowStepDetail = ({
return (
<WorkflowEditTriggerDatabaseEventForm
trigger={stepDefinition.definition}
// eslint-disable-next-line react/jsx-props-no-spreading
{...props}
triggerOptions={props}
/>
);
}
@ -62,8 +63,7 @@ export const WorkflowStepDetail = ({
return (
<WorkflowEditTriggerManualForm
trigger={stepDefinition.definition}
// eslint-disable-next-line react/jsx-props-no-spreading
{...props}
triggerOptions={props}
/>
);
}
@ -80,8 +80,7 @@ export const WorkflowStepDetail = ({
return (
<WorkflowEditActionFormServerlessFunction
action={stepDefinition.definition}
// eslint-disable-next-line react/jsx-props-no-spreading
{...props}
actionOptions={props}
/>
);
}
@ -89,11 +88,22 @@ export const WorkflowStepDetail = ({
return (
<WorkflowEditActionFormSendEmail
action={stepDefinition.definition}
// eslint-disable-next-line react/jsx-props-no-spreading
{...props}
actionOptions={props}
/>
);
}
case 'RECORD_CRUD': {
if (isWorkflowRecordCreateAction(stepDefinition.definition)) {
return (
<WorkflowEditActionFormRecordCreate
action={stepDefinition.definition}
actionOptions={props}
/>
);
}
return null;
}
}
return assertUnreachable(