@rsdk/logging 4.0.1-next.0 → 4.0.1-next.1

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.0.1-next.1](https://github.com/R-Vision/rsdk/compare/v4.0.0...v4.0.1-next.1) (2023-12-06)
+
+**Note:** Version bump only for package @rsdk/logging
+
 ## [4.0.1-next.0](https://github.com/R-Vision/rsdk/compare/v4.0.0...v4.0.1-next.0) (2023-12-06)
 
 **Note:** Version bump only for package @rsdk/logging

package/dist/logger.factory.d.ts

@@ -5,6 +5,7 @@ import type { LoggerOptions, LoggingContext, OnMessage } from './types';
  * Фабрика является статической потому что
  */
 export declare class LoggerFactory {
+    private static opts;
     /**
      * Under the hood every logger instance will use this
      * static instance. Motivation for this is that it's much
@@ -16,7 +17,28 @@ export declare class LoggerFactory {
      */
     private static _globalPino;
     private static events;
-    static reconfigure(opts: LoggerOptions): void;
+    /**
+     * Переконфигурация pino нужна потому, что изначально логгер инициализируется
+     * с дефолтными настройками, т. к. конфигурация ещё не прочитана.
+     *
+     * FIXME: Это грязно. Надо придумать решение получше.
+     * @param opts Опции логгер
+     */
+    static reconfigure(opts: Partial<LoggerOptions>): void;
+    /**
+     * Этот метод должен быть вызван после того, как подключен instrumentation-pino.
+     * Пакет instrumentation-pino модифицирует require. Согласно предполагаемому автором
+     * библиотеки сценарию использования, нужно сначала выполнять эту модификацию, а
+     * уже потом делать require(import) pino.
+     *
+     * У нас pino импортируется раньше - на этапе сборки NestContainer. Мы не можем
+     * воткнуть auto-instrumentation-node вперёд инициализации контейнера потому,
+     * что мы хотим, чтобы подключение инструментирование зависело от настройки
+     * TRACING_ENABLED. Т. е. нас сначала нужно полностью инициализировать систему
+     * конфигурации, а уже потом решать - делать инструментирование или нет.
+     */
+    static applyInstrumentations(): void;
     static onMessage(handler: OnMessage): void;
     static create(context: LoggingContext): ILogger;
+    private static applyOptions;
 }

package/dist/logger.factory.js

@@ -13,6 +13,11 @@ const implementations_1 = require("./implementations");
  * Фабрика является статической потому что
  */
 class LoggerFactory {
+    static opts = {
+        level: defaults_1.DEFAULT_LEVEL,
+        redact: [],
+        stream: pino_1.default.destination(),
+    };
     /**
      * Under the hood every logger instance will use this
      * static instance. Motivation for this is that it's much
@@ -27,13 +32,34 @@ class LoggerFactory {
     });
     // eslint-disable-next-line unicorn/prefer-event-target
     static events = new node_events_1.default();
+    /**
+     * Переконфигурация pino нужна потому, что изначально логгер инициализируется
+     * с дефолтными настройками, т. к. конфигурация ещё не прочитана.
+     *
+     * FIXME: Это грязно. Надо придумать решение получше.
+     * @param opts Опции логгер
+     */
     static reconfigure(opts) {
-        const { redact, level, stream = pino_1.default.destination() } = opts;
-        // eslint-disable-next-line @typescript-eslint/no-var-requires,unicorn/prefer-module
-        this._globalPino = (0, pino_1.default)({
-            level: level ?? defaults_1.DEFAULT_LEVEL,
-            ...(redact && { redact }),
-        }, stream);
+        this.applyOptions(opts);
+        const { stream, ...other } = this.opts;
+        this._globalPino = (0, pino_1.default)(other, stream);
+    }
+    /**
+     * Этот метод должен быть вызван после того, как подключен instrumentation-pino.
+     * Пакет instrumentation-pino модифицирует require. Согласно предполагаемому автором
+     * библиотеки сценарию использования, нужно сначала выполнять эту модификацию, а
+     * уже потом делать require(import) pino.
+     *
+     * У нас pino импортируется раньше - на этапе сборки NestContainer. Мы не можем
+     * воткнуть auto-instrumentation-node вперёд инициализации контейнера потому,
+     * что мы хотим, чтобы подключение инструментирование зависело от настройки
+     * TRACING_ENABLED. Т. е. нас сначала нужно полностью инициализировать систему
+     * конфигурации, а уже потом решать - делать инструментирование или нет.
+     */
+    static applyInstrumentations() {
+        const { stream, ...other } = this.opts;
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        this._globalPino = require('pino')(other, stream);
     }
     static onMessage(handler) {
         this.events.on('msg', handler);
@@ -41,6 +67,10 @@ class LoggerFactory {
     static create(context) {
         return new implementations_1.PinoLogger(() => this._globalPino, (level, data) => this.events.emit('msg', level, data), context);
     }
+    static applyOptions(opts) {
+        const { redact, level, stream = pino_1.default.destination() } = opts || {};
+        Object.assign(this.opts, { redact, level: level ?? defaults_1.DEFAULT_LEVEL, stream });
+    }
 }
 exports.LoggerFactory = LoggerFactory;
 //# sourceMappingURL=logger.factory.js.map

package/dist/logger.factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger.factory.js","sourceRoot":"","sources":["../src/logger.factory.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAuC;AAEvC,gDAAwB;AAExB,yCAA2C;AAC3C,uDAA+C;AAS/C;;;GAGG;AACH,MAAa,aAAa;IACxB;;;;;;;;OAQG;IACK,MAAM,CAAC,WAAW,GAAS,IAAA,cAAI,EAAC;QACtC,KAAK,EAAE,wBAAa;KACrB,CAAC,CAAC;IAEH,uDAAuD;IAC/C,MAAM,CAAC,MAAM,GAAG,IAAI,qBAAY,EAAE,CAAC;IAE3C,MAAM,CAAC,WAAW,CAAC,IAAmB;QACpC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,cAAI,CAAC,WAAW,EAAE,EAAE,GAAG,IAAI,CAAC;QAE5D,oFAAoF;QACpF,IAAI,CAAC,WAAW,GAAG,IAAA,cAAI,EACrB;YACE,KAAK,EAAE,KAAK,IAAI,wBAAa;YAC7B,GAAG,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,CAAC;SAC1B,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,OAAkB;QACjC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,OAAuB;QACnC,OAAO,IAAI,4BAAU,CACnB,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,EACtB,CAAC,KAAe,EAAE,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EACxE,OAAO,CACR,CAAC;IACJ,CAAC;;AAxCH,sCAyCC"}
+{"version":3,"file":"logger.factory.js","sourceRoot":"","sources":["../src/logger.factory.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAuC;AAEvC,gDAAwB;AAExB,yCAA2C;AAC3C,uDAA+C;AAS/C;;;GAGG;AACH,MAAa,aAAa;IAChB,MAAM,CAAC,IAAI,GAAkB;QACnC,KAAK,EAAE,wBAAa;QACpB,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,cAAI,CAAC,WAAW,EAAE;KAC3B,CAAC;IAEF;;;;;;;;OAQG;IACK,MAAM,CAAC,WAAW,GAAS,IAAA,cAAI,EAAC;QACtC,KAAK,EAAE,wBAAa;KACrB,CAAC,CAAC;IAEH,uDAAuD;IAC/C,MAAM,CAAC,MAAM,GAAG,IAAI,qBAAY,EAAE,CAAC;IAE3C;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,IAA4B;QAC7C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;QAEvC,IAAI,CAAC,WAAW,GAAG,IAAA,cAAI,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,qBAAqB;QAC1B,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;QAEvC,8DAA8D;QAC9D,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,OAAkB;QACjC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,OAAuB;QACnC,OAAO,IAAI,4BAAU,CACnB,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,EACtB,CAAC,KAAe,EAAE,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EACxE,OAAO,CACR,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,IAA4B;QACtD,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,cAAI,CAAC,WAAW,EAAE,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;QAElE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,IAAI,wBAAa,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9E,CAAC;;AAzEH,sCA0EC"}

package/dist/types.d.ts

@@ -10,9 +10,9 @@ export declare enum LogLevel {
 }
 export type Params = Record<string, unknown>;
 export interface LoggerOptions {
-    level?: LogLevel;
-    redact?: string[];
-    stream?: pino.DestinationStream;
+    level: LogLevel;
+    redact: string[];
+    stream: pino.DestinationStream;
 }
 export type LoggingContext = string | Constructor;
 export type OnMessage = (level: LogLevel, data: object) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/logging",
-  "version": "4.0.1-next.0",
+  "version": "4.0.1-next.1",
   "description": "Base framework independent logging functionality",
   "license": "Apache License 2.0",
   "publishConfig": {
@@ -18,7 +18,7 @@
     "rxjs": "^7.8.1"
   },
   "peerDependencies": {
-    "@rsdk/common": "^4.0.1-next.0"
+    "@rsdk/common": "^4.0.1-next.1"
   },
-  "gitHead": "772c1ca796c9a5b279274d6a6fb1a356e64aa71f"
+  "gitHead": "9dcbaf369400a27c0b29fce9c7f319c5b81c9594"
 }

package/src/logger.factory.ts

@@ -17,6 +17,12 @@ import type {
  * Фабрика является статической потому что
  */
 export class LoggerFactory {
+  private static opts: LoggerOptions = {
+    level: DEFAULT_LEVEL,
+    redact: [],
+    stream: pino.destination(),
+  };
+
   /**
    * Under the hood every logger instance will use this
    * static instance. Motivation for this is that it's much
@@ -33,17 +39,38 @@ export class LoggerFactory {
   // eslint-disable-next-line unicorn/prefer-event-target
   private static events = new EventEmitter();
 
-  static reconfigure(opts: LoggerOptions): void {
-    const { redact, level, stream = pino.destination() } = opts;
+  /**
+   * Переконфигурация pino нужна потому, что изначально логгер инициализируется
+   * с дефолтными настройками, т. к. конфигурация ещё не прочитана.
+   *
+   * FIXME: Это грязно. Надо придумать решение получше.
+   * @param opts Опции логгер
+   */
+  static reconfigure(opts: Partial<LoggerOptions>): void {
+    this.applyOptions(opts);
+
+    const { stream, ...other } = this.opts;
 
-    // eslint-disable-next-line @typescript-eslint/no-var-requires,unicorn/prefer-module
-    this._globalPino = pino(
-      {
-        level: level ?? DEFAULT_LEVEL,
-        ...(redact && { redact }),
-      },
-      stream,
-    );
+    this._globalPino = pino(other, stream);
+  }
+
+  /**
+   * Этот метод должен быть вызван после того, как подключен instrumentation-pino.
+   * Пакет instrumentation-pino модифицирует require. Согласно предполагаемому автором
+   * библиотеки сценарию использования, нужно сначала выполнять эту модификацию, а
+   * уже потом делать require(import) pino.
+   *
+   * У нас pino импортируется раньше - на этапе сборки NestContainer. Мы не можем
+   * воткнуть auto-instrumentation-node вперёд инициализации контейнера потому,
+   * что мы хотим, чтобы подключение инструментирование зависело от настройки
+   * TRACING_ENABLED. Т. е. нас сначала нужно полностью инициализировать систему
+   * конфигурации, а уже потом решать - делать инструментирование или нет.
+   */
+  static applyInstrumentations(): void {
+    const { stream, ...other } = this.opts;
+
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    this._globalPino = require('pino')(other, stream);
   }
 
   static onMessage(handler: OnMessage): void {
@@ -57,4 +84,10 @@ export class LoggerFactory {
       context,
     );
   }
+
+  private static applyOptions(opts: Partial<LoggerOptions>): void {
+    const { redact, level, stream = pino.destination() } = opts || {};
+
+    Object.assign(this.opts, { redact, level: level ?? DEFAULT_LEVEL, stream });
+  }
 }

package/src/types.ts

@@ -13,9 +13,9 @@ export enum LogLevel {
 export type Params = Record<string, unknown>;
 
 export interface LoggerOptions {
-  level?: LogLevel;
-  redact?: string[];
-  stream?: pino.DestinationStream;
+  level: LogLevel;
+  redact: string[];
+  stream: pino.DestinationStream;
 }
 
 export type LoggingContext = string | Constructor;