fix: optional condition for few fields

Basfar · Jun 22, 2023 · 1325672 · 1325672
1 parent 3a454d6
commit 1325672
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 45 deletions.
diff --git a/apps/api/src/app/messages/dtos/get-messages-requests.dto.ts b/apps/api/src/app/messages/dtos/get-messages-requests.dto.ts
@@ -1,4 +1,4 @@
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { ApiPropertyOptional } from '@nestjs/swagger';
 import { ChannelTypeEnum } from '@novu/shared';
 import { IsNumber } from 'class-validator';
 import { Transform } from 'class-transformer';
@@ -7,12 +7,12 @@ export class GetMessagesRequestDto {
   @ApiPropertyOptional({
     enum: ChannelTypeEnum,
   })
-  channel: ChannelTypeEnum;
+  channel?: ChannelTypeEnum;
 
-  @ApiProperty({
+  @ApiPropertyOptional({
     type: String,
   })
-  subscriberId: string;
+  subscriberId?: string;
 
   @ApiPropertyOptional({
     type: String,

diff --git a/apps/api/src/app/messages/usecases/get-messages/get-messages.command.ts b/apps/api/src/app/messages/usecases/get-messages/get-messages.command.ts
@@ -4,18 +4,16 @@ import { EnvironmentCommand } from '../../../shared/commands/project.command';
 
 export class GetMessagesCommand extends EnvironmentCommand {
   @IsOptional()
-  subscriberId: string;
+  subscriberId?: string;
 
   @IsOptional()
-  channel: ChannelTypeEnum;
+  channel?: ChannelTypeEnum;
 
   @IsNumber()
-  @IsOptional()
-  page: number;
+  page = 0;
 
   @IsNumber()
-  @IsOptional()
-  limit: number;
+  limit = 10;
 
   @IsOptional()
   @IsArray()

diff --git a/apps/api/src/app/messages/usecases/get-messages/get-messages.usecase.ts b/apps/api/src/app/messages/usecases/get-messages/get-messages.usecase.ts
@@ -1,13 +1,13 @@
-import { BadRequestException, Injectable, NotFoundException } from '@nestjs/common';
-import { MessageEntity, MessageRepository, SubscriberRepository, SubscriberEntity } from '@novu/dal';
-import { CachedEntity, buildSubscriberKey } from '@novu/application-generic';
+import { BadRequestException, Injectable } from '@nestjs/common';
+import { MessageEntity, MessageRepository, SubscriberEntity } from '@novu/dal';
 import { ActorTypeEnum } from '@novu/shared';
 
 import { GetMessagesCommand } from './get-messages.command';
+import { GetSubscriber, GetSubscriberCommand } from '../../../subscribers/usecases/get-subscriber';
 
 @Injectable()
 export class GetMessages {
-  constructor(private messageRepository: MessageRepository, private subscriberRepository: SubscriberRepository) {}
+  constructor(private messageRepository: MessageRepository, private getSubscriberUseCase: GetSubscriber) {}
 
   async execute(command: GetMessagesCommand) {
     const LIMIT = command.limit;
@@ -23,12 +23,13 @@ export class GetMessages {
       };
 
     if (command.subscriberId) {
-      const subscriber = await this.fetchSubscriber({
-        _environmentId: command.environmentId,
-        subscriberId: command.subscriberId,
-      });
-
-      if (!subscriber) throw new NotFoundException(`Subscriber ${command.subscriberId} not found`);
+      const subscriber = await this.getSubscriberUseCase.execute(
+        GetSubscriberCommand.create({
+          subscriberId: command.subscriberId,
+          environmentId: command.environmentId,
+          organizationId: command.organizationId,
+        })
+      );
 
       query._subscriberId = subscriber._id;
     }
@@ -81,23 +82,6 @@ export class GetMessages {
     return currentPaginationTotal < totalCount;
   }
 
-  @CachedEntity({
-    builder: (command: { subscriberId: string; _environmentId: string }) =>
-      buildSubscriberKey({
-        _environmentId: command._environmentId,
-        subscriberId: command.subscriberId,
-      }),
-  })
-  private async fetchSubscriber({
-    subscriberId,
-    _environmentId,
-  }: {
-    subscriberId: string;
-    _environmentId: string;
-  }): Promise<SubscriberEntity | null> {
-    return await this.subscriberRepository.findBySubscriberId(_environmentId, subscriberId);
-  }
-
   private processUserAvatar(actorSubscriber?: SubscriberEntity): string | null {
     return actorSubscriber?.avatar || null;
   }

diff --git a/apps/api/src/app/messages/usecases/index.ts b/apps/api/src/app/messages/usecases/index.ts
@@ -1,4 +1,5 @@
+import { GetSubscriber } from '../../subscribers/usecases/get-subscriber';
 import { GetMessages } from './get-messages';
 import { RemoveMessage } from './remove-message';
 
-export const USE_CASES = [RemoveMessage, GetMessages];
+export const USE_CASES = [RemoveMessage, GetMessages, GetSubscriber];
diff --git a/docs/docs/platform/messages.md b/docs/docs/platform/messages.md
@@ -31,7 +31,7 @@ await novu.messages.list({
   limit: 30,
   channel: ChannelTypeEnum.IN_APP,
   subscriberId: '123',
-  transactionId: ['transactionId1', 'transactionId2'],
+  transactionIds: ['transactionId1', 'transactionId2'],
 });
 ```
 
@@ -89,7 +89,7 @@ await novu.messages.list({
           "subscriberId": "subscriberId",
           "id": "_subscriberId"
       },
-      "actorSubscriber": null,
+      "actorSubscriber": 'actorSubscriberId',
       "id": "messageId"
     }
     ....

diff --git a/packages/node/src/lib/messages/messages.interface.ts b/packages/node/src/lib/messages/messages.interface.ts
@@ -10,5 +10,5 @@ export interface IMessagesPayload {
   limit?: number;
   subscriberId?: string;
   channel?: ChannelTypeEnum;
-  transactionId?: string[];
+  transactionIds?: string[];
 }
diff --git a/packages/node/src/lib/messages/messages.spec.ts b/packages/node/src/lib/messages/messages.spec.ts
@@ -77,7 +77,7 @@ describe('Novu Node.js package - Messages class', () => {
             __v: 0,
             content: [Array],
             subscriber: [Object],
-            actorSubscriber: null,
+            actorSubscriber: 'actorSubscriberId',
             id: '649070afaa9e50289df42134',
           },
         ],
@@ -89,7 +89,7 @@ describe('Novu Node.js package - Messages class', () => {
       page: 1,
       limit: 5,
       channel: ChannelTypeEnum.EMAIL,
-      transactionId: ['transactionId1', 'transactionId2'],
+      transactionIds: ['transactionId1', 'transactionId2'],
     });
 
     expect(mockedAxios.get).toHaveBeenCalled();

diff --git a/packages/node/src/lib/messages/messages.ts b/packages/node/src/lib/messages/messages.ts
@@ -6,12 +6,14 @@ const BASE_PATH = '/messages';
 
 export class Messages extends WithHttp implements IMessages {
   async list(data?: IMessagesPayload) {
-    const queryParams: Partial<IMessagesPayload> = {};
+    const queryParams: Partial<IMessagesPayload> & {
+      transactionId?: string[];
+    } = {};
     data?.page && (queryParams.page = data?.page);
     data?.limit && (queryParams.limit = data?.limit);
     data?.subscriberId && (queryParams.subscriberId = data?.subscriberId);
     data?.channel && (queryParams.channel = data?.channel);
-    data?.transactionId && (queryParams.transactionId = data?.transactionId);
+    data?.transactionIds && (queryParams.transactionId = data?.transactionIds);
 
     return await this.http.get(BASE_PATH, {
       params: queryParams,