@dxos/log 0.8.4-main.fffef41 → 0.8.4-staging.60fe92afc8

package/dist/lib/browser/index.mjs

@@ -1,121 +1,157 @@
-// src/index.ts
-import omit from "lodash.omit";
-import { pick } from "@dxos/util";
+import {
+  LogEntry,
+  LogLevel,
+  LogProcessorType,
+  gatherLogInfoFromScope,
+  getContextFromEntry,
+  getRelativeFilename,
+  levels,
+  logInfo,
+  shortLevelName,
+  shouldLog
+} from "./chunk-V7FYKT4H.mjs";
+import {
+  __export,
+  __reExport
+} from "./chunk-IEP6GGEX.mjs";
 
-// 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 = {
-  "*": 5,
-  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/index.ts
+var index_exports = {};
+__export(index_exports, {
+  BROWSER_PROCESSOR: () => BROWSER_PROCESSOR,
+  DEBUG_PROCESSOR: () => DEBUG_PROCESSOR,
+  LOG_META_MARKER: () => LOG_META_MARKER,
+  LogBuffer: () => LogBuffer,
+  LogEntry: () => LogEntry,
+  LogLevel: () => LogLevel,
+  LogProcessorType: () => LogProcessorType,
+  createLog: () => createLog,
+  dbg: () => dbg,
+  debug: () => debug,
+  gatherLogInfoFromScope: () => gatherLogInfoFromScope,
+  getContextFromEntry: () => getContextFromEntry,
+  getCurrentOwnershipScope: () => getCurrentOwnershipScope,
+  getRelativeFilename: () => getRelativeFilename,
+  inferEnvironmentName: () => inferEnvironmentName,
+  isLogMeta: () => isLogMeta,
+  levels: () => levels,
+  log: () => log,
+  logInfo: () => logInfo,
+  omit: () => omit,
+  parseFilter: () => parseFilter,
+  pick: () => pick,
+  serializeToJsonl: () => serializeToJsonl,
+  shortLevelName: () => shortLevelName,
+  shouldLog: () => shouldLog
+});
+import { omit, pick } from "@dxos/util";
 
