feat(api): include profile name and photo in chat messages

Author: Johan Book

services/api/src/features/chat/application/contracts/dtos/chat-message-profile.dto.ts

@@ -0,0 +1,5 @@
+export class ChatMessageProfileDetails {
+  id!: number;
+  imageUrl?: string;
+  name!: string;
+}

services/api/src/features/chat/application/contracts/dtos/chat.dto.ts renamed to services/api/src/features/chat/application/contracts/dtos/chat-message.dto.ts

@@ -1,6 +1,9 @@
+import { ChatMessageProfileDetails } from "./chat-message-profile.dto";
+
 export class ChatMessageDetails {
   id!: number;
   message!: string;
-  read!: boolean;
+  profile!: ChatMessageProfileDetails;
   sentByCurrentUser!: boolean;
+  read!: boolean;
 }

services/api/src/features/chat/application/handlers/query-handlers/get-chat-messages.handler.spec.ts

@@ -25,6 +25,7 @@ describe(GetChatMessagesHandler.name, () => {
 
     const chatMessage = new ChatMessage();
     chatMessage.conversationId = conversation.id;
+    chatMessage.sender = sendingProfile;
     chatMessage.senderId = sendingProfile.id;
 
     chatMessages = createMockRepository<ChatMessage>([chatMessage]);
@@ -35,10 +36,13 @@ describe(GetChatMessagesHandler.name, () => {
       fetchCurrentProfileId: jest.fn(() => sendingProfile.id),
     } as any;
 
+    const photoService = { getUrl: jest.fn() } as any;
+
     queryHandler = new GetChatMessagesHandler(
       chatMessages,
       currentOrganizationService,
       currentProfileService,
+      photoService,
     );
   });
 

services/api/src/features/chat/application/handlers/query-handlers/get-chat-messages.handler.ts

@@ -2,12 +2,14 @@ import { IQueryHandler, QueryHandler } from "@nestjs/cqrs";
 import { InjectRepository } from "@nestjs/typeorm";
 import { Repository } from "typeorm";
 
-import { mapArray } from "src/core/mapper";
+import { map, mapArray } from "src/core/mapper";
 import { CurrentOrganizationService } from "src/core/organizations";
+import { PhotoService } from "src/core/photos";
 import { CurrentProfileService } from "src/core/profiles";
 
 import { ChatMessage } from "../../..//infrastructure/entities/chat-message.entity";
-import { ChatMessageDetails } from "../../contracts/dtos/chat.dto";
+import { ChatMessageProfileDetails } from "../../contracts/dtos/chat-message-profile.dto";
+import { ChatMessageDetails } from "../../contracts/dtos/chat-message.dto";
 import { GetChatMessagesQuery } from "../../contracts/queries/get-chat-messages.query";
 
 @QueryHandler(GetChatMessagesQuery)
@@ -19,6 +21,7 @@ export class GetChatMessagesHandler
     private readonly chatMessages: Repository<ChatMessage>,
     private readonly currentOrganizationService: CurrentOrganizationService,
     private readonly currentProfileService: CurrentProfileService,
+    private readonly photoService: PhotoService,
   ) {}
 
   async execute(query: GetChatMessagesQuery) {
@@ -29,6 +32,11 @@ export class GetChatMessagesHandler
       await this.currentOrganizationService.fetchCurrentOrganizationId();
 
     const foundChatMessages = await this.chatMessages.find({
+      relations: {
+        sender: {
+          profilePhoto: true,
+        },
+      },
       where: {
         conversation: {
           id: query.conversationId,
@@ -40,8 +48,15 @@ export class GetChatMessagesHandler
     return mapArray(ChatMessageDetails, foundChatMessages, (item) => ({
       id: item.id,
       message: item.message,
-      read: false,
+      profile: map(ChatMessageProfileDetails, {
+        id: item.sender.id,
+        name: item.sender.name,
+        imageUrl:
+          item.sender.profilePhoto &&
+          this.photoService.getUrl(item.sender.profilePhoto, "profile-photo"),
+      }),
       sentByCurrentUser: item.senderId == currentProfileId,
+      read: false,
     }));
   }
 }

services/api/src/features/chat/client/controllers/chats.controller.ts

@@ -5,7 +5,7 @@ import { ApiTags } from "@nestjs/swagger";
 import { CreateChatCommand } from "../../application/contracts/commands/create-chat.command";
 import { PostChatMessageCommand } from "../../application/contracts/commands/post-chat-message.command";
 import { ChatConversationDetails } from "../../application/contracts/dtos/chat-conversation.dto";
-import { ChatMessageDetails } from "../../application/contracts/dtos/chat.dto";
+import { ChatMessageDetails } from "../../application/contracts/dtos/chat-message.dto";
 import { GetChatMessagesQuery } from "../../application/contracts/queries/get-chat-messages.query";
 import { GetConversationListQuery } from "../../application/contracts/queries/get-conversation-list.query";