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/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 {}