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

feat: twenty orm sync (#5266)

Browse Source 
This PR is updating all object metadata entities with the new
decorators, and deleting the old ones.
This way we can use the new TwentyORM with all the standard objects.

---------

Co-authored-by: Weiko <corentin@twenty.com>
This commit is contained in:
Jérémy M
2024-05-15 16:58:47 +02:00
committed by GitHub
parent 6898c1e4d8
commit f0383e3147
81 changed files with 1721 additions and 2060 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/commands/add-standard-id.command.ts
View File

@ -10,7 +10,7 @@ import { standardObjectMetadataDefinitions } from 'src/engine/workspace-manager/
import { StandardObjectFactory } from 'src/engine/workspace-manager/workspace-sync-metadata/factories/standard-object.factory';
import { computeStandardObject } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/compute-standard-object.util';
import { StandardFieldFactory } from 'src/engine/workspace-manager/workspace-sync-metadata/factories/standard-field.factory';
import { CustomObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/custom-objects/custom.object-metadata';
import { CustomWorkspaceEntity } from 'src/engine/twenty-orm/custom.workspace-entity';
interface RunCommandOptions {
workspaceId?: string;
@ -61,7 +61,7 @@ export class AddStandardIdCommand extends CommandRunner {
},
);
const standardFieldMetadataCollection = this.standardFieldFactory.create(
CustomObjectMetadata,
CustomWorkspaceEntity,
{
workspaceId: '',
dataSourceId: '',

107
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/custom-objects/custom.object-metadata.ts
View File

@ -1,107 +0,0 @@
import { BaseCustomObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/base-custom-object-metadata.decorator';
import { FieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/field-metadata.decorator';
import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { IsNullable } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/is-nullable.decorator';
import { IsSystem } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/is-system.decorator';
import { BaseObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-objects/base.object-metadata';
import {
RelationMetadataType,
RelationOnDeleteAction,
} from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
import { ActivityTargetObjectMetadata } from 'src/modules/activity/standard-objects/activity-target.object-metadata';
import { RelationMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/relation-metadata.decorator';
import { FavoriteObjectMetadata } from 'src/modules/favorite/standard-objects/favorite.object-metadata';
import { AttachmentObjectMetadata } from 'src/modules/attachment/standard-objects/attachment.object-metadata';
import { CUSTOM_OBJECT_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
import { TimelineActivityObjectMetadata } from 'src/modules/timeline/standard-objects/timeline-activity.object-metadata';
@BaseCustomObjectMetadata()
export class CustomObjectMetadata extends BaseObjectMetadata {
@FieldMetadata({
standardId: CUSTOM_OBJECT_STANDARD_FIELD_IDS.name,
label: 'Name',
description: 'Name',
type: FieldMetadataType.TEXT,
icon: 'IconAbc',
defaultValue: "'Untitled'",
})
name: string;
@FieldMetadata({
standardId: CUSTOM_OBJECT_STANDARD_FIELD_IDS.position,
label: 'Position',
description: 'Position',
type: FieldMetadataType.POSITION,
icon: 'IconHierarchy2',
})
@IsNullable()
@IsSystem()
position: number;
@FieldMetadata({
standardId: CUSTOM_OBJECT_STANDARD_FIELD_IDS.activityTargets,
type: FieldMetadataType.RELATION,
label: 'Activities',
description: (objectMetadata) =>
`Activities tied to the ${objectMetadata.labelSingular}`,
icon: 'IconCheckbox',
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
inverseSideTarget: () => ActivityTargetObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
@IsNullable()
activityTargets: ActivityTargetObjectMetadata[];
@FieldMetadata({
standardId: CUSTOM_OBJECT_STANDARD_FIELD_IDS.favorites,
type: FieldMetadataType.RELATION,
label: 'Favorites',
description: (objectMetadata) =>
`Favorites tied to the ${objectMetadata.labelSingular}`,
icon: 'IconHeart',
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
inverseSideTarget: () => FavoriteObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
@IsNullable()
@IsSystem()
favorites: FavoriteObjectMetadata[];
@FieldMetadata({
standardId: CUSTOM_OBJECT_STANDARD_FIELD_IDS.attachments,
type: FieldMetadataType.RELATION,
label: 'Attachments',
description: (objectMetadata) =>
`Attachments tied to the ${objectMetadata.labelSingular}`,
icon: 'IconFileImport',
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
inverseSideTarget: () => AttachmentObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
@IsNullable()
attachments: AttachmentObjectMetadata[];
@FieldMetadata({
standardId: CUSTOM_OBJECT_STANDARD_FIELD_IDS.timelineActivities,
type: FieldMetadataType.RELATION,
label: 'Timeline Activities',
description: (objectMetadata) =>
`Timeline Activities tied to the ${objectMetadata.labelSingular}`,
icon: 'IconIconTimelineEvent',
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
inverseSideTarget: () => TimelineActivityObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
@IsNullable()
@IsSystem()
timelineActivities: TimelineActivityObjectMetadata[];
}

20
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/decorators/base-custom-object-metadata.decorator.ts
View File

@ -1,20 +0,0 @@
import { BaseCustomObjectMetadataDecoratorParams } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-custom-object-metadata.interface';
import { TypedReflect } from 'src/utils/typed-reflect';
export function BaseCustomObjectMetadata(
params?: BaseCustomObjectMetadataDecoratorParams,
): ClassDecorator {
return (target) => {
const gate = TypedReflect.getMetadata('gate', target);
TypedReflect.defineMetadata(
'extendObjectMetadata',
{
...params,
gate,
},
target,
);
};
}

27
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/decorators/dynamic-field-metadata.interface.ts
View File

@ -1,27 +0,0 @@
import { DynamicRelationFieldMetadataDecoratorParams } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-computed-relation-field-metadata.interface';
import { TypedReflect } from 'src/utils/typed-reflect';
import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
export function DynamicRelationFieldMetadata(
params: DynamicRelationFieldMetadataDecoratorParams,
): PropertyDecorator {
return (target: object, fieldKey: string) => {
const isSystem =
TypedReflect.getMetadata('isSystem', target, fieldKey) ?? false;
const gate = TypedReflect.getMetadata('gate', target, fieldKey);
TypedReflect.defineMetadata(
'dynamicRelationFieldMetadataMap',
{
type: FieldMetadataType.RELATION,
paramsFactory: params,
isCustom: false,
isNullable: true,
isSystem,
gate,
},
target.constructor,
);
};
}

92
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/decorators/field-metadata.decorator.ts
View File

@ -1,92 +0,0 @@
import {
FieldMetadataDecoratorParams,
ReflectFieldMetadata,
} from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-field-metadata.interface';
import { GateDecoratorParams } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/gate-decorator.interface';
import { FieldMetadataDefaultValue } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata-default-value.interface';
import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { generateDefaultValue } from 'src/engine/metadata-modules/field-metadata/utils/generate-default-value';
import { TypedReflect } from 'src/utils/typed-reflect';
import { createDeterministicUuid } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/create-deterministic-uuid.util';
export function FieldMetadata<T extends FieldMetadataType>(
params: FieldMetadataDecoratorParams<T>,
): PropertyDecorator {
return (target: object, fieldKey: string) => {
const existingFieldMetadata =
TypedReflect.getMetadata('fieldMetadataMap', target.constructor) ?? {};
const isNullable =
TypedReflect.getMetadata('isNullable', target, fieldKey) ?? false;
const isSystem =
TypedReflect.getMetadata('isSystem', target, fieldKey) ?? false;
const gate = TypedReflect.getMetadata('gate', target, fieldKey);
const { joinColumn, standardId, ...restParams } = params;
TypedReflect.defineMetadata(
'fieldMetadataMap',
{
...existingFieldMetadata,
[fieldKey]: generateFieldMetadata<T>(
{
...restParams,
standardId,
joinColumn,
},
fieldKey,
isNullable,
isSystem,
gate,
),
...(joinColumn && restParams.type === FieldMetadataType.RELATION
? {
[joinColumn]: generateFieldMetadata<FieldMetadataType.UUID>(
{
...restParams,
standardId: createDeterministicUuid(standardId),
type: FieldMetadataType.UUID,
label: `${restParams.label} id (foreign key)`,
description: `${restParams.description} id foreign key`,
defaultValue: null,
options: undefined,
settings: undefined,
joinColumn,
},
joinColumn,
isNullable,
true,
gate,
),
}
: {}),
},
target.constructor,
);
};
}
function generateFieldMetadata<T extends FieldMetadataType>(
params: FieldMetadataDecoratorParams<T>,
fieldKey: string,
isNullable: boolean,
isSystem: boolean,
gate: GateDecoratorParams | undefined = undefined,
): ReflectFieldMetadata[string] {
const defaultValue = (params.defaultValue ??
generateDefaultValue(
params.type,
)) as FieldMetadataDefaultValue<'default'> | null;
return {
name: fieldKey,
...params,
isNullable: params.type === FieldMetadataType.RELATION ? true : isNullable,
isSystem,
isCustom: false,
options: params.options,
description: params.description,
icon: params.icon,
defaultValue,
gate,
};
}

13
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/decorators/gate.decorator.ts
View File

@ -1,13 +0,0 @@
import { GateDecoratorParams } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/gate-decorator.interface';
import { TypedReflect } from 'src/utils/typed-reflect';
export function Gate(metadata: GateDecoratorParams) {
return function (target: object, fieldKey?: string) {
if (fieldKey) {
TypedReflect.defineMetadata('gate', metadata, target, fieldKey);
} else {
TypedReflect.defineMetadata('gate', metadata, target);
}
};
}

7
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/decorators/is-not-audit-logged.decorator.ts
View File

@ -1,7 +0,0 @@
import { TypedReflect } from 'src/utils/typed-reflect';
export function IsNotAuditLogged() {
return function (target: object) {
TypedReflect.defineMetadata('isAuditLogged', false, target);
};
}

7
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/decorators/is-nullable.decorator.ts
View File

@ -1,7 +0,0 @@
import { TypedReflect } from 'src/utils/typed-reflect';
export function IsNullable() {
return function (target: object, fieldKey: string) {
TypedReflect.defineMetadata('isNullable', true, target, fieldKey);
};
}

11
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/decorators/is-system.decorator.ts
View File

@ -1,11 +0,0 @@
import { TypedReflect } from 'src/utils/typed-reflect';
export function IsSystem() {
return function (target: object, fieldKey?: string) {
if (fieldKey) {
TypedReflect.defineMetadata('isSystem', true, target, fieldKey);
} else {
TypedReflect.defineMetadata('isSystem', true, target);
}
};
}

33
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/decorators/object-metadata.decorator.ts
View File

@ -1,33 +0,0 @@
import { ObjectMetadataDecoratorParams } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-object-metadata.interface';
import { TypedReflect } from 'src/utils/typed-reflect';
import { convertClassNameToObjectMetadataName } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/convert-class-to-object-metadata-name.util';
export function ObjectMetadata(
params: ObjectMetadataDecoratorParams,
): ClassDecorator {
return (target) => {
const isSystem = TypedReflect.getMetadata('isSystem', target) ?? false;
const isAuditLogged =
TypedReflect.getMetadata('isAuditLogged', target) ?? true;
const gate = TypedReflect.getMetadata('gate', target);
const objectName = convertClassNameToObjectMetadataName(target.name);
TypedReflect.defineMetadata(
'objectMetadata',
{
nameSingular: objectName,
...params,
targetTableName: 'DEPRECATED',
isSystem,
isCustom: false,
isRemote: false,
isAuditLogged,
description: params.description,
icon: params.icon,
gate,
},
target,
);
};
}

35
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/decorators/relation-metadata.decorator.ts
View File

@ -1,35 +0,0 @@
import 'reflect-metadata';
import {
ReflectRelationMetadata,
RelationMetadataDecoratorParams,
} from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-relation-metadata.interface';
import { TypedReflect } from 'src/utils/typed-reflect';
export function RelationMetadata<TClass extends object>(
params: RelationMetadataDecoratorParams<TClass>,
): PropertyDecorator {
return (target: object, fieldKey: string) => {
const relationMetadataCollection =
TypedReflect.getMetadata(
'reflectRelationMetadataCollection',
target.constructor,
) ?? [];
const gate = TypedReflect.getMetadata('gate', target, fieldKey);
TypedReflect.defineMetadata(
'reflectRelationMetadataCollection',
[
...relationMetadataCollection,
{
target,
fieldKey,
...params,
gate,
} satisfies ReflectRelationMetadata,
],
target.constructor,
);
};
}

256
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/factories/standard-field.factory.ts
View File

@ -6,97 +6,219 @@ import {
PartialComputedFieldMetadata,
PartialFieldMetadata,
} from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/partial-field-metadata.interface';
import { ReflectFieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-field-metadata.interface';
import { ReflectObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-object-metadata.interface';
import { ReflectDynamicRelationFieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-computed-relation-field-metadata.interface';
import { WorkspaceEntityMetadataArgs } from 'src/engine/twenty-orm/interfaces/workspace-entity-metadata-args.interface';
import { WorkspaceFieldMetadataArgs } from 'src/engine/twenty-orm/interfaces/workspace-field-metadata-args.interface';
import { WorkspaceDynamicRelationMetadataArgs } from 'src/engine/twenty-orm/interfaces/workspace-dynamic-relation-metadata-args.interface';
import { WorkspaceRelationMetadataArgs } from 'src/engine/twenty-orm/interfaces/workspace-relation-metadata-args.interface';
import { TypedReflect } from 'src/utils/typed-reflect';
import { isGatedAndNotEnabled } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/is-gate-and-not-enabled.util';
import { metadataArgsStorage } from 'src/engine/twenty-orm/storage/metadata-args.storage';
import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { createDeterministicUuid } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/create-deterministic-uuid.util';
@Injectable()
export class StandardFieldFactory {
create(
target: object,
target: typeof BaseWorkspaceEntity,
context: WorkspaceSyncContext,
workspaceFeatureFlagsMap: FeatureFlagMap,
): (PartialFieldMetadata | PartialComputedFieldMetadata)[] {
const reflectObjectMetadata = TypedReflect.getMetadata(
'objectMetadata',
target,
);
const reflectFieldMetadataMap =
TypedReflect.getMetadata('fieldMetadataMap', target) ?? [];
const reflectDynamicRelationFieldMetadataMap = TypedReflect.getMetadata(
'dynamicRelationFieldMetadataMap',
target,
);
const partialFieldMetadataCollection: (
| PartialFieldMetadata
| PartialComputedFieldMetadata
)[] = Object.values(reflectFieldMetadataMap)
.map((reflectFieldMetadata) =>
this.createFieldMetadata(
reflectObjectMetadata,
reflectFieldMetadata,
context,
workspaceFeatureFlagsMap,
),
)
.filter((metadata): metadata is PartialFieldMetadata => !!metadata);
const partialComputedFieldMetadata = this.createComputedFieldMetadata(
reflectDynamicRelationFieldMetadataMap,
context,
workspaceFeatureFlagsMap,
);
): Array<PartialFieldMetadata | PartialComputedFieldMetadata> {
const workspaceEntityMetadataArgs =
metadataArgsStorage.filterEntities(target);
const metadataCollections = this.collectMetadata(target);
if (partialComputedFieldMetadata) {
partialFieldMetadataCollection.push(partialComputedFieldMetadata);
}
return partialFieldMetadataCollection;
return [
...this.processMetadata(
workspaceEntityMetadataArgs,
metadataCollections.fields,
context,
workspaceFeatureFlagsMap,
this.createFieldMetadata,
),
...this.processMetadata(
workspaceEntityMetadataArgs,
metadataCollections.relations,
context,
workspaceFeatureFlagsMap,
this.createFieldRelationMetadata,
),
...this.processMetadata(
workspaceEntityMetadataArgs,
metadataCollections.dynamicRelations,
context,
workspaceFeatureFlagsMap,
this.createComputedFieldRelationMetadata,
),
];
}
private createFieldMetadata(
reflectObjectMetadata: ReflectObjectMetadata | undefined,
reflectFieldMetadata: ReflectFieldMetadata[string],
context: WorkspaceSyncContext,
workspaceFeatureFlagsMap: FeatureFlagMap,
): PartialFieldMetadata | undefined {
if (
isGatedAndNotEnabled(reflectFieldMetadata.gate, workspaceFeatureFlagsMap)
) {
return undefined;
}
private collectMetadata(target: typeof BaseWorkspaceEntity) {
return {
...reflectFieldMetadata,
workspaceId: context.workspaceId,
isSystem:
reflectObjectMetadata?.isSystem || reflectFieldMetadata.isSystem,
fields: metadataArgsStorage.filterFields(target),
relations: metadataArgsStorage.filterRelations(target),
dynamicRelations: metadataArgsStorage.filterDynamicRelations(target),
};
}
private createComputedFieldMetadata(
reflectDynamicRelationFieldMetadata:
| ReflectDynamicRelationFieldMetadata
| undefined,
private processMetadata<
T,
U extends PartialFieldMetadata | PartialComputedFieldMetadata,
>(
workspaceEntityMetadataArgs: WorkspaceEntityMetadataArgs | undefined,
metadataArgs: T[],
context: WorkspaceSyncContext,
featureFlagsMap: FeatureFlagMap,
createMetadata: (
workspaceEntityMetadataArgs: WorkspaceEntityMetadataArgs | undefined,
args: T,
context: WorkspaceSyncContext,
featureFlagsMap: FeatureFlagMap,
) => U[],
): U[] {
return metadataArgs
.flatMap((args) =>
createMetadata(
workspaceEntityMetadataArgs,
args,
context,
featureFlagsMap,
),
)
.filter(Boolean) as U[];
}
/**
* Create field metadata
*/
private createFieldMetadata(
workspaceEntityMetadataArgs: WorkspaceEntityMetadataArgs | undefined,
workspaceFieldMetadataArgs: WorkspaceFieldMetadataArgs,
context: WorkspaceSyncContext,
workspaceFeatureFlagsMap: FeatureFlagMap,
): PartialComputedFieldMetadata | undefined {
): PartialFieldMetadata[] {
if (
!reflectDynamicRelationFieldMetadata ||
isGatedAndNotEnabled(
reflectDynamicRelationFieldMetadata.gate,
workspaceFieldMetadataArgs.gate,
workspaceFeatureFlagsMap,
)
) {
return undefined;
return [];
}
return {
...reflectDynamicRelationFieldMetadata,
return [
{
type: workspaceFieldMetadataArgs.type,
standardId: workspaceFieldMetadataArgs.standardId,
name: workspaceFieldMetadataArgs.name,
icon: workspaceFieldMetadataArgs.icon,
label: workspaceFieldMetadataArgs.label,
description: workspaceFieldMetadataArgs.description,
defaultValue: workspaceFieldMetadataArgs.defaultValue,
options: workspaceFieldMetadataArgs.options,
workspaceId: context.workspaceId,
isNullable: workspaceFieldMetadataArgs.isNullable,
isCustom: false,
isSystem:
workspaceEntityMetadataArgs?.isSystem ||
workspaceFieldMetadataArgs.isSystem,
},
];
}
/**
* Create relation field metadata
*/
private createFieldRelationMetadata(
workspaceEntityMetadataArgs: WorkspaceEntityMetadataArgs | undefined,
workspaceRelationMetadataArgs: WorkspaceRelationMetadataArgs,
context: WorkspaceSyncContext,
workspaceFeatureFlagsMap: FeatureFlagMap,
): PartialFieldMetadata[] {
const fieldMetadataCollection: PartialFieldMetadata[] = [];
const foreignKeyStandardId = createDeterministicUuid(
workspaceRelationMetadataArgs.standardId,
);
if (
isGatedAndNotEnabled(
workspaceRelationMetadataArgs.gate,
workspaceFeatureFlagsMap,
)
) {
return [];
}
if (workspaceRelationMetadataArgs.joinColumn) {
fieldMetadataCollection.push({
type: FieldMetadataType.UUID,
standardId: foreignKeyStandardId,
name: workspaceRelationMetadataArgs.joinColumn,
label: `${workspaceRelationMetadataArgs.label} id (foreign key)`,
description: `${workspaceRelationMetadataArgs.description} id foreign key`,
icon: workspaceRelationMetadataArgs.icon,
defaultValue: null,
options: undefined,
settings: undefined,
workspaceId: context.workspaceId,
isCustom: false,
isSystem: true,
isNullable: workspaceRelationMetadataArgs.isNullable,
});
}
fieldMetadataCollection.push({
type: FieldMetadataType.RELATION,
standardId: workspaceRelationMetadataArgs.standardId,
name: workspaceRelationMetadataArgs.name,
label: workspaceRelationMetadataArgs.label,
description: workspaceRelationMetadataArgs.description,
icon: workspaceRelationMetadataArgs.icon,
defaultValue: null,
workspaceId: context.workspaceId,
isSystem: reflectDynamicRelationFieldMetadata.isSystem,
};
isCustom: false,
isSystem:
workspaceEntityMetadataArgs?.isSystem ||
workspaceRelationMetadataArgs.isSystem,
isNullable: true,
});
return fieldMetadataCollection;
}
/**
* Create computed field relation metadata
*/
private createComputedFieldRelationMetadata(
workspaceEntityMetadataArgs: WorkspaceEntityMetadataArgs | undefined,
workspaceDynamicRelationMetadataArgs:
| WorkspaceDynamicRelationMetadataArgs
| undefined,
context: WorkspaceSyncContext,
workspaceFeatureFlagsMap: FeatureFlagMap,
): PartialComputedFieldMetadata[] {
if (
!workspaceDynamicRelationMetadataArgs ||
isGatedAndNotEnabled(
workspaceDynamicRelationMetadataArgs.gate,
workspaceFeatureFlagsMap,
)
) {
return [];
}
return [
// Foreign key will be computed in compute-standard-object.util.ts, because we need to know the custom object
{
type: FieldMetadataType.RELATION,
argsFactory: workspaceDynamicRelationMetadataArgs.argsFactory,
workspaceId: context.workspaceId,
isCustom: false,
isSystem:
workspaceEntityMetadataArgs?.isSystem ||
workspaceDynamicRelationMetadataArgs.isSystem,
isNullable: workspaceDynamicRelationMetadataArgs.isNullable,
},
];
}
}

31
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/factories/standard-object.factory.ts
View File

@ -4,9 +4,9 @@ import { WorkspaceSyncContext } from 'src/engine/workspace-manager/workspace-syn
import { PartialObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/partial-object-metadata.interface';
import { FeatureFlagMap } from 'src/engine/core-modules/feature-flag/interfaces/feature-flag-map.interface';
import { BaseObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-objects/base.object-metadata';
import { TypedReflect } from 'src/utils/typed-reflect';
import { isGatedAndNotEnabled } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/is-gate-and-not-enabled.util';
import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
import { metadataArgsStorage } from 'src/engine/twenty-orm/storage/metadata-args.storage';
import { StandardFieldFactory } from './standard-field.factory';
@ -15,7 +15,7 @@ export class StandardObjectFactory {
constructor(private readonly standardFieldFactory: StandardFieldFactory) {}
create(
standardObjectMetadataDefinitions: (typeof BaseObjectMetadata)[],
standardObjectMetadataDefinitions: (typeof BaseWorkspaceEntity)[],
context: WorkspaceSyncContext,
workspaceFeatureFlagsMap: FeatureFlagMap,
): PartialObjectMetadata[] {
@ -27,32 +27,43 @@ export class StandardObjectFactory {
}
private createObjectMetadata(
metadata: typeof BaseObjectMetadata,
target: typeof BaseWorkspaceEntity,
context: WorkspaceSyncContext,
workspaceFeatureFlagsMap: FeatureFlagMap,
): PartialObjectMetadata | undefined {
const objectMetadata = TypedReflect.getMetadata('objectMetadata', metadata);
const workspaceEntityMetadataArgs =
metadataArgsStorage.filterEntities(target);
if (!objectMetadata) {
if (!workspaceEntityMetadataArgs) {
throw new Error(
`Object metadata decorator not found, can't parse ${metadata.name}`,
`Object metadata decorator not found, can't parse ${target.name}`,
);
}
if (isGatedAndNotEnabled(objectMetadata.gate, workspaceFeatureFlagsMap)) {
if (
isGatedAndNotEnabled(
workspaceEntityMetadataArgs.gate,
workspaceFeatureFlagsMap,
)
) {
return undefined;
}
const fields = this.standardFieldFactory.create(
metadata,
target,
context,
workspaceFeatureFlagsMap,
);
return {
...objectMetadata,
...workspaceEntityMetadataArgs,
// TODO: Remove targetTableName when we remove the old metadata
targetTableName: 'DEPRECATED',
workspaceId: context.workspaceId,
dataSourceId: context.dataSourceId,
isCustom: false,
isRemote: false,
isSystem: workspaceEntityMetadataArgs.isSystem ?? false,
fields,
};
}

99
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/factories/standard-relation.factory.ts
View File

@ -3,17 +3,20 @@ import { Injectable } from '@nestjs/common';
import { WorkspaceSyncContext } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/workspace-sync-context.interface';
import { FeatureFlagMap } from 'src/engine/core-modules/feature-flag/interfaces/feature-flag-map.interface';
import { BaseObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-objects/base.object-metadata';
import { TypedReflect } from 'src/utils/typed-reflect';
import { isGatedAndNotEnabled } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/is-gate-and-not-enabled.util';
import { assert } from 'src/utils/assert';
import { RelationMetadataEntity } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
import {
RelationMetadataEntity,
RelationMetadataType,
} from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { convertClassNameToObjectMetadataName } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/convert-class-to-object-metadata-name.util';
import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
import { metadataArgsStorage } from 'src/engine/twenty-orm/storage/metadata-args.storage';
interface CustomRelationFactory {
object: ObjectMetadataEntity;
metadata: typeof BaseObjectMetadata;
metadata: typeof BaseWorkspaceEntity;
}
@Injectable()
@ -26,7 +29,7 @@ export class StandardRelationFactory {
): Partial<RelationMetadataEntity>[];
create(
standardObjectMetadataDefinitions: (typeof BaseObjectMetadata)[],
standardObjectMetadataDefinitions: (typeof BaseWorkspaceEntity)[],
context: WorkspaceSyncContext,
originalObjectMetadataMap: Record<string, ObjectMetadataEntity>,
workspaceFeatureFlagsMap: FeatureFlagMap,
@ -34,10 +37,10 @@ export class StandardRelationFactory {
create(
standardObjectMetadataDefinitionsOrCustomObjectFactories:
| (typeof BaseObjectMetadata)[]
| (typeof BaseWorkspaceEntity)[]
| {
object: ObjectMetadataEntity;
metadata: typeof BaseObjectMetadata;
metadata: typeof BaseWorkspaceEntity;
}[],
context: WorkspaceSyncContext,
originalObjectMetadataMap: Record<string, ObjectMetadataEntity>,
@ -46,7 +49,7 @@ export class StandardRelationFactory {
return standardObjectMetadataDefinitionsOrCustomObjectFactories.flatMap(
(
standardObjectMetadata:
| typeof BaseObjectMetadata
| typeof BaseWorkspaceEntity
| CustomRelationFactory,
) =>
this.createRelationMetadata(
@ -59,64 +62,68 @@ export class StandardRelationFactory {
}
private createRelationMetadata(
standardObjectMetadataOrCustomRelationFactory:
| typeof BaseObjectMetadata
workspaceEntityOrCustomRelationFactory:
| typeof BaseWorkspaceEntity
| CustomRelationFactory,
context: WorkspaceSyncContext,
originalObjectMetadataMap: Record<string, ObjectMetadataEntity>,
workspaceFeatureFlagsMap: FeatureFlagMap,
): Partial<RelationMetadataEntity>[] {
const standardObjectMetadata =
'metadata' in standardObjectMetadataOrCustomRelationFactory
? standardObjectMetadataOrCustomRelationFactory.metadata
: standardObjectMetadataOrCustomRelationFactory;
const objectMetadata = TypedReflect.getMetadata(
'metadata' in standardObjectMetadataOrCustomRelationFactory
? 'extendObjectMetadata'
: 'objectMetadata',
standardObjectMetadata,
);
const reflectRelationMetadataCollection = TypedReflect.getMetadata(
'reflectRelationMetadataCollection',
standardObjectMetadata,
);
const target =
'metadata' in workspaceEntityOrCustomRelationFactory
? workspaceEntityOrCustomRelationFactory.metadata
: workspaceEntityOrCustomRelationFactory;
const workspaceEntity =
'metadata' in workspaceEntityOrCustomRelationFactory
? metadataArgsStorage.filterExtendedEntities(target)
: metadataArgsStorage.filterEntities(target);
const workspaceRelationMetadataArgsCollection =
metadataArgsStorage.filterRelations(target);
if (!objectMetadata) {
if (!workspaceEntity) {
throw new Error(
`Object metadata decorator not found, can't parse ${standardObjectMetadata.name}`,
`Object metadata decorator not found, can't parse ${target.name}`,
);
}
if (
!reflectRelationMetadataCollection ||
isGatedAndNotEnabled(objectMetadata?.gate, workspaceFeatureFlagsMap)
!workspaceRelationMetadataArgsCollection ||
isGatedAndNotEnabled(workspaceEntity?.gate, workspaceFeatureFlagsMap)
) {
return [];
}
return reflectRelationMetadataCollection
.filter(
(reflectRelationMetadata) =>
!isGatedAndNotEnabled(
reflectRelationMetadata.gate,
workspaceFeatureFlagsMap,
),
)
.map((reflectRelationMetadata) => {
return workspaceRelationMetadataArgsCollection
.filter((workspaceRelationMetadataArgs) => {
// We're not storing many-to-one relations in the DB for the moment
if (
workspaceRelationMetadataArgs.type ===
RelationMetadataType.MANY_TO_ONE
) {
return false;
}
return !isGatedAndNotEnabled(
workspaceRelationMetadataArgs.gate,
workspaceFeatureFlagsMap,
);
})
.map((workspaceRelationMetadataArgs) => {
// Compute reflect relation metadata
const fromObjectNameSingular =
'object' in standardObjectMetadataOrCustomRelationFactory
? standardObjectMetadataOrCustomRelationFactory.object.nameSingular
'object' in workspaceEntityOrCustomRelationFactory
? workspaceEntityOrCustomRelationFactory.object.nameSingular
: convertClassNameToObjectMetadataName(
reflectRelationMetadata.target.constructor.name,
workspaceRelationMetadataArgs.target.name,
);
const toObjectNameSingular = convertClassNameToObjectMetadataName(
reflectRelationMetadata.inverseSideTarget().name,
workspaceRelationMetadataArgs.inverseSideTarget().name,
);
const fromFieldMetadataName = reflectRelationMetadata.fieldKey;
const fromFieldMetadataName = workspaceRelationMetadataArgs.name;
const toFieldMetadataName =
(reflectRelationMetadata.inverseSideFieldKey as string | undefined) ??
fromObjectNameSingular;
(workspaceRelationMetadataArgs.inverseSideFieldKey as
| string
| undefined) ?? fromObjectNameSingular;
const fromObjectMetadata =
originalObjectMetadataMap[fromObjectNameSingular];
@ -156,13 +163,13 @@ export class StandardRelationFactory {
);
return {
relationType: reflectRelationMetadata.type,
relationType: workspaceRelationMetadataArgs.type,
fromObjectMetadataId: fromObjectMetadata?.id,
toObjectMetadataId: toObjectMetadata?.id,
fromFieldMetadataId: fromFieldMetadata?.id,
toFieldMetadataId: toFieldMetadata?.id,
workspaceId: context.workspaceId,
onDeleteAction: reflectRelationMetadata.onDelete,
onDeleteAction: workspaceRelationMetadataArgs.onDelete,
};
});
}

3
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/interfaces/gate-decorator.interface.ts
View File

@ -1,3 +0,0 @@
export interface GateDecoratorParams {
featureFlag: string;
}

30
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/interfaces/partial-field-metadata.interface.ts
View File

@ -1,19 +1,31 @@
import { ReflectDynamicRelationFieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-computed-relation-field-metadata.interface';
import { ReflectFieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-field-metadata.interface';
import { FieldMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata.interface';
import { WorkspaceDynamicRelationMetadataArgsFactory } from 'src/engine/twenty-orm/interfaces/workspace-dynamic-relation-metadata-args.interface';
import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
export type PartialFieldMetadata = Omit<
ReflectFieldMetadata[string],
'joinColumn'
FieldMetadataInterface,
'id' | 'label' | 'description' | 'objectMetadataId'
> & {
standardId: string;
label: string | ((objectMetadata: ObjectMetadataEntity) => string);
description?: string | ((objectMetadata: ObjectMetadataEntity) => string);
icon?: string;
isSystem?: boolean;
workspaceId: string;
objectMetadataId?: string;
};
export type PartialComputedFieldMetadata =
ReflectDynamicRelationFieldMetadata & {
workspaceId: string;
objectMetadataId?: string;
};
export type PartialComputedFieldMetadata = {
type: FieldMetadataType.RELATION;
argsFactory: WorkspaceDynamicRelationMetadataArgsFactory;
isNullable?: boolean;
isSystem?: boolean;
isCustom: boolean;
workspaceId: string;
objectMetadataId?: string;
};
export type ComputedPartialFieldMetadata = {
[K in keyof PartialFieldMetadata]: ExcludeFunctions<PartialFieldMetadata[K]>;

10
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/interfaces/partial-object-metadata.interface.ts
View File

@ -3,10 +3,14 @@ import {
PartialComputedFieldMetadata,
PartialFieldMetadata,
} from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/partial-field-metadata.interface';
import { ReflectObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-object-metadata.interface';
import { ObjectMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/object-metadata.interface';
export type PartialObjectMetadata = ReflectObjectMetadata & {
id?: string;
export type PartialObjectMetadata = Omit<
ObjectMetadataInterface,
'id' | 'standardId' | 'fromRelations' | 'toRelations' | 'fields' | 'isActive'
> & {
standardId: string;
icon?: string;
workspaceId: string;
dataSourceId: string;
fields: (PartialFieldMetadata | PartialComputedFieldMetadata)[];

10
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/interfaces/partial-relation-metadata.interface.ts
View File

@ -1,10 +0,0 @@
import { ReflectRelationMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-relation-metadata.interface';
export type PartialRelationMetadata = ReflectRelationMetadata & {
id: string;
workspaceId: string;
fromObjectMetadataId: string;
toObjectMetadataId: string;
fromFieldMetadataId: string;
toFieldMetadataId: string;
};

24
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-computed-relation-field-metadata.interface.ts
View File

@ -1,24 +0,0 @@
import { GateDecoratorParams } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/gate-decorator.interface';
import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
export type DynamicRelationFieldMetadataDecoratorParams = (
oppositeObjectMetadata: ObjectMetadataEntity,
) => {
standardId: string;
name: string;
label: string;
joinColumn: string;
description?: string;
icon?: string;
};
export interface ReflectDynamicRelationFieldMetadata {
type: FieldMetadataType.RELATION;
paramsFactory: DynamicRelationFieldMetadataDecoratorParams;
isNullable: boolean;
isSystem: boolean;
isCustom: boolean;
gate?: GateDecoratorParams;
}

10
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-custom-object-metadata.interface.ts
View File

@ -1,10 +0,0 @@
import { GateDecoratorParams } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/gate-decorator.interface';
export type BaseCustomObjectMetadataDecoratorParams =
| { allowObjectNameList?: string[] }
| { denyObjectNameList?: string[] };
export type ReflectBaseCustomObjectMetadata =
BaseCustomObjectMetadataDecoratorParams & {
gate?: GateDecoratorParams;
};

38
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-field-metadata.interface.ts
View File

@ -1,38 +0,0 @@
import { FieldMetadataDefaultValue } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata-default-value.interface';
import { GateDecoratorParams } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/gate-decorator.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 { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
export interface FieldMetadataDecoratorParams<
T extends FieldMetadataType | 'default',
> {
standardId: string;
type: T;
label: string | ((objectMetadata: ObjectMetadataEntity) => string);
description?: string | ((objectMetadata: ObjectMetadataEntity) => string);
icon?: string;
defaultValue?: FieldMetadataDefaultValue<T>;
joinColumn?: string;
options?: FieldMetadataOptions<T>;
settings?: FieldMetadataSettings<T>;
}
export interface ReflectFieldMetadata {
[key: string]: Omit<
FieldMetadataDecoratorParams<'default'>,
'defaultValue' | 'type' | 'options' | 'settings'
> & {
name: string;
type: FieldMetadataType;
isNullable: boolean;
isSystem: boolean;
isCustom: boolean;
defaultValue: FieldMetadataDefaultValue<'default'> | null;
gate?: GateDecoratorParams;
options?: FieldMetadataOptions<'default'> | null;
settings?: FieldMetadataSettings<'default'> | null;
};
}

20
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-object-metadata.interface.ts
View File

@ -1,20 +0,0 @@
import { GateDecoratorParams } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/gate-decorator.interface';
export interface ObjectMetadataDecoratorParams {
standardId: string;
namePlural: string;
labelSingular: string;
labelPlural: string;
description?: string;
icon?: string;
}
export interface ReflectObjectMetadata extends ObjectMetadataDecoratorParams {
nameSingular: string;
targetTableName: string;
isSystem: boolean;
isCustom: boolean;
isRemote: boolean;
isAuditLogged: boolean;
gate?: GateDecoratorParams;
}

23
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/interfaces/reflect-relation-metadata.interface.ts
View File

@ -1,23 +0,0 @@
import { ObjectType } from 'typeorm';
import { GateDecoratorParams } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/gate-decorator.interface';
import {
RelationOnDeleteAction,
RelationMetadataType,
} from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
export interface RelationMetadataDecoratorParams<T> {
type: RelationMetadataType;
inverseSideTarget: () => ObjectType<T>;
inverseSideFieldKey?: keyof T;
onDelete: RelationOnDeleteAction;
}
export interface ReflectRelationMetadata
extends RelationMetadataDecoratorParams<any> {
target: object;
fieldKey: string;
gate?: GateDecoratorParams;
onDelete: RelationOnDeleteAction;
}

4
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/services/workspace-sync-field-metadata.service.ts
View File

@ -14,7 +14,7 @@ import { WorkspaceMetadataUpdaterService } from 'src/engine/workspace-manager/wo
import { WorkspaceSyncStorage } from 'src/engine/workspace-manager/workspace-sync-metadata/storage/workspace-sync.storage';
import { WorkspaceMigrationFieldFactory } from 'src/engine/workspace-manager/workspace-migration-builder/factories/workspace-migration-field.factory';
import { StandardFieldFactory } from 'src/engine/workspace-manager/workspace-sync-metadata/factories/standard-field.factory';
import { CustomObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/custom-objects/custom.object-metadata';
import { CustomWorkspaceEntity } from 'src/engine/twenty-orm/custom.workspace-entity';
import { computeStandardObject } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/compute-standard-object.util';
@Injectable()
@ -56,7 +56,7 @@ export class WorkspaceSyncFieldMetadataService {
// Create standard field metadata collection
const standardFieldMetadataCollection = this.standardFieldFactory.create(
CustomObjectMetadata,
CustomWorkspaceEntity,
context,
workspaceFeatureFlagsMap,
);

4
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/services/workspace-sync-relation-metadata.service.ts
View File

@ -17,7 +17,7 @@ import { WorkspaceMigrationEntity } from 'src/engine/metadata-modules/workspace-
import { WorkspaceSyncStorage } from 'src/engine/workspace-manager/workspace-sync-metadata/storage/workspace-sync.storage';
import { WorkspaceMigrationRelationFactory } from 'src/engine/workspace-manager/workspace-migration-builder/factories/workspace-migration-relation.factory';
import { standardObjectMetadataDefinitions } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-objects';
import { CustomObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/custom-objects/custom.object-metadata';
import { CustomWorkspaceEntity } from 'src/engine/twenty-orm/custom.workspace-entity';
@Injectable()
export class WorkspaceSyncRelationMetadataService {
@ -88,7 +88,7 @@ export class WorkspaceSyncRelationMetadataService {
this.standardRelationFactory.create(
customObjectMetadataCollection.map((objectMetadata) => ({
object: objectMetadata,
metadata: CustomObjectMetadata,
metadata: CustomWorkspaceEntity,
})),
context,
originalObjectMetadataMap,

38
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/standard-objects/base.object-metadata.ts
View File

@ -1,38 +0,0 @@
import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { BASE_OBJECT_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
import { FieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/field-metadata.decorator';
import { IsSystem } from 'src/engine/workspace-manager/workspace-sync-metadata/decorators/is-system.decorator';
export abstract class BaseObjectMetadata {
@FieldMetadata({
standardId: BASE_OBJECT_STANDARD_FIELD_IDS.id,
type: FieldMetadataType.UUID,
label: 'Id',
description: 'Id',
defaultValue: 'uuid',
icon: 'Icon123',
})
@IsSystem()
id: string;
@FieldMetadata({
standardId: BASE_OBJECT_STANDARD_FIELD_IDS.createdAt,
type: FieldMetadataType.DATE_TIME,
label: 'Creation date',
description: 'Creation date',
icon: 'IconCalendar',
defaultValue: 'now',
})
createdAt: Date;
@FieldMetadata({
standardId: BASE_OBJECT_STANDARD_FIELD_IDS.updatedAt,
type: FieldMetadataType.DATE_TIME,
label: 'Update date',
description: 'Update date',
icon: 'IconCalendar',
defaultValue: 'now',
})
@IsSystem()
updatedAt: Date;
}

5
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/storage/workspace-sync.storage.ts
View File

@ -1,6 +1,5 @@
import { ComputedPartialObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/partial-object-metadata.interface';
import { ComputedPartialFieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/partial-field-metadata.interface';
import { PartialRelationMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/partial-relation-metadata.interface';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
@ -28,7 +27,7 @@ export class WorkspaceSyncStorage {
[];
private readonly _relationMetadataDeleteCollection: RelationMetadataEntity[] =
[];
private readonly _relationMetadataUpdateCollection: Partial<PartialRelationMetadata>[] =
private readonly _relationMetadataUpdateCollection: Partial<RelationMetadataEntity>[] =
[];
constructor() {}
@ -101,7 +100,7 @@ export class WorkspaceSyncStorage {
this._relationMetadataCreateCollection.push(relation);
}
addUpdateRelationMetadata(relation: Partial<PartialRelationMetadata>) {
addUpdateRelationMetadata(relation: Partial<RelationMetadataEntity>) {
this._relationMetadataUpdateCollection.push(relation);
}

10
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/types/object-record.ts
View File

@ -1,9 +1,9 @@
import { BaseObjectMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-objects/base.object-metadata';
import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
export type ObjectRecord<T extends BaseObjectMetadata> = {
[K in keyof T as T[K] extends BaseObjectMetadata
export type ObjectRecord<T extends BaseWorkspaceEntity> = {
[K in keyof T as T[K] extends BaseWorkspaceEntity
? `${Extract<K, string>}Id`
: K]: T[K] extends BaseObjectMetadata ? string : T[K];
: K]: T[K] extends BaseWorkspaceEntity ? string : T[K];
} & {
[K in keyof T]: T[K] extends BaseObjectMetadata ? ObjectRecord<T[K]> : T[K];
[K in keyof T]: T[K] extends BaseWorkspaceEntity ? ObjectRecord<T[K]> : T[K];
};

12
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/utils/compute-standard-object.util.ts
View File

@ -21,11 +21,11 @@ export const computeStandardObject = (
const fields: ComputedPartialFieldMetadata[] = [];
for (const partialFieldMetadata of standardObjectMetadata.fields) {
if ('paramsFactory' in partialFieldMetadata) {
if ('argsFactory' in partialFieldMetadata) {
// Compute standard fields of custom object
for (const customObjectMetadata of customObjectMetadataCollection) {
const { paramsFactory, ...rest } = partialFieldMetadata;
const { joinColumn, ...data } = paramsFactory(customObjectMetadata);
const { argsFactory, ...rest } = partialFieldMetadata;
const { joinColumn, ...data } = argsFactory(customObjectMetadata);
const relationStandardId = createRelationDeterministicUuid({
objectId: customObjectMetadata.id,
standardId: data.standardId,
@ -35,6 +35,12 @@ export const computeStandardObject = (
standardId: data.standardId,
});
if (!joinColumn) {
throw new Error(
`Missing joinColumn for field ${data.name} in object ${customObjectMetadata.nameSingular}`,
);
}
// Relation
fields.push({
...data,

4
packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/utils/is-gate-and-not-enabled.util.ts
View File

@ -1,7 +1,7 @@
import { GateDecoratorParams } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/gate-decorator.interface';
import { Gate } from 'src/engine/twenty-orm/interfaces/gate.interface';
export const isGatedAndNotEnabled = (
gate: GateDecoratorParams | undefined,
gate: Gate | undefined,
workspaceFeatureFlagsMap: Record<string, boolean>,
): boolean => {
const featureFlagValue =