Tag each console log in innkeeper

Author: bharathcs

innkeeper/src/controllers/index.ts

@@ -3,6 +3,6 @@ import { SHOULD_LOG } from '../utils';
 
 export const sendNotification = (socket: InnkeeperIoSocket | InnkeeperOtherSockets, { type, message }: NotificationMessage) => {
   const socketData = `${socket.id} (userId: ${socket.data.userId})`;
-  SHOULD_LOG && console.log(`Sending ${type} notification to ${socketData}: ${message}`);
+  SHOULD_LOG && console.log(`[OTHER][NOTIF] Sending ${type} notification to ${socketData}: ${message}`);
   socket.emit('sendNotification', { type, message });
 };

innkeeper/src/controllers/lobby.ts

@@ -23,7 +23,7 @@ const notifyOnQueue = (io: InnkeeperIoServer, inn: InnState, socket: InnkeeperIo
 };
 
 export const handleConnect = (io: InnkeeperIoServer, inn: InnState, socket: InnkeeperIoSocket): void => {
-  SHOULD_LOG && console.log(`User ${socket.data?.userId} connected to lobby.`);
+  SHOULD_LOG && console.log(`[LOBBY][Q] User ${socket.data?.userId} connected to lobby.`);
   const waitingUsers = inn.getWaitingUsers();
   socket.join('lobby');
   socket.emit('availableMatches', waitingUsers);
@@ -38,20 +38,20 @@ export const handleMatchingRequest = (
   socket.data.lastMessage = getUnixTimestamp();
   const { userId, displayName, imageUrl } = socket.data;
 
-  SHOULD_LOG && console.log(`User ${displayName} (${userId}) requested a match with parameters ${JSON.stringify(params)}.`);
+  SHOULD_LOG && console.log(`[LOBBY][Q] User ${displayName} (${userId}) requested a match with parameters ${JSON.stringify(params)}.`);
 
   // Remove user from queue in case this is a re-request.
   inn.removeUserFromQueue({ userId, displayName, imageUrl });
 
   const maybeMatch = inn.queueUserOrReturnMatchResult({ userId, displayName, imageUrl }, params);
   if (!maybeMatch) {
     notifyOnQueue(io, inn, socket);
-    SHOULD_LOG && console.log(`User ${userId} added to queue.`);
+    SHOULD_LOG && console.log(`[LOBBY][Q] User ${userId} added to queue.`);
     return;
   }
 
   const [otherUserId, roomState] = maybeMatch;
-  SHOULD_LOG && console.log(`Matched users ${userId} and ${otherUserId} in room ${roomState.roomId}.`);
+  SHOULD_LOG && console.log(`[LOBBY][Q] Matched users ${userId} and ${otherUserId} in room ${roomState.roomId}.`);
 
   io.in('lobby')
     .fetchSockets()
@@ -67,12 +67,12 @@ export const handleMatchingRequest = (
         otherSocket.data.roomId = roomState.roomId;
         otherSocket.emit('sendToRoom', roomState.roomId);
         joinAssignedRoom(io, inn, otherSocket);
-        SHOULD_LOG && console.log(`Sent users ${userId} and ${otherUserId.userId} to room ${roomState.roomId}.`);
+        SHOULD_LOG && console.log(`[LOBBY][Q] Sent users ${userId} and ${otherUserId.userId} to room ${roomState.roomId}.`);
         return;
       }
 
       // socket with matching otherUserId could not be found, remove from queue.
-      console.error(`Could not find socket for userId ${otherUserId} (returned from queue).`);
+      console.error(`[LOBBY][Q] Could not find socket for userId ${otherUserId} (returned from queue).`);
       inn.removeUserFromQueue(otherUserId);
 
       inn.addUserToQueue({ userId, displayName, imageUrl }, params);
@@ -84,5 +84,5 @@ export const handleDisconnect = (io: InnkeeperIoServer, inn: InnState, socket: I
   const { userId, displayName, imageUrl } = socket.data;
   inn.removeUserFromQueue({ userId, displayName, imageUrl });
 
-  SHOULD_LOG && console.log(`User ${userId} disconnected from queue.`);
+  SHOULD_LOG && console.log(`[LOBBY][Q] User ${userId} disconnected from queue.`);
 };

innkeeper/src/controllers/room.ts

@@ -6,13 +6,13 @@ import { getUnixTimestamp } from '../utils';
 export const getRoomState = (inn: InnState, socket: InnkeeperIoSocket | InnkeeperOtherSockets): RoomState | undefined => {
   const { roomId } = socket.data;
   if (!roomId) {
-    console.error(`Unexpected undefined roomId for socket ${socket.id}. Data: ${socket.data}.`);
+    console.error(`[ROOM][ERR] Unexpected undefined roomId for socket ${socket.id}. Data: ${socket.data}.`);
     return undefined;
   }
 
   const roomState = inn.getRoomState(roomId);
   if (!roomState) {
-    console.error(`Unexpected undefined roomState for socket ${socket.id}. Data: ${socket.data}.`);
+    console.error(`[ROOM][ERR] Unexpected undefined roomState for socket ${socket.id}. Data: ${socket.data}.`);
     return undefined;
   }
 
@@ -24,7 +24,7 @@ const getSelfAndOtherUser = (room: RoomState, userId: string): [UserState, UserS
   const userState = userStates.find(s => s.userId === userId);
   const otherUserState = userStates.find(s => s.userId !== userId);
   if (!userState || !otherUserState) {
-    console.error(`Unexpected user states in ${room.roomId}: ${userStates} (asking for ${userId} & roommate).`);
+    console.error(`[ROOM][ERR] Unexpected user states in ${room.roomId}: ${userStates} (asking for ${userId} & roommate).`);
     return undefined;
   }
 
@@ -195,7 +195,6 @@ export const handleChatMessage = (io: InnkeeperIoServer, inn: InnState, socket:
     roomState.chatHistory = [];
   }
   roomState.chatHistory.push(chatMessage);
-  console.log(roomState.chatHistory);
 
   // Emit the chat message to all users in the room
   io.to(roomState.roomId).emit('sendPartialRoomState', { chatHistory: roomState.chatHistory });

innkeeper/src/index.ts

@@ -65,15 +65,18 @@ const ysocketio = new YS.YSocketIO(io, {
   gcEnabled: false,
 });
 
-ysocketio.on('document-loaded', (doc: any) => SHOULD_LOG && console.log(`The document ${doc.name} was loaded`));
-ysocketio.on('document-update', (doc: any, update: Uint8Array) => SHOULD_LOG && console.log(`The document ${doc.name} is updated`));
+ysocketio.on('document-loaded', (doc: any) => SHOULD_LOG && console.log(`[ROOM][YDOC] The document ${doc.name} was loaded`));
+ysocketio.on(
+  'document-update',
+  (doc: any, update: Uint8Array) => SHOULD_LOG && console.log(`[ROOM][YDOC] The document ${doc.name} is updated`),
+);
 ysocketio.on('awareness-update', (doc: any, update: Uint8Array) => {
   // SHOULD_LOG && console.log(`The awareness of the document ${doc.name} is updated`),
 });
-ysocketio.on('document-destroy', async (doc: any) => SHOULD_LOG && console.log(`The document ${doc.name} is being destroyed`));
+ysocketio.on('document-destroy', async (doc: any) => SHOULD_LOG && console.log(`[ROOM][YDOC] The document ${doc.name} is being destroyed`));
 ysocketio.on(
   'all-document-connections-closed',
-  async (doc: any) => SHOULD_LOG && console.log(`All clients of document ${doc.name} are disconnected`),
+  async (doc: any) => SHOULD_LOG && console.log(`[ROOM][YDOC] All clients of document ${doc.name} are disconnected`),
 );
 
 // Execute initialize method

innkeeper/src/models/index.ts

@@ -65,15 +65,15 @@ export class InnState {
     this.matchingParameterToUserMap.forEach((otherUserId, parameters) => {
       if (otherUserId.userId === userId.userId) {
         this.matchingParameterToUserMap.delete(parameters);
-        console.log(`Removed user ${userId.userId} from queue.`);
+        console.log(`[LOBBY][INTERNAL] Removed user ${userId.userId} from queue.`);
       }
     });
   }
 
   addUserToQueue(userId: UserId, parameters: MatchingParameters): void {
     this.removeUserFromQueue(userId);
     this.matchingParameterToUserMap.set(this.makeConsistentMatchingParameterObject(parameters), userId);
-    console.log(`Added user ${userId.userId} to queue.`);
+    console.log(`[LOBBY][INTERNAL] Added user ${userId.userId} to queue.`);
   }
 
   getWaitingUsers(): WaitingUsersCount {

innkeeper/src/utils/index.ts

@@ -42,7 +42,7 @@ export const requireUser = async (
   socket.data.roomId = inn.getRoomId(userId);
   socket.data.lastMessage = getUnixTimestamp();
 
-  SHOULD_LOG && console.log(`User ${userId} connected, with room ${socket.data.roomId}.`);
+  SHOULD_LOG && console.log(`[OTHER][MIDDLEWARE] User ${userId} connected, with room ${socket.data.roomId}.`);
   return next();
 };