@nocobase/logger 1.0.0-alpha.13 → 1.0.0-alpha.15

package/lib/config.js

@@ -48,7 +48,7 @@ const getLoggerLevel = /* @__PURE__ */ __name(() => process.env.LOGGER_LEVEL ||
 const getLoggerFilePath = /* @__PURE__ */ __name((...paths) => {
   return import_path.default.resolve(process.env.LOGGER_BASE_PATH || import_path.default.resolve(process.cwd(), "storage", "logs"), ...paths);
 }, "getLoggerFilePath");
-const getLoggerTransport = /* @__PURE__ */ __name(() => (process.env.LOGGER_TRANSPORT || (process.env.APP_ENV === "development" ? "console" : "console,dailyRotateFile")).split(","), "getLoggerTransport");
+const getLoggerTransport = /* @__PURE__ */ __name(() => (process.env.LOGGER_TRANSPORT || "console,dailyRotateFile").split(","), "getLoggerTransport");
 const getLoggerFormat = /* @__PURE__ */ __name(() => process.env.LOGGER_FORMAT || (process.env.APP_ENV === "development" ? "console" : "json"), "getLoggerFormat");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/lib/format.js

@@ -133,15 +133,16 @@ const consoleFormat = import_winston.default.format.printf((info) => {
     }
   });
   const tags = Object.entries(info).filter(([k, v]) => !keys.includes(k) && v).map(([k, v]) => `${k}=${v}`).join(" ");
-  const level = info.level.padEnd(5, " ");
+  const level = `[${info.level}]`.padEnd(7, " ");
   const message = info.message.padEnd(44, " ");
   const color = {
     error: import_chalk.default.red,
     warn: import_chalk.default.yellow,
     info: import_chalk.default.green,
-    debug: import_chalk.default.blue
+    debug: import_chalk.default.blue,
+    trace: import_chalk.default.cyan
   }[info.level] || import_chalk.default.white;
