houseassassin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix view rest api in v2 (#15398)

Browse Source 
# Introduction
Initially wanted to reactive the test introduced in
https://github.com/twentyhq/twenty/pull/15393, that was failing because
of direct data source access removing all views ( even seeded one )
which was making the test fail

While doing so discovered a lot of issue with the rest API:
- Rest api wasn't consuming the v2 at all
- Rest api wasn't prepared to handle v2 exceptions
- Rest api did not handled unknown exceptions ( timeout )

Refactored the cleanup of each test to follow black box pattern and
avoid test leakage
This commit is contained in:
Paul Rastoin
2025-10-29 15:07:08 +01:00
committed by GitHub
parent 28c6edfa1f
commit c19a799973
34 changed files with 1281 additions and 577 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/twenty-server/src/engine/metadata-modules/view-field/controllers/view-field.controller.ts
+82 -5
View File
@@ -13,11 +13,14 @@ import {
import { isDefined } from 'twenty-shared/utils';
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 { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
import { CreateViewFieldInput } from 'src/engine/metadata-modules/view-field/dtos/inputs/create-view-field.input';
import { UpdateViewFieldInput } from 'src/engine/metadata-modules/view-field/dtos/inputs/update-view-field.input';
import { ViewFieldDTO } from 'src/engine/metadata-modules/view-field/dtos/view-field.dto';
import { ViewFieldEntity } from 'src/engine/metadata-modules/view-field/entities/view-field.entity';
import {
generateViewFieldExceptionMessage,
@@ -27,13 +30,18 @@ import {
ViewFieldExceptionMessageKey,
} from 'src/engine/metadata-modules/view-field/exceptions/view-field.exception';
import { ViewFieldRestApiExceptionFilter } from 'src/engine/metadata-modules/view-field/filters/view-field-rest-api-exception.filter';
import { ViewFieldV2Service } from 'src/engine/metadata-modules/view-field/services/view-field-v2.service';
import { ViewFieldService } from 'src/engine/metadata-modules/view-field/services/view-field.service';
@Controller('rest/metadata/viewFields')
@UseGuards(WorkspaceAuthGuard)
@UseFilters(ViewFieldRestApiExceptionFilter)
export class ViewFieldController {
constructor(private readonly viewFieldService: ViewFieldService) {}
constructor(
private readonly viewFieldService: ViewFieldService,
private readonly viewFieldV2Service: ViewFieldV2Service,
private readonly featureFlagService: FeatureFlagService,
) {}
@Get()
async findMany(
@@ -77,25 +85,79 @@ export class ViewFieldController {
@Param('id') id: string,
@Body() input: UpdateViewFieldInput['update'],
@AuthWorkspace() workspace: WorkspaceEntity,
): Promise<ViewFieldEntity> {
): Promise<ViewFieldDTO> {
const isWorkspaceMigrationV2Enabled =
await this.featureFlagService.isFeatureEnabled(
FeatureFlagKey.IS_WORKSPACE_MIGRATION_V2_ENABLED,
workspace.id,
);
if (isWorkspaceMigrationV2Enabled) {
return await this.viewFieldV2Service.updateOne({
updateViewFieldInput: { id, update: input },
workspaceId: workspace.id,
});
}
const updatedViewField = await this.viewFieldService.update(
id,
workspace.id,
input,
);
return updatedViewField;
// Convert ViewFieldEntity to ViewFieldDTO for consistency
return {
id: updatedViewField.id,
fieldMetadataId: updatedViewField.fieldMetadataId,
isVisible: updatedViewField.isVisible,
size: updatedViewField.size,
position: updatedViewField.position,
aggregateOperation: updatedViewField.aggregateOperation,
viewId: updatedViewField.viewId,
workspaceId: updatedViewField.workspaceId,
createdAt: updatedViewField.createdAt,
updatedAt: updatedViewField.updatedAt,
deletedAt: updatedViewField.deletedAt,
};
}
@Post()
async create(
@Body() input: CreateViewFieldInput,
@AuthWorkspace() workspace: WorkspaceEntity,
): Promise<ViewFieldEntity> {
return this.viewFieldService.create({
): Promise<ViewFieldDTO> {
const isWorkspaceMigrationV2Enabled =
await this.featureFlagService.isFeatureEnabled(
FeatureFlagKey.IS_WORKSPACE_MIGRATION_V2_ENABLED,
workspace.id,
);
if (isWorkspaceMigrationV2Enabled) {
return await this.viewFieldV2Service.createOne({
createViewFieldInput: input,
workspaceId: workspace.id,
});
}
const createdViewField = await this.viewFieldService.create({
...input,
workspaceId: workspace.id,
});
// Convert ViewFieldEntity to ViewFieldDTO for consistency
return {
id: createdViewField.id,
fieldMetadataId: createdViewField.fieldMetadataId,
isVisible: createdViewField.isVisible,
size: createdViewField.size,
position: createdViewField.position,
aggregateOperation: createdViewField.aggregateOperation,
viewId: createdViewField.viewId,
workspaceId: createdViewField.workspaceId,
createdAt: createdViewField.createdAt,
updatedAt: createdViewField.updatedAt,
deletedAt: createdViewField.deletedAt,
};
}
@Delete(':id')
@@ -103,6 +165,21 @@ export class ViewFieldController {
@Param('id') id: string,
@AuthWorkspace() workspace: WorkspaceEntity,
): Promise<{ success: boolean }> {
const isWorkspaceMigrationV2Enabled =
await this.featureFlagService.isFeatureEnabled(
FeatureFlagKey.IS_WORKSPACE_MIGRATION_V2_ENABLED,
workspace.id,
);
if (isWorkspaceMigrationV2Enabled) {
const deletedViewField = await this.viewFieldV2Service.deleteOne({
deleteViewFieldInput: { id },
workspaceId: workspace.id,
});
return { success: isDefined(deletedViewField) };
}
const deletedViewField = await this.viewFieldService.delete(
id,
workspace.id,
packages/twenty-server/src/engine/metadata-modules/view-field/filters/view-field-rest-api-exception.filter.ts
+66 -22
View File
@@ -2,47 +2,91 @@ import {
type ArgumentsHost,
Catch,
type ExceptionFilter,
Injectable,
} from '@nestjs/common';
import { type Response } from 'express';
import { SOURCE_LOCALE } from 'twenty-shared/translations';
import { HttpExceptionHandlerService } from 'src/engine/core-modules/exception-handler/http-exception-handler.service';
import { I18nService } from 'src/engine/core-modules/i18n/i18n.service';
import {
ViewFieldException,
ViewFieldExceptionCode,
} from 'src/engine/metadata-modules/view-field/exceptions/view-field.exception';
import { type CustomException } from 'src/utils/custom-exception';
import { WorkspaceMigrationBuilderExceptionV2 } from 'src/engine/workspace-manager/workspace-migration-v2/exceptions/workspace-migration-builder-exception-v2';
import { fromWorkspaceMigrationBuilderExceptionToMetadataValidationResponseError } from 'src/engine/workspace-manager/workspace-migration-v2/interceptors/utils/from-workspace-migration-builder-exception-to-metadata-validation-response-error.util';
import {
type CustomException,
UnknownException,
} from 'src/utils/custom-exception';
@Catch(ViewFieldException)
@Injectable()
@Catch(ViewFieldException, WorkspaceMigrationBuilderExceptionV2)
export class ViewFieldRestApiExceptionFilter implements ExceptionFilter {
constructor(
private readonly httpExceptionHandlerService: HttpExceptionHandlerService,
private readonly i18nService: I18nService,
) {}
catch(exception: ViewFieldException, host: ArgumentsHost) {
catch(
exception: ViewFieldException | WorkspaceMigrationBuilderExceptionV2,
host: ArgumentsHost,
) {
const ctx = host.switchToHttp();
const response = ctx.getResponse<Response>();
switch (exception.code) {
case ViewFieldExceptionCode.VIEW_FIELD_NOT_FOUND:
return this.httpExceptionHandlerService.handleError(
exception as CustomException,
response,
404,
);
case ViewFieldExceptionCode.INVALID_VIEW_FIELD_DATA:
return this.httpExceptionHandlerService.handleError(
exception as CustomException,
response,
400,
);
default:
// TODO: change to 500 when we have input validation
return this.httpExceptionHandlerService.handleError(
exception as CustomException,
response,
400,
if (exception instanceof WorkspaceMigrationBuilderExceptionV2) {
const i18n = this.i18nService.getI18nInstance(SOURCE_LOCALE);
const { errors, summary } =
fromWorkspaceMigrationBuilderExceptionToMetadataValidationResponseError(
exception,
i18n,
);
return response.status(400).json({
statusCode: 400,
error: 'METADATA_VALIDATION_ERROR',
message: exception.message || 'Validation failed',
errors,
summary,
});
}
if (exception instanceof ViewFieldException) {
switch (exception.code) {
case ViewFieldExceptionCode.VIEW_FIELD_NOT_FOUND:
return this.httpExceptionHandlerService.handleError(
exception as CustomException,
response,
404,
);
case ViewFieldExceptionCode.INVALID_VIEW_FIELD_DATA:
return this.httpExceptionHandlerService.handleError(
exception as CustomException,
response,
400,
);
default:
// TODO: change to 500 when we have input validation
return this.httpExceptionHandlerService.handleError(
exception as CustomException,
response,
400,
);
}
}
// Fallback for any other exception type
const unknownException = new UnknownException(
'Internal server error',
'INTERNAL_ERROR',
);
return this.httpExceptionHandlerService.handleError(
unknownException as CustomException,
response,
500,
);
}
}