@dxos/log 0.8.4-main.84f28bd → 0.8.4-main.ae835ea

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/log",
-  "version": "0.8.4-main.84f28bd",
+  "version": "0.8.4-main.ae835ea",
   "description": "Logger",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -10,12 +10,12 @@
   "type": "module",
   "exports": {
     ".": {
+      "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": {
         "require": "./dist/lib/node/index.cjs",
         "default": "./dist/lib/node-esm/index.mjs"
-      },
-      "types": "./dist/types/src/index.d.ts"
+      }
     }
   },
   "browser": {
@@ -35,8 +35,8 @@
     "js-yaml": "^4.1.0",
     "lodash.defaultsdeep": "^4.6.1",
     "lodash.omit": "^4.5.0",
-    "@dxos/node-std": "0.8.4-main.84f28bd",
-    "@dxos/util": "0.8.4-main.84f28bd"
+    "@dxos/node-std": "0.8.4-main.ae835ea",
+    "@dxos/util": "0.8.4-main.ae835ea"
   },
   "devDependencies": {
     "@types/js-yaml": "^4.0.5",

package/src/config.ts

@@ -6,8 +6,8 @@ import { type LogProcessor } from './context';
 
 /**
  * Standard levels.
+ * NOTE: Keep aligned with LogLevel in @dxos/protocols.
  */
-// NOTE: Keep aligned with LogLevel in @dxos/protocols.
 // TODO(burdon): Update numbers?
 export enum LogLevel {
   TRACE = 5,
@@ -18,7 +18,7 @@ export enum LogLevel {
   ERROR = 14,
 }
 
-export const levels: { [index: string]: LogLevel } = {
+export const levels: Record<string, LogLevel> = {
   trace: LogLevel.TRACE,
   debug: LogLevel.DEBUG,
   verbose: LogLevel.VERBOSE,

package/src/context.ts

@@ -16,7 +16,7 @@ export type LogContext = Record<string, any> | Error | any;
  */
 export interface LogEntry {
   level: LogLevel;
-  message: string;
+  message?: string;
   context?: LogContext;
   meta?: CallMetadata;
   error?: Error;
@@ -64,8 +64,7 @@ export const getContextFromEntry = (entry: LogEntry): Record<string, any> | unde
   }
 
   if (entry.error) {
-    const errorContext = (entry.error as any).context;
-    context = Object.assign(context ?? {}, { error: entry.error, ...errorContext });
+    context = Object.assign(context ?? {}, { error: entry.error });
   }
 
   return context && Object.keys(context).length > 0 ? context : undefined;

package/src/decorators.ts

@@ -2,9 +2,10 @@
 // Copyright 2023 DXOS.org
 //
 
-import chalk from 'chalk';
 import { inspect } from 'node:util';
 
+import chalk from 'chalk';
+
 import type { LogMethods } from './log';
 import { type CallMetadata } from './meta';
 

package/src/experimental/classes.test.ts

@@ -4,9 +4,10 @@
 
 import { describe, test } from 'vitest';
 
-import { debugInfo, ownershipClass } from './ownership';
 import { log } from '../log';
 
+import { debugInfo, ownershipClass } from './ownership';
+
 describe('classes', function () {
   test('field instance', function () {
     @ownershipClass

package/src/index.ts

@@ -14,6 +14,6 @@ export * from './log';
 export { parseFilter } from './options';
 export * from './processors';
 export * from './scope';
-export * from './meta';
+export type * from './meta';
 
 export { getCurrentOwnershipScope } from './experimental/ownership';

package/src/log.test.ts

@@ -3,6 +3,7 @@
 //
 
 import path from 'node:path';
+
 import { describe, test } from 'vitest';
 
 import { LogLevel } from './config';
@@ -28,10 +29,10 @@ log.config({
   filter: LogLevel.DEBUG,
 });
 
-/* eslint-disable @stayradiated/prefer-arrow-functions/prefer-arrow-functions */
+/* eslint-disable prefer-arrow-functions/prefer-arrow-functions */
 
-describe('log', function () {
-  test('throws an error', function () {
+describe('log', () => {
+  test('throws an error', () => {
     try {
       throw new LogError('Test failed', { value: 1 });
     } catch (err: any) {
@@ -39,7 +40,7 @@ describe('log', function () {
     }
   });
 
-  test('throws an error showing stacktrace', function () {
+  test('throws an error showing stacktrace', () => {
     try {
       throw new LogError('Test failed', { value: 2 });
     } catch (err: any) {
@@ -47,7 +48,7 @@ describe('log', function () {
     }
   });
 
-  test('catches an error', function () {
+  test('catches an error', () => {
     try {
       throw new LogError('ERROR ON LINE 21', { value: 3 });
     } catch (err: any) {
@@ -55,7 +56,7 @@ describe('log', function () {
     }
   });
 
-  test('config', function () {
+  test('config', () => {
     log.config({
       filter: LogLevel.INFO,
     });
@@ -65,7 +66,7 @@ describe('log', function () {
     log.warn('Warn level log message');
   });
 
-  test('config file', function () {
+  test('config file', () => {
     log.config({
       file: path.join('packages/common/log/test-config.yml'),
     });
@@ -75,7 +76,7 @@ describe('log', function () {
     log.warn('Warn level log message');
   });
 
-  test('levels', function () {
+  test('levels', () => {
     log('Default level log message');
     log.debug('Debug level log message');
     log.info('Info level log message');
@@ -83,10 +84,15 @@ describe('log', function () {
     log.error('Error level log message');
   });
 
-  test('context', function () {
+  test('context', () => {
     log.info('Message with context', {
       title: 'test',
       context: 123,
     });
   });
+
+  test('error', function () {
+    const myError = new Error('Test error', { cause: new Error('Cause') });
+    log.catch(myError);
+  });
 });

package/src/log.ts

@@ -6,7 +6,7 @@ import { type LogConfig, LogLevel, type LogOptions } from './config';
 import { type LogContext, type LogProcessor } from './context';
 import { createFunctionLogDecorator, createMethodLogDecorator } from './decorators';
 import { type CallMetadata } from './meta';
-import { getConfig, DEFAULT_PROCESSORS } from './options';
+import { DEFAULT_PROCESSORS, getConfig } from './options';
 
 /**
  * Logging function.
@@ -78,8 +78,7 @@ const createLog = (): LogImp => {
   log.error = (...params) => processLog(LogLevel.ERROR, ...params);
 
   // Catch only shows error message, not stacktrace.
-  log.catch = (error: Error | any, context, meta) =>
-    processLog(LogLevel.ERROR, error?.message ?? String(error), context, meta, error);
+  log.catch = (error: Error | any, context, meta) => processLog(LogLevel.ERROR, undefined, context, meta, error);
 
   // Show break.
   log.break = () => log.info('——————————————————————————————————————————————————');
@@ -95,7 +94,7 @@ const createLog = (): LogImp => {
    */
   const processLog = (
     level: LogLevel,
-    message: string,
+    message: string | undefined,
     context: LogContext = {},
     meta?: CallMetadata,
     error?: Error,

package/src/options.ts

@@ -7,7 +7,7 @@ import defaultsDeep from 'lodash.defaultsdeep';
 import { type LogConfig, type LogFilter, LogLevel, type LogOptions, LogProcessorType, levels } from './config';
 import { type LogProcessor } from './context';
 import { loadOptions } from './platform';
-import { CONSOLE_PROCESSOR, DEBUG_PROCESSOR, BROWSER_PROCESSOR } from './processors';
+import { BROWSER_PROCESSOR, CONSOLE_PROCESSOR, DEBUG_PROCESSOR } from './processors';
 
 /**
  * Processor variants.

package/src/platform/node/index.ts

@@ -2,9 +2,10 @@
 // Copyright 2022 DXOS.org
 //
 
-import yaml from 'js-yaml';
 import fs from 'node:fs';
 
+import yaml from 'js-yaml';
+
 import { type LogOptions } from '../../config';
 
 /**

package/src/processors/browser-processor.ts

@@ -5,7 +5,7 @@
 import { getDebugName, safariCheck } from '@dxos/util';
 
 import { LogLevel } from '../config';
-import { getContextFromEntry, type LogProcessor, shouldLog } from '../context';
+import { type LogProcessor, getContextFromEntry, shouldLog } from '../context';
 
 const getRelativeFilename = (filename: string) => {
   // TODO(burdon): Hack uses "packages" as an anchor (pre-parse NX?)
@@ -66,12 +66,16 @@ const APP_BROWSER_PROCESSOR: LogProcessor = (config, entry) => {
     args.push(`%c${processPrefix}${scopeName}`, 'color:#C026D3;font-weight:bold');
   }
 
-  args.push(entry.message);
+  if (entry.message) {
+    args.push(entry.message);
+  }
 
   const context = getContextFromEntry(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);
     }

package/src/processors/console-processor.ts

@@ -2,14 +2,16 @@
 // Copyright 2022 DXOS.org
 //
 
-import chalk from 'chalk';
 import { inspect } from 'node:util';
 
+import chalk from 'chalk';
+
 import { getPrototypeSpecificInstanceId, pickBy } from '@dxos/util';
 
-import { getRelativeFilename } from './common';
 import { type LogConfig, LogLevel, shortLevelName } from '../config';
-import { getContextFromEntry, type LogProcessor, shouldLog } from '../context';
+import { type LogProcessor, getContextFromEntry, shouldLog } from '../context';
+
+import { getRelativeFilename } from './common';
 
 const LEVEL_COLORS: Record<LogLevel, typeof chalk.ForegroundColor> = {
   [LogLevel.TRACE]: 'gray',
@@ -21,7 +23,7 @@ const LEVEL_COLORS: Record<LogLevel, typeof chalk.ForegroundColor> = {
 };
 
 export const truncate = (text?: string, length = 0, right = false) => {
-  const str = text && length ? (right ? text.slice(-length) : text.substring(0, length)) : text ?? '';
+  const str = text && length ? (right ? text.slice(-length) : text.substring(0, length)) : (text ?? '');
   return right ? str.padStart(length, ' ') : str.padEnd(length, ' ');
 };
 
@@ -32,7 +34,7 @@ export type FormatParts = {
   line?: number;
   timestamp?: string;
   level: LogLevel;
-  message: string;
+  message?: string;
   context?: any;
   error?: Error;
   scope?: any;
@@ -50,8 +52,10 @@ export const DEFAULT_FORMATTER: Formatter = (
   let instance;
   if (scope) {
     const prototype = Object.getPrototypeOf(scope);
-    const id = getPrototypeSpecificInstanceId(scope);
-    instance = chalk.magentaBright(`${prototype.constructor.name}#${id}`);
+    if (prototype !== null) {
+      const id = getPrototypeSpecificInstanceId(scope);
+      instance = chalk.magentaBright(`${prototype.constructor.name}#${id}`);
+    }
   }
 
   const formattedTimestamp = config.options?.formatter?.timestamp ? new Date().toISOString() : undefined;

package/src/processors/file-processor.ts

@@ -7,10 +7,11 @@ import { dirname } from 'node:path';
 
 import { jsonlogify } from '@dxos/util';
 
-import { getRelativeFilename } from './common';
 import { type LogFilter, LogLevel } from '../config';
 import { type LogProcessor, getContextFromEntry, shouldLog } from '../context';
 
+import { getRelativeFilename } from './common';
+
 // Amount of time to retry writing after encountering EAGAIN before giving up.
 const EAGAIN_MAX_DURATION = 1000;
 /**

package/src/scope.ts

@@ -33,7 +33,7 @@ export const gatherLogInfoFromScope = (scope: any): Record<string, any> => {
   const res: Record<string, any> = {};
 
   const prototype = Object.getPrototypeOf(scope);
-  const infoProps = prototype[logInfoProperties] ?? [];
+  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];