@loop_ouroboros/mcp-hub-lite 1.0.0

package/dist/server/src/utils/logger/log-output.js

@@ -0,0 +1,320 @@
+/**
+ * Log output management utilities.
+ * This file contains MCP response detection and simplification functions.
+ */
+import { stringifyForLogging } from '../json-utils.js';
+import { logger } from './index.js';
+import { LOG_MODULES } from './log-modules.js';
+import { logStorage } from '../../services/log-storage.service.js';
+/**
+ * Check if a message is a notifications/message.
+ *
+ * @param message - The message to check
+ * @returns true if the message is a notifications/message
+ */
+export function isNotificationMessage(message) {
+    if (typeof message === 'object' && message !== null) {
+        const msg = message;
+        return msg.method === 'notifications/message';
+    }
+    return false;
+}
+/**
+ * Extract message content from notification data.
+ *
+ * @param data - The notification data
+ * @returns The extracted message string
+ */
+function extractMessageFromData(data) {
+    if (typeof data === 'string') {
+        return data;
+    }
+    if (typeof data === 'object' && data !== null) {
+        const dataObj = data;
+        if (typeof dataObj.message === 'string') {
+            return dataObj.message;
+        }
+    }
+    return stringifyForLogging(data);
+}
+/**
+ * Log a notifications/message to the application logs.
+ *
+ * @param message - The notification message
+ * @param context - Optional context (server name, session ID, etc.)
+ * @param serverId - Optional server ID for log storage (for frontend display)
+ */
+export function logNotificationMessage(message, context, serverId) {
+    if (!isNotificationMessage(message)) {
+        return;
+    }
+    const params = message.params;
+    if (!params) {
+        return;
+    }
+    const level = params.level || 'info';
+    const messageContent = params.data ? extractMessageFromData(params.data) : '';
+    if (!messageContent) {
+        return;
+    }
+    // Use params.logger as server name if available, otherwise use context
+    const serverName = params.logger || context;
+    // Map notification level to logger level
+    let logLevel = 'info';
+    switch (level.toLowerCase()) {
+        case 'debug':
+            logLevel = 'debug';
+            break;
+        case 'info':
+            logLevel = 'info';
+            break;
+        case 'warn':
+        case 'warning':
+            logLevel = 'warn';
+            break;
+        case 'error':
+            logLevel = 'error';
+            break;
+        default:
+            logLevel = 'info';
+    }
+    // Use serverLog to log with server name and module context
+    logger.serverLog(logLevel, serverName, messageContent, {
+        module: LOG_MODULES.NOTIFICATIONS_MESSAGE.module
+    });
+    // Store in logStorage for frontend display if serverId is provided
+    if (serverId) {
+        logStorage.append(serverId, logLevel, `[${serverName}] ${messageContent}`);
+    }
+}
+/**
+ * Format an MCP message for logging, with simplification for tools/list,
+ * resources/list, capabilities responses, and image content.
+ *
+ * @param message - The MCP message object to format
+ * @returns Formatted log message string
+ */
+export function formatMcpMessageForLogging(message) {
+    try {
+        const rawJson = JSON.stringify(message);
+        let logMessage;
+        if (isToolsListResponse(rawJson)) {
+            logMessage = simplifyToolsListResponse(rawJson);
+        }
+        else if (hasImageContent(rawJson)) {
+            const simplified = simplifyImageContent(rawJson);
+            try {
+                const parsed = JSON.parse(simplified);
+                logMessage = stringifyForLogging(parsed);
+            }
+            catch {
+                logMessage = simplified;
+            }
+        }
+        else {
+            logMessage = stringifyForLogging(message);
+        }
+        return logMessage;
+    }
+    catch {
+        return '[Unserializable]';
+    }
+}
+/**
+ * Check if data contains image content with binary data.
+ * @param data - stdout or response data
+ * @returns true if it contains image content with data field
+ */
+export function hasImageContent(data) {
+    try {
+        const trimmed = data.trim();
+        if (trimmed.includes('event: message') && trimmed.includes('data:')) {
+            const dataMatch = trimmed.match(/data: ([^\n]+)/);
+            if (dataMatch) {
+                const jsonData = dataMatch[1].trim();
+                return hasImageContent(jsonData);
+            }
+        }
+        if (trimmed.startsWith('{')) {
+            const message = JSON.parse(trimmed);
+            if (typeof message === 'object' && message !== null) {
+                const msg = message;
+                if (msg.result && typeof msg.result === 'object' && msg.result !== null) {
+                    const result = msg.result;
+                    if ('content' in result && Array.isArray(result.content)) {
+                        const content = result.content;
+                        return content.some((item) => typeof item === 'object' && item !== null && item.type === 'image' && 'data' in item);
+                    }
+                }
+            }
+        }
+    }
+    catch {
+        // Non-JSON data, ignore
+    }
+    return false;
+}
+/**
+ * Simplify image content by replacing binary data with placeholder.
+ * @param data - Complete response data
+ * @returns Log information with binary image data replaced
+ */
+export function simplifyImageContent(data) {
+    try {
+        const trimmed = data.trim();
+        if (trimmed.includes('event: message') && trimmed.includes('data:')) {
+            const dataMatch = trimmed.match(/data: ([^\n]+)/);
+            if (dataMatch) {
+                const jsonData = dataMatch[1].trim();
+                const simplified = simplifyImageContent(jsonData);
+                return `event: message\ndata: ${simplified}`;
+            }
+        }
+        if (trimmed.startsWith('{')) {
+            const message = JSON.parse(trimmed);
+            if (typeof message === 'object' && message !== null) {
+                const msg = message;
+                if (msg.result && typeof msg.result === 'object' && msg.result !== null) {
+                    const result = msg.result;
+                    if ('content' in result && Array.isArray(result.content)) {
+                        const content = result.content;
+                        const modifiedContent = content.map((item) => {
+                            if (typeof item === 'object' &&
+                                item !== null &&
+                                item.type === 'image' &&
+                                'data' in item) {
+                                return {
+                                    ...item,
+                                    data: '[BinaryImageData]'
+                                };
+                            }
+                            return item;
+                        });
+                        const modifiedResult = {
+                            ...result,
+                            content: modifiedContent
+                        };
+                        const modifiedMessage = {
+                            ...message,
+                            result: modifiedResult
+                        };
+                        return JSON.stringify(modifiedMessage);
+                    }
+                }
+            }
+        }
+    }
+    catch {
+        // Parsing failed, return original data
+    }
+    return data;
+}
+/**
+ * Check if data is a tools/list response.
+ * @param data - stdout or response data
+ * @returns true if it's a tools/list response
+ */
+export function isToolsListResponse(data) {
+    try {
+        const trimmed = data.trim();
+        if (trimmed.includes('event: message') && trimmed.includes('data:')) {
+            const dataMatch = trimmed.match(/data: ([^\n]+)/);
+            if (dataMatch) {
+                const jsonData = dataMatch[1].trim();
+                return isToolsListResponse(jsonData);
+            }
+        }
+        if (trimmed.startsWith('{')) {
+            const message = JSON.parse(trimmed);
+            if (typeof message === 'object' && message !== null) {
+                const msg = message;
+                if (msg.result && typeof msg.result === 'object' && msg.result !== null) {
+                    const result = msg.result;
+                    if ('tools' in result) {
+                        return true;
+                    }
+                    if ('resources' in result) {
+                        return true;
+                    }
+                    if ('capabilities' in result &&
+                        typeof result.capabilities === 'object' &&
+                        result.capabilities !== null) {
+                        const capabilities = result.capabilities;
+                        if ('tools' in capabilities || 'resources' in capabilities) {
+                            return true;
+                        }
+                    }
+                }
+            }
+        }
+    }
+    catch {
+        // Non-JSON data, ignore
+    }
+    return false;
+}
+/**
+ * Simplify tools/list response log information.
+ * @param data - Complete response data
+ * @returns Simplified log information
+ */
+export function simplifyToolsListResponse(data) {
+    try {
+        const trimmed = data.trim();
+        if (trimmed.includes('event: message') && trimmed.includes('data:')) {
+            const dataMatch = trimmed.match(/data: ([^\n]+)/);
+            if (dataMatch) {
+                const jsonData = dataMatch[1].trim();
+                const simplified = simplifyToolsListResponse(jsonData);
+                return `event: message\ndata: ${simplified}`;
+            }
+        }
+        if (trimmed.startsWith('{')) {
+            const message = JSON.parse(trimmed);
+            if (typeof message === 'object' && message !== null) {
+                const msg = message;
+                if (msg.result && typeof msg.result === 'object' && msg.result !== null) {
+                    const result = msg.result;
+                    if ('tools' in result) {
+                        const toolsCount = Array.isArray(result.tools) ? result.tools.length : 0;
+                        return `Returned ${toolsCount} tools`;
+                    }
+                    if ('resources' in result) {
+                        const resourcesCount = Array.isArray(result.resources) ? result.resources.length : 0;
+                        return `Returned ${resourcesCount} resources`;
+                    }
+                    if ('capabilities' in result &&
+                        typeof result.capabilities === 'object' &&
+                        result.capabilities !== null) {
+                        const capabilities = result.capabilities;
+                        let toolsCount = 0;
+                        let resourcesCount = 0;
+                        if ('tools' in capabilities &&
+                            typeof capabilities.tools === 'object' &&
+                            capabilities.tools !== null) {
+                            toolsCount = Object.keys(capabilities.tools).length;
+                        }
+                        if ('resources' in capabilities &&
+                            typeof capabilities.resources === 'object' &&
+                            capabilities.resources !== null) {
+                            resourcesCount = Object.keys(capabilities.resources).length;
+                        }
+                        if (toolsCount > 0 && resourcesCount > 0) {
+                            return `Returned ${toolsCount} tools and ${resourcesCount} resources`;
+                        }
+                        else if (toolsCount > 0) {
+                            return `Returned ${toolsCount} tools`;
+                        }
+                        else if (resourcesCount > 0) {
+                            return `Returned ${resourcesCount} resources`;
+                        }
+                    }
+                }
+            }
+        }
+    }
+    catch {
+        // Parsing failed, return truncated version of original data
+    }
+    return data.length > 200 ? data.substring(0, 200) + '...' : data;
+}

