import { Chalk } from "chalk"; import type { Logger as TsLogger } from "tslog"; import { CHAT_CHANNEL_ORDER } from "../channels/registry.js"; import { defaultRuntime, type RuntimeEnv } from "../runtime.js"; import { getConsoleSettings, shouldLogSubsystemToConsole } from "./console.js"; import { type LogLevel, levelToMinLevel } from "./levels.js"; import { getChildLogger } from "./logger.js"; import { loggingState } from "./state.js"; import { clearActiveProgressLine } from "../terminal/progress-line.js"; type LogObj = { date?: Date } & Record; export type SubsystemLogger = { subsystem: string; trace: (message: string, meta?: Record) => void; debug: (message: string, meta?: Record) => void; info: (message: string, meta?: Record) => void; warn: (message: string, meta?: Record) => void; error: (message: string, meta?: Record) => void; fatal: (message: string, meta?: Record) => void; raw: (message: string) => void; child: (name: string) => SubsystemLogger; }; function shouldLogToConsole(level: LogLevel, settings: { level: LogLevel }): boolean { if (settings.level === "silent") return false; const current = levelToMinLevel(level); const min = levelToMinLevel(settings.level); return current <= min; } type ChalkInstance = InstanceType; function isRichConsoleEnv(): boolean { const term = (process.env.TERM ?? "").toLowerCase(); if (process.env.COLORTERM || process.env.TERM_PROGRAM) return true; return term.length > 0 && term !== "dumb"; } function getColorForConsole(): ChalkInstance { const hasForceColor = typeof process.env.FORCE_COLOR === "string" && process.env.FORCE_COLOR.trim().length > 0 && process.env.FORCE_COLOR.trim() !== "0"; if (process.env.NO_COLOR && !hasForceColor) return new Chalk({ level: 0 }); const hasTty = Boolean(process.stdout.isTTY || process.stderr.isTTY); return hasTty || isRichConsoleEnv() ? new Chalk({ level: 1 }) : new Chalk({ level: 0 }); } const SUBSYSTEM_COLORS = ["cyan", "green", "yellow", "blue", "magenta", "red"] as const; const SUBSYSTEM_COLOR_OVERRIDES: Record = { "gmail-watcher": "blue", }; const SUBSYSTEM_PREFIXES_TO_DROP = ["gateway", "channels", "providers"] as const; const SUBSYSTEM_MAX_SEGMENTS = 2; const CHANNEL_SUBSYSTEM_PREFIXES = new Set(CHAT_CHANNEL_ORDER); function pickSubsystemColor(color: ChalkInstance, subsystem: string): ChalkInstance { const override = SUBSYSTEM_COLOR_OVERRIDES[subsystem]; if (override) return color[override]; let hash = 0; for (let i = 0; i < subsystem.length; i += 1) { hash = (hash * 31 + subsystem.charCodeAt(i)) | 0; } const idx = Math.abs(hash) % SUBSYSTEM_COLORS.length; const name = SUBSYSTEM_COLORS[idx]; return color[name]; } function formatSubsystemForConsole(subsystem: string): string { const parts = subsystem.split("/").filter(Boolean); const original = parts.join("/") || subsystem; while ( parts.length > 0 && SUBSYSTEM_PREFIXES_TO_DROP.includes(parts[0] as (typeof SUBSYSTEM_PREFIXES_TO_DROP)[number]) ) { parts.shift(); } if (parts.length === 0) return original; if (CHANNEL_SUBSYSTEM_PREFIXES.has(parts[0])) { return parts[0]; } if (parts.length > SUBSYSTEM_MAX_SEGMENTS) { return parts.slice(-SUBSYSTEM_MAX_SEGMENTS).join("/"); } return parts.join("/"); } export function stripRedundantSubsystemPrefixForConsole( message: string, displaySubsystem: string, ): string { if (!displaySubsystem) return message; // Common duplication: "[discord] discord: ..." (when a message manually includes the subsystem tag). if (message.startsWith("[")) { const closeIdx = message.indexOf("]"); if (closeIdx > 1) { const bracketTag = message.slice(1, closeIdx); if (bracketTag.toLowerCase() === displaySubsystem.toLowerCase()) { let i = closeIdx + 1; while (message[i] === " ") i += 1; return message.slice(i); } } } const prefix = message.slice(0, displaySubsystem.length); if (prefix.toLowerCase() !== displaySubsystem.toLowerCase()) return message; const next = message.slice(displaySubsystem.length, displaySubsystem.length + 1); if (next !== ":" && next !== " ") return message; let i = displaySubsystem.length; while (message[i] === " ") i += 1; if (message[i] === ":") i += 1; while (message[i] === " ") i += 1; return message.slice(i); } function formatConsoleLine(opts: { level: LogLevel; subsystem: string; message: string; style: "pretty" | "compact" | "json"; meta?: Record; }): string { const displaySubsystem = opts.style === "json" ? opts.subsystem : formatSubsystemForConsole(opts.subsystem); if (opts.style === "json") { return JSON.stringify({ time: new Date().toISOString(), level: opts.level, subsystem: displaySubsystem, message: opts.message, ...opts.meta, }); } const color = getColorForConsole(); const prefix = `[${displaySubsystem}]`; const prefixColor = pickSubsystemColor(color, displaySubsystem); const levelColor = opts.level === "error" || opts.level === "fatal" ? color.red : opts.level === "warn" ? color.yellow : opts.level === "debug" || opts.level === "trace" ? color.gray : color.cyan; const displayMessage = stripRedundantSubsystemPrefixForConsole(opts.message, displaySubsystem); const time = (() => { if (opts.style === "pretty") { return color.gray(new Date().toISOString().slice(11, 19)); } if (loggingState.consoleTimestampPrefix) { return color.gray(new Date().toISOString()); } return ""; })(); const prefixToken = prefixColor(prefix); const head = [time, prefixToken].filter(Boolean).join(" "); return `${head} ${levelColor(displayMessage)}`; } function writeConsoleLine(level: LogLevel, line: string) { clearActiveProgressLine(); const sanitized = process.platform === "win32" && process.env.GITHUB_ACTIONS === "true" ? line.replace(/[\uD800-\uDBFF][\uDC00-\uDFFF]/g, "?").replace(/[\uD800-\uDFFF]/g, "?") : line; const sink = loggingState.rawConsole ?? console; if (loggingState.forceConsoleToStderr || level === "error" || level === "fatal") { (sink.error ?? console.error)(sanitized); } else if (level === "warn") { (sink.warn ?? console.warn)(sanitized); } else { (sink.log ?? console.log)(sanitized); } } function logToFile( fileLogger: TsLogger, level: LogLevel, message: string, meta?: Record, ) { if (level === "silent") return; const safeLevel = level as Exclude; const method = (fileLogger as unknown as Record)[safeLevel] as unknown as | ((...args: unknown[]) => void) | undefined; if (typeof method !== "function") return; if (meta && Object.keys(meta).length > 0) { method.call(fileLogger, meta, message); } else { method.call(fileLogger, message); } } export function createSubsystemLogger(subsystem: string): SubsystemLogger { let fileLogger: TsLogger | null = null; const getFileLogger = () => { if (!fileLogger) fileLogger = getChildLogger({ subsystem }); return fileLogger; }; const emit = (level: LogLevel, message: string, meta?: Record) => { const consoleSettings = getConsoleSettings(); let consoleMessageOverride: string | undefined; let fileMeta = meta; if (meta && Object.keys(meta).length > 0) { const { consoleMessage, ...rest } = meta as Record & { consoleMessage?: unknown; }; if (typeof consoleMessage === "string") { consoleMessageOverride = consoleMessage; } fileMeta = Object.keys(rest).length > 0 ? rest : undefined; } logToFile(getFileLogger(), level, message, fileMeta); if (!shouldLogToConsole(level, { level: consoleSettings.level })) return; if (!shouldLogSubsystemToConsole(subsystem)) return; const line = formatConsoleLine({ level, subsystem, message: consoleSettings.style === "json" ? message : (consoleMessageOverride ?? message), style: consoleSettings.style, meta: fileMeta, }); writeConsoleLine(level, line); }; const logger: SubsystemLogger = { subsystem, trace: (message, meta) => emit("trace", message, meta), debug: (message, meta) => emit("debug", message, meta), info: (message, meta) => emit("info", message, meta), warn: (message, meta) => emit("warn", message, meta), error: (message, meta) => emit("error", message, meta), fatal: (message, meta) => emit("fatal", message, meta), raw: (message) => { logToFile(getFileLogger(), "info", message, { raw: true }); if (shouldLogSubsystemToConsole(subsystem)) { writeConsoleLine("info", message); } }, child: (name) => createSubsystemLogger(`${subsystem}/${name}`), }; return logger; } export function runtimeForLogger( logger: SubsystemLogger, exit: RuntimeEnv["exit"] = defaultRuntime.exit, ): RuntimeEnv { return { log: (message: string) => logger.info(message), error: (message: string) => logger.error(message), exit, }; } export function createSubsystemRuntime( subsystem: string, exit: RuntimeEnv["exit"] = defaultRuntime.exit, ): RuntimeEnv { return runtimeForLogger(createSubsystemLogger(subsystem), exit); }