@travetto/log 6.0.1 → 7.0.0-rc.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#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#L13), 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#L13) 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#L36) or [LogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L28), with the declared symbol of `LogCommonSymbol`.
+In addition to these simple overrides, the [CommonLogger](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L13) can be extended by providing an implementation of either a [LogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L36) or [LogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L28), with the declared symbol of `LogCommonSymbol`.
 
 **Code: Sample Common Formatter**
 ```typescript
@@ -127,13 +127,10 @@ import { LogDecorator, LogEvent } from '@travetto/log';
 @Injectable()
 export class CustomDecorator implements LogDecorator {
   decorate(ev: LogEvent): LogEvent {
-
-    // Add memory usage, and hostname
-    Object.assign(ev.context ??= {}, {
+    ev.args.push({
       memory: process.memoryUsage,
       hostname: os.hostname()
     });
-
     return ev;
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/log",
-  "version": "6.0.1",
+  "version": "7.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": "^6.0.1",
-    "@travetto/di": "^6.0.1",
-    "@travetto/terminal": "^6.0.1"
+    "@travetto/config": "^7.0.0-rc.0",
+    "@travetto/di": "^7.0.0-rc.0",
+    "@travetto/terminal": "^7.0.0-rc.0"
   },
   "travetto": {
     "displayName": "Logging"

package/src/common.ts

@@ -1,6 +1,7 @@
-import { Env } from '@travetto/runtime';
+import { Class, Env } from '@travetto/runtime';
 import { Config, EnvVar } from '@travetto/config';
-import { DependencyRegistry, Inject, Injectable } from '@travetto/di';
+import { DependencyRegistryIndex, Inject, Injectable } from '@travetto/di';
+import { Required } from '@travetto/schema';
 
 import { ConsoleLogAppender } from './appender/console.ts';
 import { FileLogAppender } from './appender/file.ts';
@@ -23,15 +24,19 @@ export class CommonLogger implements Logger {
   @Inject()
   config: CommonLoggerConfig;
 
-  @Inject(LogCommonSymbol, { optional: true })
+  @Inject(LogCommonSymbol)
+  @Required(false)
   formatter: LogFormatter;
 
-  @Inject(LogCommonSymbol, { optional: true })
+  @Inject(LogCommonSymbol)
+  @Required(false)
   appender: LogAppender;
 
   async postConstruct(): Promise<void> {
-    this.formatter ??= await DependencyRegistry.getInstance(this.config.format === 'line' ? LineLogFormatter : JsonLogFormatter);
-    this.appender ??= await DependencyRegistry.getInstance(this.config.output !== 'console' ? FileLogAppender : ConsoleLogAppender);
+    const formatterCls: Class = this.config.format === 'line' ? LineLogFormatter : JsonLogFormatter;
+    const appenderCls: Class = this.config.output !== 'console' ? FileLogAppender : ConsoleLogAppender;
+    this.formatter ??= await DependencyRegistryIndex.getInstance(formatterCls);
+    this.appender ??= await DependencyRegistryIndex.getInstance(appenderCls);
   }
 
   log(ev: LogEvent): void {

package/src/formatter/util.ts

@@ -1,5 +1,8 @@
 import { inspect, type InspectOptions } from 'node:util';
+
 import { DataUtil } from '@travetto/schema';
+import { safeAssign } from '@travetto/runtime';
+
 import { LogEvent } from '../types.ts';
 
 const INSPECT_OPTIONS = { colors: false, showHidden: false, depth: 5, breakLength: 200 };
@@ -10,7 +13,7 @@ export class LogFormatUtil {
     const out: Record<string, unknown> = {};
     for (const o of ev.args ?? []) {
       if (DataUtil.isPlainObject(o)) {
-        Object.assign(out, o);
+        safeAssign(out, o);
       }
     }
     return out && Object.keys(out).length > 0 ? out : undefined;

package/src/service.ts

@@ -1,5 +1,5 @@
 import { ConsoleListener, ConsoleManager, ConsoleEvent, toConcrete } from '@travetto/runtime';
-import { DependencyRegistry, Injectable } from '@travetto/di';
+import { DependencyRegistryIndex, Injectable } from '@travetto/di';
 
 import { LogDecorator, LogEvent, Logger } from './types.ts';
 import { CommonLogger } from './common.ts';
@@ -7,7 +7,7 @@ import { CommonLogger } from './common.ts';
 /**
  * Logger service
  */
-@Injectable({ autoCreate: true })
+@Injectable({ autoInject: true })
 export class LogService implements ConsoleListener {
 
   /**
@@ -21,12 +21,12 @@ export class LogService implements ConsoleListener {
   #decorators: LogDecorator[] = [];
 
   async postConstruct(): Promise<void> {
-    this.#listeners = await DependencyRegistry.getCandidateInstances(toConcrete<Logger>(), c => c.class !== CommonLogger);
+    this.#listeners = await DependencyRegistryIndex.getInstances(toConcrete<Logger>(), c => c.class !== CommonLogger);
     if (!this.#listeners.length) {
-      this.#listeners = [await DependencyRegistry.getInstance(CommonLogger)];
+      this.#listeners = [await DependencyRegistryIndex.getInstance(CommonLogger)];
     }
 
-    this.#decorators = await DependencyRegistry.getCandidateInstances(toConcrete<LogDecorator>());
+    this.#decorators = await DependencyRegistryIndex.getInstances(toConcrete<LogDecorator>());
 
     ConsoleManager.set(this);
   }