-// 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 = (typeof prototype === "object" && prototype !== null ? prototype[logInfoProperties] : []) ?? [];
-  for (const prop of infoProps) {
-    try {
-      res[prop] = typeof scope[prop] === "function" ? scope[prop]() : scope[prop];
-    } catch (err) {
-      res[prop] = err.message;
+// src/environment.ts
+var TAB_SUFFIX_STORAGE_KEY = "@dxos/log:env-suffix";
+var SUFFIX_LENGTH = 6;
+var randomSuffix = () => {
+  const cryptoRef = globalThis.crypto;
+  if (cryptoRef?.getRandomValues) {
+    const bytes = new Uint8Array(SUFFIX_LENGTH);
+    cryptoRef.getRandomValues(bytes);
+    let suffix = "";
+    for (const byte of bytes) {
+      suffix += (byte % 36).toString(36);
     }
+    return suffix;
   }
-  return res;
+  return Math.random().toString(36).slice(2, 2 + SUFFIX_LENGTH).padEnd(SUFFIX_LENGTH, "0");
 };
-
-// src/context.ts
-var matchFilter = (filter, level, path) => {
-  if (filter.pattern?.startsWith("-")) {
-    if (path?.includes(filter.pattern.slice(1))) {
-      if (level >= filter.level) {
-        return false;
-      }
-    }
-  } else {
-    if (filter.pattern?.length) {
-      if (path?.includes(filter.pattern)) {
-        return level >= filter.level;
-      }
-    } else {
-      if (level >= filter.level) {
-        return true;
-      }
+var getOrCreateTabSuffix = (session) => {
+  if (!session) {
+    return randomSuffix();
+  }
+  try {
+    const existing = session.getItem(TAB_SUFFIX_STORAGE_KEY);
+    if (existing && existing.length > 0) {
+      return existing;
     }
+    const suffix = randomSuffix();
+    session.setItem(TAB_SUFFIX_STORAGE_KEY, suffix);
+    return suffix;
+  } catch {
+    return randomSuffix();
   }
 };
-var shouldLog = (entry, filters) => {
-  if (filters === void 0) {
-    return false;
+var isInstanceOf = (scope, ctorName) => {
+  const ctor = scope?.[ctorName];
+  return typeof ctor === "function" && scope instanceof ctor;
+};
+var CF_WORKER_USER_AGENT = "Cloudflare-Workers";
+var inferEnvironmentName = (options = {}) => {
+  const scope = options.scope ?? globalThis;
+  if (scope.navigator?.userAgent === CF_WORKER_USER_AGENT) {
+    return `cf-worker::${randomSuffix()}`;
+  }
+  if (isInstanceOf(scope, "SharedWorkerGlobalScope")) {
+    return `shared-worker:${scope.name ?? ""}:${randomSuffix()}`;
+  }
+  if (isInstanceOf(scope, "ServiceWorkerGlobalScope")) {
+    return `service-worker::${randomSuffix()}`;
+  }
+  if (isInstanceOf(scope, "DedicatedWorkerGlobalScope")) {
+    return `dedicated-worker:${scope.name ?? ""}:${randomSuffix()}`;
+  }
+  if (scope.window !== void 0 && scope.window === scope) {
+    const origin = scope.location?.origin ?? "";
+    return `tab:${origin}:${getOrCreateTabSuffix(scope.sessionStorage)}`;
+  }
+  const proc = scope.process;
+  if (proc && typeof proc === "object" && proc.versions?.node) {
+    const pid = typeof proc.pid === "number" ? String(proc.pid) : "";
+    return `node:${pid}:${randomSuffix()}`;
   }
-  const results = filters.map((filter) => matchFilter(filter, entry.level, entry.meta?.F)).filter((result) => result !== void 0);
-  return results.length > 0 && !results.some((results2) => results2 === false);
+  return `unknown::${randomSuffix()}`;
 };
-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);
-    }
+
+// src/jsonl.ts
+var serializeToJsonl = (entry, opts = {}) => {
+  if (entry.level <= LogLevel.TRACE) {
+    return void 0;
+  }
+  const { filename, line, context: scopeName } = entry.computedMeta;
+  const record = {
+    t: new Date(entry.timestamp).toISOString(),
+    l: shortLevelName[entry.level] ?? "?",
+    m: entry.message ?? ""
+  };
+  if (filename !== void 0) {
+    record.f = filename;
+  }
+  if (line !== void 0) {
+    record.n = line;
+  }
+  if (scopeName !== void 0) {
+    record.o = scopeName;
+  }
+  if (entry.computedError !== void 0) {
+    record.e = entry.computedError;
   }
-  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 (opts.env !== void 0) {
+    record.i = opts.env;
+  }
+  const computedContext = entry.computedContext;
+  if (Object.keys(computedContext).length > 0) {
+    try {
+      record.c = JSON.stringify(computedContext);
+    } catch {
     }
   }
-  if (entry.error) {
-    context = Object.assign(context ?? {}, {
-      error: entry.error
-    });
+  try {
+    return JSON.stringify(record);
+  } catch {
+    return void 0;
   }
-  return context && Object.keys(context).length > 0 ? context : void 0;
 };
 
 // src/decorators.ts
-import { inspect } from "@dxos/node-std/util";
 import chalk from "chalk";
+import { inspect } from "@dxos/node-std/util";
 var nextPromiseId = 0;
 var createMethodLogDecorator = (log2) => (arg0, arg1, meta) => (target, propertyKey, descriptor) => {
   const method = descriptor.value;
@@ -225,47 +261,21 @@ var formatPromise = (id) => chalk.blue(`Promise#${id}`);
 // src/options.ts
 import defaultsDeep from "lodash.defaultsdeep";
 
-// src/platform/browser/index.ts
-var loadOptions = (filepath) => {
-  try {
-    let dxlog;
-    if (typeof localStorage === "undefined") {
-      if (globalThis.localStorage_dxlog) {
-        dxlog = globalThis.localStorage_dxlog;
-      }
-    } else {
-      dxlog = localStorage.getItem("dxlog") ?? void 0;
-    }
-    if (!dxlog) {
-      return void 0;
-    }
-    return JSON.parse(dxlog);
-  } catch (err) {
-    console.info("can't parse dxlog config", err);
-    return void 0;
-  }
-};
+// src/platform/index.ts
+var platform_exports = {};
+__reExport(platform_exports, platform_star);
+import * as platform_star from "#platform";
 
-// src/processors/console-stub.ts
-var CONSOLE_PROCESSOR = () => {
-};
-
-// src/processors/debug-processor.ts
-import { inspect as inspect2 } from "@dxos/node-std/util";
-var DEBUG_PROCESSOR = (config, entry) => {
-  console.log(inspect2(entry, false, null, true));
-};
+// src/processors/index.ts
+var processors_exports = {};
+__export(processors_exports, {
+  BROWSER_PROCESSOR: () => BROWSER_PROCESSOR,
+  DEBUG_PROCESSOR: () => DEBUG_PROCESSOR,
+  getRelativeFilename: () => getRelativeFilename
+});
 
 // src/processors/browser-processor.ts
-import { getDebugName, safariCheck } from "@dxos/util";
-var getRelativeFilename = (filename) => {
-  const match = filename.match(/.+\/(packages\/.+\/.+)/);
-  if (match) {
-    const [, filePath] = match;
-    return filePath;
-  }
-  return filename;
-};
+import { safariCheck } from "@dxos/util";
 var CONFIG = {
   useTestProcessor: false,
   printFileLinks: false
@@ -276,18 +286,20 @@ var APP_BROWSER_PROCESSOR = (config, entry) => {
   }
   const LOG_BROWSER_PREFIX = config.prefix ?? "https://vscode.dev/github.com/dxos/dxos/blob/main/";
   const LOG_BROWSER_CSS = [];
+  const { filename, line: lineNumber, context: scopeDebugName } = entry.computedMeta;
   let link = "";
-  if (entry.meta) {
-    const filename = getRelativeFilename(entry.meta.F);
+  if (filename !== void 0 && lineNumber !== void 0) {
     const filepath = `${LOG_BROWSER_PREFIX.replace(/\/$/, "")}/${filename}`;
-    link = `${filepath}#L${entry.meta.L}`;
+    link = `${filepath}#L${lineNumber}`;
   }
   let args = [];
-  if (entry.meta?.S) {
-    const scope = entry.meta?.S;
-    const scopeName = scope.name || getDebugName(scope);
-    const processPrefix = entry.meta.S?.hostSessionId ? "[worker] " : "";
-    args.push(`%c${processPrefix}${scopeName}`, "color:#C026D3;font-weight:bold");
+  const scope = entry.meta?.S;
+  if (scope) {
+    const scopeName = scope.name || scopeDebugName;
+    if (scopeName) {
+      const processPrefix = scope.hostSessionId ? "[worker] " : "";
+      args.push(`%c${processPrefix}${scopeName}`, "color:#C026D3;font-weight:bold");
+    }
   }
   if (entry.message) {
     args.push(entry.message);
@@ -295,9 +307,9 @@ var APP_BROWSER_PROCESSOR = (config, entry) => {
   const context = getContextFromEntry(entry);
   if (context) {
     if (Object.keys(context).length === 1 && "error" in context) {
-      args.push(context.error);
+      args.push(unwrapEffectError(context.error));
     } else if (Object.keys(context).length === 1 && "err" in context) {
-      args.push(context.err);
+      args.push(unwrapEffectError(context.err));
     } else {
       args.push(context);
     }
@@ -332,10 +344,8 @@ var TEST_BROWSER_PROCESSOR = (config, entry) => {
   if (!shouldLog(entry, config.filters)) {
     return;
   }
-  let path = "";
-  if (entry.meta) {
-    path = `${getRelativeFilename(entry.meta.F)}:${entry.meta.L}`;
-  }
+  const { filename, line: lineNumber } = entry.computedMeta;
+  const path = filename !== void 0 && lineNumber !== void 0 ? `${filename}:${lineNumber}` : "";
   let args = [];
   const processPrefix = entry.meta?.S?.hostSessionId ? "[worker] " : "";
   args.push(`${processPrefix}${entry.message}`);
@@ -362,97 +372,33 @@ var TEST_BROWSER_PROCESSOR = (config, entry) => {
   }
 };
 var BROWSER_PROCESSOR = CONFIG.useTestProcessor ? TEST_BROWSER_PROCESSOR : APP_BROWSER_PROCESSOR;
-
-// src/processors/file-processor.ts
-import { appendFileSync, mkdirSync, openSync } from "@dxos/node-std/fs";
-import { dirname } from "@dxos/node-std/path";
-import { jsonlogify } from "@dxos/util";
-
-// src/processors/common.ts
-var getRelativeFilename2 = (filename) => {
-  const match = filename.match(/.+\/(packages\/.+\/.+)/);
-  if (match) {
-    const [, filePath] = match;
-    return filePath;
-  }
-  return filename;
+var originalSymbol = /* @__PURE__ */ Symbol.for("effect/OriginalAnnotation");
+var unwrapEffectError = (error) => {
+  if (typeof error === "object" && error !== null && originalSymbol in error) {
+    return error[originalSymbol];
+  }
+  return error;
 };
 
-// src/processors/file-processor.ts
-var EAGAIN_MAX_DURATION = 1e3;
-var createFileProcessor = ({ pathOrFd, levels: levels2, filters }) => {
-  let fd;
-  return (config, entry) => {
-    if (levels2.length > 0 && !levels2.includes(entry.level)) {
-      return;
-    }
-    if (!shouldLog(entry, filters)) {
-      return;
-    }
-    if (typeof pathOrFd === "number") {
-      fd = pathOrFd;
-    } else {
-      try {
-        mkdirSync(dirname(pathOrFd));
-      } catch {
-      }
-      fd = openSync(pathOrFd, "a");
-    }
-    const record = {
-      ...entry,
-      timestamp: Date.now(),
-      ...entry.meta ? {
-        meta: {
-          file: getRelativeFilename2(entry.meta.F),
-          line: entry.meta.L
-        }
-      } : {},
-      context: jsonlogify(getContextFromEntry(entry))
-    };
-    let retryTS = 0;
-    while (true) {
-      try {
-        return appendFileSync(fd, JSON.stringify(record) + "\n");
-      } catch (err) {
-        if (err.code !== "EAGAIN") {
-          throw err;
-        }
-        if (retryTS === 0) {
-          retryTS = performance.now();
-        } else {
-          if (performance.now() - retryTS > EAGAIN_MAX_DURATION) {
-            console.log(`could not write after ${EAGAIN_MAX_DURATION}ms of EAGAIN failures, giving up`);
-            throw err;
-          }
-        }
-      }
-    }
-  };
-};
-var logFilePath;
-var getLogFilePath = () => {
-  logFilePath ??= process.env.LOG_FILE ?? (process.env.HOME ? `${process.env.HOME}/.dxlog/${(/* @__PURE__ */ new Date()).toISOString()}.log` : void 0);
-  return logFilePath;
+// 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 "@dxos/node-std/util";
+var DEBUG_PROCESSOR = (config, entry) => {
+  console.log(inspect2(entry, false, null, true));
 };
-var FILE_PROCESSOR = createFileProcessor({
-  pathOrFd: getLogFilePath(),
-  levels: [
-    LogLevel.ERROR,
-    LogLevel.WARN,
-    LogLevel.INFO,
-    LogLevel.TRACE
-  ]
-});
 
 // src/options.ts
 var processors = {
-  [LogProcessorType.CONSOLE]: CONSOLE_PROCESSOR,
+  [LogProcessorType.CONSOLE]: processors_exports.CONSOLE_PROCESSOR,
   [LogProcessorType.BROWSER]: BROWSER_PROCESSOR,
   [LogProcessorType.DEBUG]: DEBUG_PROCESSOR
 };
-var browser = typeof window !== "undefined" || typeof navigator !== "undefined";
+var browser = (typeof window !== "undefined" || typeof navigator !== "undefined") && !(typeof process !== "undefined" && process?.env?.VITEST);
 var DEFAULT_PROCESSORS = [
-  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) => {
@@ -480,7 +426,7 @@ var createConfig = (options) => {
     filter: process.env.LOG_FILTER,
     processor: process.env.LOG_PROCESSOR
   } : void 0;
-  const mergedOptions = defaultsDeep({}, loadOptions(envOptions?.file), envOptions, options);
+  const mergedOptions = defaultsDeep({}, (0, platform_exports.loadOptions)(envOptions?.file), envOptions, options);
   return {
     options: mergedOptions,
     filters: parseFilter(mergedOptions.filter ?? LogLevel.INFO),
@@ -506,13 +452,14 @@ var createLog = () => {
     get: () => log2._config
   });
   const processLog = (level, message, context = {}, meta, error) => {
-    log2._config.processors.forEach((processor) => processor(log2._config, {
+    const entry = new LogEntry({
       level,
       message,
       context,
       meta,
       error
-    }));
+    });
+    log2._config.processors.forEach((processor) => processor(log2._config, entry));
   };
   Object.assign(log2, {
     /**
@@ -520,7 +467,7 @@ var createLog = () => {
     * NOTE: Preserves any processors that were already added to this logger instance
     * unless an explicit processor option is provided.
     */
-    config: ({ processor, ...options }) => {
+    config: ({ processor, ...options } = {}) => {
       const config = createConfig(options);
       const processors2 = processor ? config.processors : log2._config.processors;
       log2._config = {
@@ -574,11 +521,94 @@ var debug = (label, args) => {
 };
 var getFormattedStackTrace = () => new Error().stack.split("\n").slice(3).join("\n");
 
+// src/index.ts
+__reExport(index_exports, processors_exports);
+
+// src/meta.ts
+var LOG_META_MARKER = "~LogMeta";
+var isLogMeta = (value) => {
+  return value != null && typeof value === "object" && value[LOG_META_MARKER] === LOG_META_MARKER;
+};
+
+// 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`.
+  * Captures every level except TRACE (does not apply `shouldLog` / filter; use for full debug dumps).
+  */
+  logProcessor = (_config, entry) => {
+    if (entry.level <= LogLevel.TRACE) {
+      return;
+    }
+    const { filename, line, context: scopeName } = entry.computedMeta;
+    const record = {
+      t: new Date(entry.timestamp).toISOString(),
+      l: shortLevelName[entry.level] ?? "?",
+      m: entry.message ?? ""
+    };
+    if (filename !== void 0) {
+      record.f = filename;
+    }
+    if (line !== void 0) {
+      record.n = line;
+    }
+    if (scopeName !== void 0) {
+      record.o = scopeName;
+    }
+    if (entry.computedError !== void 0) {
+      record.e = entry.computedError;
+    }
+    const computedContext = entry.computedContext;
+    if (Object.keys(computedContext).length > 0) {
+      try {
+        let json = JSON.stringify(computedContext);
+        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");
+  }
+};
+
 // src/experimental/ownership.ts
 import { inspect as inspect3 } from "@dxos/node-std/util";
-var kOwnershipScope = Symbol("kOwnershipScope");
-var kCurrentOwnershipScope = Symbol("kCurrentOwnershipScope");
-var kDebugInfoProperties = Symbol("kDebugInfoProperties");
+var kDebugInfoProperties = /* @__PURE__ */ Symbol("kDebugInfoProperties");
 var OwnershipScope = class {
   constr;
   parent;
@@ -609,24 +639,28 @@ var OwnershipScope = class {
 var getCurrentOwnershipScope = (thisRef) => thisRef;
 export {
   BROWSER_PROCESSOR,
-  CONSOLE_PROCESSOR,
   DEBUG_PROCESSOR,
-  FILE_PROCESSOR,
+  LOG_META_MARKER,
+  LogBuffer,
+  LogEntry,
   LogLevel,
   LogProcessorType,
-  createFileProcessor,
   createLog,
+  dbg,
   debug,
   gatherLogInfoFromScope,
   getContextFromEntry,
   getCurrentOwnershipScope,
-  getRelativeFilename2 as getRelativeFilename,
+  getRelativeFilename,
+  inferEnvironmentName,
+  isLogMeta,
   levels,
   log,
   logInfo,
   omit,
   parseFilter,
   pick,
+  serializeToJsonl,
   shortLevelName,
   shouldLog
 };