Allow to edit labels of standard objects (#10922)

Fixes #10793

This PR is a work in progress.

**Still left to fix:**

- [x] When disabling synchronization of labels / api names, the edited
labels should be set to the English version. Currently the client just
send the localized versions together with the `isLabelSyncedWithName`
change. Could be an easy fix.
- [ ] Sometimes flipping the switch don't trigger the update function,
may be a regression as it seems to affect the custom objects too.
- [ ] There is a frontend problem where the labels inputs don't reflect
the changes made. When enabling back synchronisation after editing
labels, they are correctly back to their base values (backend,
navigation breadcrumb, etc) but the label inputs still have the old
values (switching pages will put them back to normal). I suspect this
could be linked to the above problem.
- [ ] API names are still displayed for standard objects per (kept them
for debugging, trivial fix)
- [ ] `SettingsDataModelObjectAboutForm` have a `disableEdition`
parameter which is now used only for a few fields, not sure if it's
worth keeping because it's a bit misleading since it doesn't "disable"
much?
- [ ] I don't know what these do, but I have seen "Remote" object types.
Not sure if they work with my patch or not (I don't know how to test
them)
- [ ] Make it work with metadata synchronisation


**What should work:**

- Disabling synchronization of standard objects should work, label
inputs should no longer be disabled
- Modifying labels should work
- Enabling back synchronization should reset back the labels to the base
value and disable the label inputs again (minus the mentioned display
bug)
- The synchronisation switch should still work as expected for custom
objects
- Creating custom objects should still work (it uses the same form)

---------

Signed-off-by: AFCMS <afcm.contact@gmail.com>
Co-authored-by: Félix Malfait <felix@twenty.com>
Co-authored-by: Félix Malfait <felix.malfait@gmail.com>

packages/twenty-server/src/engine/metadata-modules/object-metadata/dtos/object-metadata.dto.ts

@@ -13,6 +13,7 @@ import { WorkspaceEntityDuplicateCriteria } from 'src/engine/api/graphql/workspa
 import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
 import { FieldMetadataDTO } from 'src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto';
 import { IndexMetadataDTO } from 'src/engine/metadata-modules/index-metadata/dtos/index-metadata.dto';
+import { ObjectStandardOverridesDTO } from 'src/engine/metadata-modules/object-metadata/dtos/object-standard-overrides.dto';
 import { BeforeDeleteOneObject } from 'src/engine/metadata-modules/object-metadata/hooks/before-delete-one-object.hook';
 
 @ObjectType('Object')
@@ -54,6 +55,9 @@ export class ObjectMetadataDTO {
   @Field({ nullable: true })
   icon: string;
 
+  @Field(() => ObjectStandardOverridesDTO, { nullable: true })
+  standardOverrides?: ObjectStandardOverridesDTO;
+
   @Field({ nullable: true })
   shortcut: string;
 

packages/twenty-server/src/engine/metadata-modules/object-metadata/dtos/object-standard-overrides.dto.ts

@@ -0,0 +1,26 @@
+import { Field, ObjectType } from '@nestjs/graphql';
+
+import { IsOptional, IsString } from 'class-validator';
+
+@ObjectType('ObjectStandardOverrides')
+export class ObjectStandardOverridesDTO {
+  @IsString()
+  @IsOptional()
+  @Field(() => String, { nullable: true })
+  labelSingular?: string | null;
+
+  @IsString()
+  @IsOptional()
+  @Field(() => String, { nullable: true })
+  labelPlural?: string | null;
+
+  @IsString()
+  @IsOptional()
+  @Field(() => String, { nullable: true })
+  description?: string | null;
+
+  @IsString()
+  @IsOptional()
+  @Field(() => String, { nullable: true })
+  icon?: string | null;
+}

packages/twenty-server/src/engine/metadata-modules/object-metadata/hooks/before-update-one-object.hook.ts

@@ -9,12 +9,19 @@ import {
   BeforeUpdateOneHook,
   UpdateOneInputType,
 } from '@ptc-org/nestjs-query-graphql';
+import { isDefined } from 'twenty-shared/utils';
 import { Equal, In, Repository } from 'typeorm';
 
 import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
+import { ObjectStandardOverridesDTO } from 'src/engine/metadata-modules/object-metadata/dtos/object-standard-overrides.dto';
 import { UpdateObjectPayload } from 'src/engine/metadata-modules/object-metadata/dtos/update-object.input';
+import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
 import { ObjectMetadataService } from 'src/engine/metadata-modules/object-metadata/object-metadata.service';
 
+interface StandardObjectUpdate extends Partial<UpdateObjectPayload> {
+  standardOverrides?: ObjectStandardOverridesDTO;
+}
+
 @Injectable()
 export class BeforeUpdateOneObject<T extends UpdateObjectPayload>
   implements BeforeUpdateOneHook<T>
@@ -35,6 +42,21 @@ export class BeforeUpdateOneObject<T extends UpdateObjectPayload>
       throw new UnauthorizedException();
     }
 
+    const objectMetadata = await this.getObjectMetadata(instance, workspaceId);
+
+    if (!objectMetadata.isCustom) {
+      return this.handleStandardObjectUpdate(instance, objectMetadata);
+    }
+
+    await this.validateIdentifierFields(instance, workspaceId);
+
+    return instance;
+  }
+
+  private async getObjectMetadata(
+    instance: UpdateOneInputType<T>,
+    workspaceId: string,
+  ) {
     const objectMetadata =
       await this.objectMetadataService.findOneWithinWorkspace(workspaceId, {
         where: {
@@ -46,58 +68,263 @@ export class BeforeUpdateOneObject<T extends UpdateObjectPayload>
       throw new BadRequestException('Object does not exist');
     }
 
-    if (!objectMetadata.isCustom) {
-      if (
-        Object.keys(instance.update).length === 1 &&
-        // eslint-disable-next-line no-prototype-builtins
-        instance.update.hasOwnProperty('isActive') &&
-        instance.update.isActive !== undefined
-      ) {
-        return {
-          id: instance.id,
-          update: {
-            isActive: instance.update.isActive,
-          } as T,
-        };
-      }
+    return objectMetadata;
+  }
 
+  private handleStandardObjectUpdate(
+    instance: UpdateOneInputType<T>,
+    objectMetadata: ObjectMetadataEntity,
+  ): UpdateOneInputType<T> {
+    const update: StandardObjectUpdate = {};
+    const updatableFields = ['isActive', 'isLabelSyncedWithName'];
+    const overridableFields = [
+      'labelSingular',
+      'labelPlural',
+      'icon',
+      'description',
+    ];
+
+    // Check if any field is not allowed
+    const nonUpdatableFields = Object.keys(instance.update).filter(
+      (key) =>
+        !updatableFields.includes(key) && !overridableFields.includes(key),
+    );
+
+    const hasNonUpdatableFields = nonUpdatableFields.length > 0;
+
+    const isUpdatingLabelsWhenSynced =
+      (instance.update.labelSingular || instance.update.labelPlural) &&
+      objectMetadata.isLabelSyncedWithName &&
+      instance.update.isLabelSyncedWithName !== false &&
+      (instance.update.labelSingular !== objectMetadata.labelSingular ||
+        instance.update.labelPlural !== objectMetadata.labelPlural);
+
+    if (isUpdatingLabelsWhenSynced) {
       throw new BadRequestException(
-        'Only isActive field can be updated for standard objects',
+        'Cannot update labels when they are synced with name',
       );
     }
 
-    if (
-      instance.update.labelIdentifierFieldMetadataId ||
-      instance.update.imageIdentifierFieldMetadataId
-    ) {
-      const fields = await this.fieldMetadataRepository.findBy({
-        workspaceId: Equal(workspaceId),
-        objectMetadataId: Equal(instance.id.toString()),
-        id: In(
-          [
-            instance.update.labelIdentifierFieldMetadataId,
-            instance.update.imageIdentifierFieldMetadataId,
-          ].filter((id) => id !== null),
-        ),
-      });
-
-      const fieldIds = fields.map((field) => field.id);
-
-      if (
-        instance.update.labelIdentifierFieldMetadataId &&
-        !fieldIds.includes(instance.update.labelIdentifierFieldMetadataId)
-      ) {
-        throw new BadRequestException('This label identifier does not exist');
-      }
-
-      if (
-        instance.update.imageIdentifierFieldMetadataId &&
-        !fieldIds.includes(instance.update.imageIdentifierFieldMetadataId)
-      ) {
-        throw new BadRequestException('This image identifier does not exist');
-      }
+    if (hasNonUpdatableFields) {
+      throw new BadRequestException(
+        `Only isActive, isLabelSyncedWithName, labelSingular, labelPlural, icon and description fields can be updated for standard objects. Disallowed fields: ${nonUpdatableFields.join(', ')}`,
+      );
     }
 
-    return instance;
+    //  preserve existing overrides
+    update.standardOverrides = objectMetadata.standardOverrides
+      ? { ...objectMetadata.standardOverrides }
+      : {};
+
+    this.handleActiveField(instance, update);
+    this.handleLabelSyncedWithNameField(instance, update);
+    this.handleStandardOverrides(instance, objectMetadata, update);
+
+    return {
+      id: instance.id,
+      update: update as T,
+    };
+  }
+
+  private handleActiveField(
+    instance: UpdateOneInputType<T>,
+    update: StandardObjectUpdate,
+  ): void {
+    if (!isDefined(instance.update.isActive)) {
+      return;
+    }
+
+    update.isActive = instance.update.isActive;
+  }
+
+  private handleLabelSyncedWithNameField(
+    instance: UpdateOneInputType<T>,
+    update: StandardObjectUpdate,
+  ): void {
+    if (!isDefined(instance.update.isLabelSyncedWithName)) {
+      return;
+    }
+
+    update.isLabelSyncedWithName = instance.update.isLabelSyncedWithName;
+
+    if (instance.update.isLabelSyncedWithName === false) {
+      return;
+    }
+
+    // If setting isLabelSyncedWithName to true, clear label overrides
+    update.standardOverrides = update.standardOverrides || {};
+    update.standardOverrides.labelSingular = null;
+    update.standardOverrides.labelPlural = null;
+  }
+
+  private handleStandardOverrides(
+    instance: UpdateOneInputType<T>,
+    objectMetadata: ObjectMetadataEntity,
+    update: StandardObjectUpdate,
+  ): void {
+    const hasStandardOverrides =
+      isDefined(instance.update.description) ||
+      isDefined(instance.update.icon) ||
+      isDefined(instance.update.labelSingular) ||
+      isDefined(instance.update.labelPlural);
+
+    if (!hasStandardOverrides) {
+      return;
+    }
+
+    update.standardOverrides = update.standardOverrides || {};
+
+    this.handleDescriptionOverride(instance, objectMetadata, update);
+    this.handleIconOverride(instance, objectMetadata, update);
+    this.handleLabelOverrides(instance, objectMetadata, update);
+  }
+
+  private handleDescriptionOverride(
+    instance: UpdateOneInputType<T>,
+    objectMetadata: ObjectMetadataEntity,
+    update: StandardObjectUpdate,
+  ): void {
+    if (!isDefined(instance.update.description)) {
+      return;
+    }
+
+    update.standardOverrides = update.standardOverrides || {};
+
+    if (instance.update.description === objectMetadata.description) {
+      update.standardOverrides.description = null;
+
+      return;
+    }
+
+    update.standardOverrides.description = instance.update.description;
+  }
+
+  private handleIconOverride(
+    instance: UpdateOneInputType<T>,
+    objectMetadata: ObjectMetadataEntity,
+    update: StandardObjectUpdate,
+  ): void {
+    if (!isDefined(instance.update.icon)) {
+      return;
+    }
+
+    update.standardOverrides = update.standardOverrides || {};
+
+    if (instance.update.icon === objectMetadata.icon) {
+      update.standardOverrides.icon = null;
+
+      return;
+    }
+
+    update.standardOverrides.icon = instance.update.icon;
+  }
+
+  private handleLabelOverrides(
+    instance: UpdateOneInputType<T>,
+    objectMetadata: ObjectMetadataEntity,
+    update: StandardObjectUpdate,
+  ): void {
+    // Skip label updates if labels are synced with name or will be synced
+    if (
+      objectMetadata.isLabelSyncedWithName ||
+      update.isLabelSyncedWithName === true
+    ) {
+      return;
+    }
+
+    this.handleLabelSingularOverride(instance, objectMetadata, update);
+    this.handleLabelPluralOverride(instance, objectMetadata, update);
+  }
+
+  private handleLabelSingularOverride(
+    instance: UpdateOneInputType<T>,
+    objectMetadata: ObjectMetadataEntity,
+    update: StandardObjectUpdate,
+  ): void {
+    if (!isDefined(instance.update.labelSingular)) {
+      return;
+    }
+
+    update.standardOverrides = update.standardOverrides || {};
+
+    if (instance.update.labelSingular === objectMetadata.labelSingular) {
+      update.standardOverrides.labelSingular = null;
+
+      return;
+    }
+
+    update.standardOverrides.labelSingular = instance.update.labelSingular;
+  }
+
+  private handleLabelPluralOverride(
+    instance: UpdateOneInputType<T>,
+    objectMetadata: ObjectMetadataEntity,
+    update: StandardObjectUpdate,
+  ): void {
+    if (!isDefined(instance.update.labelPlural)) {
+      return;
+    }
+
+    update.standardOverrides = update.standardOverrides || {};
+
+    if (instance.update.labelPlural === objectMetadata.labelPlural) {
+      update.standardOverrides.labelPlural = null;
+
+      return;
+    }
+
+    update.standardOverrides.labelPlural = instance.update.labelPlural;
+  }
+
+  private async validateIdentifierFields(
+    instance: UpdateOneInputType<T>,
+    workspaceId: string,
+  ): Promise<void> {
+    if (
+      !instance.update.labelIdentifierFieldMetadataId &&
+      !instance.update.imageIdentifierFieldMetadataId
+    ) {
+      return;
+    }
+
+    const fields = await this.fieldMetadataRepository.findBy({
+      workspaceId: Equal(workspaceId),
+      objectMetadataId: Equal(instance.id.toString()),
+      id: In(
+        [
+          instance.update.labelIdentifierFieldMetadataId,
+          instance.update.imageIdentifierFieldMetadataId,
+        ].filter((id) => id !== null),
+      ),
+    });
+
+    const fieldIds = fields.map((field) => field.id);
+
+    this.validateLabelIdentifier(instance, fieldIds);
+    this.validateImageIdentifier(instance, fieldIds);
+  }
+
+  private validateLabelIdentifier(
+    instance: UpdateOneInputType<T>,
+    fieldIds: string[],
+  ): void {
+    if (
+      instance.update.labelIdentifierFieldMetadataId &&
+      !fieldIds.includes(instance.update.labelIdentifierFieldMetadataId)
+    ) {
+      throw new BadRequestException('This label identifier does not exist');
+    }
+  }
+
+  private validateImageIdentifier(
+    instance: UpdateOneInputType<T>,
+    fieldIds: string[],
+  ): void {
+    if (
+      instance.update.imageIdentifierFieldMetadataId &&
+      !fieldIds.includes(instance.update.imageIdentifierFieldMetadataId)
+    ) {
+      throw new BadRequestException('This image identifier does not exist');
+    }
   }
 }

packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.entity.ts

@@ -16,6 +16,7 @@ import { WorkspaceEntityDuplicateCriteria } from 'src/engine/api/graphql/workspa
 import { DataSourceEntity } from 'src/engine/metadata-modules/data-source/data-source.entity';
 import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
 import { IndexMetadataEntity } from 'src/engine/metadata-modules/index-metadata/index-metadata.entity';
+import { ObjectStandardOverridesDTO } from 'src/engine/metadata-modules/object-metadata/dtos/object-standard-overrides.dto';
 import { ObjectPermissionsEntity } from 'src/engine/metadata-modules/object-permissions/object-permissions.entity';
 import { RelationMetadataEntity } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
 
@@ -53,6 +54,9 @@ export class ObjectMetadataEntity implements ObjectMetadataInterface {
   @Column({ nullable: true })
   icon: string;
 
+  @Column({ type: 'jsonb', nullable: true })
+  standardOverrides?: ObjectStandardOverridesDTO;
+
   @Column({ nullable: false })
   targetTableName: string;
 

packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.resolver.ts

@@ -41,7 +41,7 @@ export class ObjectMetadataResolver {
     @Parent() objectMetadata: ObjectMetadataDTO,
     @Context() context: I18nContext,
   ): Promise<string> {
-    return this.objectMetadataService.resolveTranslatableString(
+    return this.objectMetadataService.resolveOverridableString(
       objectMetadata,
       'labelPlural',
       context.req.headers['x-locale'],
@@ -53,7 +53,7 @@ export class ObjectMetadataResolver {
     @Parent() objectMetadata: ObjectMetadataDTO,
     @Context() context: I18nContext,
   ): Promise<string> {
-    return this.objectMetadataService.resolveTranslatableString(
+    return this.objectMetadataService.resolveOverridableString(
       objectMetadata,
       'labelSingular',
       context.req.headers['x-locale'],
@@ -65,13 +65,25 @@ export class ObjectMetadataResolver {
     @Parent() objectMetadata: ObjectMetadataDTO,
     @Context() context: I18nContext,
   ): Promise<string> {
-    return this.objectMetadataService.resolveTranslatableString(
+    return this.objectMetadataService.resolveOverridableString(
       objectMetadata,
       'description',
       context.req.headers['x-locale'],
     );
   }
 
+  @ResolveField(() => String, { nullable: true })
+  async icon(
+    @Parent() objectMetadata: ObjectMetadataDTO,
+    @Context() context: I18nContext,
+  ): Promise<string> {
+    return this.objectMetadataService.resolveOverridableString(
+      objectMetadata,
+      'icon',
+      context.req.headers['x-locale'],
+    );
+  }
+
   @UseGuards(SettingsPermissionsGuard(SettingsPermissions.DATA_MODEL))
   @Mutation(() => ObjectMetadataDTO)
   async deleteOneObject(
@@ -95,10 +107,13 @@ export class ObjectMetadataResolver {
     @AuthWorkspace() { id: workspaceId }: Workspace,
   ) {
     try {
-      await this.beforeUpdateOneObject.run(input, workspaceId);
+      const updatedInput = (await this.beforeUpdateOneObject.run(
+        input,
+        workspaceId,
+      )) as UpdateOneObjectInput;
 
       return await this.objectMetadataService.updateOneObject(
-        input,
+        updatedInput,
         workspaceId,
       );
     } catch (error) {

packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.service.ts

@@ -552,15 +552,22 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
     }
   };
 
-  async resolveTranslatableString(
+  async resolveOverridableString(
     objectMetadata: ObjectMetadataDTO,
-    labelKey: 'labelPlural' | 'labelSingular' | 'description',
+    labelKey: 'labelPlural' | 'labelSingular' | 'description' | 'icon',
     locale: keyof typeof APP_LOCALES | undefined,
   ): Promise<string> {
     if (objectMetadata.isCustom) {
       return objectMetadata[labelKey];
     }
 
+    if (
+      objectMetadata.standardOverrides &&
+      isDefined(objectMetadata.standardOverrides[labelKey])
+    ) {
+      return objectMetadata.standardOverrides[labelKey] as string;
+    }
+
     if (!locale) {
       return objectMetadata[labelKey];
     }