@dxos/log 0.8.4-main.c1de068 → 0.8.4-main.c85a9c8dae

package/dist/lib/node-esm/index.mjs

@@ -1,106 +1,51 @@
 import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
+import {
+  LogLevel,
+  LogProcessorType,
+  gatherLogInfoFromScope,
+  getContextFromEntry,
+  getRelativeFilename,
+  levels,
+  logInfo,
+  shortLevelName,
+  shouldLog
+} from "./chunk-62VKC2WQ.mjs";
+import {
+  __export,
+  __reExport
+} from "./chunk-2SZHAWBN.mjs";
 
 // src/index.ts
-import omit from "lodash.omit";
-import { pick } from "@dxos/util";
-
-// src/config.ts
-var LogLevel = /* @__PURE__ */ function(LogLevel2) {
-  LogLevel2[LogLevel2["TRACE"] = 5] = "TRACE";
-  LogLevel2[LogLevel2["DEBUG"] = 10] = "DEBUG";
-  LogLevel2[LogLevel2["VERBOSE"] = 11] = "VERBOSE";
-  LogLevel2[LogLevel2["INFO"] = 12] = "INFO";
-  LogLevel2[LogLevel2["WARN"] = 13] = "WARN";
-  LogLevel2[LogLevel2["ERROR"] = 14] = "ERROR";
-  return LogLevel2;
-}({});
-var levels = {
-  trace: 5,
-  debug: 10,
-  verbose: 11,
-  info: 12,
-  warn: 13,
-  error: 14
-};
-var shortLevelName = {
-  [5]: "T",
-  [10]: "D",
-  [11]: "V",
-  [12]: "I",
-  [13]: "W",
-  [14]: "E"
-};
-var LogProcessorType = /* @__PURE__ */ function(LogProcessorType2) {
-  LogProcessorType2["CONSOLE"] = "console";
-  LogProcessorType2["BROWSER"] = "browser";
-  LogProcessorType2["DEBUG"] = "debug";
-  return LogProcessorType2;
-}({});
-
-// src/scope.ts
-var logInfoProperties = Symbol("logInfoProperties");
-var logInfo = (target, propertyKey, descriptor) => {
-  (target[logInfoProperties] ??= []).push(propertyKey);
-};
-var gatherLogInfoFromScope = (scope) => {
-  if (!scope) {
-    return {};
-  }
-  const res = {};
-  const prototype = Object.getPrototypeOf(scope);
-  const infoProps = prototype[logInfoProperties] ?? [];
-  for (const prop of infoProps) {
-    try {
-      res[prop] = typeof scope[prop] === "function" ? scope[prop]() : scope[prop];
-    } catch (err) {
-      res[prop] = err.message;
-    }
-  }
-  return res;
-};
-
-// src/context.ts
-var matchFilter = (filter, level, path) => {
-  return level >= filter.level && (!filter.pattern || path.includes(filter.pattern));
-};
-var shouldLog = (entry, filters) => {
-  if (filters === void 0) {
-    return true;
-  } else {
-    return filters.some((filter) => matchFilter(filter, entry.level, entry.meta?.F ?? ""));
-  }
-};
-var getContextFromEntry = (entry) => {
-  let context;
-  if (entry.meta) {
-    const scopeInfo = gatherLogInfoFromScope(entry.meta.S);
-    if (Object.keys(scopeInfo).length > 0) {
-      context = Object.assign(context ?? {}, scopeInfo);
-    }
-  }
-  const entryContext = typeof entry.context === "function" ? entry.context() : entry.context;
-  if (entryContext) {
-    if (entryContext instanceof Error) {
-      const c = entryContext.context;
-      context = Object.assign(context ?? {}, {
-        error: entryContext.stack,
-        ...c
-      });
-    } else if (typeof entryContext === "object") {
-      context = Object.assign(context ?? {}, entryContext);
-    }
-  }
-  if (entry.error) {
-    context = Object.assign(context ?? {}, {
-      error: entry.error
-    });
-  }
-  return context && Object.keys(context).length > 0 ? context : void 0;
-};
+var index_exports = {};
+__export(index_exports, {
+  BROWSER_PROCESSOR: () => BROWSER_PROCESSOR,
+  DEBUG_PROCESSOR: () => DEBUG_PROCESSOR,
+  FILE_PROCESSOR: () => FILE_PROCESSOR,
+  LogBuffer: () => LogBuffer,
+  LogLevel: () => LogLevel,
+  LogProcessorType: () => LogProcessorType,
+  createFileProcessor: () => createFileProcessor,
+  createLog: () => createLog,
+  dbg: () => dbg,
+  debug: () => debug,
+  gatherLogInfoFromScope: () => gatherLogInfoFromScope,
+  getContextFromEntry: () => getContextFromEntry,
+  getCurrentOwnershipScope: () => getCurrentOwnershipScope,
+  getRelativeFilename: () => getRelativeFilename,
+  levels: () => levels,
+  log: () => log,
+  logInfo: () => logInfo,
+  omit: () => omit,
+  parseFilter: () => parseFilter,
+  pick: () => pick,
+  shortLevelName: () => shortLevelName,
+  shouldLog: () => shouldLog
+});
+import { omit, pick } from "@dxos/util";
 
 // src/decorators.ts
