Backfill workspace favorites (#7122)

- command to backfill workspace favorites
- create workspace favorites on workspace activation
- create workspace favorites on demo seed

---------

Co-authored-by: Charles Bochet <charles@twenty.com>

packages/twenty-server/src/database/commands/data-seed-dev-workspace.command.ts

@@ -34,7 +34,7 @@ import { InjectCacheStorage } from 'src/engine/core-modules/cache-storage/decora
 import { CacheStorageService } from 'src/engine/core-modules/cache-storage/services/cache-storage.service';
 import { CacheStorageNamespace } from 'src/engine/core-modules/cache-storage/types/cache-storage-namespace.enum';
 import { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/feature-flag-key.enum';
-import { FeatureFlagEntity } from 'src/engine/core-modules/feature-flag/feature-flag.entity';
+import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
 import { DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
 import { FieldMetadataService } from 'src/engine/metadata-modules/field-metadata/field-metadata.service';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
@@ -63,6 +63,7 @@ export class DataSeedWorkspaceCommand extends CommandRunner {
     private readonly objectMetadataService: ObjectMetadataService,
     @InjectCacheStorage(CacheStorageNamespace.EngineWorkspace)
     private readonly workspaceSchemaCache: CacheStorageService,
+    private readonly featureFlagService: FeatureFlagService,
   ) {
     super();
   }
@@ -129,10 +130,17 @@ export class DataSeedWorkspaceCommand extends CommandRunner {
           return acc;
         }, {});
 
-        const featureFlagRepository =
+        const isMessageThreadSubscriberEnabled =
-          workspaceDataSource.getRepository<FeatureFlagEntity>('featureFlag');
+          await this.featureFlagService.isFeatureEnabled(
+            FeatureFlagKey.IsMessageThreadSubscriberEnabled,
+            workspaceId,
+          );
 
-        const featureFlags = await featureFlagRepository.find({});
+        const isWorkflowEnabled =
+          await this.featureFlagService.isFeatureEnabled(
+            FeatureFlagKey.IsWorkflowEnabled,
+            workspaceId,
+          );
 
         await this.seedCompanyCustomFields(
           objectMetadataMap[STANDARD_OBJECT_IDS.company],
@@ -161,13 +169,6 @@ export class DataSeedWorkspaceCommand extends CommandRunner {
                 dataSourceMetadata.schema,
               );
 
-              const isMessageThreadSubscriberEnabled = featureFlags.some(
-                (featureFlag) =>
-                  featureFlag.key ===
-                    FeatureFlagKey.IsMessageThreadSubscriberEnabled &&
-                  featureFlag.value === true,
-              );
-
               if (isMessageThreadSubscriberEnabled) {
                 await seedMessageThreadSubscribers(
                   entityManager,
@@ -211,11 +212,13 @@ export class DataSeedWorkspaceCommand extends CommandRunner {
               entityManager,
               dataSourceMetadata.schema,
               objectMetadataMap,
-              featureFlags,
+              isWorkflowEnabled,
             );
 
             await seedWorkspaceFavorites(
-              viewDefinitionsWithId.map((view) => view.id),
+              viewDefinitionsWithId
+                .filter((view) => view.key === 'INDEX')
+                .map((view) => view.id),
               entityManager,
               dataSourceMetadata.schema,
             );

packages/twenty-server/src/database/commands/database-command.module.ts

@@ -8,9 +8,11 @@ import { DataSeedDemoWorkspaceModule } from 'src/database/commands/data-seed-dem
 import { DataSeedWorkspaceCommand } from 'src/database/commands/data-seed-dev-workspace.command';
 import { ConfirmationQuestion } from 'src/database/commands/questions/confirmation.question';
 import { UpgradeTo0_30CommandModule } from 'src/database/commands/upgrade-version/0-30/0-30-upgrade-version.module';
+import { UpgradeTo0_31CommandModule } from 'src/database/commands/upgrade-version/0-31/0-31-upgrade-version.module';
 import { TypeORMModule } from 'src/database/typeorm/typeorm.module';
 import { BillingSubscription } from 'src/engine/core-modules/billing/entities/billing-subscription.entity';
 import { FeatureFlagEntity } from 'src/engine/core-modules/feature-flag/feature-flag.entity';
+import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-flag.module';
 import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
 import { WorkspaceModule } from 'src/engine/core-modules/workspace/workspace.module';
 import { DataSourceModule } from 'src/engine/metadata-modules/data-source/data-source.module';
@@ -46,6 +48,8 @@ import { WorkspaceSyncMetadataModule } from 'src/engine/workspace-manager/worksp
     WorkspaceCacheStorageModule,
     WorkspaceMetadataVersionModule,
     UpgradeTo0_30CommandModule,
+    UpgradeTo0_31CommandModule,
+    FeatureFlagModule,
   ],
   providers: [
     DataSeedWorkspaceCommand,

packages/twenty-server/src/database/commands/upgrade-version/0-31/0-31-backfill-workspace-favorites.command.ts

@@ -0,0 +1,121 @@
+import { InjectRepository } from '@nestjs/typeorm';
+
+import chalk from 'chalk';
+import { Command } from 'nest-commander';
+import { Repository } from 'typeorm';
+
+import {
+  ActiveWorkspacesCommandOptions,
+  ActiveWorkspacesCommandRunner,
+} from 'src/database/commands/active-workspaces.command';
+import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
+import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
+import { FavoriteWorkspaceEntity } from 'src/modules/favorite/standard-objects/favorite.workspace-entity';
+import { ViewWorkspaceEntity } from 'src/modules/view/standard-objects/view.workspace-entity';
+
+@Command({
+  name: 'upgrade-0.31:backfill-workspace-favorites-migration',
+  description: 'Create a workspace favorite for all workspace views',
+})
+export class BackfillWorkspaceFavoritesCommand extends ActiveWorkspacesCommandRunner {
+  constructor(
+    @InjectRepository(Workspace, 'core')
+    protected readonly workspaceRepository: Repository<Workspace>,
+    private readonly twentyORMGlobalManager: TwentyORMGlobalManager,
+  ) {
+    super(workspaceRepository);
+  }
+
+  async executeActiveWorkspacesCommand(
+    _passedParam: string[],
+    _options: ActiveWorkspacesCommandOptions,
+    workspaceIds: string[],
+  ): Promise<void> {
+    this.logger.log('Running command to fix migration');
+
+    for (const workspaceId of workspaceIds) {
+      this.logger.log(`Running command for workspace ${workspaceId}`);
+
+      try {
+        const workspaceIndexViews = await this.getIndexViews(workspaceId);
+
+        await this.createViewWorkspaceFavorites(
+          workspaceId,
+          workspaceIndexViews.map((view) => view.id),
+        );
+
+        this.logger.log(
+          chalk.green(`Backfilled workspace favorites to ${workspaceId}.`),
+        );
+
+        await this.twentyORMGlobalManager.destroyDataSourceForWorkspace(
+          workspaceId,
+        );
+      } catch (error) {
+        this.logger.log(
+          chalk.red(
+            `Running command on workspace ${workspaceId} failed with error: ${error}`,
+          ),
+        );
+        continue;
+      } finally {
+        this.logger.log(
+          chalk.green(`Finished running command for workspace ${workspaceId}.`),
+        );
+      }
+
+      this.logger.log(chalk.green(`Command completed!`));
+    }
+  }
+
+  private async getIndexViews(
+    workspaceId: string,
+  ): Promise<ViewWorkspaceEntity[]> {
+    const viewRepository =
+      await this.twentyORMGlobalManager.getRepositoryForWorkspace<ViewWorkspaceEntity>(
+        workspaceId,
+        'view',
+        false,
+      );
+
+    return viewRepository.find({
+      where: {
+        key: 'INDEX',
+      },
+    });
+  }
+
+  private async createViewWorkspaceFavorites(
+    workspaceId: string,
+    viewIds: string[],
+  ) {
+    const favoriteRepository =
+      await this.twentyORMGlobalManager.getRepositoryForWorkspace<FavoriteWorkspaceEntity>(
+        workspaceId,
+        'favorite',
+      );
+
+    let nextFavoritePosition = await favoriteRepository.count();
+
+    for (const viewId of viewIds) {
+      const existingFavorites = await favoriteRepository.find({
+        where: {
+          viewId,
+        },
+      });
+
+      if (existingFavorites.length) {
+        continue;
+      }
+
+      await favoriteRepository.insert(
+        favoriteRepository.create({
+          viewId,
+          position: nextFavoritePosition,
+        }),
+      );
+
+      nextFavoritePosition++;
+    }
+  }
+}

packages/twenty-server/src/database/commands/upgrade-version/0-31/0-31-upgrade-version.command.ts

@@ -0,0 +1,40 @@
+import { InjectRepository } from '@nestjs/typeorm';
+
+import { Command } from 'nest-commander';
+import { Repository } from 'typeorm';
+
+import { ActiveWorkspacesCommandRunner } from 'src/database/commands/active-workspaces.command';
+import { BackfillWorkspaceFavoritesCommand } from 'src/database/commands/upgrade-version/0-31/0-31-backfill-workspace-favorites.command';
+import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
+
+interface UpdateTo0_31CommandOptions {
+  workspaceId?: string;
+}
+
+@Command({
+  name: 'upgrade-0.31',
+  description: 'Upgrade to 0.31',
+})
+export class UpgradeTo0_31Command extends ActiveWorkspacesCommandRunner {
+  constructor(
+    @InjectRepository(Workspace, 'core')
+    protected readonly workspaceRepository: Repository<Workspace>,
+    private readonly backfillWorkspaceFavoritesCommand: BackfillWorkspaceFavoritesCommand,
+  ) {
+    super(workspaceRepository);
+  }
+
+  async executeActiveWorkspacesCommand(
+    passedParam: string[],
+    options: UpdateTo0_31CommandOptions,
+    workspaceIds: string[],
+  ): Promise<void> {
+    await this.backfillWorkspaceFavoritesCommand.executeActiveWorkspacesCommand(
+      passedParam,
+      {
+        ...options,
+      },
+      workspaceIds,
+    );
+  }
+}

packages/twenty-server/src/database/commands/upgrade-version/0-31/0-31-upgrade-version.module.ts

@@ -0,0 +1,12 @@
+import { Module } from '@nestjs/common';
+import { TypeOrmModule } from '@nestjs/typeorm';
+
+import { BackfillWorkspaceFavoritesCommand } from 'src/database/commands/upgrade-version/0-31/0-31-backfill-workspace-favorites.command';
+import { UpgradeTo0_31Command } from 'src/database/commands/upgrade-version/0-31/0-31-upgrade-version.command';
+import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
+
+@Module({
+  imports: [TypeOrmModule.forFeature([Workspace], 'core')],
+  providers: [UpgradeTo0_31Command, BackfillWorkspaceFavoritesCommand],
+})
+export class UpgradeTo0_31CommandModule {}

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

@@ -10,7 +10,6 @@ import { FindManyOptions, FindOneOptions, In, Repository } from 'typeorm';
 import { FieldMetadataSettings } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata-settings.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 { DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
 import {
@@ -374,18 +373,10 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
       );
     });
 
-    const isViewWorkspaceFavoriteEnabled =
+    await this.createViewWorkspaceFavorite(
-      await this.featureFlagService.isFeatureEnabled(
+      objectMetadataInput.workspaceId,
-        FeatureFlagKey.IsWorkspaceFavoriteEnabled,
+      view[0].id,
-        objectMetadataInput.workspaceId,
+    );
-      );
-
-    if (isViewWorkspaceFavoriteEnabled) {
-      await this.createViewWorkspaceFavorite(
-        objectMetadataInput.workspaceId,
-        view[0].id,
-      );
-    }
 
     await this.workspaceMetadataVersionService.incrementMetadataVersion(
       objectMetadataInput.workspaceId,

packages/twenty-server/src/engine/workspace-manager/demo-objects-prefill-data/demo-objects-prefill-data.ts

@@ -1,16 +1,18 @@
 import { DataSource, EntityManager } from 'typeorm';
 
+import { seedWorkspaceFavorites } from 'src/database/typeorm-seeds/workspace/favorites';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
+import { companyPrefillDemoData } from 'src/engine/workspace-manager/demo-objects-prefill-data/company';
+import { opportunityPrefillDemoData } from 'src/engine/workspace-manager/demo-objects-prefill-data/opportunity';
+import { personPrefillDemoData } from 'src/engine/workspace-manager/demo-objects-prefill-data/person';
 import { workspaceMemberPrefillData } from 'src/engine/workspace-manager/demo-objects-prefill-data/workspace-member';
 import { viewPrefillData } from 'src/engine/workspace-manager/standard-objects-prefill-data/view';
-import { companyPrefillDemoData } from 'src/engine/workspace-manager/demo-objects-prefill-data/company';
-import { personPrefillDemoData } from 'src/engine/workspace-manager/demo-objects-prefill-data/person';
-import { opportunityPrefillDemoData } from 'src/engine/workspace-manager/demo-objects-prefill-data/opportunity';
 
 export const demoObjectsPrefillData = async (
   workspaceDataSource: DataSource,
   schemaName: string,
   objectMetadata: ObjectMetadataEntity[],
+  isWorkflowEnabled: boolean,
 ) => {
   const objectMetadataMap = objectMetadata.reduce((acc, object) => {
     acc[object.standardId ?? ''] = {
@@ -31,8 +33,20 @@ export const demoObjectsPrefillData = async (
       await personPrefillDemoData(entityManager, schemaName);
       await opportunityPrefillDemoData(entityManager, schemaName);
 
-      await viewPrefillData(entityManager, schemaName, objectMetadataMap);
+      const viewDefinitionsWithId = await viewPrefillData(
+        entityManager,
+        schemaName,
+        objectMetadataMap,
+        isWorkflowEnabled,
+      );
 
+      await seedWorkspaceFavorites(
+        viewDefinitionsWithId
+          .filter((view) => view.key === 'INDEX')
+          .map((view) => view.id),
+        entityManager,
+        schemaName,
+      );
       await workspaceMemberPrefillData(entityManager, schemaName);
     },
   );

packages/twenty-server/src/engine/workspace-manager/standard-objects-prefill-data/standard-objects-prefill-data.ts

@@ -1,5 +1,6 @@
 import { DataSource, EntityManager } from 'typeorm';
 
+import { seedWorkspaceFavorites } from 'src/database/typeorm-seeds/workspace/favorites';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
 import { companyPrefillData } from 'src/engine/workspace-manager/standard-objects-prefill-data/company';
 import { personPrefillData } from 'src/engine/workspace-manager/standard-objects-prefill-data/person';
@@ -9,6 +10,7 @@ export const standardObjectsPrefillData = async (
   workspaceDataSource: DataSource,
   schemaName: string,
   objectMetadata: ObjectMetadataEntity[],
+  isWorkflowEnabled: boolean,
 ) => {
   const objectMetadataMap = objectMetadata.reduce((acc, object) => {
     if (!object.standardId) {
@@ -34,6 +36,19 @@ export const standardObjectsPrefillData = async (
   workspaceDataSource.transaction(async (entityManager: EntityManager) => {
     await companyPrefillData(entityManager, schemaName);
     await personPrefillData(entityManager, schemaName);
-    await viewPrefillData(entityManager, schemaName, objectMetadataMap);
+    const viewDefinitionsWithId = await viewPrefillData(
+      entityManager,
+      schemaName,
+      objectMetadataMap,
+      isWorkflowEnabled,
+    );
+
+    await seedWorkspaceFavorites(
+      viewDefinitionsWithId
+        .filter((view) => view.key === 'INDEX')
+        .map((view) => view.id),
+      entityManager,
+      schemaName,
+    );
   });
 };

packages/twenty-server/src/engine/workspace-manager/standard-objects-prefill-data/view.ts

@@ -1,8 +1,6 @@
 import { EntityManager } from 'typeorm';
 import { v4 } from 'uuid';
 
-import { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/feature-flag-key.enum';
-import { FeatureFlagEntity } from 'src/engine/core-modules/feature-flag/feature-flag.entity';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
 import { companiesAllView } from 'src/engine/workspace-manager/standard-objects-prefill-data/views/companies-all.view';
 import { notesAllView } from 'src/engine/workspace-manager/standard-objects-prefill-data/views/notes-all.view';
@@ -17,13 +15,8 @@ export const viewPrefillData = async (
   entityManager: EntityManager,
   schemaName: string,
   objectMetadataMap: Record<string, ObjectMetadataEntity>,
-  featureFlags?: FeatureFlagEntity[],
+  isWorkflowEnabled: boolean,
 ) => {
-  const isWorkflowEnabled =
-    featureFlags?.find(
-      (featureFlag) => featureFlag.key === FeatureFlagKey.IsWorkflowEnabled,
-    )?.value ?? false;
-
   const viewDefinitions = [
     await companiesAllView(objectMetadataMap),
     await peopleAllView(objectMetadataMap),

packages/twenty-server/src/engine/workspace-manager/standard-objects-prefill-data/views/workflows-all.view.ts

@@ -9,7 +9,7 @@ export const workflowsAllView = async (
     name: 'All Workflows',
     objectMetadataId: objectMetadataMap[STANDARD_OBJECT_IDS.workflow].id,
     type: 'table',
-    key: null,
+    key: 'INDEX',
     position: 0,
     icon: 'IconSettingsAutomation',
     kanbanFieldMetadataId: '',

packages/twenty-server/src/engine/workspace-manager/workspace-manager.module.ts

@@ -1,5 +1,6 @@
 import { Module } from '@nestjs/common';
 
+import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-flag.module';
 import { DataSourceModule } from 'src/engine/metadata-modules/data-source/data-source.module';
 import { ObjectMetadataModule } from 'src/engine/metadata-modules/object-metadata/object-metadata.module';
 import { WorkspaceMigrationModule } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.module';
@@ -17,6 +18,7 @@ import { WorkspaceManagerService } from './workspace-manager.service';
     DataSourceModule,
     WorkspaceSyncMetadataModule,
     WorkspaceHealthModule,
+    FeatureFlagModule,
   ],
   exports: [WorkspaceManagerService],
   providers: [WorkspaceManagerService],

packages/twenty-server/src/engine/workspace-manager/workspace-manager.service.ts

@@ -1,5 +1,7 @@
 import { Injectable } from '@nestjs/common';
 
+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 { DataSourceEntity } from 'src/engine/metadata-modules/data-source/data-source.entity';
 import { DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
 import { ObjectMetadataService } from 'src/engine/metadata-modules/object-metadata/object-metadata.service';
@@ -17,6 +19,7 @@ export class WorkspaceManagerService {
     private readonly objectMetadataService: ObjectMetadataService,
     private readonly dataSourceService: DataSourceService,
     private readonly workspaceSyncMetadataService: WorkspaceSyncMetadataService,
+    private readonly featureFlagService: FeatureFlagService,
   ) {}
 
   /**
@@ -117,10 +120,16 @@ export class WorkspaceManagerService {
     const createdObjectMetadata =
       await this.objectMetadataService.findManyWithinWorkspace(workspaceId);
 
+    const isWorkflowEnabled = await this.featureFlagService.isFeatureEnabled(
+      FeatureFlagKey.IsWorkflowEnabled,
+      workspaceId,
+    );
+
     await standardObjectsPrefillData(
       workspaceDataSource,
       dataSourceMetadata.schema,
       createdObjectMetadata,
+      isWorkflowEnabled,
     );
   }
 
@@ -147,10 +156,16 @@ export class WorkspaceManagerService {
     const createdObjectMetadata =
       await this.objectMetadataService.findManyWithinWorkspace(workspaceId);
 
+    const isWorkflowEnabled = await this.featureFlagService.isFeatureEnabled(
+      FeatureFlagKey.IsWorkflowEnabled,
+      workspaceId,
+    );
+
     await demoObjectsPrefillData(
       workspaceDataSource,
       dataSourceMetadata.schema,
       createdObjectMetadata,
+      isWorkflowEnabled,
     );
   }