Object metadata API create one using workspace migration v2 (#13420)

# Introduction
In this PR we create basic transpilation methods and utils to handle
input to flat, entity to flat, object maps to flat. In order to
transpile everything into a common validation that will be implemented
in another PR

## FieldMetadataEntity typing
Added `never | null` to fields that should never be in order to ease
general abstracted method to pass null, as anw it's what is in the
database

## Todo
- ~~Create a feature flag~~
- Integration test for object creation through metadata api + pg col
introspection and snapshoting
This commit is contained in:
Paul Rastoin
2025-07-29 17:47:28 +02:00
committed by GitHub
parent 600df4fd90
commit c1bf0a1fbf
66 changed files with 1224 additions and 164 deletions
@@ -1,56 +0,0 @@
import { faker } from '@faker-js/faker';
import { FieldMetadataType } from 'twenty-shared/types';
import { FlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-field-metadata';
type FlatFieldMetadataOverrides<
T extends FieldMetadataType = FieldMetadataType,
> = Required<
Pick<FlatFieldMetadata<T>, 'uniqueIdentifier' | 'objectMetadataId' | 'type'>
> &
Partial<FlatFieldMetadata<T>>;
export const getFlatFieldMetadataMock = <T extends FieldMetadataType>(
overrides: FlatFieldMetadataOverrides<T>,
): FlatFieldMetadata => {
const createdAt = faker.date.anytime();
return {
defaultValue: null,
options: null,
settings: null,
createdAt,
description: 'default flat field metadata description',
icon: 'icon',
id: faker.string.uuid(),
isActive: true,
isCustom: true,
name: 'flatFieldMetadataName',
label: 'flat field metadata label',
isNullable: true,
isUnique: false,
isLabelSyncedWithName: false,
isSystem: false,
standardId: null,
standardOverrides: null,
updatedAt: createdAt,
workspaceId: faker.string.uuid(),
flatRelationTargetFieldMetadata: undefined as never,
relationTargetFieldMetadataId: undefined as never,
flatRelationTargetObjectMetadata: undefined as never,
relationTargetObjectMetadataId: undefined as never,
...overrides,
};
};
export const getStandardFlatFieldMetadataMock = (
overrides: Omit<FlatFieldMetadataOverrides, 'isCustom' | 'isSystem'>,
) => {
return getFlatFieldMetadataMock({
standardId: faker.string.uuid(),
standardOverrides: {},
isCustom: false,
isSystem: true,
...overrides,
});
};
@@ -1,24 +0,0 @@
import { faker } from '@faker-js/faker';
import { FlatIndexFieldMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-index-field-metadata';
type FlatIndexFieldMetadataOverrides = Required<
Pick<
FlatIndexFieldMetadata,
'fieldMetadataId' | 'indexMetadataId' | 'uniqueIdentifier'
>
> &
Partial<FlatIndexFieldMetadata>;
export const getFlatIndexFieldMetadataMock = (
overrides: FlatIndexFieldMetadataOverrides,
): FlatIndexFieldMetadata => {
const createdAt = faker.date.anytime();
return {
createdAt,
id: faker.string.uuid(),
order: faker.number.int(),
updatedAt: createdAt,
...overrides,
};
};
@@ -1,37 +0,0 @@
import { faker } from '@faker-js/faker';
import { IndexType } from 'src/engine/metadata-modules/index-metadata/types/indexType.types';
import { FlatIndexMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-index-metadata';
type FlatIndexMetadataOverrides = Required<
Pick<FlatIndexMetadata, 'uniqueIdentifier' | 'objectMetadataId'>
> &
Partial<FlatIndexMetadata>;
export const getFlatIndexMetadataMock = (
overrides: FlatIndexMetadataOverrides,
): FlatIndexMetadata => {
const createdAt = faker.date.anytime();
return {
flatIndexFieldMetadatas: [],
createdAt,
id: faker.string.uuid(),
indexType: IndexType.BTREE,
indexWhereClause: undefined,
isCustom: false,
isUnique: false,
name: 'defaultFlatIndexMetadataName',
updatedAt: createdAt,
workspaceId: faker.string.uuid(),
...overrides,
};
};
export const getStandardFlatIndexMetadataMock = (
overrides: Omit<FlatIndexMetadataOverrides, 'isCustom'>,
) => {
return getFlatIndexMetadataMock({
isCustom: false,
...overrides,
});
};
@@ -1,56 +0,0 @@
import { faker } from '@faker-js/faker';
import { FlatObjectMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-object-metadata';
type FlatObjectMetadataOverrides = Required<
Pick<FlatObjectMetadata, 'uniqueIdentifier'>
> &
Partial<FlatObjectMetadata>;
export const getFlatObjectMetadataMock = (
overrides: FlatObjectMetadataOverrides,
): FlatObjectMetadata => {
const createdAt = faker.date.anytime();
return {
flatFieldMetadatas: [],
flatIndexMetadatas: [],
createdAt,
dataSourceId: faker.string.uuid(),
description: 'default flat object metadata description',
duplicateCriteria: [],
icon: 'icon',
id: faker.string.uuid(),
imageIdentifierFieldMetadataId: faker.string.uuid(),
isActive: true,
isAuditLogged: true,
isCustom: true,
isLabelSyncedWithName: false,
isRemote: false,
isSearchable: true,
isSystem: false,
labelIdentifierFieldMetadataId: faker.string.uuid(),
labelPlural: 'default flat object metadata label plural',
labelSingular: 'default flat object metadata label singular',
namePlural: 'defaultflatObjectMetadataNamePlural',
nameSingular: 'defaultflatObjectMetadataNameSingular',
shortcut: 'shortcut',
standardId: null,
standardOverrides: null,
targetTableName: '',
updatedAt: createdAt,
workspaceId: faker.string.uuid(),
...overrides,
};
};
export const getStandardFlatObjectMetadataMock = (
overrides: Omit<FlatObjectMetadataOverrides, 'isCustom' | 'isSystem'>,
) => {
return getFlatObjectMetadataMock({
standardId: faker.string.uuid(),
standardOverrides: {},
isCustom: false,
isSystem: true,
...overrides,
});
};
@@ -1,32 +0,0 @@
import { FieldMetadataType } from 'twenty-shared/types';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { AssignTypeIfIsRelationFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/types/assign-type-if-is-relation-field-metadata-type.type';
import { FlatObjectMetadataWithoutFields } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-object-metadata';
const fieldMetadataRelationProperties = [
'relationTargetFieldMetadata',
'relationTargetObjectMetadata',
'fieldPermissions',
'indexFieldMetadatas',
'object',
] as const satisfies (keyof FieldMetadataEntity)[];
type FieldMetadataEntityRelationProperties =
(typeof fieldMetadataRelationProperties)[number];
export type FlatFieldMetadata<T extends FieldMetadataType = FieldMetadataType> =
Omit<FieldMetadataEntity<T>, FieldMetadataEntityRelationProperties> & {
uniqueIdentifier: string;
flatRelationTargetFieldMetadata: AssignTypeIfIsRelationFieldMetadataType<
Omit<
FlatFieldMetadata,
'flatRelationTargetFieldMetadata' | 'flatRelationTargetObjectMetadata'
>,
T
>;
flatRelationTargetObjectMetadata: AssignTypeIfIsRelationFieldMetadataType<
FlatObjectMetadataWithoutFields,
T
>;
};
@@ -1,16 +0,0 @@
import { IndexMetadataEntity } from 'src/engine/metadata-modules/index-metadata/index-metadata.entity';
import { ExtractRecordTypeOrmRelationProperties } from 'src/engine/workspace-manager/workspace-migration-v2/types/extract-record-typeorm-relation-properties.type';
import { FlatIndexFieldMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-index-field-metadata';
import { MetadataEntitiesRelationTarget } from 'src/engine/workspace-manager/workspace-migration-v2/types/metadata-entities-relation-targets.type';
type IndexMetadataRelationProperties = ExtractRecordTypeOrmRelationProperties<
IndexMetadataEntity,
MetadataEntitiesRelationTarget
>;
export type FlatIndexMetadata = Partial<
Omit<IndexMetadataEntity, IndexMetadataRelationProperties>
> & {
flatIndexFieldMetadatas: FlatIndexFieldMetadata[];
uniqueIdentifier: string;
};
@@ -1,25 +0,0 @@
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { ExtractRecordTypeOrmRelationProperties } from 'src/engine/workspace-manager/workspace-migration-v2/types/extract-record-typeorm-relation-properties.type';
import { FlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-field-metadata';
import { FlatIndexMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-index-metadata';
import { MetadataEntitiesRelationTarget } from 'src/engine/workspace-manager/workspace-migration-v2/types/metadata-entities-relation-targets.type';
type ObjectMetadataRelationProperties = ExtractRecordTypeOrmRelationProperties<
ObjectMetadataEntity,
MetadataEntitiesRelationTarget
>;
export type FlatObjectMetadata = Omit<
ObjectMetadataEntity,
ObjectMetadataRelationProperties
> & {
uniqueIdentifier: string;
flatIndexMetadatas: FlatIndexMetadata[];
flatFieldMetadatas: FlatFieldMetadata[];
};
// Could be renamed
export type FlatObjectMetadataWithoutFields = Omit<
FlatObjectMetadata,
'flatFieldMetadatas' | 'flatIndexMetadatas'
>;
@@ -1,4 +0,0 @@
export type FromTo<T> = {
from: T;
to: T;
};
@@ -1,4 +1,4 @@
import { FromTo } from 'src/engine/workspace-manager/workspace-migration-v2/types/from-to.type';
import { FromTo } from 'twenty-shared/types';
export type DeletedCreatedUpdatedMatrix<T> = {
created: T[];
@@ -1,120 +0,0 @@
import diff from 'microdiff';
import { FieldMetadataType } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { isRelationFieldMetadataType } from 'src/engine/utils/is-relation-field-metadata-type.util';
import { FlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-field-metadata';
import { FromTo } from 'src/engine/workspace-manager/workspace-migration-v2/types/from-to.type';
import { UpdateFieldAction } from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-builder-v2/types/workspace-migration-field-action-v2';
import { transformMetadataForComparison } from 'src/engine/workspace-manager/workspace-sync-metadata/comparators/utils/transform-metadata-for-comparison.util';
const flatFieldMetadataPropertiesToCompare = [
'defaultValue',
'description',
'icon',
'isActive',
'isLabelSyncedWithName',
'isUnique',
'label',
'name',
'options',
'standardOverrides',
'settings',
// To reactivate once we authorize relation edition, see https://github.com/twentyhq/twenty/commit/39f6f3c4bb101272a9014e142a842d0801a3c33b
// 'relationTargetFieldMetadataId',
// 'relationTargetObjectMetadataId',
///
] as const satisfies (keyof FlatFieldMetadata)[];
export type FlatFieldMetadataPropertiesToCompare =
(typeof flatFieldMetadataPropertiesToCompare)[number];
const fieldMetadataPropertiesToStringify = [
'defaultValue',
'standardOverrides',
'settings',
] as const satisfies FlatFieldMetadataPropertiesToCompare[];
const shouldNotOverrideDefaultValue = (type: FieldMetadataType) => {
return [
FieldMetadataType.BOOLEAN,
FieldMetadataType.SELECT,
FieldMetadataType.MULTI_SELECT,
FieldMetadataType.CURRENCY,
FieldMetadataType.PHONES,
FieldMetadataType.ADDRESS,
].includes(type);
};
type GetWorkspaceMigrationUpdateFieldActionArgs = FromTo<FlatFieldMetadata>;
export const compareTwoFlatFieldMetadata = ({
from,
to,
}: GetWorkspaceMigrationUpdateFieldActionArgs) => {
const compareFieldMetadataOptions = {
shouldIgnoreProperty: (
property: string,
fieldMetadata: FlatFieldMetadata,
) => {
if (
!flatFieldMetadataPropertiesToCompare.includes(
property as FlatFieldMetadataPropertiesToCompare,
)
) {
return true;
}
if (
property === 'defaultValue' &&
isDefined(fieldMetadata.type) &&
shouldNotOverrideDefaultValue(fieldMetadata.type)
) {
return true;
}
// Remove below assertion when we authorize relation edition, see https://github.com/twentyhq/twenty/commit/39f6f3c4bb101272a9014e142a842d0801a3c33b
if (
isDefined(fieldMetadata.type) &&
isRelationFieldMetadataType(fieldMetadata.type) &&
!['label', 'description', 'isActive'].includes(property)
) {
return true;
}
return false;
},
propertiesToStringify: fieldMetadataPropertiesToStringify,
};
const fromCompare = transformMetadataForComparison(
from,
compareFieldMetadataOptions,
);
const toCompare = transformMetadataForComparison(
to,
compareFieldMetadataOptions,
);
const flatFieldMetadataDifferences = diff(fromCompare, toCompare);
return flatFieldMetadataDifferences.flatMap<
UpdateFieldAction['updates'][number]
>((difference) => {
switch (difference.type) {
case 'CHANGE': {
const { oldValue, path, value } = difference;
return {
from: oldValue,
to: value,
property: path[0] as FlatFieldMetadataPropertiesToCompare,
};
}
case 'CREATE':
case 'REMOVE':
default: {
// Should never occurs, we should only provide null never undefined and so on
return [];
}
}
});
};
@@ -1,60 +0,0 @@
import diff from 'microdiff';
import { FlatIndexMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-index-metadata';
import { FromTo } from 'src/engine/workspace-manager/workspace-migration-v2/types/from-to.type';
import { transformMetadataForComparison } from 'src/engine/workspace-manager/workspace-sync-metadata/comparators/utils/transform-metadata-for-comparison.util';
const flatIndexMetadataPropertiesToCompare = [
'flatIndexFieldMetadatas', // Comparing this as whole ? should iterate on each keys ? => TBD should only map over cols as before ?
'indexType',
'indexWhereClause',
'isUnique',
'name',
] as const satisfies (keyof FlatIndexMetadata)[];
type FlatIndexMetadataPropertiesToCompare =
(typeof flatIndexMetadataPropertiesToCompare)[number];
// Should also handle indexFieldMetadata comparison ?
export const compareTwoFlatIndexMetadata = ({
from,
to,
}: FromTo<FlatIndexMetadata>) => {
const transformOptions = {
shouldIgnoreProperty: (property: string) =>
!flatIndexMetadataPropertiesToCompare.includes(
property as FlatIndexMetadataPropertiesToCompare,
),
};
const fromCompare = transformMetadataForComparison(from, transformOptions);
const toCompare = transformMetadataForComparison(to, transformOptions);
const flatIndexeDifferences = diff(fromCompare, toCompare);
return flatIndexeDifferences.flatMap<{ property: string } & FromTo<unknown>>(
(difference) => {
switch (difference.type) {
case 'CHANGE': {
const { oldValue, path, value } = difference;
const property = path[0];
if (typeof property === 'number') {
return [];
}
return {
from: oldValue,
property,
to: value,
};
}
case 'CREATE':
case 'REMOVE':
default:
return [];
}
},
);
};
@@ -1,79 +0,0 @@
import omit from 'lodash.omit';
import diff from 'microdiff';
import { assertUnreachable } from 'twenty-shared/utils';
import { FlatObjectMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-object-metadata';
import { FromTo } from 'src/engine/workspace-manager/workspace-migration-v2/types/from-to.type';
import { UpdateObjectAction } from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-builder-v2/types/workspace-migration-object-action-v2';
import { transformMetadataForComparison } from 'src/engine/workspace-manager/workspace-sync-metadata/comparators/utils/transform-metadata-for-comparison.util';
const flatObjectMetadataPropertiesToCompare = [
'description',
'icon',
'isActive',
'isLabelSyncedWithName',
'labelPlural',
'labelSingular',
'namePlural',
'nameSingular',
'standardOverrides', // Only if standard
] as const satisfies (keyof FlatObjectMetadata)[];
export type FlatObjectMetadataPropertiesToCompare =
(typeof flatObjectMetadataPropertiesToCompare)[number];
export const compareTwoFlatObjectMetadata = ({
from,
to,
}: FromTo<FlatObjectMetadata>) => {
const fromCompare = transformMetadataForComparison(from, {});
const toCompare = transformMetadataForComparison(to, {});
const objectMetadataDifference = diff(fromCompare, omit(toCompare, 'fields'));
return objectMetadataDifference.flatMap<
UpdateObjectAction['updates'][number]
>((difference) => {
switch (difference.type) {
case 'CHANGE': {
if (
difference.oldValue === null &&
(difference.value === null || difference.value === undefined)
) {
return [];
}
const property = difference.path[0];
// TODO investigate why it would be a number, in case of array I guess ?
if (typeof property === 'number') {
return [];
}
// Could be handled directly from the diff we do above
if (
!flatObjectMetadataPropertiesToCompare.includes(
property as FlatObjectMetadataPropertiesToCompare,
)
) {
return [];
}
return {
property: property as FlatObjectMetadataPropertiesToCompare,
from: difference.oldValue,
to: difference.value,
};
}
case 'CREATE':
case 'REMOVE': {
// Should never occurs ? should throw ?
return [];
}
default: {
assertUnreachable(
difference,
`Unexpected difference type: ${difference['type']}`,
);
}
}
});
};
@@ -1,13 +0,0 @@
import { FieldMetadataType } from 'twenty-shared/types';
import { FlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-field-metadata';
export function isFlatFieldMetadataEntityOfType<
Field extends FlatFieldMetadata<FieldMetadataType>,
Type extends FieldMetadataType,
>(
fieldMetadata: Pick<Field, 'type'>,
type: Type,
): fieldMetadata is Field & FlatFieldMetadata<Type> {
return fieldMetadata.type === type;
}
@@ -9,8 +9,8 @@ exports[`Workspace migration builder field actions test suite It should build a
"createdAt": Any<ClockDate>,
"defaultValue": null,
"description": "default flat field metadata description",
"flatRelationTargetFieldMetadata": undefined,
"flatRelationTargetObjectMetadata": undefined,
"flatRelationTargetFieldMetadata": null,
"flatRelationTargetObjectMetadata": null,
"icon": "icon",
"id": Any<String>,
"isActive": true,
@@ -23,8 +23,8 @@ exports[`Workspace migration builder field actions test suite It should build a
"name": "flatFieldMetadataName",
"objectMetadataId": Any<String>,
"options": null,
"relationTargetFieldMetadataId": undefined,
"relationTargetObjectMetadataId": undefined,
"relationTargetFieldMetadataId": null,
"relationTargetObjectMetadataId": null,
"settings": null,
"standardId": null,
"standardOverrides": null,
@@ -73,8 +73,8 @@ exports[`Workspace migration builder field actions test suite It should build an
"createdAt": Any<ClockDate>,
"defaultValue": null,
"description": "default flat field metadata description",
"flatRelationTargetFieldMetadata": undefined,
"flatRelationTargetObjectMetadata": undefined,
"flatRelationTargetFieldMetadata": null,
"flatRelationTargetObjectMetadata": null,
"icon": "icon",
"id": Any<String>,
"isActive": true,
@@ -87,8 +87,8 @@ exports[`Workspace migration builder field actions test suite It should build an
"name": "flatFieldMetadataName",
"objectMetadataId": Any<String>,
"options": null,
"relationTargetFieldMetadataId": undefined,
"relationTargetObjectMetadataId": undefined,
"relationTargetFieldMetadataId": null,
"relationTargetObjectMetadataId": null,
"settings": null,
"standardId": null,
"standardOverrides": null,
@@ -141,8 +141,8 @@ exports[`Workspace migration builder field actions test suite It should build an
"createdAt": Any<ClockDate>,
"defaultValue": null,
"description": "default flat field metadata description",
"flatRelationTargetFieldMetadata": undefined,
"flatRelationTargetObjectMetadata": undefined,
"flatRelationTargetFieldMetadata": null,
"flatRelationTargetObjectMetadata": null,
"icon": "icon",
"id": Any<String>,
"isActive": true,
@@ -155,8 +155,8 @@ exports[`Workspace migration builder field actions test suite It should build an
"name": "flatFieldMetadataName",
"objectMetadataId": Any<String>,
"options": null,
"relationTargetFieldMetadataId": undefined,
"relationTargetObjectMetadataId": undefined,
"relationTargetFieldMetadataId": null,
"relationTargetObjectMetadataId": null,
"settings": null,
"standardId": null,
"standardOverrides": null,
@@ -257,8 +257,8 @@ exports[`Workspace migration builder field actions test suite It should build an
"createdAt": Any<ClockDate>,
"defaultValue": null,
"description": "new description",
"flatRelationTargetFieldMetadata": undefined,
"flatRelationTargetObjectMetadata": undefined,
"flatRelationTargetFieldMetadata": null,
"flatRelationTargetObjectMetadata": null,
"icon": "new icon",
"id": Any<String>,
"isActive": false,
@@ -271,8 +271,8 @@ exports[`Workspace migration builder field actions test suite It should build an
"name": "new name",
"objectMetadataId": Any<String>,
"options": null,
"relationTargetFieldMetadataId": undefined,
"relationTargetObjectMetadataId": undefined,
"relationTargetFieldMetadataId": null,
"relationTargetObjectMetadataId": null,
"settings": null,
"standardId": null,
"standardOverrides": null,
@@ -344,8 +344,8 @@ exports[`Workspace migration builder field actions test suite It should build an
"createdAt": Any<ClockDate>,
"defaultValue": null,
"description": "new description",
"flatRelationTargetFieldMetadata": undefined,
"flatRelationTargetObjectMetadata": undefined,
"flatRelationTargetFieldMetadata": null,
"flatRelationTargetObjectMetadata": null,
"icon": "icon",
"id": Any<String>,
"isActive": false,
@@ -552,8 +552,8 @@ exports[`Workspace migration builder object actions test suite It should build a
"createdAt": Any<ClockDate>,
"defaultValue": null,
"description": "default flat field metadata description",
"flatRelationTargetFieldMetadata": undefined,
"flatRelationTargetObjectMetadata": undefined,
"flatRelationTargetFieldMetadata": null,
"flatRelationTargetObjectMetadata": null,
"icon": "icon",
"id": Any<String>,
"isActive": true,
@@ -566,8 +566,8 @@ exports[`Workspace migration builder object actions test suite It should build a
"name": "flatFieldMetadataName",
"objectMetadataId": Any<String>,
"options": null,
"relationTargetFieldMetadataId": undefined,
"relationTargetObjectMetadataId": undefined,
"relationTargetFieldMetadataId": null,
"relationTargetObjectMetadataId": null,
"settings": null,
"standardId": null,
"standardOverrides": null,
@@ -611,8 +611,8 @@ exports[`Workspace migration builder object actions test suite It should build a
"createdAt": Any<ClockDate>,
"defaultValue": null,
"description": "default flat field metadata description",
"flatRelationTargetFieldMetadata": undefined,
"flatRelationTargetObjectMetadata": undefined,
"flatRelationTargetFieldMetadata": null,
"flatRelationTargetObjectMetadata": null,
"icon": "icon",
"id": Any<String>,
"isActive": true,
@@ -625,8 +625,8 @@ exports[`Workspace migration builder object actions test suite It should build a
"name": "flatFieldMetadataName",
"objectMetadataId": Any<String>,
"options": null,
"relationTargetFieldMetadataId": undefined,
"relationTargetObjectMetadataId": undefined,
"relationTargetFieldMetadataId": null,
"relationTargetObjectMetadataId": null,
"settings": null,
"standardId": null,
"standardOverrides": null,
@@ -670,8 +670,8 @@ exports[`Workspace migration builder object actions test suite It should build a
"createdAt": Any<ClockDate>,
"defaultValue": null,
"description": "default flat field metadata description",
"flatRelationTargetFieldMetadata": undefined,
"flatRelationTargetObjectMetadata": undefined,
"flatRelationTargetFieldMetadata": null,
"flatRelationTargetObjectMetadata": null,
"icon": "icon",
"id": Any<String>,
"isActive": true,
@@ -684,8 +684,8 @@ exports[`Workspace migration builder object actions test suite It should build a
"name": "flatFieldMetadataName",
"objectMetadataId": Any<String>,
"options": null,
"relationTargetFieldMetadataId": undefined,
"relationTargetObjectMetadataId": undefined,
"relationTargetFieldMetadataId": null,
"relationTargetObjectMetadataId": null,
"settings": null,
"standardId": null,
"standardOverrides": null,
@@ -729,8 +729,8 @@ exports[`Workspace migration builder object actions test suite It should build a
"createdAt": Any<ClockDate>,
"defaultValue": null,
"description": "default flat field metadata description",
"flatRelationTargetFieldMetadata": undefined,
"flatRelationTargetObjectMetadata": undefined,
"flatRelationTargetFieldMetadata": null,
"flatRelationTargetObjectMetadata": null,
"icon": "icon",
"id": Any<String>,
"isActive": true,
@@ -743,8 +743,8 @@ exports[`Workspace migration builder object actions test suite It should build a
"name": "flatFieldMetadataName",
"objectMetadataId": Any<String>,
"options": null,
"relationTargetFieldMetadataId": undefined,
"relationTargetObjectMetadataId": undefined,
"relationTargetFieldMetadataId": null,
"relationTargetObjectMetadataId": null,
"settings": null,
"standardId": null,
"standardOverrides": null,
@@ -788,8 +788,8 @@ exports[`Workspace migration builder object actions test suite It should build a
"createdAt": Any<ClockDate>,
"defaultValue": null,
"description": "default flat field metadata description",
"flatRelationTargetFieldMetadata": undefined,
"flatRelationTargetObjectMetadata": undefined,
"flatRelationTargetFieldMetadata": null,
"flatRelationTargetObjectMetadata": null,
"icon": "icon",
"id": Any<String>,
"isActive": true,
@@ -802,8 +802,8 @@ exports[`Workspace migration builder object actions test suite It should build a
"name": "flatFieldMetadataName",
"objectMetadataId": Any<String>,
"options": null,
"relationTargetFieldMetadataId": undefined,
"relationTargetObjectMetadataId": undefined,
"relationTargetFieldMetadataId": null,
"relationTargetObjectMetadataId": null,
"settings": null,
"standardId": null,
"standardOverrides": null,
@@ -3,8 +3,8 @@ import { FieldMetadataType } from 'twenty-shared/types';
import { RelationType } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-type.interface';
import { getFlatFieldMetadataMock } from 'src/engine/workspace-manager/workspace-migration-v2/__tests__/get-flat-field-metadata.mock';
import { getFlatObjectMetadataMock } from 'src/engine/workspace-manager/workspace-migration-v2/__tests__/get-flat-object-metadata.mock';
import { getFlatFieldMetadataMock } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/get-flat-field-metadata.mock';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
import { WorkspaceMigrationBuilderTestCase } from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-builder-v2/__tests__/types/workspace-migration-builder-test-case.type';
const basicObjectMetadataId = faker.string.uuid();
@@ -1,7 +1,7 @@
import { faker } from '@faker-js/faker';
import { getFlatIndexMetadataMock } from 'src/engine/workspace-manager/workspace-migration-v2/__tests__/get-flat-index-metadata.mock';
import { getFlatObjectMetadataMock } from 'src/engine/workspace-manager/workspace-migration-v2/__tests__/get-flat-object-metadata.mock';
import { getFlatIndexMetadataMock } from 'src/engine/metadata-modules/flat-index-metadata/__mocks__/get-flat-index-metadata.mock';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
import { WorkspaceMigrationBuilderTestCase } from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-builder-v2/__tests__/types/workspace-migration-builder-test-case.type';
// Should test more things such as flatFieldIndex diffing
@@ -1,9 +1,9 @@
import { faker } from '@faker-js/faker';
import { FieldMetadataType } from 'twenty-shared/types';
import { getFlatFieldMetadataMock } from 'src/engine/workspace-manager/workspace-migration-v2/__tests__/get-flat-field-metadata.mock';
import { getFlatIndexMetadataMock } from 'src/engine/workspace-manager/workspace-migration-v2/__tests__/get-flat-index-metadata.mock';
import { getFlatObjectMetadataMock } from 'src/engine/workspace-manager/workspace-migration-v2/__tests__/get-flat-object-metadata.mock';
import { getFlatFieldMetadataMock } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/get-flat-field-metadata.mock';
import { getFlatIndexMetadataMock } from 'src/engine/metadata-modules/flat-index-metadata/__mocks__/get-flat-index-metadata.mock';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
import { WorkspaceMigrationBuilderTestCase } from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-builder-v2/__tests__/types/workspace-migration-builder-test-case.type';
export const WORKSPACE_MIGRATION_OBJECT_BUILDER_TEST_CASES: WorkspaceMigrationBuilderTestCase[] =
@@ -0,0 +1,3 @@
export type ToMerge<T, K extends 'object' | 'field'> = {
[P in ['toMerge', 'dest'][number] as `${P}Flat${Capitalize<K>}Metadatas`]: T;
};
@@ -1,8 +1,9 @@
import { FromTo } from 'twenty-shared/types';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { FlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-field-metadata';
import { FlatObjectMetadataWithoutFields } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-object-metadata';
import { FromTo } from 'src/engine/workspace-manager/workspace-migration-v2/types/from-to.type';
import { FlatFieldMetadataPropertiesToCompare } from 'src/engine/workspace-manager/workspace-migration-v2/utils/flat-field-metadata-comparator.util';
import { FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
import { FlatFieldMetadataPropertiesToCompare } from 'src/engine/metadata-modules/flat-field-metadata/utils/compare-two-flat-field-metadata.util';
import { FlatObjectMetadataWithoutFields } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
export type CreateFieldAction = {
type: 'create_field';
@@ -1,4 +1,4 @@
import { FlatIndexMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-index-metadata';
import { FlatIndexMetadata } from 'src/engine/metadata-modules/flat-index-metadata/types/flat-index-metadata.type';
export type CreateIndexAction = {
type: 'create_index';
@@ -1,7 +1,8 @@
import { FromTo } from 'twenty-shared/types';
import { FlatObjectMetadataWithoutFields } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
import { FlatObjectMetadataPropertiesToCompare } from 'src/engine/metadata-modules/flat-object-metadata/utils/compare-two-flat-object-metadata.util';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { FlatObjectMetadataWithoutFields } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-object-metadata';
import { FromTo } from 'src/engine/workspace-manager/workspace-migration-v2/types/from-to.type';
import { FlatObjectMetadataPropertiesToCompare } from 'src/engine/workspace-manager/workspace-migration-v2/utils/flat-object-metadata-comparator.util';
import { CreateFieldAction } from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-builder-v2/types/workspace-migration-field-action-v2';
export type CreateObjectAction = {
@@ -1,6 +1,7 @@
import { FlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-field-metadata';
import { FlatObjectMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-object-metadata';
import { FromTo } from 'src/engine/workspace-manager/workspace-migration-v2/types/from-to.type';
import { FromTo } from 'twenty-shared/types';
import { FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
import { FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
import {
CustomDeletedCreatedUpdatedMatrix,
deletedCreatedUpdatedMatrixDispatcher,
@@ -1,9 +1,10 @@
import { FlatIndexMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-index-metadata';
import { FromTo } from 'twenty-shared/types';
import { FlatIndexMetadata } from 'src/engine/metadata-modules/flat-index-metadata/types/flat-index-metadata.type';
import {
FlatObjectMetadata,
FlatObjectMetadataWithoutFields,
} from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-object-metadata';
import { FromTo } from 'src/engine/workspace-manager/workspace-migration-v2/types/from-to.type';
} from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
import {
CustomDeletedCreatedUpdatedMatrix,
deletedCreatedUpdatedMatrixDispatcher,
@@ -1,7 +1,7 @@
import {
FlatObjectMetadata,
FlatObjectMetadataWithoutFields,
} from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-object-metadata';
} from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
export const fromFlatObjectMetadataToFlatObjectMetadataWithoutFields = ({
flatFieldMetadatas: _flatFieldMetadatas,
@@ -1,5 +1,5 @@
import { FlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-field-metadata';
import { FlatObjectMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-object-metadata';
import { FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
import { FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
import {
CreateFieldAction,
DeleteFieldAction,
@@ -1,4 +1,4 @@
import { FlatIndexMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-index-metadata';
import { FlatIndexMetadata } from 'src/engine/metadata-modules/flat-index-metadata/types/flat-index-metadata.type';
import {
CreateIndexAction,
DeleteIndexAction,
@@ -1,4 +1,4 @@
import { FlatObjectMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-object-metadata';
import { FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
import { CreateFieldAction } from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-builder-v2/types/workspace-migration-field-action-v2';
import {
CreateObjectAction,
@@ -1,7 +1,8 @@
import { Injectable } from '@nestjs/common';
import { FlatObjectMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-object-metadata';
import { FromTo } from 'src/engine/workspace-manager/workspace-migration-v2/types/from-to.type';
import { FromTo } from 'twenty-shared/types';
import { FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
import { deletedCreatedUpdatedMatrixDispatcher } from 'src/engine/workspace-manager/workspace-migration-v2/utils/deleted-created-updated-matrix-dispatcher.util';
import { WorkspaceMigrationV2 } from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-builder-v2/types/workspace-migration-v2';
import { computeUpdatedObjectMetadataDeletedCreatedUpdatedFieldMatrix } from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-builder-v2/utils/compute-updated-object-metadata-deleted-created-updated-field-matrix.util';
@@ -1,4 +1,4 @@
import { compareTwoFlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/utils/flat-field-metadata-comparator.util';
import { compareTwoFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/compare-two-flat-field-metadata.util';
import {
UpdateFieldAction,
WorkspaceMigrationFieldActionV2,
@@ -1,4 +1,4 @@
import { compareTwoFlatIndexMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/utils/flat-index-metadata-comparator.util';
import { compareTwoFlatIndexMetadata } from 'src/engine/metadata-modules/flat-index-metadata/utils/compare-two-flat-index-metadata.util';
import { WorkspaceMigrationIndexActionV2 } from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-builder-v2/types/workspace-migration-index-action-v2';
import { UpdatedObjectMetadataDeletedCreatedUpdatedIndexMatrix } from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-builder-v2/utils/compute-updated-object-metadata-deleted-created-updated-index-matrix.util';
import {
@@ -1,6 +1,6 @@
import { FlatObjectMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-object-metadata';
import { FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
import { compareTwoFlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/utils/compare-two-flat-object-metadata.util';
import { CustomDeletedCreatedUpdatedMatrix } from 'src/engine/workspace-manager/workspace-migration-v2/utils/deleted-created-updated-matrix-dispatcher.util';
import { compareTwoFlatObjectMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/utils/flat-object-metadata-comparator.util';
import {
UpdateObjectAction,
WorkspaceMigrationObjectActionV2,
@@ -1,8 +1,8 @@
import { In } from 'typeorm';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { FlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-field-metadata';
import { FlatFieldMetadataPropertiesToCompare } from 'src/engine/workspace-manager/workspace-migration-v2/utils/flat-field-metadata-comparator.util';
import { FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
import { FlatFieldMetadataPropertiesToCompare } from 'src/engine/metadata-modules/flat-field-metadata/utils/compare-two-flat-field-metadata.util';
import {
CreateFieldAction,
DeleteFieldAction,
@@ -1,9 +1,9 @@
import { Injectable } from '@nestjs/common';
import { DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
import { FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
import { FlatObjectMetadataPropertiesToCompare } from 'src/engine/metadata-modules/flat-object-metadata/utils/compare-two-flat-object-metadata.util';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { FlatObjectMetadata } from 'src/engine/workspace-manager/workspace-migration-v2/types/flat-object-metadata';
import { FlatObjectMetadataPropertiesToCompare } from 'src/engine/workspace-manager/workspace-migration-v2/utils/flat-object-metadata-comparator.util';
import {
CreateObjectAction,
DeleteObjectAction,