twentyhq/twenty
1
1
Fork 0
mirror of https://github.com/twentyhq/twenty.git synced 2024-12-23 03:51:36 +03:00
Code Issues Packages Projects Releases Wiki Activity

feat: standard fields on custom (#4332)

Browse Source 
* feat: add ability to sync standard fields on custom object

* fix: clean

* fix: wrong compute during object creation

* fix: missing cascade delete

* fix: remove unused injected class

* fix: naming

* fix: rename factory to paramsFactory and clean

* fix: rename ExtendCustomObjectMetadata to BaseCustomObjectMetadata

* fix: partial fix inconsistent label and description

* Fixes

* Fix

---------

Co-authored-by: Charles Bochet <charles@twenty.com>
This commit is contained in:
Jérémy M 2024-03-07 17:21:50 +01:00 committed by GitHub
parent c3a024b047
commit af6ffbcc68
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
54 changed files with 923 additions and 250 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
.vscode/twenty.code-workspace vendored
View File

@ -42,10 +42,59 @@
},
],
"settings": {
"editor.formatOnSave": false,
"files.eol": "auto",
"[typescript]": {
"editor.formatOnSave": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true,
"source.addMissingImports": "always"
}
},
"[javascript]": {
"editor.formatOnSave": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true,
"source.addMissingImports": "always"
}
},
"[typescriptreact]": {
"editor.formatOnSave": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true,
"source.addMissingImports": "always"
}
},
"[json]": {
"editor.formatOnSave": true
},
"javascript.format.enable": false,
"typescript.format.enable": false,
"cSpell.enableFiletypes": [
"!javascript",
"!json",
"!typescript",
"!typescriptreact",
"md",
"mdx"
],
"cSpell.words": [
"twentyhq"
],
"typescript.preferences.importModuleSpecifier": "non-relative",
"[javascript][typescript][typescriptreact]": {
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit",
"source.addMissingImports": "always"
}
},
"search.exclude": {
"**/.yarn": true,
},
"files.exclude": {
"packages/": true
},
"jest.autoEnable": false,
"jest.runMode": "on-demand",
"jest.disabledWorkspaceFolders": [
"ROOT",
"packages/twenty-zapier",

1
packages/twenty-front/src/modules/activities/hooks/useInjectIntoActivityTargetsQueries.ts
View File

@ -72,6 +72,7 @@ export const useInjectIntoActivityTargetsQueries = () => {
overwriteFindManyActivityTargetsQueryInCache({
objectRecordsToOverwrite: newActivityTargets,
queryVariables: findManyActivitiyTargetsQueryVariables,
depth: 2,
});
};

1
packages/twenty-front/src/modules/activities/hooks/useRemoveFromActivityTargetsQueries.ts
View File

@ -63,6 +63,7 @@ export const useRemoveFromActivityTargetsQueries = () => {
overwriteFindManyActivityTargetsQueryInCache({
objectRecordsToOverwrite: newActivityTargetsForTargetableObject,
queryVariables: findManyActivityTargetsQueryVariables,
depth: 2,
});
};

1
packages/twenty-front/src/modules/activities/inline-cell/hooks/useInjectIntoActivityTargetInlineCellCache.ts
View File

@ -34,6 +34,7 @@ export const useInjectIntoActivityTargetInlineCellCache = () => {
overwriteFindManyActivityTargetsQueryInCache({
queryVariables: activityTargetInlineCellQueryVariables,
objectRecordsToOverwrite: activityTargetsToInject,
depth: 2,
});
};

4
packages/twenty-front/src/modules/object-record/cache/hooks/useUpsertFindManyRecordsQueryInCache.ts vendored
View File

@ -20,14 +20,16 @@ export const useUpsertFindManyRecordsQueryInCache = ({
T extends ObjectRecord = ObjectRecord,
>({
queryVariables,
depth = MAX_QUERY_DEPTH_FOR_CACHE_INJECTION,
objectRecordsToOverwrite,
}: {
queryVariables: ObjectRecordQueryVariables;
depth?: number;
objectRecordsToOverwrite: T[];
}) => {
const findManyRecordsQueryForCacheOverwrite = generateFindManyRecordsQuery({
objectMetadataItem,
depth: MAX_QUERY_DEPTH_FOR_CACHE_INJECTION, // TODO: fix this
depth, // TODO: fix this
});
const newObjectRecordConnection = getRecordConnectionFromRecords({

3
packages/twenty-server/@types/common.d.ts vendored
View File

@ -3,3 +3,6 @@ type DeepPartial<T> = {
? Array<DeepPartial<R>>
: DeepPartial<T[K]>;
};
// eslint-disable-next-line @typescript-eslint/ban-types
type ExcludeFunctions<T> = T extends Function ? never : T;

1
packages/twenty-server/package.json
View File

@ -28,6 +28,7 @@
"database:seed:dev": "npx nx command -- workspace:seed:dev",
"database:seed:demo": "npx nx command -- workspace:seed:demo",
"database:reset": "npx nx database:truncate && npx nx database:init",
"command": "node dist/src/command",
"queue:work": "node dist/src/queue-worker"
},
"dependencies": {

10
packages/twenty-server/src/database/commands/data-seed-dev-workspace.command.ts
View File

@ -61,12 +61,10 @@ export class DataSeedWorkspaceCommand extends CommandRunner {
schemaName,
);
await this.workspaceSyncMetadataService.syncStandardObjectsAndFieldsMetadata(
{
workspaceId: this.workspaceId,
dataSourceId: dataSourceMetadata.id,
},
);
await this.workspaceSyncMetadataService.synchronize({
workspaceId: this.workspaceId,
dataSourceId: dataSourceMetadata.id,
});
} catch (error) {
console.error(error);

64
packages/twenty-server/src/metadata/object-metadata/object-metadata.service.ts
View File

@ -340,8 +340,9 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
columns: [
{
action: WorkspaceMigrationColumnActionType.CREATE,
columnName: `${computeObjectTargetTable(
createdObjectMetadata,
columnName: `${computeCustomName(
createdObjectMetadata.nameSingular,
false,
)}Id`,
columnType: 'uuid',
isNullable: true,
@ -354,8 +355,9 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
columns: [
{
action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
columnName: `${computeObjectTargetTable(
createdObjectMetadata,
columnName: `${computeCustomName(
createdObjectMetadata.nameSingular,
false,
)}Id`,
referencedTableName: computeObjectTargetTable(
createdObjectMetadata,
@ -372,8 +374,9 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
columns: [
{
action: WorkspaceMigrationColumnActionType.CREATE,
columnName: `${computeObjectTargetTable(
createdObjectMetadata,
columnName: `${computeCustomName(
createdObjectMetadata.nameSingular,
false,
)}Id`,
columnType: 'uuid',
isNullable: true,
@ -386,8 +389,9 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
columns: [
{
action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
columnName: `${computeObjectTargetTable(
createdObjectMetadata,
columnName: `${computeCustomName(
createdObjectMetadata.nameSingular,
false,
)}Id`,
referencedTableName: computeObjectTargetTable(
createdObjectMetadata,
@ -403,8 +407,9 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
columns: [
{
action: WorkspaceMigrationColumnActionType.CREATE,
columnName: `${computeObjectTargetTable(
createdObjectMetadata,
columnName: `${computeCustomName(
createdObjectMetadata.nameSingular,
false,
)}Id`,
columnType: 'uuid',
isNullable: true,
@ -417,8 +422,9 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
columns: [
{
action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
columnName: `${computeObjectTargetTable(
createdObjectMetadata,
columnName: `${computeCustomName(
createdObjectMetadata.nameSingular,
false,
)}Id`,
referencedTableName: computeObjectTargetTable(
createdObjectMetadata,
@ -582,7 +588,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
{
objectMetadataId: createdObjectMetadata.id,
workspaceId: workspaceId,
isCustom: true,
isCustom: false,
isActive: true,
type: FieldMetadataType.RELATION,
name: 'activityTargets',
@ -596,7 +602,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
{
objectMetadataId: activityTargetObjectMetadata.id,
workspaceId: workspaceId,
isCustom: true,
isCustom: false,
isActive: true,
type: FieldMetadataType.RELATION,
name: createdObjectMetadata.nameSingular,
@ -610,13 +616,16 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
{
objectMetadataId: activityTargetObjectMetadata.id,
workspaceId: workspaceId,
isCustom: true,
isCustom: false,
isActive: true,
type: FieldMetadataType.UUID,
name: `${createdObjectMetadata.nameSingular}Id`,
label: `${createdObjectMetadata.labelSingular} ID (foreign key)`,
targetColumnMap: {
value: `${computeObjectTargetTable(createdObjectMetadata)}Id`,
value: `${computeCustomName(
createdObjectMetadata.nameSingular,
false,
)}Id`,
},
description: `ActivityTarget ${createdObjectMetadata.labelSingular} id foreign key`,
icon: undefined,
@ -673,7 +682,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
{
objectMetadataId: createdObjectMetadata.id,
workspaceId: workspaceId,
isCustom: true,
isCustom: false,
isActive: true,
type: FieldMetadataType.RELATION,
name: 'attachments',
@ -687,7 +696,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
{
objectMetadataId: attachmentObjectMetadata.id,
workspaceId: workspaceId,
isCustom: true,
isCustom: false,
isActive: true,
type: FieldMetadataType.RELATION,
name: createdObjectMetadata.nameSingular,
@ -701,13 +710,16 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
{
objectMetadataId: attachmentObjectMetadata.id,
workspaceId: workspaceId,
isCustom: true,
isCustom: false,
isActive: true,
type: FieldMetadataType.UUID,
name: `${createdObjectMetadata.nameSingular}Id`,
label: `${createdObjectMetadata.labelSingular} ID (foreign key)`,
targetColumnMap: {
value: `${computeObjectTargetTable(createdObjectMetadata)}Id`,
value: `${computeCustomName(
createdObjectMetadata.nameSingular,
false,
)}Id`,
},
description: `Attachment ${createdObjectMetadata.labelSingular} id foreign key`,
icon: undefined,
@ -739,6 +751,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
attachmentRelationFieldMetadataMap[createdObjectMetadata.id].id,
toFieldMetadataId:
attachmentRelationFieldMetadataMap[attachmentObjectMetadata.id].id,
onDeleteAction: RelationOnDeleteAction.CASCADE,
},
]);
@ -761,7 +774,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
{
objectMetadataId: createdObjectMetadata.id,
workspaceId: workspaceId,
isCustom: true,
isCustom: false,
isActive: true,
type: FieldMetadataType.RELATION,
name: 'favorites',
@ -775,7 +788,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
{
objectMetadataId: favoriteObjectMetadata.id,
workspaceId: workspaceId,
isCustom: true,
isCustom: false,
isActive: true,
type: FieldMetadataType.RELATION,
name: createdObjectMetadata.nameSingular,
@ -789,13 +802,16 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
{
objectMetadataId: favoriteObjectMetadata.id,
workspaceId: workspaceId,
isCustom: true,
isCustom: false,
isActive: true,
type: FieldMetadataType.UUID,
name: `${createdObjectMetadata.nameSingular}Id`,
label: `${createdObjectMetadata.labelSingular} ID (foreign key)`,
targetColumnMap: {
value: `${computeObjectTargetTable(createdObjectMetadata)}Id`,
value: `${computeCustomName(
createdObjectMetadata.nameSingular,
false,
)}Id`,
},
description: `Favorite ${createdObjectMetadata.labelSingular} id foreign key`,
icon: undefined,

6
packages/twenty-server/src/utils/typed-reflect.ts
View File

@ -1,14 +1,18 @@
import 'reflect-metadata';
import { GateDecoratorParams } from 'src/workspace/workspace-sync-metadata/interfaces/gate-decorator.interface';
import { ReflectBaseCustomObjectMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/reflect-custom-object-metadata.interface';
import { ReflectDynamicRelationFieldMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/reflect-computed-relation-field-metadata.interface';
import { ReflectFieldMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/reflect-field-metadata.interface';
import { ReflectObjectMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/reflect-object-metadata.interface';
import { ReflectRelationMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/reflect-relation-metadata.interface';
export interface ReflectMetadataTypeMap {
objectMetadata: ReflectObjectMetadata;
extendObjectMetadata: ReflectBaseCustomObjectMetadata;
fieldMetadataMap: ReflectFieldMetadata;
relationMetadataCollection: ReflectRelationMetadata[];
dynamicRelationFieldMetadataMap: ReflectDynamicRelationFieldMetadata;
reflectRelationMetadataCollection: ReflectRelationMetadata[];
gate: GateDecoratorParams;
isNullable: true;
isSystem: true;

20
packages/twenty-server/src/workspace/workspace-manager/workspace-manager.service.ts
View File

@ -38,12 +38,10 @@ export class WorkspaceManagerService {
await this.setWorkspaceMaxRow(workspaceId, schemaName);
await this.workspaceSyncMetadataService.syncStandardObjectsAndFieldsMetadata(
{
workspaceId,
dataSourceId: dataSourceMetadata.id,
},
);
await this.workspaceSyncMetadataService.synchronize({
workspaceId,
dataSourceId: dataSourceMetadata.id,
});
await this.prefillWorkspaceWithStandardObjects(
dataSourceMetadata,
@ -70,12 +68,10 @@ export class WorkspaceManagerService {
await this.setWorkspaceMaxRow(workspaceId, schemaName);
await this.workspaceSyncMetadataService.syncStandardObjectsAndFieldsMetadata(
{
workspaceId,
dataSourceId: dataSourceMetadata.id,
},
);
await this.workspaceSyncMetadataService.synchronize({
workspaceId,
dataSourceId: dataSourceMetadata.id,
});
await this.prefillWorkspaceWithDemoObjects(dataSourceMetadata, workspaceId);
}

2
packages/twenty-server/src/workspace/workspace-sync-metadata/commands/sync-workspace-metadata.command.ts
View File

@ -72,7 +72,7 @@ export class SyncWorkspaceMetadataCommand extends CommandRunner {
);
const { storage, workspaceMigrations } =
await this.workspaceSyncMetadataService.syncStandardObjectsAndFieldsMetadata(
await this.workspaceSyncMetadataService.synchronize(
{
workspaceId,
dataSourceId: dataSourceMetadata.id,

10
packages/twenty-server/src/workspace/workspace-sync-metadata/comparators/workspace-field.comparator.ts
View File

@ -6,8 +6,8 @@ import {
ComparatorAction,
FieldComparatorResult,
} from 'src/workspace/workspace-sync-metadata/interfaces/comparator.interface';
import { PartialFieldMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-field-metadata.interface';
import { PartialObjectMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-object-metadata.interface';
import { ComputedPartialFieldMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-field-metadata.interface';
import { ComputedPartialObjectMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-object-metadata.interface';
import { ObjectMetadataEntity } from 'src/metadata/object-metadata/object-metadata.entity';
import { transformMetadataForComparison } from 'src/workspace/workspace-sync-metadata/comparators/utils/transform-metadata-for-comparison.util';
@ -30,12 +30,12 @@ export class WorkspaceFieldComparator {
public compare(
originalObjectMetadata: ObjectMetadataEntity,
standardObjectMetadata: PartialObjectMetadata,
standardObjectMetadata: ComputedPartialObjectMetadata,
): FieldComparatorResult[] {
const result: FieldComparatorResult[] = [];
const fieldPropertiesToUpdateMap: Record<
string,
Partial<PartialFieldMetadata>
Partial<ComputedPartialFieldMetadata>
> = {};
// Double security to only compare non-custom fields
@ -69,7 +69,7 @@ export class WorkspaceFieldComparator {
standardObjectMetadata.fields,
{
shouldIgnoreProperty: (property, originalMetadata) => {
if (['options'].includes(property)) {
if (['options', 'gate'].includes(property)) {
return true;
}

6
packages/twenty-server/src/workspace/workspace-sync-metadata/comparators/workspace-object.comparator.ts
View File

@ -7,7 +7,7 @@ import {
ComparatorAction,
ObjectComparatorResult,
} from 'src/workspace/workspace-sync-metadata/interfaces/comparator.interface';
import { PartialObjectMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-object-metadata.interface';
import { ComputedPartialObjectMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-object-metadata.interface';
import { transformMetadataForComparison } from 'src/workspace/workspace-sync-metadata/comparators/utils/transform-metadata-for-comparison.util';
import { ObjectMetadataEntity } from 'src/metadata/object-metadata/object-metadata.entity';
@ -28,7 +28,7 @@ export class WorkspaceObjectComparator {
public compare(
originalObjectMetadata: ObjectMetadataEntity | undefined,
standardObjectMetadata: PartialObjectMetadata,
standardObjectMetadata: ComputedPartialObjectMetadata,
): ObjectComparatorResult {
// If the object doesn't exist in the original metadata, we need to create it
if (!originalObjectMetadata) {
@ -38,7 +38,7 @@ export class WorkspaceObjectComparator {
};
}
const objectPropertiesToUpdate: Partial<PartialObjectMetadata> = {};
const objectPropertiesToUpdate: Partial<ComputedPartialObjectMetadata> = {};
// Only compare properties that are not ignored
const partialOriginalObjectMetadata = transformMetadataForComparison(

81
packages/twenty-server/src/workspace/workspace-sync-metadata/custom-objects/custom.object-metadata.ts Normal file
View File

@ -0,0 +1,81 @@
import { BaseCustomObjectMetadata } from 'src/workspace/workspace-sync-metadata/decorators/base-custom-object-metadata.decorator';
import { FieldMetadata } from 'src/workspace/workspace-sync-metadata/decorators/field-metadata.decorator';
import { FieldMetadataType } from 'src/metadata/field-metadata/field-metadata.entity';
import { IsNullable } from 'src/workspace/workspace-sync-metadata/decorators/is-nullable.decorator';
import { IsSystem } from 'src/workspace/workspace-sync-metadata/decorators/is-system.decorator';
import { BaseObjectMetadata } from 'src/workspace/workspace-sync-metadata/standard-objects/base.object-metadata';
import {
RelationMetadataType,
RelationOnDeleteAction,
} from 'src/metadata/relation-metadata/relation-metadata.entity';
import { ActivityTargetObjectMetadata } from 'src/workspace/workspace-sync-metadata/standard-objects/activity-target.object-metadata';
import { RelationMetadata } from 'src/workspace/workspace-sync-metadata/decorators/relation-metadata.decorator';
import { FavoriteObjectMetadata } from 'src/workspace/workspace-sync-metadata/standard-objects/favorite.object-metadata';
import { AttachmentObjectMetadata } from 'src/workspace/workspace-sync-metadata/standard-objects/attachment.object-metadata';
@BaseCustomObjectMetadata()
export class CustomObjectMetadata extends BaseObjectMetadata {
@FieldMetadata({
label: 'Name',
description: 'Name',
type: FieldMetadataType.TEXT,
icon: 'IconAbc',
defaultValue: { value: 'Untitled' },
})
name: string;
@FieldMetadata({
label: 'Position',
description: 'Position',
type: FieldMetadataType.POSITION,
icon: 'IconHierarchy2',
})
@IsNullable()
@IsSystem()
position: number;
@FieldMetadata({
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({
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()
favorites: FavoriteObjectMetadata[];
@FieldMetadata({
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[];
}

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

@ -0,0 +1,20 @@
import { BaseCustomObjectMetadataDecoratorParams } from 'src/workspace/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/workspace/workspace-sync-metadata/decorators/dynamic-field-metadata.interface.ts Normal file
View File

@ -0,0 +1,27 @@
import { DynamicRelationFieldMetadataDecoratorParams } from 'src/workspace/workspace-sync-metadata/interfaces/reflect-computed-relation-field-metadata.interface';
import { TypedReflect } from 'src/utils/typed-reflect';
import { FieldMetadataType } from 'src/metadata/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,
);
};
}

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

@ -6,33 +6,27 @@ import {
} from 'src/workspace/workspace-sync-metadata/interfaces/reflect-relation-metadata.interface';
import { TypedReflect } from 'src/utils/typed-reflect';
import { convertClassNameToObjectMetadataName } from 'src/workspace/workspace-sync-metadata/utils/convert-class-to-object-metadata-name.util';
import { RelationOnDeleteAction } from 'src/metadata/relation-metadata/relation-metadata.entity';
export function RelationMetadata(
params: RelationMetadataDecoratorParams,
export function RelationMetadata<TClass extends object>(
params: RelationMetadataDecoratorParams<TClass>,
): PropertyDecorator {
return (target: object, fieldKey: string) => {
const relationMetadataCollection =
TypedReflect.getMetadata(
'relationMetadataCollection',
'reflectRelationMetadataCollection',
target.constructor,
) ?? [];
const gate = TypedReflect.getMetadata('gate', target, fieldKey);
const objectName = convertClassNameToObjectMetadataName(
target.constructor.name,
);
Reflect.defineMetadata(
'relationMetadataCollection',
TypedReflect.defineMetadata(
'reflectRelationMetadataCollection',
[
...relationMetadataCollection,
{
type: params.type,
fromObjectNameSingular: objectName,
toObjectNameSingular: params.objectName,
fromFieldMetadataName: fieldKey,
toFieldMetadataName: params.inverseSideFieldName ?? objectName,
target,
fieldKey,
...params,
onDelete: params.onDelete ?? RelationOnDeleteAction.SET_NULL,
gate,
} satisfies ReflectRelationMetadata,

2
packages/twenty-server/src/workspace/workspace-sync-metadata/factories/index.ts
View File

@ -1,9 +1,11 @@
import { FeatureFlagFactory } from './feature-flags.factory';
import { StandardFieldFactory } from './standard-field.factory';
import { StandardObjectFactory } from './standard-object.factory';
import { StandardRelationFactory } from './standard-relation.factory';
export const workspaceSyncMetadataFactories = [
FeatureFlagFactory,
StandardFieldFactory,
StandardObjectFactory,
StandardRelationFactory,
];

102
packages/twenty-server/src/workspace/workspace-sync-metadata/factories/standard-field.factory.ts Normal file
View File

@ -0,0 +1,102 @@
import { Injectable } from '@nestjs/common';
import { WorkspaceSyncContext } from 'src/workspace/workspace-sync-metadata/interfaces/workspace-sync-context.interface';
import { FeatureFlagMap } from 'src/core/feature-flag/interfaces/feature-flag-map.interface';
import {
PartialComputedFieldMetadata,
PartialFieldMetadata,
} from 'src/workspace/workspace-sync-metadata/interfaces/partial-field-metadata.interface';
import { ReflectFieldMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/reflect-field-metadata.interface';
import { ReflectObjectMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/reflect-object-metadata.interface';
import { ReflectDynamicRelationFieldMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/reflect-computed-relation-field-metadata.interface';
import { TypedReflect } from 'src/utils/typed-reflect';
import { isGatedAndNotEnabled } from 'src/workspace/workspace-sync-metadata/utils/is-gate-and-not-enabled.util';
@Injectable()
export class StandardFieldFactory {
create(
target: object,
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,
);
if (partialComputedFieldMetadata) {
partialFieldMetadataCollection.push(partialComputedFieldMetadata);
}
return partialFieldMetadataCollection;
}
private createFieldMetadata(
reflectObjectMetadata: ReflectObjectMetadata | undefined,
reflectFieldMetadata: ReflectFieldMetadata[string],
context: WorkspaceSyncContext,
workspaceFeatureFlagsMap: FeatureFlagMap,
): PartialFieldMetadata | undefined {
if (
isGatedAndNotEnabled(reflectFieldMetadata.gate, workspaceFeatureFlagsMap)
) {
return undefined;
}
return {
...reflectFieldMetadata,
workspaceId: context.workspaceId,
isSystem:
reflectObjectMetadata?.isSystem || reflectFieldMetadata.isSystem,
};
}
private createComputedFieldMetadata(
reflectDynamicRelationFieldMetadata:
| ReflectDynamicRelationFieldMetadata
| undefined,
context: WorkspaceSyncContext,
workspaceFeatureFlagsMap: FeatureFlagMap,
): PartialComputedFieldMetadata | undefined {
if (
!reflectDynamicRelationFieldMetadata ||
isGatedAndNotEnabled(
reflectDynamicRelationFieldMetadata.gate,
workspaceFeatureFlagsMap,
)
) {
return undefined;
}
return {
...reflectDynamicRelationFieldMetadata,
workspaceId: context.workspaceId,
isSystem: reflectDynamicRelationFieldMetadata.isSystem,
};
}
}

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

@ -3,20 +3,23 @@ import { Injectable } from '@nestjs/common';
import { WorkspaceSyncContext } from 'src/workspace/workspace-sync-metadata/interfaces/workspace-sync-context.interface';
import { PartialObjectMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-object-metadata.interface';
import { FeatureFlagMap } from 'src/core/feature-flag/interfaces/feature-flag-map.interface';
import { PartialFieldMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-field-metadata.interface';
import { BaseObjectMetadata } from 'src/workspace/workspace-sync-metadata/standard-objects/base.object-metadata';
import { standardObjectMetadataCollection } from 'src/workspace/workspace-sync-metadata/standard-objects';
import { TypedReflect } from 'src/utils/typed-reflect';
import { isGatedAndNotEnabled } from 'src/workspace/workspace-sync-metadata/utils/is-gate-and-not-enabled.util';
import { StandardFieldFactory } from './standard-field.factory';
@Injectable()
export class StandardObjectFactory {
constructor(private readonly standardFieldFactory: StandardFieldFactory) {}
create(
standardObjectMetadataDefinitions: (typeof BaseObjectMetadata)[],
context: WorkspaceSyncContext,
workspaceFeatureFlagsMap: FeatureFlagMap,
): PartialObjectMetadata[] {
return standardObjectMetadataCollection
return standardObjectMetadataDefinitions
.map((metadata) =>
this.createObjectMetadata(metadata, context, workspaceFeatureFlagsMap),
)
@ -29,8 +32,6 @@ export class StandardObjectFactory {
workspaceFeatureFlagsMap: FeatureFlagMap,
): PartialObjectMetadata | undefined {
const objectMetadata = TypedReflect.getMetadata('objectMetadata', metadata);
const fieldMetadataMap =
TypedReflect.getMetadata('fieldMetadataMap', metadata) ?? [];
if (!objectMetadata) {
throw new Error(
@ -42,22 +43,10 @@ export class StandardObjectFactory {
return undefined;
}
const fields = Object.values(fieldMetadataMap).reduce(
// Omit gate as we don't want to store it in the DB
(acc, { gate, ...fieldMetadata }) => {
if (isGatedAndNotEnabled(gate, workspaceFeatureFlagsMap)) {
return acc;
}
acc.push({
...fieldMetadata,
workspaceId: context.workspaceId,
isSystem: objectMetadata.isSystem || fieldMetadata.isSystem,
});
return acc;
},
[] as PartialFieldMetadata[],
const fields = this.standardFieldFactory.create(
metadata,
context,
workspaceFeatureFlagsMap,
);
return {

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

@ -4,42 +4,80 @@ import { WorkspaceSyncContext } from 'src/workspace/workspace-sync-metadata/inte
import { FeatureFlagMap } from 'src/core/feature-flag/interfaces/feature-flag-map.interface';
import { BaseObjectMetadata } from 'src/workspace/workspace-sync-metadata/standard-objects/base.object-metadata';
import { standardObjectMetadataCollection } from 'src/workspace/workspace-sync-metadata/standard-objects';
import { TypedReflect } from 'src/utils/typed-reflect';
import { isGatedAndNotEnabled } from 'src/workspace/workspace-sync-metadata/utils/is-gate-and-not-enabled.util';
import { assert } from 'src/utils/assert';
import { RelationMetadataEntity } from 'src/metadata/relation-metadata/relation-metadata.entity';
import { ObjectMetadataEntity } from 'src/metadata/object-metadata/object-metadata.entity';
import { convertClassNameToObjectMetadataName } from 'src/workspace/workspace-sync-metadata/utils/convert-class-to-object-metadata-name.util';
interface CustomRelationFactory {
object: ObjectMetadataEntity;
metadata: typeof BaseObjectMetadata;
}
@Injectable()
export class StandardRelationFactory {
create(
customObjectFactories: CustomRelationFactory[],
context: WorkspaceSyncContext,
originalObjectMetadataMap: Record<string, ObjectMetadataEntity>,
workspaceFeatureFlagsMap: FeatureFlagMap,
): Partial<RelationMetadataEntity>[];
create(
standardObjectMetadataDefinitions: (typeof BaseObjectMetadata)[],
context: WorkspaceSyncContext,
originalObjectMetadataMap: Record<string, ObjectMetadataEntity>,
workspaceFeatureFlagsMap: FeatureFlagMap,
): Partial<RelationMetadataEntity>[];
create(
standardObjectMetadataDefinitionsOrCustomObjectFactories:
| (typeof BaseObjectMetadata)[]
| {
object: ObjectMetadataEntity;
metadata: typeof BaseObjectMetadata;
}[],
context: WorkspaceSyncContext,
originalObjectMetadataMap: Record<string, ObjectMetadataEntity>,
workspaceFeatureFlagsMap: FeatureFlagMap,
): Partial<RelationMetadataEntity>[] {
return standardObjectMetadataCollection.flatMap((standardObjectMetadata) =>
this.createRelationMetadata(
standardObjectMetadata,
context,
originalObjectMetadataMap,
workspaceFeatureFlagsMap,
),
return standardObjectMetadataDefinitionsOrCustomObjectFactories.flatMap(
(
standardObjectMetadata:
| typeof BaseObjectMetadata
| CustomRelationFactory,
) =>
this.createRelationMetadata(
standardObjectMetadata,
context,
originalObjectMetadataMap,
workspaceFeatureFlagsMap,
),
);
}
private createRelationMetadata(
standardObjectMetadata: typeof BaseObjectMetadata,
standardObjectMetadataOrCustomRelationFactory:
| typeof BaseObjectMetadata
| CustomRelationFactory,
context: WorkspaceSyncContext,
originalObjectMetadataMap: Record<string, ObjectMetadataEntity>,
workspaceFeatureFlagsMap: FeatureFlagMap,
): Partial<RelationMetadataEntity>[] {
const standardObjectMetadata =
'metadata' in standardObjectMetadataOrCustomRelationFactory
? standardObjectMetadataOrCustomRelationFactory.metadata
: standardObjectMetadataOrCustomRelationFactory;
const objectMetadata = TypedReflect.getMetadata(
'objectMetadata',
'metadata' in standardObjectMetadataOrCustomRelationFactory
? 'extendObjectMetadata'
: 'objectMetadata',
standardObjectMetadata,
);
const relationMetadataCollection = TypedReflect.getMetadata(
'relationMetadataCollection',
const reflectRelationMetadataCollection = TypedReflect.getMetadata(
'reflectRelationMetadataCollection',
standardObjectMetadata,
);
@ -50,67 +88,81 @@ export class StandardRelationFactory {
}
if (
!relationMetadataCollection ||
isGatedAndNotEnabled(objectMetadata.gate, workspaceFeatureFlagsMap)
!reflectRelationMetadataCollection ||
isGatedAndNotEnabled(objectMetadata?.gate, workspaceFeatureFlagsMap)
) {
return [];
}
return relationMetadataCollection
return reflectRelationMetadataCollection
.filter(
(relationMetadata) =>
(reflectRelationMetadata) =>
!isGatedAndNotEnabled(
relationMetadata.gate,
reflectRelationMetadata.gate,
workspaceFeatureFlagsMap,
),
)
.map((relationMetadata) => {
.map((reflectRelationMetadata) => {
// Compute reflect relation metadata
const fromObjectNameSingular =
'object' in standardObjectMetadataOrCustomRelationFactory
? standardObjectMetadataOrCustomRelationFactory.object.nameSingular
: convertClassNameToObjectMetadataName(
reflectRelationMetadata.target.constructor.name,
);
const toObjectNameSingular = convertClassNameToObjectMetadataName(
reflectRelationMetadata.inverseSideTarget().name,
);
const fromFieldMetadataName = reflectRelationMetadata.fieldKey;
const toFieldMetadataName =
(reflectRelationMetadata.inverseSideFieldKey as string | undefined) ??
fromObjectNameSingular;
const fromObjectMetadata =
originalObjectMetadataMap[relationMetadata.fromObjectNameSingular];
originalObjectMetadataMap[fromObjectNameSingular];
assert(
fromObjectMetadata,
`Object ${relationMetadata.fromObjectNameSingular} not found in DB
for relation FROM defined in class ${objectMetadata.nameSingular}`,
`Object ${fromObjectNameSingular} not found in DB
for relation FROM defined in class ${fromObjectNameSingular}`,
);
const toObjectMetadata =
originalObjectMetadataMap[relationMetadata.toObjectNameSingular];
originalObjectMetadataMap[toObjectNameSingular];
assert(
toObjectMetadata,
`Object ${relationMetadata.toObjectNameSingular} not found in DB
for relation TO defined in class ${objectMetadata.nameSingular}`,
`Object ${toObjectNameSingular} not found in DB
for relation TO defined in class ${fromObjectNameSingular}`,
);
const fromFieldMetadata = fromObjectMetadata?.fields.find(
(field) => field.name === relationMetadata.fromFieldMetadataName,
(field) => field.name === fromFieldMetadataName,
);
assert(
fromFieldMetadata,
`Field ${relationMetadata.fromFieldMetadataName} not found in object ${relationMetadata.fromObjectNameSingular}
for relation FROM defined in class ${objectMetadata.nameSingular}`,
`Field ${fromFieldMetadataName} not found in object ${fromObjectNameSingular}
for relation FROM defined in class ${fromObjectNameSingular}`,
);
const toFieldMetadata = toObjectMetadata?.fields.find(
(field) => field.name === relationMetadata.toFieldMetadataName,
(field) => field.name === toFieldMetadataName,
);
assert(
toFieldMetadata,
`Field ${relationMetadata.toFieldMetadataName} not found in object ${relationMetadata.toObjectNameSingular}
for relation TO defined in class ${objectMetadata.nameSingular}`,
`Field ${toFieldMetadataName} not found in object ${toObjectNameSingular}
for relation TO defined in class ${fromObjectNameSingular}`,
);
return {
relationType: relationMetadata.type,
relationType: reflectRelationMetadata.type,
fromObjectMetadataId: fromObjectMetadata?.id,
toObjectMetadataId: toObjectMetadata?.id,
fromFieldMetadataId: fromFieldMetadata?.id,
toFieldMetadataId: toFieldMetadata?.id,
workspaceId: context.workspaceId,
onDeleteAction: relationMetadata.onDelete,
onDeleteAction: reflectRelationMetadata.onDelete,
};
});
}

14
packages/twenty-server/src/workspace/workspace-sync-metadata/interfaces/comparator.interface.ts
View File

@ -1,8 +1,8 @@
import { FieldMetadataEntity } from 'src/metadata/field-metadata/field-metadata.entity';
import { RelationMetadataEntity } from 'src/metadata/relation-metadata/relation-metadata.entity';
import { PartialFieldMetadata } from './partial-field-metadata.interface';
import { PartialObjectMetadata } from './partial-object-metadata.interface';
import { ComputedPartialFieldMetadata } from './partial-field-metadata.interface';
import { ComputedPartialObjectMetadata } from './partial-object-metadata.interface';
export const enum ComparatorAction {
SKIP = 'SKIP',
@ -32,13 +32,15 @@ export interface ComparatorDeleteResult<T> {
export type ObjectComparatorResult =
| ComparatorSkipResult
| ComparatorCreateResult<PartialObjectMetadata>
| ComparatorUpdateResult<Partial<PartialObjectMetadata>>;
| ComparatorCreateResult<ComputedPartialObjectMetadata>
| ComparatorUpdateResult<Partial<ComputedPartialObjectMetadata>>;
export type FieldComparatorResult =
| ComparatorSkipResult
| ComparatorCreateResult<PartialFieldMetadata>
| ComparatorUpdateResult<Partial<PartialFieldMetadata> & { id: string }>
| ComparatorCreateResult<ComputedPartialFieldMetadata>
| ComparatorUpdateResult<
Partial<ComputedPartialFieldMetadata> & { id: string }
>
| ComparatorDeleteResult<FieldMetadataEntity>;
export type RelationComparatorResult =

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

@ -1,6 +1,20 @@
import { ReflectDynamicRelationFieldMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/reflect-computed-relation-field-metadata.interface';
import { ReflectFieldMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/reflect-field-metadata.interface';
export type PartialFieldMetadata = ReflectFieldMetadata[string] & {
export type PartialFieldMetadata = Omit<
ReflectFieldMetadata[string],
'joinColumn'
> & {
workspaceId: string;
objectMetadataId?: string;
};
export type PartialComputedFieldMetadata =
ReflectDynamicRelationFieldMetadata & {
workspaceId: string;
objectMetadataId?: string;
};
export type ComputedPartialFieldMetadata = {
[K in keyof PartialFieldMetadata]: ExcludeFunctions<PartialFieldMetadata[K]>;
};

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

@ -1,9 +1,20 @@
import { PartialFieldMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-field-metadata.interface';
import {
ComputedPartialFieldMetadata,
PartialComputedFieldMetadata,
PartialFieldMetadata,
} from 'src/workspace/workspace-sync-metadata/interfaces/partial-field-metadata.interface';
import { ReflectObjectMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/reflect-object-metadata.interface';
export type PartialObjectMetadata = ReflectObjectMetadata & {
id?: string;
workspaceId: string;
dataSourceId: string;
fields: PartialFieldMetadata[];
fields: (PartialFieldMetadata | PartialComputedFieldMetadata)[];
};
export type ComputedPartialObjectMetadata = Omit<
PartialObjectMetadata,
'fields'
> & {
fields: ComputedPartialFieldMetadata[];
};

23
packages/twenty-server/src/workspace/workspace-sync-metadata/interfaces/reflect-computed-relation-field-metadata.interface.ts Normal file
View File

@ -0,0 +1,23 @@
import { GateDecoratorParams } from 'src/workspace/workspace-sync-metadata/interfaces/gate-decorator.interface';
import { FieldMetadataType } from 'src/metadata/field-metadata/field-metadata.entity';
import { ObjectMetadataEntity } from 'src/metadata/object-metadata/object-metadata.entity';
export type DynamicRelationFieldMetadataDecoratorParams = (
oppositeObjectMetadata: ObjectMetadataEntity,
) => {
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/workspace/workspace-sync-metadata/interfaces/reflect-custom-object-metadata.interface.ts Normal file
View File

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

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

@ -4,13 +4,14 @@ import { FieldMetadataOptions } from 'src/metadata/field-metadata/interfaces/fie
import { FieldMetadataTargetColumnMap } from 'src/metadata/field-metadata/interfaces/field-metadata-target-column-map.interface';
import { FieldMetadataType } from 'src/metadata/field-metadata/field-metadata.entity';
import { ObjectMetadataEntity } from 'src/metadata/object-metadata/object-metadata.entity';
export interface FieldMetadataDecoratorParams<
T extends FieldMetadataType | 'default',
> {
type: T;
label: string;
description?: string;
label: string | ((objectMetadata: ObjectMetadataEntity) => string);
description?: string | ((objectMetadata: ObjectMetadataEntity) => string);
icon?: string;
defaultValue?: FieldMetadataDefaultValue<T>;
joinColumn?: string;
@ -28,7 +29,6 @@ export interface ReflectFieldMetadata {
isNullable: boolean;
isSystem: boolean;
isCustom: boolean;
description?: string;
defaultValue: FieldMetadataDefaultValue<'default'> | null;
gate?: GateDecoratorParams;
options?: FieldMetadataOptions<'default'> | null;

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

@ -1,3 +1,5 @@
import { ObjectType } from 'typeorm';
import { GateDecoratorParams } from 'src/workspace/workspace-sync-metadata/interfaces/gate-decorator.interface';
import {
@ -5,19 +7,17 @@ import {
RelationMetadataType,
} from 'src/metadata/relation-metadata/relation-metadata.entity';
export interface RelationMetadataDecoratorParams {
export interface RelationMetadataDecoratorParams<T> {
type: RelationMetadataType;
objectName: string;
inverseSideFieldName?: string;
inverseSideTarget: () => ObjectType<T>;
inverseSideFieldKey?: keyof T;
onDelete?: RelationOnDeleteAction;
}
export interface ReflectRelationMetadata {
type: RelationMetadataType;
fromObjectNameSingular: string;
toObjectNameSingular: string;
fromFieldMetadataName: string;
toFieldMetadataName: string;
export interface ReflectRelationMetadata
extends RelationMetadataDecoratorParams<any> {
target: object;
fieldKey: string;
gate?: GateDecoratorParams;
onDelete: RelationOnDeleteAction;
}

10
packages/twenty-server/src/workspace/workspace-sync-metadata/services/workspace-metadata-updater.service.ts
View File

@ -153,8 +153,8 @@ export class WorkspaceMetadataUpdaterService {
// https://github.com/typeorm/typeorm/issues/3490
// To avoid calling update in a for loop, we did this hack.
return {
...oldFieldMetadata,
...updateFieldMetadata,
...omit(oldFieldMetadata, ['objectMetadataId', 'workspaceId']),
...omit(updateFieldMetadata, ['objectMetadataId', 'workspaceId']),
options: updateFieldMetadata.options ?? oldFieldMetadata.options,
};
});
@ -197,7 +197,11 @@ export class WorkspaceMetadataUpdaterService {
return {
current: oldFieldMetadata as FieldMetadataEntity,
altered: alteredFieldMetadata as FieldMetadataEntity,
altered: {
...alteredFieldMetadata,
objectMetadataId: oldFieldMetadata.objectMetadataId,
workspaceId: oldFieldMetadata.workspaceId,
} as FieldMetadataEntity,
};
},
),

140
packages/twenty-server/src/workspace/workspace-sync-metadata/services/workspace-sync-field-metadata.service.ts Normal file
View File

@ -0,0 +1,140 @@
import { Injectable, Logger } from '@nestjs/common';
import { EntityManager } from 'typeorm';
import { WorkspaceSyncContext } from 'src/workspace/workspace-sync-metadata/interfaces/workspace-sync-context.interface';
import { ComparatorAction } from 'src/workspace/workspace-sync-metadata/interfaces/comparator.interface';
import { FeatureFlagMap } from 'src/core/feature-flag/interfaces/feature-flag-map.interface';
import { WorkspaceMigrationBuilderAction } from 'src/workspace/workspace-migration-builder/interfaces/workspace-migration-builder-action.interface';
import { ObjectMetadataEntity } from 'src/metadata/object-metadata/object-metadata.entity';
import { WorkspaceMigrationEntity } from 'src/metadata/workspace-migration/workspace-migration.entity';
import { WorkspaceFieldComparator } from 'src/workspace/workspace-sync-metadata/comparators/workspace-field.comparator';
import { WorkspaceMetadataUpdaterService } from 'src/workspace/workspace-sync-metadata/services/workspace-metadata-updater.service';
import { WorkspaceSyncStorage } from 'src/workspace/workspace-sync-metadata/storage/workspace-sync.storage';
import { WorkspaceMigrationFieldFactory } from 'src/workspace/workspace-migration-builder/factories/workspace-migration-field.factory';
import { StandardFieldFactory } from 'src/workspace/workspace-sync-metadata/factories/standard-field.factory';
import { CustomObjectMetadata } from 'src/workspace/workspace-sync-metadata/custom-objects/custom.object-metadata';
import { computeStandardObject } from 'src/workspace/workspace-sync-metadata/utils/compute-standard-object.util';
@Injectable()
export class WorkspaceSyncFieldMetadataService {
private readonly logger = new Logger(WorkspaceSyncFieldMetadataService.name);
constructor(
private readonly standardFieldFactory: StandardFieldFactory,
private readonly workspaceFieldComparator: WorkspaceFieldComparator,
private readonly workspaceMetadataUpdaterService: WorkspaceMetadataUpdaterService,
private readonly workspaceMigrationFieldFactory: WorkspaceMigrationFieldFactory,
) {}
async synchronize(
context: WorkspaceSyncContext,
manager: EntityManager,
storage: WorkspaceSyncStorage,
workspaceFeatureFlagsMap: FeatureFlagMap,
): Promise<Partial<WorkspaceMigrationEntity>[]> {
const objectMetadataRepository =
manager.getRepository(ObjectMetadataEntity);
// Retrieve object metadata collection from DB
const originalObjectMetadataCollection =
await objectMetadataRepository.find({
where: {
workspaceId: context.workspaceId,
// We're only interested in standard fields
fields: { isCustom: false },
},
relations: ['dataSource', 'fields'],
});
// Filter out custom objects
const customObjectMetadataCollection =
originalObjectMetadataCollection.filter(
(objectMetadata) => objectMetadata.isCustom,
);
// Create standard field metadata collection
const standardFieldMetadataCollection = this.standardFieldFactory.create(
CustomObjectMetadata,
context,
workspaceFeatureFlagsMap,
);
// Loop over all standard objects and compare them with the objects in DB
for (const customObjectMetadata of customObjectMetadataCollection) {
// Also, maybe it's better to refactor a bit and move generation part into a separate module ?
const standardObjectMetadata = computeStandardObject(
{
...customObjectMetadata,
fields: standardFieldMetadataCollection,
},
customObjectMetadata,
);
/**
* COMPARE FIELD METADATA
*/
const fieldComparatorResults = this.workspaceFieldComparator.compare(
customObjectMetadata,
standardObjectMetadata,
);
for (const fieldComparatorResult of fieldComparatorResults) {
switch (fieldComparatorResult.action) {
case ComparatorAction.CREATE: {
storage.addCreateFieldMetadata(fieldComparatorResult.object);
break;
}
case ComparatorAction.UPDATE: {
storage.addUpdateFieldMetadata(fieldComparatorResult.object);
break;
}
case ComparatorAction.DELETE: {
storage.addDeleteFieldMetadata(fieldComparatorResult.object);
break;
}
}
}
}
this.logger.log('Updating workspace metadata');
const metadataFieldUpdaterResult =
await this.workspaceMetadataUpdaterService.updateFieldMetadata(
manager,
storage,
);
this.logger.log('Generating migrations');
const createFieldWorkspaceMigrations =
await this.workspaceMigrationFieldFactory.create(
originalObjectMetadataCollection,
metadataFieldUpdaterResult.createdFieldMetadataCollection,
WorkspaceMigrationBuilderAction.CREATE,
);
const updateFieldWorkspaceMigrations =
await this.workspaceMigrationFieldFactory.create(
originalObjectMetadataCollection,
metadataFieldUpdaterResult.updatedFieldMetadataCollection,
WorkspaceMigrationBuilderAction.UPDATE,
);
const deleteFieldWorkspaceMigrations =
await this.workspaceMigrationFieldFactory.create(
originalObjectMetadataCollection,
storage.fieldMetadataDeleteCollection,
WorkspaceMigrationBuilderAction.DELETE,
);
this.logger.log('Saving migrations');
return [
...createFieldWorkspaceMigrations,
...updateFieldWorkspaceMigrations,
...deleteFieldWorkspaceMigrations,
];
}
}

50
packages/twenty-server/src/workspace/workspace-sync-metadata/services/workspace-sync-object-metadata.service.ts
View File

@ -16,7 +16,8 @@ import { WorkspaceFieldComparator } from 'src/workspace/workspace-sync-metadata/
import { WorkspaceMetadataUpdaterService } from 'src/workspace/workspace-sync-metadata/services/workspace-metadata-updater.service';
import { WorkspaceSyncStorage } from 'src/workspace/workspace-sync-metadata/storage/workspace-sync.storage';
import { WorkspaceMigrationObjectFactory } from 'src/workspace/workspace-migration-builder/factories/workspace-migration-object.factory';
import { WorkspaceMigrationFieldFactory } from 'src/workspace/workspace-migration-builder/factories/workspace-migration-field.factory';
import { computeStandardObject } from 'src/workspace/workspace-sync-metadata/utils/compute-standard-object.util';
import { standardObjectMetadataDefinitions } from 'src/workspace/workspace-sync-metadata/standard-objects';
@Injectable()
export class WorkspaceSyncObjectMetadataService {
@ -28,7 +29,6 @@ export class WorkspaceSyncObjectMetadataService {
private readonly workspaceFieldComparator: WorkspaceFieldComparator,
private readonly workspaceMetadataUpdaterService: WorkspaceMetadataUpdaterService,
private readonly workspaceMigrationObjectFactory: WorkspaceMigrationObjectFactory,
private readonly workspaceMigrationFieldFactory: WorkspaceMigrationFieldFactory,
) {}
async synchronize(
@ -45,14 +45,18 @@ export class WorkspaceSyncObjectMetadataService {
await objectMetadataRepository.find({
where: {
workspaceId: context.workspaceId,
isCustom: false,
fields: { isCustom: false },
},
relations: ['dataSource', 'fields'],
});
const customObjectMetadataCollection =
originalObjectMetadataCollection.filter(
(objectMetadata) => objectMetadata.isCustom,
);
// Create standard object metadata collection
const standardObjectMetadataCollection = this.standardObjectFactory.create(
standardObjectMetadataDefinitions,
context,
workspaceFeatureFlagsMap,
);
@ -68,7 +72,9 @@ export class WorkspaceSyncObjectMetadataService {
this.logger.log('Comparing standard objects and fields metadata');
// Store object that need to be deleted
for (const originalObjectMetadata of originalObjectMetadataCollection) {
for (const originalObjectMetadata of originalObjectMetadataCollection.filter(
(object) => !object.isCustom,
)) {
if (!standardObjectMetadataMap[originalObjectMetadata.nameSingular]) {
storage.addDeleteObjectMetadata(originalObjectMetadata);
}
@ -78,8 +84,11 @@ export class WorkspaceSyncObjectMetadataService {
for (const standardObjectName in standardObjectMetadataMap) {
const originalObjectMetadata =
originalObjectMetadataMap[standardObjectName];
const standardObjectMetadata =
standardObjectMetadataMap[standardObjectName];
const standardObjectMetadata = computeStandardObject(
standardObjectMetadataMap[standardObjectName],
originalObjectMetadata,
customObjectMetadataCollection,
);
/**
* COMPARE OBJECT METADATA
@ -132,11 +141,6 @@ export class WorkspaceSyncObjectMetadataService {
manager,
storage,
);
const metadataFieldUpdaterResult =
await this.workspaceMetadataUpdaterService.updateFieldMetadata(
manager,
storage,
);
this.logger.log('Generating migrations');
@ -153,35 +157,11 @@ export class WorkspaceSyncObjectMetadataService {
WorkspaceMigrationBuilderAction.DELETE,
);
const createFieldWorkspaceMigrations =
await this.workspaceMigrationFieldFactory.create(
originalObjectMetadataCollection,
metadataFieldUpdaterResult.createdFieldMetadataCollection,
WorkspaceMigrationBuilderAction.CREATE,
);
const updateFieldWorkspaceMigrations =
await this.workspaceMigrationFieldFactory.create(
originalObjectMetadataCollection,
metadataFieldUpdaterResult.updatedFieldMetadataCollection,
WorkspaceMigrationBuilderAction.UPDATE,
);
const deleteFieldWorkspaceMigrations =
await this.workspaceMigrationFieldFactory.create(
originalObjectMetadataCollection,
storage.fieldMetadataDeleteCollection,
WorkspaceMigrationBuilderAction.DELETE,
);
this.logger.log('Saving migrations');
return [
...createObjectWorkspaceMigrations,
...deleteObjectWorkspaceMigrations,
...createFieldWorkspaceMigrations,
...updateFieldWorkspaceMigrations,
...deleteFieldWorkspaceMigrations,
];
}
}

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

@ -16,6 +16,8 @@ import { WorkspaceMetadataUpdaterService } from 'src/workspace/workspace-sync-me
import { WorkspaceMigrationEntity } from 'src/metadata/workspace-migration/workspace-migration.entity';
import { WorkspaceSyncStorage } from 'src/workspace/workspace-sync-metadata/storage/workspace-sync.storage';
import { WorkspaceMigrationRelationFactory } from 'src/workspace/workspace-migration-builder/factories/workspace-migration-relation.factory';
import { standardObjectMetadataDefinitions } from 'src/workspace/workspace-sync-metadata/standard-objects';
import { CustomObjectMetadata } from 'src/workspace/workspace-sync-metadata/custom-objects/custom.object-metadata';
@Injectable()
export class WorkspaceSyncRelationMetadataService {
@ -44,11 +46,14 @@ export class WorkspaceSyncRelationMetadataService {
await objectMetadataRepository.find({
where: {
workspaceId: context.workspaceId,
isCustom: false,
fields: { isCustom: false },
},
relations: ['dataSource', 'fields'],
});
const customObjectMetadataCollection =
originalObjectMetadataCollection.filter(
(objectMetadata) => objectMetadata.isCustom,
);
// Create map of object metadata & field metadata by unique identifier
const originalObjectMetadataMap = mapObjectMetadataByUniqueIdentifier(
@ -71,6 +76,18 @@ export class WorkspaceSyncRelationMetadataService {
// Create standard relation metadata collection
const standardRelationMetadataCollection =
this.standardRelationFactory.create(
standardObjectMetadataDefinitions,
context,
originalObjectMetadataMap,
workspaceFeatureFlagsMap,
);
const customRelationMetadataCollection =
this.standardRelationFactory.create(
customObjectMetadataCollection.map((objectMetadata) => ({
object: objectMetadata,
metadata: CustomObjectMetadata,
})),
context,
originalObjectMetadataMap,
workspaceFeatureFlagsMap,
@ -78,7 +95,10 @@ export class WorkspaceSyncRelationMetadataService {
const relationComparatorResults = this.workspaceRelationComparator.compare(
originalRelationMetadataCollection,
standardRelationMetadataCollection,
[
...standardRelationMetadataCollection,
...customRelationMetadataCollection,
],
);
for (const relationComparatorResult of relationComparatorResults) {

11
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/activity-target.object-metadata.ts
View File

@ -1,4 +1,6 @@
import { FieldMetadataType } from 'src/metadata/field-metadata/field-metadata.entity';
import { CustomObjectMetadata } from 'src/workspace/workspace-sync-metadata/custom-objects/custom.object-metadata';
import { DynamicRelationFieldMetadata } from 'src/workspace/workspace-sync-metadata/decorators/dynamic-field-metadata.interface';
import { FieldMetadata } from 'src/workspace/workspace-sync-metadata/decorators/field-metadata.decorator';
import { IsNullable } from 'src/workspace/workspace-sync-metadata/decorators/is-nullable.decorator';
import { IsSystem } from 'src/workspace/workspace-sync-metadata/decorators/is-system.decorator';
@ -57,4 +59,13 @@ export class ActivityTargetObjectMetadata extends BaseObjectMetadata {
})
@IsNullable()
opportunity: OpportunityObjectMetadata;
@DynamicRelationFieldMetadata((oppositeObjectMetadata) => ({
name: oppositeObjectMetadata.nameSingular,
label: oppositeObjectMetadata.labelSingular,
description: `ActivityTarget ${oppositeObjectMetadata.labelSingular}`,
joinColumn: `${oppositeObjectMetadata.nameSingular}Id`,
icon: 'IconBuildingSkyscraper',
}))
custom: CustomObjectMetadata;
}

8
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/activity.object-metadata.ts
View File

@ -80,7 +80,7 @@ export class ActivityObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'activityTarget',
inverseSideTarget: () => ActivityTargetObjectMetadata,
})
@IsNullable()
activityTargets: ActivityTargetObjectMetadata[];
@ -93,7 +93,7 @@ export class ActivityObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'attachment',
inverseSideTarget: () => AttachmentObjectMetadata,
})
@IsNullable()
attachments: AttachmentObjectMetadata[];
@ -106,7 +106,7 @@ export class ActivityObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'comment',
inverseSideTarget: () => CommentObjectMetadata,
})
@IsNullable()
comments: CommentObjectMetadata[];
@ -123,7 +123,7 @@ export class ActivityObjectMetadata extends BaseObjectMetadata {
@FieldMetadata({
type: FieldMetadataType.RELATION,
label: 'Assignee',
description: 'Acitivity assignee',
description: 'Activity assignee',
icon: 'IconUserCircle',
joinColumn: 'assigneeId',
})

11
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/attachment.object-metadata.ts
View File

@ -1,4 +1,6 @@
import { FieldMetadataType } from 'src/metadata/field-metadata/field-metadata.entity';
import { CustomObjectMetadata } from 'src/workspace/workspace-sync-metadata/custom-objects/custom.object-metadata';
import { DynamicRelationFieldMetadata } from 'src/workspace/workspace-sync-metadata/decorators/dynamic-field-metadata.interface';
import { FieldMetadata } from 'src/workspace/workspace-sync-metadata/decorators/field-metadata.decorator';
import { IsNullable } from 'src/workspace/workspace-sync-metadata/decorators/is-nullable.decorator';
import { IsSystem } from 'src/workspace/workspace-sync-metadata/decorators/is-system.decorator';
@ -91,4 +93,13 @@ export class AttachmentObjectMetadata extends BaseObjectMetadata {
})
@IsNullable()
opportunity: OpportunityObjectMetadata;
@DynamicRelationFieldMetadata((oppositeObjectMetadata) => ({
name: oppositeObjectMetadata.nameSingular,
label: oppositeObjectMetadata.labelSingular,
description: `Attachment ${oppositeObjectMetadata.labelSingular}`,
joinColumn: `${oppositeObjectMetadata.nameSingular}Id`,
icon: 'IconBuildingSkyscraper',
}))
custom: CustomObjectMetadata;
}

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

@ -6,7 +6,9 @@ export abstract class BaseObjectMetadata {
@FieldMetadata({
type: FieldMetadataType.UUID,
label: 'Id',
description: 'Id',
defaultValue: { type: 'uuid' },
icon: 'Icon123',
})
@IsSystem()
id: string;
@ -14,6 +16,7 @@ export abstract class BaseObjectMetadata {
@FieldMetadata({
type: FieldMetadataType.DATE_TIME,
label: 'Creation date',
description: 'Creation date',
icon: 'IconCalendar',
defaultValue: { type: 'now' },
})
@ -22,6 +25,7 @@ export abstract class BaseObjectMetadata {
@FieldMetadata({
type: FieldMetadataType.DATE_TIME,
label: 'Update date',
description: 'Update date',
icon: 'IconCalendar',
defaultValue: { type: 'now' },
})

2
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/calendar-event.object-metadata.ts
View File

@ -136,7 +136,7 @@ export class CalendarEventObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'calendarEventAttendee',
inverseSideTarget: () => CalendarEventAttendeeObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
eventAttendees: CalendarEventAttendeeObjectMetadata[];

10
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/company.object-metadata.ts
View File

@ -117,7 +117,7 @@ export class CompanyObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'person',
inverseSideTarget: () => PersonObjectMetadata,
})
@IsNullable()
people: PersonObjectMetadata[];
@ -141,7 +141,7 @@ export class CompanyObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'activityTarget',
inverseSideTarget: () => ActivityTargetObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
@IsNullable()
@ -155,7 +155,7 @@ export class CompanyObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'opportunity',
inverseSideTarget: () => OpportunityObjectMetadata,
})
@IsNullable()
opportunities: OpportunityObjectMetadata[];
@ -168,7 +168,7 @@ export class CompanyObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'favorite',
inverseSideTarget: () => FavoriteObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
@IsNullable()
@ -182,7 +182,7 @@ export class CompanyObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'attachment',
inverseSideTarget: () => AttachmentObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
@IsNullable()

4
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/connected-account.object-metadata.ts
View File

@ -80,7 +80,7 @@ export class ConnectedAccountObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'messageChannel',
inverseSideTarget: () => MessageChannelObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
messageChannels: MessageChannelObjectMetadata[];
@ -93,7 +93,7 @@ export class ConnectedAccountObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'calendarChannel',
inverseSideTarget: () => CalendarChannelObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
@Gate({

11
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/favorite.object-metadata.ts
View File

@ -1,4 +1,6 @@
import { FieldMetadataType } from 'src/metadata/field-metadata/field-metadata.entity';
import { CustomObjectMetadata } from 'src/workspace/workspace-sync-metadata/custom-objects/custom.object-metadata';
import { DynamicRelationFieldMetadata } from 'src/workspace/workspace-sync-metadata/decorators/dynamic-field-metadata.interface';
import { FieldMetadata } from 'src/workspace/workspace-sync-metadata/decorators/field-metadata.decorator';
import { IsNullable } from 'src/workspace/workspace-sync-metadata/decorators/is-nullable.decorator';
import { IsSystem } from 'src/workspace/workspace-sync-metadata/decorators/is-system.decorator';
@ -66,4 +68,13 @@ export class FavoriteObjectMetadata extends BaseObjectMetadata {
})
@IsNullable()
opportunity: OpportunityObjectMetadata;
@DynamicRelationFieldMetadata((oppositeObjectMetadata) => ({
name: oppositeObjectMetadata.nameSingular,
label: oppositeObjectMetadata.labelSingular,
description: `Favorite ${oppositeObjectMetadata.labelSingular}`,
joinColumn: `${oppositeObjectMetadata.nameSingular}Id`,
icon: 'IconBuildingSkyscraper',
}))
custom: CustomObjectMetadata;
}

2
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/index.ts
View File

@ -25,7 +25,7 @@ import { ViewObjectMetadata } from 'src/workspace/workspace-sync-metadata/standa
import { WebhookObjectMetadata } from 'src/workspace/workspace-sync-metadata/standard-objects/webhook.object-metadata';
import { WorkspaceMemberObjectMetadata } from 'src/workspace/workspace-sync-metadata/standard-objects/workspace-member.object-metadata';
export const standardObjectMetadataCollection = [
export const standardObjectMetadataDefinitions = [
ActivityTargetObjectMetadata,
ActivityObjectMetadata,
ApiKeyObjectMetadata,

2
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/message-channel.object-metadata.ts
View File

@ -87,7 +87,7 @@ export class MessageChannelObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'messageChannelMessageAssociation',
inverseSideTarget: () => MessageChannelMessageAssociationObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
@IsNullable()

4
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/message-thread.object-metadata.ts
View File

@ -29,7 +29,7 @@ export class MessageThreadObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'message',
inverseSideTarget: () => MessageObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
@IsNullable()
@ -43,7 +43,7 @@ export class MessageThreadObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'messageChannelMessageAssociation',
inverseSideTarget: () => MessageChannelMessageAssociationObjectMetadata,
onDelete: RelationOnDeleteAction.RESTRICT,
})
@IsNullable()

6
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/message.object-metadata.ts
View File

@ -86,8 +86,8 @@ export class MessageObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'messageParticipant',
inverseSideFieldName: 'message',
inverseSideTarget: () => MessageParticipantObjectMetadata,
inverseSideFieldKey: 'message',
onDelete: RelationOnDeleteAction.CASCADE,
})
@IsNullable()
@ -101,7 +101,7 @@ export class MessageObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'messageChannelMessageAssociation',
inverseSideTarget: () => MessageChannelMessageAssociationObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
@IsNullable()

6
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/opportunity.object-metadata.ts
View File

@ -130,7 +130,7 @@ export class OpportunityObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'favorite',
inverseSideTarget: () => FavoriteObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
@IsNullable()
@ -144,7 +144,7 @@ export class OpportunityObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'activityTarget',
inverseSideTarget: () => ActivityTargetObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
@IsNullable()
@ -158,7 +158,7 @@ export class OpportunityObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'attachment',
inverseSideTarget: () => AttachmentObjectMetadata,
})
@IsNullable()
attachments: AttachmentObjectMetadata[];

18
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/person.object-metadata.ts
View File

@ -124,8 +124,8 @@ export class PersonObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'opportunity',
inverseSideFieldName: 'pointOfContact',
inverseSideTarget: () => OpportunityObjectMetadata,
inverseSideFieldKey: 'pointOfContact',
})
pointOfContactForOpportunities: OpportunityObjectMetadata[];
@ -137,7 +137,7 @@ export class PersonObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'activityTarget',
inverseSideTarget: () => ActivityTargetObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
activityTargets: ActivityTargetObjectMetadata[];
@ -150,7 +150,7 @@ export class PersonObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'favorite',
inverseSideTarget: () => FavoriteObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
favorites: FavoriteObjectMetadata[];
@ -163,7 +163,7 @@ export class PersonObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'attachment',
inverseSideTarget: () => AttachmentObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
attachments: AttachmentObjectMetadata[];
@ -176,8 +176,8 @@ export class PersonObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'messageParticipant',
inverseSideFieldName: 'person',
inverseSideTarget: () => MessageParticipantObjectMetadata,
inverseSideFieldKey: 'person',
})
messageParticipants: MessageParticipantObjectMetadata[];
@ -189,8 +189,8 @@ export class PersonObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'calendarEventAttendee',
inverseSideFieldName: 'person',
inverseSideTarget: () => CalendarEventAttendeeObjectMetadata,
inverseSideFieldKey: 'person',
})
@Gate({
featureFlag: 'IS_CALENDAR_ENABLED',

2
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/pipeline-step.object-metadata.ts
View File

@ -52,7 +52,7 @@ export class PipelineStepObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'opportunity',
inverseSideTarget: () => OpportunityObjectMetadata,
})
@IsNullable()
opportunities: OpportunityObjectMetadata[];

6
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/view.object-metadata.ts
View File

@ -57,7 +57,7 @@ export class ViewObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'viewField',
inverseSideTarget: () => ViewFieldObjectMetadata,
})
@IsNullable()
viewFields: ViewFieldObjectMetadata[];
@ -70,7 +70,7 @@ export class ViewObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'viewFilter',
inverseSideTarget: () => ViewFilterObjectMetadata,
})
@IsNullable()
viewFilters: ViewFilterObjectMetadata[];
@ -83,7 +83,7 @@ export class ViewObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'viewSort',
inverseSideTarget: () => ViewSortObjectMetadata,
})
@IsNullable()
viewSorts: ViewSortObjectMetadata[];

42
packages/twenty-server/src/workspace/workspace-sync-metadata/standard-objects/workspace-member.object-metadata.ts
View File

@ -6,7 +6,6 @@ import {
} from 'src/metadata/relation-metadata/relation-metadata.entity';
import { FieldMetadata } from 'src/workspace/workspace-sync-metadata/decorators/field-metadata.decorator';
import { Gate } from 'src/workspace/workspace-sync-metadata/decorators/gate.decorator';
import { IsNullable } from 'src/workspace/workspace-sync-metadata/decorators/is-nullable.decorator';
import { IsSystem } from 'src/workspace/workspace-sync-metadata/decorators/is-system.decorator';
import { ObjectMetadata } from 'src/workspace/workspace-sync-metadata/decorators/object-metadata.decorator';
import { RelationMetadata } from 'src/workspace/workspace-sync-metadata/decorators/relation-metadata.decorator';
@ -89,8 +88,8 @@ export class WorkspaceMemberObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'activity',
inverseSideFieldName: 'author',
inverseSideTarget: () => ActivityObjectMetadata,
inverseSideFieldKey: 'author',
})
authoredActivities: ActivityObjectMetadata[];
@ -102,10 +101,11 @@ export class WorkspaceMemberObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'activity',
inverseSideFieldName: 'assignee',
inverseSideTarget: () => ActivityObjectMetadata,
inverseSideFieldKey: 'assignee',
})
@IsNullable()
assignedActivities: ActivityObjectMetadata[];
@FieldMetadata({
type: FieldMetadataType.RELATION,
label: 'Favorites',
@ -114,7 +114,7 @@ export class WorkspaceMemberObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'favorite',
inverseSideTarget: () => FavoriteObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
favorites: FavoriteObjectMetadata[];
@ -127,8 +127,8 @@ export class WorkspaceMemberObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'company',
inverseSideFieldName: 'accountOwner',
inverseSideTarget: () => CompanyObjectMetadata,
inverseSideFieldKey: 'accountOwner',
})
accountOwnerForCompanies: CompanyObjectMetadata[];
@ -140,8 +140,8 @@ export class WorkspaceMemberObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'attachment',
inverseSideFieldName: 'author',
inverseSideTarget: () => AttachmentObjectMetadata,
inverseSideFieldKey: 'author',
})
authoredAttachments: AttachmentObjectMetadata[];
@ -153,8 +153,8 @@ export class WorkspaceMemberObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'comment',
inverseSideFieldName: 'author',
inverseSideTarget: () => CommentObjectMetadata,
inverseSideFieldKey: 'author',
})
authoredComments: CommentObjectMetadata[];
@ -166,8 +166,8 @@ export class WorkspaceMemberObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'connectedAccount',
inverseSideFieldName: 'accountOwner',
inverseSideTarget: () => ConnectedAccountObjectMetadata,
inverseSideFieldKey: 'accountOwner',
})
connectedAccounts: ConnectedAccountObjectMetadata[];
@ -179,8 +179,8 @@ export class WorkspaceMemberObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'messageParticipant',
inverseSideFieldName: 'workspaceMember',
inverseSideTarget: () => MessageParticipantObjectMetadata,
inverseSideFieldKey: 'workspaceMember',
})
messageParticipants: MessageParticipantObjectMetadata[];
@ -192,8 +192,8 @@ export class WorkspaceMemberObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'blocklist',
inverseSideFieldName: 'workspaceMember',
inverseSideTarget: () => BlocklistObjectMetadata,
inverseSideFieldKey: 'workspaceMember',
})
blocklist: BlocklistObjectMetadata[];
@ -205,8 +205,8 @@ export class WorkspaceMemberObjectMetadata extends BaseObjectMetadata {
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
objectName: 'calendarEventAttendee',
inverseSideFieldName: 'workspaceMember',
inverseSideTarget: () => CalendarEventAttendeeObjectMetadata,
inverseSideFieldKey: 'workspaceMember',
})
@Gate({
featureFlag: 'IS_CALENDAR_ENABLED',

21
packages/twenty-server/src/workspace/workspace-sync-metadata/storage/workspace-sync.storage.ts
View File

@ -1,5 +1,5 @@
import { PartialObjectMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-object-metadata.interface';
import { PartialFieldMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-field-metadata.interface';
import { ComputedPartialObjectMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-object-metadata.interface';
import { ComputedPartialFieldMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-field-metadata.interface';
import { PartialRelationMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-relation-metadata.interface';
import { ObjectMetadataEntity } from 'src/metadata/object-metadata/object-metadata.entity';
@ -8,15 +8,16 @@ import { RelationMetadataEntity } from 'src/metadata/relation-metadata/relation-
export class WorkspaceSyncStorage {
// Object metadata
private readonly _objectMetadataCreateCollection: PartialObjectMetadata[] =
private readonly _objectMetadataCreateCollection: ComputedPartialObjectMetadata[] =
[];
private readonly _objectMetadataUpdateCollection: Partial<PartialObjectMetadata>[] =
private readonly _objectMetadataUpdateCollection: Partial<ComputedPartialObjectMetadata>[] =
[];
private readonly _objectMetadataDeleteCollection: ObjectMetadataEntity[] = [];
// Field metadata
private readonly _fieldMetadataCreateCollection: PartialFieldMetadata[] = [];
private readonly _fieldMetadataUpdateCollection: (Partial<PartialFieldMetadata> & {
private readonly _fieldMetadataCreateCollection: ComputedPartialFieldMetadata[] =
[];
private readonly _fieldMetadataUpdateCollection: (Partial<ComputedPartialFieldMetadata> & {
id: string;
})[] = [];
private readonly _fieldMetadataDeleteCollection: FieldMetadataEntity[] = [];
@ -67,11 +68,11 @@ export class WorkspaceSyncStorage {
return this._relationMetadataDeleteCollection;
}
addCreateObjectMetadata(object: PartialObjectMetadata) {
addCreateObjectMetadata(object: ComputedPartialObjectMetadata) {
this._objectMetadataCreateCollection.push(object);
}
addUpdateObjectMetadata(object: Partial<PartialObjectMetadata>) {
addUpdateObjectMetadata(object: Partial<ComputedPartialObjectMetadata>) {
this._objectMetadataUpdateCollection.push(object);
}
@ -79,12 +80,12 @@ export class WorkspaceSyncStorage {
this._objectMetadataDeleteCollection.push(object);
}
addCreateFieldMetadata(field: PartialFieldMetadata) {
addCreateFieldMetadata(field: ComputedPartialFieldMetadata) {
this._fieldMetadataCreateCollection.push(field);
}
addUpdateFieldMetadata(
field: Partial<PartialFieldMetadata> & { id: string },
field: Partial<ComputedPartialFieldMetadata> & { id: string },
) {
this._fieldMetadataUpdateCollection.push(field);
}

72
packages/twenty-server/src/workspace/workspace-sync-metadata/utils/compute-standard-object.util.ts Normal file
View File

@ -0,0 +1,72 @@
import {
ComputedPartialObjectMetadata,
PartialObjectMetadata,
} from 'src/workspace/workspace-sync-metadata/interfaces/partial-object-metadata.interface';
import { ComputedPartialFieldMetadata } from 'src/workspace/workspace-sync-metadata/interfaces/partial-field-metadata.interface';
import { ObjectMetadataEntity } from 'src/metadata/object-metadata/object-metadata.entity';
import { generateTargetColumnMap } from 'src/metadata/field-metadata/utils/generate-target-column-map.util';
import { FieldMetadataType } from 'src/metadata/field-metadata/field-metadata.entity';
export const computeStandardObject = (
standardObjectMetadata: PartialObjectMetadata,
originalObjectMetadata: ObjectMetadataEntity,
customObjectMetadataCollection: ObjectMetadataEntity[] = [],
): ComputedPartialObjectMetadata => {
const fields: ComputedPartialFieldMetadata[] = [];
for (const partialFieldMetadata of standardObjectMetadata.fields) {
if ('paramsFactory' in partialFieldMetadata) {
// Compute standard fields of custom object
for (const customObjectMetadata of customObjectMetadataCollection) {
const { paramsFactory, ...rest } = partialFieldMetadata;
const { joinColumn, ...data } = paramsFactory(customObjectMetadata);
// Relation
fields.push({
...data,
...rest,
defaultValue: null,
targetColumnMap: {},
});
// Foreign key
fields.push({
...rest,
name: joinColumn,
type: FieldMetadataType.UUID,
label: `${data.label} ID (foreign key)`,
description: `${data.description} id foreign key`,
defaultValue: null,
icon: undefined,
targetColumnMap: generateTargetColumnMap(
FieldMetadataType.UUID,
rest.isCustom,
joinColumn,
),
isSystem: true,
});
}
} else {
const labelText =
typeof partialFieldMetadata.label === 'function'
? partialFieldMetadata.label(originalObjectMetadata)
: partialFieldMetadata.label;
const descriptionText =
typeof partialFieldMetadata.description === 'function'
? partialFieldMetadata.description(originalObjectMetadata)
: partialFieldMetadata.description;
fields.push({
...partialFieldMetadata,
label: labelText,
description: descriptionText,
});
}
}
return {
...standardObjectMetadata,
fields,
};
};

2
packages/twenty-server/src/workspace/workspace-sync-metadata/workspace-sync-metadata.module.ts
View File

@ -13,6 +13,7 @@ import { workspaceSyncMetadataComparators } from 'src/workspace/workspace-sync-m
import { WorkspaceMetadataUpdaterService } from 'src/workspace/workspace-sync-metadata/services/workspace-metadata-updater.service';
import { WorkspaceSyncObjectMetadataService } from 'src/workspace/workspace-sync-metadata/services/workspace-sync-object-metadata.service';
import { WorkspaceSyncRelationMetadataService } from 'src/workspace/workspace-sync-metadata/services/workspace-sync-relation-metadata.service';
import { WorkspaceSyncFieldMetadataService } from 'src/workspace/workspace-sync-metadata/services/workspace-sync-field-metadata.service';
import { WorkspaceMigrationBuilderModule } from 'src/workspace/workspace-migration-builder/workspace-migration-builder.module';
@Module({
@ -36,6 +37,7 @@ import { WorkspaceMigrationBuilderModule } from 'src/workspace/workspace-migrati
WorkspaceMetadataUpdaterService,
WorkspaceSyncObjectMetadataService,
WorkspaceSyncRelationMetadataService,
WorkspaceSyncFieldMetadataService,
WorkspaceSyncMetadataService,
],
exports: [WorkspaceSyncMetadataService],

22
packages/twenty-server/src/workspace/workspace-sync-metadata/workspace-sync-metadata.service.ts
View File

@ -9,9 +9,14 @@ import { WorkspaceMigrationRunnerService } from 'src/workspace/workspace-migrati
import { FeatureFlagFactory } from 'src/workspace/workspace-sync-metadata/factories/feature-flags.factory';
import { WorkspaceSyncObjectMetadataService } from 'src/workspace/workspace-sync-metadata/services/workspace-sync-object-metadata.service';
import { WorkspaceSyncRelationMetadataService } from 'src/workspace/workspace-sync-metadata/services/workspace-sync-relation-metadata.service';
import { WorkspaceSyncFieldMetadataService } from 'src/workspace/workspace-sync-metadata/services/workspace-sync-field-metadata.service';
import { WorkspaceSyncStorage } from 'src/workspace/workspace-sync-metadata/storage/workspace-sync.storage';
import { WorkspaceMigrationEntity } from 'src/metadata/workspace-migration/workspace-migration.entity';
interface SynchronizeOptions {
applyChanges?: boolean;
}
@Injectable()
export class WorkspaceSyncMetadataService {
private readonly logger = new Logger(WorkspaceSyncMetadataService.name);
@ -23,6 +28,7 @@ export class WorkspaceSyncMetadataService {
private readonly workspaceMigrationRunnerService: WorkspaceMigrationRunnerService,
private readonly workspaceSyncObjectMetadataService: WorkspaceSyncObjectMetadataService,
private readonly workspaceSyncRelationMetadataService: WorkspaceSyncRelationMetadataService,
private readonly workspaceSyncFieldMetadataService: WorkspaceSyncFieldMetadataService,
) {}
/**
@ -33,9 +39,9 @@ export class WorkspaceSyncMetadataService {
* @param dataSourceId
* @param workspaceId
*/
public async syncStandardObjectsAndFieldsMetadata(
public async synchronize(
context: WorkspaceSyncContext,
options: { applyChanges?: boolean } = { applyChanges: true },
options: SynchronizeOptions = { applyChanges: true },
): Promise<{
workspaceMigrations: WorkspaceMigrationEntity[];
storage: WorkspaceSyncStorage;
@ -62,6 +68,7 @@ export class WorkspaceSyncMetadataService {
this.logger.log('Syncing standard objects and fields metadata');
// 1 - Sync standard objects
const workspaceObjectMigrations =
await this.workspaceSyncObjectMetadataService.synchronize(
context,
@ -70,6 +77,16 @@ export class WorkspaceSyncMetadataService {
workspaceFeatureFlagsMap,
);
// 2 - Sync standard fields on custom objects
const workspaceFieldMigrations =
await this.workspaceSyncFieldMetadataService.synchronize(
context,
manager,
storage,
workspaceFeatureFlagsMap,
);
// 3 - Sync standard relations on standard and custom objects
const workspaceRelationMigrations =
await this.workspaceSyncRelationMetadataService.synchronize(
context,
@ -81,6 +98,7 @@ export class WorkspaceSyncMetadataService {
// Save workspace migrations into the database
workspaceMigrations = await workspaceMigrationRepository.save([
...workspaceObjectMigrations,
...workspaceFieldMigrations,
...workspaceRelationMigrations,
]);