Introduce webhook v2 (#17456)

Migrate webhook to v2 entity
2026-01-27 16:32:33 +01:00
parent 27e5b9797b
commit bc7791871f
83 changed files with 1574 additions and 975 deletions
@@ -0,0 +1,224 @@
+import { Injectable } from '@nestjs/common';
+import { InjectRepository } from '@nestjs/typeorm';
+
+import { IsNull, Repository } from 'typeorm';
+import { isDefined } from 'twenty-shared/utils';
+
+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 { fromCreateWebhookInputToFlatWebhookToCreate } from 'src/engine/metadata-modules/flat-webhook/utils/from-create-webhook-input-to-flat-webhook-to-create.util';
+import { fromDeleteWebhookInputToFlatWebhookOrThrow } from 'src/engine/metadata-modules/flat-webhook/utils/from-delete-webhook-input-to-flat-webhook-or-throw.util';
+import { fromFlatWebhookToWebhookDto } from 'src/engine/metadata-modules/flat-webhook/utils/from-flat-webhook-to-webhook-dto.util';
+import { fromUpdateWebhookInputToFlatWebhookToUpdateOrThrow } from 'src/engine/metadata-modules/flat-webhook/utils/from-update-webhook-input-to-flat-webhook-to-update-or-throw.util';
+import { fromWebhookEntityToFlatWebhook } from 'src/engine/metadata-modules/flat-webhook/utils/from-webhook-entity-to-flat-webhook.util';
+import { type CreateWebhookInput } from 'src/engine/metadata-modules/webhook/dtos/create-webhook.input';
+import { type UpdateWebhookInput } from 'src/engine/metadata-modules/webhook/dtos/update-webhook.input';
+import { type WebhookDTO } from 'src/engine/metadata-modules/webhook/dtos/webhook.dto';
+import { WebhookEntity } from 'src/engine/metadata-modules/webhook/entities/webhook.entity';
+import { WorkspaceMigrationBuilderException } from 'src/engine/workspace-manager/workspace-migration/exceptions/workspace-migration-builder-exception';
+import { WorkspaceMigrationValidateBuildAndRunService } from 'src/engine/workspace-manager/workspace-migration/services/workspace-migration-validate-build-and-run-service';
+
+@Injectable()
+export class WebhookService {
+  constructor(
+    @InjectRepository(WebhookEntity)
+    private readonly webhookRepository: Repository<WebhookEntity>,
+    private readonly workspaceMigrationValidateBuildAndRunService: WorkspaceMigrationValidateBuildAndRunService,
+    private readonly workspaceManyOrAllFlatEntityMapsCacheService: WorkspaceManyOrAllFlatEntityMapsCacheService,
+    private readonly applicationService: ApplicationService,
+  ) {}
+
+  private normalizeTargetUrl(targetUrl: string): string {
+    try {
+      const url = new URL(targetUrl);
+
+      return url.toString();
+    } catch {
+      return targetUrl;
+    }
+  }
+
+  async findAll(workspaceId: string): Promise<WebhookDTO[]> {
+    const webhooks = await this.webhookRepository.find({
+      where: { workspaceId, deletedAt: IsNull() },
+      order: { createdAt: 'ASC' },
+    });
+
+    return webhooks
+      .map(fromWebhookEntityToFlatWebhook)
+      .map(fromFlatWebhookToWebhookDto);
+  }
+
+  async findById(id: string, workspaceId: string): Promise<WebhookDTO | null> {
+    const webhook = await this.webhookRepository.findOne({
+      where: { id, workspaceId, deletedAt: IsNull() },
+    });
+
+    if (!isDefined(webhook)) {
+      return null;
+    }
+
+    return fromFlatWebhookToWebhookDto(fromWebhookEntityToFlatWebhook(webhook));
+  }
+
+  async create(
+    input: CreateWebhookInput,
+    workspaceId: string,
+  ): Promise<WebhookDTO> {
+    const normalizedTargetUrl = this.normalizeTargetUrl(input.targetUrl);
+
+    const { workspaceCustomFlatApplication } =
+      await this.applicationService.findWorkspaceTwentyStandardAndCustomApplicationOrThrow(
+        { workspaceId },
+      );
+
+    const flatWebhookToCreate = fromCreateWebhookInputToFlatWebhookToCreate({
+      createWebhookInput: {
+        ...input,
+        targetUrl: normalizedTargetUrl,
+      },
+      workspaceId,
+      applicationId: workspaceCustomFlatApplication.id,
+    });
+
+    const validateAndBuildResult =
+      await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigration(
+        {
+          allFlatEntityOperationByMetadataName: {
+            webhook: {
+              flatEntityToCreate: [flatWebhookToCreate],
+              flatEntityToDelete: [],
+              flatEntityToUpdate: [],
+            },
+          },
+          workspaceId,
+        },
+      );
+
+    if (isDefined(validateAndBuildResult)) {
+      throw new WorkspaceMigrationBuilderException(
+        validateAndBuildResult,
+        'Multiple validation errors occurred while creating webhook',
+      );
+    }
+
+    const { flatWebhookMaps: recomputedFlatWebhookMaps } =
+      await this.workspaceManyOrAllFlatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
+        {
+          workspaceId,
+          flatMapsKeys: ['flatWebhookMaps'],
+        },
+      );
+
+    return fromFlatWebhookToWebhookDto(
+      findFlatEntityByIdInFlatEntityMapsOrThrow({
+        flatEntityId: flatWebhookToCreate.id,
+        flatEntityMaps: recomputedFlatWebhookMaps,
+      }),
+    );
+  }
+
+  async update(
+    input: UpdateWebhookInput,
+    workspaceId: string,
+  ): Promise<WebhookDTO> {
+    const normalizedInput = {
+      ...input,
+      update: {
+        ...input.update,
+        ...(isDefined(input.update.targetUrl) && {
+          targetUrl: this.normalizeTargetUrl(input.update.targetUrl),
+        }),
+      },
+    };
+
+    const { flatWebhookMaps: existingFlatWebhookMaps } =
+      await this.workspaceManyOrAllFlatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
+        {
+          workspaceId,
+          flatMapsKeys: ['flatWebhookMaps'],
+        },
+      );
+
+    const flatWebhookToUpdate =
+      fromUpdateWebhookInputToFlatWebhookToUpdateOrThrow({
+        flatWebhookMaps: existingFlatWebhookMaps,
+        updateWebhookInput: normalizedInput,
+      });
+
+    const validateAndBuildResult =
+      await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigration(
+        {
+          allFlatEntityOperationByMetadataName: {
+            webhook: {
+              flatEntityToCreate: [],
+              flatEntityToDelete: [],
+              flatEntityToUpdate: [flatWebhookToUpdate],
+            },
+          },
+          workspaceId,
+        },
+      );
+
+    if (isDefined(validateAndBuildResult)) {
+      throw new WorkspaceMigrationBuilderException(
+        validateAndBuildResult,
+        'Multiple validation errors occurred while updating webhook',
+      );
+    }
+
+    const { flatWebhookMaps: recomputedFlatWebhookMaps } =
+      await this.workspaceManyOrAllFlatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
+        {
+          workspaceId,
+          flatMapsKeys: ['flatWebhookMaps'],
+        },
+      );
+
+    return fromFlatWebhookToWebhookDto(
+      findFlatEntityByIdInFlatEntityMapsOrThrow({
+        flatEntityId: input.id,
+        flatEntityMaps: recomputedFlatWebhookMaps,
+      }),
+    );
+  }
+
+  async delete(id: string, workspaceId: string): Promise<WebhookDTO> {
+    const { flatWebhookMaps: existingFlatWebhookMaps } =
+      await this.workspaceManyOrAllFlatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps(
+        {
+          workspaceId,
+          flatMapsKeys: ['flatWebhookMaps'],
+        },
+      );
+
+    const flatWebhookToDelete = fromDeleteWebhookInputToFlatWebhookOrThrow({
+      flatWebhookMaps: existingFlatWebhookMaps,
+      webhookId: id,
+    });
+
+    const validateAndBuildResult =
+      await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigration(
+        {
+          allFlatEntityOperationByMetadataName: {
+            webhook: {
+              flatEntityToCreate: [],
+              flatEntityToDelete: [flatWebhookToDelete],
+              flatEntityToUpdate: [],
+            },
+          },
+          workspaceId,
+        },
+      );
+
+    if (isDefined(validateAndBuildResult)) {
+      throw new WorkspaceMigrationBuilderException(
+        validateAndBuildResult,
+        'Multiple validation errors occurred while deleting webhook',
+      );
+    }
+
+    return fromFlatWebhookToWebhookDto(flatWebhookToDelete);
+  }
+}