Add workspace favorites behind feature flag (#6904)

- make member nullable on favorites - add potential relation with view entity - add a new type of favorite list in front : workspace favorite - build a new component for retrieving workspace favorite to display + refacto the existing one Bonus: - removing activities seed since this is deprecated
2024-09-05 16:41:06 +02:00
parent bc8c961e30
commit 78d8df6a68
21 changed files with 339 additions and 160 deletions
--- a/packages/twenty-server/src/engine/core-modules/feature-flag/enums/feature-flag-key.enum.ts
+++ b/packages/twenty-server/src/engine/core-modules/feature-flag/enums/feature-flag-key.enum.ts
@ -9,4 +9,5 @@ export enum FeatureFlagKey {
  IsWorkflowEnabled = 'IS_WORKFLOW_ENABLED',
  IsMessageThreadSubscriberEnabled = 'IS_MESSAGE_THREAD_SUBSCRIBER_ENABLED',
  IsQueryRunnerTwentyORMEnabled = 'IS_QUERY_RUNNER_TWENTY_ORM_ENABLED',
+  IsWorkspaceFavoriteEnabled = 'IS_WORKSPACE_FAVORITE_ENABLED',
 }
--- a/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.service.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.service.ts
@ -10,6 +10,8 @@ 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 {
  FieldMetadataEntity,
@ -40,6 +42,7 @@ import {
  WorkspaceMigrationTableActionType,
 } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.entity';
 import { WorkspaceMigrationService } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.service';
+import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
 import { computeObjectTargetTable } from 'src/engine/utils/compute-object-target-table.util';
 import { computeTableName } from 'src/engine/utils/compute-table-name.util';
 import { WorkspaceMigrationRunnerService } from 'src/engine/workspace-manager/workspace-migration-runner/workspace-migration-runner.service';
@ -57,6 +60,7 @@ import {
  createForeignKeyDeterministicUuid,
  createRelationDeterministicUuid,
 } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/create-deterministic-uuid.util';
+import { FavoriteWorkspaceEntity } from 'src/modules/favorite/standard-objects/favorite.workspace-entity';

 import { ObjectMetadataEntity } from './object-metadata.entity';

@ -81,6 +85,8 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
    private readonly workspaceMigrationService: WorkspaceMigrationService,
    private readonly workspaceMigrationRunnerService: WorkspaceMigrationRunnerService,
    private readonly workspaceMetadataVersionService: WorkspaceMetadataVersionService,
+    private readonly twentyORMGlobalManager: TwentyORMGlobalManager,
+    private readonly featureFlagService: FeatureFlagService,
  ) {
    super(objectMetadataRepository);
  }
@ -369,6 +375,19 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
      );
    });

+    const isViewWorkspaceFavoriteEnabled =
+      await this.featureFlagService.isFeatureEnabled(
+        FeatureFlagKey.IsWorkspaceFavoriteEnabled,
+        objectMetadataInput.workspaceId,
+      );
+
+    if (isViewWorkspaceFavoriteEnabled) {
+      await this.createViewWorkspaceFavorite(
+        objectMetadataInput.workspaceId,
+        view[0].id,
+      );
+    }
+
    await this.workspaceMetadataVersionService.incrementMetadataVersion(
      objectMetadataInput.workspaceId,
    );
@ -1260,4 +1279,24 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
      );
    }
  }
+
+  private async createViewWorkspaceFavorite(
+    workspaceId: string,
+    viewId: string,
+  ) {
+    const favoriteRepository =
+      await this.twentyORMGlobalManager.getRepositoryForWorkspace<FavoriteWorkspaceEntity>(
+        workspaceId,
+        'favorite',
+      );
+
+    const favoriteCount = await favoriteRepository.count();
+
+    return favoriteRepository.insert(
+      favoriteRepository.create({
+        viewId,
+        position: favoriteCount,
+      }),
+    );
+  }
 }
--- a/packages/twenty-server/src/engine/workspace-manager/standard-objects-prefill-data/view.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/standard-objects-prefill-data/view.ts
@ -4,7 +4,6 @@ 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 { activitiesAllView } from 'src/engine/workspace-manager/standard-objects-prefill-data/views/activities-all.view';
 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';
 import { opportunitiesAllView } from 'src/engine/workspace-manager/standard-objects-prefill-data/views/opportunities-all.view';
