Skip to content

The open alternative to Salesforce, designed for AI.

Render pre-2.33 command menu item labels instead of raw template expressions (#24405)

Félix Malfait39a5780d6c72
diff --git a/packages/twenty-front/src/modules/command-menu-item/display/utils/interpolateCommandMenuItemFields.ts b/packages/twenty-front/src/modules/command-menu-item/display/utils/interpolateCommandMenuItemFields.ts
index 409c228aa83..328efe3e1c2 100644
--- a/packages/twenty-front/src/modules/command-menu-item/display/utils/interpolateCommandMenuItemFields.ts
+++ b/packages/twenty-front/src/modules/command-menu-item/display/utils/interpolateCommandMenuItemFields.ts
@@ -1,4 +1,4 @@
-import { interpolateMessagePlaceholders } from 'twenty-shared/i18n';
+import { interpolateCommandMenuItemPlaceholders } from 'twenty-shared/i18n';
import { type CommandMenuContextApi, type Nullable } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { getCommandMenuItemPlaceholderValues } from '@/command-menu-item/utils/getCommandMenuItemPlaceholderValues';
@@ -17,11 +17,13 @@ export const interpolateCommandMenuItemFields = (
const values = getCommandMenuItemPlaceholderValues(commandMenuContextApi);
const interpolate = (value: Nullable<string>): Nullable<string> =>
- isDefined(value) ? interpolateMessagePlaceholders(value, values) : value;
+ isDefined(value)
+ ? interpolateCommandMenuItemPlaceholders(value, values)
+ : value;
return {
iconKey: interpolate(item.icon),
- label: interpolateMessagePlaceholders(item.label, values),
+ label: interpolateCommandMenuItemPlaceholders(item.label, values),
shortLabel: interpolate(item.shortLabel),
};
};
diff --git a/packages/twenty-front/src/modules/command-menu-item/edit/components/SidePanelCommandMenuItemEditPage.tsx b/packages/twenty-front/src/modules/command-menu-item/edit/components/SidePanelCommandMenuItemEditPage.tsx
index d55b29c9eac..40617c8473c 100644
--- a/packages/twenty-front/src/modules/command-menu-item/edit/components/SidePanelCommandMenuItemEditPage.tsx
+++ b/packages/twenty-front/src/modules/command-menu-item/edit/components/SidePanelCommandMenuItemEditPage.tsx
@@ -18,7 +18,7 @@ import { type DraggableListDropResult } from '@/ui/layout/draggable-list/types/D
import { styled } from '@linaria/react';
import { useLingui } from '@lingui/react/macro';
import { ContextStorePageType } from 'twenty-shared/types';
-import { interpolateMessagePlaceholders } from 'twenty-shared/i18n';
+import { interpolateCommandMenuItemPlaceholders } from 'twenty-shared/i18n';
import { isDefined } from 'twenty-shared/utils';
import { getCommandMenuItemPlaceholderValues } from '@/command-menu-item/utils/getCommandMenuItemPlaceholderValues';
import {
@@ -82,7 +82,7 @@ export const SidePanelCommandMenuItemEditPage = () => {
);
const getDisplayLabel = (item: CommandMenuItemFieldsFragment) =>
- interpolateMessagePlaceholders(
+ interpolateCommandMenuItemPlaceholders(
item.label,
getCommandMenuItemPlaceholderValues(commandMenuContextApi),
);
diff --git a/packages/twenty-front/src/modules/side-panel/pages/root/hooks/useFilterCommandMenuItemsWithSidePanelSearch.ts b/packages/twenty-front/src/modules/side-panel/pages/root/hooks/useFilterCommandMenuItemsWithSidePanelSearch.ts
index b17fa55e230..fa1f1dc46a6 100644
--- a/packages/twenty-front/src/modules/side-panel/pages/root/hooks/useFilterCommandMenuItemsWithSidePanelSearch.ts
+++ b/packages/twenty-front/src/modules/side-panel/pages/root/hooks/useFilterCommandMenuItemsWithSidePanelSearch.ts
@@ -1,6 +1,6 @@
import { isNonEmptyString } from '@sniptt/guards';
import { useCallback } from 'react';
-import { interpolateMessagePlaceholders } from 'twenty-shared/i18n';
+import { interpolateCommandMenuItemPlaceholders } from 'twenty-shared/i18n';
import { type CommandMenuContextApi } from 'twenty-shared/types';
import { getCommandMenuItemPlaceholderValues } from '@/command-menu-item/utils/getCommandMenuItemPlaceholderValues';
import { type CommandMenuItemFieldsFragment } from '~/generated-metadata/graphql';
@@ -20,7 +20,7 @@ const checkInLabels = (
search: string,
commandMenuContextApi: CommandMenuContextApi,
) => {
- const label = interpolateMessagePlaceholders(
+ const label = interpolateCommandMenuItemPlaceholders(
commandMenuItem.label,
getCommandMenuItemPlaceholderValues(commandMenuContextApi),
);
diff --git a/packages/twenty-server/src/engine/metadata-modules/command-menu-item/utils/interpolate-navigation-command-menu-item-field.util.ts b/packages/twenty-server/src/engine/metadata-modules/command-menu-item/utils/interpolate-navigation-command-menu-item-field.util.ts
index 252b8d6e587..84ca042df92 100644
--- a/packages/twenty-server/src/engine/metadata-modules/command-menu-item/utils/interpolate-navigation-command-menu-item-field.util.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/command-menu-item/utils/interpolate-navigation-command-menu-item-field.util.ts
@@ -1,5 +1,5 @@
import { isNonEmptyString } from '@sniptt/guards';
-import { interpolateMessagePlaceholders } from 'twenty-shared/i18n';
+import { interpolateCommandMenuItemPlaceholders } from 'twenty-shared/i18n';
import { isDefined } from 'twenty-shared/utils';
import { type CommandMenuItemDTO } from 'src/engine/metadata-modules/command-menu-item/dtos/command-menu-item.dto';
@@ -41,7 +41,7 @@ export const interpolateNavigationCommandMenuItemField = ({
return resolvedValue;
}
- return interpolateMessagePlaceholders(
+ return interpolateCommandMenuItemPlaceholders(
resolvedValue,
buildNavigationPlaceholderValues({
objectMetadata,
diff --git a/packages/twenty-server/src/engine/subscriptions/metadata-event/utils/interpolate-navigation-command-menu-item-event.util.ts b/packages/twenty-server/src/engine/subscriptions/metadata-event/utils/interpolate-navigation-command-menu-item-event.util.ts
index ce3a9175ce5..a67dcfb9af5 100644
--- a/packages/twenty-server/src/engine/subscriptions/metadata-event/utils/interpolate-navigation-command-menu-item-event.util.ts
+++ b/packages/twenty-server/src/engine/subscriptions/metadata-event/utils/interpolate-navigation-command-menu-item-event.util.ts
@@ -1,5 +1,5 @@
import { isNonEmptyString } from '@sniptt/guards';
-import { interpolateMessagePlaceholders } from 'twenty-shared/i18n';
+import { interpolateCommandMenuItemPlaceholders } from 'twenty-shared/i18n';
import { isDefined } from 'twenty-shared/utils';
import { EngineComponentKey } from 'src/engine/metadata-modules/command-menu-item/enums/engine-component-key.enum';
@@ -66,7 +66,7 @@ export const interpolateNavigationCommandMenuItemEvent = ({
continue;
}
- interpolated[field] = interpolateMessagePlaceholders(
+ interpolated[field] = interpolateCommandMenuItemPlaceholders(
value,
placeholderValues,
);
diff --git a/packages/twenty-shared/src/i18n/__tests__/rewrite-legacy-metadata-label-template.spec.ts b/packages/twenty-shared/src/i18n/__tests__/rewrite-legacy-metadata-label-template.spec.ts
new file mode 100644
index 00000000000..393810225df
--- /dev/null
+++ b/packages/twenty-shared/src/i18n/__tests__/rewrite-legacy-metadata-label-template.spec.ts
@@ -0,0 +1,66 @@
+import { interpolateCommandMenuItemPlaceholders } from '../interpolate-command-menu-item-placeholders';
+import { interpolateMessagePlaceholders } from '../interpolate-message-placeholders';
+import { rewriteLegacyMetadataLabelTemplate } from '../rewrite-legacy-metadata-label-template';
+
+describe('rewriteLegacyMetadataLabelTemplate', () => {
+ it.each([
+ [
+ 'New ${capitalize(objectMetadataItem.labelSingular)}',
+ 'New {objectLabelSingular}',
+ ],
+ [
+ 'New ${capitalize{objectMetadataItem.labelSingular}}',
+ 'New {objectLabelSingular}',
+ ],
+ [
+ 'Go to ${capitalize(objectMetadataItem.labelPlural)}',
+ 'Go to {objectLabelPlural}',
+ ],
+ ['Delete ${capitalize(objectMetadataLabel)}', 'Delete {objectLabel}'],
+ ['${navigateToObjectMetadataItem.labelPlural}', '{objectLabelPlural}'],
+ ['${navigateToObjectMetadataItem.icon}', '{objectIcon}'],
+ ])('rewrites %s to the placeholder syntax', (legacyMessage, expected) => {
+ expect(rewriteLegacyMetadataLabelTemplate(legacyMessage)).toBe(expected);
+ });
+
+ it('leaves messages already using placeholders untouched', () => {
+ expect(
+ rewriteLegacyMetadataLabelTemplate('New {objectLabelSingular}'),
+ ).toBe('New {objectLabelSingular}');
+ });
+
+ it('leaves unknown template expressions as written', () => {
+ expect(rewriteLegacyMetadataLabelTemplate('Hello ${user.firstName}')).toBe(
+ 'Hello ${user.firstName}',
+ );
+ });
+
+ it('fills a legacy label through the command menu item interpolator', () => {
+ expect(
+ interpolateCommandMenuItemPlaceholders(
+ 'New ${capitalize(objectMetadataItem.labelSingular)}',
+ { objectLabelSingular: 'Person' },
+ ),
+ ).toBe('New Person');
+ });
+
+ it('keeps a legacy placeholder the caller cannot fill', () => {
+ expect(
+ interpolateCommandMenuItemPlaceholders(
+ 'New ${capitalize(objectMetadataItem.labelSingular)}',
+ {},
+ ),
+ ).toBe('New {objectLabelSingular}');
+ });
+
+ // A view name is text a person typed: it must survive verbatim even when it
+ // happens to look like the syntax command menu item labels once used.
+ it('leaves a user-authored name alone through the generic interpolator', () => {
+ expect(
+ interpolateMessagePlaceholders(
+ 'New ${capitalize(objectMetadataItem.labelSingular)}',
+ { objectLabelSingular: 'Person' },
+ ),
+ ).toBe('New ${capitalize(objectMetadataItem.labelSingular)}');
+ });
+});
diff --git a/packages/twenty-shared/src/i18n/index.ts b/packages/twenty-shared/src/i18n/index.ts
index 629656a8a63..914bfa6bae0 100644
--- a/packages/twenty-shared/src/i18n/index.ts
+++ b/packages/twenty-shared/src/i18n/index.ts
@@ -11,6 +11,7 @@ export type { LocaleMessagesMap } from './create-i18n-instance-factory';
export { createI18nInstanceFactory } from './create-i18n-instance-factory';
export { generateMessageId } from './generate-message-id';
export { getMetadataLabelContext } from './get-metadata-label-context';
+export { interpolateCommandMenuItemPlaceholders } from './interpolate-command-menu-item-placeholders';
export { interpolateMessagePlaceholders } from './interpolate-message-placeholders';
export type {
MetadataLabelPlaceholderName,
@@ -24,6 +25,7 @@ export {
buildObjectMetadataLabelPlaceholderValues,
hasObjectMetadataLabelPlaceholder,
} from './metadata-label-placeholder';
+export { rewriteLegacyMetadataLabelTemplate } from './rewrite-legacy-metadata-label-template';
export type {
TranslatableMetadataName,
TranslatablePropertyName,
diff --git a/packages/twenty-shared/src/i18n/interpolate-command-menu-item-placeholders.ts b/packages/twenty-shared/src/i18n/interpolate-command-menu-item-placeholders.ts
new file mode 100644
index 00000000000..4ba577cf499
--- /dev/null
+++ b/packages/twenty-shared/src/i18n/interpolate-command-menu-item-placeholders.ts
@@ -0,0 +1,19 @@
+import { interpolateMessagePlaceholders } from './interpolate-message-placeholders';
+import { rewriteLegacyMetadataLabelTemplate } from './rewrite-legacy-metadata-label-template';
+
+// DEPRECATED — remove once every workspace has run the 2.33 command
+// `upgrade:2-33:migrate-command-menu-item-labels-to-placeholders`, and call
+// interpolateMessagePlaceholders directly again. Until then a workspace
+// provisioned before that release still stores its command menu item labels as
+// template expressions, which the placeholder interpolator would leave as
+// written -- putting the raw expression on screen. Scoped to command menu
+// items on purpose: the same text in a user-authored view name is a literal
+// the viewer typed, and must stay untouched. See the tracking issue.
+export const interpolateCommandMenuItemPlaceholders = (
+ message: string,
+ values?: Record<string, string | number | undefined>,
+): string =>
+ interpolateMessagePlaceholders(
+ rewriteLegacyMetadataLabelTemplate(message),
+ values,
+ );
diff --git a/packages/twenty-shared/src/i18n/rewrite-legacy-metadata-label-template.ts b/packages/twenty-shared/src/i18n/rewrite-legacy-metadata-label-template.ts
new file mode 100644
index 00000000000..792a99ccf55
--- /dev/null
+++ b/packages/twenty-shared/src/i18n/rewrite-legacy-metadata-label-template.ts
@@ -0,0 +1,52 @@
+import { type MetadataLabelPlaceholderName } from './metadata-label-placeholder';
+import { isDefined } from '../utils/validation/isDefined';
+
+// DEPRECATED — remove once every workspace has run the 2.33 command
+// `upgrade:2-33:migrate-command-menu-item-labels-to-placeholders`, which
+// rewrites stored command menu item labels to the placeholder syntax.
+// Until then a workspace provisioned before that release still stores labels
+// as template expressions, and the placeholder interpolator leaves what it
+// does not recognise as written -- so the raw expression reaches the screen.
+// See the tracking issue for the removal checklist.
+
+// The expressions those labels were stored as, mapped onto the placeholder
+// that replaced them. Values are already capitalized by the placeholder
+// builder, so the capitalize() wrapper is dropped rather than reimplemented.
+const LEGACY_EXPRESSION_TO_PLACEHOLDER_NAME: Record<
+ string,
+ MetadataLabelPlaceholderName
+> = {
+ objectMetadataLabel: 'objectLabel',
+ 'objectMetadataItem.labelSingular': 'objectLabelSingular',
+ 'objectMetadataItem.labelPlural': 'objectLabelPlural',
+ 'objectMetadataItem.icon': 'objectIcon',
+ 'navigateToObjectMetadataItem.labelSingular': 'objectLabelSingular',
+ 'navigateToObjectMetadataItem.labelPlural': 'objectLabelPlural',
+ 'navigateToObjectMetadataItem.icon': 'objectIcon',
+};
+
+// `${capitalize(expression)}`, `${capitalize{expression}}` and bare
+// `${expression}` all occur in stored rows across the releases this syntax
+// changed in.
+const LEGACY_TEMPLATE_REGEX =
+ /\$\{\s*(?:capitalize\s*[({]\s*([\w.]+)\s*[)}]|([\w.]+))\s*\}/g;
+
+export const rewriteLegacyMetadataLabelTemplate = (message: string): string => {
+ if (!message.includes('${')) {
+ return message;
+ }
+
+ return message.replace(
+ LEGACY_TEMPLATE_REGEX,
+ (legacyExpression, capitalizedName?: string, bareName?: string) => {
+ const placeholderName =
+ LEGACY_EXPRESSION_TO_PLACEHOLDER_NAME[
+ capitalizedName ?? bareName ?? ''
+ ];
+
+ return isDefined(placeholderName)
+ ? `{${placeholderName}}`
+ : legacyExpression;
+ },
+ );
+};