@aztec/foundation 0.65.1 → 0.66.0

package/src/log/pino-logger.ts

@@ -0,0 +1,196 @@
+import { createColors } from 'colorette';
+import isNode from 'detect-node';
+import { pino, symbols } from 'pino';
+import pretty from 'pino-pretty';
+import { type Writable } from 'stream';
+import { inspect } from 'util';
+
+import { compactArray } from '../collection/array.js';
+import { getLogLevelFromFilters, parseEnv } from './log-filters.js';
+import { type LogLevel } from './log-levels.js';
+import { type LogData, type LogFn } from './log_fn.js';
+
+// TODO(palla/log): Rename to createLogger
+export function createDebugLogger(module: string): DebugLogger {
+  // TODO(palla/log): Rename all module names to remove the aztec prefix
+  const pinoLogger = logger.child(
+    { module: module.replace(/^aztec:/, '') },
+    { level: getLogLevelFromFilters(logFilters, module) },
+  );
+
+  // We check manually for isLevelEnabled to avoid calling processLogData unnecessarily.
+  // Note that isLevelEnabled is missing from the browser version of pino.
+  const logFn = (level: LogLevel, msg: string, data?: LogData) =>
+    isLevelEnabled(pinoLogger, level) && pinoLogger[level](processLogData(data ?? {}), msg);
+
+  return {
+    silent: () => {},
+    // TODO(palla/log): Should we move err to data instead of the text message?
+    /** Log as fatal. Use when an error has brought down the system. */
+    fatal: (msg: string, err?: unknown, data?: LogData) => logFn('fatal', formatErr(msg, err), data),
+    /** Log as error. Use for errors in general. */
+    error: (msg: string, err?: unknown, data?: LogData) => logFn('error', formatErr(msg, err), data),
+    /** Log as warn. Use for when we stray from the happy path. */
+    warn: (msg: string, data?: LogData) => logFn('warn', msg, data),
+    /** Log as info. Use for providing an operator with info on what the system is doing. */
+    info: (msg: string, data?: LogData) => logFn('info', msg, data),
+    /** Log as verbose. Use for when we need additional insight on what a subsystem is doing. */
+    verbose: (msg: string, data?: LogData) => logFn('verbose', msg, data),
+    /** Log as debug. Use for when we need debugging info to troubleshoot an issue on a specific component. */
+    debug: (msg: string, data?: LogData) => logFn('debug', msg, data),
+    /** Log as trace. Use for when we want to denial-of-service any recipient of the logs. */
+    trace: (msg: string, data?: LogData) => logFn('trace', msg, data),
+    level: pinoLogger.level as LogLevel,
+    isLevelEnabled: (level: LogLevel) => isLevelEnabled(pinoLogger, level),
+  };
+}
+
+// Allow global hooks for processing log data.
+// Used for injecting OTEL trace_id in telemetry client.
+type LogDataHandler = (data: LogData) => LogData;
+const logDataHandlers: LogDataHandler[] = [];
+
+export function addLogDataHandler(handler: LogDataHandler): void {
+  logDataHandlers.push(handler);
+}
+
+function processLogData(data: LogData): LogData {
+  return logDataHandlers.reduce((accum, handler) => handler(accum), data);
+}
+
+// Patch isLevelEnabled missing from pino/browser.
+function isLevelEnabled(logger: pino.Logger<'verbose', boolean>, level: LogLevel): boolean {
+  return typeof logger.isLevelEnabled === 'function'
+    ? logger.isLevelEnabled(level)
+    : logger.levels.values[level] >= logger.levels.values[logger.level];
+}
+
+// Load log levels from environment variables.
+const defaultLogLevel = process.env.NODE_ENV === 'test' ? 'silent' : 'info';
+const [logLevel, logFilters] = parseEnv(process.env.LOG_LEVEL, defaultLogLevel);
+
+// Transport options for pretty logging to stderr via pino-pretty.
+const useColor = true;
+const { bold, reset } = createColors({ useColor });
+const pinoPrettyOpts = {
+  destination: 2,
+  sync: true,
+  colorize: useColor,
+  ignore: 'module,pid,hostname,trace_id,span_id,trace_flags',
+  messageFormat: `${bold('{module}')} ${reset('{msg}')}`,
+  customLevels: 'fatal:60,error:50,warn:40,info:30,verbose:25,debug:20,trace:10',
+  customColors: 'fatal:bgRed,error:red,warn:yellow,info:green,verbose:magenta,debug:blue,trace:gray',
+  minimumLevel: 'trace' as const,
+};
+const prettyTransport: pino.TransportSingleOptions = {
+  target: 'pino-pretty',
+  options: pinoPrettyOpts,
+};
+
+// Transport for vanilla stdio logging as JSON.
+const stdioTransport: pino.TransportSingleOptions = {
+  target: 'pino/file',
+  options: { destination: 2 },
+};
+
+// Define custom logging levels for pino.
+const customLevels = { verbose: 25 };
+const pinoOpts = { customLevels, useOnlyCustomLevels: false, level: logLevel };
+
+export const levels = {
+  labels: { ...pino.levels.labels, ...Object.fromEntries(Object.entries(customLevels).map(e => e.reverse())) },
+  values: { ...pino.levels.values, ...customLevels },
+};
+
+// Transport for OpenTelemetry logging. While defining this here is an abstraction leakage since this
+// should live in the telemetry-client, it is necessary to ensure that the logger is initialized with
+// the correct transport. Tweaking transports of a live pino instance is tricky, and creating a new instance
+// would mean that all child loggers created before the telemetry-client is initialized would not have
+// this transport configured. Note that the target is defined as the export in the telemetry-client,
+// since pino will load this transport separately on a worker thread, to minimize disruption to the main loop.
+const otlpEndpoint = process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT;
+const otelOpts = { levels };
+const otelTransport: pino.TransportSingleOptions = {
+  target: '@aztec/telemetry-client/otel-pino-stream',
+  options: otelOpts,
+};
+
+function makeLogger() {
+  if (!isNode) {
+    // We are on the browser
+    return pino({ ...pinoOpts, browser: { asObject: false } });
+  } else if (process.env.JEST_WORKER_ID) {
+    // We are on jest, so we need sync logging. We stream to stderr with pretty.
+    return pino(pinoOpts, pretty(pinoPrettyOpts));
+  } else {
+    // Regular nodejs with transports on worker thread, using pino-pretty for console logging if LOG_JSON
+    // is not set, and an optional OTLP transport if the OTLP endpoint is provided.
+    const targets: pino.TransportSingleOptions[] = compactArray([
+      ['1', 'true', 'TRUE'].includes(process.env.LOG_JSON ?? '') ? stdioTransport : prettyTransport,
+      otlpEndpoint ? otelTransport : undefined,
+    ]);
+    return pino(pinoOpts, pino.transport({ targets }));
+  }
+}
+
+const logger = makeLogger();
+
+// Log the logger configuration.
+logger.verbose(
+  {
+    module: 'logger',
+    ...logFilters.reduce((accum, [module, level]) => ({ ...accum, [`log.${module}`]: level }), {}),
+  },
+  isNode
+    ? `Logger initialized with level ${logLevel}` + (otlpEndpoint ? ` with OTLP exporter to ${otlpEndpoint}` : '')
+    : `Browser console logger initialized with level ${logLevel}`,
+);
+
+/**
+ * Registers an additional destination to the pino logger.
+ * Use only when working with destinations, not worker transports.
+ */
+export function registerLoggingStream(stream: Writable): void {
+  logger.verbose({ module: 'logger' }, `Registering additional logging stream`);
+  const original = (logger as any)[symbols.streamSym];
+  const destination = original
+    ? pino.multistream(
+        [
+          // Set streams to lowest logging level, and control actual logging from the parent logger
+          // otherwise streams default to info and refuse to log anything below that.
+          { level: 'trace', stream: original },
+          { level: 'trace', stream },
+        ],
+        { levels: levels.values },
+      )
+    : stream;
+  (logger as any)[symbols.streamSym] = destination;
+}
+
+/** Log function that accepts an exception object */
+type ErrorLogFn = (msg: string, err?: Error | unknown, data?: LogData) => void;
+
+/**
+ * Logger that supports multiple severity levels.
+ */
+export type Logger = { [K in LogLevel]: LogFn } & { /** Error log function */ error: ErrorLogFn } & {
+  level: LogLevel;
+  isLevelEnabled: (level: LogLevel) => boolean;
+};
+
+/**
+ * Logger that supports multiple severity levels and can be called directly to issue a debug statement.
+ * Intended as a drop-in replacement for the debug module.
+ * TODO(palla/log): Remove this alias
+ */
+export type DebugLogger = Logger;
+
+/**
+ * Concatenates a log message and an exception.
+ * @param msg - Log message
+ * @param err - Error to log
+ * @returns A string with both the log message and the error message.
+ */
+function formatErr(msg: string, err?: Error | unknown): string {
+  return err ? `${msg}: ${inspect(err)}` : msg;
+}

