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
@ -2,6 +2,9 @@ import { Field, InputType, OmitType } from '@nestjs/graphql';
|
||||
|
||||
import { Type } from 'class-transformer';
|
||||
import { IsOptional, IsUUID, ValidateNested } from 'class-validator';
|
||||
import GraphQLJSON from 'graphql-type-json';
|
||||
|
||||
import { RelationType } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-type.interface';
|
||||
|
||||
import { FieldMetadataDTO } from 'src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto';
|
||||
|
||||
@ -18,6 +21,15 @@ export class CreateFieldInput extends OmitType(
|
||||
@Field(() => Boolean, { nullable: true })
|
||||
@IsOptional()
|
||||
isRemoteCreation?: boolean;
|
||||
|
||||
@IsOptional()
|
||||
@Field(() => GraphQLJSON, { nullable: true })
|
||||
relationCreationPayload?: {
|
||||
targetObjectMetadataId: string;
|
||||
targetFieldLabel: string;
|
||||
targetFieldIcon: string;
|
||||
type: RelationType;
|
||||
};
|
||||
}
|
||||
|
||||
@InputType()
|
||||
|
||||
@ -37,7 +37,6 @@ import { FieldMetadataDefaultOption } from 'src/engine/metadata-modules/field-me
|
||||
import { IsFieldMetadataDefaultValue } from 'src/engine/metadata-modules/field-metadata/validators/is-field-metadata-default-value.validator';
|
||||
import { IsFieldMetadataOptions } from 'src/engine/metadata-modules/field-metadata/validators/is-field-metadata-options.validator';
|
||||
import { ObjectMetadataDTO } from 'src/engine/metadata-modules/object-metadata/dtos/object-metadata.dto';
|
||||
import { RelationMetadataDTO } from 'src/engine/metadata-modules/relation-metadata/dtos/relation-metadata.dto';
|
||||
import { transformEnumValue } from 'src/engine/utils/transform-enum-value';
|
||||
|
||||
registerEnumType(FieldMetadataType, {
|
||||
@ -57,12 +56,6 @@ registerEnumType(FieldMetadataType, {
|
||||
disableSort: true,
|
||||
maxResultsSize: 1000,
|
||||
})
|
||||
@Relation('toRelationMetadata', () => RelationMetadataDTO, {
|
||||
nullable: true,
|
||||
})
|
||||
@Relation('fromRelationMetadata', () => RelationMetadataDTO, {
|
||||
nullable: true,
|
||||
})
|
||||
@Relation('object', () => ObjectMetadataDTO, {
|
||||
nullable: true,
|
||||
})
|
||||
|
||||
@ -1,50 +0,0 @@
|
||||
import { Field, ObjectType, registerEnumType } from '@nestjs/graphql';
|
||||
|
||||
import { IsEnum, IsNotEmpty } from 'class-validator';
|
||||
import { Relation } from 'typeorm';
|
||||
import { IDField } from '@ptc-org/nestjs-query-graphql';
|
||||
|
||||
import { FieldMetadataDTO } from 'src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto';
|
||||
import { ObjectMetadataDTO } from 'src/engine/metadata-modules/object-metadata/dtos/object-metadata.dto';
|
||||
import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
|
||||
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
|
||||
|
||||
export enum RelationDefinitionType {
|
||||
ONE_TO_ONE = RelationMetadataType.ONE_TO_ONE,
|
||||
ONE_TO_MANY = RelationMetadataType.ONE_TO_MANY,
|
||||
MANY_TO_MANY = RelationMetadataType.MANY_TO_MANY,
|
||||
MANY_TO_ONE = 'MANY_TO_ONE',
|
||||
}
|
||||
|
||||
registerEnumType(RelationDefinitionType, {
|
||||
name: 'RelationDefinitionType',
|
||||
description: 'Relation definition type',
|
||||
});
|
||||
|
||||
@ObjectType('RelationDefinition')
|
||||
export class RelationDefinitionDTO {
|
||||
@IsNotEmpty()
|
||||
@IDField(() => UUIDScalarType)
|
||||
relationId: string;
|
||||
|
||||
@IsNotEmpty()
|
||||
@Field(() => ObjectMetadataDTO)
|
||||
sourceObjectMetadata: Relation<ObjectMetadataDTO>;
|
||||
|
||||
@IsNotEmpty()
|
||||
@Field(() => ObjectMetadataDTO)
|
||||
targetObjectMetadata: Relation<ObjectMetadataDTO>;
|
||||
|
||||
@IsNotEmpty()
|
||||
@Field(() => FieldMetadataDTO)
|
||||
sourceFieldMetadata: Relation<FieldMetadataDTO>;
|
||||
|
||||
@IsNotEmpty()
|
||||
@Field(() => FieldMetadataDTO)
|
||||
targetFieldMetadata: Relation<FieldMetadataDTO>;
|
||||
|
||||
@IsEnum(RelationDefinitionType)
|
||||
@IsNotEmpty()
|
||||
@Field(() => RelationDefinitionType)
|
||||
direction: RelationDefinitionType;
|
||||
}
|
||||
@ -1,17 +1,21 @@
|
||||
import { Injectable } from '@nestjs/common';
|
||||
|
||||
import { plainToInstance } from 'class-transformer';
|
||||
import { ClassConstructor, plainToInstance } from 'class-transformer';
|
||||
import {
|
||||
IsEnum,
|
||||
IsInt,
|
||||
IsOptional,
|
||||
IsString,
|
||||
IsUUID,
|
||||
Max,
|
||||
Min,
|
||||
ValidationError,
|
||||
validateOrReject,
|
||||
} from 'class-validator';
|
||||
import { FieldMetadataType } from 'twenty-shared/types';
|
||||
|
||||
import { FieldMetadataSettings } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata-settings.interface';
|
||||
import { RelationType } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-type.interface';
|
||||
|
||||
import {
|
||||
FieldMetadataException,
|
||||
@ -42,12 +46,51 @@ class TextSettingsValidation {
|
||||
displayedMaxRows?: number;
|
||||
}
|
||||
|
||||
export class RelationCreationPayloadValidation {
|
||||
@IsUUID()
|
||||
targetObjectMetadataId?: string;
|
||||
|
||||
@IsString()
|
||||
targetFieldLabel: string;
|
||||
|
||||
@IsString()
|
||||
targetFieldIcon: string;
|
||||
|
||||
@IsEnum(RelationType)
|
||||
type: RelationType;
|
||||
}
|
||||
|
||||
@Injectable()
|
||||
export class FieldMetadataValidationService<
|
||||
T extends FieldMetadataType = FieldMetadataType,
|
||||
> {
|
||||
constructor() {}
|
||||
|
||||
async validateRelationCreationPayloadOrThrow(
|
||||
relationCreationPayload: RelationCreationPayloadValidation,
|
||||
) {
|
||||
try {
|
||||
const relationCreationPayloadInstance = plainToInstance(
|
||||
RelationCreationPayloadValidation,
|
||||
relationCreationPayload,
|
||||
);
|
||||
|
||||
await validateOrReject(relationCreationPayloadInstance);
|
||||
} catch (error) {
|
||||
const errorMessages = Array.isArray(error)
|
||||
? error
|
||||
.map((err: ValidationError) => Object.values(err.constraints ?? {}))
|
||||
.flat()
|
||||
.join(', ')
|
||||
: error.message;
|
||||
|
||||
throw new FieldMetadataException(
|
||||
`Relation creation payload is invalid: ${errorMessages}`,
|
||||
FieldMetadataExceptionCode.INVALID_FIELD_INPUT,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
async validateSettingsOrThrow({
|
||||
fieldType,
|
||||
settings,
|
||||
@ -57,19 +100,32 @@ export class FieldMetadataValidationService<
|
||||
}) {
|
||||
switch (fieldType) {
|
||||
case FieldMetadataType.NUMBER:
|
||||
await this.validateSettings(NumberSettingsValidation, settings);
|
||||
await this.validateSettings<FieldMetadataType.NUMBER>(
|
||||
NumberSettingsValidation,
|
||||
settings,
|
||||
);
|
||||
break;
|
||||
case FieldMetadataType.TEXT:
|
||||
await this.validateSettings(TextSettingsValidation, settings);
|
||||
await this.validateSettings<FieldMetadataType.TEXT>(
|
||||
TextSettingsValidation,
|
||||
settings,
|
||||
);
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
private async validateSettings(validator: any, settings: any) {
|
||||
private async validateSettings<Type extends FieldMetadataType>(
|
||||
validator: ClassConstructor<
|
||||
Type extends FieldMetadataType.NUMBER
|
||||
? NumberSettingsValidation
|
||||
: Type extends FieldMetadataType.TEXT
|
||||
? TextSettingsValidation
|
||||
: never
|
||||
>,
|
||||
settings: FieldMetadataSettings<T>,
|
||||
) {
|
||||
try {
|
||||
const settingsInstance = plainToInstance(validator, settings);
|
||||
|
||||
@ -77,8 +133,7 @@ export class FieldMetadataValidationService<
|
||||
} catch (error) {
|
||||
const errorMessages = Array.isArray(error)
|
||||
? error
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
.map((err: any) => Object.values(err.constraints))
|
||||
.map((err: ValidationError) => Object.values(err.constraints ?? {}))
|
||||
.flat()
|
||||
.join(', ')
|
||||
: error.message;
|
||||
|
||||
@ -22,7 +22,6 @@ import { FieldMetadataInterface } from 'src/engine/metadata-modules/field-metada
|
||||
import { FieldStandardOverridesDTO } from 'src/engine/metadata-modules/field-metadata/dtos/field-standard-overrides.dto';
|
||||
import { IndexFieldMetadataEntity } from 'src/engine/metadata-modules/index-metadata/index-field-metadata.entity';
|
||||
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
|
||||
import { RelationMetadataEntity } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
|
||||
|
||||
@Entity('fieldMetadata')
|
||||
@Unique('IDX_FIELD_METADATA_NAME_OBJECT_METADATA_ID_WORKSPACE_ID_UNIQUE', [
|
||||
@ -133,18 +132,6 @@ export class FieldMetadataEntity<
|
||||
@JoinColumn({ name: 'relationTargetObjectMetadataId' })
|
||||
relationTargetObjectMetadata: Relation<ObjectMetadataEntity>;
|
||||
|
||||
@OneToOne(
|
||||
() => RelationMetadataEntity,
|
||||
(relation: RelationMetadataEntity) => relation.fromFieldMetadata,
|
||||
)
|
||||
fromRelationMetadata: Relation<RelationMetadataEntity>;
|
||||
|
||||
@OneToOne(
|
||||
() => RelationMetadataEntity,
|
||||
(relation: RelationMetadataEntity) => relation.toFieldMetadata,
|
||||
)
|
||||
toRelationMetadata: Relation<RelationMetadataEntity>;
|
||||
|
||||
@OneToMany(
|
||||
() => IndexFieldMetadataEntity,
|
||||
(indexFieldMetadata: IndexFieldMetadataEntity) =>
|
||||
|
||||
@ -24,7 +24,6 @@ import { IsFieldMetadataOptions } from 'src/engine/metadata-modules/field-metada
|
||||
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
|
||||
import { ObjectMetadataModule } from 'src/engine/metadata-modules/object-metadata/object-metadata.module';
|
||||
import { PermissionsModule } from 'src/engine/metadata-modules/permissions/permissions.module';
|
||||
import { RelationMetadataEntity } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
|
||||
import { WorkspaceMetadataVersionModule } from 'src/engine/metadata-modules/workspace-metadata-version/workspace-metadata-version.module';
|
||||
import { WorkspaceMigrationModule } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.module';
|
||||
import { WorkspaceCacheStorageModule } from 'src/engine/workspace-cache-storage/workspace-cache-storage.module';
|
||||
@ -42,8 +41,8 @@ import { UpdateFieldInput } from './dtos/update-field.input';
|
||||
NestjsQueryGraphQLModule.forFeature({
|
||||
imports: [
|
||||
NestjsQueryTypeOrmModule.forFeature(
|
||||
[FieldMetadataEntity, ObjectMetadataEntity, RelationMetadataEntity],
|
||||
'metadata',
|
||||
[FieldMetadataEntity, ObjectMetadataEntity],
|
||||
'core',
|
||||
),
|
||||
WorkspaceMigrationModule,
|
||||
WorkspaceMigrationRunnerModule,
|
||||
|
||||
@ -23,10 +23,6 @@ import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
|
||||
import { CreateOneFieldMetadataInput } from 'src/engine/metadata-modules/field-metadata/dtos/create-field.input';
|
||||
import { DeleteOneFieldInput } from 'src/engine/metadata-modules/field-metadata/dtos/delete-field.input';
|
||||
import { FieldMetadataDTO } from 'src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto';
|
||||
import {
|
||||
RelationDefinitionDTO,
|
||||
RelationDefinitionType,
|
||||
} from 'src/engine/metadata-modules/field-metadata/dtos/relation-definition.dto';
|
||||
import { RelationDTO } from 'src/engine/metadata-modules/field-metadata/dtos/relation.dto';
|
||||
import {
|
||||
UpdateFieldInput,
|
||||
@ -43,7 +39,6 @@ import { fieldMetadataGraphqlApiExceptionHandler } from 'src/engine/metadata-mod
|
||||
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 { isRelationFieldMetadataType } from 'src/engine/utils/is-relation-field-metadata-type.util';
|
||||
import { createDeterministicUuid } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/create-deterministic-uuid.util';
|
||||
|
||||
@UseGuards(WorkspaceAuthGuard)
|
||||
@Resolver(() => FieldMetadataDTO)
|
||||
@ -165,40 +160,6 @@ export class FieldMetadataResolver {
|
||||
}
|
||||
}
|
||||
|
||||
@ResolveField(() => RelationDefinitionDTO, { nullable: true })
|
||||
async relationDefinition(
|
||||
@AuthWorkspace() workspace: Workspace,
|
||||
@Parent() fieldMetadata: FieldMetadataDTO,
|
||||
@Context() context: { loaders: IDataloaders },
|
||||
): Promise<RelationDefinitionDTO | null | undefined> {
|
||||
if (fieldMetadata.type !== FieldMetadataType.RELATION) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const relation = await this.relation(
|
||||
workspace,
|
||||
fieldMetadata as FieldMetadataEntity<FieldMetadataType.RELATION>,
|
||||
context,
|
||||
);
|
||||
|
||||
if (!relation) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return {
|
||||
// Temporary fix as we don't have relationId in the new relation
|
||||
relationId: createDeterministicUuid([
|
||||
relation.sourceFieldMetadata.id,
|
||||
relation.targetFieldMetadata.id,
|
||||
]),
|
||||
direction: relation.type as unknown as RelationDefinitionType,
|
||||
sourceObjectMetadata: relation.sourceObjectMetadata,
|
||||
targetObjectMetadata: relation.targetObjectMetadata,
|
||||
sourceFieldMetadata: relation.sourceFieldMetadata,
|
||||
targetFieldMetadata: relation.targetFieldMetadata,
|
||||
};
|
||||
}
|
||||
|
||||
@ResolveField(() => RelationDTO, { nullable: true })
|
||||
async relation(
|
||||
@AuthWorkspace() workspace: Workspace,
|
||||
|
||||
@ -23,10 +23,6 @@ import {
|
||||
FieldMetadataComplexOption,
|
||||
FieldMetadataDefaultOption,
|
||||
} from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
|
||||
import {
|
||||
RelationDefinitionDTO,
|
||||
RelationDefinitionType,
|
||||
} from 'src/engine/metadata-modules/field-metadata/dtos/relation-definition.dto';
|
||||
import { UpdateFieldInput } from 'src/engine/metadata-modules/field-metadata/dtos/update-field.input';
|
||||
import {
|
||||
FieldMetadataException,
|
||||
@ -42,17 +38,18 @@ import {
|
||||
} from 'src/engine/metadata-modules/field-metadata/utils/compute-column-name.util';
|
||||
import { generateNullable } from 'src/engine/metadata-modules/field-metadata/utils/generate-nullable';
|
||||
import { isCompositeFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/utils/is-composite-field-metadata-type.util';
|
||||
import { isEnumFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/utils/is-enum-field-metadata-type.util';
|
||||
import { isSelectOrMultiSelectFieldMetadata } from 'src/engine/metadata-modules/field-metadata/utils/is-select-or-multi-select-field-metadata.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 {
|
||||
RelationMetadataEntity,
|
||||
RelationMetadataType,
|
||||
} from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
|
||||
import { RelationOnDeleteAction } from 'src/engine/metadata-modules/relation-metadata/relation-on-delete-action.type';
|
||||
import { InvalidMetadataException } from 'src/engine/metadata-modules/utils/exceptions/invalid-metadata.exception';
|
||||
import { validateFieldNameAvailabilityOrThrow } from 'src/engine/metadata-modules/utils/validate-field-name-availability.utils';
|
||||
import { validateMetadataNameOrThrow } from 'src/engine/metadata-modules/utils/validate-metadata-name.utils';
|
||||
import { validateNameAndLabelAreSyncOrThrow } from 'src/engine/metadata-modules/utils/validate-name-and-label-are-sync-or-throw.util';
|
||||
import {
|
||||
computeMetadataNameFromLabel,
|
||||
validateNameAndLabelAreSyncOrThrow,
|
||||
} from 'src/engine/metadata-modules/utils/validate-name-and-label-are-sync-or-throw.util';
|
||||
import { WorkspaceMetadataVersionService } from 'src/engine/metadata-modules/workspace-metadata-version/services/workspace-metadata-version.service';
|
||||
import { generateMigrationName } from 'src/engine/metadata-modules/workspace-migration/utils/generate-migration-name.util';
|
||||
import {
|
||||
@ -66,9 +63,9 @@ import { WorkspaceMigrationService } from 'src/engine/metadata-modules/workspace
|
||||
import { WorkspaceEntityManager } from 'src/engine/twenty-orm/entity-manager/workspace-entity-manager';
|
||||
import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
|
||||
import { computeObjectTargetTable } from 'src/engine/utils/compute-object-target-table.util';
|
||||
import { isFieldMetadataEntityOfType } from 'src/engine/utils/is-field-metadata-of-type.util';
|
||||
import { WorkspaceMigrationRunnerService } from 'src/engine/workspace-manager/workspace-migration-runner/workspace-migration-runner.service';
|
||||
import { ViewService } from 'src/modules/view/services/view.service';
|
||||
import { isEnumFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/utils/is-enum-field-metadata-type.util';
|
||||
import { trimAndRemoveDuplicatedWhitespacesFromObjectStringProperties } from 'src/utils/trim-and-remove-duplicated-whitespaces-from-object-string-properties';
|
||||
|
||||
import { FieldMetadataValidationService } from './field-metadata-validation.service';
|
||||
@ -88,14 +85,12 @@ type ValidateFieldMetadataArgs<T extends UpdateFieldInput | CreateFieldInput> =
|
||||
@Injectable()
|
||||
export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntity> {
|
||||
constructor(
|
||||
@InjectDataSource('metadata')
|
||||
private readonly metadataDataSource: DataSource,
|
||||
@InjectRepository(FieldMetadataEntity, 'metadata')
|
||||
@InjectDataSource('core')
|
||||
private readonly coreDataSource: DataSource,
|
||||
@InjectRepository(FieldMetadataEntity, 'core')
|
||||
private readonly fieldMetadataRepository: Repository<FieldMetadataEntity>,
|
||||
@InjectRepository(ObjectMetadataEntity, 'metadata')
|
||||
@InjectRepository(ObjectMetadataEntity, 'core')
|
||||
private readonly objectMetadataRepository: Repository<ObjectMetadataEntity>,
|
||||
@InjectRepository(RelationMetadataEntity, 'metadata')
|
||||
private readonly relationMetadataRepository: Repository<RelationMetadataEntity>,
|
||||
private readonly workspaceMigrationFactory: WorkspaceMigrationFactory,
|
||||
private readonly workspaceMigrationService: WorkspaceMigrationService,
|
||||
private readonly workspaceMigrationRunnerService: WorkspaceMigrationRunnerService,
|
||||
@ -128,7 +123,7 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
|
||||
id: string,
|
||||
fieldMetadataInput: UpdateFieldInput,
|
||||
): Promise<FieldMetadataEntity> {
|
||||
const queryRunner = this.metadataDataSource.createQueryRunner();
|
||||
const queryRunner = this.coreDataSource.createQueryRunner();
|
||||
|
||||
await queryRunner.connect();
|
||||
await queryRunner.startTransaction();
|
||||
@ -314,7 +309,7 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
|
||||
input: DeleteOneFieldInput,
|
||||
workspaceId: string,
|
||||
): Promise<FieldMetadataEntity> {
|
||||
const queryRunner = this.metadataDataSource.createQueryRunner();
|
||||
const queryRunner = this.coreDataSource.createQueryRunner();
|
||||
|
||||
await queryRunner.connect();
|
||||
await queryRunner.startTransaction(); // transaction not safe as a different queryRunner is used within workspaceMigrationRunnerService
|
||||
@ -377,20 +372,6 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
|
||||
);
|
||||
}
|
||||
|
||||
// TODO: remove this once we have deleted the relation metadata table
|
||||
await this.relationMetadataRepository.delete({
|
||||
fromFieldMetadataId: In([
|
||||
fieldMetadata.id,
|
||||
fieldMetadata.relationTargetFieldMetadata.id,
|
||||
]),
|
||||
});
|
||||
await this.relationMetadataRepository.delete({
|
||||
toFieldMetadataId: In([
|
||||
fieldMetadata.id,
|
||||
fieldMetadata.relationTargetFieldMetadata.id,
|
||||
]),
|
||||
});
|
||||
|
||||
await fieldMetadataRepository.delete({
|
||||
id: In([
|
||||
fieldMetadata.id,
|
||||
@ -560,61 +541,6 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
|
||||
return updatableStandardFieldInput;
|
||||
}
|
||||
|
||||
public async getRelationDefinitionFromRelationMetadata(
|
||||
fieldMetadataDTO: FieldMetadataDTO,
|
||||
relationMetadata: RelationMetadataEntity,
|
||||
): Promise<RelationDefinitionDTO | null> {
|
||||
if (fieldMetadataDTO.type !== FieldMetadataType.RELATION) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const isRelationFromSource =
|
||||
relationMetadata.fromFieldMetadata.id === fieldMetadataDTO.id;
|
||||
|
||||
// TODO: implement MANY_TO_MANY
|
||||
if (
|
||||
relationMetadata.relationType === RelationMetadataType.MANY_TO_MANY ||
|
||||
relationMetadata.relationType === RelationMetadataType.MANY_TO_ONE
|
||||
) {
|
||||
throw new FieldMetadataException(
|
||||
`
|
||||
Relation type ${relationMetadata.relationType} not supported
|
||||
`,
|
||||
FieldMetadataExceptionCode.INVALID_FIELD_INPUT,
|
||||
);
|
||||
}
|
||||
|
||||
if (isRelationFromSource) {
|
||||
const direction =
|
||||
relationMetadata.relationType === RelationMetadataType.ONE_TO_ONE
|
||||
? RelationDefinitionType.ONE_TO_ONE
|
||||
: RelationDefinitionType.ONE_TO_MANY;
|
||||
|
||||
return {
|
||||
relationId: relationMetadata.id,
|
||||
sourceObjectMetadata: relationMetadata.fromObjectMetadata,
|
||||
sourceFieldMetadata: relationMetadata.fromFieldMetadata,
|
||||
targetObjectMetadata: relationMetadata.toObjectMetadata,
|
||||
targetFieldMetadata: relationMetadata.toFieldMetadata,
|
||||
direction,
|
||||
};
|
||||
} else {
|
||||
const direction =
|
||||
relationMetadata.relationType === RelationMetadataType.ONE_TO_ONE
|
||||
? RelationDefinitionType.ONE_TO_ONE
|
||||
: RelationDefinitionType.MANY_TO_ONE;
|
||||
|
||||
return {
|
||||
relationId: relationMetadata.id,
|
||||
sourceObjectMetadata: relationMetadata.toObjectMetadata,
|
||||
sourceFieldMetadata: relationMetadata.toFieldMetadata,
|
||||
targetObjectMetadata: relationMetadata.fromObjectMetadata,
|
||||
targetFieldMetadata: relationMetadata.fromFieldMetadata,
|
||||
direction,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
private async validateFieldMetadata<
|
||||
T extends UpdateFieldInput | CreateFieldInput,
|
||||
>({
|
||||
@ -680,6 +606,25 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
|
||||
});
|
||||
}
|
||||
|
||||
// TODO: clean typings, we should try to validate both update and create inputs in the same function
|
||||
if (
|
||||
fieldMetadataType === FieldMetadataType.RELATION &&
|
||||
isDefined(
|
||||
(fieldMetadataInput as unknown as CreateFieldInput)
|
||||
.relationCreationPayload,
|
||||
)
|
||||
) {
|
||||
const relationCreationPayload = (
|
||||
fieldMetadataInput as unknown as CreateFieldInput
|
||||
).relationCreationPayload;
|
||||
|
||||
if (isDefined(relationCreationPayload)) {
|
||||
await this.fieldMetadataValidationService.validateRelationCreationPayloadOrThrow(
|
||||
relationCreationPayload,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return fieldMetadataInput;
|
||||
}
|
||||
|
||||
@ -745,20 +690,49 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
|
||||
fieldMetadataInput.defaultValue ??
|
||||
generateDefaultValue(fieldMetadataInput.type);
|
||||
|
||||
const relationCreationPayload = fieldMetadataInput.relationCreationPayload;
|
||||
|
||||
return {
|
||||
id: v4(),
|
||||
createdAt: new Date(),
|
||||
updatedAt: new Date(),
|
||||
...fieldMetadataInput,
|
||||
name: fieldMetadataInput.name,
|
||||
label: fieldMetadataInput.label,
|
||||
icon: fieldMetadataInput.icon,
|
||||
type: fieldMetadataInput.type,
|
||||
isLabelSyncedWithName: fieldMetadataInput.isLabelSyncedWithName,
|
||||
objectMetadataId: fieldMetadataInput.objectMetadataId,
|
||||
workspaceId: fieldMetadataInput.workspaceId,
|
||||
isNullable: generateNullable(
|
||||
fieldMetadataInput.type,
|
||||
fieldMetadataInput.isNullable,
|
||||
fieldMetadataInput.isRemoteCreation,
|
||||
),
|
||||
relationTargetObjectMetadataId:
|
||||
relationCreationPayload?.targetObjectMetadataId,
|
||||
defaultValue,
|
||||
...options,
|
||||
isActive: true,
|
||||
isCustom: true,
|
||||
settings: {
|
||||
...fieldMetadataInput.settings,
|
||||
...(fieldMetadataInput.type === FieldMetadataType.RELATION &&
|
||||
relationCreationPayload &&
|
||||
relationCreationPayload.type === RelationType.ONE_TO_MANY
|
||||
? {
|
||||
relationType: RelationType.ONE_TO_MANY,
|
||||
}
|
||||
: {}),
|
||||
...(fieldMetadataInput.type === FieldMetadataType.RELATION &&
|
||||
relationCreationPayload &&
|
||||
relationCreationPayload.type === RelationType.MANY_TO_ONE
|
||||
? {
|
||||
relationType: RelationType.MANY_TO_ONE,
|
||||
onDelete: RelationOnDeleteAction.SET_NULL,
|
||||
joinColumnName: `${fieldMetadataInput.name}Id`,
|
||||
}
|
||||
: {}),
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
@ -778,11 +752,11 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
|
||||
);
|
||||
}
|
||||
|
||||
private async validateAndCreateFieldMetadata(
|
||||
private async validateAndCreateFieldMetadataItems(
|
||||
fieldMetadataInput: CreateFieldInput,
|
||||
objectMetadata: ObjectMetadataEntity,
|
||||
fieldMetadataRepository: Repository<FieldMetadataEntity>,
|
||||
): Promise<FieldMetadataEntity> {
|
||||
): Promise<FieldMetadataEntity[]> {
|
||||
if (!fieldMetadataInput.isRemoteCreation) {
|
||||
assertMutationNotOnRemoteObject(objectMetadata);
|
||||
}
|
||||
@ -796,7 +770,10 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
|
||||
|
||||
await this.validateFieldMetadata({
|
||||
fieldMetadataType: fieldMetadataForCreate.type,
|
||||
fieldMetadataInput: fieldMetadataForCreate,
|
||||
fieldMetadataInput: {
|
||||
...fieldMetadataForCreate,
|
||||
relationCreationPayload: fieldMetadataInput.relationCreationPayload,
|
||||
},
|
||||
objectMetadata,
|
||||
});
|
||||
|
||||
@ -807,26 +784,99 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
|
||||
);
|
||||
}
|
||||
|
||||
return await fieldMetadataRepository.save(fieldMetadataForCreate);
|
||||
}
|
||||
const createdFieldMetadataItem = await fieldMetadataRepository.save(
|
||||
fieldMetadataForCreate,
|
||||
);
|
||||
|
||||
private async createMigrationActions(
|
||||
createdFieldMetadata: FieldMetadataEntity,
|
||||
objectMetadata: ObjectMetadataEntity,
|
||||
isRemoteCreation: boolean,
|
||||
): Promise<WorkspaceMigrationTableAction | null> {
|
||||
if (isRemoteCreation) {
|
||||
return null;
|
||||
if (fieldMetadataForCreate.type !== FieldMetadataType.RELATION) {
|
||||
return [createdFieldMetadataItem];
|
||||
}
|
||||
|
||||
return {
|
||||
name: computeObjectTargetTable(objectMetadata),
|
||||
action: WorkspaceMigrationTableActionType.ALTER,
|
||||
columns: this.workspaceMigrationFactory.createColumnActions(
|
||||
WorkspaceMigrationColumnActionType.CREATE,
|
||||
createdFieldMetadata,
|
||||
),
|
||||
};
|
||||
const relationCreationPayload = fieldMetadataInput.relationCreationPayload;
|
||||
|
||||
if (!isDefined(relationCreationPayload)) {
|
||||
throw new FieldMetadataException(
|
||||
'Relation creation payload is not defined',
|
||||
FieldMetadataExceptionCode.FIELD_METADATA_RELATION_MALFORMED,
|
||||
);
|
||||
}
|
||||
|
||||
const targetFieldMetadataToCreate =
|
||||
this.prepareCustomFieldMetadataForCreation({
|
||||
objectMetadataId: relationCreationPayload.targetObjectMetadataId,
|
||||
type: FieldMetadataType.RELATION,
|
||||
name: computeMetadataNameFromLabel(
|
||||
relationCreationPayload.targetFieldLabel,
|
||||
),
|
||||
label: relationCreationPayload.targetFieldLabel,
|
||||
icon: relationCreationPayload.targetFieldIcon,
|
||||
workspaceId: fieldMetadataForCreate.workspaceId,
|
||||
relationCreationPayload: {
|
||||
targetObjectMetadataId: objectMetadata.id,
|
||||
targetFieldLabel: fieldMetadataInput.label,
|
||||
targetFieldIcon: fieldMetadataInput.icon ?? 'Icon123',
|
||||
type:
|
||||
relationCreationPayload.type === RelationType.ONE_TO_MANY
|
||||
? RelationType.MANY_TO_ONE
|
||||
: RelationType.ONE_TO_MANY,
|
||||
},
|
||||
});
|
||||
|
||||
const targetFieldMetadata = await fieldMetadataRepository.save({
|
||||
...targetFieldMetadataToCreate,
|
||||
relationTargetFieldMetadataId: createdFieldMetadataItem.id,
|
||||
});
|
||||
|
||||
const createdFieldMetadataItemUpdated = await fieldMetadataRepository.save({
|
||||
...createdFieldMetadataItem,
|
||||
relationTargetFieldMetadataId: targetFieldMetadata.id,
|
||||
});
|
||||
|
||||
return [createdFieldMetadataItemUpdated, targetFieldMetadata];
|
||||
}
|
||||
|
||||
private async createMigrationActions({
|
||||
createdFieldMetadataItems,
|
||||
objectMetadataMap,
|
||||
isRemoteCreation,
|
||||
}: {
|
||||
createdFieldMetadataItems: FieldMetadataEntity[];
|
||||
objectMetadataMap: Record<string, ObjectMetadataEntity>;
|
||||
isRemoteCreation: boolean;
|
||||
}): Promise<WorkspaceMigrationTableAction[]> {
|
||||
if (isRemoteCreation) {
|
||||
return [];
|
||||
}
|
||||
|
||||
const migrationActions: WorkspaceMigrationTableAction[] = [];
|
||||
|
||||
for (const createdFieldMetadata of createdFieldMetadataItems) {
|
||||
if (
|
||||
isFieldMetadataEntityOfType(
|
||||
createdFieldMetadata,
|
||||
FieldMetadataType.RELATION,
|
||||
)
|
||||
) {
|
||||
const relationType = createdFieldMetadata.settings?.relationType;
|
||||
|
||||
if (relationType === RelationType.ONE_TO_MANY) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
migrationActions.push({
|
||||
name: computeObjectTargetTable(
|
||||
objectMetadataMap[createdFieldMetadata.objectMetadataId],
|
||||
),
|
||||
action: WorkspaceMigrationTableActionType.ALTER,
|
||||
columns: this.workspaceMigrationFactory.createColumnActions(
|
||||
WorkspaceMigrationColumnActionType.CREATE,
|
||||
createdFieldMetadata,
|
||||
),
|
||||
});
|
||||
}
|
||||
|
||||
return migrationActions;
|
||||
}
|
||||
|
||||
async createMany(
|
||||
@ -837,7 +887,7 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
|
||||
}
|
||||
|
||||
const workspaceId = fieldMetadataInputs[0].workspaceId;
|
||||
const queryRunner = this.metadataDataSource.createQueryRunner();
|
||||
const queryRunner = this.coreDataSource.createQueryRunner();
|
||||
|
||||
await queryRunner.connect();
|
||||
await queryRunner.startTransaction();
|
||||
@ -854,7 +904,6 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
|
||||
|
||||
const objectMetadatas = await this.objectMetadataRepository.find({
|
||||
where: {
|
||||
id: In(objectMetadataIds),
|
||||
workspaceId,
|
||||
},
|
||||
relations: ['fields'],
|
||||
@ -881,24 +930,22 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
|
||||
const inputs = inputsByObjectId[objectMetadataId];
|
||||
|
||||
for (const fieldMetadataInput of inputs) {
|
||||
const createdFieldMetadata =
|
||||
await this.validateAndCreateFieldMetadata(
|
||||
const createdFieldMetadataItems =
|
||||
await this.validateAndCreateFieldMetadataItems(
|
||||
fieldMetadataInput,
|
||||
objectMetadata,
|
||||
fieldMetadataRepository,
|
||||
);
|
||||
|
||||
createdFieldMetadatas.push(createdFieldMetadata);
|
||||
createdFieldMetadatas.push(...createdFieldMetadataItems);
|
||||
|
||||
const migrationAction = await this.createMigrationActions(
|
||||
createdFieldMetadata,
|
||||
objectMetadata,
|
||||
fieldMetadataInput.isRemoteCreation ?? false,
|
||||
);
|
||||
const fieldMigrationActions = await this.createMigrationActions({
|
||||
createdFieldMetadataItems,
|
||||
objectMetadataMap,
|
||||
isRemoteCreation: fieldMetadataInput.isRemoteCreation ?? false,
|
||||
});
|
||||
|
||||
if (isDefined(migrationAction)) {
|
||||
migrationActions.push(migrationAction);
|
||||
}
|
||||
migrationActions.push(...fieldMigrationActions);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ -4,7 +4,6 @@ import { FieldMetadataDefaultValue } from 'src/engine/metadata-modules/field-met
|
||||
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 { RelationMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-metadata.interface';
|
||||
|
||||
export interface FieldMetadataInterface<
|
||||
T extends FieldMetadataType = FieldMetadataType,
|
||||
@ -22,8 +21,6 @@ export interface FieldMetadataInterface<
|
||||
icon?: string;
|
||||
isNullable?: boolean;
|
||||
isUnique?: boolean;
|
||||
fromRelationMetadata?: RelationMetadataInterface;
|
||||
toRelationMetadata?: RelationMetadataInterface;
|
||||
relationTargetFieldMetadataId?: string;
|
||||
relationTargetFieldMetadata?: FieldMetadataInterface;
|
||||
relationTargetObjectMetadataId?: string;
|
||||
|
||||
@ -3,7 +3,6 @@ import { IndexMetadataInterface } from 'src/engine/metadata-modules/index-metada
|
||||
import { WorkspaceEntityDuplicateCriteria } from 'src/engine/api/graphql/workspace-query-builder/types/workspace-entity-duplicate-criteria.type';
|
||||
|
||||
import { FieldMetadataInterface } from './field-metadata.interface';
|
||||
import { RelationMetadataInterface } from './relation-metadata.interface';
|
||||
|
||||
export interface ObjectMetadataInterface {
|
||||
id: string;
|
||||
@ -16,8 +15,6 @@ export interface ObjectMetadataInterface {
|
||||
description?: string;
|
||||
icon?: string;
|
||||
targetTableName: string;
|
||||
fromRelations: RelationMetadataInterface[];
|
||||
toRelations: RelationMetadataInterface[];
|
||||
fields: FieldMetadataInterface[];
|
||||
indexMetadatas: IndexMetadataInterface[];
|
||||
isSystem: boolean;
|
||||
|
||||
@ -1,22 +0,0 @@
|
||||
import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
|
||||
|
||||
import { ObjectMetadataInterface } from './object-metadata.interface';
|
||||
import { FieldMetadataInterface } from './field-metadata.interface';
|
||||
|
||||
export interface RelationMetadataInterface {
|
||||
id: string;
|
||||
|
||||
relationType: RelationMetadataType;
|
||||
|
||||
fromObjectMetadataId: string;
|
||||
fromObjectMetadata: ObjectMetadataInterface;
|
||||
|
||||
toObjectMetadataId: string;
|
||||
toObjectMetadata: ObjectMetadataInterface;
|
||||
|
||||
fromFieldMetadataId: string;
|
||||
fromFieldMetadata: FieldMetadataInterface;
|
||||
|
||||
toFieldMetadataId: string;
|
||||
toFieldMetadata: FieldMetadataInterface;
|
||||
}
|
||||
@ -1,5 +1,4 @@
|
||||
export enum RelationType {
|
||||
ONE_TO_ONE = 'ONE_TO_ONE',
|
||||
ONE_TO_MANY = 'ONE_TO_MANY',
|
||||
MANY_TO_ONE = 'MANY_TO_ONE',
|
||||
}
|
||||
|
||||
@ -6,8 +6,8 @@ import {
|
||||
ValidatorConstraint,
|
||||
ValidatorConstraintInterface,
|
||||
} from 'class-validator';
|
||||
import { Repository } from 'typeorm';
|
||||
import { FieldMetadataType } from 'twenty-shared/types';
|
||||
import { Repository } from 'typeorm';
|
||||
|
||||
import { FieldMetadataDefaultValue } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata-default-value.interface';
|
||||
|
||||
@ -21,7 +21,7 @@ export class IsFieldMetadataDefaultValue
|
||||
implements ValidatorConstraintInterface
|
||||
{
|
||||
constructor(
|
||||
@InjectRepository(FieldMetadataEntity, 'metadata')
|
||||
@InjectRepository(FieldMetadataEntity, 'core')
|
||||
private readonly fieldMetadataRepository: Repository<FieldMetadataEntity>,
|
||||
private readonly loggerService: LoggerService,
|
||||
) {}
|
||||
|
||||
@ -2,8 +2,8 @@ import { Injectable } from '@nestjs/common';
|
||||
import { InjectRepository } from '@nestjs/typeorm';
|
||||
|
||||
import { ValidationArguments, ValidatorConstraint } from 'class-validator';
|
||||
import { Repository } from 'typeorm';
|
||||
import { FieldMetadataType } from 'twenty-shared/types';
|
||||
import { Repository } from 'typeorm';
|
||||
|
||||
import { FieldMetadataOptions } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata-options.interface';
|
||||
|
||||
@ -16,7 +16,7 @@ export class IsFieldMetadataOptions {
|
||||
private validationErrors: string[] = [];
|
||||
|
||||
constructor(
|
||||
@InjectRepository(FieldMetadataEntity, 'metadata')
|
||||
@InjectRepository(FieldMetadataEntity, 'core')
|
||||
private readonly fieldMetadataRepository: Repository<FieldMetadataEntity>,
|
||||
) {}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user