Skip to content

The open alternative to Salesforce, designed for AI.

Give the REST metadata API one label-resolution path (#24410)

Félix Malfaitdb69390e4d98
diff --git a/packages/twenty-server/src/engine/metadata-modules/application-translation-catalog/services/application-translation-catalog.service.ts b/packages/twenty-server/src/engine/metadata-modules/application-translation-catalog/services/application-translation-catalog.service.ts
index f7c9da52743..aaed7a93613 100644
--- a/packages/twenty-server/src/engine/metadata-modules/application-translation-catalog/services/application-translation-catalog.service.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/application-translation-catalog/services/application-translation-catalog.service.ts
@@ -1,11 +1,16 @@
import { Injectable } from '@nestjs/common';
-import { type APP_LOCALES } from 'twenty-shared/translations';
+import { type TranslatableMetadataName } from 'twenty-shared/i18n';
+import { type APP_LOCALES, SOURCE_LOCALE } from 'twenty-shared/translations';
+import { isDefined } from 'twenty-shared/utils';
import { ApplicationTranslationCacheService } from 'src/engine/core-modules/application/application-translation/application-translation-cache.service';
+import { I18nService } from 'src/engine/core-modules/i18n/i18n.service';
import { type FlatApplicationCacheMaps } from 'src/engine/core-modules/application/types/flat-application-cache-maps.type';
import { WorkspaceManyOrAllFlatEntityMapsCacheService } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service';
import { resolveRegistrationIdByApplicationId } from 'src/engine/metadata-modules/application-translation-catalog/utils/resolve-registration-id-by-application-id.util';
+import { resolveTranslatableProperties } from 'src/engine/metadata-modules/application-translation-catalog/utils/resolve-translatable-properties.util';
+import { type EffectiveEntityI18nContext } from 'src/engine/metadata-modules/utils/effective-entity-i18n-context.type';
import { getTwentyStandardApplicationIdOrThrow } from 'src/engine/metadata-modules/utils/get-twenty-standard-application-id-or-throw.util';
export type ApplicationCatalogs = {
@@ -18,6 +23,7 @@ export class ApplicationTranslationCatalogService {
constructor(
private readonly flatEntityMapsCacheService: WorkspaceManyOrAllFlatEntityMapsCacheService,
private readonly applicationTranslationCacheService: ApplicationTranslationCacheService,
+ private readonly i18nService: I18nService,
) {}
async getStandardApplicationId({
@@ -87,6 +93,74 @@ export class ApplicationTranslationCatalogService {
return { standardApplicationId, catalogByApplicationId };
}
+ // Every REST controller needs the same thing the GraphQL resolvers get from
+ // buildEffectiveEntityI18nContext, minus the per-request dataloaders that
+ // only exist in a GraphQL context: one context per application, batched.
+ async getI18nContextByApplicationId({
+ applicationIds,
+ locale,
+ workspaceId,
+ }: {
+ applicationIds: (string | undefined)[];
+ locale: keyof typeof APP_LOCALES | undefined;
+ workspaceId: string;
+ }): Promise<
+ (applicationId: string | undefined) => EffectiveEntityI18nContext
+ > {
+ const safeLocale = locale ?? SOURCE_LOCALE;
+
+ const { standardApplicationId, catalogByApplicationId } =
+ await this.getCatalogs({
+ applicationIds,
+ locale: safeLocale,
+ workspaceId,
+ });
+ const i18nInstance = this.i18nService.getI18nInstance(safeLocale);
+
+ return (applicationId) => ({
+ locale,
+ i18nInstance,
+ isStandardApp: applicationId === standardApplicationId,
+ applicationCatalog: isDefined(applicationId)
+ ? catalogByApplicationId.get(applicationId)
+ : undefined,
+ });
+ }
+
+ // The common case: merge every resolved translatable property back onto the
+ // entity it came from. Callers that present several metadata names in one
+ // payload use getI18nContextByApplicationId directly instead.
+ async resolveTranslatablePropertiesForEntities<
+ TEntity extends { applicationId?: string | null },
+ >({
+ metadataName,
+ entities,
+ locale,
+ workspaceId,
+ }: {
+ metadataName: TranslatableMetadataName;
+ entities: TEntity[];
+ locale: keyof typeof APP_LOCALES | undefined;
+ workspaceId: string;
+ }): Promise<TEntity[]> {
+ const getI18nContext = await this.getI18nContextByApplicationId({
+ applicationIds: entities.map(
+ (entity) => entity.applicationId ?? undefined,
+ ),
+ locale,
+ workspaceId,
+ });
+
+ return entities.map((entity) => ({
+ ...entity,
+ ...resolveTranslatableProperties({
+ metadataName,
+ entity,
+ i18nContext: getI18nContext(entity.applicationId ?? undefined),
+ }),
+ }));
+ }
+
private async getFlatApplicationMaps({
workspaceId,
}: {
diff --git a/packages/twenty-server/src/engine/metadata-modules/application-translation-catalog/utils/__tests__/resolve-translatable-properties.util.spec.ts b/packages/twenty-server/src/engine/metadata-modules/application-translation-catalog/utils/__tests__/resolve-translatable-properties.util.spec.ts
new file mode 100644
index 00000000000..3dfec34429c
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/application-translation-catalog/utils/__tests__/resolve-translatable-properties.util.spec.ts
@@ -0,0 +1,83 @@
+import { SOURCE_LOCALE } from 'twenty-shared/translations';
+
+import { resolveTranslatableProperties } from 'src/engine/metadata-modules/application-translation-catalog/utils/resolve-translatable-properties.util';
+import { type EffectiveEntityI18nContext } from 'src/engine/metadata-modules/utils/effective-entity-i18n-context.type';
+
+const i18nContext: EffectiveEntityI18nContext = {
+ locale: 'fr-FR',
+ i18nInstance: { _: (messageId: string) => messageId },
+ isStandardApp: false,
+ applicationCatalog: undefined,
+};
+
+describe('resolveTranslatableProperties', () => {
+ it('resolves every translatable property the entity carries', () => {
+ expect(
+ resolveTranslatableProperties({
+ metadataName: 'objectMetadata',
+ entity: {
+ labelSingular: 'Company',
+ labelPlural: 'Companies',
+ description: 'A company',
+ },
+ i18nContext,
+ }),
+ ).toEqual({
+ labelSingular: 'Company',
+ labelPlural: 'Companies',
+ description: 'A company',
+ });
+ });
+
+ it('omits properties the entity does not carry', () => {
+ expect(
+ resolveTranslatableProperties({
+ metadataName: 'objectMetadata',
+ entity: { labelSingular: 'Company' },
+ i18nContext,
+ }),
+ ).toEqual({ labelSingular: 'Company' });
+ });
+
+ it('prefers a workspace translation for the resolved locale', () => {
+ expect(
+ resolveTranslatableProperties({
+ metadataName: 'objectMetadata',
+ entity: {
+ labelSingular: 'Company',
+ overrides: {
+ translations: { 'fr-FR': { labelSingular: 'Entreprise' } },
+ },
+ },
+ i18nContext: { ...i18nContext, isStandardApp: true },
+ }),
+ ).toEqual({ labelSingular: 'Entreprise' });
+ });
+
+ it('falls back to the canonical override when the locale has no translation', () => {
+ expect(
+ resolveTranslatableProperties({
+ metadataName: 'objectMetadata',
+ entity: {
+ labelSingular: 'Company',
+ overrides: { labelSingular: 'Client' },
+ },
+ i18nContext: {
+ ...i18nContext,
+ locale: SOURCE_LOCALE,
+ isStandardApp: true,
+ },
+ }),
+ ).toEqual({ labelSingular: 'Client' });
+ });
+
+ it('returns nothing for a metadata name with no translatable properties', () => {
+ expect(
+ resolveTranslatableProperties({
+ metadataName: 'objectMetadata',
+ entity: {},
+ i18nContext,
+ }),
+ ).toEqual({});
+ });
+});
diff --git a/packages/twenty-server/src/engine/metadata-modules/application-translation-catalog/utils/resolve-translatable-properties.util.ts b/packages/twenty-server/src/engine/metadata-modules/application-translation-catalog/utils/resolve-translatable-properties.util.ts
new file mode 100644
index 00000000000..9a6483a33cc
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/application-translation-catalog/utils/resolve-translatable-properties.util.ts
@@ -0,0 +1,43 @@
+import { type TranslatableMetadataName } from 'twenty-shared/i18n';
+import { isDefined } from 'twenty-shared/utils';
+
+import { ALL_TRANSLATABLE_PROPERTIES_BY_METADATA_NAME } from 'src/engine/metadata-modules/flat-entity/constant/all-translatable-properties-by-metadata-name.constant';
+import { type EffectiveEntityI18nContext } from 'src/engine/metadata-modules/utils/effective-entity-i18n-context.type';
+import { resolveEffectiveEntityPropertyByName } from 'src/engine/metadata-modules/utils/resolve-effective-entity-property.util';
+
+// The registry decides which property to read, so this is the one place a
+// dynamic property name meets a concrete entity. Callers range from TypeORM
+// classes to plain DTOs, some without an overrides column at all, so the read
+// is dynamic rather than typed per shape.
+const readProperty = (entity: object, property: string): unknown =>
+ (entity as Record<string, unknown>)[property];
+
+export const resolveTranslatableProperties = ({
+ metadataName,
+ entity,
+ i18nContext,
+}: {
+ metadataName: TranslatableMetadataName;
+ entity: object;
+ i18nContext: EffectiveEntityI18nContext;
+}): Record<string, string> =>
+ Object.fromEntries(
+ (ALL_TRANSLATABLE_PROPERTIES_BY_METADATA_NAME[metadataName] ?? [])
+ .map((property) => {
+ const baseValue = readProperty(entity, property);
+
+ return isDefined(baseValue)
+ ? [
+ property,
+ resolveEffectiveEntityPropertyByName({
+ metadataName,
+ baseValue,
+ overrides: readProperty(entity, 'overrides'),
+ property,
+ i18nContext,
+ }),
+ ]
+ : undefined;
+ })
+ .filter(isDefined),
+ );
diff --git a/packages/twenty-server/src/engine/metadata-modules/field-metadata/controllers/field-metadata.controller.ts b/packages/twenty-server/src/engine/metadata-modules/field-metadata/controllers/field-metadata.controller.ts
index df7fc3f9be2..223bbcc6021 100644
--- a/packages/twenty-server/src/engine/metadata-modules/field-metadata/controllers/field-metadata.controller.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/field-metadata/controllers/field-metadata.controller.ts
@@ -41,6 +41,9 @@ import {
import { FieldMetadataRestApiExceptionFilter } from 'src/engine/metadata-modules/field-metadata/filters/field-metadata-rest-api-exception.filter';
import { FieldMetadataService } from 'src/engine/metadata-modules/field-metadata/services/field-metadata.service';
import { fromFieldMetadataEntityToFieldMetadataDto } from 'src/engine/metadata-modules/field-metadata/utils/from-field-metadata-entity-to-field-metadata-dto.util';
+import { ApplicationTranslationCatalogService } from 'src/engine/metadata-modules/application-translation-catalog/services/application-translation-catalog.service';
+import { RequestLocale } from 'src/engine/decorators/locale/request-locale.decorator';
+import { type APP_LOCALES } from 'twenty-shared/translations';
import {
toLegacyFieldMetadataCreateResponse,
toLegacyFieldMetadataDeleteResponse,
@@ -73,12 +76,42 @@ export class FieldMetadataController {
private readonly fieldMetadataService: FieldMetadataService,
private readonly featureFlagService: FeatureFlagService,
private readonly uniqueFieldMetadataIdsService: UniqueFieldMetadataIdsService,
+ private readonly applicationTranslationCatalogService: ApplicationTranslationCatalogService,
) {}
+ // REST returns the same labels the app renders: resolved for the caller's
+ // locale, through the one resolver the GraphQL read path uses.
+ private async toPresentedFieldDtos({
+ fields,
+ uniqueFieldMetadataIds,
+ locale,
+ workspaceId,
+ }: {
+ fields: FieldMetadataEntity[];
+ uniqueFieldMetadataIds: ReadonlySet<string>;
+ locale: keyof typeof APP_LOCALES | undefined;
+ workspaceId: string;
+ }): Promise<FieldMetadataDTO[]> {
+ const resolvedFields =
+ await this.applicationTranslationCatalogService.resolveTranslatablePropertiesForEntities(
+ {
+ metadataName: 'fieldMetadata',
+ entities: fields,
+ locale,
+ workspaceId,
+ },
+ );
+
+ return resolvedFields.map((field) =>
+ fromFieldMetadataEntityToFieldMetadataDto(field, uniqueFieldMetadataIds),
+ );
+ }
+
@Get()
async findMany(
@Req() request: AuthenticatedRequest,
@AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
+ @RequestLocale() locale: keyof typeof APP_LOCALES | undefined,
) {
const { items, pageInfo, totalCount } = await paginateByIdCursor({
repository: this.fieldMetadataRepository,
@@ -94,9 +127,12 @@ export class FieldMetadataController {
pageInfo: RestCursorPageInfo;
totalCount: number;
} = {
- data: items.map((item) =>
- fromFieldMetadataEntityToFieldMetadataDto(item, uniqueFieldMetadataIds),
- ),
+ data: await this.toPresentedFieldDtos({
+ fields: items,
+ uniqueFieldMetadataIds,
+ locale,
+ workspaceId,
+ }),
pageInfo,
totalCount,
};
@@ -110,6 +146,7 @@ export class FieldMetadataController {
async findOne(
@Param('id', new ParseUUIDPipe()) id: string,
@AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
+ @RequestLocale() locale: keyof typeof APP_LOCALES | undefined,
) {
const field = await this.fieldMetadataRepository.findOne({
where: { id, workspaceId },
@@ -124,10 +161,12 @@ export class FieldMetadataController {
const uniqueFieldMetadataIds =
await this.uniqueFieldMetadataIdsService.getForWorkspace(workspaceId);
- const result = fromFieldMetadataEntityToFieldMetadataDto(
- field,
+ const [result] = await this.toPresentedFieldDtos({
+ fields: [field],
uniqueFieldMetadataIds,
- );
+ locale,
+ workspaceId,
+ });
return (await this.isNewMetadataFormat(workspaceId))
? result
diff --git a/packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.module.ts b/packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.module.ts
index 20bce3c1e3d..312a3d7a5fc 100644
--- a/packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.module.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.module.ts
@@ -1,4 +1,6 @@
import { Module } from '@nestjs/common';
+
+import { ApplicationTranslationCatalogModule } from 'src/engine/metadata-modules/application-translation-catalog/application-translation-catalog.module';
import { TypeOrmModule } from '@nestjs/typeorm';
import { TypeORMModule } from 'src/database/typeorm/typeorm.module';
@@ -29,6 +31,7 @@ import { FieldMetadataEntity } from './field-metadata.entity';
@Module({
imports: [
+ ApplicationTranslationCatalogModule,
TypeOrmModule.forFeature([FieldMetadataEntity, ObjectMetadataEntity]),
ApplicationModule,
ApplicationTranslationModule,
diff --git a/packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.resolver.ts b/packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.resolver.ts
index e503ffed686..6222db0646f 100644
--- a/packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.resolver.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.resolver.ts
@@ -182,31 +182,17 @@ export class FieldMetadataResolver {
context: { loaders: IDataloaders } & I18nContext,
workspaceId: string,
): Promise<string> {
- const i18n = this.i18nService.getI18nInstance(context.req.locale);
-
- const standardApplicationId =
- await context.loaders.standardApplicationIdLoader.load({ workspaceId });
-
- const isStandardApp = fieldMetadata.applicationId === standardApplicationId;
-
- const applicationCatalog =
- await context.loaders.applicationTranslationCatalogLoader.load({
- applicationId: fieldMetadata.applicationId,
- workspaceId,
- locale: context.req.locale,
- });
-
return resolveEffectiveEntityProperty({
metadataName: 'fieldMetadata',
baseValue: fieldMetadata[labelKey],
overrides: fieldMetadata.overrides,
property: labelKey,
- i18nContext: {
+ i18nContext: await this.i18nService.buildEffectiveEntityI18nContext({
+ applicationId: fieldMetadata.applicationId ?? undefined,
+ loaders: context.loaders,
locale: context.req.locale,
- i18nInstance: i18n,
- isStandardApp,
- applicationCatalog,
- },
+ workspaceId,
+ }),
});
}
diff --git a/packages/twenty-server/src/engine/metadata-modules/object-metadata/controllers/object-metadata.controller.ts b/packages/twenty-server/src/engine/metadata-modules/object-metadata/controllers/object-metadata.controller.ts
index a326c7b6936..c4b69c2f469 100644
--- a/packages/twenty-server/src/engine/metadata-modules/object-metadata/controllers/object-metadata.controller.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/object-metadata/controllers/object-metadata.controller.ts
@@ -46,6 +46,9 @@ import {
} from 'src/engine/metadata-modules/object-metadata/object-metadata.exception';
import { ObjectMetadataService } from 'src/engine/metadata-modules/object-metadata/object-metadata.service';
import { fromObjectMetadataEntityToObjectMetadataDto } from 'src/engine/metadata-modules/object-metadata/utils/from-object-metadata-entity-to-object-metadata-dto.util';
+import { ApplicationTranslationCatalogService } from 'src/engine/metadata-modules/application-translation-catalog/services/application-translation-catalog.service';
+import { RequestLocale } from 'src/engine/decorators/locale/request-locale.decorator';
+import { type APP_LOCALES } from 'twenty-shared/translations';
import {
toLegacyObjectMetadataCreateResponse,
toLegacyObjectMetadataDeleteResponse,
@@ -77,12 +80,14 @@ export class ObjectMetadataController {
private readonly objectMetadataService: ObjectMetadataService,
private readonly featureFlagService: FeatureFlagService,
private readonly uniqueFieldMetadataIdsService: UniqueFieldMetadataIdsService,
+ private readonly applicationTranslationCatalogService: ApplicationTranslationCatalogService,
) {}
@Get()
async findMany(
@Req() request: AuthenticatedRequest,
@AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
+ @RequestLocale() locale: keyof typeof APP_LOCALES | undefined,
) {
const { items, pageInfo, totalCount } = await paginateByIdCursor({
repository: this.objectMetadataRepository,
@@ -98,13 +103,13 @@ export class ObjectMetadataController {
this.uniqueFieldMetadataIdsService.getForWorkspace(workspaceId),
]);
- const data = items.map((object) =>
- this.toObjectWithFieldsDto(
- object,
- fields.get(object.id) ?? [],
- uniqueFieldMetadataIds,
- ),
- );
+ const data = await this.toObjectWithFieldsDtos({
+ objects: items,
+ fieldsByObjectId: fields,
+ uniqueFieldMetadataIds,
+ locale,
+ workspaceId,
+ });
const result: {
data: ObjectMetadataWithFieldsDTO[];
@@ -121,6 +126,7 @@ export class ObjectMetadataController {
async findOne(
@Param('id', new ParseUUIDPipe()) id: string,
@AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
+ @RequestLocale() locale: keyof typeof APP_LOCALES | undefined,
) {
const object = await this.objectMetadataRepository.findOne({
where: { id, workspaceId },
@@ -140,11 +146,13 @@ export class ObjectMetadataController {
this.uniqueFieldMetadataIdsService.getForWorkspace(workspaceId),
]);
- const result = this.toObjectWithFieldsDto(
- object,
- fields,
+ const [result] = await this.toObjectWithFieldsDtos({
+ objects: [object],
+ fieldsByObjectId: new Map([[object.id, fields]]),
uniqueFieldMetadataIds,
- );
+ locale,
+ workspaceId,
+ });
return (await this.isNewMetadataFormat(workspaceId))
? result
@@ -288,19 +296,61 @@ export class ObjectMetadataController {
return grouped;
}
- private toObjectWithFieldsDto(
- object: ObjectMetadataEntity,
- fields: FieldMetadataEntity[],
- uniqueFieldMetadataIds: ReadonlySet<string>,
- ): ObjectMetadataWithFieldsDTO {
- return {
+ // REST returns the same labels the app renders: resolved for the caller's
+ // locale, through the one resolver the GraphQL read path uses. Objects and
+ // every field across them resolve in one call each, so a page costs a fixed
+ // number of catalog reads rather than one per row.
+ private async toObjectWithFieldsDtos({
+ objects,
+ fieldsByObjectId,
+ uniqueFieldMetadataIds,
+ locale,
+ workspaceId,
+ }: {
+ objects: ObjectMetadataEntity[];
+ fieldsByObjectId: Map<string, FieldMetadataEntity[]>;
+ uniqueFieldMetadataIds: ReadonlySet<string>;
+ locale: keyof typeof APP_LOCALES | undefined;
+ workspaceId: string;
+ }): Promise<ObjectMetadataWithFieldsDTO[]> {
+ const [resolvedObjects, resolvedFields] = await Promise.all([
+ this.applicationTranslationCatalogService.resolveTranslatablePropertiesForEntities(
+ {
+ metadataName: 'objectMetadata',
+ entities: objects,
+ locale,
+ workspaceId,
+ },
+ ),
+ this.applicationTranslationCatalogService.resolveTranslatablePropertiesForEntities(
+ {
+ metadataName: 'fieldMetadata',
+ entities: objects.flatMap(
+ (object) => fieldsByObjectId.get(object.id) ?? [],
+ ),
+ locale,
+ workspaceId,
+ },
+ ),
+ ]);
+ const resolvedFieldsByObjectId = new Map<string, FieldMetadataEntity[]>();
+
+ for (const field of resolvedFields) {
+ const fieldsForObject =
+ resolvedFieldsByObjectId.get(field.objectMetadataId) ?? [];
+
+ fieldsForObject.push(field);
+ resolvedFieldsByObjectId.set(field.objectMetadataId, fieldsForObject);
+ }
+
+ return resolvedObjects.map((object) => ({
...fromObjectMetadataEntityToObjectMetadataDto(object),
- fields: fields.map((field) =>
+ fields: (resolvedFieldsByObjectId.get(object.id) ?? []).map((field) =>
fromFieldMetadataEntityToFieldMetadataDto(
field,
uniqueFieldMetadataIds,
),
),
- };
+ }));
}
}
diff --git a/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.module.ts b/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.module.ts
index ee856ec8e3c..8421bb1a8d8 100644
--- a/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.module.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.module.ts
@@ -1,4 +1,6 @@
import { Module } from '@nestjs/common';
+
+import { ApplicationTranslationCatalogModule } from 'src/engine/metadata-modules/application-translation-catalog/application-translation-catalog.module';
import { TypeOrmModule } from '@nestjs/typeorm';
import { TypeORMModule } from 'src/database/typeorm/typeorm.module';
@@ -28,6 +30,7 @@ import { WorkspaceMigrationModule } from 'src/engine/workspace-manager/workspace
@Module({
imports: [
+ ApplicationTranslationCatalogModule,
TypeOrmModule.forFeature([
ObjectMetadataEntity,
FieldMetadataEntity,
diff --git a/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.resolver.ts b/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.resolver.ts
index 3ce9b8c85ad..567e0a216b5 100644
--- a/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.resolver.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.resolver.ts
@@ -236,32 +236,17 @@ export class ObjectMetadataResolver {
context: { loaders: IDataloaders } & I18nContext,
workspaceId: string,
): Promise<string> {
- const i18n = this.i18nService.getI18nInstance(context.req.locale);
-
- const standardApplicationId =
- await context.loaders.standardApplicationIdLoader.load({ workspaceId });
-
- const isStandardApp =
- objectMetadata.applicationId === standardApplicationId;
-
- const applicationCatalog =
- await context.loaders.applicationTranslationCatalogLoader.load({
- applicationId: objectMetadata.applicationId,
- workspaceId,
- locale: context.req.locale,
- });
-
return resolveEffectiveEntityProperty({
metadataName: 'objectMetadata',
baseValue: objectMetadata[labelKey],
overrides: objectMetadata.overrides,
property: labelKey,
- i18nContext: {
+ i18nContext: await this.i18nService.buildEffectiveEntityI18nContext({
+ applicationId: objectMetadata.applicationId ?? undefined,
+ loaders: context.loaders,
locale: context.req.locale,
- i18nInstance: i18n,
- isStandardApp,
- applicationCatalog,
- },
+ workspaceId,
+ }),
});
}
diff --git a/packages/twenty-server/src/engine/metadata-modules/page-layout-tab/controllers/page-layout-tab.controller.ts b/packages/twenty-server/src/engine/metadata-modules/page-layout-tab/controllers/page-layout-tab.controller.ts
index 8e935a9f307..4e134db945e 100644
--- a/packages/twenty-server/src/engine/metadata-modules/page-layout-tab/controllers/page-layout-tab.controller.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/page-layout-tab/controllers/page-layout-tab.controller.ts
@@ -14,12 +14,15 @@ import {
import { PermissionFlagType } from 'twenty-shared/constants';
import { ApiPath } from 'twenty-shared/types';
+import { type APP_LOCALES } from 'twenty-shared/translations';
import { isDefined } from 'twenty-shared/utils';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
+import { ApplicationTranslationCatalogService } from 'src/engine/metadata-modules/application-translation-catalog/services/application-translation-catalog.service';
import { paginateMetadataRestItems } from 'src/engine/api/rest/metadata/utils/paginate-metadata-rest-items.util';
import { type AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
+import { RequestLocale } from 'src/engine/decorators/locale/request-locale.decorator';
import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
@@ -47,7 +50,10 @@ import { WorkspaceMigrationRunnerRestApiExceptionFilter } from 'src/engine/works
WorkspaceMigrationRunnerRestApiExceptionFilter,
)
export class PageLayoutTabController {
- constructor(private readonly pageLayoutTabService: PageLayoutTabService) {}
+ constructor(
+ private readonly pageLayoutTabService: PageLayoutTabService,
+ private readonly applicationTranslationCatalogService: ApplicationTranslationCatalogService,
+ ) {}
@Get()
@UseGuards(NoPermissionGuard)
@@ -55,6 +61,7 @@ export class PageLayoutTabController {
@Req() request: AuthenticatedRequest,
@AuthWorkspace() workspace: WorkspaceEntity,
@Query('pageLayoutId') pageLayoutId: string,
+ @RequestLocale() locale: keyof typeof APP_LOCALES | undefined,
) {
if (!isDefined(pageLayoutId)) {
throw new PageLayoutTabException(
@@ -70,7 +77,18 @@ export class PageLayoutTabController {
pageLayoutId,
});
- return paginateMetadataRestItems({ items, request });
+ return paginateMetadataRestItems({
+ items:
+ await this.applicationTranslationCatalogService.resolveTranslatablePropertiesForEntities(
+ {
+ metadataName: 'pageLayoutTab',
+ entities: items,
+ locale,
+ workspaceId: workspace.id,
+ },
+ ),
+ request,
+ });
}
@Get(':id')
@@ -78,11 +96,24 @@ export class PageLayoutTabController {
async findOne(
@Param('id') id: string,
@AuthWorkspace() workspace: WorkspaceEntity,
+ @RequestLocale() locale: keyof typeof APP_LOCALES | undefined,
): Promise<PageLayoutTabDTO | null> {
- return this.pageLayoutTabService.findByIdOrThrow({
+ const pageLayoutTab = await this.pageLayoutTabService.findByIdOrThrow({
id,
workspaceId: workspace.id,
});
+
+ const [resolvedPageLayoutTab] =
+ await this.applicationTranslationCatalogService.resolveTranslatablePropertiesForEntities(
+ {
+ metadataName: 'pageLayoutTab',
+ entities: [pageLayoutTab],
+ locale,
+ workspaceId: workspace.id,
+ },
+ );
+
+ return resolvedPageLayoutTab;
}
@Post()
diff --git a/packages/twenty-server/src/engine/metadata-modules/page-layout-tab/page-layout-tab.module.ts b/packages/twenty-server/src/engine/metadata-modules/page-layout-tab/page-layout-tab.module.ts
index 16708d7a2f5..fecc92399fd 100644
--- a/packages/twenty-server/src/engine/metadata-modules/page-layout-tab/page-layout-tab.module.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/page-layout-tab/page-layout-tab.module.ts
@@ -1,3 +1,4 @@
+import { ApplicationTranslationCatalogModule } from 'src/engine/metadata-modules/application-translation-catalog/application-translation-catalog.module';
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
@@ -20,6 +21,7 @@ import { DashboardSyncModule } from 'src/modules/dashboard-sync/dashboard-sync.m
@Module({
imports: [
+ ApplicationTranslationCatalogModule,
TypeOrmModule.forFeature([PageLayoutTabEntity, WorkspaceEntity]),
TwentyORMModule,
PermissionsModule,
diff --git a/packages/twenty-server/src/engine/metadata-modules/page-layout-widget/controllers/page-layout-widget.controller.ts b/packages/twenty-server/src/engine/metadata-modules/page-layout-widget/controllers/page-layout-widget.controller.ts
index 6cecd76ee14..e287f3cc569 100644
--- a/packages/twenty-server/src/engine/metadata-modules/page-layout-widget/controllers/page-layout-widget.controller.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/page-layout-widget/controllers/page-layout-widget.controller.ts
@@ -15,11 +15,14 @@ import {
import { isDefined } from 'class-validator';
import { PermissionFlagType } from 'twenty-shared/constants';
import { ApiPath } from 'twenty-shared/types';
+import { type APP_LOCALES } from 'twenty-shared/translations';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
+import { ApplicationTranslationCatalogService } from 'src/engine/metadata-modules/application-translation-catalog/services/application-translation-catalog.service';
import { paginateMetadataRestItems } from 'src/engine/api/rest/metadata/utils/paginate-metadata-rest-items.util';
import { type AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
+import { RequestLocale } from 'src/engine/decorators/locale/request-locale.decorator';
import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
@@ -49,6 +52,7 @@ import { WorkspaceMigrationRunnerRestApiExceptionFilter } from 'src/engine/works
export class PageLayoutWidgetController {
constructor(
private readonly pageLayoutWidgetService: PageLayoutWidgetService,
+ private readonly applicationTranslationCatalogService: ApplicationTranslationCatalogService,
) {}
@Get()
@@ -57,6 +61,7 @@ export class PageLayoutWidgetController {
@Req() request: AuthenticatedRequest,
@AuthWorkspace() workspace: WorkspaceEntity,
@Query('pageLayoutTabId') pageLayoutTabId: string,
+ @RequestLocale() locale: keyof typeof APP_LOCALES | undefined,
) {
if (!isDefined(pageLayoutTabId)) {
throw new PageLayoutWidgetException(
@@ -72,7 +77,18 @@ export class PageLayoutWidgetController {
pageLayoutTabId,
});
- return paginateMetadataRestItems({ items, request });
+ return paginateMetadataRestItems({
+ items:
+ await this.applicationTranslationCatalogService.resolveTranslatablePropertiesForEntities(
+ {
+ metadataName: 'pageLayoutWidget',
+ entities: items,
+ locale,
+ workspaceId: workspace.id,
+ },
+ ),
+ request,
+ });
}
@Get(':id')
@@ -80,11 +96,26 @@ export class PageLayoutWidgetController {
async findOne(
@Param('id') id: string,
@AuthWorkspace() workspace: WorkspaceEntity,
+ @RequestLocale() locale: keyof typeof APP_LOCALES | undefined,
): Promise<PageLayoutWidgetDTO | null> {
- return this.pageLayoutWidgetService.findByIdOrThrow({
- id,
- workspaceId: workspace.id,
- });
+ const pageLayoutWidget = await this.pageLayoutWidgetService.findByIdOrThrow(
+ {
+ id,
+ workspaceId: workspace.id,
+ },
+ );
+
+ const [resolvedPageLayoutWidget] =
+ await this.applicationTranslationCatalogService.resolveTranslatablePropertiesForEntities(
+ {
+ metadataName: 'pageLayoutWidget',
+ entities: [pageLayoutWidget],
+ locale,
+ workspaceId: workspace.id,
+ },
+ );
+
+ return resolvedPageLayoutWidget;
}
@Post()
diff --git a/packages/twenty-server/src/engine/metadata-modules/page-layout-widget/page-layout-widget.module.ts b/packages/twenty-server/src/engine/metadata-modules/page-layout-widget/page-layout-widget.module.ts
index 91c15d634d6..02a4f024abc 100644
--- a/packages/twenty-server/src/engine/metadata-modules/page-layout-widget/page-layout-widget.module.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/page-layout-widget/page-layout-widget.module.ts
@@ -1,3 +1,4 @@
+import { ApplicationTranslationCatalogModule } from 'src/engine/metadata-modules/application-translation-catalog/application-translation-catalog.module';
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
@@ -19,6 +20,7 @@ import { DashboardSyncModule } from 'src/modules/dashboard-sync/dashboard-sync.m
@Module({
imports: [
+ ApplicationTranslationCatalogModule,
TypeOrmModule.forFeature([PageLayoutWidgetEntity, WorkspaceEntity]),
TwentyORMModule,
PermissionsModule,
diff --git a/packages/twenty-server/src/engine/metadata-modules/page-layout/controllers/page-layout.controller.ts b/packages/twenty-server/src/engine/metadata-modules/page-layout/controllers/page-layout.controller.ts
index a968b64c653..43fc54618fd 100644
--- a/packages/twenty-server/src/engine/metadata-modules/page-layout/controllers/page-layout.controller.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/page-layout/controllers/page-layout.controller.ts
@@ -13,10 +13,9 @@ import {
} from '@nestjs/common';
import { PermissionFlagType } from 'twenty-shared/constants';
-import { type APP_LOCALES, SOURCE_LOCALE } from 'twenty-shared/translations';
+import { type APP_LOCALES } from 'twenty-shared/translations';
import { ApiPath } from 'twenty-shared/types';
-import { I18nService } from 'src/engine/core-modules/i18n/i18n.service';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { parseMetadataRestPagination } from 'src/engine/api/rest/metadata/utils/parse-metadata-rest-pagination.util';
import { type AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request';
@@ -33,7 +32,6 @@ import { PageLayoutType } from 'src/engine/metadata-modules/page-layout/enums/pa
import { PageLayoutRestApiExceptionFilter } from 'src/engine/metadata-modules/page-layout/filters/page-layout-rest-api-exception.filter';
import { PageLayoutService } from 'src/engine/metadata-modules/page-layout/services/page-layout.service';
import { PermissionsRestApiExceptionFilter } from 'src/engine/metadata-modules/permissions/utils/permissions-rest-api-exception.filter';
-import { resolveEffectiveEntityProperty } from 'src/engine/metadata-modules/utils/resolve-effective-entity-property.util';
import { ApplicationTranslationCatalogService } from 'src/engine/metadata-modules/application-translation-catalog/services/application-translation-catalog.service';
import { WorkspaceMigrationRunnerRestApiExceptionFilter } from 'src/engine/workspace-manager/workspace-migration/filters/workspace-migration-runner-rest-api-exception.filter';
@@ -49,7 +47,6 @@ export class PageLayoutController {
constructor(
private readonly pageLayoutService: PageLayoutService,
private readonly applicationTranslationCatalogService: ApplicationTranslationCatalogService,
- private readonly i18nService: I18nService,
) {}
@Get()
@@ -69,11 +66,14 @@ export class PageLayoutController {
});
return {
- data: await this.resolvePageLayoutNames({
- pageLayouts: page.items,
- workspaceId: workspace.id,
- locale,
- }),
+ data: await this.applicationTranslationCatalogService.resolveTranslatablePropertiesForEntities(
+ {
+ metadataName: 'pageLayout',
+ entities: page.items,
+ locale,
+ workspaceId: workspace.id,
+ },
+ ),
pageInfo: page.pageInfo,
totalCount: page.totalCount,
};
@@ -91,11 +91,15 @@ export class PageLayoutController {
workspaceId: workspace.id,
});
- const [resolvedPageLayout] = await this.resolvePageLayoutNames({
- pageLayouts: [pageLayout],
- workspaceId: workspace.id,
- locale,
- });
+ const [resolvedPageLayout] =
+ await this.applicationTranslationCatalogService.resolveTranslatablePropertiesForEntities(
+ {
+ metadataName: 'pageLayout',
+ entities: [pageLayout],
+ locale,
+ workspaceId: workspace.id,
+ },
+ );
return resolvedPageLayout;
}
@@ -139,47 +143,4 @@ export class PageLayoutController {
workspaceId: workspace.id,
});
}
-
- private async resolvePageLayoutNames({
- pageLayouts,
- workspaceId,
- locale,
- }: {
- pageLayouts: PageLayoutDTO[];
- workspaceId: string;
- locale: keyof typeof APP_LOCALES | undefined;
- }): Promise<PageLayoutDTO[]> {
- const safeLocale = locale ?? SOURCE_LOCALE;
-
- const i18nInstance = this.i18nService.getI18nInstance(safeLocale);
-
- const { standardApplicationId, catalogByApplicationId } =
- await this.applicationTranslationCatalogService.getCatalogs({
- applicationIds: pageLayouts.map(
- (pageLayout) => pageLayout.applicationId,
- ),
- locale: safeLocale,
- workspaceId,
- });
-
- return pageLayouts.map((pageLayout) => ({
- ...pageLayout,
- name: resolveEffectiveEntityProperty({
- metadataName: 'pageLayout',
- baseValue: pageLayout.name,
- // pageLayout is not an overridable entity: a workspace renaming a
- // layout edits the row itself.
- overrides: undefined,
- property: 'name',
- i18nContext: {
- locale,
- i18nInstance,
- isStandardApp: pageLayout.applicationId === standardApplicationId,
- applicationCatalog: catalogByApplicationId.get(
- pageLayout.applicationId,
- ),
- },
- }),
- }));
- }
}
diff --git a/packages/twenty-server/src/engine/metadata-modules/view/controllers/view.controller.ts b/packages/twenty-server/src/engine/metadata-modules/view/controllers/view.controller.ts
index a3c8b0121e4..ea1dda74031 100644
--- a/packages/twenty-server/src/engine/metadata-modules/view/controllers/view.controller.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/view/controllers/view.controller.ts
@@ -12,12 +12,11 @@ import {
UseGuards,
} from '@nestjs/common';
-import { type APP_LOCALES, SOURCE_LOCALE } from 'twenty-shared/translations';
+import { type APP_LOCALES } from 'twenty-shared/translations';
import { ApiPath } from 'twenty-shared/types';
import { hasObjectMetadataLabelPlaceholder } from 'twenty-shared/i18n';
import { isDefined } from 'twenty-shared/utils';
-import { I18nService } from 'src/engine/core-modules/i18n/i18n.service';
import { parseMetadataRestPagination } from 'src/engine/api/rest/metadata/utils/parse-metadata-rest-pagination.util';
import { type AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
@@ -64,7 +63,6 @@ export class ViewController {
private readonly viewService: ViewService,
private readonly flatEntityMapsCacheService: WorkspaceManyOrAllFlatEntityMapsCacheService,
private readonly applicationTranslationCatalogService: ApplicationTranslationCatalogService,
- private readonly i18nService: I18nService,
) {}
@Get()
@@ -212,16 +210,14 @@ export class ViewController {
},
);
- const safeLocale = locale ?? SOURCE_LOCALE;
-
- const i18nInstance = this.i18nService.getI18nInstance(safeLocale);
-
- const { standardApplicationId, catalogByApplicationId } =
- await this.applicationTranslationCatalogService.getCatalogs({
- applicationIds: views.map((view) => view.applicationId),
- locale: safeLocale,
- workspaceId,
- });
+ const getI18nContext =
+ await this.applicationTranslationCatalogService.getI18nContextByApplicationId(
+ {
+ applicationIds: views.map((view) => view.applicationId),
+ locale,
+ workspaceId,
+ },
+ );
return views.map((view) => {
const objectMetadata = hasObjectMetadataLabelPlaceholder(view.name)
@@ -236,8 +232,7 @@ export class ViewController {
viewName: view.name,
objectMetadata,
i18nContext: {
- locale,
- i18nInstance,
+ ...getI18nContext(objectMetadata.applicationId ?? undefined),
isStandardApp: belongsToTwentyStandardApp(objectMetadata),
},
})
@@ -248,12 +243,7 @@ export class ViewController {
name: resolveViewName({
view,
objectLabelPlaceholderValues,
- i18nContext: {
- locale,
- i18nInstance,
- isStandardApp: view.applicationId === standardApplicationId,
- applicationCatalog: catalogByApplicationId.get(view.applicationId),
- },
+ i18nContext: getI18nContext(view.applicationId),
}),
};
});
diff --git a/packages/twenty-server/test/integration/metadata/suites/object-metadata/object-metadata-i18n.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/object-metadata/object-metadata-i18n.integration-spec.ts
index 166a8ce79b7..9e8cf90a11f 100644
--- a/packages/twenty-server/test/integration/metadata/suites/object-metadata/object-metadata-i18n.integration-spec.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/object-metadata/object-metadata-i18n.integration-spec.ts
@@ -1,5 +1,12 @@
import request from 'supertest';
+import { makeRestAPIRequest } from 'test/integration/rest/utils/make-rest-api-request.util';
+import {
+ extractMetadataItemPayload,
+ extractMetadataListPayload,
+} from 'test/integration/rest/utils/metadata-rest-api.util';
+import { assertRestApiSuccessfulResponse } from 'test/integration/rest/utils/rest-test-assertions.util';
+
import { WORKSPACE_MEMBER_DATA_SEED_IDS } from 'src/engine/workspace-manager/dev-seeder/data/constants/workspace-member-data-seeds.constant';
const client = request(`http://localhost:${APP_PORT}`);
@@ -28,6 +35,16 @@ type ObjectNode = {
description: string;
};
+type RestFieldShape = { id: string; name: string; label: string };
+
+type RestObjectShape = {
+ nameSingular: string;
+ labelSingular: string;
+ labelPlural: string;
+ description: string;
+ fields: RestFieldShape[];
+};
+
const updateWorkspaceMemberLocale = async (locale: string) => {
const response = await client
.post('/metadata')
@@ -112,4 +129,88 @@ describe('object metadata i18n', () => {
expect(opportunity!.labelPlural).toBe('Opportunités');
expect(opportunity!.description).toBe('Une opportunité');
});
+
+ describe('REST metadata API', () => {
+ beforeAll(async () => {
+ await updateWorkspaceMemberLocale('fr-FR');
+ });
+
+ it('should return French labels from GET /metadata/objects', async () => {
+ const response = await makeRestAPIRequest({
+ method: 'get',
+ path: '/metadata/objects?limit=200',
+ bearer: APPLE_JANE_ADMIN_ACCESS_TOKEN,
+ });
+
+ assertRestApiSuccessfulResponse(response);
+
+ const { items } = extractMetadataListPayload<RestObjectShape>(
+ response.body,
+ 'objects',
+ );
+ const person = items.find((item) => item.nameSingular === 'person');
+
+ expect(person).toBeDefined();
+ expect(person!.labelSingular).toBe('Personne');
+ expect(person!.labelPlural).toBe('Personnes');
+ expect(person!.description).toBe('Une personne');
+ });
+
+ it('should return French labels on the fields inlined by GET /metadata/objects', async () => {
+ const response = await makeRestAPIRequest({
+ method: 'get',
+ path: '/metadata/objects?limit=200',
+ bearer: APPLE_JANE_ADMIN_ACCESS_TOKEN,
+ });
+
+ assertRestApiSuccessfulResponse(response);
+
+ const { items } = extractMetadataListPayload<RestObjectShape>(
+ response.body,
+ 'objects',
+ );
+ const person = items.find((item) => item.nameSingular === 'person');
+ // A field only reachable through person proves the inlined fields were
+ // regrouped onto the object they belong to, not merely onto some object.
+ const companyField = person?.fields.find(
+ (field) => field.name === 'company',
+ );
+
+ expect(companyField).toBeDefined();
+ expect(companyField!.label).toBe('Entreprise');
+ });
+
+ it('should return French labels from GET /metadata/fields/:id', async () => {
+ const objectsResponse = await makeRestAPIRequest({
+ method: 'get',
+ path: '/metadata/objects?limit=200',
+ bearer: APPLE_JANE_ADMIN_ACCESS_TOKEN,
+ });
+
+ assertRestApiSuccessfulResponse(objectsResponse);
+
+ const { items } = extractMetadataListPayload<RestObjectShape>(
+ objectsResponse.body,
+ 'objects',
+ );
+ const companyField = items
+ .find((item) => item.nameSingular === 'person')
+ ?.fields.find((field) => field.name === 'company');
+
+ expect(companyField).toBeDefined();
+
+ const response = await makeRestAPIRequest({
+ method: 'get',
+ path: `/metadata/fields/${companyField!.id}`,
+ bearer: APPLE_JANE_ADMIN_ACCESS_TOKEN,
+ });
+
+ assertRestApiSuccessfulResponse(response);
+
+ expect(
+ extractMetadataItemPayload<RestFieldShape>(response.body, 'field')
+ .label,
+ ).toBe('Entreprise');
+ });
+ });
});