Skip to content

Self-hosted, plugin-based server management.

8.9 KB
Raw Blame
import chalk, { type ChalkInstance } from "chalk";

export type LogLevel = "debug" | "info" | "warn" | "error" | "success";

const LOG_LEVEL_PRIORITY: Record<LogLevel, number> = {
  debug: 0,
  info: 1,
  success: 1,
  warn: 2,
  error: 3,
};

let globalLogLevel: LogLevel = "info";

export function setGlobalLogLevel(level: string): void {
  const normalized = level.toLowerCase();
  if (normalized in LOG_LEVEL_PRIORITY) {
    globalLogLevel = normalized as LogLevel;
  }
}

export function getGlobalLogLevel(): LogLevel {
  return globalLogLevel;
}

// Initialize from environment variable if set
const envLogLevel = process.env.LOG_LEVEL?.toLowerCase();
if (envLogLevel && envLogLevel in LOG_LEVEL_PRIORITY) {
  globalLogLevel = envLogLevel as LogLevel;
}

export interface LogContext {
  service?: string;
  operation?: string;
  userId?: string;
  hostId?: number;
  sessionId?: string;
  requestId?: string;
  duration?: number;
  [key: string]: unknown;
}

const SENSITIVE_FIELDS = [
  "password",
  "passphrase",
  "key",
  "privateKey",
  "publicKey",
  "token",
  "secret",
  "clientSecret",
  "keyPassword",
  "credentialId",
  "authToken",
  "jwt",
  "session",
  "cookie",
];

const TRUNCATE_FIELDS = ["data", "content", "body", "response", "request"];

export class Logger {
  private serviceName: string;
  private serviceIcon: string;
  private serviceColor: string;
  private logCounts = new Map<string, { count: number; lastLog: number }>();
  private readonly RATE_LIMIT_WINDOW = 60000;
  private readonly RATE_LIMIT_MAX = 10;

  constructor(serviceName: string, serviceIcon: string, serviceColor: string) {
    this.serviceName = serviceName;
    this.serviceIcon = serviceIcon;
    this.serviceColor = serviceColor;
  }

  private getTimeStamp(): string {
    const now = new Date();
    const format = process.env.LOG_TIMESTAMP_FORMAT?.toLowerCase();
    let time: string;
    if (format === "iso") {
      time = now.toISOString();
    } else if (format === "24h") {
      time = now.toLocaleTimeString("en-GB", { hour12: false });
    } else {
      time = now.toLocaleTimeString();
    }
    return chalk.gray(`[${time}]`);
  }

  private sanitizeContext(context: LogContext): LogContext {
    const sanitized = { ...context };

    for (const field of SENSITIVE_FIELDS) {
      if (sanitized[field] !== undefined) {
        if (
          typeof sanitized[field] === "string" &&
          sanitized[field].length > 0
        ) {
          sanitized[field] = "[MASKED]";
        } else if (typeof sanitized[field] === "boolean") {
          sanitized[field] = sanitized[field] ? "[PRESENT]" : "[ABSENT]";
        } else {
          sanitized[field] = "[MASKED]";
        }
      }
    }

    for (const field of TRUNCATE_FIELDS) {
      if (
        sanitized[field] &&
        typeof sanitized[field] === "string" &&
        sanitized[field].length > 100
      ) {
        sanitized[field] = sanitized[field].substring(0, 100) + "...";
      }
    }

    return sanitized;
  }

