Skip to content

Self-hosted, plugin-based server management.

10.2 KB
Raw Blame
export type LogLevel = "debug" | "info" | "warn" | "error" | "success";

export interface LogContext {
  operation?: string;
  userId?: string;
  hostId?: number;
  sessionId?: string;
  requestId?: string;
  duration?: number;
  method?: string;
  url?: string;
  status?: number;
  statusText?: string;
  responseTime?: number;
  retryCount?: number;
  errorCode?: string;
  errorMessage?: string;

  [key: string]: unknown;
}

class FrontendLogger {
  private serviceName: string;
  private serviceIcon: string;
  private serviceColor: string;
  private isDevelopment: boolean;

  constructor(serviceName: string, serviceIcon: string, serviceColor: string) {
    this.serviceName = serviceName;
    this.serviceIcon = serviceIcon;
    this.serviceColor = serviceColor;
    this.isDevelopment = process.env.NODE_ENV === "development";
  }

  private getTimeStamp(): string {
    const now = new Date();
    return `[${now.toLocaleTimeString()}.${now.getMilliseconds().toString().padStart(3, "0")}]`;
  }

  private formatMessage(
    level: LogLevel,
    message: string,
    context?: LogContext,
  ): string {
    const timestamp = this.getTimeStamp();
    const levelTag = this.getLevelTag(level);
    const serviceTag = this.getServiceTag();

    let contextStr = "";
    if (context && this.isDevelopment) {
      const contextParts = [];
      if (context.operation) contextParts.push(context.operation);
      if (context.userId) contextParts.push(`user:${context.userId}`);
      if (context.hostId) contextParts.push(`host:${context.hostId}`);
      if (context.sessionId) contextParts.push(`session:${context.sessionId}`);
      if (context.responseTime) contextParts.push(`${context.responseTime}ms`);
      if (context.status) contextParts.push(`status:${context.status}`);
      if (context.errorCode) contextParts.push(`code:${context.errorCode}`);

      if (contextParts.length > 0) {
        contextStr = ` (${contextParts.join(", ")})`;
      }
    }

    return `${timestamp} ${levelTag} ${serviceTag} ${message}${contextStr}`;
  }

  private getLevelTag(level: LogLevel): string {
    const symbols = {
      debug: "πŸ”",
      info: "ℹ️",
      warn: "⚠️",
      error: "❌",
      success: "βœ…",
    };
    return `${symbols[level]} [${level.toUpperCase()}]`;
  }

  private getServiceTag(): string {
    return `${this.serviceIcon} [${this.serviceName}]`;
  }

  private shouldLog(level: LogLevel): boolean {
    if (level === "debug" && !this.isDevelopment) {
      return false;
    }
    return true;
  }

  private log(
    level: LogLevel,
    message: string,
    context?: LogContext,
    error?: unknown,
  ): void {
    if (!this.shouldLog(level)) return;

    const formattedMessage = this.formatMessage(level, message, context);

    switch (level) {
      case "debug":
        console.debug(formattedMessage);
        break;
      case "info":
        console.log(formattedMessage);
        break;
      case "warn":
        console.warn(formattedMessage);
        break;
      case "error":
        console.error(formattedMessage);
        if (error) {
          console.error("Error details:", error);
        }
        break;
      case "success":
        console.log(formattedMessage);
        break;
    }
  }

  debug(message: string, context?: LogContext): void {
    this.log("debug", message, context);
  }

  info(message: string, context?: LogContext): void {
    this.log("info", message, context);
  }

  warn(message: string, context?: LogContext): void {
    this.log("warn", message, context);
  }

  error(message: string, error?: unknown, context?: LogContext): void {
    this.log("error", message, context, error);
  }

  success(message: string, context?: LogContext): void {
    this.log("success", message, context);
  }

  api(message: string, context?: LogContext): void {
    this.info(`API: ${message}`, { ...context, operation: "api" });
  }

  request(message: string, context?: LogContext): void {
    this.info(`REQUEST: ${message}`, { ...context, operation: "request" });
  }

  response(message: string, context?: LogContext): void {
    this.info(`RESPONSE: ${message}`, { ...context, operation: "response" });
  }

  auth(message: string, context?: LogContext): void {
    this.info(`AUTH: ${message}`, { ...context, operation: "auth" });
  }

  ssh(message: string, context?: LogContext): void {
    this.info(`SSH: ${message}`, { ...context, operation: "ssh" });
  }

  file(message: string, context?: LogContext): void {
    this.info(`FILE: ${message}`, { ...context, operation: "file" });
  }

  connection(message: string, context?: LogContext): void {
    this.info(`CONNECTION: ${message}`, {
      ...context,
      operation: "connection",
    });
  }

  disconnect(message: string, context?: LogContext): void {
    this.info(`DISCONNECT: ${message}`, {
      ...context,
      operation: "disconnect",
    });
  }

  retry(message: string, context?: LogContext): void {
    this.warn(`RETRY: ${message}`, { ...context, operation: "retry" });
  }

  performance(message: string, context?: LogContext): void {
    this.info(`PERFORMANCE: ${message}`, {
      ...context,
      operation: "performance",
    });
  }

  security(message: string, context?: LogContext): void {
    this.warn(`SECURITY: ${message}`, { ...context, operation: "security" });
  }