-import chalk from "chalk";
 import { inspect } from "node:util";
+import chalk from "chalk";
 var nextPromiseId = 0;
 var createMethodLogDecorator = (log2) => (arg0, arg1, meta) => (target, propertyKey, descriptor) => {
   const method = descriptor.value;
@@ -197,142 +142,33 @@ var logAsyncResolved = (log2, methodName, resolvedValue, promiseId, startTime, c
 var logAsyncRejected = (log2, methodName, err, promiseId, startTime, combinedMeta) => {
   log2.info(`.${formatFunction(methodName)} \u21B2 \u{1F525} ${chalk.gray("reject")} ${formatPromise(promiseId)} ${formatTimeElapsed(startTime)} ${chalk.gray("=>")} ${err}`, {}, combinedMeta);
 };
-var greenCheck = typeof chalk.green === "function" ? chalk.green("\u2714") : "\u2714";
-var formatTimeElapsed = (startTime) => chalk.gray(`${(performance.now() - startTime).toFixed(0)}ms`);
 var COLOR_FUNCTION = [
   220,
   220,
   170
 ];
+var greenCheck = typeof chalk.green === "function" ? chalk.green("\u2714") : "\u2714";
+var formatTimeElapsed = (startTime) => chalk.gray(`${(performance.now() - startTime).toFixed(0)}ms`);
 var formatFunction = (name) => chalk.bold(chalk.rgb(...COLOR_FUNCTION)(name));
 var formatPromise = (id) => chalk.blue(`Promise#${id}`);
 
 // src/options.ts
 import defaultsDeep from "lodash.defaultsdeep";
 
-// src/platform/node/index.ts
-import yaml from "js-yaml";
-import fs from "node:fs";
-var loadOptions = (filepath) => {
-  if (filepath) {
-    try {
-      const text = fs.readFileSync(filepath, "utf-8");
-      if (text) {
-        return yaml.load(text);
-      }
-    } catch (err) {
-      console.warn(`Invalid log file: ${filepath}`);
-    }
-  }
-};
-
-// src/processors/console-processor.ts
-import chalk2 from "chalk";
-import { inspect as inspect2 } from "node:util";
-import { getPrototypeSpecificInstanceId, pickBy } from "@dxos/util";
-
-// src/processors/common.ts
-var getRelativeFilename = (filename) => {
-  const match = filename.match(/.+\/(packages\/.+\/.+)/);
-  if (match) {
-    const [, filePath] = match;
-    return filePath;
-  }
-  return filename;
-};
-
-// src/processors/console-processor.ts
-var LEVEL_COLORS = {
-  [LogLevel.TRACE]: "gray",
-  [LogLevel.DEBUG]: "gray",
-  [LogLevel.VERBOSE]: "gray",
-  [LogLevel.INFO]: "white",
-  [LogLevel.WARN]: "yellow",
-  [LogLevel.ERROR]: "red"
-};
-var truncate = (text, length = 0, right = false) => {
-  const str = text && length ? right ? text.slice(-length) : text.substring(0, length) : text ?? "";
-  return right ? str.padStart(length, " ") : str.padEnd(length, " ");
-};
-var DEFAULT_FORMATTER = (config, { path, line, level, message, context, error, scope }) => {
-  const column = config.options?.formatter?.column;
-  const filepath = path !== void 0 && line !== void 0 ? chalk2.grey(`${path}:${line}`) : void 0;
-  let instance;
-  if (scope) {
-    const prototype = Object.getPrototypeOf(scope);
-    const id = getPrototypeSpecificInstanceId(scope);
-    instance = chalk2.magentaBright(`${prototype.constructor.name}#${id}`);
-  }
-  const formattedTimestamp = config.options?.formatter?.timestamp ? (/* @__PURE__ */ new Date()).toISOString() : void 0;
-  const formattedLevel = chalk2[LEVEL_COLORS[level]](column ? shortLevelName[level] : LogLevel[level]);
-  const padding = column && filepath ? "".padStart(column - filepath.length) : void 0;
-  return config.options?.formatter?.timestampFirst ? [
-    formattedTimestamp,
-    filepath,
-    padding,
-    formattedLevel,
-    instance,
-    message,
-    context,
-    error
-  ] : [
-    // NOTE: File path must come fist for console hyperlinks.
-    // Must not truncate for terminal output.
-    filepath,
-    padding,
-    formattedTimestamp,
-    formattedLevel,
-    instance,
-    message,
-    context,
-    error
-  ];
-};
-var SHORT_FORMATTER = (config, { path, level, message }) => {
-  return [
-    chalk2.grey(truncate(path, 16, true)),
-    chalk2[LEVEL_COLORS[level]](shortLevelName[level]),
-    message
-  ];
-};
-var formatter = DEFAULT_FORMATTER;
-var CONSOLE_PROCESSOR = (config, entry) => {
-  const { level, message, meta, error } = entry;
-  if (!shouldLog(entry, config.filters)) {
-    return;
-  }
-  const parts = {
-    level,
-    message,
-    error,
-    path: void 0,
-    line: void 0,
-    scope: void 0,
-    context: void 0
-  };
-  if (meta) {
-    parts.path = getRelativeFilename(meta.F);
-    parts.line = meta.L;
-    parts.scope = meta.S;
-  }
-  const context = getContextFromEntry(entry);
-  if (context) {
-    parts.context = inspect2(pickBy(context, (value) => value !== void 0), {
-      depth: config.options.depth,
-      colors: true,
-      maxArrayLength: 8,
-      sorted: false
-    });
-  }
-  const line = formatter(config, parts).filter(Boolean).join(" ");
-  console.log(line);
-};
+// src/platform/index.ts
+var platform_exports = {};
+__reExport(platform_exports, platform_star);
+import * as platform_star from "#platform";
 
-// src/processors/debug-processor.ts
-import { inspect as inspect3 } from "node:util";
-var DEBUG_PROCESSOR = (config, entry) => {
-  console.log(inspect3(entry, false, null, true));
-};
+// src/processors/index.ts
+var processors_exports = {};
+__export(processors_exports, {
+  BROWSER_PROCESSOR: () => BROWSER_PROCESSOR,
+  DEBUG_PROCESSOR: () => DEBUG_PROCESSOR,
+  FILE_PROCESSOR: () => FILE_PROCESSOR,
+  createFileProcessor: () => createFileProcessor,
+  getRelativeFilename: () => getRelativeFilename
+});
 
 // src/processors/browser-processor.ts
 import { getDebugName, safariCheck } from "@dxos/util";
@@ -374,6 +210,8 @@ var APP_BROWSER_PROCESSOR = (config, entry) => {
   if (context) {
     if (Object.keys(context).length === 1 && "error" in context) {
       args.push(context.error);
+    } else if (Object.keys(context).length === 1 && "err" in context) {
+      args.push(context.err);
     } else {
       args.push(context);
     }
@@ -439,6 +277,16 @@ var TEST_BROWSER_PROCESSOR = (config, entry) => {
 };
 var BROWSER_PROCESSOR = CONFIG.useTestProcessor ? TEST_BROWSER_PROCESSOR : APP_BROWSER_PROCESSOR;
 
+// src/processors/index.ts
+__reExport(processors_exports, console_processor_star);
+import * as console_processor_star from "#console-processor";
+
+// src/processors/debug-processor.ts
+import { inspect as inspect2 } from "node:util";
+var DEBUG_PROCESSOR = (config, entry) => {
+  console.log(inspect2(entry, false, null, true));
+};
+
 // src/processors/file-processor.ts
 import { appendFileSync, mkdirSync, openSync } from "node:fs";
 import { dirname } from "node:path";
@@ -510,14 +358,15 @@ var FILE_PROCESSOR = createFileProcessor({
 
 // src/options.ts
 var processors = {
-  [LogProcessorType.CONSOLE]: CONSOLE_PROCESSOR,
+  [LogProcessorType.CONSOLE]: processors_exports.CONSOLE_PROCESSOR,
   [LogProcessorType.BROWSER]: BROWSER_PROCESSOR,
   [LogProcessorType.DEBUG]: DEBUG_PROCESSOR
 };
-var IS_BROWSER = typeof window !== "undefined" || typeof navigator !== "undefined";
+var browser = (typeof window !== "undefined" || typeof navigator !== "undefined") && !(typeof process !== "undefined" && process?.env?.VITEST);
 var DEFAULT_PROCESSORS = [
-  IS_BROWSER ? BROWSER_PROCESSOR : CONSOLE_PROCESSOR
+  browser ? BROWSER_PROCESSOR : processors_exports.CONSOLE_PROCESSOR
 ];
+var parseLogLevel = (level, defValue = LogLevel.WARN) => levels[level.toLowerCase()] ?? defValue;
 var parseFilter = (filter) => {
   if (typeof filter === "number") {
     return [
@@ -526,7 +375,6 @@ var parseFilter = (filter) => {
       }
     ];
   }
-  const parseLogLevel = (level, defValue = LogLevel.WARN) => levels[level.toLowerCase()] ?? defValue;
   const lines = typeof filter === "string" ? filter.split(/,\s*/) : filter;
   return lines.map((filter2) => {
     const [pattern, level] = filter2.split(":");
@@ -538,54 +386,37 @@ var parseFilter = (filter) => {
     };
   });
 };
-var getConfig = (options) => {
-  const nodeOptions = "process" in globalThis ? {
+var createConfig = (options) => {
+  const envOptions = "process" in globalThis ? {
     file: process.env.LOG_CONFIG,
     filter: process.env.LOG_FILTER,
     processor: process.env.LOG_PROCESSOR
   } : void 0;
-  const mergedOptions = defaultsDeep({}, loadOptions(nodeOptions?.file), nodeOptions, options);
+  const mergedOptions = defaultsDeep({}, (0, platform_exports.loadOptions)(envOptions?.file), envOptions, options);
   return {
     options: mergedOptions,
     filters: parseFilter(mergedOptions.filter ?? LogLevel.INFO),
     captureFilters: parseFilter(mergedOptions.captureFilter ?? LogLevel.WARN),
     processors: mergedOptions.processor ? [
       processors[mergedOptions.processor]
-    ] : DEFAULT_PROCESSORS,
+    ] : [
+      ...DEFAULT_PROCESSORS
+    ],
     prefix: mergedOptions.prefix
   };
 };
 
 // src/log.ts
+var logCount = 0;
 var createLog = () => {
   const log2 = (...params) => processLog(LogLevel.DEBUG, ...params);
-  log2._config = getConfig();
+  Object.assign(log2, {
+    _id: `log-${++logCount}`,
+    _config: createConfig()
+  });
   Object.defineProperty(log2, "runtimeConfig", {
     get: () => log2._config
   });
-  log2.addProcessor = (processor) => {
-    if (DEFAULT_PROCESSORS.filter((p) => p === processor).length === 0) {
-      DEFAULT_PROCESSORS.push(processor);
-    }
-    if (log2._config.processors.filter((p) => p === processor).length === 0) {
-      log2._config.processors.push(processor);
-    }
-  };
-  log2.config = (options) => {
-    log2._config = getConfig(options);
-  };
-  log2.trace = (...params) => processLog(LogLevel.TRACE, ...params);
-  log2.debug = (...params) => processLog(LogLevel.DEBUG, ...params);
-  log2.verbose = (...params) => processLog(LogLevel.VERBOSE, ...params);
-  log2.info = (...params) => processLog(LogLevel.INFO, ...params);
-  log2.warn = (...params) => processLog(LogLevel.WARN, ...params);
-  log2.error = (...params) => processLog(LogLevel.ERROR, ...params);
-  log2.catch = (error, context, meta) => processLog(LogLevel.ERROR, void 0, context, meta, error);
-  log2.break = () => log2.info("\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014");
-  log2.stack = (message, context, meta) => processLog(LogLevel.INFO, `${message ?? "Stack Dump"}
-${getFormattedStackTrace()}`, context, meta);
-  log2.method = createMethodLogDecorator(log2);
-  log2.func = createFunctionLogDecorator(log2);
   const processLog = (level, message, context = {}, meta, error) => {
     log2._config.processors.forEach((processor) => processor(log2._config, {
       level,
@@ -595,9 +426,50 @@ ${getFormattedStackTrace()}`, context, meta);
       error
     }));
   };
+  Object.assign(log2, {
+    /**
+    * Update config.
+    * NOTE: Preserves any processors that were already added to this logger instance
+    * unless an explicit processor option is provided.
+    */
+    config: ({ processor, ...options } = {}) => {
+      const config = createConfig(options);
+      const processors2 = processor ? config.processors : log2._config.processors;
+      log2._config = {
+        ...config,
+        processors: processors2
+      };
+      return log2;
+    },
+    /**
+    * Adds a processor to the logger.
+    */
+    addProcessor: (processor) => {
+      if (log2._config.processors.filter((p) => p === processor).length === 0) {
+        log2._config.processors.push(processor);
+      }
+      return () => {
+        log2._config.processors = log2._config.processors.filter((p) => p !== processor);
+      };
+    },
+    trace: (...params) => processLog(LogLevel.TRACE, ...params),
+    debug: (...params) => processLog(LogLevel.DEBUG, ...params),
+    verbose: (...params) => processLog(LogLevel.VERBOSE, ...params),
+    info: (...params) => processLog(LogLevel.INFO, ...params),
+    warn: (...params) => processLog(LogLevel.WARN, ...params),
+    error: (...params) => processLog(LogLevel.ERROR, ...params),
+    catch: (error, context, meta) => processLog(LogLevel.ERROR, void 0, context, meta, error),
+    method: createMethodLogDecorator(log2),
+    function: createFunctionLogDecorator(log2),
+    break: () => log2.info("-".repeat(80)),
+    stack: (message, context, meta) => {
+      return processLog(LogLevel.INFO, `${message ?? "Stack Dump"}
+${getFormattedStackTrace()}`, context, meta);
+    }
+  });
   return log2;
 };
-var log = globalThis.dx_log ??= createLog();
+var log = globalThis.DX_LOG ??= createLog();
 var start = Date.now();
 var last = start;
 var debug = (label, args) => {
@@ -614,12 +486,92 @@ var debug = (label, args) => {
 };
 var getFormattedStackTrace = () => new Error().stack.split("\n").slice(3).join("\n");
 
+// src/index.ts
+__reExport(index_exports, processors_exports);
+
+// src/dbg.ts
+var dbg = (arg, meta) => {
+  if (meta?.A) {
+    console.log(`${meta.A[0]} =`, arg);
+  } else {
+    console.log(arg);
+  }
+  return arg;
+};
+
+// src/log-buffer.ts
+import { CircularBuffer } from "@dxos/util";
+var DEFAULT_BUFFER_SIZE = 2e3;
+var MAX_CONTEXT_LENGTH = 500;
+var LogBuffer = class {
+  _buffer;
+  constructor(size = DEFAULT_BUFFER_SIZE) {
+    this._buffer = new CircularBuffer(size);
+  }
+  /** Log processor that can be registered with `log.runtimeConfig.processors`. */
+  logProcessor = (_config, entry) => {
+    if (entry.level <= LogLevel.TRACE) {
+      return;
+    }
+    const record = {
+      t: (/* @__PURE__ */ new Date()).toISOString(),
+      l: shortLevelName[entry.level] ?? "?",
+      m: entry.message ?? ""
+    };
+    if (entry.meta) {
+      record.f = getRelativeFilename3(entry.meta.F);
+      record.n = entry.meta.L;
+    }
+    if (entry.error) {
+      record.e = entry.error.stack ?? entry.error.message;
+    }
+    if (entry.context != null) {
+      try {
+        const ctx = typeof entry.context === "function" ? entry.context() : entry.context;
+        if (ctx != null && !(ctx instanceof Error)) {
+          let json = JSON.stringify(ctx);
+          if (json.length > MAX_CONTEXT_LENGTH) {
+            json = json.slice(0, MAX_CONTEXT_LENGTH);
+          }
+          record.c = json;
+        }
+      } catch {
+      }
+    }
+    this._buffer.push(record);
+  };
+  /** Number of entries currently in the buffer. */
+  get size() {
+    return this._buffer.elementCount;
+  }
+  /** Discard all buffered entries. */
+  clear() {
+    this._buffer.clear();
+  }
+  /** Serialize buffer contents as NDJSON (newline-delimited JSON). */
+  serialize() {
+    const lines = [];
+    for (const record of this._buffer) {
+      lines.push(JSON.stringify(record));
+    }
+    return lines.join("\n");
+  }
+};
+var getRelativeFilename3 = (filename) => {
+  const match = filename.match(/.+\/(packages\/.+\/.+)/);
+  if (match) {
+    return match[1];
+  }
+  return filename;
+};
+
 // src/experimental/ownership.ts
-import { inspect as inspect4 } from "node:util";
-var kOwnershipScope = Symbol("kOwnershipScope");
-var kCurrentOwnershipScope = Symbol("kCurrentOwnershipScope");
-var kDebugInfoProperties = Symbol("kDebugInfoProperties");
+import { inspect as inspect3 } from "node:util";
+var kDebugInfoProperties = /* @__PURE__ */ Symbol("kDebugInfoProperties");
 var OwnershipScope = class {
+  constr;
+  parent;
+  instance;
   constructor(constr, parent) {
     this.constr = constr;
     this.parent = parent;
@@ -635,7 +587,7 @@ var OwnershipScope = class {
     }
     return info;
   }
-  [inspect4.custom]() {
+  [inspect3.custom]() {
     return {
       className: this.constr.name,
       info: this.getInfo(),
@@ -646,14 +598,14 @@ var OwnershipScope = class {
 var getCurrentOwnershipScope = (thisRef) => thisRef;
 export {
   BROWSER_PROCESSOR,
-  CONSOLE_PROCESSOR,
   DEBUG_PROCESSOR,
-  DEFAULT_FORMATTER,
   FILE_PROCESSOR,
+  LogBuffer,
   LogLevel,
   LogProcessorType,
-  SHORT_FORMATTER,
   createFileProcessor,
+  createLog,
+  dbg,
   debug,
   gatherLogInfoFromScope,
   getContextFromEntry,
@@ -666,7 +618,6 @@ export {
   parseFilter,
   pick,
   shortLevelName,
-  shouldLog,
-  truncate
+  shouldLog
 };
 //# sourceMappingURL=index.mjs.map