This PR is the second part of https://github.com/twentyhq/twenty/pull/5693. It optimizes all remaining field types. The observed improvements are : - x2 loading time improvement on table rows - more consistent render time Here's a summary of measured improvements, what's given here is the average of hundreds of renders with a React Profiler component. (in our Storybook performance stories) | Component | Before (µs) | After (µs) | | ----- | ------------- | --- | | TextFieldDisplay | 127 | 83 | | EmailFieldDisplay | 117 | 83 | | NumberFieldDisplay | 97 | 56 | | DateFieldDisplay | 240 | 52 | | CurrencyFieldDisplay | 236 | 110 | | FullNameFieldDisplay | 131 | 85 | | AddressFieldDisplay | 118 | 81 | | BooleanFieldDisplay | 130 | 100 | | JSONFieldDisplay | 248 | 49 | | LinksFieldDisplay | 1180 | 140 | | LinkFieldDisplay | 140 | 78 | | MultiSelectFieldDisplay | 770 | 130 | | SelectFieldDisplay | 230 | 87 |
227 lines
8.2 KiB
TypeScript
227 lines
8.2 KiB
TypeScript
import { useEffect, useState } from 'react';
|
|
import { FormProvider, useForm } from 'react-hook-form';
|
|
import { useNavigate, useParams } from 'react-router-dom';
|
|
import { useApolloClient } from '@apollo/client';
|
|
import styled from '@emotion/styled';
|
|
import { zodResolver } from '@hookform/resolvers/zod';
|
|
import pick from 'lodash.pick';
|
|
import { H2Title, IconSettings } from 'twenty-ui';
|
|
import { z } from 'zod';
|
|
|
|
import { useCreateOneRelationMetadataItem } from '@/object-metadata/hooks/useCreateOneRelationMetadataItem';
|
|
import { useFieldMetadataItem } from '@/object-metadata/hooks/useFieldMetadataItem';
|
|
import { useFilteredObjectMetadataItems } from '@/object-metadata/hooks/useFilteredObjectMetadataItems';
|
|
import { CoreObjectNameSingular } from '@/object-metadata/types/CoreObjectNameSingular';
|
|
import { useFindManyRecords } from '@/object-record/hooks/useFindManyRecords';
|
|
import { SaveAndCancelButtons } from '@/settings/components/SaveAndCancelButtons/SaveAndCancelButtons';
|
|
import { SettingsHeaderContainer } from '@/settings/components/SettingsHeaderContainer';
|
|
import { SettingsPageContainer } from '@/settings/components/SettingsPageContainer';
|
|
import { SettingsDataModelFieldAboutForm } from '@/settings/data-model/fields/forms/components/SettingsDataModelFieldAboutForm';
|
|
import { SettingsDataModelFieldSettingsFormCard } from '@/settings/data-model/fields/forms/components/SettingsDataModelFieldSettingsFormCard';
|
|
import { SettingsDataModelFieldTypeSelect } from '@/settings/data-model/fields/forms/components/SettingsDataModelFieldTypeSelect';
|
|
import { settingsFieldFormSchema } from '@/settings/data-model/fields/forms/validation-schemas/settingsFieldFormSchema';
|
|
import { SettingsSupportedFieldType } from '@/settings/data-model/types/SettingsSupportedFieldType';
|
|
import { AppPath } from '@/types/AppPath';
|
|
import { SnackBarVariant } from '@/ui/feedback/snack-bar-manager/components/SnackBar';
|
|
import { useSnackBar } from '@/ui/feedback/snack-bar-manager/hooks/useSnackBar';
|
|
import { SubMenuTopBarContainer } from '@/ui/layout/page/SubMenuTopBarContainer';
|
|
import { Section } from '@/ui/layout/section/components/Section';
|
|
import { Breadcrumb } from '@/ui/navigation/bread-crumb/components/Breadcrumb';
|
|
import { View } from '@/views/types/View';
|
|
import { ViewType } from '@/views/types/ViewType';
|
|
import { FieldMetadataType } from '~/generated-metadata/graphql';
|
|
import { isDefined } from '~/utils/isDefined';
|
|
import { isUndefinedOrNull } from '~/utils/isUndefinedOrNull';
|
|
|
|
type SettingsDataModelNewFieldFormValues = z.infer<
|
|
typeof settingsFieldFormSchema
|
|
>;
|
|
|
|
const StyledSettingsObjectFieldTypeSelect = styled(
|
|
SettingsDataModelFieldTypeSelect,
|
|
)`
|
|
margin-bottom: ${({ theme }) => theme.spacing(4)};
|
|
`;
|
|
|
|
export const SettingsObjectNewFieldStep2 = () => {
|
|
const navigate = useNavigate();
|
|
const { objectSlug = '' } = useParams();
|
|
const { enqueueSnackBar } = useSnackBar();
|
|
|
|
const { findActiveObjectMetadataItemBySlug } =
|
|
useFilteredObjectMetadataItems();
|
|
|
|
const activeObjectMetadataItem =
|
|
findActiveObjectMetadataItemBySlug(objectSlug);
|
|
const { createMetadataField } = useFieldMetadataItem();
|
|
|
|
const formConfig = useForm<SettingsDataModelNewFieldFormValues>({
|
|
mode: 'onTouched',
|
|
resolver: zodResolver(settingsFieldFormSchema),
|
|
});
|
|
|
|
useEffect(() => {
|
|
if (!activeObjectMetadataItem) {
|
|
navigate(AppPath.NotFound);
|
|
}
|
|
}, [activeObjectMetadataItem, navigate]);
|
|
|
|
const [, setObjectViews] = useState<View[]>([]);
|
|
const [, setRelationObjectViews] = useState<View[]>([]);
|
|
|
|
useFindManyRecords<View>({
|
|
objectNameSingular: CoreObjectNameSingular.View,
|
|
filter: {
|
|
type: { eq: ViewType.Table },
|
|
objectMetadataId: { eq: activeObjectMetadataItem?.id },
|
|
},
|
|
onCompleted: async (views) => {
|
|
if (isUndefinedOrNull(views)) return;
|
|
|
|
setObjectViews(views);
|
|
},
|
|
});
|
|
|
|
const relationObjectMetadataId = formConfig.watch(
|
|
'relation.objectMetadataId',
|
|
);
|
|
|
|
useFindManyRecords<View>({
|
|
objectNameSingular: CoreObjectNameSingular.View,
|
|
skip: !relationObjectMetadataId,
|
|
filter: {
|
|
type: { eq: ViewType.Table },
|
|
objectMetadataId: { eq: relationObjectMetadataId },
|
|
},
|
|
onCompleted: async (views) => {
|
|
if (isUndefinedOrNull(views)) return;
|
|
|
|
setRelationObjectViews(views);
|
|
},
|
|
});
|
|
|
|
const { createOneRelationMetadataItem: createOneRelationMetadata } =
|
|
useCreateOneRelationMetadataItem();
|
|
|
|
const apolloClient = useApolloClient();
|
|
|
|
if (!activeObjectMetadataItem) return null;
|
|
|
|
const canSave =
|
|
formConfig.formState.isValid && !formConfig.formState.isSubmitting;
|
|
|
|
const handleSave = async (
|
|
formValues: SettingsDataModelNewFieldFormValues,
|
|
) => {
|
|
try {
|
|
if (
|
|
formValues.type === FieldMetadataType.Relation &&
|
|
'relation' in formValues
|
|
) {
|
|
const { relation: relationFormValues, ...fieldFormValues } = formValues;
|
|
|
|
await createOneRelationMetadata({
|
|
relationType: relationFormValues.type,
|
|
field: pick(fieldFormValues, ['icon', 'label', 'description']),
|
|
objectMetadataId: activeObjectMetadataItem.id,
|
|
connect: {
|
|
field: {
|
|
icon: relationFormValues.field.icon,
|
|
label: relationFormValues.field.label,
|
|
},
|
|
objectMetadataId: relationFormValues.objectMetadataId,
|
|
},
|
|
});
|
|
|
|
// TODO: fix optimistic update logic
|
|
// Forcing a refetch for now but it's not ideal
|
|
await apolloClient.refetchQueries({
|
|
include: ['FindManyViews', 'CombinedFindManyRecords'],
|
|
});
|
|
} else {
|
|
await createMetadataField({
|
|
...formValues,
|
|
objectMetadataId: activeObjectMetadataItem.id,
|
|
});
|
|
|
|
// TODO: fix optimistic update logic
|
|
// Forcing a refetch for now but it's not ideal
|
|
await apolloClient.refetchQueries({
|
|
include: ['FindManyViews', 'CombinedFindManyRecords'],
|
|
});
|
|
}
|
|
|
|
navigate(`/settings/objects/${objectSlug}`);
|
|
} catch (error) {
|
|
enqueueSnackBar((error as Error).message, {
|
|
variant: SnackBarVariant.Error,
|
|
});
|
|
}
|
|
};
|
|
|
|
const excludedFieldTypes: SettingsSupportedFieldType[] = (
|
|
[
|
|
// FieldMetadataType.Email,
|
|
// FieldMetadataType.FullName,
|
|
// FieldMetadataType.Link,
|
|
FieldMetadataType.Numeric,
|
|
FieldMetadataType.Probability,
|
|
// FieldMetadataType.Uuid,
|
|
// FieldMetadataType.Phone,
|
|
] as const
|
|
).filter(isDefined);
|
|
|
|
return (
|
|
// eslint-disable-next-line react/jsx-props-no-spreading
|
|
<FormProvider {...formConfig}>
|
|
<SubMenuTopBarContainer Icon={IconSettings} title="Settings">
|
|
<SettingsPageContainer>
|
|
<SettingsHeaderContainer>
|
|
<Breadcrumb
|
|
links={[
|
|
{ children: 'Objects', href: '/settings/objects' },
|
|
{
|
|
children: activeObjectMetadataItem.labelPlural,
|
|
href: `/settings/objects/${objectSlug}`,
|
|
},
|
|
{ children: 'New Field' },
|
|
]}
|
|
/>
|
|
{!activeObjectMetadataItem.isRemote && (
|
|
<SaveAndCancelButtons
|
|
isSaveDisabled={!canSave}
|
|
onCancel={() => navigate(`/settings/objects/${objectSlug}`)}
|
|
onSave={formConfig.handleSubmit(handleSave)}
|
|
/>
|
|
)}
|
|
</SettingsHeaderContainer>
|
|
<Section>
|
|
<H2Title
|
|
title="Name and description"
|
|
description="The name and description of this field"
|
|
/>
|
|
<SettingsDataModelFieldAboutForm />
|
|
</Section>
|
|
<Section>
|
|
<H2Title
|
|
title="Type and values"
|
|
description="The field's type and values."
|
|
/>
|
|
<StyledSettingsObjectFieldTypeSelect
|
|
excludedFieldTypes={excludedFieldTypes}
|
|
/>
|
|
<SettingsDataModelFieldSettingsFormCard
|
|
fieldMetadataItem={{
|
|
icon: formConfig.watch('icon'),
|
|
label: formConfig.watch('label') || 'Employees',
|
|
type: formConfig.watch('type'),
|
|
}}
|
|
objectMetadataItem={activeObjectMetadataItem}
|
|
/>
|
|
</Section>
|
|
</SettingsPageContainer>
|
|
</SubMenuTopBarContainer>
|
|
</FormProvider>
|
|
);
|
|
};
|