  requestStart(method: string, url: string, context?: LogContext): void {
    const cleanUrl = this.sanitizeUrl(url);
    const shortUrl = this.getShortUrl(cleanUrl);

    console.group(`πŸš€ ${method.toUpperCase()} ${shortUrl}`);
    this.request(`β†’ Starting request to ${cleanUrl}`, {
      ...context,
      method: method.toUpperCase(),
      url: cleanUrl,
    });
  }

  requestSuccess(
    method: string,
    url: string,
    status: number,
    responseTime: number,
    context?: LogContext,
  ): void {
    const cleanUrl = this.sanitizeUrl(url);
    const statusIcon = this.getStatusIcon(status);
    const performanceIcon = this.getPerformanceIcon(responseTime);

    this.response(
      `← ${statusIcon} ${status} ${performanceIcon} ${responseTime}ms`,
      {
        ...context,
        method: method.toUpperCase(),
        url: cleanUrl,
        status,
        responseTime,
      },
    );
    console.groupEnd();
  }

  requestError(
    method: string,
    url: string,
    status: number,
    errorMessage: string,
    responseTime?: number,
    context?: LogContext,
  ): void {
    const cleanUrl = this.sanitizeUrl(url);
    const statusIcon = this.getStatusIcon(status);

    this.error(`← ${statusIcon} ${status} ${errorMessage}`, undefined, {
      ...context,
      method: method.toUpperCase(),
      url: cleanUrl,
      status,
      errorMessage,
      responseTime,
    });
    console.groupEnd();
  }

  networkError(
    method: string,
    url: string,
    errorMessage: string,
    context?: LogContext,
  ): void {
    const cleanUrl = this.sanitizeUrl(url);

    this.error(`🌐 Network Error: ${errorMessage}`, undefined, {
      ...context,
      method: method.toUpperCase(),
      url: cleanUrl,
      errorMessage,
      errorCode: "NETWORK_ERROR",
    });
    console.groupEnd();
  }

  authError(method: string, url: string, context?: LogContext): void {
    const cleanUrl = this.sanitizeUrl(url);

    this.security(`πŸ” Authentication Required`, {
      ...context,
      method: method.toUpperCase(),
      url: cleanUrl,
      errorCode: "AUTH_REQUIRED",
    });
    console.groupEnd();
  }

  retryAttempt(
    method: string,
    url: string,
    attempt: number,
    maxAttempts: number,
    context?: LogContext,
  ): void {
    const cleanUrl = this.sanitizeUrl(url);

    this.retry(`πŸ”„ Retry ${attempt}/${maxAttempts}`, {
      ...context,
      method: method.toUpperCase(),
      url: cleanUrl,
      retryCount: attempt,
    });
  }

  apiOperation(operation: string, details: string, context?: LogContext): void {
    this.info(`πŸ”§ ${operation}: ${details}`, {
      ...context,
      operation: "api_operation",
    });
  }

  requestSummary(
    method: string,
    url: string,
    status: number,
    responseTime: number,
    context?: LogContext,
  ): void {
    const cleanUrl = this.sanitizeUrl(url);
    const shortUrl = this.getShortUrl(cleanUrl);
    const statusIcon = this.getStatusIcon(status);
    const performanceIcon = this.getPerformanceIcon(responseTime);

    console.log(
      `%cπŸ“Š ${method} ${shortUrl} ${statusIcon} ${status} ${performanceIcon} ${responseTime}ms`,
      "color: #666; font-style: italic; font-size: 0.9em;",
      context,
    );
  }

  private getShortUrl(url: string): string {
    try {
      const urlObj = new URL(url);
      const path = urlObj.pathname;
      const query = urlObj.search;
      return `${urlObj.hostname}${path}${query}`;
    } catch {
      return url.length > 50 ? url.substring(0, 47) + "..." : url;
    }
  }

  private getStatusIcon(status: number): string {
    if (status >= 200 && status < 300) return "βœ…";
    if (status >= 300 && status < 400) return "↩️";
    if (status >= 400 && status < 500) return "⚠️";
    if (status >= 500) return "❌";
    return "❓";
  }

  private getPerformanceIcon(responseTime: number): string {
    if (responseTime < 100) return "⚑";
    if (responseTime < 500) return "πŸš€";
    if (responseTime < 1000) return "πŸƒ";
    if (responseTime < 3000) return "🚢";
    return "🐌";
  }

  private sanitizeUrl(url: string): string {
    try {
      const urlObj = new URL(url);
      if (
        urlObj.searchParams.has("password") ||
        urlObj.searchParams.has("token")
      ) {
        urlObj.search = "";
      }
      return urlObj.toString();
    } catch {
      return url;
    }
  }
}

export const apiLogger = new FrontendLogger("API", "🌐", "#3b82f6");
export const authLogger = new FrontendLogger("AUTH", "πŸ”", "#dc2626");
export const sshLogger = new FrontendLogger("SSH", "πŸ–₯️", "#1e3a8a");
export const fileLogger = new FrontendLogger("FILE", "πŸ“", "#1e3a8a");
export const dashboardLogger = new FrontendLogger("DASHBOARD", "πŸ“Š", "#ec4899");

/** A named console logger, for plugins that want the same log format. */
export function createFrontendLogger(
  serviceName: string,
  serviceIcon = "🧩",
  serviceColor = "#6b7280",
) {
  return new FrontendLogger(serviceName, serviceIcon, serviceColor);
}