package/src/queue/fifo_memory_queue.ts

@@ -1,4 +1,4 @@
-import { type DebugLogger } from '../log/logger.js';
+import { type DebugLogger } from '../log/index.js';
 import { BaseMemoryQueue } from './base_memory_queue.js';
 
 /**

package/dest/log/logger.d.ts

@@ -1,57 +0,0 @@
-import { type LogData, type LogFn } from './log_fn.js';
-declare const LogLevels: readonly ["silent", "error", "warn", "info", "verbose", "debug"];
-/**
- * A valid log severity level.
- */
-export type LogLevel = (typeof LogLevels)[number];
-export declare let currentLevel: "silent" | "error" | "warn" | "info" | "verbose" | "debug";
-/** Log function that accepts an exception object */
-type ErrorLogFn = (msg: string, err?: Error | unknown, data?: LogData) => void;
-/**
- * Logger that supports multiple severity levels.
- */
-export type Logger = {
-    [K in LogLevel]: LogFn;
-} & {
-    error: ErrorLogFn;
-};
-/**
- * Logger that supports multiple severity levels and can be called directly to issue a debug statement.
- * Intended as a drop-in replacement for the debug module.
- */
-export type DebugLogger = Logger;
-/**
- * Creates a new DebugLogger for the current module, defaulting to the LOG_LEVEL env var.
- * If DEBUG="[module]" env is set, will enable debug logging if the module matches.
- * Uses npm debug for debug level and console.error for other levels.
- * @param name - Name of the module.
- * @param fixedLogData - Additional data to include in the log message.
- * @usage createDebugLogger('aztec:validator');
- * // will always add the validator address to the log labels
- * @returns A debug logger.
- */
-export declare function createDebugLogger(name: string): DebugLogger;
-/**
- * A function to create a logger that automatically includes fixed data in each log entry.
- * @param debugLogger - The base DebugLogger instance to which we attach fixed log data.
- * @param fixedLogData - The data to be included in every log entry.
- * @returns A DebugLogger with log level methods (error, warn, info, verbose, debug) that
- * automatically attach `fixedLogData` to every log message.
- */
-export declare function attachedFixedDataToLogger(debugLogger: DebugLogger, fixedLogData: LogData): DebugLogger;
-/** A callback to capture all logs. */
-export type LogHandler = (level: LogLevel, namespace: string, msg: string, data?: LogData) => void;
-/**
- * Registers a callback for all logs, whether they are emitted in the current log level or not.
- * @param handler - Callback to be called on every log.
- */
-export declare function onLog(handler: LogHandler): void;
-/** Overrides current log level. */
-export declare function setLevel(level: LogLevel): void;
-/**
- * Formats structured log data as a string for console output.
- * @param data - Optional log data.
- */
-export declare function fmtLogData(data?: LogData): string;
-export {};
-//# sourceMappingURL=logger.d.ts.map

