Merge pull request novuhq#726 from novuhq/NV-550-Validate-that-each-t…

…rigger-has-a-subscriberId

feat: subscriber id validation

apps/api/src/app/events/events.controller.ts

@@ -16,16 +16,7 @@ export class EventsController {
   @UseGuards(JwtAuthGuard)
   @Post('/trigger')
   trackEvent(@UserSession() user: IJwtPayload, @Body() body: TriggerEventDto) {
-    const subscribers = Array.isArray(body.to) ? body.to : [body.to];
-    const mappedSubscribers: ISubscribersDefine[] = subscribers.map((subscriber) => {
-      if (typeof subscriber === 'string') {
-        return {
-          subscriberId: subscriber,
-        };
-      } else {
-        return subscriber;
-      }
-    });
+    const mappedSubscribers = this.mapSubscribers(body);
 
     return this.triggerEvent.execute(
       TriggerEventCommand.create({
@@ -39,4 +30,18 @@ export class EventsController {
       })
     );
   }
+
+  private mapSubscribers(body: TriggerEventDto): ISubscribersDefine[] {
+    const subscribers = Array.isArray(body.to) ? body.to : [body.to];
+
+    return subscribers.map((subscriber) => {
+      if (typeof subscriber === 'string') {
+        return {
+          subscriberId: subscriber,
+        };
+      } else {
+        return subscriber;
+      }
+    });
+  }
 }

apps/api/src/app/events/usecases/trigger-event/trigger-event.usecase.ts

@@ -11,6 +11,7 @@ import { ProcessSubscriberCommand } from '../process-subscriber/process-subscrib
 import { matchMessageWithFilters } from './message-filter.matcher';
 import { WorkflowQueueService } from '../../services/workflow.queue.service';
 import { ANALYTICS_SERVICE } from '../../../shared/shared.module';
+import { ApiException } from '../../../shared/exceptions/api.exception';
 
 @Injectable()
 export class TriggerEvent {
@@ -31,6 +32,8 @@ export class TriggerEvent {
       },
     });
 
+    await this.validateSubscriberIdProperty(command);
+
     this.logEventTriggered(command);
 
     const template = await this.notificationTemplateRepository.findByTriggerIdentifier(
@@ -153,4 +156,41 @@ export class TriggerEvent {
       // eslint-disable-next-line no-console
       .catch((e) => console.error(e));
   }
+
+  private async validateSubscriberIdProperty(command: TriggerEventCommand): Promise<boolean> {
+    for (const subscriber of command.to) {
+      const subscriberIdExists = typeof subscriber === 'string' ? subscriber : subscriber.subscriberId;
+
+      if (!subscriberIdExists) {
+        await this.logSubscriberIdMissing(command);
+        throw new ApiException(
+          'subscriberId under property to is not configured, please make sure all the subscriber contains subscriberId property'
+        );
+      }
+    }
+
+    return true;
+  }
+
+  private async logSubscriberIdMissing(command: TriggerEventCommand) {
+    await this.createLogUsecase.execute(
+      CreateLogCommand.create({
+        transactionId: command.transactionId,
+        status: LogStatusEnum.ERROR,
+        environmentId: command.environmentId,
+        organizationId: command.organizationId,
+        text: 'SubscriberId missing in to property',
+        userId: command.userId,
+        code: LogCodeEnum.SUBSCRIBER_ID_MISSING,
+        raw: {
+          triggerIdentifier: command.identifier,
+        },
+      })
+    );
+
+    return {
+      acknowledged: true,
+      status: 'subscriber_id_missing',
+    };
+  }
 }

libs/shared/src/entities/log/log.enums.ts

@@ -16,6 +16,7 @@ export enum LogCodeEnum {
   SUBSCRIBER_NOT_FOUND = 3003,
   SUBSCRIBER_MISSING_EMAIL = 3002,
   SUBSCRIBER_MISSING_PHONE = 3003,
+  SUBSCRIBER_ID_MISSING = 3004,
   MISSING_EMAIL_INTEGRATION = 3004,
   MISSING_SMS_INTEGRATION = 3005,
 }