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>
This commit is contained in:
Thomas Trompette
2024-09-18 18:26:55 +02:00
committed by GitHub
parent 759eb3070e
commit b1cb8998f8
12 changed files with 250 additions and 40 deletions

View File

@ -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.featureFlagService.isFeatureEnabled(
FeatureFlagKey.IsWorkspaceFavoriteEnabled,
objectMetadataInput.workspaceId,
);
if (isViewWorkspaceFavoriteEnabled) {
await this.createViewWorkspaceFavorite(
objectMetadataInput.workspaceId,
view[0].id,
);
}
await this.createViewWorkspaceFavorite(
objectMetadataInput.workspaceId,
view[0].id,
);
await this.workspaceMetadataVersionService.incrementMetadataVersion(
objectMetadataInput.workspaceId,

View File

@ -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);
},
);

View File

@ -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,
);
});
};

View File

@ -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),

View File

@ -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: '',

View File

@ -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],

View File

@ -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,
);
}