Change how Logging is implemented (#5)

HungKNguyen · web-flow · commit e22f98256e44 · 2025-07-30T11:09:56.000+07:00
diff --git a/.env.example b/.env.example
@@ -13,7 +13,7 @@ OPENAI_API_KEY=your-openai-api-key
 # MAX_RETRIES=3
 # RETRY_DELAY=1000
 # MAX_CONNECTIONS=100
-# LOG_LEVEL=INFO
+# LOG_LEVEL=info
 
 # MCP Transport configuration
 # MCP_TRANSPORT=stdio
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -46,7 +46,7 @@ We welcome contributions to the Nutrient Document Engine MCP Server! This docume
 
    # Optional configuration
    MCP_TRANSPORT=stdio
-   LOG_LEVEL=INFO
+   LOG_LEVEL=info
    ```
 
 ### Starting Document Engine
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -13,18 +13,18 @@ This guide covers configuration options, environment variables, transport modes,
 
 ### Optional Configuration
 
-| Variable             | Description                                                               | Default                         | Example    |
-|----------------------|---------------------------------------------------------------------------|---------------------------------|------------|
-| `MCP_TRANSPORT`      | Transport type - "stdio" or "http"                                        | `stdio`                         | `http`     |
-| `MCP_HOST`           | The host as IP address for the Dashboard and the MCP server and Dashboard | `localhost`                     | `0.0.0.0`  |
-| `PORT`               | HTTP server port (HTTP transport only)                                    | `5100`                          | `8080`     |
-| `MAX_RETRIES`        | Number of API request retries                                             | `3`                             | `5`        |
-| `CONNECTION_TIMEOUT` | Request timeout in milliseconds                                           | `30000`                         | `60000`    |
-| `RETRY_DELAY`        | Delay between retries in milliseconds                                     | `1000`                          | `2000`     |
-| `MAX_CONNECTIONS`    | Maximum concurrent connections                                            | `100`                           | `200`      |
-| `LOG_LEVEL`          | Logging level                                                             | `INFO`                          | `DEBUG`    |
-| `DASHBOARD_USERNAME` | Dashboard authentication username (required to enable dashboard)          | `undefined`                     | `admin`    |
-| `DASHBOARD_PASSWORD` | Dashboard authentication password (required to enable dashboard)          | `undefined`                     | `password` |
+| Variable             | Description                                                                                     | Default     | Example    |
+|----------------------|-------------------------------------------------------------------------------------------------|-------------|------------|
+| `MCP_TRANSPORT`      | Transport type - "stdio" or "http"                                                              | `stdio`     | `http`     |
+| `MCP_HOST`           | The host as IP address for the Dashboard and the MCP server and Dashboard                       | `localhost` | `0.0.0.0`  |
+| `PORT`               | HTTP server port (HTTP transport only)                                                          | `5100`      | `8080`     |
+| `MAX_RETRIES`        | Number of API request retries                                                                   | `3`         | `5`        |
+| `CONNECTION_TIMEOUT` | Request timeout in milliseconds                                                                 | `30000`     | `60000`    |
+| `RETRY_DELAY`        | Delay between retries in milliseconds                                                           | `1000`      | `2000`     |
+| `MAX_CONNECTIONS`    | Maximum concurrent connections                                                                  | `100`       | `200`      |
+| `LOG_LEVEL`          | Logging level ("debug", "info", "notice", "warning", "error", "critical", "alert", "emergency") | `info`      | `error`    |
+| `DASHBOARD_USERNAME` | Dashboard authentication username (required to enable dashboard)                                | `undefined` | `admin`    |
+| `DASHBOARD_PASSWORD` | Dashboard authentication password (required to enable dashboard)                                | `undefined` | `password` |
 
 > MCP_HOST information
 >  Setting host to `127.0.0.1` (localhost) ensure that the Dashboard and the MCP server is only accessible locally 
@@ -275,5 +275,5 @@ echo $DOCUMENT_ENGINE_API_AUTH_TOKEN
 
 ### Debug Logging
 ```bash
-LOG_LEVEL=DEBUG npx @nutrient-sdk/document-engine-mcp-server
+LOG_LEVEL=debug npx @nutrient-sdk/document-engine-mcp-server
 ```
diff --git a/src/api/Client.ts b/src/api/Client.ts
@@ -69,7 +69,7 @@ export async function createDocumentEngineClient(config: ClientConfig): Promise<
 function setupInterceptors(client: Client): void {
   client.interceptors.request.use(
     config => {
-      logger.request(config.method || 'unknown', config.url || 'unknown', {
+      logger.request(null, config.method || 'unknown', config.url || 'unknown', {
         params: config.params,
         body: config.data,
       });
@@ -82,7 +82,7 @@ function setupInterceptors(client: Client): void {
 
   client.interceptors.response.use(
     response => {
-      logger.response(response.status, response.config?.url || 'unknown', {
+      logger.response(null, response.status, response.config?.url || 'unknown', {
         data: response.data,
       });
       return response;
@@ -93,15 +93,15 @@ function setupInterceptors(client: Client): void {
         const method = error.config?.method?.toUpperCase();
         const url = error.config?.url || 'unknown';
 
-        logger.error('API Request Failed', {
+        logger.error(null, 'API Request Failed', {
           method,
           url,
           status,
           message: error.message,
           code: error.code,
         });
       } else {
-        logger.error('Non-Axios Error in Response Interceptor', {
+        logger.error(null, 'Non-Axios Error in Response Interceptor', {
           message: error instanceof Error ? error.message : String(error),
         });
       }
@@ -139,7 +139,7 @@ function addRetryFunctionality(client: Client, maxRetries: number, retryDelay: n
             const currentAttempt = retryCount + 1;
             const delay = calculateDelay(retryDelay, retryCount);
 
-            logger.retry(currentAttempt, maxRetries, delay);
+            logger.retry(null, currentAttempt, maxRetries, delay);
             await new Promise(resolve => setTimeout(resolve, delay));
             return attempt(retryCount + 1);
           }
diff --git a/src/dashboard/routes.ts b/src/dashboard/routes.ts
@@ -52,7 +52,7 @@ export async function dashboardHandler(client: DocumentEngineClient, req: Reques
     // Render HTML dashboard
     res.send(dashboardTemplate(documents, formatFileSize, message));
   } catch (error) {
-    logger.error('Dashboard error', { error });
+    logger.error(null, 'Dashboard error', { error });
     res
       .status(500)
       .send(
@@ -128,7 +128,7 @@ export async function uploadHandler(client: DocumentEngineClient, req: Request,
     // Render upload results
     res.send(uploadResultsTemplate(templateResults));
   } catch (error) {
-    logger.error('File upload error', { error });
+    logger.error(null, 'File upload error', { error });
     res
       .status(500)
       .send(
@@ -173,7 +173,7 @@ export async function downloadHandler(client: DocumentEngineClient, req: Request
 
     res.send(Buffer.from(response.data));
   } catch (error) {
-    logger.error('Document download error', { error });
+    logger.error(null, 'Document download error', { error });
     res
       .status(500)
       .send(
@@ -201,7 +201,7 @@ export async function deleteHandler(client: DocumentEngineClient, req: Request,
     // Redirect back to dashboard with success message
     res.redirect('/dashboard?message=Document+deleted+successfully');
   } catch (error) {
-    logger.error('Document delete error', { error });
+    logger.error(null, 'Document delete error', { error });
     res
       .status(500)
       .send(
diff --git a/src/index.ts b/src/index.ts
@@ -23,7 +23,10 @@ if (process.env.NODE_ENV !== 'test') {
   try {
     validateEnvironment();
   } catch (error) {
-    console.error('Environment validation failed:', error instanceof Error ? error.message : error);
+    logger.error(
+      null,
+      `Environment validation failed: ${error instanceof Error ? error.message : error}`
+    );
     process.exit(1);
   }
 }
@@ -41,29 +44,32 @@ async function waitForDocumentEngine(): Promise<DocumentEngineClient> {
   while (attempts < maxRetries) {
     try {
       logger.info(
+        null,
         `Attempting to connect to Document Engine (attempt ${attempts + 1}/${maxRetries})`
       );
       const client = await getDocumentEngineClient();
 
       // Test the connection with a health check
       await client.get('/healthcheck');
 
-      logger.info('Document Engine is ready! Connection established successfully.');
+      logger.info(null, 'Document Engine is ready! Connection established successfully.');
       return client;
     } catch (error) {
       attempts++;
       const errorMessage = error instanceof Error ? error.message : String(error);
 
       if (attempts >= maxRetries) {
         logger.error(
+          null,
           `Failed to connect to Document Engine after ${maxRetries} attempts. Last error: ${errorMessage}`
         );
         throw new Error(
           `Document Engine connection failed after ${maxRetries} attempts: ${errorMessage}`
         );
       }
 
-      logger.warn(
+      logger.warning(
+        null,
         `Document Engine not ready yet (attempt ${attempts}/${maxRetries}): ${errorMessage}. Retrying in ${retryDelay}ms...`
       );
       await new Promise(resolve => setTimeout(resolve, retryDelay));
@@ -97,7 +103,7 @@ function createMCPServer(): McpServer {
 
 function configureMCPServerTools(server: McpServer): void {
   for (const tool of mcpToolsToRegister) {
-    server.tool(tool.name, tool.schema, (args, extra) => tool.handler(client, args, extra));
+    server.tool(tool.name, tool.schema, (args, extra) => tool.handler(server, client, args, extra));
   }
 }
 
@@ -127,7 +133,7 @@ function createExpressApp(enableDashboard: boolean = false): express.Application
         });
       }
     } catch (error) {
-      logger.error('Health check endpoint error', { error });
+      logger.error(null, 'Health check endpoint error', { error });
       res.status(500).json({
         status: 'error',
         message: error instanceof Error ? error.message : 'Unknown error',
@@ -153,7 +159,10 @@ async function startStdioServer() {
 
     // Start HTTP server for dashboard
     app.listen(env.PORT, env.MCP_HOST, () => {
-      logger.info(`Dashboard server running on HTTP at ${env.MCP_HOST}:${env.PORT}/dashboard`);
+      logger.info(
+        null,
+        `Dashboard server running on HTTP at ${env.MCP_HOST}:${env.PORT}/dashboard`
+      );
     });
   }
 
@@ -168,8 +177,7 @@ async function startStdioServer() {
   });
 
   await server.connect(transport);
-  logger.setMCPServer(server);
-  logger.info(`Nutrient Document Engine MCP server ${getVersion()} running on stdio`);
+  logger.info(null, `Nutrient Document Engine MCP server ${getVersion()} running on stdio`);
 }
 
 async function startHttpServer() {
@@ -204,12 +212,14 @@ async function startHttpServer() {
         transport.onclose = () => {
           if (transport.sessionId) {
             delete transports[transport.sessionId];
+            logger.info(null, `Close Session : ${transport.sessionId}`);
           }
         };
 
         const server = createMCPServer();
         await server.connect(transport);
-        logger.setMCPServer(server);
+
+        logger.info(null, `Open Session : ${transport.sessionId}`);
       } else {
         // Invalid request
         res.status(400).json({
@@ -226,7 +236,7 @@ async function startHttpServer() {
       // Handle the request
       await transport.handleRequest(req, res, req.body);
     } catch (error) {
-      logger.error('Error handling MCP request:', error);
+      logger.error(null, 'Error handling MCP request:', error);
       if (!res.headersSent) {
         res.status(500).json({
           jsonrpc: '2.0',
@@ -265,10 +275,14 @@ async function startHttpServer() {
 
   app.listen(env.PORT, env.MCP_HOST, () => {
     logger.info(
+      null,
       `Nutrient Document Engine MCP server ${getVersion()} running on HTTP at ${env.MCP_HOST}:${env.PORT}/mcp`
     );
     if (dashboardEnabled) {
-      logger.info(`Dashboard server running on HTTP at ${env.MCP_HOST}:${env.PORT}/dashboard`);
+      logger.info(
+        null,
+        `Dashboard server running on HTTP at ${env.MCP_HOST}:${env.PORT}/dashboard`
+      );
     }
   });
 }
@@ -284,6 +298,6 @@ async function main() {
 }
 
 main().catch(error => {
-  logger.error('Failed to start server', { error: error.message, stack: error.stack });
+  logger.error(null, 'Failed to start server', { error: error.message, stack: error.stack });
   process.exit(1);
 });
diff --git a/src/mcpTools.ts b/src/mcpTools.ts
@@ -40,6 +40,7 @@ import {
   MergeDocumentPagesSchema,
 } from './tools/document-editing/mergeDocumentPages.js';
 import { rotatePages, RotatePagesSchema } from './tools/document-editing/rotatePages.js';
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 
 export type MCPToolOutput = {
   markdown: string;
@@ -51,6 +52,7 @@ export type MCPToolOutput = {
 };
 
 type MCPToolCallback = (
+  server: McpServer,
   client: DocumentEngineClient,
   args: Record<string, unknown>,
   extra: RequestHandlerExtra<ServerRequest, ServerNotification>
@@ -72,22 +74,23 @@ async function withLogging<T, R>(
   toolName: string,
   extras: RequestHandlerExtra<ServerRequest, ServerNotification>,
   toolFn: (client: DocumentEngineClient, params: T) => Promise<R>,
+  server: McpServer,
   client: DocumentEngineClient,
   params: T
 ): Promise<R> {
   let messagePrefix = `[${toolName}]`;
   if (extras.sessionId) messagePrefix += `[s=${extras.sessionId}]`;
   if (extras.requestId) messagePrefix += `[r=${extras.requestId}]`;
 
-  logger.info(`${messagePrefix} START`, params);
+  logger.info(server, `${messagePrefix} START`, params);
 
   try {
     const result = await toolFn(client, params);
-    logger.debug(`${messagePrefix} END`, result);
-    logger.info(`${messagePrefix} END`);
+    logger.debug(server, `${messagePrefix} END`, result);
+    logger.info(server, `${messagePrefix} END`);
     return result;
   } catch (error) {
-    logger.error(`${messagePrefix} END`, {
+    logger.error(server, `${messagePrefix} END`, {
       error: error instanceof Error ? error.message : String(error),
     });
     throw error;
@@ -100,8 +103,8 @@ async function withLogging<T, R>(
 function createToolHandler<TParams>(
   toolFn: (client: DocumentEngineClient, params: TParams) => Promise<MCPToolOutput>
 ): (toolName: string) => MCPToolCallback {
-  return (toolName: string) => async (client, params, extras) => {
-    const result = await withLogging(toolName, extras, toolFn, client, params as TParams);
+  return (toolName: string) => async (server, client, params, extras) => {
+    const result = await withLogging(toolName, extras, toolFn, server, client, params as TParams);
 
     // Create the content array with the markdown text
     const textContent = {
diff --git a/src/utils/Environment.ts b/src/utils/Environment.ts
@@ -17,7 +17,9 @@ const environmentSchema = z.object({
   MAX_RETRIES: z.coerce.number().int().min(0).default(3),
   RETRY_DELAY: z.coerce.number().int().min(0).default(1000),
   MAX_CONNECTIONS: z.coerce.number().int().positive().default(100),
-  LOG_LEVEL: z.enum(['ERROR', 'WARN', 'WARNING', 'INFO', 'DEBUG']).default('INFO'),
+  LOG_LEVEL: z
+    .enum(['debug', 'info', 'notice', 'warning', 'error', 'critical', 'alert', 'emergency'])
+    .default('info'),
 
   // MCP Transport configuration
   MCP_TRANSPORT: z.enum(['stdio', 'http']).default('stdio'),
diff --git a/src/utils/Logger.ts b/src/utils/Logger.ts
diff --git a/test/environment.test.ts b/test/environment.test.ts
diff --git a/test/logger.test.ts b/test/logger.test.ts
diff --git a/test/tools/healthCheck.test.ts b/test/tools/healthCheck.test.ts