  private formatMessage(
    level: LogLevel,
    message: string,
    context?: LogContext,
  ): string {
    const timestamp = this.getTimeStamp();
    const levelColor = this.getLevelColor(level);
    const serviceTag = chalk.hex(this.serviceColor)(`[${this.serviceIcon}]`);
    const levelTag = levelColor(`[${level.toUpperCase()}]`);

    let contextStr = "";
    if (context) {
      const sanitizedContext = this.sanitizeContext(context);
      const contextParts = [];
      if (sanitizedContext.operation)
        contextParts.push(`op:${sanitizedContext.operation}`);
      if (sanitizedContext.userId)
        contextParts.push(`user:${sanitizedContext.userId}`);
      if (sanitizedContext.hostId)
        contextParts.push(`host:${sanitizedContext.hostId}`);
      if (sanitizedContext.sessionId)
        contextParts.push(`session:${sanitizedContext.sessionId}`);
      if (sanitizedContext.requestId)
        contextParts.push(`req:${sanitizedContext.requestId}`);
      if (sanitizedContext.source)
        contextParts.push(`source:${sanitizedContext.source}`);
      if (sanitizedContext.sequence !== undefined)
        contextParts.push(`seq:${sanitizedContext.sequence}`);
      if (sanitizedContext.clientUploadTimestamp)
        contextParts.push(
          `clientUpload:${sanitizedContext.clientUploadTimestamp}`,
        );
      if (sanitizedContext.serverReceivedAt)
        contextParts.push(
          `serverReceived:${sanitizedContext.serverReceivedAt}`,
        );
      if (sanitizedContext.bytes !== undefined)
        contextParts.push(`bytes:${sanitizedContext.bytes}`);
      if (sanitizedContext.duration)
        contextParts.push(`duration:${sanitizedContext.duration}ms`);
      if (sanitizedContext.error)
        contextParts.push(`error:${sanitizedContext.error}`);

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

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

  private getLevelColor(level: LogLevel): ChalkInstance {
    switch (level) {
      case "debug":
        return chalk.magenta;
      case "info":
        return chalk.cyan;
      case "warn":
        return chalk.yellow;
      case "error":
        return chalk.redBright;
      case "success":
        return chalk.greenBright;
      default:
        return chalk.white;
    }
  }

  private shouldLog(level: LogLevel, message: string): boolean {
    if (LOG_LEVEL_PRIORITY[level] < LOG_LEVEL_PRIORITY[globalLogLevel]) {
      return false;
    }

    const now = Date.now();
    const logKey = `${level}:${message}`;
    const logInfo = this.logCounts.get(logKey);

    if (logInfo) {
      if (now - logInfo.lastLog < this.RATE_LIMIT_WINDOW) {
        logInfo.count++;
        if (logInfo.count > this.RATE_LIMIT_MAX) {
          return false;
        }
      } else {
        logInfo.count = 1;
        logInfo.lastLog = now;
      }
    } else {
      this.logCounts.set(logKey, { count: 1, lastLog: now });
    }

    return true;
  }

  debug(message: string, context?: LogContext): void {
    if (!this.shouldLog("debug", message)) return;
    console.debug(this.formatMessage("debug", message, context));
  }

  info(message: string, context?: LogContext): void {
    if (!this.shouldLog("info", message)) return;
    console.log(this.formatMessage("info", message, context));
  }

  warn(message: string, context?: LogContext): void {
    if (!this.shouldLog("warn", message)) return;
    console.warn(this.formatMessage("warn", message, context));
  }

  error(message: string, error?: unknown, context?: LogContext): void {
    if (!this.shouldLog("error", message)) return;
    console.error(this.formatMessage("error", message, context));
    if (error) {
      console.error(error);
    }
  }

  success(message: string, context?: LogContext): void {
    if (!this.shouldLog("success", message)) return;
    console.log(this.formatMessage("success", message, context));
  }

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

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

  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" });
  }

  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" });
  }

  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" });
  }
}

export const databaseLogger = new Logger("DATABASE", "πŸ—„οΈ", "#6366f1");
export const sshLogger = new Logger("SSH", "πŸ–₯️", "#0ea5e9");
export const fileLogger = new Logger("FILE", "πŸ“", "#f59e0b");
export const apiLogger = new Logger("API", "🌐", "#3b82f6");
export const authLogger = new Logger("AUTH", "πŸ”", "#ef4444");
export const systemLogger = new Logger("SYSTEM", "πŸš€", "#14b8a6");
export const versionLogger = new Logger("VERSION", "πŸ“¦", "#8b5cf6");
export const dashboardLogger = new Logger("DASHBOARD", "πŸ“Š", "#ec4899");
export const pluginLogger = new Logger("PLUGIN", "🧩", "#84cc16");
export const syncLogger = new Logger("SYNC", "πŸ”„", "#06b6d4");

export const logger = systemLogger;