package/dist/server/src/utils/logger/logger.d.ts

@@ -0,0 +1,190 @@
+/**
+ * Advanced structured logger with color support, file output, and context-aware logging.
+ *
+ * This logger provides comprehensive logging capabilities with the following features:
+ * - ANSI color-coded console output with different colors for each log level
+ * - Structured context information including PID, server name, trace ID, span ID
+ * - File output with plain text formatting (no colors) for log analysis
+ * - Development mode with automatic log file creation and clearing
+ * - Context-aware logging with module, traceId, and spanId support
+ * - Error formatting with stack trace truncation to prevent overly verbose logs
+ * - MCP server-specific logging with serverName context
+ * - Log rotation with date-based file naming and automatic cleanup
+ *
+ * The logger supports four log levels: debug, info, warn, and error, with configurable
+ * minimum log level threshold.
+ *
+ * @example
+ * ```typescript
+ * // Basic usage
+ * logger.info('Server started', { port: 7788 });
+ *
+ * // With context
+ * logger.error('Connection failed', { error: err.message, serverName: 'my-server' });
+ *
+ * // Development mode
+ * logger.enableDevLog();
+ * ```
+ */
+import type { LogLevel } from '../../../shared/types/common.types.js';
+import type { LogContext } from './log-context.js';
+import { DevLogger } from './dev-logger.js';
+export declare class Logger {
+    private level;
+    private useStderr;
+    private useColor;
+    private devLogger;
+    constructor(level?: LogLevel);
+    /**
+     * Enables development logging mode with file output and enhanced debugging.
+     *
+     * @param rotatorConfig - Optional custom rotation configuration (default: 7 days retention)
+     * @example
+     * ```typescript
+     * const logger = new Logger();
+     * logger.enableDevLog(); // Logs will be written to logs/dev-server.2026-02-27.log
+     *
+     * // With custom retention period
+     * logger.enableDevLog({ rotationAge: '14d' });
+     * ```
+     */
+    enableDevLog(rotatorConfig?: Parameters<DevLogger['enableDevLog']>[0]): void;
+    setUseStderr(use: boolean): void;
+    /**
+     * Enable or disable ANSI color output.
+     * When disabled, logs will be plain text without color codes.
+     *
+     * @param use - Whether to use color in output
+     * @example
+     * ```typescript
+     * logger.setUseColor(false); // Plain text output for files
+     * ```
+     */
+    setUseColor(use: boolean): void;
+    /**
+     * Check if a message should be logged at the current level.
+     * @internal Public for testing only
+     */
+    shouldLog(messageLevel: LogLevel): boolean;
+    /**
+     * Generic logging method to eliminate code duplication.
+     */
+    private log;
+    /**
+     * Logs a debug message with optional context and additional arguments.
+     *
+     * @param message - The primary log message
+     * @param args - Additional arguments to include in the log
+     *
+     * @example
+     * ```typescript
+     * // Basic debug message
+     * logger.debug('Processing request');
+     *
+     * // With context
+     * logger.debug('Tool called', { module: 'Gateway', traceId: 'abc123' }, toolName, args);
+     * ```
+     */
+    debug(message: string, ...args: unknown[]): void;
+    /**
+     * Logs an informational message with optional context and additional arguments.
+     *
+     * @param message - The primary log message
+     * @param args - Additional arguments to include in the log
+     *
+     * @example
+     * ```typescript
+     * // Basic info message
+     * logger.info('Server started successfully');
+     *
+     * // With context and additional data
+     * logger.info('Request processed', { module: 'API' }, { duration: 150, statusCode: 200 });
+     * ```
+     */
+    info(message: string, ...args: unknown[]): void;
+    /**
+     * Logs a warning message with optional context and additional arguments.
+     *
+     * @param message - The primary log message
+     * @param args - Additional arguments to include in the log
+     *
+     * @example
+     * ```typescript
+     * // Basic warning message
+     * logger.warn('Deprecated API usage detected');
+     *
+     * // With context and error details
+     * logger.warn('Connection timeout', { module: 'Network' }, { server: 'api.example.com', timeout: 5000 });
+     * ```
+     */
+    warn(message: string, ...args: unknown[]): void;
+    /**
+     * Logs an error message with optional context and additional arguments.
+     *
+     * @param message - The primary log message
+     * @param args - Additional arguments to include in the log
+     *
+     * @example
+     * ```typescript
+     * // Basic error message
+     * logger.error('Database connection failed');
+     *
+     * // With error object and context
+     * logger.error('Request processing failed', { module: 'API' }, error, { requestId: '123' });
+     * ```
+     */
+    error(message: string, ...args: unknown[]): void;
+    private extractOptionsAndArgs;
+    setLevel(level: LogLevel): void;
+    /**
+     * Method specifically for MCP Server logging.
+     * Handles multi-line messages by splitting them into individual log entries.
+     */
+    serverLog(level: LogLevel, serverName: string, message: string, context?: Omit<LogContext, 'serverName'>): void;
+    /**
+     * Internal helper to log a single line for serverLog.
+     * Contains the core logging logic originally in serverLog.
+     */
+    private logSingleServerLine;
+    /**
+     * Internal accessor for testing and legacy compatibility.
+     * @internal
+     */
+    get logFileStream(): unknown;
+    /**
+     * Internal accessor for testing and legacy compatibility.
+     * @internal
+     */
+    get devLogRotator(): unknown;
+    /**
+     * Internal method for testing and legacy compatibility.
+     * @internal
+     */
+    createColoredLogMessage(level: LogLevel, message: string, context?: LogContext): string;
+    /**
+     * Internal method for testing and legacy compatibility.
+     * @internal
+     */
+    createLogMessage(level: LogLevel, message: string, context?: LogContext): string;
+    /**
+     * Internal method for testing and legacy compatibility.
+     * @internal
+     */
+    formatError(error: unknown): string;
+    /**
+     * Internal method for testing and legacy compatibility.
+     * @internal
+     */
+    formatTimestamp(date: Date): string;
+    /**
+     * Internal method for testing and legacy compatibility.
+     * @internal
+     */
+    formatLogLevel(level: LogLevel): string;
+    /**
+     * Internal method for testing and legacy compatibility.
+     * @internal
+     */
+    formatPid(pid: number): string;
+}
+//# sourceMappingURL=logger.d.ts.map

