feat(api-service): provider trigger overrides alignment (#7448)

scopsy · web-flow · commit 906cefa6cfef · 2025-05-06T20:45:35.000+03:00
diff --git a/apps/api/src/app/events/dtos/trigger-event-request.dto.ts b/apps/api/src/app/events/dtos/trigger-event-request.dto.ts
@@ -2,6 +2,9 @@ import { IsDefined, IsObject, IsOptional, IsString, ValidateIf, ValidateNested }
 import { Type } from 'class-transformer';
 import { ApiExtraModels, ApiHideProperty, ApiProperty, ApiPropertyOptional, getSchemaPath } from '@nestjs/swagger';
 import {
+  EmailProviderIdEnum,
+  ProvidersIdEnum,
+  ProvidersIdEnumConst,
   TriggerRecipientsPayload,
   TriggerRecipientsTypeEnum,
   TriggerRecipientSubscriber,
@@ -24,9 +27,9 @@ export class WorkflowToStepControlValuesDto {
     type: 'object',
     additionalProperties: {
       type: 'object',
-      additionalProperties: true, // Allows any additional properties
+      additionalProperties: true,
     },
-    required: false, // Indicates that this property is optional
+    required: false,
   })
   steps?: Record<string, Record<string, unknown>>;
 }
@@ -45,7 +48,59 @@ export class TopicPayloadDto {
   type: TriggerRecipientsTypeEnum;
 }
 
-@ApiExtraModels(SubscriberPayloadDto, TenantPayloadDto, TopicPayloadDto)
+export class StepsOverrides {
+  @ApiProperty({
+    description: 'Passing the provider id and the provider specific configurations',
+    example: {
+      sendgrid: {
+        templateId: '1234567890',
+      },
+    },
+    type: 'object',
+    additionalProperties: {
+      type: 'object',
+      additionalProperties: true,
+    },
+  })
+  providers: Record<ProvidersIdEnum, Record<string, unknown>>;
+}
+
+export class TriggerOverrides {
+  @ApiProperty({
+    description: 'This could be used to override provider specific configurations',
+    example: {
+      'email-step': {
+        providers: {
+          sendgrid: {
+            templateId: '1234567890',
+          },
+        },
+      },
+    },
+    type: 'object',
+    additionalProperties: {
+      $ref: getSchemaPath(StepsOverrides),
+    },
+  })
+  steps?: Record<string, StepsOverrides>;
+
+  @ApiProperty({
+    description: 'Overrides the provider configuration for the entire workflow and all steps',
+    example: {
+      sendgrid: {
+        templateId: '1234567890',
+      },
+    },
+    type: 'object',
+    additionalProperties: {
+      type: 'object',
+      additionalProperties: true,
+    },
+  })
+  providers?: Record<ProvidersIdEnum, Record<string, unknown>>;
+}
+
+@ApiExtraModels(SubscriberPayloadDto, TenantPayloadDto, TopicPayloadDto, StepsOverrides)
 export class TriggerEventRequestDto {
   @SdkApiProperty(
     {
@@ -91,16 +146,16 @@ export class TriggerEventRequestDto {
         },
       },
     },
-    type: 'object',
+    type: TriggerOverrides,
     additionalProperties: {
       type: 'object',
-      additionalProperties: true, // Allows any additional properties
+      additionalProperties: true,
     },
-    required: false, // Indicates that this property is optional
+    required: false,
   })
   @IsObject()
   @IsOptional()
