feat: refactor usecase position

Author: scopsy

apps/api/src/app/bridge/bridge.module.ts

@@ -24,6 +24,7 @@ import { USECASES } from './usecases';
 import { BuildVariableSchemaUsecase } from '../workflows-v2/usecases';
 import { CreateVariablesObject } from '../workflows-v2/usecases/create-variables-object/create-variables-object.usecase';
 import { BuildStepIssuesUsecase } from '../workflows-v2/usecases/build-step-issues/build-step-issues.usecase';
+import { WebhooksModule } from '../webhooks/webhooks.module';
 
 const PROVIDERS = [
   CreateWorkflow,
@@ -51,7 +52,7 @@ const PROVIDERS = [
 ];
 
 @Module({
-  imports: [SharedModule],
+  imports: [SharedModule, WebhooksModule],
   providers: [...PROVIDERS, ...USECASES],
   controllers: [BridgeController],
   exports: [...USECASES],

apps/api/src/app/webhooks/dtos/webhook-payload.dto.ts

@@ -1,59 +1,5 @@
-import { ApiProperty } from '@nestjs/swagger';
-import { WorkflowResponseDto } from '../../workflows-v2/dtos/workflow-response.dto';
+import { WebhookEventEnum, WebhookObjectTypeEnum } from '@novu/shared';
+import { WrapperDto } from '@novu/application-generic';
 
-export enum WebhookEventEnum {
-  WORKFLOW_CREATED = 'workflow.created',
-  WORKFLOW_UPDATED = 'workflow.updated',
-  WORKFLOW_DELETED = 'workflow.deleted',
-}
-
-export enum WebhookObjectTypeEnum {
-  WORKFLOW = 'workflow',
-}
-
-export class WrapperDto<T> {
-  @ApiProperty({
-    description: 'The type of the webhook',
-    enum: WebhookEventEnum,
-  })
-  type: WebhookEventEnum;
-
-  @ApiProperty({
-    description: 'The payload of the webhook',
-    type: 'object',
-  })
-  data: T;
-
-  @ApiProperty({
-    description: 'The timestamp of the webhook',
-    type: 'string',
-  })
-  timestamp: string;
-
-  @ApiProperty({
-    description: 'The environment connected to the webhook',
-    type: 'string',
-  })
-  environmentId: string;
-
-  @ApiProperty({
-    description: 'The object of the webhook',
-    enum: WebhookObjectTypeEnum,
-  })
-  object: WebhookObjectTypeEnum;
-}
-
-export class WorkflowUpdatedWebhookDto extends WrapperDto<WorkflowResponseDto> {
-  type: WebhookEventEnum.WORKFLOW_UPDATED;
-  object: WebhookObjectTypeEnum.WORKFLOW;
-}
-
-export class WorkflowCreatedWebhookDto extends WrapperDto<WorkflowResponseDto> {
-  type: WebhookEventEnum.WORKFLOW_CREATED;
-  object: WebhookObjectTypeEnum.WORKFLOW;
-}
-
-export class WorkflowDeletedWebhookDto extends WrapperDto<WorkflowResponseDto> {
-  type: WebhookEventEnum.WORKFLOW_DELETED;
-  object: WebhookObjectTypeEnum.WORKFLOW;
-}
+// Re-export for backward compatibility
+export { WebhookEventEnum, WebhookObjectTypeEnum, WrapperDto };

apps/api/src/app/webhooks/usecases/send-webhook-message/send-webhook-message.command.ts

@@ -1,21 +1,33 @@
 import { WebhookEventEnum, WebhookObjectTypeEnum } from './dtos/webhook-payload.dto';
 import { WorkflowResponseDto } from '../workflows-v2/dtos/workflow-response.dto';
 
+export class WebhookUpdatedWorkflowDto {
+  object: WorkflowResponseDto;
+  previousObject: WorkflowResponseDto;
+}
+
+export class WebhookCreatedWorkflowDto {
+  object: WorkflowResponseDto;
+}
+
+export class WebhookDeletedWorkflowDto {
+  object: WorkflowResponseDto;
+}
+
 export const webhookEvents = [
   {
     event: WebhookEventEnum.WORKFLOW_UPDATED,
-    payloadDto: WorkflowResponseDto,
+    payloadDto: WebhookUpdatedWorkflowDto,
     objectType: WebhookObjectTypeEnum.WORKFLOW,
   },
   {
     event: WebhookEventEnum.WORKFLOW_CREATED,
-    payloadDto: WorkflowResponseDto,
+    payloadDto: WebhookCreatedWorkflowDto,
     objectType: WebhookObjectTypeEnum.WORKFLOW,
   },
   {
     event: WebhookEventEnum.WORKFLOW_DELETED,
-    payloadDto: WorkflowResponseDto,
+    payloadDto: WebhookDeletedWorkflowDto,
     objectType: WebhookObjectTypeEnum.WORKFLOW,
   },
-  // Add other webhook events here as needed
 ];

apps/api/src/app/webhooks/webhooks.const.ts

@@ -1,27 +1,13 @@
-import { Module, Provider } from '@nestjs/common';
-import { Svix } from 'svix'; // Import Svix SDK
+import { Module } from '@nestjs/common';
+import { SvixProviderService, SendWebhookMessage } from '@novu/application-generic';
 import { SharedModule } from '../shared/shared.module';
 import { WebhooksController } from './webhooks.controller';
 import { GetWebhookPortalTokenUsecase } from './usecases/get-webhook-portal-token/get-webhook-portal-token.usecase';
-import { SendWebhookMessage } from './usecases/send-webhook-message/send-webhook-message.usecase';
-
-// Define the custom provider for the Svix client
-const svixProvider: Provider = {
-  provide: 'SVIX_CLIENT', // The injection token used in the use case
-  useFactory: () => {
-    const apiKey = process.env.SVIX_API_KEY;
-    if (!apiKey) {
-      throw new Error('SVIX_API_KEY environment variable is not set.');
-    }
-
-    return new Svix(apiKey || '');
-  },
-};
 
 @Module({
   imports: [SharedModule],
   controllers: [WebhooksController],
-  providers: [GetWebhookPortalTokenUsecase, svixProvider, SendWebhookMessage],
+  providers: [GetWebhookPortalTokenUsecase, SvixProviderService, SendWebhookMessage],
   exports: [SendWebhookMessage],
 })
 export class WebhooksModule {}

apps/api/src/app/webhooks/webhooks.module.ts

@@ -8,9 +8,18 @@ import { NotificationTemplateController } from './notification-template.controll
 import { USE_CASES } from './usecases';
 import { WorkflowControllerV1 } from './workflow-v1.controller';
 import { PreferencesModule } from '../preferences';
+import { WebhooksModule } from '../webhooks/webhooks.module';
 
 @Module({
-  imports: [SharedModule, MessageTemplateModule, ChangeModule, AuthModule, IntegrationModule, PreferencesModule],
+  imports: [
+    SharedModule,
+    MessageTemplateModule,
+    ChangeModule,
+    AuthModule,
+    IntegrationModule,
+    PreferencesModule,
+    WebhooksModule,
+  ],
   controllers: [NotificationTemplateController, WorkflowControllerV1],
   providers: [...USE_CASES],
   exports: [...USE_CASES],

apps/api/src/app/workflows-v1/workflow-v1.module.ts

@@ -1,12 +1,14 @@
 import { Injectable } from '@nestjs/common';
-import { UserSessionData, WorkflowStatusEnum } from '@novu/shared';
+import { UserSessionData, WebhookObjectTypeEnum, WebhookEventEnum, WorkflowStatusEnum } from '@novu/shared';
 import { NotificationTemplateEntity, NotificationTemplateRepository } from '@novu/dal';
-import { GetWorkflowWithPreferencesUseCase, WorkflowWithPreferencesResponseDto } from '@novu/application-generic';
-import { SendWebhookMessage } from '../../../webhooks/usecases/send-webhook-message/send-webhook-message.usecase';
+import {
+  GetWorkflowWithPreferencesUseCase,
+  SendWebhookMessage,
+  WorkflowWithPreferencesResponseDto,
+} from '@novu/application-generic';
 import { PatchWorkflowCommand } from './patch-workflow.command';
 import { GetWorkflowUseCase } from '../get-workflow';
 import { WorkflowResponseDto } from '../../dtos';
-import { WebhookEventEnum, WebhookObjectTypeEnum } from '../../../webhooks/dtos/webhook-payload.dto';
 
 @Injectable()
 export class PatchWorkflowUsecase {
@@ -30,7 +32,10 @@ export class PatchWorkflowUsecase {
     await this.sendWebhookMessage.execute({
       eventType: WebhookEventEnum.WORKFLOW_UPDATED,
       objectType: WebhookObjectTypeEnum.WORKFLOW,
-      payload: updatedWorkflow,
+      payload: {
+        object: updatedWorkflow,
+        previousObject: persistedWorkflow,
+      },
       organizationId: command.user.organizationId,
       environmentId: command.user.environmentId,
     });

apps/api/src/app/workflows-v2/usecases/patch-workflow/patch-workflow.usecase.ts

@@ -14,6 +14,7 @@ import {
   UpdateWorkflowCommand,
   UpsertControlValuesCommand,
   UpsertControlValuesUseCase,
+  SendWebhookMessage,
 } from '@novu/application-generic';
 import {
   ControlSchemas,
@@ -26,6 +27,8 @@ import {
   ControlValuesLevelEnum,
   DEFAULT_WORKFLOW_PREFERENCES,
   slugify,
+  WebhookEventEnum,
+  WebhookObjectTypeEnum,
   WorkflowCreationSourceEnum,
   WorkflowOriginEnum,
   WorkflowTypeEnum,
@@ -37,8 +40,6 @@ import { BuildStepIssuesUsecase } from '../build-step-issues/build-step-issues.u
 import { GetWorkflowCommand, GetWorkflowUseCase } from '../get-workflow';
 import { UpsertStepDataCommand, UpsertWorkflowCommand } from './upsert-workflow.command';
 import { StepIssuesDto, WorkflowResponseDto } from '../../dtos';
-import { SendWebhookMessage } from '../../../webhooks/usecases/send-webhook-message/send-webhook-message.usecase';
-import { WebhookEventEnum, WebhookObjectTypeEnum } from '../../../webhooks/dtos/webhook-payload.dto';
 
 @Injectable()
 export class UpsertWorkflowUseCase {
@@ -94,13 +95,28 @@ export class UpsertWorkflowUseCase {
       })
     );
 
-    await this.sendWebhookMessage.execute({
-      eventType: WebhookEventEnum.WORKFLOW_UPDATED,
-      objectType: WebhookObjectTypeEnum.WORKFLOW,
-      payload: updatedWorkflow,
-      organizationId: command.user.organizationId,
-      environmentId: command.user.environmentId,
-    });
+    if (existingWorkflow) {
+      await this.sendWebhookMessage.execute({
+        eventType: WebhookEventEnum.WORKFLOW_UPDATED,
+        objectType: WebhookObjectTypeEnum.WORKFLOW,
+        payload: {
+          object: updatedWorkflow,
+          previousObject: existingWorkflow,
+        },
+        organizationId: command.user.organizationId,
+        environmentId: command.user.environmentId,
+      });
+    } else {
+      await this.sendWebhookMessage.execute({
+        eventType: WebhookEventEnum.WORKFLOW_CREATED,
+        objectType: WebhookObjectTypeEnum.WORKFLOW,
+        payload: {
+          object: updatedWorkflow,
+        },
+        organizationId: command.user.organizationId,
+        environmentId: command.user.environmentId,
+      });
+    }
 
     return updatedWorkflow;
   }

apps/api/src/app/workflows-v2/usecases/upsert-workflow/upsert-workflow.usecase.ts

@@ -81,6 +81,7 @@
     "ioredis": "^5.2.4",
     "jsonwebtoken": "9.0.0",
     "@launchdarkly/node-server-sdk": "^9.7.3",
+    "svix": "^1.64.1",
     "lodash": "^4.17.15",
     "mixpanel": "^0.17.0",
     "nanoid": "^3.1.20",

libs/application-generic/package.json

@@ -18,3 +18,4 @@ export * from './utils';
 export * from './schemas/control';
 export * from './services/resource-validator.service';
 export * from './value-objects';
+export * from './webhooks';

libs/application-generic/src/index.ts

@@ -5,13 +5,14 @@ import {
   NotificationTemplateEntity,
   NotificationTemplateRepository,
 } from '@novu/dal';
-import { PreferencesTypeEnum } from '@novu/shared';
+import { PreferencesTypeEnum, WebhookEventEnum, WebhookObjectTypeEnum } from '@novu/shared';
 
 import { DeleteWorkflowCommand } from './delete-workflow.command';
 import { GetWorkflowByIdsUseCase } from '../get-workflow-by-ids/get-workflow-by-ids.usecase';
 import { GetWorkflowWithPreferencesCommand } from '../get-workflow-with-preferences/get-workflow-with-preferences.command';
 import { DeletePreferencesUseCase, DeletePreferencesCommand } from '../../delete-preferences';
 import { Instrument, InstrumentUsecase } from '../../../instrumentation';
+import { SendWebhookMessage } from '../../../webhooks/usecases/send-webhook-message/send-webhook-message.usecase';
 
 @Injectable()
 export class DeleteWorkflowUseCase {
@@ -20,7 +21,8 @@ export class DeleteWorkflowUseCase {
     private messageTemplateRepository: MessageTemplateRepository,
     private getWorkflowByIdsUseCase: GetWorkflowByIdsUseCase,
     private controlValuesRepository: ControlValuesRepository,
-    private deletePreferencesUsecase: DeletePreferencesUseCase
+    private deletePreferencesUsecase: DeletePreferencesUseCase,
+    private sendWebhookMessage: SendWebhookMessage
   ) {}
 
   @InstrumentUsecase()
@@ -33,6 +35,16 @@ export class DeleteWorkflowUseCase {
     );
 
     await this.deleteRelatedEntities(command, workflowEntity);
+
+    await this.sendWebhookMessage.execute({
+      eventType: WebhookEventEnum.WORKFLOW_DELETED,
+      objectType: WebhookObjectTypeEnum.WORKFLOW,
+      payload: {
+        object: workflowEntity,
+      },
+      organizationId: command.organizationId,
+      environmentId: command.environmentId,
+    });
   }
 
   @Instrument()

libs/application-generic/src/usecases/workflow/delete-workflow/delete-workflow.usecase.ts

@@ -0,0 +1 @@
+export * from './webhook-payload.dto';

libs/application-generic/src/webhooks/dtos/index.ts

@@ -0,0 +1,34 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { WebhookEventEnum, WebhookObjectTypeEnum } from '@novu/shared';
+
+export class WrapperDto<T> {
+  @ApiProperty({
+    description: 'The type of the webhook',
+    enum: WebhookEventEnum,
+  })
+  type: WebhookEventEnum;
+
+  @ApiProperty({
+    description: 'The payload of the webhook',
+    type: 'object',
+  })
+  data: T;
+
+  @ApiProperty({
+    description: 'The timestamp of the webhook',
+    type: 'string',
+  })
+  timestamp: string;
+
+  @ApiProperty({
+    description: 'The environment connected to the webhook',
+    type: 'string',
+  })
+  environmentId: string;
+
+  @ApiProperty({
+    description: 'The object of the webhook',
+    enum: WebhookObjectTypeEnum,
+  })
+  object: WebhookObjectTypeEnum;
+}

libs/application-generic/src/webhooks/dtos/webhook-payload.dto.ts

@@ -0,0 +1,3 @@
+export * from './dtos';
+export * from './services';
+export * from './usecases';

libs/application-generic/src/webhooks/index.ts

@@ -0,0 +1 @@
+export * from './svix-provider.service';