-  const colorized = message.startsWith("Executing") ? color(`${info.timestamp} [${level}]`) + ` ${message}` : color(`${info.timestamp} [${level}] ${message}`);
+  const colorized = message.startsWith("Executing") ? color(`${info.timestamp} ${level}`) + ` ${message}` : color(`${info.timestamp} ${level} ${message}`);
   return `${colorized} ${tags}`;
 });
 const delimiterFormat = import_winston.default.format.printf(

package/lib/logger.d.ts

@@ -6,17 +6,27 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
-import winston, { Logger } from 'winston';
+import winston, { LeveledLogMethod, Logger as WinstonLogger } from 'winston';
 import 'winston-daily-rotate-file';
+interface Logger extends WinstonLogger {
+    trace: LeveledLogMethod;
+}
 interface LoggerOptions extends Omit<winston.LoggerOptions, 'transports' | 'format'> {
     dirname?: string;
     filename?: string;
     format?: 'logfmt' | 'json' | 'delimiter' | 'console' | winston.Logform.Format;
     transports?: ('console' | 'file' | 'dailyRotateFile' | winston.transport)[];
 }
-export declare const createLogger: (options: LoggerOptions) => winston.Logger;
+export declare const levels: {
+    trace: number;
+    debug: number;
+    info: number;
+    warn: number;
+    error: number;
+};
+export declare const createLogger: (options: LoggerOptions) => Logger;
 /**
  * @internal
  */
-export declare const createConsoleLogger: (options?: winston.LoggerOptions) => winston.Logger;
+export declare const createConsoleLogger: (options?: winston.LoggerOptions) => Logger;
 export { Logger, LoggerOptions };

package/lib/logger.js

@@ -37,9 +37,9 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var logger_exports = {};
 __export(logger_exports, {
-  Logger: () => import_winston.Logger,
   createConsoleLogger: () => createConsoleLogger,
-  createLogger: () => createLogger
+  createLogger: () => createLogger,
+  levels: () => levels
 });
 module.exports = __toCommonJS(logger_exports);
 var import_winston = __toESM(require("winston"));
@@ -47,12 +47,20 @@ var import_winston_daily_rotate_file = require("winston-daily-rotate-file");
 var import_config = require("./config");
 var import_transports = require("./transports");
 var import_format = require("./format");
+const levels = {
+  trace: 4,
+  debug: 3,
+  info: 2,
+  warn: 1,
+  error: 0
+};
 const createLogger = /* @__PURE__ */ __name((options) => {
   if (process.env.GITHUB_ACTIONS) {
     return createConsoleLogger();
   }
   const { format, ...rest } = options;
   const winstonOptions = {
+    levels,
     level: (0, import_config.getLoggerLevel)(),
     ...rest,
     transports: (0, import_transports.getTransports)(options)
@@ -62,6 +70,7 @@ const createLogger = /* @__PURE__ */ __name((options) => {
 const createConsoleLogger = /* @__PURE__ */ __name((options) => {
   const { format, ...rest } = options || {};
   return import_winston.default.createLogger({
+    levels,
     level: (0, import_config.getLoggerLevel)(),
     format: import_winston.default.format.combine(
       import_winston.default.format.timestamp({
@@ -75,7 +84,7 @@ const createConsoleLogger = /* @__PURE__ */ __name((options) => {
 }, "createConsoleLogger");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  Logger,
   createConsoleLogger,
-  createLogger
+  createLogger,
+  levels
 });

package/lib/request-logger.d.ts

@@ -6,10 +6,10 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
-import { LoggerOptions } from './logger';
+import { Logger, LoggerOptions } from './logger';
 export interface RequestLoggerOptions extends LoggerOptions {
     skip?: (ctx?: any) => Promise<boolean>;
     requestWhitelist?: string[];
     responseWhitelist?: string[];
 }
-export declare const requestLogger: (appName: string, options?: RequestLoggerOptions) => (ctx: any, next: any) => Promise<void>;
+export declare const requestLogger: (appName: string, requestLogger: Logger, options?: RequestLoggerOptions) => (ctx: any, next: any) => Promise<void>;

package/lib/request-logger.js

@@ -30,8 +30,6 @@ __export(request_logger_exports, {
   requestLogger: () => requestLogger
 });
 module.exports = __toCommonJS(request_logger_exports);
-var import_config = require("./config");
-var import_logger = require("./logger");
 var import_lodash = require("lodash");
 const defaultRequestWhitelist = [
   "action",
@@ -44,12 +42,7 @@ const defaultRequestWhitelist = [
   "referer"
 ];
 const defaultResponseWhitelist = ["status"];
-const requestLogger = /* @__PURE__ */ __name((appName, options) => {
-  const requestLogger2 = (0, import_logger.createLogger)({
-    dirname: (0, import_config.getLoggerFilePath)(appName),
-    filename: "request",
-    ...options || {}
-  });
+const requestLogger = /* @__PURE__ */ __name((appName, requestLogger2, options) => {
   return async (ctx, next) => {
     var _a, _b, _c, _d, _e, _f, _g, _h;
     const reqId = ctx.reqId;

package/lib/system-logger.d.ts

@@ -6,8 +6,7 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
-import { Logger } from 'winston';
-import { LoggerOptions } from './logger';
+import { Logger, LoggerOptions } from './logger';
 export interface SystemLoggerOptions extends LoggerOptions {
     seperateError?: boolean;
 }
@@ -17,10 +16,11 @@ export type logMethod = (message: string, meta?: {
     method?: string;
     [key: string]: any;
 }) => SystemLogger;
-export interface SystemLogger extends Omit<Logger, 'info' | 'warn' | 'error' | 'debug'> {
+export interface SystemLogger extends Omit<Logger, 'info' | 'warn' | 'error' | 'debug' | 'trace'> {
     info: logMethod;
     warn: logMethod;
     error: logMethod;
     debug: logMethod;
+    trace: logMethod;
 }
 export declare const createSystemLogger: (options: SystemLoggerOptions) => SystemLogger;

package/lib/system-logger.js

@@ -95,6 +95,12 @@ const _SystemLoggerTransport = class _SystemLoggerTransport extends import_winst
     }
     callback(null, true);
   }
+  close() {
+    this.logger.close();
+    if (this.errorLogger) {
+      this.errorLogger.close();
+    }
+  }
 };
 __name(_SystemLoggerTransport, "SystemLoggerTransport");
 let SystemLoggerTransport = _SystemLoggerTransport;
@@ -116,8 +122,15 @@ function child(defaultRequestMetadata) {
 }
 __name(child, "child");
 const createSystemLogger = /* @__PURE__ */ __name((options) => {
+  const transport = new SystemLoggerTransport(options);
+  transport.once("unpipe", () => {
+    transport.close();
+  });
   const logger = import_winston.default.createLogger({
-    transports: [new SystemLoggerTransport(options)]
+    levels: import_logger.levels,
+    transports: [transport]
+    // Due to the use of custom log levels,
+    // we have to use the any type until Winston updates the type definitions.
   });
   return new Proxy(logger, {
     get(target, prop) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/logger",
-  "version": "1.0.0-alpha.13",
+  "version": "1.0.0-alpha.15",
   "description": "nocobase logging library",
   "license": "AGPL-3.0",
   "main": "./lib/index.js",
@@ -18,5 +18,5 @@
     "winston-daily-rotate-file": "^5.0.0",
     "winston-transport": "^4.7.0"
   },
-  "gitHead": "bd97adef70762a6691b5b58ca6572672a8cdf838"
+  "gitHead": "2793d371368e094ea2bba04cfbe9b9b73c44edba"
 }