File size: 12,966 Bytes
fc93158 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 | import { Chalk } from "chalk";
import type { Logger as TsLogger } from "tslog";
import { isVerbose } from "../globals.js";
import { defaultRuntime, type RuntimeEnv } from "../runtime.js";
import { clearActiveProgressLine } from "../terminal/progress-line.js";
import {
formatConsoleTimestamp,
getConsoleSettings,
shouldLogSubsystemToConsole,
} from "./console.js";
import { type LogLevel, levelToMinLevel } from "./levels.js";
import { getChildLogger, isFileLogLevelEnabled } from "./logger.js";
import { loggingState } from "./state.js";
type LogObj = { date?: Date } & Record<string, unknown>;
export type SubsystemLogger = {
subsystem: string;
isEnabled: (level: LogLevel, target?: "any" | "console" | "file") => boolean;
trace: (message: string, meta?: Record<string, unknown>) => void;
debug: (message: string, meta?: Record<string, unknown>) => void;
info: (message: string, meta?: Record<string, unknown>) => void;
warn: (message: string, meta?: Record<string, unknown>) => void;
error: (message: string, meta?: Record<string, unknown>) => void;
fatal: (message: string, meta?: Record<string, unknown>) => 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<typeof Chalk>;
const inspectValue: ((value: unknown) => string) | null = (() => {
const getBuiltinModule = (
process as NodeJS.Process & {
getBuiltinModule?: (id: string) => unknown;
}
).getBuiltinModule;
if (typeof getBuiltinModule !== "function") {
return null;
}
try {
const utilNamespace = getBuiltinModule("util") as {
inspect?: (value: unknown) => string;
};
return typeof utilNamespace.inspect === "function" ? utilNamespace.inspect : null;
} catch {
return null;
}
})();
function formatRuntimeArg(arg: unknown): string {
if (typeof arg === "string") {
return arg;
}
if (inspectValue) {
return inspectValue(arg);
}
try {
return JSON.stringify(arg);
} catch {
return String(arg);
}
}
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<string, (typeof SUBSYSTEM_COLORS)[number]> = {
"gmail-watcher": "blue",
};
const SUBSYSTEM_PREFIXES_TO_DROP = ["gateway", "channels", "providers"] as const;
const SUBSYSTEM_MAX_SEGMENTS = 2;
// Keep local to avoid importing channel registry into hot logging paths.
const CHANNEL_SUBSYSTEM_PREFIXES = new Set<string>([
"telegram",
"whatsapp",
"discord",
"irc",
"googlechat",
"slack",
"signal",
"imessage",
]);
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, unknown>;
}): string {
const displaySubsystem =
opts.style === "json" ? opts.subsystem : formatSubsystemForConsole(opts.subsystem);
if (opts.style === "json") {
return JSON.stringify({
time: formatConsoleTimestamp("json"),
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(formatConsoleTimestamp("pretty"));
}
if (loggingState.consoleTimestampPrefix) {
return color.gray(formatConsoleTimestamp(opts.style));
}
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 shouldSuppressProbeConsoleLine(params: {
level: LogLevel;
subsystem: string;
message: string;
meta?: Record<string, unknown>;
}): boolean {
if (isVerbose()) {
return false;
}
if (params.level === "error" || params.level === "fatal") {
return false;
}
const isProbeSuppressedSubsystem =
params.subsystem === "agent/embedded" ||
params.subsystem.startsWith("agent/embedded/") ||
params.subsystem === "model-fallback" ||
params.subsystem.startsWith("model-fallback/");
if (!isProbeSuppressedSubsystem) {
return false;
}
const runLikeId =
typeof params.meta?.runId === "string"
? params.meta.runId
: typeof params.meta?.sessionId === "string"
? params.meta.sessionId
: undefined;
if (runLikeId?.startsWith("probe-")) {
return true;
}
return /(sessionId|runId)=probe-/.test(params.message);
}
function logToFile(
fileLogger: TsLogger<LogObj>,
level: LogLevel,
message: string,
meta?: Record<string, unknown>,
) {
if (level === "silent") {
return;
}
const safeLevel = level;
const method = (fileLogger as unknown as Record<string, unknown>)[safeLevel] 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<LogObj> | null = null;
const getFileLogger = () => {
if (!fileLogger) {
fileLogger = getChildLogger({ subsystem });
}
return fileLogger;
};
const emit = (level: LogLevel, message: string, meta?: Record<string, unknown>) => {
const consoleSettings = getConsoleSettings();
const consoleEnabled =
shouldLogToConsole(level, { level: consoleSettings.level }) &&
shouldLogSubsystemToConsole(subsystem);
const fileEnabled = isFileLogLevelEnabled(level);
if (!consoleEnabled && !fileEnabled) {
return;
}
let consoleMessageOverride: string | undefined;
let fileMeta = meta;
if (meta && Object.keys(meta).length > 0) {
const { consoleMessage, ...rest } = meta as Record<string, unknown> & {
consoleMessage?: unknown;
};
if (typeof consoleMessage === "string") {
consoleMessageOverride = consoleMessage;
}
fileMeta = Object.keys(rest).length > 0 ? rest : undefined;
}
if (fileEnabled) {
logToFile(getFileLogger(), level, message, fileMeta);
}
if (!consoleEnabled) {
return;
}
const consoleMessage = consoleMessageOverride ?? message;
if (
shouldSuppressProbeConsoleLine({
level,
subsystem,
message: consoleMessage,
meta: fileMeta,
})
) {
return;
}
const line = formatConsoleLine({
level,
subsystem,
message: consoleSettings.style === "json" ? message : consoleMessage,
style: consoleSettings.style,
meta: fileMeta,
});
writeConsoleLine(level, line);
};
const isConsoleEnabled = (level: LogLevel): boolean => {
const consoleSettings = getConsoleSettings();
return (
shouldLogToConsole(level, { level: consoleSettings.level }) &&
shouldLogSubsystemToConsole(subsystem)
);
};
const isFileEnabled = (level: LogLevel): boolean => isFileLogLevelEnabled(level);
const logger: SubsystemLogger = {
subsystem,
isEnabled: (level, target = "any") => {
if (target === "console") {
return isConsoleEnabled(level);
}
if (target === "file") {
return isFileEnabled(level);
}
return isConsoleEnabled(level) || isFileEnabled(level);
},
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) => {
if (isFileEnabled("info")) {
logToFile(getFileLogger(), "info", message, { raw: true });
}
if (isConsoleEnabled("info")) {
if (shouldSuppressProbeConsoleLine({ level: "info", subsystem, message })) {
return;
}
writeConsoleLine("info", message);
}
},
child: (name) => createSubsystemLogger(`${subsystem}/${name}`),
};
return logger;
}
export function runtimeForLogger(
logger: SubsystemLogger,
exit: RuntimeEnv["exit"] = defaultRuntime.exit,
): RuntimeEnv {
const formatArgs = (...args: unknown[]) =>
args
.map((arg) => formatRuntimeArg(arg))
.join(" ")
.trim();
return {
log: (...args: unknown[]) => logger.info(formatArgs(...args)),
error: (...args: unknown[]) => logger.error(formatArgs(...args)),
exit,
};
}
export function createSubsystemRuntime(
subsystem: string,
exit: RuntimeEnv["exit"] = defaultRuntime.exit,
): RuntimeEnv {
return runtimeForLogger(createSubsystemLogger(subsystem), exit);
}
|