Finalize twenty standard app as workspace migration object and fields (#16353)

# Introduction Related to https://github.com/twentyhq/core-team-issues/issues/1995 In this PR we're fixing the remaining object/fields validation errors resulting from standard objects and fields now passing a validation that wasn't when using the sync metadata ## Key Changes - **Field naming**: Renamed `iCalUID` to `iCalUid` for consistent camelCase convention across calendar events - **Enum standardization**: Uppercased enum values for message channels (email→EMAIL), message participants (from→FROM, to→TO, cc→CC, bcc→BCC), and message direction (incoming→INCOMING, outgoing→OUTGOING) - **Label simplification**: Removed example values from workspace member number format labels for cleaner UI - **Migration infrastructure**: Added `isSystemBuild` flag throughout field metadata service pipeline to allow system-level updates of standard fields that bypass normal restrictions ## Migrating the existing data We've created an upgrade command that will identify using the existing object and field standard id field that needs to be updated, even though the sync metadata still in usage could have fix them ( and the goal is to deprecate it by the end of the sprint ) We will call the updateOneField for each of them, we're passing by the field service in order to battle test what are going to be the temporary way to handle standard migrations when we will start deprecating the sync metadata but haven't still refactored the v2 workspace migration to be workspace agnostic ## Twenty eng migration Tested the whole migration + upgrade on twenty eng Here are generated workspace migration Records are handled natively gracefully too ### ICalUid ```json { "status": "success", "workspaceMigration": { "relatedFlatEntityMapsKeys": [ "flatFieldMetadataMaps", "flatIndexMaps", "flatViewFilterMaps", "flatViewGroupMaps", "flatViewMaps", "flatViewFieldMaps", "flatObjectMetadataMaps" ], "actions": [ { "type": "update_field", "fieldMetadataId": "", "objectMetadataId": "", "updates": [ { "from": "iCalUID", "to": "iCalUid", "property": "name" } ] } ], "workspaceId": "" } } ``` ### Incoming Outgoing None as already caps in database somehow ```json { "status": "success", "workspaceMigration": { "relatedFlatEntityMapsKeys": [ "flatFieldMetadataMaps", "flatIndexMaps", "flatViewFilterMaps", "flatViewGroupMaps", "flatViewMaps", "flatViewFieldMaps", "flatObjectMetadataMaps" ], "actions": [], "workspaceId": "" } } ``` ### EMAIL ```json { "status": "success", "workspaceMigration": { "relatedFlatEntityMapsKeys": [ "flatFieldMetadataMaps", "flatIndexMaps", "flatViewFilterMaps", "flatViewGroupMaps", "flatViewMaps", "flatViewFieldMaps", "flatObjectMetadataMaps" ], "actions": [ { "type": "update_field", "fieldMetadataId": "", "objectMetadataId": "", "updates": [ { "from": "'email'", "to": "'EMAIL'", "property": "defaultValue" }, { "from": [ { "color": "green", "id": "", "label": "Email", "position": 0, "value": "email" }, { "color": "blue", "id": "", "label": "SMS", "position": 1, "value": "sms" } ], "to": [ { "color": "green", "id": "", "label": "Email", "position": 0, "value": "EMAIL" }, { "color": "blue", "id": "", "label": "SMS", "position": 1, "value": "SMS" } ], "property": "options" } ] } ], "workspaceId": "e" } } ``` ### MessageParticipantRole ```json { "status": "success", "workspaceMigration": { "relatedFlatEntityMapsKeys": [ "flatFieldMetadataMaps", "flatIndexMaps", "flatViewFilterMaps", "flatViewGroupMaps", "flatViewMaps", "flatViewFieldMaps", "flatObjectMetadataMaps" ], "actions": [ { "type": "update_field", "fieldMetadataId": "", "objectMetadataId": "", "updates": [ { "from": "'from'", "to": "'FROM'", "property": "defaultValue" }, { "from": [ { "color": "green", "id": "", "label": "From", "position": 0, "value": "from" }, { "color": "blue", "id": "", "label": "To", "position": 1, "value": "to" }, { "color": "orange", "id": "", "label": "Cc", "position": 2, "value": "cc" }, { "color": "red", "id": "", "label": "Bcc", "position": 3, "value": "bcc" } ], "to": [ { "color": "green", "id": "", "label": "From", "position": 0, "value": "FROM" }, { "color": "blue", "id": "", "label": "To", "position": 1, "value": "TO" }, { "color": "orange", "id": "", "label": "Cc", "position": 2, "value": "CC" }, { "color": "red", "id": "", "label": "Bcc", "position": 3, "value": "BCC" } ], "property": "options" } ] } ], "workspaceId": "" } } ``` ### Workspace member number format labels ```json { "status": "success", "workspaceMigration": { "relatedFlatEntityMapsKeys": [ "flatFieldMetadataMaps", "flatIndexMaps", "flatViewFilterMaps", "flatViewGroupMaps", "flatViewMaps", "flatViewFieldMaps", "flatObjectMetadataMaps" ], "actions": [ { "type": "update_field", "fieldMetadataId": "", "objectMetadataId": "", "updates": [ { "from": [ { "color": "turquoise", "id": "", "label": "System", "position": 0, "value": "SYSTEM" }, { "color": "blue", "id": "", "label": "Commas and dot (1,234.56)", "position": 1, "value": "COMMAS_AND_DOT" }, { "color": "green", "id": "", "label": "Spaces and comma (1 234,56)", "position": 2, "value": "SPACES_AND_COMMA" }, { "color": "orange", "id": "", "label": "Dots and comma (1.234,56)", "position": 3, "value": "DOTS_AND_COMMA" }, { "color": "purple", "id": "", "label": "Apostrophe and dot (1'234.56)", "position": 4, "value": "APOSTROPHE_AND_DOT" } ], "to": [ { "color": "turquoise", "id": "", "label": "System", "position": 0, "value": "SYSTEM" }, { "color": "blue", "id": "", "label": "Commas and dot", "position": 1, "value": "COMMAS_AND_DOT" }, { "color": "green", "id": "", "label": "Spaces and comma", "position": 2, "value": "SPACES_AND_COMMA" }, { "color": "orange", "id": "", "label": "Dots and comma", "position": 3, "value": "DOTS_AND_COMMA" }, { "color": "purple", "id": "", "label": "Apostrophe and dot", "position": 4, "value": "APOSTROPHE_AND_DOT" } ], "property": "options" } ] } ], "workspaceId": "" } } ```
2025-12-09 14:09:48 +01:00
parent be91d870f9
commit 4996f3dd28
69 changed files with 807 additions and 193 deletions
@@ -1,10 +1,10 @@
 import { isNonEmptyString } from '@sniptt/guards';
+import { computeMetadataNameFromLabel } from 'twenty-shared/metadata';
 import {
  isDefined,
  trimAndRemoveDuplicatedWhitespacesFromObjectStringProperties,
 } from 'twenty-shared/utils';
 import { v4 } from 'uuid';
-import { computeMetadataNameFromLabel } from 'twenty-shared/metadata';

 import { type CreateAgentInput } from 'src/engine/metadata-modules/ai/ai-agent/dtos/create-agent.input';
 import { type FlatAgent } from 'src/engine/metadata-modules/flat-agent/types/flat-agent.type';
@@ -48,7 +48,7 @@ export const fromCreateAgentInputToFlatAgent = ({
    standardId,
    name: isNonEmptyString(createAgentInput.name)
      ? createAgentInput.name
-      : computeMetadataNameFromLabel(createAgentInput.label),
+      : computeMetadataNameFromLabel({ label: createAgentInput.label }),
    label: createAgentInput.label,
    icon: createAgentInput.icon ?? null,
    description: createAgentInput.description ?? null,
@@ -181,6 +181,7 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
      flatViewMaps: existingFlatViewMaps,
      flatViewFieldMaps: existingFlatViewFieldMaps,
      workspaceCustomApplicationId: workspaceCustomFlatApplication.id,
+      isSystemBuild,
    });

    if (inputTranspilationResult.status === 'fail') {
@@ -26,6 +26,7 @@ type ComputeFlatFieldToUpdateAndRelatedFlatFieldToUpdateArgs = {
  rawUpdateFieldInput: UpdateFieldInput;
  fromFlatFieldMetadata: FlatFieldMetadata;
  flatObjectMetadata: FlatObjectMetadata;
+  isSystemBuild: boolean;
 } & Pick<AllFlatEntityMaps, 'flatFieldMetadataMaps'>;
 // Note: Standard override is way too complex we should land a smoother implemenentation once we standardize
 // them across every flat entities
@@ -34,11 +35,13 @@ export const computeFlatFieldToUpdateAndRelatedFlatFieldToUpdate = ({
  rawUpdateFieldInput,
  flatFieldMetadataMaps,
  flatObjectMetadata,
+  isSystemBuild,
 }: ComputeFlatFieldToUpdateAndRelatedFlatFieldToUpdateArgs): ComputeFlatFieldToUpdateAndRelatedFlatFieldToUpdateReturnType => {
  const { standardOverrides, updatedEditableFieldProperties } =
    sanitizeRawUpdateFieldInput({
      existingFlatFieldMetadata: fromFlatFieldMetadata,
      rawUpdateFieldInput,
+      isSystemBuild,
    });

  const isStandardField = isStandardMetadata(fromFlatFieldMetadata);
@@ -48,7 +51,7 @@ export const computeFlatFieldToUpdateAndRelatedFlatFieldToUpdate = ({
      existing: fromFlatFieldMetadata,
      properties:
        FLAT_FIELD_METADATA_EDITABLE_PROPERTIES[
-          isStandardField ? 'standard' : 'custom'
+          isStandardField && !isSystemBuild ? 'standard' : 'custom'
        ],
      update: updatedEditableFieldProperties,
    }),
@@ -104,7 +107,7 @@ export const computeFlatFieldToUpdateAndRelatedFlatFieldToUpdate = ({
      >((relatedFlatFieldMetadataFrom) => {
        const relatedMorphPropertiesToUpdateTo =
          FLAT_FIELD_METADATA_MORPH_RELATION_EDITABLE_PROPERTIES_ON_SIBLING_MORPH_RELATION_UPDATE_CONSTANT[
-            isStandardField ? 'standard' : 'custom'
+            isStandardField && !isSystemBuild ? 'standard' : 'custom'
          ];
        const relatedFlatFieldMetadataTo = {
          ...mergeUpdateInExistingRecord({
@@ -24,6 +24,7 @@ import { isFlatFieldMetadataOfType } from 'src/engine/metadata-modules/flat-fiel
 type FromUpdateFieldInputToFlatFieldMetadataArgs = {
  updateFieldInput: UpdateFieldInput;
  workspaceCustomApplicationId: string;
+  isSystemBuild: boolean;
 } & Pick<
  AllFlatEntityMaps,
  | 'flatObjectMetadataMaps'
@@ -49,6 +50,7 @@ export const fromUpdateFieldInputToFlatFieldMetadata = ({
  flatViewGroupMaps,
  flatViewMaps,
  flatViewFieldMaps,
+  isSystemBuild,
 }: FromUpdateFieldInputToFlatFieldMetadataArgs): FieldInputTranspilationResult<FlatFieldMetadataAndIndexToUpdate> => {
  const updateFieldInputInformalProperties =
    extractAndSanitizeObjectStringFields(rawUpdateFieldInput, [
@@ -98,6 +100,7 @@ export const fromUpdateFieldInputToFlatFieldMetadata = ({
      flatObjectMetadata,
      fromFlatFieldMetadata: existingFlatFieldMetadataToUpdate,
      rawUpdateFieldInput,
+      isSystemBuild,
    });

  const { flatFieldMetadatasToCreate, flatIndexMetadatasToCreate } =
@@ -1,10 +1,10 @@
+import { computeMetadataNameFromLabel } from 'twenty-shared/metadata';
 import {
  FieldMetadataType,
  RelationOnDeleteAction,
  RelationType,
 } from 'twenty-shared/types';
 import { v4 } from 'uuid';
-import { computeMetadataNameFromLabel } from 'twenty-shared/metadata';

 import { type CreateFieldInput } from 'src/engine/metadata-modules/field-metadata/dtos/create-field.input';
 import { type MorphOrRelationFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/types/morph-or-relation-field-metadata-type.type';
@@ -100,7 +100,9 @@ export const generateMorphOrRelationFlatFieldMetadataPair = ({
    label: relationCreationPayload.targetFieldLabel,
    name:
      targetFieldName ??
-      computeMetadataNameFromLabel(relationCreationPayload.targetFieldLabel),
+      computeMetadataNameFromLabel({
+        label: relationCreationPayload.targetFieldLabel,
+      }),
    objectMetadataId: targetFlatObjectMetadata.id,
    type: FieldMetadataType.RELATION,
    workspaceId,
@@ -2,13 +2,20 @@ import { computeMetadataNameFromLabel } from 'twenty-shared/metadata';

 import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';

-export const isFlatFieldMetadataNameSyncedWithLabel = (
+export const isFlatFieldMetadataNameSyncedWithLabel = ({
+  flatFieldMetadata,
+  isSystemBuild,
+}: {
  flatFieldMetadata: Pick<
    FlatFieldMetadata,
    'name' | 'isLabelSyncedWithName' | 'label'
-  >,
-) => {
-  const computedName = computeMetadataNameFromLabel(flatFieldMetadata.label);
+  >;
+  isSystemBuild: boolean;
+}) => {
+  const computedName = computeMetadataNameFromLabel({
+    label: flatFieldMetadata.label,
+    applyCustomSuffix: !isSystemBuild,
+  });

  return flatFieldMetadata.name === computedName;
 };
@@ -18,10 +18,12 @@ import { isStandardMetadata } from 'src/engine/metadata-modules/utils/is-standar
 type SanitizeRawUpdateFieldInputArgs = {
  rawUpdateFieldInput: UpdateFieldInput;
  existingFlatFieldMetadata: FlatFieldMetadata;
+  isSystemBuild: boolean;
 };
 export const sanitizeRawUpdateFieldInput = ({
  existingFlatFieldMetadata,
  rawUpdateFieldInput,
+  isSystemBuild,
 }: SanitizeRawUpdateFieldInputArgs) => {
  const isStandardField = isStandardMetadata(existingFlatFieldMetadata);
  const updatedEditableFieldProperties = extractAndSanitizeObjectStringFields(
@@ -43,7 +45,7 @@ export const sanitizeRawUpdateFieldInput = ({
        ...option,
      }));

-  if (!isStandardField) {
+  if (!isStandardField || isSystemBuild) {
    return {
      updatedEditableFieldProperties,
      standardOverrides: null,
@@ -2,16 +2,25 @@ import { computeMetadataNameFromLabel } from 'twenty-shared/metadata';

 import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';

-export const areFlatObjectMetadataNamesSyncedWithLabels = (
+export const areFlatObjectMetadataNamesSyncedWithLabels = ({
+  flatObjectdMetadata,
+  isSystemBuild,
+}: {
+  isSystemBuild: boolean;
  flatObjectdMetadata: Pick<
    FlatObjectMetadata,
    'namePlural' | 'nameSingular' | 'labelPlural' | 'labelSingular'
-  >,
-) => {
+  >;
+}) => {
  const [computedSingularName, computedPluralName] = [
    flatObjectdMetadata.labelSingular,
    flatObjectdMetadata.labelPlural,
-  ].map(computeMetadataNameFromLabel);
+  ].map((label) =>
+    computeMetadataNameFromLabel({
+      label,
+      applyCustomSuffix: !isSystemBuild,
+    }),
+  );

  return (
    flatObjectdMetadata.nameSingular === computedSingularName &&
@@ -8,6 +8,7 @@ import { areFlatObjectMetadataNamesSyncedWithLabels } from 'src/engine/metadata-
 import { validateFlatObjectMetadataLabel } from 'src/engine/metadata-modules/flat-object-metadata/validators/utils/validate-flat-object-metadata-label.util';
 import { validateFlatObjectMetadataNames } from 'src/engine/metadata-modules/flat-object-metadata/validators/utils/validate-flat-object-metadata-name.util';
 import { ObjectMetadataExceptionCode } from 'src/engine/metadata-modules/object-metadata/object-metadata.exception';
+import { type WorkspaceMigrationBuilderOptions } from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-builder-v2/types/workspace-migration-builder-options.type';

 type ValidateNoOtherObjectWithSameNameExistsOrThrowsParams = {
  objectMetadataNameSingular: string;
@@ -36,9 +37,11 @@ export const doesOtherObjectWithSameNameExists = ({
 export const validateFlatObjectMetadataNameAndLabels = ({
  optimisticFlatObjectMetadataMaps,
  flatObjectMetadataToValidate,
+  buildOptions,
 }: {
  flatObjectMetadataToValidate: FlatObjectMetadata;
  optimisticFlatObjectMetadataMaps: FlatEntityMaps<FlatObjectMetadata>;
+  buildOptions: WorkspaceMigrationBuilderOptions;
 }): FlatObjectMetadataValidationError[] => {
  const errors: FlatObjectMetadataValidationError[] = [];

@@ -58,7 +61,10 @@ export const validateFlatObjectMetadataNameAndLabels = ({

  if (
    flatObjectMetadataToValidate.isLabelSyncedWithName &&
-    !areFlatObjectMetadataNamesSyncedWithLabels(flatObjectMetadataToValidate)
+    !areFlatObjectMetadataNamesSyncedWithLabels({
+      flatObjectdMetadata: flatObjectMetadataToValidate,
+      isSystemBuild: buildOptions.isSystemBuild,
+    })
  ) {
    errors.push({
      code: ObjectMetadataExceptionCode.INVALID_OBJECT_INPUT,
@@ -17,7 +17,7 @@ export const computeMetadataNameFromLabelOrThrow = (label: string): string => {
  }

  try {
-    return computeMetadataNameFromLabelCore(label);
+    return computeMetadataNameFromLabelCore({ label });
  } catch (error) {
    if (error instanceof Error) {
      throw new InvalidMetadataException(