@travetto/log 7.1.3 → 8.0.0-alpha.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/runtime/src/console.ts#L43) in the [Runtime](https://github.com/travetto/travetto/tree/main/module/runtime#readme "Runtime 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#L13), and by default will leverage the [LineLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/line.ts#L39) 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#L13) provides two configuration variables that allows for switching out [LineLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/line.ts#L39) 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#L13), and by default will leverage the [LineLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/line.ts#L39) 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#L13) provides two configuration variables that allows for switching out [LineLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/line.ts#L39) for the [JsonLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/json.ts#L17), 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
@@ -95,13 +95,14 @@ The [LogEvent](https://github.com/travetto/travetto/tree/main/module/log/src/typ
 ```typescript
 import { Injectable } from '@travetto/di';
 import type { LogEvent, Logger } from '@travetto/log';
+import { JSONUtil } from '@travetto/runtime';
 
 @Injectable()
 export class CustomLogger implements Logger {
   log(event: LogEvent): void {
     const headers = new Headers();
     headers.set('Content-Type', 'application/json');
-    const body = JSON.stringify(event);
+    const body = JSONUtil.toUTF8(event);
     fetch('http://localhost:8080/log', { method: 'POST', headers, body, });
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/log",
-  "version": "7.1.3",
+  "version": "8.0.0-alpha.0",
   "type": "module",
   "description": "Logging framework that integrates at the console.log level.",
   "keywords": [
@@ -24,9 +24,9 @@
     "directory": "module/log"
   },
   "dependencies": {
-    "@travetto/config": "^7.1.3",
-    "@travetto/di": "^7.1.3",
-    "@travetto/terminal": "^7.1.3"
+    "@travetto/config": "^8.0.0-alpha.0",
+    "@travetto/di": "^8.0.0-alpha.0",
+    "@travetto/terminal": "^8.0.0-alpha.0"
   },
   "travetto": {
     "displayName": "Logging"

package/src/formatter/google.ts

@@ -1,3 +1,4 @@
+import { JSONUtil } from '@travetto/runtime';
 import { Injectable } from '@travetto/di';
 
 import type { LogFormatter, LogEvent } from '../types.ts';
@@ -26,7 +27,7 @@ export class GoogleLogFormatter implements LogFormatter {
       delete context.statusCode;
     }
 
-    return JSON.stringify({
+    return JSONUtil.toUTF8({
       context,
       'logging.googleapis.com/sourceLocation': { file: `${event.module}/${event.modulePath}`, line: event.line },
       'logging.googleapis.com/labels': { module: event.module, scope: event.scope },

package/src/formatter/json.ts

@@ -1,5 +1,6 @@
 import { Injectable } from '@travetto/di';
 import { Config } from '@travetto/config';
+import { JSONUtil } from '@travetto/runtime';
 
 import type { LogEvent, LogFormatter } from '../types.ts';
 import { LogFormatUtil } from './util.ts';
@@ -24,10 +25,10 @@ export class JsonLogFormatter implements LogFormatter {
     const { message: _m, args: _a, ...rest } = event;
     const message = LogFormatUtil.getLogMessage(event);
     const context = LogFormatUtil.getContext(event);
-    return JSON.stringify({
+    return JSONUtil.toUTF8({
       ...rest,
       ...(message ? { message } : {}),
       ...(context ? { context } : {}),
-    }, null, this.config.jsonIndent);
+    }, { indent: this.config.jsonIndent });
   }
 }

package/src/formatter/line.ts

@@ -1,6 +1,6 @@
 import util from 'node:util';
 
-import { Env } from '@travetto/runtime';
+import { Env, RuntimeIndex } from '@travetto/runtime';
 import { Injectable } from '@travetto/di';
 import { Config, EnvVar } from '@travetto/config';
 import { Ignore } from '@travetto/schema';
@@ -43,6 +43,7 @@ export class LineLogFormatterConfig {
   @EnvVar(Env.TRV_LOG_TIME.key)
   time?: 's' | 'ms' | string;
 
+  links?: boolean;
   colorize?: boolean;
   align?: boolean;
   level?: boolean;
@@ -62,6 +63,7 @@ export class LineLogFormatterConfig {
     this.time ??= (!this.plain ? 'ms' : undefined);
     this.plain ??= !StyleUtil.enabled;
     this.colorize ??= !this.plain;
+    this.links ??= !this.plain;
     this.location ??= !this.plain;
     this.level ??= !this.plain;
     this.align ??= !this.plain;
@@ -122,6 +124,9 @@ export class LineLogFormatter implements LogFormatter {
       if (this.config.colorize) {
         location = STYLES.location(location);
       }
+      if (this.config.links) {
+        location = StyleUtil.link(location, `file://${RuntimeIndex.getModule(event.module)?.sourcePath}/${event.modulePath}${event.line ? `#${event.line}` : ''}`);
+      }
       out.push(`[${location}]`);
     }