fix: audit dir and compatible with old configurations (#107)

* fix: audit dir

* fix: case

* docs: update

Author: czy88840616

BREAKING-3.md

@@ -171,4 +171,11 @@ const newLoggerConfig = formatLegacyLoggerOptions({
 
 ~~注意，这个方法只能转换老的配置，如果配置中同时包含新老配置，则新配置不会有任何变化。~~
 
-当前版本已经可以同时支持新老配置，不需要转换了，如果新配置和老配置同时存在，老配置会忽略，你可以使用 `formatLegacyLoggerOptions` 方法测试转换后的结果。
+当前版本已经可以同时支持新老配置，不需要自行转换了，如可以使用 `formatLegacyLoggerOptions` 方法测试转换后的结果。
+
+转换逻辑如下：
+
+* 1、如果都是新配置，则不做任何处理
+* 2、如果配置中包含 `enableXXXX` 或者 `disableXXXX`，则会优先处理，即使存在 transports 的配置
+* 3、当新老配置同时存在时，老配置会被忽略，比如 dir 和 transports 中的 dir，则 transports 中的 dir 优先级更高
+* 4、转换完成后，如果 transports 中缺少必要的配置，比如 file/error/json 中缺少 dir 和 fileLogName，则会移除这个 Transport

src/factory.ts

@@ -1,6 +1,7 @@
 import {
   ContextLoggerOptions,
   ILogger,
+  LegacyLoggerOptions,
   LoggerFactoryOptions,
   LoggerOptions,
 } from './interface';
@@ -15,7 +16,10 @@ export class LoggerFactory extends Map<string, ILogger> {
     super();
   }
 
-  createLogger(name: string, options: LoggerOptions): ILogger {
+  createLogger(
+    name: string,
+    options: LoggerOptions & LegacyLoggerOptions
+  ): ILogger {
     if (!this.has(name)) {
       debug('[logger]: Create logger "%s" with options %j', name, options);
       const logger = new MidwayLogger(

src/index.ts

@@ -3,6 +3,7 @@ import {
   ConsoleTransportOptions,
   FileTransportOptions,
   ILogger,
+  LegacyLoggerOptions,
   LoggerOptions,
 } from './interface';
 import { MidwayLogger } from './logger';
@@ -22,7 +23,7 @@ export const clearAllLoggers = () => {
 };
 export const createLogger = <T = ILogger>(
   name: string,
-  options: LoggerOptions = {}
+  options: LoggerOptions & LegacyLoggerOptions = {}
 ): T => {
   return loggers.createLogger(name, options) as T;
 };

src/interface.ts

@@ -187,14 +187,17 @@ export interface LegacyLoggerOptions {
   level?: LoggerLevel;
   /**
    * level for console logger
+   * @deprecated
    */
   consoleLevel?: LoggerLevel;
   /**
    * level for file logger
+   * @deprecated
    */
   fileLevel?: LoggerLevel;
   /**
    * level for json logger
+   * @deprecated
    */
   jsonLevel?: LoggerLevel;
   /**
@@ -207,18 +210,22 @@ export interface LegacyLoggerOptions {
   contextFormat?: LoggerFormat;
   /**
    * format for json logger
+   * @deprecated
    */
   jsonFormat?: LoggerFormat;
   /**
    * The directory where file logger will be output
+   * @deprecated
    */
   dir?: string;
   /**
    * The directory where error logger will be output, if not set, use dir to instead.
+   * @deprecated
    */
   errorDir?: string;
   /**
    * The directory where json logger will be output, if not set, use dir to instead.
+   * @deprecated
    */
   jsonDir?: string;
   /**
@@ -227,46 +234,57 @@ export interface LegacyLoggerOptions {
   aliasName?: string;
   /**
    * Output log name for file logger
+   * @deprecated
    */
   fileLogName?: string;
   /**
    * Output log name for error logger
+   * @deprecated
    */
   errorLogName?: string;
   /**
    * Output log name for json logger
+   * @deprecated
    */
   jsonLogName?: string;
   /**
    * Enable console transport, default is true
+   * @deprecated
    */
   enableConsole?: boolean;
   /**
    * Enable console transport, default is true
+   * @deprecated
    */
   enableFile?: boolean;
   /**
    * Enable console transport, default is true
+   * @deprecated
    */
   enableError?: boolean;
   /**
    * Enable json transport, default is false
+   * @deprecated
    */
   enableJSON?: boolean;
   /**
    * disable symlink for file, error and json logger
+   * @deprecated
    */
   disableSymlink?: boolean;
   /**
    * disable symlink for file logger
+   * @deprecated
    */
   disableFileSymlink?: boolean;
   /**
    * disable symlink for error logger
+   * @deprecated
    */
   disableErrorSymlink?: boolean;
   /**
    * disable symlink for json logger
+   * @deprecated
    */
   disableJSONSymlink?: boolean;
   /**
@@ -276,18 +294,22 @@ export interface LegacyLoggerOptions {
    * If using the units, add 'k', 'm', or 'g' as the suffix.
    * The units need to directly follow the number.
    * default is 200m
+   * @deprecated
    */
   maxSize?: string;
   /**
    * max file size for file logger
+   * @deprecated
    */
   fileMaxSize?: string;
   /**
    * max file size for error logger
+   * @deprecated
    */
   errMaxSize?: string;
   /**
    * max file size for json logger
+   * @deprecated
    */
   jsonMaxSize?: string;
   /**
@@ -298,34 +320,52 @@ export interface LegacyLoggerOptions {
    * It won't delete any file not contained in it.
    * It can be a number of files or number of days
    * default is 31d
+   * @deprecated
    */
   maxFiles?: number | string;
+  /**
+   * max files for file logger
+   * @deprecated
+   */
   fileMaxFiles?: number | string;
+  /**
+   * max files for error logger
+   * @deprecated
+   */
   errMaxFiles?: number | string;
+  /**
+   * max files for json logger
+   * @deprecated
+   */
   jsonMaxFiles?: number | string;
   /**
    * end of line string for file and error logger
    */
   eol?: string;
   /**
    * end of line string for json logger
+   * @deprecated
    */
   jsonEol?: string;
   /**
    * A boolean to define whether or not to gzip archived log files.
    * for file, error and json logger
+   * @deprecated
    */
   zippedArchive?: boolean;
   /**
    * gzip options for file logger
+   * @deprecated
    */
   fileZippedArchive?: boolean;
   /**
    * gzip options for error logger
+   * @deprecated
    */
   errZippedArchive?: boolean;
   /**
    * gzip options for json logger
+   * @deprecated
    */
   jsonZippedArchive?: boolean;
   /**
@@ -334,22 +374,27 @@ export interface LegacyLoggerOptions {
    * For example, if your datePattern is simply 'HH' you will end up with 24 log files that are picked up and appended to every day.
    * default: 'YYYY-MM-DD'
    * for file, error and json logger
+   * @deprecated
    */
   datePattern?: string;
   /**
    * date pattern for file logger
+   * @deprecated
    */
   fileDatePattern?: string;
   /**
    * date pattern for error logger
+   * @deprecated
    */
   errDatePattern?: string;
   /**
    * date pattern for json logger
+   * @deprecated
    */
   jsonDatePattern?: string;
   /**
    * A directory of the audit file with absolute path.
+   * @deprecated
    */
   auditFileDir?: string;
   /**

src/logger.ts

@@ -3,6 +3,7 @@ import {
   ContextLoggerOptions,
   ILogger,
   ITransport,
+  LegacyLoggerOptions,
   LoggerLevel,
   LoggerOptions,
   LogMeta,
@@ -25,7 +26,7 @@ export class MidwayLogger implements ILogger {
   private closeHandlers: Array<() => void> = [];
   protected options: LoggerOptions;
 
-  constructor(options: LoggerOptions = {}) {
+  constructor(options: LoggerOptions & LegacyLoggerOptions = {}) {
     options = formatLegacyLoggerOptions(options);
     this.options = options;
     this.options.level = this.options.level || 'silly';

src/transport/file.ts

@@ -57,14 +57,22 @@ export class FileTransport
       zippedArchive: false,
     } as Omit<StreamOptions, 'filename'>;
 
+    if (!this.options.auditFileDir) {
+      options.auditFileDir = this.options.dir;
+    }
+
+    if (!path.isAbsolute(this.options.auditFileDir)) {
+      options.auditFileDir = path.join(this.options.dir, options.auditFileDir);
+    }
+
     this.logStream = FileStreamRotatorManager.getStream({
       ...defaultStreamOptions,
       filename: path.join(this.options.dir, this.options.fileLogName),
-      size: getMaxSize(options.maxSize || '200m'),
+      size: getMaxSize(this.options.maxSize || '200m'),
       symlinkName: this.options.fileLogName,
       auditFile: path.join(
-        options.auditFileDir || this.options.dir,
-        '.' + hash(options) + '-audit.json'
+        options.auditFileDir,
+        '.' + hash(this.options) + '-audit.json'
       ),
       ...options,
     });