@ -30,7 +29,6 @@ export const viewPrefillData = async (
    await peopleAllView(objectMetadataMap),
    await opportunitiesAllView(objectMetadataMap),
    await opportunitiesByStageView(objectMetadataMap),
-    await activitiesAllView(objectMetadataMap),
    await notesAllView(objectMetadataMap),
    await tasksAllView(objectMetadataMap),
    await tasksByStatusView(objectMetadataMap),
@ -128,4 +126,6 @@ export const viewPrefillData = async (
        .execute();
    }
  }
+
+  return viewDefinitionsWithId;
 };
--- a/packages/twenty-server/src/engine/workspace-manager/standard-objects-prefill-data/views/activities-all.view.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/standard-objects-prefill-data/views/activities-all.view.ts
@ -1,71 +0,0 @@
-import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
-import {
-  ACTIVITY_STANDARD_FIELD_IDS,
-  BASE_OBJECT_STANDARD_FIELD_IDS,
-} from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
-import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
-
-export const activitiesAllView = async (
-  objectMetadataMap: Record<string, ObjectMetadataEntity>,
-) => {
-  return {
-    name: 'All',
-    objectMetadataId: objectMetadataMap[STANDARD_OBJECT_IDS.activity].id,
-    type: 'table',
-    key: 'INDEX',
-    position: 1,
-    icon: 'IconList',
-    kanbanFieldMetadataId: '',
-    filters: [],
-    fields: [
-      {
-        fieldMetadataId:
-          objectMetadataMap[STANDARD_OBJECT_IDS.activity].fields[
-            ACTIVITY_STANDARD_FIELD_IDS.title
-          ],
-        position: 0,
-        isVisible: true,
-        size: 210,
-      },
-      {
-        fieldMetadataId:
-          objectMetadataMap[STANDARD_OBJECT_IDS.activity].fields[
-            ACTIVITY_STANDARD_FIELD_IDS.type
-          ],
-        position: 0,
-        isVisible: true,
-        size: 150,
-      },
-      {
-        fieldMetadataId:
-          objectMetadataMap[STANDARD_OBJECT_IDS.activity].fields[
-            ACTIVITY_STANDARD_FIELD_IDS.body
-          ],
-        position: 0,
-        isVisible: true,
-        size: 150,
-      },
-      {
-        fieldMetadataId:
-          objectMetadataMap[STANDARD_OBJECT_IDS.activity].fields[
-            BASE_OBJECT_STANDARD_FIELD_IDS.createdAt
-          ],
-        position: 0,
-        isVisible: true,
-        size: 150,
-      },
-      /*
-      TODO: Add later, since we don't have real-time it probably doesn't work well?
-      {
-        fieldMetadataId:
-          objectMetadataMap[STANDARD_OBJECT_IDS.activity].fields[
-            BASE_OBJECT_STANDARD_FIELD_IDS.updatedAt
-          ],
-        position: 0,
-        isVisible: true,
-        size: 210,
-      },
-      */
-    ],
-  };
-};
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids.ts
@ -203,6 +203,7 @@ export const FAVORITE_STANDARD_FIELD_IDS = {
  workflow: '20202020-b11b-4dc8-999a-6bd0a947b463',
  task: '20202020-1b1b-4b3b-8b1b-7f8d6a1d7d5c',
  note: '20202020-1f25-43fe-8b00-af212fdde824',
+  view: '20202020-5a93-4fa9-acce-e73481a0bbdf',
  custom: '20202020-855a-4bc8-9861-79deef37011f',
 };

@ -380,6 +381,7 @@ export const VIEW_STANDARD_FIELD_IDS = {
  viewFields: '20202020-542b-4bdc-b177-b63175d48edf',
  viewFilters: '20202020-ff23-4154-b63c-21fb36cd0967',
  viewSorts: '20202020-891b-45c3-9fe1-80a75b4aa043',
+  favorites: '20202020-c818-4a86-8284-9ec0ef0a59a5',
 };

 export const WEBHOOK_STANDARD_FIELD_IDS = {