Merge pull request #21 from DerTyp876/feature_better-logger

Better logger

src/handlers/teamspeak/connectionHandler.ts

@@ -1,6 +1,7 @@
 import { IAuthSenderPayload, IChannel, IClient, IConnection, ITS5ConnectionHandler, ITS5DataHandler, ITS5MessageHandler } from "@interfaces/teamspeak";
 import { TS5DataHandler } from "./dataHandler";
 import { TS5MessageHandler } from "./messageHandler";
+import Logger from "@/utils/logger";
 
 
 // Establish connection to TS5 client
@@ -22,6 +23,8 @@ export class TS5ConnectionHandler implements ITS5ConnectionHandler {
     setClients: React.Dispatch<React.SetStateAction<IClient[]>>,
     setActiveConnectionStateId: React.Dispatch<React.SetStateAction<number>>,
   ) {
+
+
     // Create websocket connection to TS5 client
     this.remoteAppPort = remoteAppPort;
     this.ws = new WebSocket(`ws://localhost:${this.remoteAppPort}`);
@@ -32,7 +35,7 @@ export class TS5ConnectionHandler implements ITS5ConnectionHandler {
   }
 
   reconnect() {
-    console.log("Reconnecting...")
+    Logger.log("Reconnecting...")
     this.ws.close();
 
     this.ws = new WebSocket(`ws://localhost:${this.remoteAppPort}`);
@@ -44,8 +47,7 @@ export class TS5ConnectionHandler implements ITS5ConnectionHandler {
 
   // Connect to TS5 client
   connect() {
-    console.log('Connecting to TS5 client...');
-    console.log(localStorage.getItem("apiKey"))
+    Logger.log('Connecting to TS5 client...');
 
     // Create authentication payload
     const initalPayload: IAuthSenderPayload = {
@@ -63,17 +65,17 @@ export class TS5ConnectionHandler implements ITS5ConnectionHandler {
 
     this.ws.onopen = () => {
       // Send authentication payload to TS5 client
-      console.log("Sending auth payload...")
       this.ws.send(JSON.stringify(initalPayload));
+      Logger.wsSent(initalPayload);
     };
 
     this.ws.onclose = (event) => {
-      console.log("WebSocket connection closed", event);
+      Logger.log("WebSocket connection closed", event);
 
       // If the connection was closed before authentication, remove the API key from local storage
       // OBS weirdly caches the localstorage and is very stubborn about clearing it (even when clicken "Clear Cache")
       if (!this.authenticated) {
-        console.log("WebSocket connection closed before authentication");
+        Logger.log("WebSocket connection closed before authentication");
         localStorage.removeItem("apiKey");
       }
 
@@ -87,7 +89,7 @@ export class TS5ConnectionHandler implements ITS5ConnectionHandler {
     this.ws.onmessage = (event) => {
       const data = JSON.parse(event.data);
 
-      console.log(data)
+      Logger.wsReceived(data)
 
       switch (data.type) {
         case "auth":
@@ -105,7 +107,6 @@ export class TS5ConnectionHandler implements ITS5ConnectionHandler {
           break;
         case "serverPropertiesUpdated":
           this.messageHandler.handleServerPropertiesUpdatedMessage(data);
-          //this.ws.close();
           break;
         case "connectStatusChanged":
           this.messageHandler.handleConnectStatusChangedMessage(data);
@@ -117,7 +118,7 @@ export class TS5ConnectionHandler implements ITS5ConnectionHandler {
           this.messageHandler.handleChannelsMessage(data);
           break;
         default:
-          console.log(`No handler for event type: ${data.type}`);
+          Logger.log(`No handler for event type: ${data.type}`);
           break;
       }
     };

src/handlers/teamspeak/dataHandler.ts

@@ -1,3 +1,4 @@
+import Logger from "@/utils/logger";
 import { IConnection, IChannel, IClient, ITS5DataHandler } from "@interfaces/teamspeak";
 
 
@@ -58,88 +59,88 @@ export class TS5DataHandler implements ITS5DataHandler {
 
   // Add data to local lists and update states
   addConnection(connection: IConnection) {
-    console.log("Adding connection...", connection)
+    Logger.log("Adding connection...", connection)
 
     const existingConnection: IConnection | undefined = this.localConnections.find((localConnection: IConnection) => localConnection.id === connection.id);
 
     if (existingConnection == undefined) {
       this.localConnections.push(connection);
       this.updateConnectionsState();
-      console.log("Connection added")
+      Logger.log("Connection added")
     } else {
-      console.log("Connection already exists")
+      Logger.log("Connection already exists")
     }
   }
 
   addChannel(channel: IChannel) {
-    console.log("Adding channel...", channel)
+    Logger.log("Adding channel...", channel)
     const existingChannel: IChannel | undefined = this.localChannels.find((localChannel: IChannel) => localChannel.id === channel.id && localChannel.connection.id === channel.connection.id);
 
     if (existingChannel == undefined) {
       this.localChannels.push(channel);
       this.updateChannelsState();
-      console.log("Channel added")
+      Logger.log("Channel added")
     } else {
-      console.log("Channel already exists")
+      Logger.log("Channel already exists")
     }
   }
 
   addClient(client: IClient) {
-    console.log("Adding client...", client)
+    Logger.log("Adding client...", client)
     const existingClient: IClient | undefined = this.localClients.find((localClient: IClient) => localClient.id === client.id && localClient.channel?.connection.id === client.channel?.connection.id);
 
     if (existingClient == undefined) {
       this.localClients.push(client);
       this.updateClientsState();
-      console.log("Client added")
+      Logger.log("Client added")
     } else {
-      console.log("Client already exists")
+      Logger.log("Client already exists")
     }
   }
 
   // Update data in local lists and update states
   updateConnection(connection: IConnection) {
-    console.log("Updating connection...", connection)
+    Logger.log("Updating connection...", connection)
     const existingConnection: IConnection | undefined = this.localConnections.find((localConnection: IConnection) => localConnection.id === connection.id);
 
     if (existingConnection !== undefined) {
       this.localConnections[this.localConnections.indexOf(existingConnection)] = connection;
       this.updateConnectionsState();
-      console.log("Connection updated")
+      Logger.log("Connection updated")
     } else {
-      console.log("Connection does not exist")
+      Logger.log("Connection does not exist")
     }
   }
 
   updateChannel(channel: IChannel) {
-    console.log("Updating channel...", channel)
+    Logger.log("Updating channel...", channel)
     const existingChannel: IChannel | undefined = this.localChannels.find((localChannel: IChannel) => localChannel.id === channel.id && localChannel.connection.id === channel.connection.id);
 
     if (existingChannel !== undefined) {
       this.localChannels[this.localChannels.indexOf(existingChannel)] = channel;
       this.updateChannelsState();
-      console.log("Channel updated")
+      Logger.log("Channel updated")
     } else {
-      console.log("Channel does not exist")
+      Logger.log("Channel does not exist")
     }
   }
 
   updateClient(client: IClient) {
-    console.log("Updating client...", client)
+    Logger.log("Updating client...", client)
     const existingClient: IClient | undefined = this.localClients.find((localClient: IClient) => localClient.id === client.id && localClient.channel?.connection.id === client.channel?.connection.id);
 
     if (existingClient !== undefined) {
       this.localClients[this.localClients.indexOf(existingClient)] = client;
       this.updateClientsState();
-      console.log("Client updated")
+      Logger.log("Client updated")
     } else {
-      console.log("Client does not exist")
+      Logger.log("Client does not exist")
     }
   }
 
   // Remove data from local lists and update states
   removeConnection(connection: IConnection) {
-    console.log("Removing connection...", connection)
+    Logger.log("Removing connection...", connection)
     const existingConnection: IConnection | undefined = this.localConnections.find((localConnection: IConnection) => localConnection.id === connection.id);
 
     if (existingConnection !== undefined) {
@@ -152,14 +153,14 @@ export class TS5DataHandler implements ITS5DataHandler {
       this.updateChannelsState();
       this.updateClientsState();
       this.updateConnectionsState();
-      console.log("Connection removed")
+      Logger.log("Connection removed")
     } else {
-      console.log("Connection does not exist")
+      Logger.log("Connection does not exist")
     }
   }
 
   removeChannel(channel: IChannel) {
-    console.log("Removing channel...", channel)
+    Logger.log("Removing channel...", channel)
     const existingChannel: IChannel | undefined = this.localChannels.find((localChannel: IChannel) => localChannel.id === channel.id && localChannel.connection.id === channel.connection.id);
 
     if (existingChannel !== undefined) {
@@ -170,22 +171,22 @@ export class TS5DataHandler implements ITS5DataHandler {
 
       this.updateClientsState();
       this.updateChannelsState();
-      console.log("Channel removed")
+      Logger.log("Channel removed")
     } else {
-      console.log("Channel does not exist")
+      Logger.log("Channel does not exist")
     }
   }
 
   removeClient(client: IClient) {
-    console.log("Removing client...", client)
+    Logger.log("Removing client...", client)
     const existingClient: IClient | undefined = this.localClients.find((localClient: IClient) => localClient.id === client.id && localClient.channel?.connection.id === client.channel?.connection.id);
 
     if (existingClient !== undefined) {
       this.localClients.splice(this.localClients.indexOf(existingClient), 1);
       this.updateClientsState();
-      console.log("Client removed")
+      Logger.log("Client removed")
     } else {
-      console.log("Client does not exist")
+      Logger.log("Client does not exist")
     }
   }
 

src/handlers/teamspeak/messageHandler.ts

@@ -1,3 +1,4 @@
+import Logger from "@/utils/logger";
 import { IChannelInfos, IConnection, IChannel, IAuthMessage, IClientInfo, IClientMovedMessage, IClient, IClientPropertiesUpdatedMessage, ITalkStatusChangedMessage, IClientSelfPropertyUpdatedMessage, IServerPropertiesUpdatedMessage, IConnectStatusChangedMessage, IChannelsMessage, ITS5MessageHandler, ITS5DataHandler } from "@interfaces/teamspeak";
 
 // Handle incoming messages from TS5 client
@@ -36,8 +37,6 @@ export class TS5MessageHandler implements ITS5MessageHandler {
   // This message is sent by the TS5 server when the client is connected
   // It contains the initial data
   handleAuthMessage(data: IAuthMessage) {
-    console.log("handleAuthMessage", data);
-
     localStorage.setItem("apiKey", data.payload.apiKey);
 
     // Process auth payload and add initial data
@@ -67,8 +66,6 @@ export class TS5MessageHandler implements ITS5MessageHandler {
 
   // This message is sent by the TS5 server when a client moves a channel OR joins/leaves the server
   handleClientMovedMessage(data: IClientMovedMessage) {
-    console.log("handleClientMoved", data);
-
     const client: IClient | undefined = this.dataHandler.getClientById(data.payload.clientId, data.payload.connectionId);
 
 
@@ -76,7 +73,6 @@ export class TS5MessageHandler implements ITS5MessageHandler {
     if (+data.payload.oldChannelId == 0) { // Create new client(when connecting to server)
       //set timout to wait for channels to be created
       setTimeout(() => {
-        console.log("---> New Client created")
         const newChannel = this.dataHandler.getChannelById(data.payload.newChannelId, data.payload.connectionId);
         if (newChannel !== undefined) {
           this.dataHandler.addClient(
@@ -86,25 +82,23 @@ export class TS5MessageHandler implements ITS5MessageHandler {
               channel: newChannel,
               properties: data.payload.properties,
             });
+          Logger.ts(`New Client found (${data.payload.connectionId} - ${data.payload.clientId} - ${data.payload.properties.nickname})`)
         }
       }, 2000);
+
     } else {//* This gets called when a client moves a channel OR joins/leaves the server
       const newChannel: IChannel | undefined = this.dataHandler.getChannelById(data.payload.newChannelId, data.payload.connectionId);
 
       if (newChannel === undefined || newChannel.id === 0) {
-        console.log("---> Client left")
-
+        Logger.ts(`Client left (${data.payload.connectionId} - ${data.payload.clientId} - ${data.payload.properties.nickname})`)
         if (client !== undefined) {
           this.dataHandler.removeClient(client);
-
         }
         return;
       }
 
       if (client !== undefined) { // Client already exists
-
-        // Client moved
-        console.log("---> Client moved")
+        Logger.ts(`Client moved (${client.channel.connection.id} - ${client.id} - ${client.properties.nickname})`)
 
         this.dataHandler.updateClient({
           ...client,
@@ -113,7 +107,8 @@ export class TS5MessageHandler implements ITS5MessageHandler {
 
       } else { // Client does not exist
         // Client joined
-        console.log("---> New Client joined")
+        Logger.ts(`Client joined (${data.payload.connectionId} - ${data.payload.clientId} - ${data.payload.properties.nickname})`)
+
         this.dataHandler.addClient(
           {
             id: data.payload.clientId,
@@ -127,8 +122,6 @@ export class TS5MessageHandler implements ITS5MessageHandler {
   }
 
   handleClientPropertiesUpdatedMessage(data: IClientPropertiesUpdatedMessage) {
-    console.log("handleClientPropertiesUpdate", data);
-
     const client: IClient | undefined = this.dataHandler.getClientById(data.payload.clientId, data.payload.connectionId);
 
     if (client !== undefined) {
@@ -140,8 +133,6 @@ export class TS5MessageHandler implements ITS5MessageHandler {
   }
 
   handleTalkStatusChangedMessage(data: ITalkStatusChangedMessage) {
-    console.log("handleTalkStatusChanged", data);
-
     const client: IClient | undefined = this.dataHandler.getClientById(data.payload.clientId, data.payload.connectionId);
 
     if (client !== undefined) {
@@ -151,14 +142,12 @@ export class TS5MessageHandler implements ITS5MessageHandler {
       });
     }
 
-    console.log(this.dataHandler.localConnections)
-    console.log(this.dataHandler.localChannels)
-    console.log(this.dataHandler.localClients)
+    // console.log(this.dataHandler.localConnections)
+    // console.log(this.dataHandler.localChannels)
+    // console.log(this.dataHandler.localClients)
 
   }
   handleClientSelfPropertyUpdatedMessage(data: IClientSelfPropertyUpdatedMessage) {
-    console.log("handleClientSelfPropertyUpdated", data);
-
     const connection: IConnection | undefined = this.dataHandler.getConnectionById(this.activeConnectionId);
 
     if (data.payload.flag == "inputHardware" || connection == undefined) { // sadly thats the only way to detect if a server is active or not
@@ -167,8 +156,6 @@ export class TS5MessageHandler implements ITS5MessageHandler {
   }
 
   handleServerPropertiesUpdatedMessage(data: IServerPropertiesUpdatedMessage) {
-    console.log("handleServerPropertiesUpdated", data);
-
     const connection: IConnection | undefined = this.dataHandler.getConnectionById(data.payload.connectionId);
 
     if (connection !== undefined) { // Update existing connection
@@ -180,8 +167,6 @@ export class TS5MessageHandler implements ITS5MessageHandler {
   }
 
   handleConnectStatusChangedMessage(data: IConnectStatusChangedMessage) {
-    console.log("handleConnectStatusChanged", data);
-
     if (data.payload.status === 0) { // Disconnected from server
       const connection: IConnection | undefined = this.dataHandler.getConnectionById(data.payload.connectionId);
 
@@ -201,19 +186,11 @@ export class TS5MessageHandler implements ITS5MessageHandler {
   }
 
   handleChannelsMessage(data: IChannelsMessage) {
-    console.log("handleChannels", data);
-
     // Wait a bit for the connection to be added
     setTimeout(() => {
-      console.log(this.dataHandler.localConnections);
-      console.log(data.payload.connectionId)
-      console.log(this.dataHandler.localConnections.filter((connection: IConnection) => connection.id === data.payload.connectionId)[0]);
-      console.log(this.dataHandler.localConnections.find((connection: IConnection) => connection.id === data.payload.connectionId));
       const connection: IConnection | undefined = this.dataHandler.getConnectionById(data.payload.connectionId);
-      console.log(connection);
       if (connection !== undefined) {
         this.parseChannelInfos(data.payload.info, connection);
-        console.log(data.payload.info)
       }
     }, 1000);
   }

src/utils/logger.tsx

@@ -0,0 +1,31 @@
+export default class Logger {
+  // Log message to the console
+  public static log(message: string, data: object | null = null): void {
+    console.log(`%c${message}`.trim(), "color: gray", data ?? "");
+  }
+
+  // Log warning to the console
+  public static warn(message: string, data: object | null = null): void {
+    console.warn(`%c${message}`.trim(), data ?? "");
+  }
+
+  // Log error to the console
+  public static error(message: string, data: object | null = null): void {
+    console.error(`%c${message}`.trim(), data ?? "");
+  }
+
+  // Log message received from the websocket to the console
+  public static wsReceived(data: object, message: string | undefined = undefined): void {
+    console.log(`%c[WS Recieved] ${message ?? ""}`.trim(), "color: #8258c7", data);
+  }
+
+  // Log message sent to the websocket to the console
+  public static wsSent(data: object, message: string | undefined = undefined): void {
+    console.log(`%c[WS Sent] ${message ?? ""}`.trim(), "color: #4eb570", data);
+  }
+
+  // Log message to the console with a timestamp
+  public static ts(message: string, data: object | null = null): void {
+    console.log(`%c[TS] ${message}`.trim(), "color: #2e6bc7", data ?? "");
+  }
+}