Deprecate old relations completely (#12482)

# What

Fully deprecate old relations because we have one bug tied to it and it
make the codebase complex

# How I've made this PR:
1. remove metadata datasource (we only keep 'core') => this was causing
extra complexity in the refactor + flaky reset
2. merge dev and demo datasets => as I needed to update the tests which
is very painful, I don't want to do it twice
3. remove all code tied to RELATION_METADATA /
relation-metadata.resolver, or anything tied to the old relation system
4. Remove ONE_TO_ONE and MANY_TO_MANY that are not supported
5. fix impacts on the different areas : see functional testing below 

# Functional testing

## Functional testing from the front-end:
1. Database Reset 
2. Sign In 
3. Workspace sign-up 
5. Browsing table / kanban / show 
6. Assigning a record in a one to many / in a many to one 
7. Deleting a record involved in a relation  => broken but not tied to
this PR
8. "Add new" from relation picker  => broken but not tied to this PR
9. Creating a Task / Note, Updating a Task / Note relations, Deleting a
Task / Note (from table, show page, right drawer)  => broken but not
tied to this PR
10. creating a relation from settings (custom / standard x oneToMany /
manyToOne) 
11. updating a relation from settings should not be possible 
12. deleting a relation from settings (custom / standard x oneToMany /
manyToOne) 
13. Make sure timeline activity still work (relation were involved
there), espacially with Task / Note => to be double checked  => Cannot
convert undefined or null to object
14. Workspace deletion / User deletion  
15. CSV Import should keep working  
16. Permissions: I have tested without permissions V2 as it's still hard
to test v2 work and it's not in prod yet 
17. Workflows global test  

## From the API:
1. Review open-api documentation (REST)  
2. Make sure REST Api are still able to fetch relations ==> won't do, we
have a coupling Get/Update/Create there, this requires refactoring
3. Make sure REST Api is still able to update / remove relation => won't
do same

## Automated tests
1. lint + typescript 
2. front unit tests: 
3. server unit tests 2 
4. front stories: 
5. server integration: 
6. chromatic check : expected 0
7. e2e check : expected no more that current failures

## Remove // Todos
1. All are captured by functional tests above, nothing additional to do

## (Un)related regressions
1. Table loading state is not working anymore, we see the empty state
before table content
2. Filtering by Creator Tim Ap return empty results
3. Not possible to add Tasks / Notes / Files from show page

# Result

## New seeds that can be easily extended
<img width="1920" alt="image"
src="https://github.com/user-attachments/assets/d290d130-2a5f-44e6-b419-7e42a89eec4b"
/>

## -5k lines of code
## No more 'metadata' dataSource (we only have 'core)
## No more relationMetadata (I haven't drop the table yet it's not
referenced in the code anymore)
## We are ready to fix the 6 months lag between current API results and
our mocked tests
## No more bug on relation creation / deletion

---------

Co-authored-by: Weiko <corentin@twenty.com>
Co-authored-by: Félix Malfait <felix@twenty.com>
This commit is contained in:
Charles Bochet
2025-06-10 16:45:27 +02:00
committed by GitHub
parent 264861e020
commit a68895189c
426 changed files with 48870 additions and 54125 deletions

View File

