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

Deprecate old relations completely (#12482)

Browse Source 
# 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
Download Patch File Download Diff File Expand all files Collapse all files

25
packages/twenty-front/src/modules/object-metadata/graphql/mutations.ts
View File

@ -45,23 +45,6 @@ export const CREATE_ONE_FIELD_METADATA_ITEM = gql`
}
`;
export const CREATE_ONE_RELATION_METADATA_ITEM = gql`
mutation CreateOneRelationMetadataItem(
$input: CreateOneRelationMetadataInput!
) {
createOneRelationMetadata(input: $input) {
id
relationType
fromObjectMetadataId
toObjectMetadataId
fromFieldMetadataId
toFieldMetadataId
createdAt
updatedAt
}
}
`;
export const UPDATE_ONE_FIELD_METADATA_ITEM = gql`
mutation UpdateOneFieldMetadataItem(
$idToUpdate: UUID!
@ -152,11 +135,3 @@ export const DELETE_ONE_FIELD_METADATA_ITEM = gql`
}
}
`;
export const DELETE_ONE_RELATION_METADATA_ITEM = gql`
mutation DeleteOneRelationMetadataItem($idToDelete: UUID!) {
deleteOneRelation(input: { id: $idToDelete }) {
id
}
}
`;

15
packages/twenty-front/src/modules/object-metadata/graphql/queries.ts
View File

@ -67,23 +67,22 @@ export const FIND_MANY_OBJECT_METADATA_ITEMS = gql`
options
settings
isLabelSyncedWithName
relationDefinition {
relationId
direction
relation {
type
sourceObjectMetadata {
id
nameSingular
namePlural
}
targetObjectMetadata {
id
nameSingular
namePlural
}
sourceFieldMetadata {
id
name
}
targetObjectMetadata {
id
nameSingular
namePlural
}
targetFieldMetadata {
id
name

47
packages/twenty-front/src/modules/object-metadata/hooks/__mocks__/useCreateOneRelationMetadataItem.ts
View File

@ -1,47 +0,0 @@
import { gql } from '@apollo/client';
export const query = gql`
mutation CreateOneRelationMetadataItem(
$input: CreateOneRelationMetadataInput!
) {
createOneRelationMetadata(input: $input) {
id
relationType
fromObjectMetadataId
toObjectMetadataId
fromFieldMetadataId
toFieldMetadataId
createdAt
updatedAt
}
}
`;
export const variables = {
input: {
relationMetadata: {
fromDescription: null,
fromIcon: undefined,
fromLabel: 'label',
fromName: 'name',
fromObjectMetadataId: 'objectMetadataId',
relationType: 'ONE_TO_ONE',
toDescription: null,
toIcon: undefined,
toLabel: 'Another label',
toName: 'anotherName',
toObjectMetadataId: 'objectMetadataId1',
},
},
};
export const responseData = {
id: '',
relationType: 'ONE_TO_ONE',
fromObjectMetadataId: 'objectMetadataId',
toObjectMetadataId: 'objectMetadataId1',
fromFieldMetadataId: '',
toFieldMetadataId: '',
createdAt: '',
updatedAt: '',
};

15
packages/twenty-front/src/modules/object-metadata/hooks/__mocks__/useDeleteOneRelationMetadataItem.ts
View File

@ -1,15 +0,0 @@
import { gql } from '@apollo/client';
export const query = gql`
mutation DeleteOneRelationMetadataItem($idToDelete: UUID!) {
deleteOneRelation(input: { id: $idToDelete }) {
id
}
}
`;
export const variables = { idToDelete: 'idToDelete' };
export const responseData = {
id: 'idToDelete',
};

10
packages/twenty-front/src/modules/object-metadata/hooks/__mocks__/useFieldMetadataItem.ts
View File

@ -4,7 +4,6 @@ import { FieldMetadataType, PermissionsOnAllObjectRecords } from '~/generated/gr
export const FIELD_METADATA_ID = '2c43466a-fe9e-4005-8d08-c5836067aa6c';
export const FIELD_RELATION_METADATA_ID =
'4da0302d-358a-45cd-9973-9f92723ed3c1';
export const RELATION_METADATA_ID = 'f81d4fae-7dec-11d0-a765-00a0c91e6bf6';
export const queries = {
deleteMetadataField: gql`
@ -67,13 +66,6 @@ export const queries = {
}
}
`,
deleteMetadataFieldRelation: gql`
mutation DeleteOneRelationMetadataItem($idToDelete: UUID!) {
deleteOneRelation(input: { id: $idToDelete }) {
id
}
}
`,
activateMetadataField: gql`
mutation UpdateOneFieldMetadataItem(
$idToUpdate: UUID!
@ -216,7 +208,7 @@ export const objectMetadataId = '25611fce-6637-4089-b0ca-91afeec95784';
export const variables = {
deleteMetadataField: { idToDelete: FIELD_METADATA_ID },
deleteMetadataFieldRelation: { idToDelete: RELATION_METADATA_ID },
deleteMetadataFieldRelation: { idToDelete: FIELD_RELATION_METADATA_ID },
activateMetadataField: {
idToUpdate: FIELD_METADATA_ID,
updatePayload: { isActive: true },

2
packages/twenty-front/src/modules/object-metadata/hooks/__tests__/useColumnDefinitionsFromFieldMetadata.test.ts
View File

@ -69,6 +69,6 @@ describe('useColumnDefinitionsFromFieldMetadata', () => {
const { columnDefinitions } = result.current;
expect(columnDefinitions.length).toBe(22);
expect(columnDefinitions.length).toBe(21);
});
});

77
packages/twenty-front/src/modules/object-metadata/hooks/__tests__/useCreateOneRelationMetadataItem.test.tsx
View File

@ -1,77 +0,0 @@
import { MockedProvider } from '@apollo/client/testing';
import { renderHook } from '@testing-library/react';
import { ReactNode, act } from 'react';
import { RecoilRoot } from 'recoil';
import { useCreateOneRelationMetadataItem } from '@/object-metadata/hooks/useCreateOneRelationMetadataItem';
import { RelationDefinitionType } from '~/generated/graphql';
import {
query,
responseData,
variables,
} from '../__mocks__/useCreateOneRelationMetadataItem';
import {
query as findManyObjectMetadataItemsQuery,
responseData as findManyObjectMetadataItemsResponseData,
} from '../__mocks__/useFindManyObjectMetadataItems';
const mocks = [
{
request: {
query,
variables,
},
result: jest.fn(() => ({
data: {
createOneRelation: responseData,
},
})),
},
{
request: {
query: findManyObjectMetadataItemsQuery,
variables: {},
},
result: jest.fn(() => ({
data: findManyObjectMetadataItemsResponseData,
})),
},
];
const Wrapper = ({ children }: { children: ReactNode }) => (
<RecoilRoot>
<MockedProvider mocks={mocks} addTypename={false}>
{children}
</MockedProvider>
</RecoilRoot>
);
describe('useCreateOneRelationMetadataItem', () => {
it('should work as expected', async () => {
const { result } = renderHook(() => useCreateOneRelationMetadataItem(), {
wrapper: Wrapper,
});
await act(async () => {
const res = await result.current.createOneRelationMetadataItem({
relationType: RelationDefinitionType.ONE_TO_ONE,
field: {
label: 'label',
name: 'name',
},
objectMetadataId: 'objectMetadataId',
connect: {
field: {
label: 'Another label',
name: 'anotherName',
},
objectMetadataId: 'objectMetadataId1',
},
});
expect(res.data).toEqual({ createOneRelation: responseData });
});
});
});

63
packages/twenty-front/src/modules/object-metadata/hooks/__tests__/useDeleteOneRelationMetadataItem.test.tsx
View File

@ -1,63 +0,0 @@
import { MockedProvider } from '@apollo/client/testing';
import { act, renderHook } from '@testing-library/react';
import { ReactNode } from 'react';
import { RecoilRoot } from 'recoil';
import { useDeleteOneRelationMetadataItem } from '@/object-metadata/hooks/useDeleteOneRelationMetadataItem';
import {
query,
responseData,
variables,
} from '../__mocks__/useDeleteOneRelationMetadataItem';
import {
query as findManyObjectMetadataItemsQuery,
responseData as findManyObjectMetadataItemsResponseData,
} from '../__mocks__/useFindManyObjectMetadataItems';
const mocks = [
{
request: {
query,
variables,
},
result: jest.fn(() => ({
data: {
deleteOneRelation: responseData,
},
})),
},
{
request: {
query: findManyObjectMetadataItemsQuery,
variables: {},
},
result: jest.fn(() => ({
data: findManyObjectMetadataItemsResponseData,
})),
},
];
const Wrapper = ({ children }: { children: ReactNode }) => (
<RecoilRoot>
<MockedProvider mocks={mocks} addTypename={false}>
{children}
</MockedProvider>
</RecoilRoot>
);
describe('useDeleteOneRelationMetadataItem', () => {
it('should work as expected', async () => {
const { result } = renderHook(() => useDeleteOneRelationMetadataItem(), {
wrapper: Wrapper,
});
await act(async () => {
const res =
await result.current.deleteOneRelationMetadataItem('idToDelete');
expect(res.data).toEqual({ deleteOneRelation: responseData });
});
});
});

14
packages/twenty-front/src/modules/object-metadata/hooks/__tests__/useFieldMetadataItem.test.tsx
View File

@ -3,7 +3,7 @@ import { act } from 'react';
import { useFieldMetadataItem } from '@/object-metadata/hooks/useFieldMetadataItem';
import { FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';
import { FieldMetadataType, RelationDefinitionType } from '~/generated/graphql';
import { FieldMetadataType, RelationType } from '~/generated/graphql';
import { getJestMetadataAndApolloMocksWrapper } from '~/testing/jest/getJestMetadataAndApolloMocksWrapper';
import {
@ -11,7 +11,6 @@ import {
FIELD_RELATION_METADATA_ID,
objectMetadataId,
queries,
RELATION_METADATA_ID,
responseData,
variables,
} from '../__mocks__/useFieldMetadataItem';
@ -49,9 +48,8 @@ const fieldRelationMetadataItem: FieldMetadataItem = {
type: FieldMetadataType.RELATION,
updatedAt: '',
isLabelSyncedWithName: true,
relationDefinition: {
relationId: RELATION_METADATA_ID,
direction: RelationDefinitionType.ONE_TO_MANY,
relation: {
type: RelationType.ONE_TO_MANY,
sourceFieldMetadata: {
id: 'e5903d91-9b10-4f3e-b761-35c36e93b7c1',
name: 'sourceField',
@ -112,12 +110,12 @@ const mocks = [
},
{
request: {
query: queries.deleteMetadataFieldRelation,
query: queries.deleteMetadataField,
variables: variables.deleteMetadataFieldRelation,
},
result: jest.fn(() => ({
data: {
deleteOneRelation: responseData.fieldRelation,
deleteOneField: responseData.fieldRelation,
},
})),
},
@ -236,7 +234,7 @@ describe('useFieldMetadataItem', () => {
);
expect(res.data).toEqual({
deleteOneRelation: responseData.fieldRelation,
deleteOneField: responseData.fieldRelation,
});
});
});

47
packages/twenty-front/src/modules/object-metadata/hooks/useCreateOneRelationMetadataItem.ts
View File

@ -1,47 +0,0 @@
import { useMutation } from '@apollo/client';
import {
CreateOneRelationMetadataItemMutation,
CreateOneRelationMetadataItemMutationVariables,
} from '~/generated-metadata/graphql';
import { CREATE_ONE_RELATION_METADATA_ITEM } from '../graphql/mutations';
import {
formatRelationMetadataInput,
FormatRelationMetadataInputParams,
} from '../utils/formatRelationMetadataInput';
import { useRefreshObjectMetadataItems } from '@/object-metadata/hooks/useRefreshObjectMetadataItem';
import { useApolloMetadataClient } from './useApolloMetadataClient';
export const useCreateOneRelationMetadataItem = () => {
const apolloMetadataClient = useApolloMetadataClient();
const [mutate] = useMutation<
CreateOneRelationMetadataItemMutation,
CreateOneRelationMetadataItemMutationVariables
>(CREATE_ONE_RELATION_METADATA_ITEM, {
client: apolloMetadataClient,
});
const { refreshObjectMetadataItems } =
useRefreshObjectMetadataItems('network-only');
const createOneRelationMetadataItem = async (
input: FormatRelationMetadataInputParams,
) => {
const result = await mutate({
variables: {
input: { relationMetadata: formatRelationMetadataInput(input) },
},
});
await refreshObjectMetadataItems();
return result;
};
return {
createOneRelationMetadataItem,
};
};

42
packages/twenty-front/src/modules/object-metadata/hooks/useDeleteOneRelationMetadataItem.ts
View File

@ -1,42 +0,0 @@
import { useMutation } from '@apollo/client';
import { DELETE_ONE_RELATION_METADATA_ITEM } from '@/object-metadata/graphql/mutations';
import {
DeleteOneRelationMetadataItemMutation,
DeleteOneRelationMetadataItemMutationVariables,
} from '~/generated-metadata/graphql';
import { useRefreshObjectMetadataItems } from '@/object-metadata/hooks/useRefreshObjectMetadataItem';
import { useApolloMetadataClient } from './useApolloMetadataClient';
export const useDeleteOneRelationMetadataItem = () => {
const apolloMetadataClient = useApolloMetadataClient();
const [mutate] = useMutation<
DeleteOneRelationMetadataItemMutation,
DeleteOneRelationMetadataItemMutationVariables
>(DELETE_ONE_RELATION_METADATA_ITEM, {
client: apolloMetadataClient,
});
const { refreshObjectMetadataItems } =
useRefreshObjectMetadataItems('network-only');
const deleteOneRelationMetadataItem = async (
idToDelete: DeleteOneRelationMetadataItemMutationVariables['idToDelete'],
) => {
const result = await mutate({
variables: {
idToDelete,
},
});
await refreshObjectMetadataItems();
return result;
};
return {
deleteOneRelationMetadataItem,
};
};

19
packages/twenty-front/src/modules/object-metadata/hooks/useFieldMetadataItem.ts
View File

@ -1,10 +1,8 @@
import { useDeleteOneRelationMetadataItem } from '@/object-metadata/hooks/useDeleteOneRelationMetadataItem';
import { Field, FieldMetadataType } from '~/generated-metadata/graphql';
import { Field, RelationType } from '~/generated-metadata/graphql';
import { FieldMetadataItem } from '../types/FieldMetadataItem';
import { formatFieldMetadataItemInput } from '../utils/formatFieldMetadataItemInput';
import { isDefined } from 'twenty-shared/utils';
import { useCreateOneFieldMetadataItem } from './useCreateOneFieldMetadataItem';
import { useDeleteOneFieldMetadataItem } from './useDeleteOneFieldMetadataItem';
import { useUpdateOneFieldMetadataItem } from './useUpdateOneFieldMetadataItem';
@ -13,7 +11,6 @@ export const useFieldMetadataItem = () => {
const { createOneFieldMetadataItem } = useCreateOneFieldMetadataItem();
const { updateOneFieldMetadataItem } = useUpdateOneFieldMetadataItem();
const { deleteOneFieldMetadataItem } = useDeleteOneFieldMetadataItem();
const { deleteOneRelationMetadataItem } = useDeleteOneRelationMetadataItem();
const createMetadataField = (
input: Pick<
@ -29,6 +26,12 @@ export const useFieldMetadataItem = () => {
| 'isLabelSyncedWithName'
> & {
objectMetadataId: string;
relationCreationPayload?: {
type: RelationType;
targetObjectMetadataId: string;
targetFieldLabel: string;
targetFieldIcon: string;
};
},
) => {
const formattedInput = formatFieldMetadataItemInput(input);
@ -40,6 +43,7 @@ export const useFieldMetadataItem = () => {
label: formattedInput.label ?? '',
name: formattedInput.name ?? '',
isLabelSyncedWithName: formattedInput.isLabelSyncedWithName ?? true,
relationCreationPayload: input.relationCreationPayload,
});
};
@ -64,12 +68,7 @@ export const useFieldMetadataItem = () => {
});
const deleteMetadataField = (metadataField: FieldMetadataItem) => {
return metadataField.type === FieldMetadataType.RELATION &&
!isDefined(metadataField.settings?.relationType)
? deleteOneRelationMetadataItem(
metadataField.relationDefinition?.relationId,
)
: deleteOneFieldMetadataItem(metadataField.id);
return deleteOneFieldMetadataItem(metadataField.id);
};
return {

15
packages/twenty-front/src/modules/object-metadata/hooks/useGetRelationMetadata.ts
View File

@ -11,21 +11,18 @@ export const useGetRelationMetadata = () =>
({
fieldMetadataItem,
}: {
fieldMetadataItem: Pick<
FieldMetadataItem,
'type' | 'relationDefinition'
>;
fieldMetadataItem: Pick<FieldMetadataItem, 'type' | 'relation'>;
}) => {
if (fieldMetadataItem.type !== FieldMetadataType.RELATION) return null;
const relationDefinition = fieldMetadataItem.relationDefinition;
const relation = fieldMetadataItem.relation;
if (!relationDefinition) return null;
if (!relation) return null;
const relationObjectMetadataItem = snapshot
.getLoadable(
objectMetadataItemFamilySelector({
objectName: relationDefinition.targetObjectMetadata.nameSingular,
objectName: relation.targetObjectMetadata.nameSingular,
objectNameType: 'singular',
}),
)
@ -35,7 +32,7 @@ export const useGetRelationMetadata = () =>
const relationFieldMetadataItem =
relationObjectMetadataItem.fields.find(
(field) => field.id === relationDefinition.targetFieldMetadata.id,
(field) => field.id === relation.targetFieldMetadata.id,
);
if (!relationFieldMetadataItem) return null;
@ -43,7 +40,7 @@ export const useGetRelationMetadata = () =>
return {
relationFieldMetadataItem,
relationObjectMetadataItem,
relationType: relationDefinition.direction,
relationType: relation.type,
};
},
[],

25
packages/twenty-front/src/modules/object-metadata/types/FieldMetadataItem.ts
View File

@ -1,12 +1,8 @@
import { FieldMetadataItemRelation } from '@/object-metadata/types/FieldMetadataItemRelation';
import { FieldDateMetadataSettings } from '@/object-record/record-field/types/FieldMetadata';
import { ThemeColor } from 'twenty-ui/theme';
import {
Field,
Object as MetadataObject,
RelationDefinition,
RelationDefinitionType,
} from '~/generated-metadata/graphql';
import { Field } from '~/generated-metadata/graphql';
export type FieldMetadataItemOption = {
color: ThemeColor;
@ -18,25 +14,12 @@ export type FieldMetadataItemOption = {
export type FieldMetadataItem = Omit<
Field,
'__typename' | 'defaultValue' | 'options' | 'relationDefinition'
'__typename' | 'defaultValue' | 'options' | 'relation'
> & {
__typename?: string;
defaultValue?: any;
options?: FieldMetadataItemOption[] | null;
relationDefinition?: {
relationId: RelationDefinition['relationId'];
direction: RelationDefinitionType;
sourceFieldMetadata: Pick<Field, 'id' | 'name'>;
sourceObjectMetadata: Pick<
MetadataObject,
'id' | 'nameSingular' | 'namePlural'
>;
targetFieldMetadata: Pick<Field, 'id' | 'name'>;
targetObjectMetadata: Pick<
MetadataObject,
'id' | 'nameSingular' | 'namePlural'
>;
} | null;
relation?: FieldMetadataItemRelation | null;
settings?: FieldDateMetadataSettings;
isLabelSyncedWithName?: boolean | null;
};

17
packages/twenty-front/src/modules/object-metadata/types/FieldMetadataItemRelation.ts Normal file
View File

@ -0,0 +1,17 @@
import { ObjectMetadataItem } from '@/object-metadata/types/ObjectMetadataItem';
import { Field, RelationType } from '~/generated-metadata/graphql';
export type FieldMetadataItemRelation = {
type: RelationType;
sourceFieldMetadata: Pick<Field, 'id' | 'name'>;
targetFieldMetadata: Pick<Field, 'id' | 'name'>;
sourceObjectMetadata: Pick<
ObjectMetadataItem,
'id' | 'nameSingular' | 'namePlural'
>;
targetObjectMetadata: Pick<
ObjectMetadataItem,
'id' | 'nameSingular' | 'namePlural'
>;
};

74
packages/twenty-front/src/modules/object-metadata/utils/__tests__/shouldFieldBeQueried.test.ts
View File

@ -1,5 +1,5 @@
import { shouldFieldBeQueried } from '@/object-metadata/utils/shouldFieldBeQueried';
import { FieldMetadataType } from '~/generated-metadata/graphql';
import { FieldMetadataType, RelationType } from '~/generated-metadata/graphql';
describe('shouldFieldBeQueried', () => {
describe('if recordGqlFields is absent, we query all except relations', () => {
@ -11,20 +11,62 @@ describe('shouldFieldBeQueried', () => {
expect(res).toBe(true);
});
it('should not be queried if the field is a relation', () => {
it('should not be queried if the field is a relation ONE_TO_MANY', () => {
const res = shouldFieldBeQueried({
gqlField: 'fieldName',
fieldMetadata: { name: 'fieldName', type: FieldMetadataType.RELATION },
fieldMetadata: {
name: 'fieldName',
type: FieldMetadataType.RELATION,
settings: {
relationType: RelationType.ONE_TO_MANY,
},
},
});
expect(res).toBe(false);
});
it('should not be queried if the field is a relation MANY_TO_ONE', () => {
const res = shouldFieldBeQueried({
gqlField: 'fieldName',
fieldMetadata: {
name: 'fieldName',
type: FieldMetadataType.RELATION,
settings: {
relationType: RelationType.MANY_TO_ONE,
joinColumnName: 'fieldNameId',
},
},
});
expect(res).toBe(false);
});
it('should be queried if the field is a relation MANY_TO_ONE and is the joinColumnName', () => {
const res = shouldFieldBeQueried({
gqlField: 'fieldNameId',
fieldMetadata: {
name: 'fieldNameId',
type: FieldMetadataType.RELATION,
settings: {
relationType: RelationType.MANY_TO_ONE,
joinColumnName: 'fieldNameId',
},
},
});
expect(res).toBe(true);
});
});
describe('if recordGqlFields is present, we respect it', () => {
it('should be queried if true', () => {
const res = shouldFieldBeQueried({
gqlField: 'fieldName',
fieldMetadata: { name: 'fieldName', type: FieldMetadataType.RELATION },
fieldMetadata: {
name: 'fieldName',
type: FieldMetadataType.RELATION,
settings: {
relationType: RelationType.ONE_TO_MANY,
},
},
recordGqlFields: { fieldName: true },
});
expect(res).toBe(true);
@ -33,7 +75,13 @@ describe('shouldFieldBeQueried', () => {
it('should be queried if object', () => {
const res = shouldFieldBeQueried({
recordGqlFields: { fieldName: { subFieldName: false } },
fieldMetadata: { name: 'fieldName', type: FieldMetadataType.RELATION },
fieldMetadata: {
name: 'fieldName',
type: FieldMetadataType.RELATION,
settings: {
relationType: RelationType.ONE_TO_MANY,
},
},
gqlField: 'fieldName',
});
expect(res).toBe(true);
@ -42,7 +90,13 @@ describe('shouldFieldBeQueried', () => {
it('should not be queried if false', () => {
const res = shouldFieldBeQueried({
gqlField: 'fieldName',
fieldMetadata: { name: 'fieldName', type: FieldMetadataType.RELATION },
fieldMetadata: {
name: 'fieldName',
type: FieldMetadataType.RELATION,
settings: {
relationType: RelationType.ONE_TO_MANY,
},
},
recordGqlFields: { fieldName: false },
});
expect(res).toBe(false);
@ -51,7 +105,13 @@ describe('shouldFieldBeQueried', () => {
it('should not be queried if absent', () => {
const res = shouldFieldBeQueried({
gqlField: 'fieldName',
fieldMetadata: { name: 'fieldName', type: FieldMetadataType.RELATION },
fieldMetadata: {
name: 'fieldName',
type: FieldMetadataType.RELATION,
settings: {
relationType: RelationType.ONE_TO_MANY,
},
},
recordGqlFields: { otherFieldName: false },
});
expect(res).toBe(false);

11
packages/twenty-front/src/modules/object-metadata/utils/formatFieldMetadataItemAsFieldDefinition.ts
View File

@ -18,16 +18,14 @@ export const formatFieldMetadataItemAsFieldDefinition = ({
showLabel,
labelWidth,
}: FieldMetadataItemAsFieldDefinitionProps): FieldDefinition<FieldMetadata> => {
const relationObjectMetadataItem =
field.relationDefinition?.targetObjectMetadata;
const relationObjectMetadataItem = field.relation?.targetObjectMetadata;
const relationFieldMetadataId =
field.relationDefinition?.targetFieldMetadata.id;
const relationFieldMetadataId = field.relation?.targetFieldMetadata.id;
const fieldDefintionMetadata = {
fieldName: field.name,
placeHolder: field.label,
relationType: field.relationDefinition?.direction,
relationType: field.relation?.type,
relationFieldMetadataId,
relationObjectMetadataNameSingular:
relationObjectMetadataItem?.nameSingular ?? '',
@ -35,8 +33,7 @@ export const formatFieldMetadataItemAsFieldDefinition = ({
relationObjectMetadataItem?.namePlural ?? '',
relationObjectMetadataId: relationObjectMetadataItem?.id ?? '',
objectMetadataNameSingular: objectMetadataItem.nameSingular ?? '',
targetFieldMetadataName:
field.relationDefinition?.targetFieldMetadata?.name ?? '',
targetFieldMetadataName: field.relation?.targetFieldMetadata?.name ?? '',
options: field.options,
settings: field.settings,
isNullable: field.isNullable,

2
packages/twenty-front/src/modules/object-metadata/utils/formatFieldMetadataItemsAsFilterDefinitions.ts
View File

@ -8,7 +8,7 @@ export const getRelationObjectMetadataNameSingular = ({
}: {
field: ObjectMetadataItem['fields'][0];
}): string | undefined => {
return field.relationDefinition?.targetObjectMetadata.nameSingular;
return field.relation?.targetObjectMetadata.nameSingular;
};
export const getFilterTypeFromFieldType = (

62
packages/twenty-front/src/modules/object-metadata/utils/formatRelationMetadataInput.ts
View File

@ -1,62 +0,0 @@
import { RelationType } from '@/settings/data-model/types/RelationType';
import {
CreateRelationInput,
Field,
RelationDefinitionType,
RelationMetadataType,
} from '~/generated-metadata/graphql';
import { formatFieldMetadataItemInput } from './formatFieldMetadataItemInput';
export type FormatRelationMetadataInputParams = {
relationType: RelationType;
field: Pick<Field, 'label' | 'icon' | 'description' | 'name'>;
objectMetadataId: string;
connect: {
field: Pick<Field, 'label' | 'icon' | 'name'>;
objectMetadataId: string;
};
};
export const formatRelationMetadataInput = (
input: FormatRelationMetadataInputParams,
): CreateRelationInput => {
// /!\ MANY_TO_ONE does not exist on backend.
// => Transform into ONE_TO_MANY and invert "from" and "to" data.
const isManyToOne = input.relationType === 'MANY_TO_ONE';
const relationType = isManyToOne
? RelationDefinitionType.ONE_TO_MANY
: (input.relationType as RelationDefinitionType);
const { field: fromField, objectMetadataId: fromObjectMetadataId } =
isManyToOne ? input.connect : input;
const { field: toField, objectMetadataId: toObjectMetadataId } = isManyToOne
? input
: input.connect;
const {
description: fromDescription,
icon: fromIcon,
label: fromLabel = '',
name: fromName = '',
} = formatFieldMetadataItemInput(fromField);
const {
description: toDescription,
icon: toIcon,
label: toLabel = '',
name: toName = '',
} = formatFieldMetadataItemInput(toField);
return {
fromDescription,
fromIcon,
fromLabel,
fromName,
fromObjectMetadataId,
relationType: relationType as unknown as RelationMetadataType,
toDescription,
toIcon,
toLabel,
toName,
toObjectMetadataId,
};
};

9
packages/twenty-front/src/modules/object-metadata/utils/getFilterFilterableFieldMetadataItems.ts
View File

@ -1,8 +1,5 @@
import { FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';
import {
FieldMetadataType,
RelationDefinitionType,
} from '~/generated-metadata/graphql';
import { FieldMetadataType, RelationType } from '~/generated-metadata/graphql';
export const getFilterFilterableFieldMetadataItems = ({
isJsonFilterEnabled,
@ -15,9 +12,7 @@ export const getFilterFilterableFieldMetadataItems = ({
const isRelationFieldHandled = !(
field.type === FieldMetadataType.RELATION &&
field.relationDefinition?.direction !==
RelationDefinitionType.MANY_TO_ONE &&
field.relationDefinition?.direction !== RelationDefinitionType.ONE_TO_ONE
field.relation?.type !== RelationType.MANY_TO_ONE
);
const isFieldTypeFilterable = [

18
packages/twenty-front/src/modules/object-metadata/utils/mapFieldMetadataToGraphQLQuery.ts
View File

@ -3,7 +3,7 @@ import { isUndefined } from '@sniptt/guards';
import {
FieldMetadataType,
ObjectPermission,
RelationDefinitionType,
RelationType,
} from '~/generated-metadata/graphql';
import { ObjectMetadataItem } from '@/object-metadata/types/ObjectMetadataItem';
@ -18,13 +18,13 @@ type MapFieldMetadataToGraphQLQueryArgs = {
gqlField: string;
fieldMetadata: Pick<
FieldMetadataItem,
'name' | 'type' | 'relationDefinition' | 'settings'
'name' | 'type' | 'relation' | 'settings'
>;
relationRecordGqlFields?: RecordGqlFields;
computeReferences?: boolean;
objectPermissionsByObjectMetadataId: Record<string, ObjectPermission>;
};
// TODO: change ObjectMetadataItems mock before refactoring with relationDefinition computed field
// TODO: change ObjectMetadataItems mock before refactoring with relation computed field
export const mapFieldMetadataToGraphQLQuery = ({
objectMetadataItems,
gqlField,
@ -39,7 +39,7 @@ export const mapFieldMetadataToGraphQLQuery = ({
const objectPermission = getObjectPermissionsForObject(
objectPermissionsByObjectMetadataId,
fieldMetadata.relationDefinition?.targetObjectMetadata.id,
fieldMetadata.relation?.targetObjectMetadata.id,
);
if (fieldIsNonCompositeField) {
@ -48,13 +48,12 @@ export const mapFieldMetadataToGraphQLQuery = ({
if (
fieldType === FieldMetadataType.RELATION &&
fieldMetadata.relationDefinition?.direction ===
RelationDefinitionType.MANY_TO_ONE
fieldMetadata.relation?.type === RelationType.MANY_TO_ONE
) {
const relationMetadataItem = objectMetadataItems.find(
(objectMetadataItem) =>
objectMetadataItem.id ===
fieldMetadata.relationDefinition?.targetObjectMetadata.id,
fieldMetadata.relation?.targetObjectMetadata.id,
);
if (isUndefined(relationMetadataItem)) {
@ -87,13 +86,12 @@ ${mapObjectMetadataToGraphQLQuery({
if (
fieldType === FieldMetadataType.RELATION &&
fieldMetadata.relationDefinition?.direction ===
RelationDefinitionType.ONE_TO_MANY
fieldMetadata.relation?.type === RelationType.ONE_TO_MANY
) {
const relationMetadataItem = objectMetadataItems.find(
(objectMetadataItem) =>
objectMetadataItem.id ===
fieldMetadata.relationDefinition?.targetObjectMetadata.id,
fieldMetadata.relation?.targetObjectMetadata.id,
);
if (isUndefined(relationMetadataItem)) {

9
packages/twenty-front/src/modules/object-metadata/utils/shouldFieldBeQueried.ts
View File

@ -3,6 +3,7 @@ import { ObjectRecord } from '@/object-record/types/ObjectRecord';
import { FieldMetadataType } from '~/generated-metadata/graphql';
import { isUndefinedOrNull } from '~/utils/isUndefinedOrNull';
import { isFieldRelation } from '@/object-record/record-field/types/guards/isFieldRelation';
import { isDefined } from 'twenty-shared/utils';
import { FieldMetadataItem } from '../types/FieldMetadataItem';
@ -12,13 +13,17 @@ export const shouldFieldBeQueried = ({
recordGqlFields,
}: {
gqlField: string;
fieldMetadata: Pick<FieldMetadataItem, 'name' | 'type'>;
fieldMetadata: Pick<FieldMetadataItem, 'name' | 'type' | 'settings'>;
objectRecord?: ObjectRecord;
recordGqlFields?: RecordGqlOperationGqlRecordFields;
}): any => {
const isJoinColumn: boolean =
isFieldRelation(fieldMetadata) &&
fieldMetadata.settings.joinColumnName === gqlField;
if (
isUndefinedOrNull(recordGqlFields) &&
fieldMetadata.type !== FieldMetadataType.RELATION
(fieldMetadata.type !== FieldMetadataType.RELATION || isJoinColumn)
) {
return true;
}

14
packages/twenty-front/src/modules/object-metadata/validation-schemas/fieldMetadataItemSchema.ts
View File

@ -2,12 +2,9 @@ import { z } from 'zod';
import { FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';
import { metadataLabelSchema } from '@/object-metadata/validation-schemas/metadataLabelSchema';
import {
FieldMetadataType,
RelationDefinitionType,
} from '~/generated-metadata/graphql';
import { camelCaseStringSchema } from '~/utils/validation-schemas/camelCaseStringSchema';
import { themeColorSchema } from 'twenty-ui/theme';
import { FieldMetadataType, RelationType } from '~/generated-metadata/graphql';
import { camelCaseStringSchema } from '~/utils/validation-schemas/camelCaseStringSchema';
export const fieldMetadataItemSchema = (existingLabels?: string[]) => {
return z.object({
@ -38,11 +35,10 @@ export const fieldMetadataItemSchema = (existingLabels?: string[]) => {
.nullable()
.optional(),
settings: z.any().optional(),
relationDefinition: z
relation: z
.object({
__typename: z.literal('RelationDefinition').optional(),
relationId: z.string().uuid(),
direction: z.nativeEnum(RelationDefinitionType),
__typename: z.literal('Relation').optional(),
type: z.nativeEnum(RelationType),
sourceFieldMetadata: z.object({
__typename: z.literal('Field').optional(),
id: z.string().uuid(),

1
packages/twenty-front/src/modules/object-metadata/validation-schemas/objectMetadataItemSchema.ts
View File

@ -15,6 +15,7 @@ export const objectMetadataItemSchema = z.object({
indexMetadatas: z.array(indexMetadataItemSchema),
icon: z.string().startsWith('Icon').trim(),
id: z.string().uuid(),
duplicateCriteria: z.array(z.array(z.string())),
imageIdentifierFieldMetadataId: z.string().uuid().nullable(),
isActive: z.boolean(),
isCustom: z.boolean(),