mukeshs/twenty_crm
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Deprecate FieldMetadataInterface (#13264)

Browse Source 
# Introduction

From the moment replaced the FieldMetadataInterface definition to:
```ts
import { FieldMetadataType } from 'twenty-shared/types';

import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';

export type FieldMetadataInterface<
  T extends FieldMetadataType = FieldMetadataType,
> = FieldMetadataEntity<T>;
```
After this PR merge will create a new one removing the type and
replacing it to `FieldMetadataEntity`.
Did not renamed it here to avoid conflicts on naming + type issues fixs
within the same PR

## Field metadata entity RELATION or MORPH
Relations fields cannot be null for those field metadata entity instance
anymore, but are never for the others see
`packages/twenty-server/src/engine/metadata-modules/field-metadata/types/field-metadata-entity-test.type.ts`
( introduced TypeScript tests )

## Concerns
- TS_VECTOR is the most at risk with the `generatedType` and
`asExpression` removal from interface

## What's next
- `FielMetadataInterface` removal and rename ( see introduction )
- Depcrecating `ObjectMetadataInterface`
- Refactor `FieldMetadataEntity` optional fiels to be nullable only
- TO DIG `never` occurences on settings, defaultValue etc
- Some interfaces will be replaced by the `FlatFieldMetadata` when
deprecating the current sync and comparators tools
This commit is contained in:
Paul Rastoin
2025-07-21 11:30:18 +02:00
committed by GitHub
parent c2a5f95675
commit 47b60bd49f
67 changed files with 1780 additions and 769 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
packages/twenty-server/src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto.ts
View File

@ -56,6 +56,7 @@ registerEnumType(FieldMetadataType, {
@Relation('object', () => ObjectMetadataDTO, {
nullable: true,
})
// TODO refactor nullable fields to be typed as nullable and not optional
export class FieldMetadataDTO<T extends FieldMetadataType = FieldMetadataType> {
@IsUUID()
@IsNotEmpty()
@ -132,7 +133,7 @@ export class FieldMetadataDTO<T extends FieldMetadataType = FieldMetadataType> {
// @Validate(IsFieldMetadataOptions)
@IsOptional()
@Field(() => GraphQLJSON, { nullable: true })
options?: FieldMetadataOptions<T>;
options?: FieldMetadataOptions<T> | null;
@IsOptional()
@Field(() => GraphQLJSON, { nullable: true })

54
packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.entity.ts
View File

@ -1,4 +1,4 @@
import { FieldMetadataType } from 'twenty-shared/types';
import { FieldMetadataType, IsExactly } from 'twenty-shared/types';
import {
Column,
CreateDateColumn,
@ -22,8 +22,16 @@ import { IndexFieldMetadataEntity } from 'src/engine/metadata-modules/index-meta
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { FieldPermissionEntity } from 'src/engine/metadata-modules/object-permission/field-permission/field-permission.entity';
type IsRelationType<Ttype, T extends FieldMetadataType = FieldMetadataType> =
IsExactly<T, FieldMetadataType> extends true
? null | Ttype
: T extends FieldMetadataType.RELATION
? Ttype
: T extends FieldMetadataType.MORPH_RELATION
? Ttype
: never;
@Entity('fieldMetadata')
// max length of index is 63 characters
@Index(
'IDX_FIELD_METADATA_NAME_OBJMID_WORKSPACE_ID_EXCEPT_MORPH_UNIQUE',
['name', 'objectMetadataId', 'workspaceId'],
@ -42,6 +50,7 @@ import { FieldPermissionEntity } from 'src/engine/metadata-modules/object-permis
'objectMetadataId',
'workspaceId',
])
// TODO add some documentation about this entity
export class FieldMetadataEntity<
T extends FieldMetadataType = FieldMetadataType,
> {
@ -56,6 +65,7 @@ export class FieldMetadataEntity<
@ManyToOne(() => ObjectMetadataEntity, (object) => object.fields, {
onDelete: 'CASCADE',
nullable: false,
})
@JoinColumn({ name: 'objectMetadataId' })
@Index('IDX_FIELD_METADATA_OBJECT_METADATA_ID', ['objectMetadataId'])
@ -74,22 +84,22 @@ export class FieldMetadataEntity<
label: string;
@Column({ nullable: true, type: 'jsonb' })
defaultValue: FieldMetadataDefaultValue<T>;
defaultValue: FieldMetadataDefaultValue<T> | null;
@Column({ nullable: true, type: 'text' })
description: string;
description: string | null;
@Column({ nullable: true })
icon: string;
@Column({ nullable: true, type: 'varchar' })
icon: string | null;
@Column({ type: 'jsonb', nullable: true })
standardOverrides?: FieldStandardOverridesDTO;
standardOverrides?: FieldStandardOverridesDTO | null;
@Column('jsonb', { nullable: true })
options: FieldMetadataOptions<T>;
options: FieldMetadataOptions<T> | null;
@Column('jsonb', { nullable: true })
settings?: FieldMetadataSettings<T>;
settings?: FieldMetadataSettings<T> | null;
@Column({ default: false })
isCustom: boolean;
@ -100,11 +110,13 @@ export class FieldMetadataEntity<
@Column({ default: false })
isSystem: boolean;
@Column({ nullable: true, default: true })
isNullable: boolean;
// Is this really nullable ?
@Column({ nullable: true, default: true, type: 'boolean' })
isNullable: boolean | null;
@Column({ nullable: true, default: false })
isUnique: boolean;
// Is this really nullable ?
@Column({ nullable: true, default: false, type: 'boolean' })
isUnique: boolean | null;
@Column({ nullable: false, type: 'uuid' })
@Index('IDX_FIELD_METADATA_WORKSPACE_ID', ['workspaceId'])
@ -114,25 +126,31 @@ export class FieldMetadataEntity<
isLabelSyncedWithName: boolean;
@Column({ nullable: true, type: 'uuid' })
relationTargetFieldMetadataId: string;
relationTargetFieldMetadataId: IsRelationType<string, T>;
@OneToOne(
() => FieldMetadataEntity,
(fieldMetadata: FieldMetadataEntity) =>
fieldMetadata.relationTargetFieldMetadataId,
{ nullable: true },
)
@JoinColumn({ name: 'relationTargetFieldMetadataId' })
relationTargetFieldMetadata: Relation<FieldMetadataEntity>;
relationTargetFieldMetadata: IsRelationType<Relation<FieldMetadataEntity>, T>;
@Column({ nullable: true, type: 'uuid' })
relationTargetObjectMetadataId: string;
relationTargetObjectMetadataId: IsRelationType<string, T>;
@ManyToOne(
() => ObjectMetadataEntity,
(objectMetadata: ObjectMetadataEntity) =>
objectMetadata.targetRelationFields,
{ onDelete: 'CASCADE' },
{ onDelete: 'CASCADE', nullable: true },
)
@JoinColumn({ name: 'relationTargetObjectMetadataId' })
relationTargetObjectMetadata: Relation<ObjectMetadataEntity>;
relationTargetObjectMetadata: IsRelationType<
Relation<ObjectMetadataEntity>,
T
>;
@OneToMany(
() => IndexFieldMetadataEntity,

19
packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.resolver.ts
View File

@ -39,6 +39,7 @@ import {
import { BeforeUpdateOneField } from 'src/engine/metadata-modules/field-metadata/hooks/before-update-one-field.hook';
import { FieldMetadataService } from 'src/engine/metadata-modules/field-metadata/services/field-metadata.service';
import { fieldMetadataGraphqlApiExceptionHandler } from 'src/engine/metadata-modules/field-metadata/utils/field-metadata-graphql-api-exception-handler.util';
import { fromFieldMetadataEntityToFieldMetadataDto } from 'src/engine/metadata-modules/field-metadata/utils/from-field-metadata-entity-to-fieldMetadata-dto.util';
import { SettingPermissionType } from 'src/engine/metadata-modules/permissions/constants/setting-permission-type.constants';
import { PermissionsGraphqlApiExceptionFilter } from 'src/engine/metadata-modules/permissions/utils/permissions-graphql-api-exception.filter';
import { isMorphRelationFieldMetadataType } from 'src/engine/utils/is-morph-relation-field-metadata-type.util';
@ -152,7 +153,7 @@ export class FieldMetadataResolver {
workspaceId: workspace.id,
});
if (!fieldMetadata.settings) {
if (!isDefined(fieldMetadata.settings)) {
throw new FieldMetadataException(
'Relation settings are required',
FieldMetadataExceptionCode.FIELD_METADATA_RELATION_MALFORMED,
@ -163,8 +164,10 @@ export class FieldMetadataResolver {
type: fieldMetadata.settings.relationType,
sourceObjectMetadata,
targetObjectMetadata,
sourceFieldMetadata,
targetFieldMetadata,
sourceFieldMetadata:
fromFieldMetadataEntityToFieldMetadataDto(sourceFieldMetadata),
targetFieldMetadata:
fromFieldMetadataEntityToFieldMetadataDto(targetFieldMetadata),
};
} catch (error) {
fieldMetadataGraphqlApiExceptionHandler(error);
@ -198,12 +201,16 @@ export class FieldMetadataResolver {
);
}
return morphRelations.map((morphRelation) => ({
return morphRelations.map<RelationDTO>((morphRelation) => ({
type: settings.relationType,
sourceObjectMetadata: morphRelation.sourceObjectMetadata,
targetObjectMetadata: morphRelation.targetObjectMetadata,
sourceFieldMetadata: morphRelation.sourceFieldMetadata,
targetFieldMetadata: morphRelation.targetFieldMetadata,
sourceFieldMetadata: fromFieldMetadataEntityToFieldMetadataDto(
morphRelation.sourceFieldMetadata,
),
targetFieldMetadata: fromFieldMetadataEntityToFieldMetadataDto(
morphRelation.targetFieldMetadata,
),
}));
} catch (error) {
fieldMetadataGraphqlApiExceptionHandler(error);

76
packages/twenty-server/src/engine/metadata-modules/field-metadata/hooks/__tests__/before-update-one-field.hook.spec.ts
View File

@ -2,6 +2,7 @@ import { Test, TestingModule } from '@nestjs/testing';
import { i18n } from '@lingui/core';
import { UpdateOneInputType } from '@ptc-org/nestjs-query-graphql';
import { FieldMetadataType } from 'twenty-shared/types';
import {
ForbiddenError,
@ -11,6 +12,7 @@ import { UpdateFieldInput } from 'src/engine/metadata-modules/field-metadata/dto
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { BeforeUpdateOneField } from 'src/engine/metadata-modules/field-metadata/hooks/before-update-one-field.hook';
import { FieldMetadataService } from 'src/engine/metadata-modules/field-metadata/services/field-metadata.service';
import { getMockFieldMetadataEntity } from 'src/utils/__test__/get-field-metadata-entity.mock';
jest.mock('@lingui/core', () => ({
i18n: {
@ -96,14 +98,23 @@ describe('BeforeUpdateOneField', () => {
},
};
const mockField: Partial<FieldMetadataEntity> = {
const mockField = getMockFieldMetadataEntity({
workspaceId: mockWorkspaceId,
objectMetadataId: '20202020-0000-0000-0000-000000000002',
id: mockFieldId,
type: FieldMetadataType.TEXT,
name: 'oldName',
label: 'Old Name',
isNullable: true,
isCustom: true,
};
isLabelSyncedWithName: true,
createdAt: new Date(),
updatedAt: new Date(),
}) as FieldMetadataEntity;
jest
.spyOn(fieldMetadataService, 'findOneWithinWorkspace')
.mockResolvedValue(mockField as FieldMetadataEntity);
.mockResolvedValue(mockField);
const result = await hook.run(
instance as UpdateOneInputType<UpdateFieldInput>,
@ -124,14 +135,23 @@ describe('BeforeUpdateOneField', () => {
},
};
const mockField: Partial<FieldMetadataEntity> = {
const mockField = getMockFieldMetadataEntity({
workspaceId: mockWorkspaceId,
objectMetadataId: '20202020-0000-0000-0000-000000000002',
id: mockFieldId,
type: FieldMetadataType.TEXT,
name: 'oldName',
label: 'Old Name',
isNullable: true,
isCustom: false,
};
isLabelSyncedWithName: true,
createdAt: new Date(),
updatedAt: new Date(),
}) as FieldMetadataEntity;
jest
.spyOn(fieldMetadataService, 'findOneWithinWorkspace')
.mockResolvedValue(mockField as FieldMetadataEntity);
.mockResolvedValue(mockField);
await expect(
hook.run(instance as UpdateOneInputType<UpdateFieldInput>, {
@ -149,15 +169,24 @@ describe('BeforeUpdateOneField', () => {
},
};
const mockField: Partial<FieldMetadataEntity> = {
const mockField = getMockFieldMetadataEntity({
workspaceId: mockWorkspaceId,
objectMetadataId: '20202020-0000-0000-0000-000000000002',
id: mockFieldId,
type: FieldMetadataType.TEXT,
name: 'oldName',
label: 'Old Name',
isNullable: true,
isCustom: false,
isActive: true,
};
isLabelSyncedWithName: true,
createdAt: new Date(),
updatedAt: new Date(),
}) as FieldMetadataEntity;
jest
.spyOn(fieldMetadataService, 'findOneWithinWorkspace')
.mockResolvedValue(mockField as FieldMetadataEntity);
.mockResolvedValue(mockField);
const result = await hook.run(
instance as UpdateOneInputType<UpdateFieldInput>,
@ -186,18 +215,26 @@ describe('BeforeUpdateOneField', () => {
},
};
const mockField: Partial<FieldMetadataEntity> = {
const mockField = getMockFieldMetadataEntity({
workspaceId: mockWorkspaceId,
objectMetadataId: '20202020-0000-0000-0000-000000000002',
id: mockFieldId,
type: FieldMetadataType.TEXT,
name: 'oldName',
label: 'Old Name',
isNullable: true,
isCustom: false,
isLabelSyncedWithName: false,
standardOverrides: {
label: 'Custom Label',
},
};
createdAt: new Date(),
updatedAt: new Date(),
}) as FieldMetadataEntity;
jest
.spyOn(fieldMetadataService, 'findOneWithinWorkspace')
.mockResolvedValue(mockField as FieldMetadataEntity);
.mockResolvedValue(mockField);
const result = await hook.run(
instance as UpdateOneInputType<UpdateFieldInput>,
@ -228,16 +265,23 @@ describe('BeforeUpdateOneField', () => {
},
};
const mockField: Partial<FieldMetadataEntity> = {
const mockField = getMockFieldMetadataEntity({
workspaceId: mockWorkspaceId,
objectMetadataId: '20202020-0000-0000-0000-000000000002',
id: mockFieldId,
type: FieldMetadataType.TEXT,
name: 'oldName',
label: 'Default Label',
isNullable: true,
isCustom: false,
isLabelSyncedWithName: false,
label: 'Default Label',
};
createdAt: new Date(),
updatedAt: new Date(),
}) as FieldMetadataEntity;
jest
.spyOn(fieldMetadataService, 'findOneWithinWorkspace')
.mockResolvedValue(mockField as FieldMetadataEntity);
.mockResolvedValue(mockField);
const result = await hook.run(
instance as UpdateOneInputType<UpdateFieldInput>,

6
packages/twenty-server/src/engine/metadata-modules/field-metadata/hooks/before-update-one-field.hook.ts
View File

@ -207,7 +207,7 @@ export class BeforeUpdateOneField<T extends UpdateFieldInput>
update: StandardFieldUpdate;
overrideKey: 'label' | 'description' | 'icon';
newValue: string;
originalValue: string;
originalValue: string | null;
locale?: keyof typeof APP_LOCALES | undefined;
}): boolean {
// Handle localized overrides
@ -238,7 +238,7 @@ export class BeforeUpdateOneField<T extends UpdateFieldInput>
update: StandardFieldUpdate,
overrideKey: 'label' | 'description' | 'icon',
newValue: string,
originalValue: string,
originalValue: string | null,
locale: keyof typeof APP_LOCALES,
): boolean {
const messageId = generateMessageId(originalValue ?? '');
@ -268,7 +268,7 @@ export class BeforeUpdateOneField<T extends UpdateFieldInput>
update: StandardFieldUpdate,
overrideKey: 'label' | 'description' | 'icon',
newValue: string,
originalValue: string,
originalValue: string | null,
): boolean {
if (newValue !== originalValue) {
return false;

38
packages/twenty-server/src/engine/metadata-modules/field-metadata/interfaces/field-metadata.interface.ts
View File

@ -1,39 +1,7 @@
import { FieldMetadataType } from 'twenty-shared/types';
import { FieldMetadataDefaultValue } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata-default-value.interface';
import { FieldMetadataOptions } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata-options.interface';
import { FieldMetadataSettings } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata-settings.interface';
import { ObjectMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/object-metadata.interface';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { RelationDTO } from 'src/engine/metadata-modules/field-metadata/dtos/relation.dto';
export interface FieldMetadataInterface<
export type FieldMetadataInterface<
T extends FieldMetadataType = FieldMetadataType,
> {
id: string;
type: T;
name: string;
label: string;
defaultValue?: FieldMetadataDefaultValue<T>;
options?: FieldMetadataOptions<T>;
settings?: FieldMetadataSettings<T>;
objectMetadataId: string;
workspaceId?: string;
description?: string;
icon?: string;
isNullable: boolean;
isUnique?: boolean;
relationTargetFieldMetadataId?: string;
relationTargetFieldMetadata?: FieldMetadataInterface;
relationTargetObjectMetadataId?: string;
relationTargetObjectMetadata?: ObjectMetadataInterface;
relation?: RelationDTO;
isCustom?: boolean;
isSystem?: boolean;
isActive?: boolean;
generatedType?: 'STORED' | 'VIRTUAL';
asExpression?: string;
isLabelSyncedWithName: boolean;
createdAt: Date;
updatedAt: Date;
}
> = FieldMetadataEntity<T>;

27
packages/twenty-server/src/engine/metadata-modules/field-metadata/services/field-metadata-related-records.service.ts
View File

@ -57,8 +57,8 @@ export class FieldMetadataRelatedRecordsService {
);
const { created, updated, deleted } = this.getOptionsDifferences(
oldFieldMetadata.options,
newFieldMetadata.options,
oldFieldMetadata.options ?? [],
newFieldMetadata.options ?? [],
);
const viewGroupRepository =
@ -175,9 +175,15 @@ export class FieldMetadataRelatedRecordsService {
}
const viewFilterOptions = viewFilterValue
.map((value) =>
oldFieldMetadata.options.find((option) => option.value === value),
)
.map((value) => {
if (!isDefined(oldFieldMetadata.options)) {
return undefined;
}
return oldFieldMetadata.options.find(
(option) => option.value === value,
);
})
.filter(isDefined);
const afterDeleteViewFilterOptions = viewFilterOptions.filter(
@ -247,8 +253,12 @@ export class FieldMetadataRelatedRecordsService {
}
public getOptionsDifferences(
oldOptions: (FieldMetadataDefaultOption | FieldMetadataComplexOption)[],
newOptions: (FieldMetadataDefaultOption | FieldMetadataComplexOption)[],
rawOldOptions:
| (FieldMetadataDefaultOption | FieldMetadataComplexOption)[]
| null,
rawNewOptions:
| (FieldMetadataDefaultOption | FieldMetadataComplexOption)[]
| null,
compareLabel = false,
): GetOptionsDifferences {
const differences: Differences<
@ -259,6 +269,9 @@ export class FieldMetadataRelatedRecordsService {
deleted: [],
};
const oldOptions = rawOldOptions ?? [];
const newOptions = rawNewOptions ?? [];
const oldOptionsMap = new Map(oldOptions.map((opt) => [opt.id, opt]));
for (const newOption of newOptions) {

1
packages/twenty-server/src/engine/metadata-modules/field-metadata/services/field-metadata-relation.service.ts
View File

@ -91,6 +91,7 @@ export class FieldMetadataRelationService {
label: relationCreationPayload.targetFieldLabel,
icon: relationCreationPayload.targetFieldIcon,
workspaceId: fieldMetadataInput.workspaceId,
defaultValue: fieldMetadataInput.defaultValue,
});
const targetFieldMetadataToCreateWithRelation =

5
packages/twenty-server/src/engine/metadata-modules/field-metadata/services/field-metadata.service.ts
View File

@ -39,6 +39,7 @@ import { isCompositeFieldMetadataType } from 'src/engine/metadata-modules/field-
import { isSelectOrMultiSelectFieldMetadata } from 'src/engine/metadata-modules/field-metadata/utils/is-select-or-multi-select-field-metadata.util';
import { prepareCustomFieldMetadataOptions } from 'src/engine/metadata-modules/field-metadata/utils/prepare-custom-field-metadata-for-options.util';
import { prepareCustomFieldMetadataForCreation } from 'src/engine/metadata-modules/field-metadata/utils/prepare-field-metadata-for-creation.util';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { assertMutationNotOnRemoteObject } from 'src/engine/metadata-modules/object-metadata/utils/assert-mutation-not-on-remote-object.util';
import { ObjectMetadataItemWithFieldMaps } from 'src/engine/metadata-modules/types/object-metadata-item-with-field-maps';
import { ObjectMetadataMaps } from 'src/engine/metadata-modules/types/object-metadata-maps';
@ -190,8 +191,8 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
const fieldMetadataForUpdate = {
...updatableFieldInput,
defaultValue: defaultValueForUpdate,
...optionsForUpdate,
defaultValue: defaultValueForUpdate,
};
await this.fieldMetadataValidationService.validateFieldMetadata({
@ -379,7 +380,7 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
name: isManyToOneRelation
? computeObjectTargetTable(fieldMetadata.object)
: computeObjectTargetTable(
fieldMetadata.relationTargetObjectMetadata,
fieldMetadata.relationTargetObjectMetadata as ObjectMetadataEntity,
),
action: WorkspaceMigrationTableActionType.ALTER,
columns: [

90
packages/twenty-server/src/engine/metadata-modules/field-metadata/types/field-metadata-entity-test.type.ts Normal file
View File

@ -0,0 +1,90 @@
import { Expect, HasAllProperties } from 'twenty-shared/testing';
import { FieldMetadataType } from 'twenty-shared/types';
import { Relation as TypeOrmRelation } from 'typeorm';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
type DefinedRelationRecord = {
relationTargetFieldMetadataId: string;
relationTargetFieldMetadata: TypeOrmRelation<FieldMetadataEntity>;
relationTargetObjectMetadataId: string;
relationTargetObjectMetadata: TypeOrmRelation<ObjectMetadataEntity>;
};
type NotDefinedRelationRecord = {
relationTargetFieldMetadataId: never;
relationTargetFieldMetadata: never;
relationTargetObjectMetadataId: never;
relationTargetObjectMetadata: never;
};
type UUIDFieldMetadata = FieldMetadataEntity<FieldMetadataType.UUID>;
type TextFieldMetadata = FieldMetadataEntity<FieldMetadataType.TEXT>;
type NumberFieldMetadata = FieldMetadataEntity<FieldMetadataType.NUMBER>;
type BooleanFieldMetadata = FieldMetadataEntity<FieldMetadataType.BOOLEAN>;
type DateFieldMetadata = FieldMetadataEntity<FieldMetadataType.DATE>;
type DateTimeFieldMetadata = FieldMetadataEntity<FieldMetadataType.DATE_TIME>;
type CurrencyFieldMetadata = FieldMetadataEntity<FieldMetadataType.CURRENCY>;
type FullNameFieldMetadata = FieldMetadataEntity<FieldMetadataType.FULL_NAME>;
type RatingFieldMetadata = FieldMetadataEntity<FieldMetadataType.RATING>;
type SelectFieldMetadata = FieldMetadataEntity<FieldMetadataType.SELECT>;
type MultiSelectFieldMetadata =
FieldMetadataEntity<FieldMetadataType.MULTI_SELECT>;
type PositionFieldMetadata = FieldMetadataEntity<FieldMetadataType.POSITION>;
type RawJsonFieldMetadata = FieldMetadataEntity<FieldMetadataType.RAW_JSON>;
type RichTextFieldMetadata = FieldMetadataEntity<FieldMetadataType.RICH_TEXT>;
type ActorFieldMetadata = FieldMetadataEntity<FieldMetadataType.ACTOR>;
type ArrayFieldMetadata = FieldMetadataEntity<FieldMetadataType.ARRAY>;
type PhonesFieldMetadata = FieldMetadataEntity<FieldMetadataType.PHONES>;
type EmailsFieldMetadata = FieldMetadataEntity<FieldMetadataType.EMAILS>;
type LinksFieldMetadata = FieldMetadataEntity<FieldMetadataType.LINKS>;
type RelationFieldMetadata = FieldMetadataEntity<FieldMetadataType.RELATION>;
type MorphRelationFieldMetadata =
FieldMetadataEntity<FieldMetadataType.MORPH_RELATION>;
// eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
type Assertions = [
Expect<HasAllProperties<UUIDFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<TextFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<NumberFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<BooleanFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<DateFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<DateTimeFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<CurrencyFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<FullNameFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<RatingFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<SelectFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<MultiSelectFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<PositionFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<RawJsonFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<RichTextFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<ActorFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<ArrayFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<PhonesFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<EmailsFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<LinksFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<RelationFieldMetadata, DefinedRelationRecord>>,
Expect<HasAllProperties<MorphRelationFieldMetadata, DefinedRelationRecord>>,
];

2
packages/twenty-server/src/engine/metadata-modules/field-metadata/utils/assert-does-not-nullify-default-value-for-non-nullable-field.util.ts
View File

@ -7,7 +7,7 @@ export const assertDoesNotNullifyDefaultValueForNonNullableField = ({
isNullable,
defaultValueFromUpdate,
}: {
isNullable: boolean;
isNullable: boolean | null;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
defaultValueFromUpdate?: any;
}) => {

31
packages/twenty-server/src/engine/metadata-modules/field-metadata/utils/from-field-metadata-entity-to-fieldMetadata-dto.util.ts Normal file
View File

@ -0,0 +1,31 @@
import { FieldMetadataDTO } from 'src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
export const fromFieldMetadataEntityToFieldMetadataDto = (
fieldMetadataEntity: FieldMetadataEntity,
): FieldMetadataDTO => {
const {
createdAt,
updatedAt,
description,
icon,
standardOverrides,
isNullable,
isUnique,
settings,
...rest
} = fieldMetadataEntity;
return {
...rest,
// Should we ? seems to be typed a dateString from classValidator, should be typed as string in TypeScript ?
createdAt: new Date(createdAt),
updatedAt: new Date(updatedAt),
description: description ?? undefined,
icon: icon ?? undefined,
standardOverrides: standardOverrides ?? undefined,
isNullable: isNullable ?? false,
isUnique: isUnique ?? false,
settings: settings ?? undefined,
};
};

3
packages/twenty-server/src/engine/metadata-modules/field-metadata/utils/is-select-or-multi-select-field-metadata.util.ts
View File

@ -9,7 +9,8 @@ export type SelectOrMultiSelectFieldMetadataEntity = FieldMetadataEntity<
>;
export const isSelectOrMultiSelectFieldMetadata = (
fieldMetadata: FieldMetadataInterface,
): fieldMetadata is SelectOrMultiSelectFieldMetadataEntity => {
): fieldMetadata is FieldMetadataInterface &
SelectOrMultiSelectFieldMetadataEntity => {
return [FieldMetadataType.SELECT, FieldMetadataType.MULTI_SELECT].includes(
fieldMetadata.type,
);

14
packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.service.ts
View File

@ -11,6 +11,7 @@ import {
QueryRunner,
Repository,
} from 'typeorm';
import { FieldMetadataType } from 'twenty-shared/types';
import { DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
@ -46,6 +47,7 @@ import { WorkspaceDataSourceService } from 'src/engine/workspace-datasource/work
import { WorkspaceMigrationRunnerService } from 'src/engine/workspace-manager/workspace-migration-runner/workspace-migration-runner.service';
import { CUSTOM_OBJECT_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
import { isSearchableFieldType } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/is-searchable-field.util';
import { isFieldMetadataEntityOfType } from 'src/engine/utils/is-field-metadata-of-type.util';
import { ObjectMetadataEntity } from './object-metadata.entity';
@ -471,9 +473,15 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
);
const fieldMetadataIds = objectMetadata.fields.map((field) => field.id);
const relationMetadataIds = objectMetadata.fields
.map((field) => field.relationTargetFieldMetadata?.id)
.filter(isDefined);
const relationMetadataIds = objectMetadata.fields.flatMap((field) => {
if (
isFieldMetadataEntityOfType(field, FieldMetadataType.MORPH_RELATION)
) {
return field.relationTargetFieldMetadata.id;
}
return [];
});
await fieldMetadataRepository.delete({
id: In(fieldMetadataIds.concat(relationMetadataIds)),

16
packages/twenty-server/src/engine/metadata-modules/object-permission/field-permission/__tests__/field-permissions.service.spec.ts
View File

@ -4,12 +4,11 @@ import { getRepositoryToken } from '@nestjs/typeorm';
import { ObjectRecordsPermissionsByRoleId } from 'twenty-shared/types';
import { In, Repository } from 'typeorm';
import { FieldMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata.interface';
import {
fieldTextMock,
objectMetadataItemMock,
} from 'src/engine/api/__mocks__/object-metadata-item.mock';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { UpsertFieldPermissionsInput } from 'src/engine/metadata-modules/object-permission/dtos/upsert-field-permissions.input';
import { FieldPermissionEntity } from 'src/engine/metadata-modules/object-permission/field-permission/field-permission.entity';
import { FieldPermissionService } from 'src/engine/metadata-modules/object-permission/field-permission/field-permission.service';
@ -21,6 +20,7 @@ import {
import { RoleEntity } from 'src/engine/metadata-modules/role/role.entity';
import { WorkspacePermissionsCacheService } from 'src/engine/metadata-modules/workspace-permissions-cache/workspace-permissions-cache.service';
import { WorkspaceCacheStorageService } from 'src/engine/workspace-cache-storage/workspace-cache-storage.service';
import { getMockFieldMetadataEntity } from 'src/utils/__test__/get-field-metadata-entity.mock';
describe('FieldPermissionService', () => {
let service: FieldPermissionService;
@ -31,9 +31,9 @@ describe('FieldPermissionService', () => {
let workspacePermissionsCacheService: jest.Mocked<WorkspacePermissionsCacheService>;
let workspaceCacheStorageService: jest.Mocked<WorkspaceCacheStorageService>;
const testWorkspaceId = 'test-workspace-id';
const testRoleId = 'test-role-id';
const testObjectMetadataId = 'test-object-metadata-id';
const testWorkspaceId = '20202020-0000-0000-0000-000000000000';
const testRoleId = '20202020-0000-0000-0000-000000000001';
const testObjectMetadataId = '20202020-0000-0000-0000-000000000002';
const testFieldMetadataId = fieldTextMock.id;
const mockRole: RoleEntity = {
@ -121,11 +121,13 @@ describe('FieldPermissionService', () => {
[testObjectMetadataId]: {
...objectMetadataItemMock,
fieldsById: {
[fieldTextMock.id]: {
[fieldTextMock.id]: getMockFieldMetadataEntity({
...fieldTextMock,
label: 'Test Field',
objectMetadataId: testObjectMetadataId,
} as FieldMetadataInterface,
workspaceId: testWorkspaceId,
id: '20202020-0000-0000-0000-000000000003',
}) as FieldMetadataEntity,
},
fieldIdByJoinColumnName: {},
fieldIdByName: {},

27
packages/twenty-server/src/engine/metadata-modules/search-vector/search-vector.service.ts
View File

@ -5,8 +5,6 @@ import { FieldMetadataType } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { QueryRunner, Repository } from 'typeorm';
import { FieldMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata.interface';
import { SEARCH_VECTOR_FIELD } from 'src/engine/metadata-modules/constants/search-vector-field.constants';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { IndexMetadataService } from 'src/engine/metadata-modules/index-metadata/index-metadata.service';
@ -14,7 +12,10 @@ import { IndexType } from 'src/engine/metadata-modules/index-metadata/types/inde
import { CreateObjectInput } from 'src/engine/metadata-modules/object-metadata/dtos/create-object.input';
import { DEFAULT_LABEL_IDENTIFIER_FIELD_NAME } from 'src/engine/metadata-modules/object-metadata/object-metadata.constants';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { TsVectorColumnActionFactory } from 'src/engine/metadata-modules/workspace-migration/factories/ts-vector-column-action.factory';
import {
TsVectorColumnActionFactory,
TsVectorFieldMetadata,
} from 'src/engine/metadata-modules/workspace-migration/factories/ts-vector-column-action.factory';
import { generateMigrationName } from 'src/engine/metadata-modules/workspace-migration/utils/generate-migration-name.util';
import {
WorkspaceMigrationColumnActionType,
@ -23,6 +24,7 @@ import {
import { WorkspaceMigrationFactory } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.factory';
import { WorkspaceMigrationService } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.service';
import { computeTableName } from 'src/engine/utils/compute-table-name.util';
import { isFieldMetadataEntityOfType } from 'src/engine/utils/is-field-metadata-of-type.util';
import { CUSTOM_OBJECT_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
import {
FieldTypeAndNameMetadata,
@ -66,6 +68,17 @@ export class SearchVectorService {
isNullable: true,
});
if (
!isFieldMetadataEntityOfType(
searchVectorFieldMetadata,
FieldMetadataType.TS_VECTOR,
)
) {
throw new Error(
'Should never occur, created searchVectorFieldMetadata is not a TS_VECTOR field',
);
}
const searchableFieldForCustomObject =
createdObjectMetadata.labelIdentifierFieldMetadataId
? createdObjectMetadata.fields.find(
@ -94,7 +107,6 @@ export class SearchVectorService {
action: WorkspaceMigrationTableActionType.ALTER,
columns: this.tsVectorColumnActionFactory.handleCreateAction({
...searchVectorFieldMetadata,
defaultValue: undefined,
generatedType: 'STORED',
asExpression: getTsVectorColumnExpressionFromFields([
{
@ -102,8 +114,7 @@ export class SearchVectorService {
name: searchableFieldForCustomObject.name,
},
]),
options: undefined,
} as FieldMetadataInterface<FieldMetadataType.TS_VECTOR>),
}),
},
],
queryRunner,
@ -159,8 +170,8 @@ export class SearchVectorService {
fieldMetadataNameAndTypeForSearch,
),
generatedType: 'STORED', // Not stored on fieldMetadata
options: undefined,
},
options: null,
} as TsVectorFieldMetadata,
),
},
],

2
packages/twenty-server/src/engine/metadata-modules/workspace-migration/factories/composite-column-action.factory.ts
View File

@ -72,7 +72,7 @@ export class CompositeColumnActionFactory extends ColumnActionAbstractFactory<Co
columnType: fieldMetadataTypeToColumnType(property.type),
enum: enumOptions,
isNullable: fieldMetadata.isNullable || !property.isRequired,
isUnique: fieldMetadata.isUnique,
isUnique: fieldMetadata.isUnique ?? undefined,
defaultValue: serializedDefaultValue,
isArray:
property.type === FieldMetadataType.MULTI_SELECT || property.isArray,

13
packages/twenty-server/src/engine/metadata-modules/workspace-migration/factories/ts-vector-column-action.factory.ts
View File

@ -13,14 +13,19 @@ import {
WorkspaceMigrationColumnCreate,
} from 'src/engine/metadata-modules/workspace-migration/workspace-migration.entity';
export type TsVectorFieldMetadataType = FieldMetadataType.TS_VECTOR;
export type TsVectorFieldMetadata =
FieldMetadataInterface<FieldMetadataType.TS_VECTOR> & {
generatedType?: 'STORED' | 'VIRTUAL';
asExpression?: string;
};
export type TsVectorFieldMetadataType = FieldMetadataType.TS_VECTOR;
@Injectable()
export class TsVectorColumnActionFactory extends ColumnActionAbstractFactory<TsVectorFieldMetadataType> {
protected readonly logger = new Logger(TsVectorColumnActionFactory.name);
handleCreateAction(
fieldMetadata: FieldMetadataInterface<TsVectorFieldMetadataType>,
fieldMetadata: TsVectorFieldMetadata,
): WorkspaceMigrationColumnCreate[] {
return [
{
@ -37,8 +42,8 @@ export class TsVectorColumnActionFactory extends ColumnActionAbstractFactory<TsV
}
handleAlterAction(
currentFieldMetadata: FieldMetadataInterface<TsVectorFieldMetadataType>,
alteredFieldMetadata: FieldMetadataInterface<TsVectorFieldMetadataType>,
currentFieldMetadata: TsVectorFieldMetadata,
alteredFieldMetadata: TsVectorFieldMetadata,
): WorkspaceMigrationColumnAlter[] {
return [
{

15
packages/twenty-server/src/engine/metadata-modules/workspace-migration/workspace-migration.factory.ts
View File

@ -11,7 +11,10 @@ import { CompositeColumnActionFactory } from 'src/engine/metadata-modules/worksp
import { EnumColumnActionFactory } from 'src/engine/metadata-modules/workspace-migration/factories/enum-column-action.factory';
import { MorphRelationColumnActionFactory } from 'src/engine/metadata-modules/workspace-migration/factories/morph-relation-column-action.factory';
import { RelationColumnActionFactory } from 'src/engine/metadata-modules/workspace-migration/factories/relation-column-action.factory';
import { TsVectorColumnActionFactory } from 'src/engine/metadata-modules/workspace-migration/factories/ts-vector-column-action.factory';
import {
TsVectorColumnActionFactory,
TsVectorFieldMetadata,
} from 'src/engine/metadata-modules/workspace-migration/factories/ts-vector-column-action.factory';
import {
WorkspaceMigrationColumnAction,
WorkspaceMigrationColumnActionType,
@ -115,9 +118,9 @@ export class WorkspaceMigrationFactory {
]);
}
createColumnActions(
createColumnActions<T extends FieldMetadataType = FieldMetadataType>(
action: WorkspaceMigrationColumnActionType.CREATE,
fieldMetadata: FieldMetadataInterface,
fieldMetadata: FieldMetadataInterface<T>,
): WorkspaceMigrationColumnAction[];
createColumnActions(
@ -126,6 +129,12 @@ export class WorkspaceMigrationFactory {
alteredFieldMetadata: FieldMetadataInterface,
): WorkspaceMigrationColumnAction[];
createColumnActions(
action: WorkspaceMigrationColumnActionType.ALTER,
currentFieldMetadata: FieldMetadataInterface,
alteredFieldMetadata: TsVectorFieldMetadata,
): WorkspaceMigrationColumnAction[];
createColumnActions(
action:
| WorkspaceMigrationColumnActionType.CREATE