feat(logger): Implement configurable logging and replace console statements in client SDK

This commit introduces a new logging utility to the microstream-client SDK, allowing developers to control the verbosity of logs using a configurable logLevel option. The logLevel supports the following levels: "debug", "info", "warn", "error", and "silent".

Changes include:

- Creation of a logger.ts file in src/utils/ with methods for debug, info, warn, and error, respecting the logLevel setting.
- Addition of a logLevel option to the MicrostreamClientOptions interface.
- Initialization of the logger in the MicrostreamClient constructor using the provided logLevel.
- Replacement of all console.log, console.warn, and console.error calls with the appropriate logger methods.

Author: arijitcodes

README.md

@@ -1,4 +1,3 @@
-
 # Microstream Client SDK
 
 A lightweight client SDK for Microstream communication.
@@ -17,13 +16,34 @@ import { MicrostreamClient } from "microstream-client";
 const client = new MicrostreamClient({
   hubUrl: "http://localhost:3000",
   serviceName: "auth-service",
+  logLevel: "debug", // Enable debug logs
 });
 
 client.onRequest("authenticate", (data) => {
   console.log("Received authentication request:", data);
   return { success: true, token: "sample-token" };
 });
 
-const response = await client.sendRequest("jwt-service", "generate_jwt", { userId: 123 });
+const response = await client.sendRequest("jwt-service", "generate_jwt", {
+  userId: 123,
+});
 console.log("Received response:", response);
 ```
+
+### Configuration Options
+
+#### MicrostreamClientOptions
+
+- `hubUrl`: URL of the Microstream Hub.
+- `serviceName`: Name of the service connecting to the hub.
+- `timeout`: Timeout for requests in milliseconds (default: 5000).
+- `heartbeatInterval`: Interval for sending heartbeats in milliseconds (default: 5000).
+- `logLevel`: Log level for the client (default: "info").
+
+### Log Levels
+
+- `debug`: Log everything (useful for development).
+- `info`: Log only important events (useful for production).
+- `warn`: Log only warnings and errors.
+- `error`: Log only errors.
+- `silent`: Disable all logs.

src/index.ts

@@ -1,5 +1,6 @@
 import { io, Socket } from "socket.io-client";
 import { nanoid } from "nanoid";
+import Logger from "./utils/logger"; // Import the logger
 
 /**
  * Options for initializing the MicrostreamClient.
@@ -13,6 +14,8 @@ export interface MicrostreamClientOptions {
   timeout?: number;
   /** Interval for sending heartbeats in milliseconds (default: 5000). */
   heartbeatInterval?: number;
+  /** Log level for the client (default: "info"). */
+  logLevel?: "debug" | "info" | "warn" | "error" | "silent";
 }
 
 /**
@@ -39,6 +42,7 @@ export class MicrostreamClient {
   private handlers: { [event: string]: (data: any) => any } = {};
   private pendingRequests: { [requestId: string]: (response: any) => void } =
     {};
+  private logger: Logger; // Add logger instance
 
   /**
    * Initializes a new MicrostreamClient.
@@ -49,29 +53,33 @@ export class MicrostreamClient {
     serviceName,
     timeout = 5000,
     heartbeatInterval = 5000,
+    logLevel = "info", // Add logLevel option
   }: MicrostreamClientOptions) {
     this.serviceName = serviceName;
     this.timeout = timeout;
     this.heartbeatInterval = heartbeatInterval;
+    this.logger = new Logger(logLevel); // Initialize logger
     this.socket = io(hubUrl, { query: { serviceName } });
 
     // Handle connection
     this.socket.on("connect", () => {
-      console.log(
+      this.logger.info(
         `[${this.serviceName}] Connected to Microstream Hub at ${hubUrl}`
       );
       this.startHeartbeat();
     });
 
     // Handle disconnection
     this.socket.on("disconnect", () => {
-      console.log(`[${this.serviceName}] Disconnected from Microstream Hub`);
+      this.logger.warn(
+        `[${this.serviceName}] Disconnected from Microstream Hub`
+      );
       this.stopHeartbeat();
     });
 
     // Handle incoming requests
     this.socket.on("request", ({ id, event, data }) => {
-      console.log(
+      this.logger.debug(
         `[${this.serviceName}] Received request for event "${event}" (ID: ${id})`,
         data
       );
@@ -81,22 +89,22 @@ export class MicrostreamClient {
         try {
           // Execute the handler and get the response
           const response = this.handlers[event](data);
-          console.log(
+          this.logger.debug(
             `[${this.serviceName}] Sending response for event "${event}" (ID: ${id})`,
             response
           );
           // Send the response back to the requester
           this.socket.emit("response", { id, response });
         } catch (error) {
-          console.error(
+          this.logger.error(
             `[${this.serviceName}] Error handling request for event "${event}" (ID: ${id})`,
             error
           );
           // Handle any errors that occur during handler execution
           this.socket.emit("response", { id, error: "Internal server error" });
         }
       } else {
-        console.warn(
+        this.logger.warn(
           `[${this.serviceName}] No handler found for event "${event}" (ID: ${id})`
         );
         // No handler found for the event
@@ -106,15 +114,15 @@ export class MicrostreamClient {
 
     // Handle responses to pending requests
     this.socket.on("response", ({ id, data }) => {
-      console.log(
+      this.logger.debug(
         `[${this.serviceName}] Received response for request ${id}`,
         data
       );
       if (this.pendingRequests[id]) {
         this.pendingRequests[id](data);
         delete this.pendingRequests[id];
       } else {
-        console.warn(
+        this.logger.warn(
           `[${this.serviceName}] Received unexpected response for request ${id}`,
           data
         );
@@ -177,23 +185,19 @@ export class MicrostreamClient {
 
   private startHeartbeat() {
     if (this.heartbeatInterval > 0) {
-      console.log(
+      this.logger.info(
         `[${this.serviceName}] Starting heartbeat with interval ${this.heartbeatInterval}ms`
       );
       this.heartbeatTimer = setInterval(() => {
-        /* console.log(
-          `[${
-            this.serviceName
-          }] Sending heartbeat - ${new Date().toLocaleString()}`
-        ); */
+        this.logger.debug(`[${this.serviceName}] Sending heartbeat}`);
         this.socket.emit("heartbeat", { serviceName: this.serviceName });
       }, this.heartbeatInterval);
     }
   }
 
   private stopHeartbeat() {
     if (this.heartbeatTimer) {
-      console.log(`[${this.serviceName}] Stopping heartbeat`);
+      this.logger.info(`[${this.serviceName}] Stopping heartbeat`);
       clearInterval(this.heartbeatTimer);
     }
   }

src/utils/logger.ts

@@ -0,0 +1,45 @@
+export type LogLevel = "debug" | "info" | "warn" | "error" | "silent";
+
+export default class Logger {
+  private logLevel: LogLevel;
+
+  constructor(logLevel: LogLevel = "info") {
+    this.logLevel = logLevel;
+  }
+
+  private shouldLog(level: LogLevel): boolean {
+    const levels = ["debug", "info", "warn", "error", "silent"];
+    return levels.indexOf(level) >= levels.indexOf(this.logLevel);
+  }
+
+  private formatMessage(level: string, ...args: any[]): string {
+    const timestamp = new Date().toISOString();
+    return `[MicroStream Client][${timestamp}][${level.toUpperCase()}] ${args.join(
+      " "
+    )}`;
+  }
+
+  debug(...args: any[]) {
+    if (this.shouldLog("debug")) {
+      console.debug(this.formatMessage("debug", ...args));
+    }
+  }
+
+  info(...args: any[]) {
+    if (this.shouldLog("info")) {
+      console.info(this.formatMessage("info", ...args));
+    }
+  }
+
+  warn(...args: any[]) {
+    if (this.shouldLog("warn")) {
+      console.warn(this.formatMessage("warn", ...args));
+    }
+  }
+
+  error(...args: any[]) {
+    if (this.shouldLog("error")) {
+      console.error(this.formatMessage("error", ...args));
+    }
+  }
+}

tsconfig.cjs.json

@@ -9,5 +9,5 @@
     "declaration": true,
     "declarationMap": true
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*", "src/utils/**/*"] // Add this line
 }

tsconfig.esm.json

@@ -9,5 +9,5 @@
     "declaration": true,
     "declarationMap": true
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*", "src/utils/**/*"] // Add this line
 }