-  overrides?: Record<string, Record<string, unknown>>;
+  overrides?: TriggerOverrides;
 
   @ApiProperty({
     description: 'The recipients list of people who will receive the notification.',
diff --git a/apps/api/src/app/events/dtos/trigger-event-to-all-request.dto.ts b/apps/api/src/app/events/dtos/trigger-event-to-all-request.dto.ts
@@ -3,7 +3,7 @@ import { Type } from 'class-transformer';
 import { ApiProperty, ApiPropertyOptional, getSchemaPath } from '@nestjs/swagger';
 import { TriggerRecipientSubscriber, TriggerTenantContext } from '@novu/shared';
 
-import { SubscriberPayloadDto, TenantPayloadDto } from './trigger-event-request.dto';
+import { SubscriberPayloadDto, TenantPayloadDto, TriggerOverrides } from './trigger-event-request.dto';
 
 export class TriggerEventToAllRequestDto {
   @ApiProperty({
@@ -40,10 +40,16 @@ export class TriggerEventToAllRequestDto {
         },
       },
     },
+    type: TriggerOverrides,
+    additionalProperties: {
+      type: 'object',
+      additionalProperties: true,
+    },
+    required: false,
   })
   @IsObject()
   @IsOptional()
-  overrides?: Record<string, Record<string, unknown>>;
+  overrides?: TriggerOverrides;
 
   @ApiProperty({
     description: 'A unique identifier for this transaction, we will generated a UUID if not provided.',
diff --git a/apps/api/src/app/events/events.controller.ts b/apps/api/src/app/events/events.controller.ts
@@ -138,7 +138,7 @@ export class EventsController {
   })
   @ApiCreatedResponse({
     description: 'Broadcast request has been registered successfully ',
-    type: TriggerEventResponseDto, // Specify the response type
+    type: TriggerEventResponseDto,
   })
   async broadcastEventToAll(
     @UserSession() user: UserSessionData,
diff --git a/apps/api/src/app/events/usecases/parse-event-request/parse-event-request.command.ts b/apps/api/src/app/events/usecases/parse-event-request/parse-event-request.command.ts
@@ -6,6 +6,7 @@ import {
   TriggerRecipientSubscriber,
   TriggerRequestCategoryEnum,
   TriggerTenantContext,
+  TriggerOverrides,
 } from '@novu/shared';
 
 import { EnvironmentWithUserCommand } from '../../../shared/commands/project.command';
@@ -19,7 +20,7 @@ export class ParseEventRequestBaseCommand extends EnvironmentWithUserCommand {
   payload: any; // eslint-disable-line @typescript-eslint/no-explicit-any
 
   @IsDefined()
-  overrides: Record<string, Record<string, unknown>>;
+  overrides: TriggerOverrides;
 
   @IsString()
   @IsOptional()
diff --git a/apps/api/src/app/events/usecases/trigger-event-to-all/trigger-event-to-all.command.ts b/apps/api/src/app/events/usecases/trigger-event-to-all/trigger-event-to-all.command.ts
@@ -1,5 +1,5 @@
 import { IsDefined, IsObject, IsOptional, IsString } from 'class-validator';
-import { TriggerRecipientSubscriber, TriggerTenantContext } from '@novu/shared';
+import { TriggerOverrides, TriggerRecipientSubscriber, TriggerTenantContext } from '@novu/shared';
 
 import { EnvironmentWithUserCommand } from '../../../shared/commands/project.command';
 
@@ -17,7 +17,7 @@ export class TriggerEventToAllCommand extends EnvironmentWithUserCommand {
 
   @IsObject()
   @IsOptional()
-  overrides: Record<string, Record<string, unknown>>;
+  overrides?: TriggerOverrides;
 
   @IsOptional()
   actor?: TriggerRecipientSubscriber | null;
diff --git a/apps/api/src/app/events/usecases/trigger-event-to-all/trigger-event-to-all.usecase.ts b/apps/api/src/app/events/usecases/trigger-event-to-all/trigger-event-to-all.usecase.ts
@@ -1,16 +1,12 @@
 import { Injectable } from '@nestjs/common';
-import { SubscriberRepository } from '@novu/dal';
 import { AddressingTypeEnum, TriggerEventStatusEnum, TriggerRequestCategoryEnum } from '@novu/shared';
 
 import { TriggerEventToAllCommand } from './trigger-event-to-all.command';
 import { ParseEventRequest, ParseEventRequestBroadcastCommand } from '../parse-event-request';
 
 @Injectable()
 export class TriggerEventToAll {
-  constructor(
-    private subscriberRepository: SubscriberRepository,
-    private parseEventRequest: ParseEventRequest
-  ) {}
+  constructor(private parseEventRequest: ParseEventRequest) {}
 
   public async execute(command: TriggerEventToAllCommand) {
     await this.parseEventRequest.execute(
diff --git a/apps/worker/src/app/workflow/usecases/send-message/send-message-chat.usecase.ts b/apps/worker/src/app/workflow/usecases/send-message/send-message-chat.usecase.ts
@@ -450,10 +450,14 @@ export class SendMessageChat extends SendMessageBase {
         ...(command.overrides[integration?.channel] || {}),
         ...(command.overrides[integration?.providerId] || {}),
       };
-      const bridgeProviderData = command.bridgeData?.providers?.[integration.providerId] || {};
 
       const result = await chatHandler.send({
-        bridgeProviderData,
+        bridgeProviderData: this.combineOverrides(
+          command.bridgeData,
+          command.overrides,
+          command.step.stepId,
+          integration.providerId
+        ),
         phoneNumber,
         customData: overrides,
         webhookUrl: chatWebhookUrl,
diff --git a/apps/worker/src/app/workflow/usecases/send-message/send-message-email.usecase.ts b/apps/worker/src/app/workflow/usecases/send-message/send-message-email.usecase.ts
@@ -457,10 +457,17 @@ export class SendMessageEmail extends SendMessageBase {
   ): Promise<SendMessageResult> {
     const mailFactory = new MailFactory();
     const mailHandler = mailFactory.getHandler(this.buildFactoryIntegration(integration), mailData.from);
-    const bridgeProviderData = command.bridgeData?.providers?.[integration.providerId] || {};
 
     try {
-      const result = await mailHandler.send({ ...mailData, bridgeProviderData });
+      const result = await mailHandler.send({
+        ...mailData,
+        bridgeProviderData: this.combineOverrides(
+          command.bridgeData,
+          command.overrides,
+          command.step.stepId,
+          integration.providerId
+        ),
+      });
 
       Logger.verbose({ command }, 'Email message has been sent', LOG_CONTEXT);
 
diff --git a/apps/worker/src/app/workflow/usecases/send-message/send-message-push.usecase.ts b/apps/worker/src/app/workflow/usecases/send-message/send-message-push.usecase.ts
@@ -292,7 +292,6 @@ export class SendMessagePush extends SendMessageBase {
     try {
       const pushHandler = this.getIntegrationHandler(integration);
       const bridgeOutputs = command.bridgeData?.outputs;
-      const bridgeProviderData = command.bridgeData?.providers?.[integration.providerId] || {};
 
       const result = await pushHandler.send({
         target: [deviceToken],
@@ -302,7 +301,12 @@ export class SendMessagePush extends SendMessageBase {
         overrides,
         subscriber,
         step,
-        bridgeProviderData,
+        bridgeProviderData: this.combineOverrides(
+          command.bridgeData,
+          command.overrides,
+          command.step.stepId,
+          integration.providerId
+        ),
       });
 
       await this.createExecutionDetails.execute(
diff --git a/apps/worker/src/app/workflow/usecases/send-message/send-message-sms.usecase.ts b/apps/worker/src/app/workflow/usecases/send-message/send-message-sms.usecase.ts
@@ -2,13 +2,7 @@ import { Injectable } from '@nestjs/common';
 import { addBreadcrumb } from '@sentry/node';
 import { ModuleRef } from '@nestjs/core';
 
-import {
-  MessageRepository,
-  NotificationStepEntity,
-  SubscriberRepository,
-  MessageEntity,
-  IntegrationEntity,
-} from '@novu/dal';
+import { MessageRepository, SubscriberRepository, MessageEntity, IntegrationEntity } from '@novu/dal';
 import { ChannelTypeEnum, LogCodeEnum, ExecutionDetailsSourceEnum, ExecutionDetailsStatusEnum } from '@novu/shared';
 import {
   InstrumentUsecase,
@@ -299,15 +293,19 @@ export class SendMessageSms extends SendMessageBase {
       if (!smsHandler) {
         throw new PlatformException(`Sms handler for provider ${integration.providerId} is  not found`);
       }
-      const bridgeProviderData = command.bridgeData?.providers?.[integration.providerId] || {};
 
       const result = await smsHandler.send({
         to: overrides.to || phone,
         from: overrides.from || integration.credentials.from,
         content: bridgeBody || overrides.content || content,
         id: message._id,
         customData: overrides.customData || {},
-        bridgeProviderData,
+        bridgeProviderData: this.combineOverrides(
+          command.bridgeData,
+          command.overrides,
+          command.step.stepId,
+          integration.providerId
+        ),
       });
 
       await this.createExecutionDetails.execute(
diff --git a/apps/worker/src/app/workflow/usecases/send-message/send-message.base.ts b/apps/worker/src/app/workflow/usecases/send-message/send-message.base.ts
@@ -19,6 +19,7 @@ import {
 } from '@novu/shared';
 import { format } from 'date-fns';
 import i18next from 'i18next';
+import { merge } from 'lodash';
 
 import {
   CreateExecutionDetails,
@@ -48,6 +49,19 @@ export abstract class SendMessageBase extends SendMessageType {
     super(messageRepository, createExecutionDetails);
   }
 
+  protected combineOverrides(
+    bridgeData: Record<string, any> | null | undefined,
+    overrides: Record<string, any> | undefined,
+    stepId: string | undefined,
+    integrationId: string
+  ): Record<string, unknown> {
+    const bridgeProviderData = bridgeData?.providers?.[integrationId] || {};
+    const workflowGlobalProviderOverrides = overrides?.providers?.[integrationId] || {};
+    const triggerOverrides = stepId ? overrides?.steps?.[stepId]?.providers[integrationId] || {} : {};
+
+    return merge({}, bridgeProviderData, workflowGlobalProviderOverrides, triggerOverrides);
+  }
+
   protected async getIntegration(params: {
     id?: string;
     providerId?: ProvidersIdEnum;
diff --git a/apps/worker/src/app/workflow/usecases/send-message/send-message.command.ts b/apps/worker/src/app/workflow/usecases/send-message/send-message.command.ts
@@ -2,7 +2,7 @@ import { IsDefined, IsOptional, IsString } from 'class-validator';
 import { NotificationStepEntity, JobEntity } from '@novu/dal';
 import { EnvironmentWithUserCommand } from '@novu/application-generic';
 import { ExecuteOutput } from '@novu/framework/internal';
-import { WorkflowPreferences } from '@novu/shared';
+import { WorkflowPreferences, TriggerOverrides } from '@novu/shared';
 
 export class SendMessageCommand extends EnvironmentWithUserCommand {
   @IsDefined()
@@ -16,7 +16,7 @@ export class SendMessageCommand extends EnvironmentWithUserCommand {
   compileContext?: any; // eslint-disable-line @typescript-eslint/no-explicit-any
 
   @IsDefined()
-  overrides: Record<string, Record<string, unknown>>;
+  overrides: TriggerOverrides;
 
   @IsDefined()
   step: NotificationStepEntity;
diff --git a/apps/worker/src/app/workflow/usecases/subscriber-job-bound/subscriber-job-bound.command.ts b/apps/worker/src/app/workflow/usecases/subscriber-job-bound/subscriber-job-bound.command.ts
@@ -5,6 +5,7 @@ import {
   ITenantDefine,
   StatelessControls,
   SubscriberSourceEnum,
+  TriggerOverrides,
   TriggerRequestCategoryEnum,
 } from '@novu/shared';
 import { SubscriberEntity } from '@novu/dal';
@@ -24,7 +25,7 @@ export class SubscriberJobBoundCommand extends EnvironmentWithUserCommand {
   identifier: string;
 
   @IsDefined()
-  overrides: Record<string, Record<string, unknown>>;
+  overrides: TriggerOverrides;
 
   @IsOptional()
   @ValidateNested()
diff --git a/libs/application-generic/src/dtos/process-subscriber-job.dto.ts b/libs/application-generic/src/dtos/process-subscriber-job.dto.ts
@@ -3,15 +3,13 @@ import {
   ITenantDefine,
   StatelessControls,
   SubscriberSourceEnum,
+  TriggerOverrides,
   TriggerRequestCategoryEnum,
 } from '@novu/shared';
 import { SubscriberEntity } from '@novu/dal';
 import { DiscoverWorkflowOutput } from '@novu/framework/internal';
 
-import {
-  IBulkJobParams,
-  IJobParams,
-} from '../services/queues/queue-base.service';
+import { IBulkJobParams, IJobParams } from '../services/queues/queue-base.service';
 
 export interface IProcessSubscriberDataDto {
   environmentId: string;
@@ -21,7 +19,7 @@ export interface IProcessSubscriberDataDto {
   transactionId: string;
   identifier: string;
   payload: any;
-  overrides: Record<string, Record<string, unknown>>;
+  overrides: TriggerOverrides;
   tenant?: ITenantDefine;
   actor?: SubscriberEntity;
   subscriber: ISubscribersDefine;
diff --git a/libs/application-generic/src/dtos/workflow-job.dto.ts b/libs/application-generic/src/dtos/workflow-job.dto.ts
diff --git a/libs/application-generic/src/usecases/create-notification-jobs/create-notification-jobs.command.ts b/libs/application-generic/src/usecases/create-notification-jobs/create-notification-jobs.command.ts
diff --git a/libs/application-generic/src/usecases/trigger-event/trigger-event.command.ts b/libs/application-generic/src/usecases/trigger-event/trigger-event.command.ts
diff --git a/libs/dal/src/repositories/job/job.entity.ts b/libs/dal/src/repositories/job/job.entity.ts
diff --git a/packages/framework/src/index.ts b/packages/framework/src/index.ts
diff --git a/packages/shared/src/dto/events/event.interface.ts b/packages/shared/src/dto/events/event.interface.ts
