V2 centralize relation optimistic logic (#15552)

# Introduction
This PR aims to deprecate having to manually handle optimistic side
effect foreign key addition in the whole v2 experience.
This PR implements the strong basis + builder refactor of the optimistic
computation of a given flat entity maps with its related flat entity
maps ( runner needs a small refactor on actions type definition first )
Flat entity maps updates through mutations are now only scoped to the
generic entity builder ( very isolated )

## What's next
- Refactor actions v2 type definition to gain grain over `metadataName`
and action operation ( `create` `delete` `update` ).
from `{type: 'create_view_field'}` to `{metadataName: 'view_field',
type: 'create' }`
- Use new optimistic tool computation tools
- Only invalidate impacted flat maps cache

## New tools
Strictly dynamically typed new flat entity maps tools
- `addFlatEntityToFlatEntityAndRelatedEntityMapsThroughMutationOrThrow`
-
`deleteFlatEntityFromFlatEntityAndRelatedEntityMapsThroughMutationOrThrow`

## Unit test
Adding basic unit testing coverage to introduced tools

## `FlatEntityValidationArgs`
From 
```ts
export type FlatEntityValidationArgs<T extends AllMetadataName> = {
  flatEntityToValidate: MetadataFlatEntity<T>;
  optimisticFlatEntityMaps: MetadataFlatEntityMaps<T>;
  mutableDependencyOptimisticFlatEntityMaps: MetadataValidationRelatedFlatEntityMaps<T>;
  workspaceId: string;
  remainingFlatEntityMapsToValidate: MetadataFlatEntityMaps<T>;
  buildOptions: WorkspaceMigrationBuilderOptions;
};

```

To
```ts
export type FlatEntityValidationArgs<T extends AllMetadataName> = {
  flatEntityToValidate: MetadataFlatEntity<T>;
  optimisticFlatEntityMapsAndRelatedFlatEntityMaps: MetadataFlatEntityAndRelatedFlatEntityMapsForValidation<T>;
  workspaceId: string;
  remainingFlatEntityMapsToValidate: MetadataFlatEntityMaps<T>;
  buildOptions: WorkspaceMigrationBuilderOptions;
};

```
This commit is contained in:
Paul Rastoin
2025-11-04 12:28:28 +01:00
committed by GitHub
parent 281070423f
commit 3514054235
39 changed files with 946 additions and 807 deletions
@@ -1,21 +1,22 @@
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { removePropertiesFromRecord } from 'twenty-shared/utils';
import { Repository } from 'typeorm';
import { InjectCacheStorage } from 'src/engine/core-modules/cache-storage/decorators/cache-storage.decorator';
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 { CronTriggerEntity } from 'src/engine/metadata-modules/cron-trigger/entities/cron-trigger.entity';
import { DatabaseEventTriggerEntity } from 'src/engine/metadata-modules/database-event-trigger/entities/database-event-trigger.entity';
import { createEmptyFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/constant/create-empty-flat-entity-maps.constant';
import { FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import {
SERVERLESS_FUNCTION_ENTITY_RELATION_PROPERTIES,
ServerlessFunctionEntity,
} from 'src/engine/metadata-modules/serverless-function/serverless-function.entity';
import { RouteTriggerEntity } from 'src/engine/metadata-modules/route-trigger/route-trigger.entity';
import { ServerlessFunctionEntity } from 'src/engine/metadata-modules/serverless-function/serverless-function.entity';
import { FlatServerlessFunction } from 'src/engine/metadata-modules/serverless-function/types/flat-serverless-function.type';
import { fromServerlessFunctionEntityToFlatServerlessFunction } from 'src/engine/metadata-modules/serverless-function/utils/from-serverless-function-entity-to-flat-serverless-function.type';
import { WorkspaceFlatMapCache } from 'src/engine/workspace-flat-map-cache/decorators/workspace-flat-map-cache.decorator';
import { WorkspaceFlatMapCacheService } from 'src/engine/workspace-flat-map-cache/services/workspace-flat-map-cache.service';
import { regroupEntitiesByRelatedEntityId } from 'src/engine/workspace-flat-map-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()
@@ -28,6 +29,12 @@ export class WorkspaceFlatServerlessFunctionMapCacheService extends WorkspaceFla
cacheStorageService: CacheStorageService,
@InjectRepository(ServerlessFunctionEntity)
private readonly serverlessFunctionRepository: Repository<ServerlessFunctionEntity>,
@InjectRepository(DatabaseEventTriggerEntity)
private readonly databaseEventTriggerRepository: Repository<DatabaseEventTriggerEntity>,
@InjectRepository(CronTriggerEntity)
private readonly cronTriggerRepository: Repository<CronTriggerEntity>,
@InjectRepository(RouteTriggerEntity)
private readonly routeTriggerRepository: Repository<RouteTriggerEntity>,
) {
super(cacheStorageService);
}
@@ -37,24 +44,73 @@ export class WorkspaceFlatServerlessFunctionMapCacheService extends WorkspaceFla
}: {
workspaceId: string;
}): Promise<FlatEntityMaps<FlatServerlessFunction>> {
const serverlessFunctions = await this.serverlessFunctionRepository.find({
where: {
workspaceId,
},
withDeleted: true,
});
const [
serverlessFunctions,
routeTriggers,
cronTriggers,
databaseEventTriggers,
] = await Promise.all([
this.serverlessFunctionRepository.find({
where: { workspaceId },
withDeleted: true,
}),
this.cronTriggerRepository.find({
where: { workspaceId },
select: ['id', 'serverlessFunctionId'],
withDeleted: true,
}),
this.routeTriggerRepository.find({
where: { workspaceId },
select: ['id', 'serverlessFunctionId'],
withDeleted: true,
}),
this.databaseEventTriggerRepository.find({
where: { workspaceId },
select: ['id', 'serverlessFunctionId'],
withDeleted: true,
}),
]);
const [
routeTriggersByServerlessFunctionId,
cronTriggersByServerlessFunctionId,
databaseEventTriggersByServerlessFunctionId,
] = (
[
{
entities: routeTriggers,
foreignKey: 'serverlessFunctionId',
},
{
entities: cronTriggers,
foreignKey: 'serverlessFunctionId',
},
{
entities: databaseEventTriggers,
foreignKey: 'serverlessFunctionId',
},
] as const
).map(regroupEntitiesByRelatedEntityId);
const flatServerlessFunctionMaps = createEmptyFlatEntityMaps();
for (const serverlessFunctionEntity of serverlessFunctions) {
const flatServerlessFunction = {
...removePropertiesFromRecord(serverlessFunctionEntity, [
...SERVERLESS_FUNCTION_ENTITY_RELATION_PROPERTIES,
]),
universalIdentifier:
serverlessFunctionEntity.universalIdentifier ??
serverlessFunctionEntity.id,
} satisfies FlatServerlessFunction;
const flatServerlessFunction =
fromServerlessFunctionEntityToFlatServerlessFunction({
...serverlessFunctionEntity,
routeTriggers:
routeTriggersByServerlessFunctionId.get(
serverlessFunctionEntity.id,
) || [],
cronTriggers:
cronTriggersByServerlessFunctionId.get(
serverlessFunctionEntity.id,
) || [],
databaseEventTriggers:
databaseEventTriggersByServerlessFunctionId.get(
serverlessFunctionEntity.id,
) || [],
} as ServerlessFunctionEntity);
addFlatEntityToFlatEntityMapsThroughMutationOrThrow({
flatEntity: flatServerlessFunction,