package/dist/server/src/utils/logger/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../../../src/utils/logger/logger.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,KAAK,EAAE,UAAU,EAAc,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAY5C,qBAAa,MAAM;IACjB,OAAO,CAAC,KAAK,CAAoB;IACjC,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,SAAS,CAA8B;gBAEnC,KAAK,GAAE,QAAiB;IAcpC;;;;;;;;;;;;OAYG;IACI,YAAY,CAAC,aAAa,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;IAO5E,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAIvC;;;;;;;;;OASG;IACI,WAAW,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAItC;;;OAGG;IACH,SAAS,CAAC,YAAY,EAAE,QAAQ,GAAG,OAAO;IAK1C;;OAEG;IACH,OAAO,CAAC,GAAG;IAgDX;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAKhD;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAK/C;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAK/C;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAKhD,OAAO,CAAC,qBAAqB;IAkB7B,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI;IAI/B;;;OAGG;IACH,SAAS,CACP,KAAK,EAAE,QAAQ,EACf,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,GACvC,IAAI;IAuBP;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IA4C3B;;;OAGG;IACH,IAAI,aAAa,IAAI,OAAO,CAE3B;IAED;;;OAGG;IACH,IAAI,aAAa,IAAI,OAAO,CAE3B;IAED;;;OAGG;IACH,uBAAuB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,MAAM;IAIvF;;;OAGG;IACH,gBAAgB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,MAAM;IAIhF;;;OAGG;IACH,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;IAInC;;;OAGG;IACH,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM;IAInC;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;IAIvC;;;OAGG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;CAG/B"}