feat: CommandMenuItem entity and FrontComponent support in command menu (#17555)

https://github.com/user-attachments/assets/6f172ffc-d43d-42fd-a26b-94f591fb767e
2026-01-30 22:05:06 +05:30
parent 6462ff6c5f
commit 51a2a90b0a
45 changed files with 899 additions and 34 deletions
@@ -7,6 +7,7 @@ import { CustomException } from 'src/utils/custom-exception';
 export enum CommandMenuItemExceptionCode {
  COMMAND_MENU_ITEM_NOT_FOUND = 'COMMAND_MENU_ITEM_NOT_FOUND',
  INVALID_COMMAND_MENU_ITEM_INPUT = 'INVALID_COMMAND_MENU_ITEM_INPUT',
+  WORKFLOW_OR_FRONT_COMPONENT_REQUIRED = 'WORKFLOW_OR_FRONT_COMPONENT_REQUIRED',
 }

 const getCommandMenuItemExceptionUserFriendlyMessage = (
@@ -17,6 +18,8 @@ const getCommandMenuItemExceptionUserFriendlyMessage = (
      return msg`Command menu item not found.`;
    case CommandMenuItemExceptionCode.INVALID_COMMAND_MENU_ITEM_INPUT:
      return msg`Invalid command menu item input.`;
+    case CommandMenuItemExceptionCode.WORKFLOW_OR_FRONT_COMPONENT_REQUIRED:
+      return msg`Either workflow version or front component is required.`;
    default:
      assertUnreachable(code);
  }
@@ -3,6 +3,7 @@ import { Module } from '@nestjs/common';
 import { ApplicationModule } from 'src/engine/core-modules/application/application.module';
 import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-flag.module';
 import { CommandMenuItemResolver } from 'src/engine/metadata-modules/command-menu-item/command-menu-item.resolver';
+import { FrontComponentModule } from 'src/engine/metadata-modules/front-component/front-component.module';
 import { CommandMenuItemService } from 'src/engine/metadata-modules/command-menu-item/command-menu-item.service';
 import { CommandMenuItemGraphqlApiExceptionInterceptor } from 'src/engine/metadata-modules/command-menu-item/interceptors/command-menu-item-graphql-api-exception.interceptor';
 import { FlatCommandMenuItemModule } from 'src/engine/metadata-modules/flat-command-menu-item/flat-command-menu-item.module';
@@ -16,6 +17,7 @@ import { WorkspaceMigrationModule } from 'src/engine/workspace-manager/workspace
    WorkspaceMigrationModule,
    ApplicationModule,
    FlatCommandMenuItemModule,
+    FrontComponentModule,
    FeatureFlagModule,
  ],
  providers: [
@@ -1,5 +1,14 @@
 import { UseGuards, UseInterceptors } from '@nestjs/common';
-import { Args, Mutation, Query, Resolver } from '@nestjs/graphql';
+import {
+  Args,
+  Mutation,
+  Parent,
+  Query,
+  ResolveField,
+  Resolver,
+} from '@nestjs/graphql';
+
+import { isDefined } from 'twenty-shared/utils';

 import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
 import { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/feature-flag-key.enum';
@@ -16,6 +25,8 @@ import { CommandMenuItemDTO } from 'src/engine/metadata-modules/command-menu-ite
 import { CreateCommandMenuItemInput } from 'src/engine/metadata-modules/command-menu-item/dtos/create-command-menu-item.input';
 import { UpdateCommandMenuItemInput } from 'src/engine/metadata-modules/command-menu-item/dtos/update-command-menu-item.input';
 import { CommandMenuItemGraphqlApiExceptionInterceptor } from 'src/engine/metadata-modules/command-menu-item/interceptors/command-menu-item-graphql-api-exception.interceptor';
+import { FrontComponentDTO } from 'src/engine/metadata-modules/front-component/dtos/front-component.dto';
+import { FrontComponentService } from 'src/engine/metadata-modules/front-component/front-component.service';
 import { WorkspaceMigrationGraphqlApiExceptionInterceptor } from 'src/engine/workspace-manager/workspace-migration/interceptors/workspace-migration-graphql-api-exception.interceptor';

@UseGuards(WorkspaceAuthGuard, FeatureFlagGuard)
@@ -27,8 +38,24 @@ import { WorkspaceMigrationGraphqlApiExceptionInterceptor } from 'src/engine/wor
 export class CommandMenuItemResolver {
  constructor(
    private readonly commandMenuItemService: CommandMenuItemService,
+    private readonly frontComponentService: FrontComponentService,
  ) {}

+  @ResolveField(() => FrontComponentDTO, { nullable: true })
+  async frontComponent(
+    @Parent() commandMenuItem: CommandMenuItemDTO,
+    @AuthWorkspace() workspace: WorkspaceEntity,
+  ) {
+    if (!isDefined(commandMenuItem.frontComponentId)) {
+      return null;
+    }
+
+    return this.frontComponentService.findById(
+      commandMenuItem.frontComponentId,
+      workspace.id,
+    );
+  }
+
  @Query(() => [CommandMenuItemDTO])
  @UseGuards(NoPermissionGuard)
  @RequireFeatureFlag(FeatureFlagKey.IS_COMMAND_MENU_ITEM_ENABLED)
@@ -17,6 +17,7 @@ import {

 import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
 import { CommandMenuItemAvailabilityType } from 'src/engine/metadata-modules/command-menu-item/entities/command-menu-item.entity';
+import { FrontComponentDTO } from 'src/engine/metadata-modules/front-component/dtos/front-component.dto';

 registerEnumType(CommandMenuItemAvailabilityType, {
  name: 'CommandMenuItemAvailabilityType',
@@ -30,9 +31,17 @@ export class CommandMenuItemDTO {
  id: string;

  @IsUUID()
-  @IsNotEmpty()
-  @Field(() => UUIDScalarType)
-  workflowVersionId: string;
+  @IsOptional()
+  @Field(() => UUIDScalarType, { nullable: true })
+  workflowVersionId?: string;
+
+  @IsUUID()
+  @IsOptional()
+  @Field(() => UUIDScalarType, { nullable: true })
+  frontComponentId?: string;
+
+  @Field(() => FrontComponentDTO, { nullable: true })
+  frontComponent?: FrontComponentDTO | null;

  @IsString()
  @IsNotEmpty()
@@ -15,9 +15,14 @@ import { CommandMenuItemAvailabilityType } from 'src/engine/metadata-modules/com
@InputType()
 export class CreateCommandMenuItemInput {
  @IsUUID()
-  @IsNotEmpty()
-  @Field(() => UUIDScalarType)
-  workflowVersionId: string;
+  @IsOptional()
+  @Field(() => UUIDScalarType, { nullable: true })
+  workflowVersionId?: string;
+
+  @IsUUID()
+  @IsOptional()
+  @Field(() => UUIDScalarType, { nullable: true })
+  frontComponentId?: string;

  @IsString()
  @IsNotEmpty()
@@ -1,4 +1,5 @@
 import {
+  Check,
  Column,
  CreateDateColumn,
  Entity,
@@ -10,6 +11,7 @@ import {
  UpdateDateColumn,
 } from 'typeorm';

+import { FrontComponentEntity } from 'src/engine/metadata-modules/front-component/entities/front-component.entity';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
 import { SyncableEntity } from 'src/engine/workspace-manager/types/syncable-entity.interface';

@@ -24,9 +26,17 @@ export enum CommandMenuItemAvailabilityType {
  'workflowVersionId',
  'workspaceId',
 ])
+@Index('IDX_COMMAND_MENU_ITEM_FRONT_COMPONENT_ID_WORKSPACE_ID', [
+  'frontComponentId',
+  'workspaceId',
+])
@Index('IDX_COMMAND_MENU_ITEM_AVAILABILITY_OBJECT_METADATA_ID', [
  'availabilityObjectMetadataId',
 ])
+@Check(
+  'CHK_command_menu_item_workflow_or_front_component',
+  '("workflowVersionId" IS NOT NULL AND "frontComponentId" IS NULL) OR ("workflowVersionId" IS NULL AND "frontComponentId" IS NOT NULL)',
+)
 export class CommandMenuItemEntity
  extends SyncableEntity
  implements Required<CommandMenuItemEntity>
@@ -34,8 +44,18 @@ export class CommandMenuItemEntity
  @PrimaryGeneratedColumn('uuid')
  id: string;

-  @Column({ nullable: false, type: 'uuid' })
-  workflowVersionId: string;
+  @Column({ nullable: true, type: 'uuid' })
+  workflowVersionId: string | null;
+
+  @Column({ nullable: true, type: 'uuid' })
+  frontComponentId: string | null;
+
+  @ManyToOne(() => FrontComponentEntity, {
+    onDelete: 'CASCADE',
+    nullable: true,
+  })
+  @JoinColumn({ name: 'frontComponentId' })
+  frontComponent: Relation<FrontComponentEntity> | null;

  @Column({ nullable: false })
  label: string;
@@ -15,6 +15,7 @@ export const commandMenuItemGraphqlApiExceptionHandler = (error: Error) => {
      case CommandMenuItemExceptionCode.COMMAND_MENU_ITEM_NOT_FOUND:
        throw new NotFoundError(error);
      case CommandMenuItemExceptionCode.INVALID_COMMAND_MENU_ITEM_INPUT:
+      case CommandMenuItemExceptionCode.WORKFLOW_OR_FRONT_COMPONENT_REQUIRED:
        throw new UserInputError(error);
      default: {
        return assertUnreachable(error.code);
@@ -5,6 +5,7 @@ import { ApplicationEntity } from 'src/engine/core-modules/application/applicati
 import { CommandMenuItemEntity } from 'src/engine/metadata-modules/command-menu-item/entities/command-menu-item.entity';
 import { WorkspaceFlatCommandMenuItemMapCacheService } from 'src/engine/metadata-modules/flat-command-menu-item/services/workspace-flat-command-menu-item-map-cache.service';
 import { WorkspaceManyOrAllFlatEntityMapsCacheModule } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.module';
+import { FrontComponentEntity } from 'src/engine/metadata-modules/front-component/entities/front-component.entity';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';

@Module({
@@ -13,6 +14,7 @@ import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadat
      CommandMenuItemEntity,
      ApplicationEntity,
      ObjectMetadataEntity,
+      FrontComponentEntity,
    ]),
    WorkspaceManyOrAllFlatEntityMapsCacheModule,
  ],
@@ -10,6 +10,7 @@ import { CommandMenuItemEntity } from 'src/engine/metadata-modules/command-menu-
 import { type FlatCommandMenuItemMaps } from 'src/engine/metadata-modules/flat-command-menu-item/types/flat-command-menu-item-maps.type';
 import { fromCommandMenuItemEntityToFlatCommandMenuItem } from 'src/engine/metadata-modules/flat-command-menu-item/utils/from-command-menu-item-entity-to-flat-command-menu-item.util';
 import { createEmptyFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/constant/create-empty-flat-entity-maps.constant';
+import { FrontComponentEntity } from 'src/engine/metadata-modules/front-component/entities/front-component.entity';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
 import { WorkspaceCache } from 'src/engine/workspace-cache/decorators/workspace-cache.decorator';
 import { createIdToUniversalIdentifierMap } from 'src/engine/workspace-cache/utils/create-id-to-universal-identifier-map.util';
@@ -25,13 +26,15 @@ export class WorkspaceFlatCommandMenuItemMapCacheService extends WorkspaceCacheP
    private readonly applicationRepository: Repository<ApplicationEntity>,
    @InjectRepository(ObjectMetadataEntity)
    private readonly objectMetadataRepository: Repository<ObjectMetadataEntity>,
+    @InjectRepository(FrontComponentEntity)
+    private readonly frontComponentRepository: Repository<FrontComponentEntity>,
  ) {
    super();
  }

  async computeForCache(workspaceId: string): Promise<FlatCommandMenuItemMaps> {
-    const [commandMenuItems, applications, objectMetadatas] = await Promise.all(
-      [
+    const [commandMenuItems, applications, objectMetadatas, frontComponents] =
+      await Promise.all([
        this.commandMenuItemRepository.find({
          where: { workspaceId },
          withDeleted: true,
@@ -46,13 +49,19 @@ export class WorkspaceFlatCommandMenuItemMapCacheService extends WorkspaceCacheP
          select: ['id', 'universalIdentifier'],
          withDeleted: true,
        }),
-      ],
-    );
+        this.frontComponentRepository.find({
+          where: { workspaceId },
+          select: ['id', 'universalIdentifier'],
+          withDeleted: true,
+        }),
+      ]);

    const applicationIdToUniversalIdentifierMap =
      createIdToUniversalIdentifierMap(applications);
    const objectMetadataIdToUniversalIdentifierMap =
      createIdToUniversalIdentifierMap(objectMetadatas);
+    const frontComponentIdToUniversalIdentifierMap =
+      createIdToUniversalIdentifierMap(frontComponents);

    const flatCommandMenuItemMaps = createEmptyFlatEntityMaps();

@@ -62,6 +71,7 @@ export class WorkspaceFlatCommandMenuItemMapCacheService extends WorkspaceCacheP
          entity: commandMenuItemEntity,
          applicationIdToUniversalIdentifierMap,
          objectMetadataIdToUniversalIdentifierMap,
+          frontComponentIdToUniversalIdentifierMap,
        });

      addFlatEntityToFlatEntityMapsThroughMutationOrThrow({
@@ -11,6 +11,7 @@ export const fromCommandMenuItemEntityToFlatCommandMenuItem = ({
  entity: commandMenuItemEntity,
  applicationIdToUniversalIdentifierMap,
  objectMetadataIdToUniversalIdentifierMap,
+  frontComponentIdToUniversalIdentifierMap,
 }: FromEntityToFlatEntityArgs<'commandMenuItem'>): FlatCommandMenuItem => {
  const applicationUniversalIdentifier =
    applicationIdToUniversalIdentifierMap.get(
@@ -40,9 +41,26 @@ export const fromCommandMenuItemEntityToFlatCommandMenuItem = ({
    }
  }

+  let frontComponentUniversalIdentifier: string | null = null;
+
+  if (isDefined(commandMenuItemEntity.frontComponentId)) {
+    frontComponentUniversalIdentifier =
+      frontComponentIdToUniversalIdentifierMap.get(
+        commandMenuItemEntity.frontComponentId,
+      ) ?? null;
+
+    if (!isDefined(frontComponentUniversalIdentifier)) {
+      throw new FlatEntityMapsException(
+        `FrontComponent with id ${commandMenuItemEntity.frontComponentId} not found for commandMenuItem ${commandMenuItemEntity.id}`,
+        FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
+      );
+    }
+  }
+
  return {
    id: commandMenuItemEntity.id,
    workflowVersionId: commandMenuItemEntity.workflowVersionId,
+    frontComponentId: commandMenuItemEntity.frontComponentId,
    label: commandMenuItemEntity.label,
    icon: commandMenuItemEntity.icon,
    isPinned: commandMenuItemEntity.isPinned,
@@ -58,6 +76,7 @@ export const fromCommandMenuItemEntityToFlatCommandMenuItem = ({
      universalIdentifier: commandMenuItemEntity.universalIdentifier,
      applicationUniversalIdentifier,
      availabilityObjectMetadataUniversalIdentifier,
+      frontComponentUniversalIdentifier,
    },
  };
 };
@@ -1,5 +1,10 @@
+import { isDefined } from 'twenty-shared/utils';
 import { v4 as uuidv4 } from 'uuid';

+import {
+  CommandMenuItemException,
+  CommandMenuItemExceptionCode,
+} from 'src/engine/metadata-modules/command-menu-item/command-menu-item.exception';
 import { type CreateCommandMenuItemInput } from 'src/engine/metadata-modules/command-menu-item/dtos/create-command-menu-item.input';
 import { CommandMenuItemAvailabilityType } from 'src/engine/metadata-modules/command-menu-item/entities/command-menu-item.entity';
 import { type FlatCommandMenuItem } from 'src/engine/metadata-modules/flat-command-menu-item/types/flat-command-menu-item.type';
@@ -13,13 +18,28 @@ export const fromCreateCommandMenuItemInputToFlatCommandMenuItemToCreate = ({
  workspaceId: string;
  applicationId: string;
 }): FlatCommandMenuItem => {
+  const hasWorkflowVersionId = isDefined(
+    createCommandMenuItemInput.workflowVersionId,
+  );
+  const hasFrontComponentId = isDefined(
+    createCommandMenuItemInput.frontComponentId,
+  );
+
+  if (hasWorkflowVersionId === hasFrontComponentId) {
+    throw new CommandMenuItemException(
+      'Exactly one of workflowVersionId or frontComponentId is required',
+      CommandMenuItemExceptionCode.WORKFLOW_OR_FRONT_COMPONENT_REQUIRED,
+    );
+  }
+
  const id = uuidv4();
  const now = new Date().toISOString();

  return {
    id,
    universalIdentifier: id,
-    workflowVersionId: createCommandMenuItemInput.workflowVersionId,
+    workflowVersionId: createCommandMenuItemInput.workflowVersionId ?? null,
+    frontComponentId: createCommandMenuItemInput.frontComponentId ?? null,
    label: createCommandMenuItemInput.label,
    icon: createCommandMenuItemInput.icon ?? null,
    isPinned: createCommandMenuItemInput.isPinned ?? false,
@@ -5,7 +5,8 @@ export const fromFlatCommandMenuItemToCommandMenuItemDto = (
  flatCommandMenuItem: FlatCommandMenuItem,
 ): CommandMenuItemDTO => ({
  id: flatCommandMenuItem.id,
-  workflowVersionId: flatCommandMenuItem.workflowVersionId,
+  workflowVersionId: flatCommandMenuItem.workflowVersionId ?? undefined,
+  frontComponentId: flatCommandMenuItem.frontComponentId ?? undefined,
  label: flatCommandMenuItem.label,
  icon: flatCommandMenuItem.icon ?? undefined,
  isPinned: flatCommandMenuItem.isPinned,
@@ -85,6 +85,11 @@ export const ALL_METADATA_RELATIONS = {
        flatEntityForeignKeyAggregator: null,
        foreignKey: 'availabilityObjectMetadataId',
      },
+      frontComponent: {
+        metadataName: 'frontComponent',
+        flatEntityForeignKeyAggregator: null,
+        foreignKey: 'frontComponentId',
+      },
    },
    oneToMany: {},
  },
@@ -55,6 +55,7 @@ export const ALL_METADATA_REQUIRED_METADATA_FOR_VALIDATION = {
  skill: {},
  commandMenuItem: {
    objectMetadata: true,
+    frontComponent: true,
  },
  navigationMenuItem: {
    objectMetadata: true,
@@ -1,10 +1,11 @@
-// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+// Jest Snapshot v1, https://goo.gl/fbAQLP

 exports[`getMetadataRelatedMetadataNames should return related metadata names for agent 1`] = `[]`;

 exports[`getMetadataRelatedMetadataNames should return related metadata names for commandMenuItem 1`] = `
 [
  "objectMetadata",
+  "frontComponent",
 ]
 `;

@@ -5,9 +5,9 @@ exports[`sortMetadataNamesChildrenFirst should return metadata names sorted with
  "rowLevelPermissionPredicate",
  "navigationMenuItem",
  "viewFilter",
+  "commandMenuItem",
  "pageLayoutWidget",
  "viewField",
-  "commandMenuItem",
  "index",
  "pageLayout",
  "roleTarget",