@ -1,13 +1,6 @@
import { RelationDefinitionType } from '~/generated-metadata/graphql';
import { IconComponent, IllustrationIconOneToMany } from 'twenty-ui/display';
import { RelationType } from '~/generated-metadata/graphql';
import OneToManySvg from '../assets/OneToMany.svg';
import OneToOneSvg from '../assets/OneToOne.svg';
import { RelationType } from '../types/RelationType';
import {
IconComponent,
IllustrationIconManyToMany,
IllustrationIconOneToMany,
IllustrationIconOneToOne,
} from 'twenty-ui/display';
export const RELATION_TYPES: Record<
RelationType,
@ -18,27 +11,15 @@ export const RELATION_TYPES: Record<
isImageFlipped?: boolean;
}
> = {
[RelationDefinitionType.ONE_TO_MANY]: {
[RelationType.ONE_TO_MANY]: {
label: 'Has many',
Icon: IllustrationIconOneToMany,
imageSrc: OneToManySvg,
},
[RelationDefinitionType.ONE_TO_ONE]: {
label: 'Has one',
Icon: IllustrationIconOneToOne,
imageSrc: OneToOneSvg,
},
[RelationDefinitionType.MANY_TO_ONE]: {
[RelationType.MANY_TO_ONE]: {
label: 'Belongs to one',
Icon: IllustrationIconOneToMany,
imageSrc: OneToManySvg,
isImageFlipped: true,
},
// Not supported yet
[RelationDefinitionType.MANY_TO_MANY]: {
label: 'Belongs to many',
Icon: IllustrationIconManyToMany,
imageSrc: OneToManySvg,
isImageFlipped: true,
},
};

View File

@ -10,14 +10,13 @@ import { fieldMetadataItemSchema } from '@/object-metadata/validation-schemas/fi
import { FIELD_NAME_MAXIMUM_LENGTH } from '@/settings/data-model/constants/FieldNameMaximumLength';
import { RELATION_TYPES } from '@/settings/data-model/constants/RelationTypes';
import { useRelationSettingsFormInitialValues } from '@/settings/data-model/fields/forms/relation/hooks/useRelationSettingsFormInitialValues';
import { RelationType } from '@/settings/data-model/types/RelationType';
import { IconPicker } from '@/ui/input/components/IconPicker';
import { Select } from '@/ui/input/components/Select';
import { TextInput } from '@/ui/input/components/TextInput';
import { useIsMobile } from '@/ui/utilities/responsive/hooks/useIsMobile';
import { useLingui } from '@lingui/react/macro';
import { useIcons } from 'twenty-ui/display';
import { RelationDefinitionType } from '~/generated-metadata/graphql';
import { RelationType } from '~/generated-metadata/graphql';
export const settingsDataModelFieldRelationFormSchema = z.object({
relation: z.object({
@ -37,10 +36,7 @@ export const settingsDataModelFieldRelationFormSchema = z.object({
),
objectMetadataId: z.string().uuid(),
type: z.enum(
Object.keys(RELATION_TYPES) as [
RelationDefinitionType,
...RelationDefinitionType[],
],
Object.keys(RELATION_TYPES) as [RelationType, ...RelationType[]],
),
}),
});
@ -78,17 +74,13 @@ const StyledInputsContainer = styled.div`
width: 100%;
`;
const RELATION_TYPE_OPTIONS = Object.entries(RELATION_TYPES)
.filter(
([value]) =>
RelationDefinitionType.ONE_TO_ONE !== value &&
RelationDefinitionType.MANY_TO_MANY !== value,
)
.map(([value, { label, Icon }]) => ({
const RELATION_TYPE_OPTIONS = Object.entries(RELATION_TYPES).map(
([value, { label, Icon }]) => ({
label,
value: value as RelationType,
Icon,
}));
}),
);
export const SettingsDataModelFieldRelationForm = ({
fieldMetadataItem,
@ -170,7 +162,7 @@ export const SettingsDataModelFieldRelationForm = ({
</StyledSelectsContainer>
<StyledInputsLabel>
Field on{' '}
{selectedRelationType === RelationDefinitionType.MANY_TO_ONE
{selectedRelationType === RelationType.MANY_TO_ONE
? selectedObjectMetadataItem?.labelSingular
: selectedObjectMetadataItem?.labelPlural}
</StyledInputsLabel>

View File

@ -17,8 +17,8 @@ import {
import { useIsMobile } from '@/ui/utilities/responsive/hooks/useIsMobile';
import {
FieldMetadataType,
RelationDefinition,
RelationDefinitionType,
Relation,
RelationType,
} from '~/generated-metadata/graphql';
type SettingsDataModelFieldRelationSettingsFormCardProps = {
fieldMetadataItem: Pick<FieldMetadataItem, 'icon' | 'label' | 'type'> &
@ -78,13 +78,16 @@ export const SettingsDataModelFieldRelationSettingsFormCard = ({
if (!relationObjectMetadataItem) return null;
const relationType = watchFormValue('relation.type', initialRelationType);
const relationType: RelationType = watchFormValue(
'relation.type',
initialRelationType,
);
const relationTypeConfig = RELATION_TYPES[relationType];
const oppositeRelationType =
relationType === RelationDefinitionType.MANY_TO_ONE
? RelationDefinitionType.ONE_TO_MANY
: RelationDefinitionType.MANY_TO_ONE;
relationType === RelationType.MANY_TO_ONE
? RelationType.ONE_TO_MANY
: RelationType.MANY_TO_ONE;
return (
<SettingsDataModelPreviewFormCard
@ -93,16 +96,15 @@ export const SettingsDataModelFieldRelationSettingsFormCard = ({
<StyledFieldPreviewCard
fieldMetadataItem={{
...fieldMetadataItem,
relationDefinition: {
direction: relationType,
} as RelationDefinition,
relation: {
type: relationType,
} as Relation,
}}
shrink
objectMetadataItem={objectMetadataItem}
relationObjectMetadataItem={relationObjectMetadataItem}
pluralizeLabel={
watchFormValue('relation.type') ===
RelationDefinitionType.MANY_TO_ONE
watchFormValue('relation.type') === RelationType.MANY_TO_ONE
}
/>
<StyledRelationImage
@ -124,16 +126,15 @@ export const SettingsDataModelFieldRelationSettingsFormCard = ({
initialRelationFieldMetadataItem.label,
) || 'Field name',
type: FieldMetadataType.RELATION,
relationDefinition: {
direction: oppositeRelationType,
} as RelationDefinition,
relation: {
type: oppositeRelationType,
} as Relation,
}}
shrink
objectMetadataItem={relationObjectMetadataItem}
relationObjectMetadataItem={objectMetadataItem}
pluralizeLabel={
watchFormValue('relation.type') !==
RelationDefinitionType.MANY_TO_ONE
watchFormValue('relation.type') !== RelationType.MANY_TO_ONE
}
/>
</StyledPreviewContent>

View File

@ -6,13 +6,13 @@ import { FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';
import { isObjectMetadataAvailableForRelation } from '@/object-metadata/utils/isObjectMetadataAvailableForRelation';
import { SettingsDataModelFieldPreviewCardProps } from '@/settings/data-model/fields/preview/components/SettingsDataModelFieldPreviewCard';
import { isDefined } from 'twenty-shared/utils';
import { RelationDefinitionType } from '~/generated-metadata/graphql';
import { RelationType } from '~/generated-metadata/graphql';
export const useRelationSettingsFormInitialValues = ({
fieldMetadataItem,
objectMetadataItem,
}: {
fieldMetadataItem?: Pick<FieldMetadataItem, 'type' | 'relationDefinition'>;
fieldMetadataItem?: Pick<FieldMetadataItem, 'type' | 'relation'>;
objectMetadataItem?: SettingsDataModelFieldPreviewCardProps['objectMetadataItem'];
}) => {
const { activeObjectMetadataItems } = useFilteredObjectMetadataItems();
@ -49,7 +49,7 @@ export const useRelationSettingsFormInitialValues = ({
]);
const initialRelationType =
relationTypeFromFieldMetadata ?? RelationDefinitionType.ONE_TO_MANY;
relationTypeFromFieldMetadata ?? RelationType.ONE_TO_MANY;
return {
disableFieldEdition:
@ -57,10 +57,7 @@ export const useRelationSettingsFormInitialValues = ({
disableRelationEdition: !!relationFieldMetadataItem,
initialRelationFieldMetadataItem: relationFieldMetadataItem ?? {
icon: initialRelationObjectMetadataItem.icon ?? 'IconUsers',
label: [
RelationDefinitionType.MANY_TO_MANY,
RelationDefinitionType.MANY_TO_ONE,
].includes(initialRelationType)
label: [RelationType.MANY_TO_ONE].includes(initialRelationType)
? initialRelationObjectMetadataItem.labelPlural
: initialRelationObjectMetadataItem.labelSingular,
},

View File

@ -26,7 +26,7 @@ export type SettingsDataModelFieldPreviewProps = {
| 'defaultValue'
| 'options'
| 'settings'
| 'relationDefinition'
| 'relation'
> & {
id?: string;
name?: string;
@ -102,7 +102,7 @@ export const SettingsDataModelFieldPreview = ({
fieldMetadataItem.name || `${fieldMetadataItem.type}-new-field`;
const recordId =
previewRecord?.id ??
`${objectMetadataItem.nameSingular}-${fieldName}-${fieldMetadataItem.relationDefinition?.direction}-${relationObjectMetadataItem?.nameSingular}-preview`;
`${objectMetadataItem.nameSingular}-${fieldName}-${fieldMetadataItem.relation?.type}-${relationObjectMetadataItem?.nameSingular}-preview`;
return (
<>
@ -146,7 +146,7 @@ export const SettingsDataModelFieldPreview = ({
relationObjectMetadataItem?.nameSingular,
options: fieldMetadataItem.options ?? [],
settings: fieldMetadataItem.settings,
relationType: fieldMetadataItem.relationDefinition?.direction,
relationType: fieldMetadataItem.relation?.type,
},
defaultValue: fieldMetadataItem.defaultValue,
},

View File

@ -8,15 +8,12 @@ import { getFieldPreviewValue } from '@/settings/data-model/fields/preview/utils
import { getMultiSelectFieldPreviewValue } from '@/settings/data-model/fields/preview/utils/getMultiSelectFieldPreviewValue';
import { getPhonesFieldPreviewValue } from '@/settings/data-model/fields/preview/utils/getPhonesFieldPreviewValue';
import { getSelectFieldPreviewValue } from '@/settings/data-model/fields/preview/utils/getSelectFieldPreviewValue';
import {
FieldMetadataType,
RelationDefinitionType,
} from '~/generated-metadata/graphql';
import { FieldMetadataType, RelationType } from '~/generated-metadata/graphql';
type UseFieldPreviewParams = {
fieldMetadataItem: Pick<
FieldMetadataItem,
'type' | 'options' | 'defaultValue' | 'relationDefinition'
'type' | 'options' | 'defaultValue' | 'relation'
>;
relationObjectMetadataItem?: ObjectMetadataItem;
skip?: boolean;
@ -46,8 +43,7 @@ export const useFieldPreviewValue = ({
case FieldMetadataType.CURRENCY:
return getCurrencyFieldPreviewValue({ fieldMetadataItem });
case FieldMetadataType.RELATION:
return fieldMetadataItem.relationDefinition?.direction ===
RelationDefinitionType.MANY_TO_ONE
return fieldMetadataItem.relation?.type === RelationType.MANY_TO_ONE
? relationFieldPreviewValue
: [relationFieldPreviewValue];
case FieldMetadataType.SELECT:

View File

@ -43,25 +43,22 @@ export const SettingsDataModelOverviewEffect = ({
for (const field of object.fields) {
if (
isDefined(field.relationDefinition) &&
isDefined(field.relation) &&
isDefined(
items.find(
(x) =>
x.id === field.relationDefinition?.targetObjectMetadata.id,
(x) => x.id === field.relation?.targetObjectMetadata.id,
),
)
) {
const sourceObj =
field.relationDefinition?.sourceObjectMetadata.namePlural;
const targetObj =
field.relationDefinition?.targetObjectMetadata.namePlural;
const sourceObj = field.relation?.sourceObjectMetadata.namePlural;
const targetObj = field.relation?.targetObjectMetadata.namePlural;
edges.push({
id: `${sourceObj}-${targetObj}`,
source: object.namePlural,
sourceHandle: `${field.id}-right`,
target: field.relationDefinition.targetObjectMetadata.namePlural,
targetHandle: `${field.relationDefinition.targetObjectMetadata}-left`,
target: field.relation.targetObjectMetadata.namePlural,
targetHandle: `${field.relation.targetObjectMetadata}-left`,
type: 'smoothstep',
style: {
strokeWidth: 1,
@ -71,8 +68,8 @@ export const SettingsDataModelOverviewEffect = ({
markerStart: 'marker',
data: {
sourceField: field.id,
targetField: field.relationDefinition.targetFieldMetadata.id,
relation: field.relationDefinition.direction,
targetField: field.relation.targetFieldMetadata.id,
relation: field.relation.type,
sourceObject: sourceObj,
targetObject: targetObj,
},

View File

@ -5,8 +5,8 @@ import { useRecoilValue } from 'recoil';
import { objectMetadataItemsState } from '@/object-metadata/states/objectMetadataItemsState';
import { FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';
import { RelationDefinitionType } from '~/generated-metadata/graphql';
import { useIcons } from 'twenty-ui/display';
import { RelationType } from '~/generated-metadata/graphql';
type ObjectFieldRowProps = {
field: FieldMetadataItem;
@ -30,7 +30,7 @@ export const ObjectFieldRow = ({ field }: ObjectFieldRowProps) => {
const { getIcon } = useIcons();
const theme = useTheme();
const relatedObjectId = field.relationDefinition?.targetObjectMetadata.id;
const relatedObjectId = field.relation?.targetObjectMetadata.id;
const relatedObject = objectMetadataItems.find(
(x) => x.id === relatedObjectId,
@ -44,32 +44,28 @@ export const ObjectFieldRow = ({ field }: ObjectFieldRowProps) => {
<StyledFieldName>{relatedObject?.labelPlural ?? ''}</StyledFieldName>
<Handle
type={
field.relationDefinition?.direction ===
RelationDefinitionType.ONE_TO_MANY
field.relation?.type === RelationType.ONE_TO_MANY
? 'source'
: 'target'
}
position={Position.Right}
id={`${field.id}-right`}
className={
field.relationDefinition?.direction ===
RelationDefinitionType.ONE_TO_MANY
field.relation?.type === RelationType.ONE_TO_MANY
? 'right-handle source-handle'
: 'right-handle target-handle'
}
/>
<Handle
type={
field.relationDefinition?.direction ===
RelationDefinitionType.ONE_TO_MANY
field.relation?.type === RelationType.ONE_TO_MANY
? 'source'
: 'target'
}
position={Position.Left}
id={`${field.id}-left`}
className={
field.relationDefinition?.direction ===
RelationDefinitionType.ONE_TO_MANY
field.relation?.type === RelationType.ONE_TO_MANY
? 'left-handle source-handle'
: 'left-handle target-handle'
}

View File

@ -19,16 +19,16 @@ import { useTheme } from '@emotion/react';
import styled from '@emotion/styled';
import { useMemo } from 'react';
import { useRecoilState, useRecoilValue } from 'recoil';
import { RelationDefinitionType } from '~/generated-metadata/graphql';
import { isDefined } from 'twenty-shared/utils';
import { IconMinus, IconPlus, useIcons } from 'twenty-ui/display';
import { LightIconButton } from 'twenty-ui/input';
import { UndecoratedLink } from 'twenty-ui/navigation';
import { RelationType } from '~/generated-metadata/graphql';
import { useNavigateSettings } from '~/hooks/useNavigateSettings';
import { SettingsObjectDetailTableItem } from '~/pages/settings/data-model/types/SettingsObjectDetailTableItem';
import { getSettingsPath } from '~/utils/navigation/getSettingsPath';
import { RELATION_TYPES } from '../../constants/RelationTypes';
import { SettingsObjectFieldDataType } from './SettingsObjectFieldDataType';
import { isDefined } from 'twenty-shared/utils';
import { IconMinus, IconPlus, useIcons } from 'twenty-ui/display';
import { LightIconButton } from 'twenty-ui/input';
import { UndecoratedLink } from 'twenty-ui/navigation';
type SettingsObjectFieldItemTableRowProps = {
settingsObjectDetailTableItem: SettingsObjectDetailTableItem;
@ -240,8 +240,7 @@ export const SettingsObjectFieldItemTableRow = ({
<SettingsObjectFieldDataType
Icon={RelationIcon}
label={
relationType === RelationDefinitionType.MANY_TO_ONE ||
relationType === RelationDefinitionType.ONE_TO_ONE
relationType === RelationType.MANY_TO_ONE
? relationObjectMetadataItem?.labelSingular
: relationObjectMetadataItem?.labelPlural
}

View File

@ -1,3 +0,0 @@
import { RelationDefinitionType } from '~/generated-metadata/graphql';
export type RelationType = RelationDefinitionType;