Drop utility for emitting events, and update chats

Author: hussein-m-kandil

src/api/v1/chats/chats.router.ts

@@ -7,6 +7,7 @@ import * as Service from './chats.service';
 import * as Middlewares from '@/middlewares';
 import { Request, Response, Router } from 'express';
 import logger from '@/lib/logger';
+import io from '@/lib/io';
 
 export const chatsRouter = Router();
 
@@ -31,7 +32,7 @@ chatsRouter.get('/', Middlewares.authValidator, async (req, res) => {
   const chats = await Service.getUserChats(userId, filters);
   res.json(chats).on('finish', () => {
     const rooms = Service.getOtherChatsMemberIds(userId, chats);
-    Utils.emitToRoomsIfAny({ rooms, event: 'chats:received', volatile: true });
+    if (rooms.length) io.to(rooms).emit('chats:received');
   });
 });
 
@@ -40,7 +41,7 @@ chatsRouter.get('/members/:profileId', Middlewares.authValidator, async (req, re
   const chats = await Service.getUserChatsByMember(userId, req.params.profileId);
   res.json(chats).on('finish', () => {
     const rooms = Service.getOtherChatsMemberIds(userId, chats);
-    Utils.emitToRoomsIfAny({ rooms, event: 'chats:received', volatile: true });
+    if (rooms.length) io.to(rooms).emit('chats:received');
   });
 });
 
@@ -50,7 +51,9 @@ chatsRouter.get('/:id', Middlewares.authValidator, async (req, res) => {
   const chat = await Service.getUserChatById(userId, chatId);
   res.json(chat).on('finish', () => {
     Service.getOtherChatMemberIds(userId, chatId)
-      .then((rooms) => Utils.emitToRoomsIfAny({ rooms, event: 'chats:received', volatile: true }))
+      .then((rooms) => {
+        if (rooms.length) io.to(rooms).emit('chats:received');
+      })
       .catch((error: unknown) => logger.error('Failed to broadcast "chats:received"', error));
   });
 });
@@ -62,7 +65,9 @@ chatsRouter.get('/:id/messages', Middlewares.authValidator, async (req, res) =>
   const messages = await Service.getUserChatMessages(userId, chatId, filters);
   res.json(messages).on('finish', () => {
     Service.getOtherChatMemberIds(userId, chatId)
-      .then((rooms) => Utils.emitToRoomsIfAny({ rooms, event: 'chats:received', volatile: true }))
+      .then((rooms) => {
+        if (rooms.length) io.to(rooms).emit('chats:received');
+      })
       .catch((error: unknown) => logger.error('Failed to broadcast "chats:received"', error));
   });
 });
@@ -73,7 +78,9 @@ chatsRouter.get('/:id/messages/:msgId', Middlewares.authValidator, async (req, r
   const msg = await Service.getUserChatMessageById(userId, chatId, req.params.msgId);
   res.json(msg).on('finish', () => {
     Service.getOtherChatMemberIds(userId, chatId)
-      .then((rooms) => Utils.emitToRoomsIfAny({ rooms, event: 'chats:received', volatile: true }))
+      .then((rooms) => {
+        if (rooms.length) io.to(rooms).emit('chats:received');
+      })
       .catch((error: unknown) => logger.error('Failed to broadcast "chats:received"', error));
   });
 });
@@ -94,9 +101,12 @@ chatsRouter.post(
       .json(createdChat)
       .on('finish', () => {
         Service.getOtherChatMemberIds(user.id, createdChat.id)
-          .then((rooms) =>
-            Utils.emitToRoomsIfAny({ rooms, event: 'chats:updated', volatile: true }),
-          )
+          .then((rooms) => {
+            if (rooms.length) {
+              io.to(rooms).emit('chats:updated');
+              io.to(rooms).emit('chat:created', createdChat.id);
+            }
+          })
           .catch((error: unknown) => logger.error('Failed to broadcast "chats:updated"', error));
       });
   },
@@ -107,7 +117,13 @@ chatsRouter.patch('/:id/seen', Middlewares.authValidator, async (req, res) => {
   const userId = Utils.getCurrentUserIdFromReq(req)!;
   res.json(await Service.updateProfileChatLastSeenDate(userId, chatId)).on('finish', () => {
     Service.getOtherChatMemberIds(userId, chatId)
-      .then((rooms) => Utils.emitToRoomsIfAny({ rooms, event: 'chats:updated', volatile: true }))
+      .then((rooms) => {
+        if (rooms.length) {
+          io.to(rooms).emit('chat:updated', chatId);
+          io.to(rooms).emit(`chat:updated:${chatId}`);
+          io.to(rooms).emit('chats:updated');
+        }
+      })
       .catch((error: unknown) => logger.error('Failed to broadcast "chats:updated"', error));
   });
 });