package/dest/log/logger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/log/logger.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,aAAa,CAAC;AAEvD,QAAA,MAAM,SAAS,kEAAmE,CAAC;AAEnF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAelD,eAAO,IAAI,YAAY,4DAAgB,CAAC;AAwBxC,oDAAoD;AACpD,KAAK,UAAU,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,KAAK,GAAG,OAAO,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;KAAG,CAAC,IAAI,QAAQ,GAAG,KAAK;CAAE,GAAG;IAA4B,KAAK,EAAE,UAAU,CAAA;CAAE,CAAC;AAElG;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;;;;;;;;GASG;AAEH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAqB3D;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,GAAG,WAAW,CActG;AAED,sCAAsC;AACtC,MAAM,MAAM,UAAU,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;AAInG;;;GAGG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,UAAU,QAExC;AAED,mCAAmC;AACnC,wBAAgB,QAAQ,CAAC,KAAK,EAAE,QAAQ,QAEvC;AAkCD;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,CAIjD"}

package/dest/log/logger.js

@@ -1,139 +0,0 @@
-import debug from 'debug';
-import { inspect } from 'util';
-const LogLevels = ['silent', 'error', 'warn', 'info', 'verbose', 'debug'];
-function getLogLevel() {
-    const envLogLevel = process.env.LOG_LEVEL?.toLowerCase();
-    let defaultLogLevel = 'info';
-    if (process.env.DEBUG) {
-        // if we set DEBUG to a non-empty string, use debug as default
-        defaultLogLevel = 'debug';
-    }
-    else if (process.env.NODE_ENV === 'test') {
-        // otherwise, be silent in tests as these are frequently ran en-masse
-        defaultLogLevel = 'silent';
-    }
-    return LogLevels.includes(envLogLevel) ? envLogLevel : defaultLogLevel;
-}
-export let currentLevel = getLogLevel();
-const logElapsedTime = ['1', 'true'].includes(process.env.LOG_ELAPSED_TIME ?? '');
-const firstTimestamp = Date.now();
-function filterNegativePatterns(debugString) {
-    return debugString
-        .split(',')
-        .filter(p => !p.startsWith('-'))
-        .join(',');
-}
-function extractNegativePatterns(debugString) {
-    return (debugString
-        .split(',')
-        .filter(p => p.startsWith('-'))
-        // Remove the leading '-' from the pattern
-        .map(p => p.slice(1)));
-}
-const namespaces = process.env.DEBUG ?? 'aztec:*';
-debug.enable(filterNegativePatterns(namespaces));
-/**
- * Creates a new DebugLogger for the current module, defaulting to the LOG_LEVEL env var.
- * If DEBUG="[module]" env is set, will enable debug logging if the module matches.
- * Uses npm debug for debug level and console.error for other levels.
- * @param name - Name of the module.
- * @param fixedLogData - Additional data to include in the log message.
- * @usage createDebugLogger('aztec:validator');
- * // will always add the validator address to the log labels
- * @returns A debug logger.
- */
-export function createDebugLogger(name) {
-    const debugLogger = debug(name);
-    const negativePatterns = extractNegativePatterns(namespaces);
-    const accepted = () => {
-        return !negativePatterns.some(pattern => name.match(pattern));
-    };
-    const log = (level, msg, data) => {
-        if (accepted()) {
-            logWithDebug(debugLogger, level, msg, data);
-        }
-    };
-    const logger = {
-        silent: () => { },
-        error: (msg, err, data) => log('error', fmtErr(msg, err), data),
-        warn: (msg, data) => log('warn', msg, data),
-        info: (msg, data) => log('info', msg, data),
-        verbose: (msg, data) => log('verbose', msg, data),
-        debug: (msg, data) => log('debug', msg, data),
-    };
-    return Object.assign((msg, data) => log('debug', msg, data), logger);
-}
-/**
- * A function to create a logger that automatically includes fixed data in each log entry.
- * @param debugLogger - The base DebugLogger instance to which we attach fixed log data.
- * @param fixedLogData - The data to be included in every log entry.
- * @returns A DebugLogger with log level methods (error, warn, info, verbose, debug) that
- * automatically attach `fixedLogData` to every log message.
- */
-export function attachedFixedDataToLogger(debugLogger, fixedLogData) {
-    // Helper function to merge fixed data with additional data passed to log entries.
-    const attach = (data) => ({ ...fixedLogData, ...data });
-    // Define the logger with all the necessary log level methods.
-    const logger = {
-        // Silent log level does nothing.
-        silent: () => { },
-        error: (msg, err, data) => debugLogger.error(fmtErr(msg, err), attach(data)),
-        warn: (msg, data) => debugLogger.warn(msg, attach(data)),
-        info: (msg, data) => debugLogger.info(msg, attach(data)),
-        verbose: (msg, data) => debugLogger.verbose(msg, attach(data)),
-        debug: (msg, data) => debugLogger.debug(msg, attach(data)),
-    };
-    return Object.assign((msg, data) => debugLogger.debug(msg, attach(data)), logger);
-}
-const logHandlers = [];
-/**
- * Registers a callback for all logs, whether they are emitted in the current log level or not.
- * @param handler - Callback to be called on every log.
- */
-export function onLog(handler) {
-    logHandlers.push(handler);
-}
-/** Overrides current log level. */
-export function setLevel(level) {
-    currentLevel = level;
-}
-/**
- * Logs args to npm debug if enabled or log level is debug, console.error otherwise.
- * @param debug - Instance of npm debug.
- * @param level - Intended log level.
- * @param args - Args to log.
- */
-function logWithDebug(debug, level, msg, data) {
-    for (const handler of logHandlers) {
-        handler(level, debug.namespace, msg, data);
-    }
-    msg = data ? `${msg} ${fmtLogData(data)}` : msg;
-    if (debug.enabled && LogLevels.indexOf(level) <= LogLevels.indexOf(currentLevel)) {
-        if (logElapsedTime) {
-            const ts = ((Date.now() - firstTimestamp) / 1000).toFixed(3);
-            debug('%ss [%s] %s', ts, level.toUpperCase(), msg);
-        }
-        else {
-            debug('[%s] %s', level.toUpperCase(), msg);
-        }
-    }
-}
-/**
- * Concatenates a log message and an exception.
- * @param msg - Log message
- * @param err - Error to log
- * @returns A string with both the log message and the error message.
- */
-function fmtErr(msg, err) {
-    return err ? `${msg}: ${inspect(err)}` : msg;
-}
-/**
- * Formats structured log data as a string for console output.
- * @param data - Optional log data.
- */
-export function fmtLogData(data) {
-    return Object.entries(data ?? {})
-        .map(([key, value]) => `${key}=${typeof value === 'object' && 'toString' in value ? value.toString() : value}`)
-        .join(' ');
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9nZ2VyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2xvZy9sb2dnZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE1BQU0sT0FBTyxDQUFDO0FBQzFCLE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSxNQUFNLENBQUM7QUFJL0IsTUFBTSxTQUFTLEdBQUcsQ0FBQyxRQUFRLEVBQUUsT0FBTyxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsU0FBUyxFQUFFLE9BQU8sQ0FBVSxDQUFDO0FBT25GLFNBQVMsV0FBVztJQUNsQixNQUFNLFdBQVcsR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLFNBQVMsRUFBRSxXQUFXLEVBQWMsQ0FBQztJQUNyRSxJQUFJLGVBQWUsR0FBYSxNQUFNLENBQUM7SUFDdkMsSUFBSSxPQUFPLENBQUMsR0FBRyxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQ3RCLDhEQUE4RDtRQUM5RCxlQUFlLEdBQUcsT0FBTyxDQUFDO0lBQzVCLENBQUM7U0FBTSxJQUFJLE9BQU8sQ0FBQyxHQUFHLENBQUMsUUFBUSxLQUFLLE1BQU0sRUFBRSxDQUFDO1FBQzNDLHFFQUFxRTtRQUNyRSxlQUFlLEdBQUcsUUFBUSxDQUFDO0lBQzdCLENBQUM7SUFDRCxPQUFPLFNBQVMsQ0FBQyxRQUFRLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUMsZUFBZSxDQUFDO0FBQ3pFLENBQUM7QUFFRCxNQUFNLENBQUMsSUFBSSxZQUFZLEdBQUcsV0FBVyxFQUFFLENBQUM7QUFFeEMsTUFBTSxjQUFjLEdBQUcsQ0FBQyxHQUFHLEVBQUUsTUFBTSxDQUFDLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsZ0JBQWdCLElBQUksRUFBRSxDQUFDLENBQUM7QUFDbEYsTUFBTSxjQUFjLEdBQVcsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDO0FBRTFDLFNBQVMsc0JBQXNCLENBQUMsV0FBbUI7SUFDakQsT0FBTyxXQUFXO1NBQ2YsS0FBSyxDQUFDLEdBQUcsQ0FBQztTQUNWLE1BQU0sQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQztTQUMvQixJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7QUFDZixDQUFDO0FBQ0QsU0FBUyx1QkFBdUIsQ0FBQyxXQUFtQjtJQUNsRCxPQUFPLENBQ0wsV0FBVztTQUNSLEtBQUssQ0FBQyxHQUFHLENBQUM7U0FDVixNQUFNLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQy9CLDBDQUEwQztTQUN6QyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQ3hCLENBQUM7QUFDSixDQUFDO0FBRUQsTUFBTSxVQUFVLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQyxLQUFLLElBQUksU0FBUyxDQUFDO0FBQ2xELEtBQUssQ0FBQyxNQUFNLENBQUMsc0JBQXNCLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQztBQWdCakQ7Ozs7Ozs7OztHQVNHO0FBRUgsTUFBTSxVQUFVLGlCQUFpQixDQUFDLElBQVk7SUFDNUMsTUFBTSxXQUFXLEdBQUcsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBRWhDLE1BQU0sZ0JBQWdCLEdBQUcsdUJBQXVCLENBQUMsVUFBVSxDQUFDLENBQUM7SUFDN0QsTUFBTSxRQUFRLEdBQUcsR0FBRyxFQUFFO1FBQ3BCLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7SUFDaEUsQ0FBQyxDQUFDO0lBQ0YsTUFBTSxHQUFHLEdBQUcsQ0FBQyxLQUFlLEVBQUUsR0FBVyxFQUFFLElBQWMsRUFBRSxFQUFFO1FBQzNELElBQUksUUFBUSxFQUFFLEVBQUUsQ0FBQztZQUNmLFlBQVksQ0FBQyxXQUFXLEVBQUUsS0FBSyxFQUFFLEdBQUcsRUFBRSxJQUFJLENBQUMsQ0FBQztRQUM5QyxDQUFDO0lBQ0gsQ0FBQyxDQUFDO0lBQ0YsTUFBTSxNQUFNLEdBQUc7UUFDYixNQUFNLEVBQUUsR0FBRyxFQUFFLEdBQUUsQ0FBQztRQUNoQixLQUFLLEVBQUUsQ0FBQyxHQUFXLEVBQUUsR0FBYSxFQUFFLElBQWMsRUFBRSxFQUFFLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxNQUFNLENBQUMsR0FBRyxFQUFFLEdBQUcsQ0FBQyxFQUFFLElBQUksQ0FBQztRQUMzRixJQUFJLEVBQUUsQ0FBQyxHQUFXLEVBQUUsSUFBYyxFQUFFLEVBQUUsQ0FBQyxHQUFHLENBQUMsTUFBTSxFQUFFLEdBQUcsRUFBRSxJQUFJLENBQUM7UUFDN0QsSUFBSSxFQUFFLENBQUMsR0FBVyxFQUFFLElBQWMsRUFBRSxFQUFFLENBQUMsR0FBRyxDQUFDLE1BQU0sRUFBRSxHQUFHLEVBQUUsSUFBSSxDQUFDO1FBQzdELE9BQU8sRUFBRSxDQUFDLEdBQVcsRUFBRSxJQUFjLEVBQUUsRUFBRSxDQUFDLEdBQUcsQ0FBQyxTQUFTLEVBQUUsR0FBRyxFQUFFLElBQUksQ0FBQztRQUNuRSxLQUFLLEVBQUUsQ0FBQyxHQUFXLEVBQUUsSUFBYyxFQUFFLEVBQUUsQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLEdBQUcsRUFBRSxJQUFJLENBQUM7S0FDaEUsQ0FBQztJQUNGLE9BQU8sTUFBTSxDQUFDLE1BQU0sQ0FBQyxDQUFDLEdBQVcsRUFBRSxJQUFjLEVBQUUsRUFBRSxDQUFDLEdBQUcsQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFLElBQUksQ0FBQyxFQUFFLE1BQU0sQ0FBQyxDQUFDO0FBQ3pGLENBQUM7QUFFRDs7Ozs7O0dBTUc7QUFDSCxNQUFNLFVBQVUseUJBQXlCLENBQUMsV0FBd0IsRUFBRSxZQUFxQjtJQUN2RixrRkFBa0Y7SUFDbEYsTUFBTSxNQUFNLEdBQUcsQ0FBQyxJQUFjLEVBQUUsRUFBRSxDQUFDLENBQUMsRUFBRSxHQUFHLFlBQVksRUFBRSxHQUFHLElBQUksRUFBRSxDQUFDLENBQUM7SUFDbEUsOERBQThEO0lBQzlELE1BQU0sTUFBTSxHQUFHO1FBQ2IsaUNBQWlDO1FBQ2pDLE1BQU0sRUFBRSxHQUFHLEVBQUUsR0FBRSxDQUFDO1FBQ2hCLEtBQUssRUFBRSxDQUFDLEdBQVcsRUFBRSxHQUFhLEVBQUUsSUFBYyxFQUFFLEVBQUUsQ0FBQyxXQUFXLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLEVBQUUsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ3hHLElBQUksRUFBRSxDQUFDLEdBQVcsRUFBRSxJQUFjLEVBQUUsRUFBRSxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUMxRSxJQUFJLEVBQUUsQ0FBQyxHQUFXLEVBQUUsSUFBYyxFQUFFLEVBQUUsQ0FBQyxXQUFXLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxNQUFNLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDMUUsT0FBTyxFQUFFLENBQUMsR0FBVyxFQUFFLElBQWMsRUFBRSxFQUFFLENBQUMsV0FBVyxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ2hGLEtBQUssRUFBRSxDQUFDLEdBQVcsRUFBRSxJQUFjLEVBQUUsRUFBRSxDQUFDLFdBQVcsQ0FBQyxLQUFLLENBQUMsR0FBRyxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQztLQUM3RSxDQUFDO0lBQ0YsT0FBTyxNQUFNLENBQUMsTUFBTSxDQUFDLENBQUMsR0FBVyxFQUFFLElBQWMsRUFBRSxFQUFFLENBQUMsV0FBVyxDQUFDLEtBQUssQ0FBQyxHQUFHLEVBQUUsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDLEVBQUUsTUFBTSxDQUFDLENBQUM7QUFDdEcsQ0FBQztBQUtELE1BQU0sV0FBVyxHQUFpQixFQUFFLENBQUM7QUFFckM7OztHQUdHO0FBQ0gsTUFBTSxVQUFVLEtBQUssQ0FBQyxPQUFtQjtJQUN2QyxXQUFXLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0FBQzVCLENBQUM7QUFFRCxtQ0FBbUM7QUFDbkMsTUFBTSxVQUFVLFFBQVEsQ0FBQyxLQUFlO0lBQ3RDLFlBQVksR0FBRyxLQUFLLENBQUM7QUFDdkIsQ0FBQztBQUVEOzs7OztHQUtHO0FBQ0gsU0FBUyxZQUFZLENBQUMsS0FBcUIsRUFBRSxLQUFlLEVBQUUsR0FBVyxFQUFFLElBQWM7SUFDdkYsS0FBSyxNQUFNLE9BQU8sSUFBSSxXQUFXLEVBQUUsQ0FBQztRQUNsQyxPQUFPLENBQUMsS0FBSyxFQUFFLEtBQUssQ0FBQyxTQUFTLEVBQUUsR0FBRyxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQzdDLENBQUM7SUFFRCxHQUFHLEdBQUcsSUFBSSxDQUFDLENBQUMsQ0FBQyxHQUFHLEdBQUcsSUFBSSxVQUFVLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDO0lBQ2hELElBQUksS0FBSyxDQUFDLE9BQU8sSUFBSSxTQUFTLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxJQUFJLFNBQVMsQ0FBQyxPQUFPLENBQUMsWUFBWSxDQUFDLEVBQUUsQ0FBQztRQUNqRixJQUFJLGNBQWMsRUFBRSxDQUFDO1lBQ25CLE1BQU0sRUFBRSxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLEdBQUcsY0FBYyxDQUFDLEdBQUcsSUFBSSxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQzdELEtBQUssQ0FBQyxhQUFhLEVBQUUsRUFBRSxFQUFFLEtBQUssQ0FBQyxXQUFXLEVBQUUsRUFBRSxHQUFHLENBQUMsQ0FBQztRQUNyRCxDQUFDO2FBQU0sQ0FBQztZQUNOLEtBQUssQ0FBQyxTQUFTLEVBQUUsS0FBSyxDQUFDLFdBQVcsRUFBRSxFQUFFLEdBQUcsQ0FBQyxDQUFDO1FBQzdDLENBQUM7SUFDSCxDQUFDO0FBQ0gsQ0FBQztBQUVEOzs7OztHQUtHO0FBQ0gsU0FBUyxNQUFNLENBQUMsR0FBVyxFQUFFLEdBQXFCO0lBQ2hELE9BQU8sR0FBRyxDQUFDLENBQUMsQ0FBQyxHQUFHLEdBQUcsS0FBSyxPQUFPLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDO0FBQy9DLENBQUM7QUFFRDs7O0dBR0c7QUFDSCxNQUFNLFVBQVUsVUFBVSxDQUFDLElBQWM7SUFDdkMsT0FBTyxNQUFNLENBQUMsT0FBTyxDQUFDLElBQUksSUFBSSxFQUFFLENBQUM7U0FDOUIsR0FBRyxDQUFDLENBQUMsQ0FBQyxHQUFHLEVBQUUsS0FBSyxDQUFDLEVBQUUsRUFBRSxDQUFDLEdBQUcsR0FBRyxJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVEsSUFBSSxVQUFVLElBQUksS0FBSyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO1NBQzlHLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztBQUNmLENBQUMifQ==

package/src/log/logger.ts

@@ -1,179 +0,0 @@
-import debug from 'debug';
-import { inspect } from 'util';
-
-import { type LogData, type LogFn } from './log_fn.js';
-
-const LogLevels = ['silent', 'error', 'warn', 'info', 'verbose', 'debug'] as const;
-
-/**
- * A valid log severity level.
- */
-export type LogLevel = (typeof LogLevels)[number];
-
-function getLogLevel() {
-  const envLogLevel = process.env.LOG_LEVEL?.toLowerCase() as LogLevel;
-  let defaultLogLevel: LogLevel = 'info';
-  if (process.env.DEBUG) {
-    // if we set DEBUG to a non-empty string, use debug as default
-    defaultLogLevel = 'debug';
-  } else if (process.env.NODE_ENV === 'test') {
-    // otherwise, be silent in tests as these are frequently ran en-masse
-    defaultLogLevel = 'silent';
-  }
-  return LogLevels.includes(envLogLevel) ? envLogLevel : defaultLogLevel;
-}
-
-export let currentLevel = getLogLevel();
-
-const logElapsedTime = ['1', 'true'].includes(process.env.LOG_ELAPSED_TIME ?? '');
-const firstTimestamp: number = Date.now();
-
-function filterNegativePatterns(debugString: string): string {
-  return debugString
-    .split(',')
-    .filter(p => !p.startsWith('-'))
-    .join(',');
-}
-function extractNegativePatterns(debugString: string): string[] {
-  return (
-    debugString
-      .split(',')
-      .filter(p => p.startsWith('-'))
-      // Remove the leading '-' from the pattern
-      .map(p => p.slice(1))
-  );
-}
-
-const namespaces = process.env.DEBUG ?? 'aztec:*';
-debug.enable(filterNegativePatterns(namespaces));
-
-/** Log function that accepts an exception object */
-type ErrorLogFn = (msg: string, err?: Error | unknown, data?: LogData) => void;
-
-/**
- * Logger that supports multiple severity levels.
- */
-export type Logger = { [K in LogLevel]: LogFn } & { /** Error log function */ error: ErrorLogFn };
-
-/**
- * Logger that supports multiple severity levels and can be called directly to issue a debug statement.
- * Intended as a drop-in replacement for the debug module.
- */
-export type DebugLogger = Logger;
-
-/**
- * Creates a new DebugLogger for the current module, defaulting to the LOG_LEVEL env var.
- * If DEBUG="[module]" env is set, will enable debug logging if the module matches.
- * Uses npm debug for debug level and console.error for other levels.
- * @param name - Name of the module.
- * @param fixedLogData - Additional data to include in the log message.
- * @usage createDebugLogger('aztec:validator');
- * // will always add the validator address to the log labels
- * @returns A debug logger.
- */
-
-export function createDebugLogger(name: string): DebugLogger {
-  const debugLogger = debug(name);
-
-  const negativePatterns = extractNegativePatterns(namespaces);
-  const accepted = () => {
-    return !negativePatterns.some(pattern => name.match(pattern));
-  };
-  const log = (level: LogLevel, msg: string, data?: LogData) => {
-    if (accepted()) {
-      logWithDebug(debugLogger, level, msg, data);
-    }
-  };
-  const logger = {
-    silent: () => {},
-    error: (msg: string, err?: unknown, data?: LogData) => log('error', fmtErr(msg, err), data),
-    warn: (msg: string, data?: LogData) => log('warn', msg, data),
-    info: (msg: string, data?: LogData) => log('info', msg, data),
-    verbose: (msg: string, data?: LogData) => log('verbose', msg, data),
-    debug: (msg: string, data?: LogData) => log('debug', msg, data),
-  };
-  return Object.assign((msg: string, data?: LogData) => log('debug', msg, data), logger);
-}
-
-/**
- * A function to create a logger that automatically includes fixed data in each log entry.
- * @param debugLogger - The base DebugLogger instance to which we attach fixed log data.
- * @param fixedLogData - The data to be included in every log entry.
- * @returns A DebugLogger with log level methods (error, warn, info, verbose, debug) that
- * automatically attach `fixedLogData` to every log message.
- */
-export function attachedFixedDataToLogger(debugLogger: DebugLogger, fixedLogData: LogData): DebugLogger {
-  // Helper function to merge fixed data with additional data passed to log entries.
-  const attach = (data?: LogData) => ({ ...fixedLogData, ...data });
-  // Define the logger with all the necessary log level methods.
-  const logger = {
-    // Silent log level does nothing.
-    silent: () => {},
-    error: (msg: string, err?: unknown, data?: LogData) => debugLogger.error(fmtErr(msg, err), attach(data)),
-    warn: (msg: string, data?: LogData) => debugLogger.warn(msg, attach(data)),
-    info: (msg: string, data?: LogData) => debugLogger.info(msg, attach(data)),
-    verbose: (msg: string, data?: LogData) => debugLogger.verbose(msg, attach(data)),
-    debug: (msg: string, data?: LogData) => debugLogger.debug(msg, attach(data)),
-  };
-  return Object.assign((msg: string, data?: LogData) => debugLogger.debug(msg, attach(data)), logger);
-}
-
-/** A callback to capture all logs. */
-export type LogHandler = (level: LogLevel, namespace: string, msg: string, data?: LogData) => void;
-
-const logHandlers: LogHandler[] = [];
-
-/**
- * Registers a callback for all logs, whether they are emitted in the current log level or not.
- * @param handler - Callback to be called on every log.
- */
-export function onLog(handler: LogHandler) {
-  logHandlers.push(handler);
-}
-
-/** Overrides current log level. */
-export function setLevel(level: LogLevel) {
-  currentLevel = level;
-}
-
-/**
- * Logs args to npm debug if enabled or log level is debug, console.error otherwise.
- * @param debug - Instance of npm debug.
- * @param level - Intended log level.
- * @param args - Args to log.
- */
-function logWithDebug(debug: debug.Debugger, level: LogLevel, msg: string, data?: LogData) {
-  for (const handler of logHandlers) {
-    handler(level, debug.namespace, msg, data);
-  }
-
-  msg = data ? `${msg} ${fmtLogData(data)}` : msg;
-  if (debug.enabled && LogLevels.indexOf(level) <= LogLevels.indexOf(currentLevel)) {
-    if (logElapsedTime) {
-      const ts = ((Date.now() - firstTimestamp) / 1000).toFixed(3);
-      debug('%ss [%s] %s', ts, level.toUpperCase(), msg);
-    } else {
-      debug('[%s] %s', level.toUpperCase(), msg);
-    }
-  }
-}
-
-/**
- * Concatenates a log message and an exception.
- * @param msg - Log message
- * @param err - Error to log
- * @returns A string with both the log message and the error message.
- */
-function fmtErr(msg: string, err?: Error | unknown): string {
-  return err ? `${msg}: ${inspect(err)}` : msg;
-}
-
-/**
- * Formats structured log data as a string for console output.
- * @param data - Optional log data.
- */
-export function fmtLogData(data?: LogData): string {
-  return Object.entries(data ?? {})
-    .map(([key, value]) => `${key}=${typeof value === 'object' && 'toString' in value ? value.toString() : value}`)
-    .join(' ');
-}