@travetto/log 4.0.0-rc.8 → 4.0.0

package/README.md

@@ -16,7 +16,7 @@ yarn add @travetto/log
 This module provides logging functionality, building upon [ConsoleManager](https://github.com/travetto/travetto/tree/main/module/base/src/console.ts) in the [Base](https://github.com/travetto/travetto/tree/main/module/base#readme "Environment config and common utilities for travetto applications.") module.  This is all ultimately built upon [console](https://nodejs.org/api/console.html) operations. The logging infrastructure is built upon the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") system, and so new loggers can be created that rely upon dependency injected services and sources.
 
 ## Extending the Common Logger
-By default, the system ships with the [CommonLogger](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L12), and by default will leverage the [LineLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/line.ts#L36) and the [ConsoleLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/console.ts#L7). The configuration [CommonLoggerConfig](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L12) provides two configuration variables that allows for switching out [LineLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/line.ts#L36) for the [JsonLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/json.ts#L15), depending on the value of `CommonLoggerConfig.format`.  Additionally the [ConsoleLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/console.ts#L7) can be swapped out for the [FileLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/file.ts#L11) depending on the value of `CommonLoggerConfig.output`.
+By default, the system ships with the [CommonLogger](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L12), and by default will leverage the [LineLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/line.ts#L37) and the [ConsoleLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/console.ts#L7). The configuration [CommonLoggerConfig](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L12) provides two configuration variables that allows for switching out [LineLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/line.ts#L37) for the [JsonLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/json.ts#L16), depending on the value of `CommonLoggerConfig.format`.  Additionally the [ConsoleLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/console.ts#L7) can be swapped out for the [FileLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/file.ts#L11) depending on the value of `CommonLoggerConfig.output`.
 
 **Code: Standard Logging Config**
 ```typescript
@@ -29,7 +29,7 @@ export class CommonLoggerConfig {
 }
 ```
 
-In addition to these simple overrides, the [CommonLogger](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L12) can be extended by providing an implementation of either a [LogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L38) or [LogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L30), with the declared symbol of `LogCommonⲐ`.
+In addition to these simple overrides, the [CommonLogger](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L12) can be extended by providing an implementation of either a [LogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L34) or [LogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L26), with the declared symbol of `LogCommonⲐ`.
 
 **Code: Sample Common Formatter**
 ```typescript
@@ -45,10 +45,10 @@ export class SampleFormatter implements LogFormatter {
 }
 ```
 
-As you can see, implementing [LogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L38)/[LogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L30) with the appropriate symbol is all that is necessary to customize the general logging functionality.
+As you can see, implementing [LogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L34)/[LogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L26) with the appropriate symbol is all that is necessary to customize the general logging functionality.
 
 ## Creating a Logger
-The default pattern for logging is to create a [Logger](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L45) which simply consumes a logging event. The method is not asynchronous as ensuring the ordering of append calls will be the responsibility of the logger.  The default logger uses `console.log` and that is synchronous by default.
+The default pattern for logging is to create a [Logger](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L41) which simply consumes a logging event. The method is not asynchronous as ensuring the ordering of append calls will be the responsibility of the logger.  The default logger uses `console.log` and that is synchronous by default.
 
 **Code: Logger Shape**
 ```typescript
@@ -64,10 +64,6 @@ export interface LogEvent extends ConsoleEvent {
    * Log message
    */
   message?: string;
-  /**
-   * Log Message context
-   */
-  context?: Record<string, unknown>;
 }
 ```
 
@@ -114,7 +110,7 @@ export class CustomLogger implements Logger {
 ```
 
 ## Creating a Decorator
-In addition to being able to control the entire logging experience, there are also scenarios in which the caller may want to only add information to the log event, without affecting control of the formatting or appending. The [Logger](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L22) is an interface that provides a contract that allows transforming the [LogEvent](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L8) data. A common scenario for this would be to add additional metadata data (e.g. server name, ip, code revision, CPU usage, memory usage, etc) into the log messages.
+In addition to being able to control the entire logging experience, there are also scenarios in which the caller may want to only add information to the log event, without affecting control of the formatting or appending. The [Logger](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L18) is an interface that provides a contract that allows transforming the [LogEvent](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L8) data. A common scenario for this would be to add additional metadata data (e.g. server name, ip, code revision, CPU usage, memory usage, etc) into the log messages.
 
 **Code: Log Decorator Shape**
 ```typescript

package/__index__.ts

@@ -3,6 +3,7 @@ export * from './src/service';
 export * from './src/formatter/json';
 export * from './src/formatter/line';
 export * from './src/formatter/google';
+export * from './src/formatter/util';
 export * from './src/appender/console';
 export * from './src/appender/file';
 export * from './src/types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/log",
-  "version": "4.0.0-rc.8",
+  "version": "4.0.0",
   "description": "Logging framework that integrates at the console.log level.",
   "keywords": [
     "typescript",
@@ -23,9 +23,9 @@
     "directory": "module/log"
   },
   "dependencies": {
-    "@travetto/config": "^4.0.0-rc.8",
-    "@travetto/di": "^4.0.0-rc.8",
-    "@travetto/terminal": "^4.0.0-rc.8"
+    "@travetto/config": "^4.0.0",
+    "@travetto/di": "^4.0.0",
+    "@travetto/terminal": "^4.0.0"
   },
   "travetto": {
     "displayName": "Logging"

package/src/formatter/google.ts

@@ -1,8 +1,7 @@
-import util from 'node:util';
-
 import { Injectable } from '@travetto/di';
 
 import { LogFormatter, LogEvent } from '../types';
+import { LogFormatUtil } from './util';
 
 /**
  * Google Logging Formatter
@@ -11,33 +10,30 @@ import { LogFormatter, LogEvent } from '../types';
  */
 @Injectable()
 export class GoogleLogFormatter implements LogFormatter {
-  #inspectOptions = { colors: false, showHidden: false, depth: 5, breakLength: 200 };
+  format(ev: LogEvent): string {
+    const context = LogFormatUtil.getContext(ev);
 
-  format({
-    source: file, line, scope, level, message, timestamp, module, args,
-    context: { method, path, statusCode, ...context } = {},
-  }: LogEvent): string {
-    const final: unknown[] = [...args];
-    if (message) {
-      args.unshift(message);
-    }
-    if (Object.keys(context).length) {
-      args.push(context);
+    const extra: Record<string, unknown> = {};
+    // Http request specific
+    if (context && ('method' in context && 'path' in context && 'statusCode' in context)) {
+      extra.httpRequest = {
+        requestMethod: context.method,
+        requestUrl: context.path,
+        status: context.statusCode
+      };
+      delete context.method;
+      delete context.path;
+      delete context.statusCode;
     }
+
     return JSON.stringify({
       context,
-      'logging.googleapis.com/sourceLocation': { file, line },
-      'logging.googleapis.com/labels': { module, scope },
-      severity: level,
-      message: util.formatWithOptions(this.#inspectOptions, final),
-      timestamp,
-      ...(method ? {
-        httpRequest: {
-          requestMethod: method,
-          requestUrl: path,
-          status: statusCode
-        }
-      } : {})
+      'logging.googleapis.com/sourceLocation': { file: ev.source, line: ev.line },
+      'logging.googleapis.com/labels': { module: ev.module, scope: ev.scope },
+      severity: ev.level,
+      message: LogFormatUtil.getLogMessage(ev),
+      timestamp: ev.timestamp,
+      ...extra,
     });
   }
 }

package/src/formatter/json.ts

@@ -2,6 +2,7 @@ import { Injectable } from '@travetto/di';
 import { Config } from '@travetto/config';
 
 import { LogEvent, LogFormatter } from '../types';
+import { LogFormatUtil } from './util';
 
 @Config('log')
 export class JSONLogFormatterConfig {
@@ -20,6 +21,13 @@ export class JsonLogFormatter implements LogFormatter {
   }
 
   format(ev: LogEvent): string {
-    return JSON.stringify(ev, null, this.opts.jsonIndent);
+    const { message: _m, args: _a, ...rest } = ev;
+    const message = LogFormatUtil.getLogMessage(ev);
+    const context = LogFormatUtil.getContext(ev);
+    return JSON.stringify({
+      ...rest,
+      ...(message ? { message } : {}),
+      ...(context ? { context } : {}),
+    }, null, this.opts.jsonIndent);
   }
 }

package/src/formatter/line.ts

@@ -7,6 +7,7 @@ import { Ignore } from '@travetto/schema';
 import { StyleUtil } from '@travetto/terminal';
 
 import { LogEvent, LogFormatter } from '../types';
+import { LogFormatUtil } from './util';
 
 /**
  * Level coloring
@@ -85,13 +86,6 @@ export class LineLogFormatter implements LogFormatter {
     this.opts = opts;
   }
 
-  pretty(ev: LogEvent, o: unknown): string {
-    return util.inspect(o, {
-      ...this.opts.inspectOptions,
-      showHidden: ev.level === 'debug',
-    });
-  }
-
   /**
    * Format an event into a single line
    */
@@ -129,17 +123,7 @@ export class LineLogFormatter implements LogFormatter {
       out.push(`[${loc}]`);
     }
 
-    if (ev.message) {
-      out.push(ev.message);
-    }
-
-    if (ev.args && ev.args.length) {
-      out.push(...ev.args.map(a => this.pretty(ev, a)));
-    }
-
-    if (ev.context && Object.keys(ev.context).length) {
-      out.push(this.pretty(ev, ev.context));
-    }
+    out.push(LogFormatUtil.getLogMessage(ev, this.opts.inspectOptions));
 
     return out.join(' ');
   }

package/src/formatter/util.ts

@@ -0,0 +1,24 @@
+import { inspect, type InspectOptions } from 'node:util';
+import { ObjectUtil } from '@travetto/base';
+import { LogEvent } from '../types';
+
+export class LogFormatUtil {
+  static #inspectOptions = { colors: false, showHidden: false, depth: 5, breakLength: 200 };
+
+  /** Generate log context */
+  static getContext(ev: LogEvent): Record<string, unknown> | undefined {
+    const out: Record<string, unknown> = {};
+    for (const o of ev.args ?? []) {
+      if (ObjectUtil.isPlainObject(o)) {
+        Object.assign(out, o);
+      }
+    }
+    return out && Object.keys(out).length > 0 ? out : undefined;
+  }
+
+  /** Get log message */
+  static getLogMessage(ev: LogEvent, options: InspectOptions = this.#inspectOptions): string {
+    const formatted = ev.args?.map(x => inspect(x, options)) ?? [];
+    return (ev.message ? [ev.message, ...formatted] : formatted).join(' ');
+  }
+}

package/src/service.ts

@@ -38,25 +38,14 @@ export class LogService implements ConsoleListener, AutoCreate {
    */
   onLog(ev: ConsoleEvent): void {
     const args = [...ev.args];
-    let context: Record<string, unknown> | undefined;
     let message: string | undefined;
     if (typeof args[0] === 'string') {
       message = args[0];
       args.shift(); // First arg is now the message
     }
 
-    // More flexible on context
-    const last = args[args.length - 1];
-    if (last !== null && last !== undefined && typeof last === 'object') {
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      context = Object.fromEntries(
-        Object.entries(last).filter(x => typeof x[1] !== 'function')
-      );
-      args.pop();
-    }
-
     // Allow for controlled order of event properties
-    let outEvent: LogEvent = { ...ev, message, context, args };
+    let outEvent: LogEvent = { ...ev, message, args };
 
     // Decorate event as needed
     for (const d of this.#decorators) {

package/src/types.ts

@@ -10,10 +10,6 @@ export interface LogEvent extends ConsoleEvent {
    * Log message
    */
   message?: string;
-  /**
-   * Log Message context
-   */
-  context?: Record<string, unknown>;
 }
 
 /**