@travetto/log 4.1.1 → 5.0.0-rc.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 ArcSine Technologies
+Copyright (c) 2023 ArcSine Technologies
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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#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`.
+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#L12) depending on the value of `CommonLoggerConfig.output`.
 
 **Code: Standard Logging Config**
 ```typescript
@@ -53,7 +53,7 @@ The default pattern for logging is to create a [Logger](https://github.com/trave
 **Code: Logger Shape**
 ```typescript
 export interface Logger {
-  onLog(ev: LogEvent): unknown;
+  log(ev: LogEvent): unknown;
 }
 ```
 
@@ -73,7 +73,7 @@ export type ConsoleEvent = {
   /** Time of event */
   timestamp: Date;
   /** The level of the console event */
-  level: LogLevel;
+  level: 'info' | 'warn' | 'debug' | 'error';
   /** The source file of the event */
   source: string;
   /** The line number the console event was triggered from */
@@ -89,7 +89,7 @@ export type ConsoleEvent = {
 };
 ```
 
-The [LogEvent](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L8) is an extension of the [ConsoleEvent](https://github.com/travetto/travetto/tree/main/module/base/src/types.ts#L12) with the addition of two fields:
+The [LogEvent](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L8) is an extension of the [ConsoleEvent](https://github.com/travetto/travetto/tree/main/module/base/src/console.ts#L6) with the addition of two fields:
    *  `message` - This is the primary argument passed to the console statement, if it happens to be a string, otherwise the field is left empty
    *  `context` - This is the final argument passed to the console statement, if it happens to be a simple object.  This is useful for external loggers that allow for searching/querying by complex data
 
@@ -100,7 +100,7 @@ import { LogEvent, Logger } from '@travetto/log';
 
 @Injectable()
 export class CustomLogger implements Logger {
-  onLog(ev: LogEvent): void {
+  log(ev: LogEvent): void {
     const headers = new Headers();
     headers.set('Content-Type', 'application/json');
     const body = JSON.stringify(ev);

package/package.json

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

package/src/appender/file.ts

@@ -1,9 +1,10 @@
 import { createWriteStream, WriteStream, mkdirSync, openSync, appendFileSync } from 'node:fs';
+import path from 'node:path';
 
 import { Env } from '@travetto/base';
 import { Injectable } from '@travetto/di';
 import { Config, EnvVar } from '@travetto/config';
-import { path, RuntimeContext } from '@travetto/manifest';
+import { RuntimeContext } from '@travetto/manifest';
 
 import { LogAppender, LogEvent } from '../types';
 

package/src/common.ts

@@ -34,7 +34,7 @@ export class CommonLogger implements Logger {
     this.appender ??= await DependencyRegistry.getInstance(this.config.output !== 'console' ? FileLogAppender : ConsoleLogAppender);
   }
 
-  onLog(ev: LogEvent): void {
+  log(ev: LogEvent): void {
     this.appender.append(ev, this.formatter.format(ev));
   }
 }

package/src/formatter/util.ts

@@ -1,5 +1,5 @@
 import { inspect, type InspectOptions } from 'node:util';
-import { ObjectUtil } from '@travetto/base';
+import { DataUtil } from '@travetto/schema';
 import { LogEvent } from '../types';
 
 export class LogFormatUtil {
@@ -9,7 +9,7 @@ export class LogFormatUtil {
   static getContext(ev: LogEvent): Record<string, unknown> | undefined {
     const out: Record<string, unknown> = {};
     for (const o of ev.args ?? []) {
-      if (ObjectUtil.isPlainObject(o)) {
+      if (DataUtil.isPlainObject(o)) {
         Object.assign(out, o);
       }
     }

package/src/service.ts

@@ -29,14 +29,13 @@ export class LogService implements ConsoleListener, AutoCreate {
 
     this.#decorators = await DependencyRegistry.getCandidateInstances<LogDecorator>(LogDecoratorTarget);
 
-    // Take over
-    ConsoleManager.set(this, true);
+    ConsoleManager.set(this);
   }
 
   /**
    * Endpoint for listening, endpoint registered with ConsoleManager
    */
-  onLog(ev: ConsoleEvent): void {
+  log(ev: ConsoleEvent): void {
     const args = [...ev.args];
     let message: string | undefined;
     if (typeof args[0] === 'string') {
@@ -53,7 +52,7 @@ export class LogService implements ConsoleListener, AutoCreate {
     }
 
     for (const l of this.#listeners) {
-      l.onLog(outEvent);
+      l.log(outEvent);
     }
   }
 }

package/src/types.ts

@@ -39,5 +39,5 @@ export interface LogFormatter {
  * @concrete ./internal/types#LoggerTarget
  */
 export interface Logger {
-  onLog(ev: LogEvent): unknown;
+  log(ev: LogEvent): unknown;
 }