Update searchVector at label identifier update for custom fields (#7588)

By default, when custom fields are created, a searchVector field is
created based on the "name" field, which is also the label identifier by
default.
When this label identifier is updated, we want to update the
searchVector field to use this field as searchable field instead, if it
is of "searchable type" (today it is only possible to select a text or
number field as label identifier, while number fields are not
searchable).

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

@@ -14,12 +14,12 @@ import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-
 import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
 import { DataSourceModule } from 'src/engine/metadata-modules/data-source/data-source.module';
 import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
-import { IndexMetadataModule } from 'src/engine/metadata-modules/index-metadata/index-metadata.module';
 import { BeforeUpdateOneObject } from 'src/engine/metadata-modules/object-metadata/hooks/before-update-one-object.hook';
 import { ObjectMetadataGraphqlApiExceptionInterceptor } from 'src/engine/metadata-modules/object-metadata/interceptors/object-metadata-graphql-api-exception.interceptor';
 import { ObjectMetadataResolver } from 'src/engine/metadata-modules/object-metadata/object-metadata.resolver';
 import { RelationMetadataEntity } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
 import { RemoteTableRelationsModule } from 'src/engine/metadata-modules/remote-server/remote-table/remote-table-relations/remote-table-relations.module';
+import { SearchModule } from 'src/engine/metadata-modules/search/search.module';
 import { WorkspaceMetadataVersionModule } from 'src/engine/metadata-modules/workspace-metadata-version/workspace-metadata-version.module';
 import { WorkspaceMigrationModule } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.module';
 import { WorkspaceMigrationRunnerModule } from 'src/engine/workspace-manager/workspace-migration-runner/workspace-migration-runner.module';
@@ -46,8 +46,8 @@ import { UpdateObjectPayload } from './dtos/update-object.input';
         WorkspaceMigrationRunnerModule,
         WorkspaceMetadataVersionModule,
         RemoteTableRelationsModule,
-        IndexMetadataModule,
         FeatureFlagModule,
+        SearchModule,
       ],
       services: [ObjectMetadataService],
       resolvers: [

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

@@ -5,30 +5,20 @@ import console from 'console';
 
 import { Query, QueryOptions } from '@ptc-org/nestjs-query-core';
 import { TypeOrmQueryService } from '@ptc-org/nestjs-query-typeorm';
-import { isDefined } from 'class-validator';
 import { FindManyOptions, FindOneOptions, In, Repository } from 'typeorm';
 
 import { FieldMetadataSettings } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata-settings.interface';
-import { FieldMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata.interface';
 
 import { TypeORMService } from 'src/database/typeorm/typeorm.service';
-import { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/feature-flag-key.enum';
 import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
-import { SEARCH_VECTOR_FIELD } from 'src/engine/metadata-modules/constants/search-vector-field.constants';
 import { DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
 import {
   FieldMetadataEntity,
   FieldMetadataType,
 } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
-import {
-  computeColumnName,
-  FieldTypeAndNameMetadata,
-} from 'src/engine/metadata-modules/field-metadata/utils/compute-column-name.util';
-import { IndexType } from 'src/engine/metadata-modules/index-metadata/index-metadata.entity';
-import { IndexMetadataService } from 'src/engine/metadata-modules/index-metadata/index-metadata.service';
+import { computeColumnName } from 'src/engine/metadata-modules/field-metadata/utils/compute-column-name.util';
 import { DeleteOneObjectInput } from 'src/engine/metadata-modules/object-metadata/dtos/delete-object.input';
 import { UpdateOneObjectInput } from 'src/engine/metadata-modules/object-metadata/dtos/update-object.input';
-import { DEFAULT_LABEL_IDENTIFIER_FIELD_NAME } from 'src/engine/metadata-modules/object-metadata/object-metadata.constants';
 import {
   ObjectMetadataException,
   ObjectMetadataExceptionCode,
@@ -43,8 +33,8 @@ import {
 import { RelationToDelete } from 'src/engine/metadata-modules/relation-metadata/types/relation-to-delete';
 import { RemoteTableRelationsService } from 'src/engine/metadata-modules/remote-server/remote-table/remote-table-relations/remote-table-relations.service';
 import { mapUdtNameToFieldType } from 'src/engine/metadata-modules/remote-server/remote-table/utils/udt-name-mapper.util';
+import { SearchService } from 'src/engine/metadata-modules/search/search.service';
 import { WorkspaceMetadataVersionService } from 'src/engine/metadata-modules/workspace-metadata-version/services/workspace-metadata-version.service';
-import { TsVectorColumnActionFactory } from 'src/engine/metadata-modules/workspace-migration/factories/ts-vector-column-action.factory';
 import { generateMigrationName } from 'src/engine/metadata-modules/workspace-migration/utils/generate-migration-name.util';
 import {
   WorkspaceMigrationColumnActionType,
@@ -72,7 +62,7 @@ import {
   createForeignKeyDeterministicUuid,
   createRelationDeterministicUuid,
 } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/create-deterministic-uuid.util';
-import { getTsVectorColumnExpressionFromFields } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/get-ts-vector-column-expression.util';
+import { isSearchableFieldType } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/is-searchable-field.util';
 import { FavoriteWorkspaceEntity } from 'src/modules/favorite/standard-objects/favorite.workspace-entity';
 import { ViewWorkspaceEntity } from 'src/modules/view/standard-objects/view.workspace-entity';
 
@@ -94,17 +84,14 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
 
     private readonly remoteTableRelationsService: RemoteTableRelationsService,
 
-    private readonly tsVectorColumnActionFactory: TsVectorColumnActionFactory,
-
     private readonly dataSourceService: DataSourceService,
     private readonly typeORMService: TypeORMService,
     private readonly workspaceMigrationService: WorkspaceMigrationService,
-
-    private readonly indexMetadataService: IndexMetadataService,
     private readonly featureFlagService: FeatureFlagService,
     private readonly workspaceMigrationRunnerService: WorkspaceMigrationRunnerService,
     private readonly workspaceMetadataVersionService: WorkspaceMetadataVersionService,
     private readonly twentyORMGlobalManager: TwentyORMGlobalManager,
+    private readonly searchService: SearchService,
     private readonly workspaceMigrationFactory: WorkspaceMigrationFactory,
   ) {
     super(objectMetadataRepository);
@@ -372,17 +359,10 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
         createdObjectMetadata,
       );
 
-      const isSearchEnabled = await this.featureFlagService.isFeatureEnabled(
-        FeatureFlagKey.IsSearchEnabled,
-        objectMetadataInput.workspaceId,
+      await this.searchService.createSearchVectorFieldForObject(
+        objectMetadataInput,
+        createdObjectMetadata,
       );
-
-      if (isSearchEnabled) {
-        await this.createSearchVectorField(
-          objectMetadataInput,
-          createdObjectMetadata,
-        );
-      }
     } else {
       await this.remoteTableRelationsService.createForeignKeysMetadataAndMigrations(
         objectMetadataInput.workspaceId,
@@ -447,6 +427,32 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
       await this.updateObjectRelationships(input.id, input.update.isActive);
     }
 
+    if (input.update.labelIdentifierFieldMetadataId) {
+      const labelIdentifierFieldMetadata =
+        await this.fieldMetadataRepository.findOneByOrFail({
+          id: input.update.labelIdentifierFieldMetadataId,
+          objectMetadataId: input.id,
+          workspaceId: workspaceId,
+        });
+
+      if (isSearchableFieldType(labelIdentifierFieldMetadata.type)) {
+        await this.searchService.updateSearchVector(
+          input.id,
+          [
+            {
+              name: labelIdentifierFieldMetadata.name,
+              type: labelIdentifierFieldMetadata.type,
+            },
+          ],
+          workspaceId,
+        );
+      }
+
+      await this.workspaceMigrationRunnerService.executeMigrationFromPendingMigrations(
+        workspaceId,
+      );
+    }
+
     await this.workspaceMetadataVersionService.incrementMetadataVersion(
       workspaceId,
     );
@@ -611,73 +617,6 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
     );
   }
 
-  private async createSearchVectorField(
-    objectMetadataInput: CreateObjectInput,
-    createdObjectMetadata: ObjectMetadataEntity,
-  ) {
-    const searchVectorFieldMetadata = await this.fieldMetadataRepository.save({
-      standardId: CUSTOM_OBJECT_STANDARD_FIELD_IDS.searchVector,
-      objectMetadataId: createdObjectMetadata.id,
-      workspaceId: objectMetadataInput.workspaceId,
-      isCustom: false,
-      isActive: false,
-      isSystem: true,
-      type: FieldMetadataType.TS_VECTOR,
-      name: SEARCH_VECTOR_FIELD.name,
-      label: SEARCH_VECTOR_FIELD.label,
-      description: SEARCH_VECTOR_FIELD.description,
-      isNullable: true,
-    });
-
-    const searchableFieldForCustomObject =
-      createdObjectMetadata.labelIdentifierFieldMetadataId
-        ? createdObjectMetadata.fields.find(
-            (field) =>
-              field.id === createdObjectMetadata.labelIdentifierFieldMetadataId,
-          )
-        : createdObjectMetadata.fields.find(
-            (field) => field.name === DEFAULT_LABEL_IDENTIFIER_FIELD_NAME,
-          );
-
-    if (!isDefined(searchableFieldForCustomObject)) {
-      throw new Error('No searchable field found for custom object');
-    }
-
-    this.workspaceMigrationService.createCustomMigration(
-      generateMigrationName(
-        `update-${createdObjectMetadata.nameSingular}-add-searchVector`,
-      ),
-      createdObjectMetadata.workspaceId,
-      [
-        {
-          name: computeTableName(
-            createdObjectMetadata.nameSingular,
-            createdObjectMetadata.isCustom,
-          ),
-          action: WorkspaceMigrationTableActionType.ALTER,
-          columns: this.tsVectorColumnActionFactory.handleCreateAction({
-            ...searchVectorFieldMetadata,
-            defaultValue: undefined,
-            generatedType: 'STORED',
-            asExpression: getTsVectorColumnExpressionFromFields([
-              searchableFieldForCustomObject as FieldTypeAndNameMetadata,
-            ]),
-            options: undefined,
-          } as FieldMetadataInterface<FieldMetadataType.TS_VECTOR>),
-        },
-      ],
-    );
-
-    await this.indexMetadataService.createIndex(
-      objectMetadataInput.workspaceId,
-      createdObjectMetadata,
-      [searchVectorFieldMetadata],
-      false,
-      false,
-      IndexType.GIN,
-    );
-  }
-
   private async createActivityTargetRelation(
     workspaceId: string,
     createdObjectMetadata: ObjectMetadataEntity,