Migrate view filter group to v2 (#16876)

## Introduction
On the side hanlded PR with a // agents on another repo
Made several iterations to fix behavior and direction
Find below auto-generated PR description

closes https://github.com/twentyhq/core-team-issues/issues/2037

Created generic tooling for entity circular dep checking, will be useful
for permissions validation too @Weiko


## Migrate `viewFilterGroup` entity to v2 flat architecture

### Summary
Migrates the `viewFilterGroup` entity from v1 to the v2 flat entity
architecture, following the established patterns for other v2 entities
like `viewFilter`, `view`, and `viewField`.

### Changes

**Types & Constants**
- Added `FlatViewFilterGroup` and `FlatViewFilterGroupMaps` types
- Added editable properties constant for `viewFilterGroup`
- Registered `viewFilterGroup` in `ALL_METADATA_NAME`,
`ALL_METADATA_RELATION_PROPERTIES`,
`ALL_METADATA_MANY_TO_ONE_RELATIONS`, and related constants

**Cache Service**
- Created `WorkspaceFlatViewFilterGroupMapCacheService` with proper
relation loading for `viewFilters` and `childViewFilterGroups`
- Updated `WorkspaceFlatViewMapCacheService` to load `viewFilterGroups`
relation

**Builder & Validator**
- Created `WorkspaceMigrationV2ViewFilterGroupActionsBuilderService`
- Created `FlatViewFilterGroupValidatorService` with creation, update,
and deletion validation
- Integrated validation into the orchestrator service (runs before
`viewFilter` validation)

**Action Handlers**
- Created create, update, and delete action handlers for
`viewFilterGroup`

**Service Migration**
- Rewrote `ViewFilterGroupService` to use v2 migration pattern with
`WorkspaceMigrationValidateBuildAndRunService`
- Created utility functions for transforming DTOs to flat entities

**Database Migration**
- Added migration to make `parentViewFilterGroupId` foreign key
deferrable (handles self-referential parent/child insertions)

**ViewFilter Integration**
- Added `viewFilterGroupId` validation in
`FlatViewFilterValidatorService`
- Updated `viewFilter` many-to-one relations to include
`viewFilterGroup`

**Tests**
- Added integration tests for successful creation, update, deletion, and
destruction
- Added failing test cases for non-existent entities and invalid
references
- Added failing test for `viewFilter` creation with non-existent
`viewFilterGroupId`

### Breaking Changes
None - existing API contracts are preserved.
This commit is contained in:
Paul Rastoin
2026-01-02 14:16:01 +01:00
committed by GitHub
parent 0adbe439d5
commit 98a9ae2a0e
106 changed files with 4648 additions and 439 deletions
@@ -14,6 +14,7 @@ import { FLAT_ROLE_EDITABLE_PROPERTIES } from 'src/engine/metadata-modules/flat-
import { FLAT_ROW_LEVEL_PERMISSION_PREDICATE_GROUP_EDITABLE_PROPERTIES } from 'src/engine/metadata-modules/flat-row-level-permission-predicate-group/constants/flat-row-level-permission-predicate-group-editable-properties.constant';
import { FLAT_ROW_LEVEL_PERMISSION_PREDICATE_EDITABLE_PROPERTIES } from 'src/engine/metadata-modules/flat-row-level-permission-predicate/constants/flat-row-level-permission-predicate-editable-properties.constant';
import { FLAT_VIEW_FIELD_EDITABLE_PROPERTIES } from 'src/engine/metadata-modules/flat-view-field/constants/flat-view-field-editable-properties.constant';
import { FLAT_VIEW_FILTER_GROUP_EDITABLE_PROPERTIES } from 'src/engine/metadata-modules/flat-view-filter-group/constants/flat-view-filter-group-editable-properties.constant';
import { FLAT_VIEW_FILTER_EDITABLE_PROPERTIES } from 'src/engine/metadata-modules/flat-view-filter/constants/flat-view-filter-editable-properties.constant';
import { FLAT_VIEW_GROUP_EDITABLE_PROPERTIES } from 'src/engine/metadata-modules/flat-view-group/constants/flat-view-group-editable-properties.constant';
import { FLAT_VIEW_EDITABLE_PROPERTIES } from 'src/engine/metadata-modules/flat-view/constants/flat-view-editable-properties.constant';
@@ -148,6 +149,14 @@ export const ALL_FLAT_ENTITY_PROPERTIES_TO_COMPARE_AND_STRINGIFY = {
],
propertiesToStringify: [],
},
viewFilterGroup: {
propertiesToCompare: [
'viewId',
'deletedAt',
...FLAT_VIEW_FILTER_GROUP_EDITABLE_PROPERTIES,
],
propertiesToStringify: [],
},
} as const satisfies {
[P in AllMetadataName]: OneFlatEntityConfiguration<P>;
};
@@ -100,6 +100,10 @@ export const ALL_METADATA_RELATED_METADATA_BY_FOREIGN_KEY = {
metadataName: 'fieldMetadata',
flatEntityForeignKeyAggregator: 'viewFilterIds',
},
viewFilterGroupId: {
metadataName: 'viewFilterGroup',
flatEntityForeignKeyAggregator: 'viewFilterIds',
},
},
role: {},
roleTarget: {
@@ -124,4 +128,14 @@ export const ALL_METADATA_RELATED_METADATA_BY_FOREIGN_KEY = {
},
rowLevelPermissionPredicate: {},
rowLevelPermissionPredicateGroup: {},
viewFilterGroup: {
viewId: {
metadataName: 'view',
flatEntityForeignKeyAggregator: 'viewFilterGroupIds',
},
parentViewFilterGroupId: {
metadataName: 'viewFilterGroup',
flatEntityForeignKeyAggregator: 'childViewFilterGroupIds',
},
},
} as const satisfies MetadataNameAndRelations;
@@ -143,6 +143,14 @@ export const ALL_METADATA_RELATION_PROPERTIES = {
rowLevelPermissionPredicates: true,
application: true,
},
viewFilterGroup: {
view: true,
viewFilters: true,
parentViewFilterGroup: true,
childViewFilterGroups: true,
workspace: true,
application: true,
},
} as const satisfies {
[TName in AllMetadataName]: {
[P in ExtractEntityRelatedEntityProperties<MetadataEntity<TName>>]: true;
@@ -44,11 +44,16 @@ export const ALL_METADATA_REQUIRED_METADATA_FOR_VALIDATION = {
viewFilter: {
view: true,
fieldMetadata: true,
viewFilterGroup: true,
},
viewGroup: {
fieldMetadata: true,
view: true,
},
viewFilterGroup: {
view: true,
viewFilterGroup: true,
},
role: {},
roleTarget: {
role: true,
@@ -12,6 +12,7 @@ import { WorkspaceFlatPageLayoutMapCacheService } from 'src/engine/metadata-modu
import { WorkspaceFlatRowLevelPermissionPredicateGroupMapCacheService } from 'src/engine/metadata-modules/flat-row-level-permission-predicate/services/workspace-flat-row-level-permission-predicate-group-map-cache.service';
import { WorkspaceFlatRowLevelPermissionPredicateMapCacheService } from 'src/engine/metadata-modules/flat-row-level-permission-predicate/services/workspace-flat-row-level-permission-predicate-map-cache.service';
import { WorkspaceFlatViewFieldMapCacheService } from 'src/engine/metadata-modules/flat-view-field/services/workspace-flat-view-field-map-cache.service';
import { WorkspaceFlatViewFilterGroupMapCacheService } from 'src/engine/metadata-modules/flat-view-filter-group/services/workspace-flat-view-filter-group-map-cache.service';
import { WorkspaceFlatViewFilterMapCacheService } from 'src/engine/metadata-modules/flat-view-filter/services/workspace-flat-view-filter-map-cache.service';
import { WorkspaceFlatViewGroupMapCacheService } from 'src/engine/metadata-modules/flat-view-group/services/workspace-flat-view-group-map-cache.service';
import { WorkspaceFlatViewMapCacheService } from 'src/engine/metadata-modules/flat-view/services/workspace-flat-view-map-cache.service';
@@ -24,6 +25,7 @@ import { PageLayoutEntity } from 'src/engine/metadata-modules/page-layout/entiti
import { RowLevelPermissionPredicateGroupEntity } from 'src/engine/metadata-modules/row-level-permission-predicate/entities/row-level-permission-predicate-group.entity';
import { RowLevelPermissionPredicateEntity } from 'src/engine/metadata-modules/row-level-permission-predicate/entities/row-level-permission-predicate.entity';
import { ViewFieldEntity } from 'src/engine/metadata-modules/view-field/entities/view-field.entity';
import { ViewFilterGroupEntity } from 'src/engine/metadata-modules/view-filter-group/entities/view-filter-group.entity';
import { ViewFilterEntity } from 'src/engine/metadata-modules/view-filter/entities/view-filter.entity';
import { ViewGroupEntity } from 'src/engine/metadata-modules/view-group/entities/view-group.entity';
import { ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entity';
@@ -36,6 +38,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
ViewEntity,
ViewFieldEntity,
ViewFilterEntity,
ViewFilterGroupEntity,
ViewGroupEntity,
IndexMetadataEntity,
IndexFieldMetadataEntity,
@@ -54,6 +57,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
WorkspaceFlatViewMapCacheService,
WorkspaceFlatViewFieldMapCacheService,
WorkspaceFlatViewFilterMapCacheService,
WorkspaceFlatViewFilterGroupMapCacheService,
WorkspaceFlatIndexMapCacheService,
WorkspaceFlatFieldMetadataMapCacheService,
WorkspaceFlatViewGroupMapCacheService,
@@ -69,6 +73,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
WorkspaceFlatViewMapCacheService,
WorkspaceFlatViewFieldMapCacheService,
WorkspaceFlatViewFilterMapCacheService,
WorkspaceFlatViewFilterGroupMapCacheService,
WorkspaceFlatIndexMapCacheService,
WorkspaceFlatFieldMetadataMapCacheService,
WorkspaceFlatViewGroupMapCacheService,
@@ -14,6 +14,7 @@ import { type FlatPageLayout } from 'src/engine/metadata-modules/flat-page-layou
import { type FlatRoleTarget } from 'src/engine/metadata-modules/flat-role-target/types/flat-role-target.type';
import { type FlatRole } from 'src/engine/metadata-modules/flat-role/types/flat-role.type';
import { type FlatViewField } from 'src/engine/metadata-modules/flat-view-field/types/flat-view-field.type';
import { type FlatViewFilterGroup } from 'src/engine/metadata-modules/flat-view-filter-group/types/flat-view-filter-group.type';
import { type FlatViewFilter } from 'src/engine/metadata-modules/flat-view-filter/types/flat-view-filter.type';
import { type FlatViewGroup } from 'src/engine/metadata-modules/flat-view-group/types/flat-view-group.type';
import { type FlatView } from 'src/engine/metadata-modules/flat-view/types/flat-view.type';
@@ -33,6 +34,7 @@ import { type FlatRowLevelPermissionPredicate } from 'src/engine/metadata-module
import { type ServerlessFunctionEntity } from 'src/engine/metadata-modules/serverless-function/serverless-function.entity';
import { type FlatServerlessFunction } from 'src/engine/metadata-modules/serverless-function/types/flat-serverless-function.type';
import { type ViewFieldEntity } from 'src/engine/metadata-modules/view-field/entities/view-field.entity';
import { type ViewFilterGroupEntity } from 'src/engine/metadata-modules/view-filter-group/entities/view-filter-group.entity';
import { type ViewFilterEntity } from 'src/engine/metadata-modules/view-filter/entities/view-filter.entity';
import { type ViewGroupEntity } from 'src/engine/metadata-modules/view-group/entities/view-group.entity';
import { type ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entity';
@@ -116,6 +118,11 @@ import {
type DeleteViewFieldAction,
type UpdateViewFieldAction,
} from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-builder-v2/builders/view-field/types/workspace-migration-view-field-action-v2.type';
import {
type CreateViewFilterGroupAction,
type DeleteViewFilterGroupAction,
type UpdateViewFilterGroupAction,
} from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-builder-v2/builders/view-filter-group/types/workspace-migration-view-filter-group-action-v2.type';
import {
type CreateViewFilterAction,
type DeleteViewFilterAction,
@@ -198,6 +205,15 @@ export type AllFlatEntityTypesByMetadataName = {
flatEntity: FlatRowLevelPermissionPredicateGroup;
entity: RowLevelPermissionPredicateGroupEntity;
};
viewFilterGroup: {
actions: {
created: CreateViewFilterGroupAction;
updated: UpdateViewFilterGroupAction;
deleted: DeleteViewFilterGroupAction;
};
flatEntity: FlatViewFilterGroup;
entity: ViewFilterGroupEntity;
};
index: {
actions: {
created: CreateIndexAction;
@@ -0,0 +1,7 @@
import { type FlatViewFilterGroup } from 'src/engine/metadata-modules/flat-view-filter-group/types/flat-view-filter-group.type';
export const FLAT_VIEW_FILTER_GROUP_EDITABLE_PROPERTIES = [
'parentViewFilterGroupId',
'logicalOperator',
'positionInViewFilterGroup',
] as const satisfies (keyof FlatViewFilterGroup)[];
@@ -0,0 +1,75 @@
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { type Repository } from 'typeorm';
import { WorkspaceCacheProvider } from 'src/engine/workspace-cache/interfaces/workspace-cache-provider.service';
import { createEmptyFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/constant/create-empty-flat-entity-maps.constant';
import { type FlatViewFilterGroupMaps } from 'src/engine/metadata-modules/flat-view-filter-group/types/flat-view-filter-group-maps.type';
import { fromViewFilterGroupEntityToFlatViewFilterGroup } from 'src/engine/metadata-modules/flat-view-filter-group/utils/from-view-filter-group-entity-to-flat-view-filter-group.util';
import { ViewFilterGroupEntity } from 'src/engine/metadata-modules/view-filter-group/entities/view-filter-group.entity';
import { ViewFilterEntity } from 'src/engine/metadata-modules/view-filter/entities/view-filter.entity';
import { WorkspaceCache } from 'src/engine/workspace-cache/decorators/workspace-cache.decorator';
import { regroupEntitiesByRelatedEntityId } from 'src/engine/workspace-cache/utils/regroup-entities-by-related-entity-id';
import { addFlatEntityToFlatEntityMapsThroughMutationOrThrow } from 'src/engine/workspace-manager/workspace-migration-v2/utils/add-flat-entity-to-flat-entity-maps-through-mutation-or-throw.util';
@Injectable()
@WorkspaceCache('flatViewFilterGroupMaps')
export class WorkspaceFlatViewFilterGroupMapCacheService extends WorkspaceCacheProvider<FlatViewFilterGroupMaps> {
constructor(
@InjectRepository(ViewFilterGroupEntity)
private readonly viewFilterGroupRepository: Repository<ViewFilterGroupEntity>,
@InjectRepository(ViewFilterEntity)
private readonly viewFilterRepository: Repository<ViewFilterEntity>,
) {
super();
}
async computeForCache(workspaceId: string): Promise<FlatViewFilterGroupMaps> {
const [viewFilterGroups, viewFilters] = await Promise.all([
this.viewFilterGroupRepository.find({
where: { workspaceId },
withDeleted: true,
}),
this.viewFilterRepository.find({
where: { workspaceId },
select: ['id', 'viewFilterGroupId'],
withDeleted: true,
}),
]);
const [viewFiltersByViewFilterGroupId, childViewFilterGroupsByParentId] = (
[
{
entities: viewFilters,
foreignKey: 'viewFilterGroupId',
},
{
entities: viewFilterGroups,
foreignKey: 'parentViewFilterGroupId',
},
] as const
).map(regroupEntitiesByRelatedEntityId);
const flatViewFilterGroupMaps = createEmptyFlatEntityMaps();
for (const viewFilterGroupEntity of viewFilterGroups) {
const flatViewFilterGroup =
fromViewFilterGroupEntityToFlatViewFilterGroup({
...viewFilterGroupEntity,
viewFilters:
viewFiltersByViewFilterGroupId.get(viewFilterGroupEntity.id) || [],
childViewFilterGroups:
childViewFilterGroupsByParentId.get(viewFilterGroupEntity.id) || [],
} as ViewFilterGroupEntity);
addFlatEntityToFlatEntityMapsThroughMutationOrThrow({
flatEntity: flatViewFilterGroup,
flatEntityMapsToMutate: flatViewFilterGroupMaps,
});
}
return flatViewFilterGroupMaps;
}
}
@@ -0,0 +1,4 @@
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { type FlatViewFilterGroup } from 'src/engine/metadata-modules/flat-view-filter-group/types/flat-view-filter-group.type';
export type FlatViewFilterGroupMaps = FlatEntityMaps<FlatViewFilterGroup>;
@@ -0,0 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type ViewFilterGroupEntity } from 'src/engine/metadata-modules/view-filter-group/entities/view-filter-group.entity';
export type FlatViewFilterGroup = FlatEntityFrom<ViewFilterGroupEntity>;
@@ -0,0 +1,45 @@
import { trimAndRemoveDuplicatedWhitespacesFromObjectStringProperties } from 'twenty-shared/utils';
import { v4 } from 'uuid';
import { type FlatViewFilterGroup } from 'src/engine/metadata-modules/flat-view-filter-group/types/flat-view-filter-group.type';
import { type CreateViewFilterGroupInput } from 'src/engine/metadata-modules/view-filter-group/dtos/inputs/create-view-filter-group.input';
import { ViewFilterGroupLogicalOperator } from 'src/engine/metadata-modules/view-filter-group/enums/view-filter-group-logical-operator';
export const fromCreateViewFilterGroupInputToFlatViewFilterGroupToCreate = ({
createViewFilterGroupInput: rawCreateViewFilterGroupInput,
workspaceId,
workspaceCustomApplicationId,
}: {
createViewFilterGroupInput: CreateViewFilterGroupInput;
workspaceId: string;
workspaceCustomApplicationId: string;
}): FlatViewFilterGroup => {
const { viewId, ...createViewFilterGroupInput } =
trimAndRemoveDuplicatedWhitespacesFromObjectStringProperties(
rawCreateViewFilterGroupInput,
['id', 'viewId', 'parentViewFilterGroupId'],
);
const createdAt = new Date().toISOString();
const viewFilterGroupId = createViewFilterGroupInput.id ?? v4();
return {
id: viewFilterGroupId,
viewId,
workspaceId,
createdAt,
updatedAt: createdAt,
deletedAt: null,
universalIdentifier: viewFilterGroupId,
logicalOperator:
createViewFilterGroupInput.logicalOperator ??
ViewFilterGroupLogicalOperator.AND,
parentViewFilterGroupId:
createViewFilterGroupInput.parentViewFilterGroupId ?? null,
positionInViewFilterGroup:
createViewFilterGroupInput.positionInViewFilterGroup ?? null,
applicationId: workspaceCustomApplicationId,
viewFilterIds: [],
childViewFilterGroupIds: [],
};
};
@@ -0,0 +1,40 @@
import {
extractAndSanitizeObjectStringFields,
isDefined,
} from 'twenty-shared/utils';
import { type FlatViewFilterGroupMaps } from 'src/engine/metadata-modules/flat-view-filter-group/types/flat-view-filter-group-maps.type';
import { type FlatViewFilterGroup } from 'src/engine/metadata-modules/flat-view-filter-group/types/flat-view-filter-group.type';
import { type DeleteViewFilterGroupInput } from 'src/engine/metadata-modules/view-filter-group/dtos/inputs/delete-view-filter-group.input';
import {
ViewFilterGroupException,
ViewFilterGroupExceptionCode,
} from 'src/engine/metadata-modules/view-filter-group/exceptions/view-filter-group.exception';
export const fromDeleteViewFilterGroupInputToFlatViewFilterGroupOrThrow = ({
deleteViewFilterGroupInput: rawDeleteViewFilterGroupInput,
flatViewFilterGroupMaps,
}: {
deleteViewFilterGroupInput: DeleteViewFilterGroupInput;
flatViewFilterGroupMaps: FlatViewFilterGroupMaps;
}): FlatViewFilterGroup => {
const { id: viewFilterGroupId } = extractAndSanitizeObjectStringFields(
rawDeleteViewFilterGroupInput,
['id'],
);
const existingFlatViewFilterGroupToDelete =
flatViewFilterGroupMaps.byId[viewFilterGroupId];
if (!isDefined(existingFlatViewFilterGroupToDelete)) {
throw new ViewFilterGroupException(
'View filter group not found',
ViewFilterGroupExceptionCode.VIEW_FILTER_GROUP_NOT_FOUND,
);
}
return {
...existingFlatViewFilterGroupToDelete,
deletedAt: new Date().toISOString(),
};
};
@@ -0,0 +1,37 @@
import {
extractAndSanitizeObjectStringFields,
isDefined,
} from 'twenty-shared/utils';
import { type FlatViewFilterGroupMaps } from 'src/engine/metadata-modules/flat-view-filter-group/types/flat-view-filter-group-maps.type';
import { type FlatViewFilterGroup } from 'src/engine/metadata-modules/flat-view-filter-group/types/flat-view-filter-group.type';
import { type DestroyViewFilterGroupInput } from 'src/engine/metadata-modules/view-filter-group/dtos/inputs/destroy-view-filter-group.input';
import {
ViewFilterGroupException,
ViewFilterGroupExceptionCode,
} from 'src/engine/metadata-modules/view-filter-group/exceptions/view-filter-group.exception';
export const fromDestroyViewFilterGroupInputToFlatViewFilterGroupOrThrow = ({
destroyViewFilterGroupInput,
flatViewFilterGroupMaps,
}: {
destroyViewFilterGroupInput: DestroyViewFilterGroupInput;
flatViewFilterGroupMaps: FlatViewFilterGroupMaps;
}): FlatViewFilterGroup => {
const { id: viewFilterGroupId } = extractAndSanitizeObjectStringFields(
destroyViewFilterGroupInput,
['id'],
);
const existingFlatViewFilterGroupToDestroy =
flatViewFilterGroupMaps.byId[viewFilterGroupId];
if (!isDefined(existingFlatViewFilterGroupToDestroy)) {
throw new ViewFilterGroupException(
'View filter group not found',
ViewFilterGroupExceptionCode.VIEW_FILTER_GROUP_NOT_FOUND,
);
}
return existingFlatViewFilterGroupToDestroy;
};
@@ -0,0 +1,51 @@
import {
extractAndSanitizeObjectStringFields,
isDefined,
trimAndRemoveDuplicatedWhitespacesFromObjectStringProperties,
} from 'twenty-shared/utils';
import { FLAT_VIEW_FILTER_GROUP_EDITABLE_PROPERTIES } from 'src/engine/metadata-modules/flat-view-filter-group/constants/flat-view-filter-group-editable-properties.constant';
import { type FlatViewFilterGroupMaps } from 'src/engine/metadata-modules/flat-view-filter-group/types/flat-view-filter-group-maps.type';
import { type FlatViewFilterGroup } from 'src/engine/metadata-modules/flat-view-filter-group/types/flat-view-filter-group.type';
import { type UpdateViewFilterGroupInput } from 'src/engine/metadata-modules/view-filter-group/dtos/inputs/update-view-filter-group.input';
import {
ViewFilterGroupException,
ViewFilterGroupExceptionCode,
} from 'src/engine/metadata-modules/view-filter-group/exceptions/view-filter-group.exception';
import { mergeUpdateInExistingRecord } from 'src/utils/merge-update-in-existing-record.util';
export const fromUpdateViewFilterGroupInputToFlatViewFilterGroupToUpdateOrThrow =
({
updateViewFilterGroupInput: rawUpdateViewFilterGroupInput,
flatViewFilterGroupMaps,
}: {
updateViewFilterGroupInput: UpdateViewFilterGroupInput & { id: string };
flatViewFilterGroupMaps: FlatViewFilterGroupMaps;
}): FlatViewFilterGroup => {
const { id: viewFilterGroupToUpdateId } =
trimAndRemoveDuplicatedWhitespacesFromObjectStringProperties(
rawUpdateViewFilterGroupInput,
['id'],
);
const existingFlatViewFilterGroupToUpdate =
flatViewFilterGroupMaps.byId[viewFilterGroupToUpdateId];
if (!isDefined(existingFlatViewFilterGroupToUpdate)) {
throw new ViewFilterGroupException(
'View filter group not found',
ViewFilterGroupExceptionCode.VIEW_FILTER_GROUP_NOT_FOUND,
);
}
const updatedEditableFieldProperties = extractAndSanitizeObjectStringFields(
rawUpdateViewFilterGroupInput,
FLAT_VIEW_FILTER_GROUP_EDITABLE_PROPERTIES,
);
return mergeUpdateInExistingRecord({
existing: existingFlatViewFilterGroupToUpdate,
properties: FLAT_VIEW_FILTER_GROUP_EDITABLE_PROPERTIES,
update: updatedEditableFieldProperties,
});
};
@@ -0,0 +1,33 @@
import { removePropertiesFromRecord } from 'twenty-shared/utils';
import { ALL_METADATA_RELATION_PROPERTIES } from 'src/engine/metadata-modules/flat-entity/constant/all-metadata-relations-properties.constant';
import { type FlatViewFilterGroup } from 'src/engine/metadata-modules/flat-view-filter-group/types/flat-view-filter-group.type';
import { type ViewFilterGroupEntity } from 'src/engine/metadata-modules/view-filter-group/entities/view-filter-group.entity';
export const fromViewFilterGroupEntityToFlatViewFilterGroup = (
viewFilterGroupEntity: ViewFilterGroupEntity,
): FlatViewFilterGroup => {
const viewFilterGroupEntityWithoutRelations = removePropertiesFromRecord(
viewFilterGroupEntity,
Object.keys(
ALL_METADATA_RELATION_PROPERTIES.viewFilterGroup,
) as (keyof typeof ALL_METADATA_RELATION_PROPERTIES.viewFilterGroup)[],
);
return {
...viewFilterGroupEntityWithoutRelations,
createdAt: viewFilterGroupEntity.createdAt.toISOString(),
updatedAt: viewFilterGroupEntity.updatedAt.toISOString(),
deletedAt: viewFilterGroupEntity.deletedAt?.toISOString() ?? null,
universalIdentifier:
viewFilterGroupEntityWithoutRelations.universalIdentifier ??
viewFilterGroupEntityWithoutRelations.id,
viewFilterIds:
viewFilterGroupEntity.viewFilters?.map((viewFilter) => viewFilter.id) ??
[],
childViewFilterGroupIds:
viewFilterGroupEntity.childViewFilterGroups?.map(
(childGroup) => childGroup.id,
) ?? [],
};
};
@@ -1,7 +1,4 @@
import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity.type';
import { type ViewFilterEntity } from 'src/engine/metadata-modules/view-filter/entities/view-filter.entity';
export type FlatViewFilter = FlatEntityFrom<
// TODO remove once viewFilterGroups have been migrated to v2
Omit<ViewFilterEntity, 'viewFilterGroup'>
>;
export type FlatViewFilter = FlatEntityFrom<ViewFilterEntity>;
@@ -3,6 +3,7 @@ import { TypeOrmModule } from '@nestjs/typeorm';
import { WorkspaceFlatViewMapCacheService } from 'src/engine/metadata-modules/flat-view/services/workspace-flat-view-map-cache.service';
import { ViewFieldEntity } from 'src/engine/metadata-modules/view-field/entities/view-field.entity';
import { ViewFilterGroupEntity } from 'src/engine/metadata-modules/view-filter-group/entities/view-filter-group.entity';
import { ViewFilterEntity } from 'src/engine/metadata-modules/view-filter/entities/view-filter.entity';
import { ViewGroupEntity } from 'src/engine/metadata-modules/view-group/entities/view-group.entity';
import { ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entity';
@@ -14,6 +15,7 @@ import { ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entit
ViewFieldEntity,
ViewFilterEntity,
ViewGroupEntity,
ViewFilterGroupEntity,
]),
],
providers: [WorkspaceFlatViewMapCacheService],
@@ -1,7 +1,7 @@
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { type Repository } from 'typeorm';
import { WorkspaceCacheProvider } from 'src/engine/workspace-cache/interfaces/workspace-cache-provider.service';
@@ -9,6 +9,7 @@ import { createEmptyFlatEntityMaps } from 'src/engine/metadata-modules/flat-enti
import { type FlatViewMaps } from 'src/engine/metadata-modules/flat-view/types/flat-view-maps.type';
import { fromViewEntityToFlatView } from 'src/engine/metadata-modules/flat-view/utils/from-view-entity-to-flat-view.util';
import { ViewFieldEntity } from 'src/engine/metadata-modules/view-field/entities/view-field.entity';
import { ViewFilterGroupEntity } from 'src/engine/metadata-modules/view-filter-group/entities/view-filter-group.entity';
import { ViewFilterEntity } from 'src/engine/metadata-modules/view-filter/entities/view-filter.entity';
import { ViewGroupEntity } from 'src/engine/metadata-modules/view-group/entities/view-group.entity';
import { ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entity';
@@ -28,34 +29,47 @@ export class WorkspaceFlatViewMapCacheService extends WorkspaceCacheProvider<Fla
private readonly viewFilterRepository: Repository<ViewFilterEntity>,
@InjectRepository(ViewGroupEntity)
private readonly viewGroupRepository: Repository<ViewGroupEntity>,
@InjectRepository(ViewFilterGroupEntity)
private readonly viewFilterGroupRepository: Repository<ViewFilterGroupEntity>,
) {
super();
}
async computeForCache(workspaceId: string): Promise<FlatViewMaps> {
const [views, viewFields, viewFilters, viewGroups] = await Promise.all([
this.viewRepository.find({
where: { workspaceId },
withDeleted: true,
}),
this.viewFieldRepository.find({
where: { workspaceId },
select: ['id', 'viewId'],
withDeleted: true,
}),
this.viewFilterRepository.find({
where: { workspaceId },
select: ['id', 'viewId'],
withDeleted: true,
}),
this.viewGroupRepository.find({
where: { workspaceId },
select: ['id', 'viewId'],
withDeleted: true,
}),
]);
const [views, viewFields, viewFilters, viewGroups, viewFilterGroups] =
await Promise.all([
this.viewRepository.find({
where: { workspaceId },
withDeleted: true,
}),
this.viewFieldRepository.find({
where: { workspaceId },
select: ['id', 'viewId'],
withDeleted: true,
}),
this.viewFilterRepository.find({
where: { workspaceId },
select: ['id', 'viewId'],
withDeleted: true,
}),
this.viewGroupRepository.find({
where: { workspaceId },
select: ['id', 'viewId'],
withDeleted: true,
}),
this.viewFilterGroupRepository.find({
where: { workspaceId },
select: ['id', 'viewId'],
withDeleted: true,
}),
]);
const [viewFieldsByViewId, viewFiltersByViewId, viewGroupsByViewId] = (
const [
viewFieldsByViewId,
viewFiltersByViewId,
viewGroupsByViewId,
viewFilterGroupsByViewId,
] = (
[
{
entities: viewFields,
@@ -69,6 +83,10 @@ export class WorkspaceFlatViewMapCacheService extends WorkspaceCacheProvider<Fla
entities: viewGroups,
foreignKey: 'viewId',
},
{
entities: viewFilterGroups,
foreignKey: 'viewId',
},
] as const
).map(regroupEntitiesByRelatedEntityId);
@@ -80,6 +98,7 @@ export class WorkspaceFlatViewMapCacheService extends WorkspaceCacheProvider<Fla
viewFields: viewFieldsByViewId.get(viewEntity.id) || [],
viewFilters: viewFiltersByViewId.get(viewEntity.id) || [],
viewGroups: viewGroupsByViewId.get(viewEntity.id) || [],
viewFilterGroups: viewFilterGroupsByViewId.get(viewEntity.id) || [],
} as ViewEntity);
addFlatEntityToFlatEntityMapsThroughMutationOrThrow({
@@ -2,6 +2,6 @@ import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/typ
import { type ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entity';
export type FlatView = FlatEntityFrom<
// TODO remove once viewSorts and viewFilterGroups have been migrated to v2
Omit<ViewEntity, 'viewSorts' | 'viewFilterGroups'>
// TODO remove once viewSorts has been migrated to v2
Omit<ViewEntity, 'viewSorts'>
>;
@@ -68,6 +68,7 @@ export const fromCreateViewInputToFlatViewToCreate = ({
viewFieldIds: [],
viewFilterIds: [],
viewGroupIds: [],
viewFilterGroupIds: [],
applicationId: workspaceCustomApplicationId,
};
@@ -23,5 +23,9 @@ export const fromViewEntityToFlatView = (viewEntity: ViewEntity): FlatView => {
viewFieldIds: viewEntity.viewFields.map((viewField) => viewField.id),
viewFilterIds: viewEntity.viewFilters.map((viewFilter) => viewFilter.id),
viewGroupIds: viewEntity.viewGroups.map((viewGroup) => viewGroup.id),
viewFilterGroupIds:
viewEntity.viewFilterGroups?.map(
(viewFilterGroup) => viewFilterGroup.id,
) ?? [],
};
};
@@ -13,12 +13,12 @@ import {
import { isDefined } from 'twenty-shared/utils';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { type WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
import { CreateViewFilterGroupInput } from 'src/engine/metadata-modules/view-filter-group/dtos/inputs/create-view-filter-group.input';
import { UpdateViewFilterGroupInput } from 'src/engine/metadata-modules/view-filter-group/dtos/inputs/update-view-filter-group.input';
import { type CreateViewFilterGroupInput } from 'src/engine/metadata-modules/view-filter-group/dtos/inputs/create-view-filter-group.input';
import { type UpdateViewFilterGroupInput } from 'src/engine/metadata-modules/view-filter-group/dtos/inputs/update-view-filter-group.input';
import { type ViewFilterGroupDTO } from 'src/engine/metadata-modules/view-filter-group/dtos/view-filter-group.dto';
import {
generateViewFilterGroupExceptionMessage,
@@ -90,8 +90,8 @@ export class ViewFilterGroupController {
@Body() input: CreateViewFilterGroupInput,
@AuthWorkspace() workspace: WorkspaceEntity,
): Promise<ViewFilterGroupDTO> {
return this.viewFilterGroupService.create({
...input,
return this.viewFilterGroupService.createOne({
createViewFilterGroupInput: input,
workspaceId: workspace.id,
});
}
@@ -103,13 +103,11 @@ export class ViewFilterGroupController {
@Body() input: UpdateViewFilterGroupInput,
@AuthWorkspace() workspace: WorkspaceEntity,
): Promise<ViewFilterGroupDTO> {
const updatedViewFilterGroup = await this.viewFilterGroupService.update(
return this.viewFilterGroupService.updateOne({
id,
workspace.id,
input,
);
return updatedViewFilterGroup;
updateViewFilterGroupInput: input,
workspaceId: workspace.id,
});
}
@Delete(':id')
@@ -118,10 +116,10 @@ export class ViewFilterGroupController {
@Param('id') id: string,
@AuthWorkspace() workspace: WorkspaceEntity,
): Promise<{ success: boolean }> {
const deletedViewFilterGroup = await this.viewFilterGroupService.delete(
id,
workspace.id,
);
const deletedViewFilterGroup = await this.viewFilterGroupService.deleteOne({
deleteViewFilterGroupInput: { id },
workspaceId: workspace.id,
});
return { success: isDefined(deletedViewFilterGroup) };
}
@@ -13,7 +13,7 @@ export class CreateViewFilterGroupInput {
@Field(() => ViewFilterGroupLogicalOperator, {
nullable: true,
defaultValue: ViewFilterGroupLogicalOperator.NOT,
defaultValue: ViewFilterGroupLogicalOperator.AND,
})
logicalOperator?: ViewFilterGroupLogicalOperator;
@@ -0,0 +1,15 @@
import { InputType } from '@nestjs/graphql';
import { IDField } from '@ptc-org/nestjs-query-graphql';
import { IsUUID } from 'class-validator';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
@InputType()
export class DeleteViewFilterGroupInput {
@IDField(() => UUIDScalarType, {
description: 'The id of the view filter group to delete.',
})
@IsUUID()
id: string;
}
@@ -0,0 +1,15 @@
import { InputType } from '@nestjs/graphql';
import { IDField } from '@ptc-org/nestjs-query-graphql';
import { IsUUID } from 'class-validator';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
@InputType()
export class DestroyViewFilterGroupInput {
@IDField(() => UUIDScalarType, {
description: 'The id of the view filter group to destroy.',
})
@IsUUID()
id: string;
}
@@ -21,6 +21,8 @@ export enum ViewFilterGroupExceptionCode {
VIEW_FILTER_GROUP_NOT_FOUND = 'VIEW_FILTER_GROUP_NOT_FOUND',
INVALID_VIEW_FILTER_GROUP_DATA = 'INVALID_VIEW_FILTER_GROUP_DATA',
VIEW_NOT_FOUND = 'VIEW_NOT_FOUND',
CIRCULAR_DEPENDENCY = 'CIRCULAR_DEPENDENCY',
MAX_DEPTH_EXCEEDED = 'MAX_DEPTH_EXCEEDED',
}
export enum ViewFilterGroupExceptionMessageKey {
@@ -3,7 +3,7 @@ import { Args, Mutation, Query, Resolver } from '@nestjs/graphql';
import { isDefined } from 'twenty-shared/utils';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { type WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
@@ -54,8 +54,8 @@ export class ViewFilterGroupResolver {
@Args('input') input: CreateViewFilterGroupInput,
@AuthWorkspace() workspace: WorkspaceEntity,
): Promise<ViewFilterGroupDTO> {
return this.viewFilterGroupService.create({
...input,
return this.viewFilterGroupService.createOne({
createViewFilterGroupInput: input,
workspaceId: workspace.id,
});
}
@@ -67,7 +67,11 @@ export class ViewFilterGroupResolver {
@Args('input') input: UpdateViewFilterGroupInput,
@AuthWorkspace() workspace: WorkspaceEntity,
): Promise<ViewFilterGroupDTO> {
return this.viewFilterGroupService.update(id, workspace.id, input);
return this.viewFilterGroupService.updateOne({
id,
updateViewFilterGroupInput: input,
workspaceId: workspace.id,
});
}
@Mutation(() => Boolean)
@@ -76,10 +80,10 @@ export class ViewFilterGroupResolver {
@Args('id', { type: () => String }) id: string,
@AuthWorkspace() workspace: WorkspaceEntity,
): Promise<boolean> {
const deletedViewFilterGroup = await this.viewFilterGroupService.delete(
id,
workspace.id,
);
const deletedViewFilterGroup = await this.viewFilterGroupService.deleteOne({
deleteViewFilterGroupInput: { id },
workspaceId: workspace.id,
});
return isDefined(deletedViewFilterGroup);
}
@@ -90,6 +94,12 @@ export class ViewFilterGroupResolver {
@Args('id', { type: () => String }) id: string,
@AuthWorkspace() workspace: WorkspaceEntity,
): Promise<boolean> {
return this.viewFilterGroupService.destroy(id, workspace.id);
const destroyedViewFilterGroup =
await this.viewFilterGroupService.destroyOne({
destroyViewFilterGroupInput: { id },
workspaceId: workspace.id,
});
return isDefined(destroyedViewFilterGroup);
}
}
@@ -3,17 +3,12 @@ import { getRepositoryToken } from '@nestjs/typeorm';
import { type Repository } from 'typeorm';
import { ApplicationService } from 'src/engine/core-modules/application/application.service';
import { WorkspaceManyOrAllFlatEntityMapsCacheService } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service';
import { ViewFilterGroupEntity } from 'src/engine/metadata-modules/view-filter-group/entities/view-filter-group.entity';
import { ViewFilterGroupLogicalOperator } from 'src/engine/metadata-modules/view-filter-group/enums/view-filter-group-logical-operator';
import {
ViewFilterGroupException,
ViewFilterGroupExceptionCode,
ViewFilterGroupExceptionMessageKey,
generateViewFilterGroupExceptionMessage,
generateViewFilterGroupUserFriendlyExceptionMessage,
} from 'src/engine/metadata-modules/view-filter-group/exceptions/view-filter-group.exception';
import { ViewFilterGroupService } from 'src/engine/metadata-modules/view-filter-group/services/view-filter-group.service';
import { WorkspaceCacheStorageService } from 'src/engine/workspace-cache-storage/workspace-cache-storage.service';
import { WorkspaceMigrationValidateBuildAndRunService } from 'src/engine/workspace-manager/workspace-migration-v2/services/workspace-migration-validate-build-and-run-service';
describe('ViewFilterGroupService', () => {
let viewFilterGroupService: ViewFilterGroupService;
@@ -46,9 +41,22 @@ describe('ViewFilterGroupService', () => {
},
},
{
provide: WorkspaceCacheStorageService,
provide: WorkspaceMigrationValidateBuildAndRunService,
useValue: {
flushGraphQLOperation: jest.fn(),
validateBuildAndRunWorkspaceMigration: jest.fn(),
},
},
{
provide: WorkspaceManyOrAllFlatEntityMapsCacheService,
useValue: {
getOrRecomputeManyOrAllFlatEntityMaps: jest.fn(),
invalidateFlatEntityMaps: jest.fn(),
},
},
{
provide: ApplicationService,
useValue: {
findWorkspaceTwentyStandardAndCustomApplicationOrThrow: jest.fn(),
},
},
],
@@ -169,202 +177,4 @@ describe('ViewFilterGroupService', () => {
expect(result).toBeNull();
});
});
describe('create', () => {
const validViewFilterGroupData = {
viewId: 'view-id',
workspaceId: 'workspace-id',
logicalOperator: ViewFilterGroupLogicalOperator.AND,
positionInViewFilterGroup: 0,
};
it('should create a view filter group successfully', async () => {
jest
.spyOn(viewFilterGroupRepository, 'create')
.mockReturnValue(mockViewFilterGroup);
jest
.spyOn(viewFilterGroupRepository, 'save')
.mockResolvedValue(mockViewFilterGroup);
const result = await viewFilterGroupService.create(
validViewFilterGroupData,
);
expect(viewFilterGroupRepository.create).toHaveBeenCalledWith(
validViewFilterGroupData,
);
expect(viewFilterGroupRepository.save).toHaveBeenCalledWith(
mockViewFilterGroup,
);
expect(result).toEqual(mockViewFilterGroup);
});
it('should throw exception when workspaceId is missing', async () => {
const invalidData = {
...validViewFilterGroupData,
workspaceId: undefined,
};
await expect(viewFilterGroupService.create(invalidData)).rejects.toThrow(
new ViewFilterGroupException(
generateViewFilterGroupExceptionMessage(
ViewFilterGroupExceptionMessageKey.WORKSPACE_ID_REQUIRED,
),
ViewFilterGroupExceptionCode.INVALID_VIEW_FILTER_GROUP_DATA,
{
userFriendlyMessage:
generateViewFilterGroupUserFriendlyExceptionMessage(
ViewFilterGroupExceptionMessageKey.WORKSPACE_ID_REQUIRED,
),
},
),
);
});
it('should throw exception when viewId is missing', async () => {
const invalidData = { ...validViewFilterGroupData, viewId: undefined };
await expect(viewFilterGroupService.create(invalidData)).rejects.toThrow(
new ViewFilterGroupException(
generateViewFilterGroupExceptionMessage(
ViewFilterGroupExceptionMessageKey.VIEW_ID_REQUIRED,
),
ViewFilterGroupExceptionCode.INVALID_VIEW_FILTER_GROUP_DATA,
{
userFriendlyMessage:
generateViewFilterGroupUserFriendlyExceptionMessage(
ViewFilterGroupExceptionMessageKey.VIEW_ID_REQUIRED,
),
},
),
);
});
});
describe('update', () => {
it('should update a view filter group successfully', async () => {
const id = 'view-filter-group-id';
const workspaceId = 'workspace-id';
const updateData = { logicalOperator: ViewFilterGroupLogicalOperator.OR };
const updatedViewFilterGroup = { ...mockViewFilterGroup, ...updateData };
jest
.spyOn(viewFilterGroupService, 'findById')
.mockResolvedValue(mockViewFilterGroup);
jest
.spyOn(viewFilterGroupRepository, 'save')
.mockResolvedValue(updatedViewFilterGroup);
const result = await viewFilterGroupService.update(
id,
workspaceId,
updateData,
);
expect(viewFilterGroupService.findById).toHaveBeenCalledWith(
id,
workspaceId,
);
expect(viewFilterGroupRepository.save).toHaveBeenCalledWith({
id,
...updateData,
});
expect(result).toEqual({
...mockViewFilterGroup,
...updatedViewFilterGroup,
});
});
it('should throw exception when view filter group is not found', async () => {
const id = 'non-existent-id';
const workspaceId = 'workspace-id';
const updateData = { logicalOperator: ViewFilterGroupLogicalOperator.OR };
jest.spyOn(viewFilterGroupService, 'findById').mockResolvedValue(null);
await expect(
viewFilterGroupService.update(id, workspaceId, updateData),
).rejects.toThrow(
new ViewFilterGroupException(
generateViewFilterGroupExceptionMessage(
ViewFilterGroupExceptionMessageKey.VIEW_FILTER_GROUP_NOT_FOUND,
id,
),
ViewFilterGroupExceptionCode.VIEW_FILTER_GROUP_NOT_FOUND,
),
);
});
});
describe('delete', () => {
it('should delete a view filter group successfully', async () => {
const id = 'view-filter-group-id';
const workspaceId = 'workspace-id';
jest
.spyOn(viewFilterGroupService, 'findById')
.mockResolvedValue(mockViewFilterGroup);
jest
.spyOn(viewFilterGroupRepository, 'softDelete')
.mockResolvedValue({} as any);
const result = await viewFilterGroupService.delete(id, workspaceId);
expect(viewFilterGroupService.findById).toHaveBeenCalledWith(
id,
workspaceId,
);
expect(viewFilterGroupRepository.softDelete).toHaveBeenCalledWith(id);
expect(result).toEqual(mockViewFilterGroup);
});
it('should throw exception when view filter group is not found', async () => {
const id = 'non-existent-id';
const workspaceId = 'workspace-id';
jest.spyOn(viewFilterGroupService, 'findById').mockResolvedValue(null);
await expect(
viewFilterGroupService.delete(id, workspaceId),
).rejects.toThrow(
new ViewFilterGroupException(
generateViewFilterGroupExceptionMessage(
ViewFilterGroupExceptionMessageKey.VIEW_FILTER_GROUP_NOT_FOUND,
id,
),
ViewFilterGroupExceptionCode.VIEW_FILTER_GROUP_NOT_FOUND,
),
);
});
});
describe('destroy', () => {
it('should destroy a view filter group successfully', async () => {
const id = 'view-filter-group-id';
const workspaceId = 'workspace-id';
jest
.spyOn(viewFilterGroupRepository, 'findOne')
.mockResolvedValue(mockViewFilterGroup);
jest
.spyOn(viewFilterGroupRepository, 'delete')
.mockResolvedValue({} as any);
const result = await viewFilterGroupService.destroy(id, workspaceId);
expect(viewFilterGroupRepository.findOne).toHaveBeenCalledWith({
where: { id, workspaceId },
relations: [
'workspace',
'view',
'viewFilters',
'parentViewFilterGroup',
'childViewFilterGroups',
],
withDeleted: true,
});
expect(viewFilterGroupRepository.delete).toHaveBeenCalledWith(id);
expect(result).toEqual(true);
});
});
});
@@ -2,27 +2,270 @@ import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { isDefined } from 'twenty-shared/utils';
import { IsNull, Repository } from 'typeorm';
import { IsNull, type Repository } from 'typeorm';
import { ApplicationService } from 'src/engine/core-modules/application/application.service';
import { WorkspaceManyOrAllFlatEntityMapsCacheService } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service';
import { findFlatEntityByIdInFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-id-in-flat-entity-maps-or-throw.util';
import { fromCreateViewFilterGroupInputToFlatViewFilterGroupToCreate } from 'src/engine/metadata-modules/flat-view-filter-group/utils/from-create-view-filter-group-input-to-flat-view-filter-group-to-create.util';
import { fromDeleteViewFilterGroupInputToFlatViewFilterGroupOrThrow } from 'src/engine/metadata-modules/flat-view-filter-group/utils/from-delete-view-filter-group-input-to-flat-view-filter-group-or-throw.util';
import { fromDestroyViewFilterGroupInputToFlatViewFilterGroupOrThrow } from 'src/engine/metadata-modules/flat-view-filter-group/utils/from-destroy-view-filter-group-input-to-flat-view-filter-group-or-throw.util';
import { fromUpdateViewFilterGroupInputToFlatViewFilterGroupToUpdateOrThrow } from 'src/engine/metadata-modules/flat-view-filter-group/utils/from-update-view-filter-group-input-to-flat-view-filter-group-to-update-or-throw.util';
import { type CreateViewFilterGroupInput } from 'src/engine/metadata-modules/view-filter-group/dtos/inputs/create-view-filter-group.input';
import { type DeleteViewFilterGroupInput } from 'src/engine/metadata-modules/view-filter-group/dtos/inputs/delete-view-filter-group.input';
import { type DestroyViewFilterGroupInput } from 'src/engine/metadata-modules/view-filter-group/dtos/inputs/destroy-view-filter-group.input';
import { type UpdateViewFilterGroupInput } from 'src/engine/metadata-modules/view-filter-group/dtos/inputs/update-view-filter-group.input';
import { type ViewFilterGroupDTO } from 'src/engine/metadata-modules/view-filter-group/dtos/view-filter-group.dto';
import { ViewFilterGroupEntity } from 'src/engine/metadata-modules/view-filter-group/entities/view-filter-group.entity';
import {
ViewFilterGroupException,
ViewFilterGroupExceptionCode,
ViewFilterGroupExceptionMessageKey,
generateViewFilterGroupExceptionMessage,
generateViewFilterGroupUserFriendlyExceptionMessage,
} from 'src/engine/metadata-modules/view-filter-group/exceptions/view-filter-group.exception';
import { FIND_ALL_CORE_VIEWS_GRAPHQL_OPERATION } from 'src/engine/metadata-modules/view/constants/find-all-core-views-graphql-operation.constant';
import { WorkspaceCacheStorageService } from 'src/engine/workspace-cache-storage/workspace-cache-storage.service';
import { fromFlatViewFilterGroupToViewFilterGroupDto } from 'src/engine/metadata-modules/view-filter-group/utils/from-flat-view-filter-group-to-view-filter-group-dto.util';
import { WorkspaceMigrationBuilderExceptionV2 } from 'src/engine/workspace-manager/workspace-migration-v2/exceptions/workspace-migration-builder-exception-v2';
import { WorkspaceMigrationValidateBuildAndRunService } from 'src/engine/workspace-manager/workspace-migration-v2/services/workspace-migration-validate-build-and-run-service';
@Injectable()
export class ViewFilterGroupService {
constructor(
@InjectRepository(ViewFilterGroupEntity)
private readonly viewFilterGroupRepository: Repository<ViewFilterGroupEntity>,
private readonly workspaceCacheStorageService: WorkspaceCacheStorageService,
private readonly workspaceMigrationValidateBuildAndRunService: WorkspaceMigrationValidateBuildAndRunService,
private readonly flatEntityMapsCacheService: WorkspaceManyOrAllFlatEntityMapsCacheService,
private readonly applicationService: ApplicationService,
) {}
async createOne({
createViewFilterGroupInput,
workspaceId,
}: {
createViewFilterGroupInput: CreateViewFilterGroupInput;
workspaceId: string;
}): Promise<ViewFilterGroupDTO> {
const { workspaceCustomFlatApplication } =
await this.applicationService.findWorkspaceTwentyStandardAndCustomApplicationOrThrow(
{
workspaceId,
},
);
const flatViewFilterGroupToCreate =
fromCreateViewFilterGroupInputToFlatViewFilterGroupToCreate({
createViewFilterGroupInput,
workspaceId,
workspaceCustomApplicationId: workspaceCustomFlatApplication.id,
});
const buildAndRunResult =
await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigration(
{
allFlatEntityOperationByMetadataName: {
viewFilterGroup: {
flatEntityToCreate: [flatViewFilterGroupToCreate],
flatEntityToDelete: [],
flatEntityToUpdate: [],
},
},
workspaceId,
isSystemBuild: false,
},
);
if (isDefined(buildAndRunResult)) {
throw new WorkspaceMigrationBuilderExceptionV2(
buildAndRunResult,
'Multiple validation errors occurred while creating view filter group',
);
}
const {
flatViewFilterGroupMaps: recomputedExistingFlatViewFilterGroupMaps,
} =
await this.flatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
{
workspaceId,
flatMapsKeys: ['flatViewFilterGroupMaps'],
},
);
return fromFlatViewFilterGroupToViewFilterGroupDto(
findFlatEntityByIdInFlatEntityMapsOrThrow({
flatEntityId: flatViewFilterGroupToCreate.id,
flatEntityMaps: recomputedExistingFlatViewFilterGroupMaps,
}),
);
}
async updateOne({
id,
updateViewFilterGroupInput,
workspaceId,
}: {
id: string;
workspaceId: string;
updateViewFilterGroupInput: UpdateViewFilterGroupInput;
}): Promise<ViewFilterGroupDTO> {
const { flatViewFilterGroupMaps: existingFlatViewFilterGroupMaps } =
await this.flatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
{
workspaceId,
flatMapsKeys: ['flatViewFilterGroupMaps'],
},
);
const optimisticallyUpdatedFlatViewFilterGroup =
fromUpdateViewFilterGroupInputToFlatViewFilterGroupToUpdateOrThrow({
flatViewFilterGroupMaps: existingFlatViewFilterGroupMaps,
updateViewFilterGroupInput: { id, ...updateViewFilterGroupInput },
});
const validateAndBuildResult =
await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigration(
{
allFlatEntityOperationByMetadataName: {
viewFilterGroup: {
flatEntityToCreate: [],
flatEntityToDelete: [],
flatEntityToUpdate: [optimisticallyUpdatedFlatViewFilterGroup],
},
},
workspaceId,
isSystemBuild: false,
},
);
if (isDefined(validateAndBuildResult)) {
throw new WorkspaceMigrationBuilderExceptionV2(
validateAndBuildResult,
'Multiple validation errors occurred while updating view filter group',
);
}
const {
flatViewFilterGroupMaps: recomputedExistingFlatViewFilterGroupMaps,
} =
await this.flatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
{
workspaceId,
flatMapsKeys: ['flatViewFilterGroupMaps'],
},
);
return fromFlatViewFilterGroupToViewFilterGroupDto(
findFlatEntityByIdInFlatEntityMapsOrThrow({
flatEntityId: optimisticallyUpdatedFlatViewFilterGroup.id,
flatEntityMaps: recomputedExistingFlatViewFilterGroupMaps,
}),
);
}
async deleteOne({
deleteViewFilterGroupInput,
workspaceId,
}: {
deleteViewFilterGroupInput: DeleteViewFilterGroupInput;
workspaceId: string;
}): Promise<ViewFilterGroupDTO> {
const { flatViewFilterGroupMaps: existingFlatViewFilterGroupMaps } =
await this.flatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
{
workspaceId,
flatMapsKeys: ['flatViewFilterGroupMaps'],
},
);
const optimisticallyUpdatedFlatViewFilterGroupWithDeletedAt =
fromDeleteViewFilterGroupInputToFlatViewFilterGroupOrThrow({
flatViewFilterGroupMaps: existingFlatViewFilterGroupMaps,
deleteViewFilterGroupInput,
});
const validateAndBuildResult =
await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigration(
{
allFlatEntityOperationByMetadataName: {
viewFilterGroup: {
flatEntityToCreate: [],
flatEntityToDelete: [],
flatEntityToUpdate: [
optimisticallyUpdatedFlatViewFilterGroupWithDeletedAt,
],
},
},
workspaceId,
isSystemBuild: false,
},
);
if (isDefined(validateAndBuildResult)) {
throw new WorkspaceMigrationBuilderExceptionV2(
validateAndBuildResult,
'Multiple validation errors occurred while deleting view filter group',
);
}
const {
flatViewFilterGroupMaps: recomputedExistingFlatViewFilterGroupMaps,
} =
await this.flatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
{
workspaceId,
flatMapsKeys: ['flatViewFilterGroupMaps'],
},
);
return fromFlatViewFilterGroupToViewFilterGroupDto(
findFlatEntityByIdInFlatEntityMapsOrThrow({
flatEntityId: optimisticallyUpdatedFlatViewFilterGroupWithDeletedAt.id,
flatEntityMaps: recomputedExistingFlatViewFilterGroupMaps,
}),
);
}
async destroyOne({
destroyViewFilterGroupInput,
workspaceId,
}: {
destroyViewFilterGroupInput: DestroyViewFilterGroupInput;
workspaceId: string;
}): Promise<ViewFilterGroupDTO> {
const { flatViewFilterGroupMaps: existingFlatViewFilterGroupMaps } =
await this.flatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
{
workspaceId,
flatMapsKeys: ['flatViewFilterGroupMaps'],
},
);
const existingViewFilterGroupToDelete =
fromDestroyViewFilterGroupInputToFlatViewFilterGroupOrThrow({
destroyViewFilterGroupInput,
flatViewFilterGroupMaps: existingFlatViewFilterGroupMaps,
});
const validateAndBuildResult =
await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigration(
{
allFlatEntityOperationByMetadataName: {
viewFilterGroup: {
flatEntityToCreate: [],
flatEntityToDelete: [existingViewFilterGroupToDelete],
flatEntityToUpdate: [],
},
},
workspaceId,
isSystemBuild: false,
},
);
if (isDefined(validateAndBuildResult)) {
throw new WorkspaceMigrationBuilderExceptionV2(
validateAndBuildResult,
'Multiple validation errors occurred while destroying view filter group',
);
}
return fromFlatViewFilterGroupToViewFilterGroupDto(
existingViewFilterGroupToDelete,
);
}
async findByWorkspaceId(
workspaceId: string,
): Promise<ViewFilterGroupEntity[]> {
@@ -84,138 +327,4 @@ export class ViewFilterGroupService {
return viewFilterGroup || null;
}
async create(
viewFilterGroupData: Partial<ViewFilterGroupEntity>,
): Promise<ViewFilterGroupEntity> {
if (!isDefined(viewFilterGroupData.workspaceId)) {
throw new ViewFilterGroupException(
generateViewFilterGroupExceptionMessage(
ViewFilterGroupExceptionMessageKey.WORKSPACE_ID_REQUIRED,
),
ViewFilterGroupExceptionCode.INVALID_VIEW_FILTER_GROUP_DATA,
{
userFriendlyMessage:
generateViewFilterGroupUserFriendlyExceptionMessage(
ViewFilterGroupExceptionMessageKey.WORKSPACE_ID_REQUIRED,
),
},
);
}
if (!isDefined(viewFilterGroupData.viewId)) {
throw new ViewFilterGroupException(
generateViewFilterGroupExceptionMessage(
ViewFilterGroupExceptionMessageKey.VIEW_ID_REQUIRED,
),
ViewFilterGroupExceptionCode.INVALID_VIEW_FILTER_GROUP_DATA,
{
userFriendlyMessage:
generateViewFilterGroupUserFriendlyExceptionMessage(
ViewFilterGroupExceptionMessageKey.VIEW_ID_REQUIRED,
),
},
);
}
const viewFilterGroup =
this.viewFilterGroupRepository.create(viewFilterGroupData);
await this.flushGraphQLCache(viewFilterGroupData.workspaceId);
const savedViewFilterGroup =
await this.viewFilterGroupRepository.save(viewFilterGroup);
await this.flushGraphQLCache(viewFilterGroupData.workspaceId);
return savedViewFilterGroup;
}
async update(
id: string,
workspaceId: string,
updateData: Partial<ViewFilterGroupEntity>,
): Promise<ViewFilterGroupEntity> {
const existingViewFilterGroup = await this.findById(id, workspaceId);
if (!isDefined(existingViewFilterGroup)) {
throw new ViewFilterGroupException(
generateViewFilterGroupExceptionMessage(
ViewFilterGroupExceptionMessageKey.VIEW_FILTER_GROUP_NOT_FOUND,
id,
),
ViewFilterGroupExceptionCode.VIEW_FILTER_GROUP_NOT_FOUND,
);
}
const updatedViewFilterGroup = await this.viewFilterGroupRepository.save({
id,
...updateData,
});
await this.flushGraphQLCache(workspaceId);
return { ...existingViewFilterGroup, ...updatedViewFilterGroup };
}
async delete(
id: string,
workspaceId: string,
): Promise<ViewFilterGroupEntity> {
const viewFilterGroup = await this.findById(id, workspaceId);
if (!isDefined(viewFilterGroup)) {
throw new ViewFilterGroupException(
generateViewFilterGroupExceptionMessage(
ViewFilterGroupExceptionMessageKey.VIEW_FILTER_GROUP_NOT_FOUND,
id,
),
ViewFilterGroupExceptionCode.VIEW_FILTER_GROUP_NOT_FOUND,
);
}
await this.viewFilterGroupRepository.softDelete(id);
return viewFilterGroup;
}
async destroy(id: string, workspaceId: string): Promise<boolean> {
const viewFilterGroup = await this.viewFilterGroupRepository.findOne({
where: {
id,
workspaceId,
},
relations: [
'workspace',
'view',
'viewFilters',
'parentViewFilterGroup',
'childViewFilterGroups',
],
withDeleted: true,
});
if (!isDefined(viewFilterGroup)) {
throw new ViewFilterGroupException(
generateViewFilterGroupExceptionMessage(
ViewFilterGroupExceptionMessageKey.VIEW_FILTER_GROUP_NOT_FOUND,
id,
),
ViewFilterGroupExceptionCode.VIEW_FILTER_GROUP_NOT_FOUND,
);
}
await this.viewFilterGroupRepository.delete(id);
await this.flushGraphQLCache(workspaceId);
return true;
}
private async flushGraphQLCache(workspaceId: string): Promise<void> {
await this.workspaceCacheStorageService.flushGraphQLOperation({
operationName: FIND_ALL_CORE_VIEWS_GRAPHQL_OPERATION,
workspaceId,
});
}
}
@@ -0,0 +1,15 @@
import { type FlatViewFilterGroup } from 'src/engine/metadata-modules/flat-view-filter-group/types/flat-view-filter-group.type';
import { type ViewFilterGroupDTO } from 'src/engine/metadata-modules/view-filter-group/dtos/view-filter-group.dto';
export const fromFlatViewFilterGroupToViewFilterGroupDto = (
flatViewFilterGroup: FlatViewFilterGroup,
): ViewFilterGroupDTO => {
const { createdAt, updatedAt, deletedAt, ...rest } = flatViewFilterGroup;
return {
...rest,
createdAt: new Date(createdAt),
updatedAt: new Date(updatedAt),
deletedAt: deletedAt ? new Date(deletedAt) : null,
};
};
@@ -1,6 +1,8 @@
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { ApplicationModule } from 'src/engine/core-modules/application/application.module';
import { WorkspaceManyOrAllFlatEntityMapsCacheModule } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.module';
import { PermissionsModule } from 'src/engine/metadata-modules/permissions/permissions.module';
import { ViewFilterGroupController } from 'src/engine/metadata-modules/view-filter-group/controllers/view-filter-group.controller';
import { ViewFilterGroupEntity } from 'src/engine/metadata-modules/view-filter-group/entities/view-filter-group.entity';
@@ -9,12 +11,16 @@ import { ViewFilterGroupService } from 'src/engine/metadata-modules/view-filter-
import { ViewPermissionsModule } from 'src/engine/metadata-modules/view-permissions/view-permissions.module';
import { ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entity';
import { WorkspaceCacheStorageModule } from 'src/engine/workspace-cache-storage/workspace-cache-storage.module';
import { WorkspaceMigrationV2Module } from 'src/engine/workspace-manager/workspace-migration-v2/workspace-migration-v2.module';
@Module({
imports: [
TypeOrmModule.forFeature([ViewFilterGroupEntity, ViewEntity]),
PermissionsModule,
WorkspaceCacheStorageModule,
ApplicationModule,
WorkspaceMigrationV2Module,
WorkspaceManyOrAllFlatEntityMapsCacheModule,
ViewPermissionsModule,
],
controllers: [ViewFilterGroupController],
@@ -74,11 +74,6 @@ export class ViewFilterService {
);
}
this.flatEntityMapsCacheService.invalidateFlatEntityMaps({
workspaceId,
flatMapsKeys: ['flatViewFilterMaps'],
});
const { flatViewFilterMaps: recomputedExistingFlatViewFilterMaps } =
await this.flatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
{
@@ -103,6 +103,14 @@ export const viewGraphqlApiExceptionHandler = (error: Error, i18n: I18n) => {
throw new UserInputError(error.message, {
userFriendlyMessage: error.userFriendlyMessage,
});
case ViewFilterGroupExceptionCode.CIRCULAR_DEPENDENCY:
throw new UserInputError(error.message, {
userFriendlyMessage: error.userFriendlyMessage,
});
case ViewFilterGroupExceptionCode.MAX_DEPTH_EXCEEDED:
throw new UserInputError(error.message, {
userFriendlyMessage: error.userFriendlyMessage,
});
default: {
return assertUnreachable(error.code);
}