@@ -130,9 +146,13 @@ chatsRouter.post(
       .json(createdMessage)
       .on('finish', () => {
         Service.getOtherChatMemberIds(user.id, chatId)
-          .then((rooms) =>
-            Utils.emitToRoomsIfAny({ rooms, event: 'chats:updated', volatile: true }),
-          )
+          .then((rooms) => {
+            if (rooms.length) {
+              io.to(rooms).emit('chat:updated', chatId);
+              io.to(rooms).emit(`chat:updated:${chatId}`);
+              io.to(rooms).emit('chats:updated');
+            }
+          })
           .catch((error: unknown) => logger.error('Failed to broadcast "chats:updated"', error));
       });
   },
@@ -147,7 +167,13 @@ chatsRouter.delete('/:id', Middlewares.authValidator, async (req, res) => {
     .send()
     .on('finish', () => {
       Service.getOtherChatMemberIds(userId, chatId)
-        .then((rooms) => Utils.emitToRoomsIfAny({ rooms, event: 'chats:updated', volatile: true }))
+        .then((rooms) => {
+          if (rooms.length) {
+            io.to(rooms).emit('chat:deleted', chatId);
+            io.to(rooms).emit(`chat:deleted:${chatId}`);
+            io.to(rooms).emit('chats:updated');
+          }
+        })
         .catch((error: unknown) => logger.error('Failed to broadcast "chats:updated"', error));
     });
 });

src/lib/utils.ts

@@ -4,7 +4,6 @@ import * as Storage from '@/lib/storage';
 import * as AppError from '@/lib/app-error';
 import { Prisma } from '@/../prisma/client';
 import { Request } from 'express';
-import { io } from '@/lib/io';
 import { z } from 'zod';
 import ms from 'ms';
 import db from '@/lib/db';
@@ -14,10 +13,6 @@ export const lowerCase = <T extends string>(s: T): Lowercase<T> => {
   return s.toLowerCase() as Lowercase<T>;
 };
 
-export const emitToRoomsIfAny = ({ event, rooms, volatile }: Types.SocketEventData) => {
-  if (rooms.length) (volatile ? io.volatile : io).to(rooms).emit(event);
-};
-
 export const createJwtForUser = (user: Types.PublicUser): string => {
   const { id, isAdmin } = user;
   const payload: Types.AppJwtPayload = { id, isAdmin };

src/tests/api/v1/chats.int.test.ts

@@ -998,29 +998,6 @@ describe('Chats endpoints', async () => {
       expect(storage.upload).toHaveBeenCalledOnce();
       expect(storage.upload.mock.calls.at(-1)?.at(-1)).toHaveProperty('upsert', false);
     });
-
-    it('should create multiple chats sequentially, each of which have seen/received by the its owner', async () => {
-      const profileIds = [dbUserTwo.profile!.id, dbXUser.profile!.id, dbAdmin.profile!.id];
-      for (let i = 0; i < profileIds.length; i++) {
-        const iterNum = i + 1;
-        const chatData = { profiles: [profileIds[i]], message: { body: 'Hello!' } };
-        const { authorizedApi } = await prepForAuthorizedTest(userOneData);
-        const res = await authorizedApi.post(CHATS_URL).send(chatData);
-        const dbMsgs = await db.message.findMany({});
-        const dbChats = await db.chat.findMany({});
-        const chat = res.body as ChatFullData;
-        expect(res.statusCode).toBe(201);
-        expect(res.type).toMatch(/json/);
-        expect(dbChats).toHaveLength(iterNum);
-        expect(dbMsgs).toHaveLength(iterNum);
-        assertChat(chat, dbChats[i].id, 1);
-        expect(chat.profiles[0].lastSeenAt).toBeTruthy();
-        expect(chat.profiles[0].lastReceivedAt).toBeTruthy();
-        expect(dbMsgs[i].chatId).toBe(dbChats[i].id);
-        expect(chat.messages).toBeInstanceOf(Array);
-        assertMessage(chat.messages[0], dbMsgs[i].id);
-      }
-    });
   });
 
   describe(`PATCH ${CHATS_URL}/:id/seen`, () => {

src/types.ts

@@ -156,9 +156,3 @@ export interface EvaluationResult {
   evaluation: Record<string, boolean>;
   finder: CharacterFinder;
 }
-
-export interface SocketEventData {
-  event: string;
-  rooms: string[];
-  volatile?: boolean;
-}