@nocobase/logger 0.18.0-alpha.7 → 0.18.0-alpha.9

package/lib/config.d.ts

@@ -1,4 +1,4 @@
 export declare const getLoggerLevel: () => string;
 export declare const getLoggerFilePath: (...paths: string[]) => string;
 export declare const getLoggerTransport: () => ('console' | 'file' | 'dailyRotateFile')[];
-export declare const getLoggerFormat: () => 'logfmt' | 'json' | 'delimiter';
+export declare const getLoggerFormat: () => 'logfmt' | 'json' | 'delimiter' | 'console';

package/lib/config.js

@@ -40,7 +40,7 @@ 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 getLoggerFormat = /* @__PURE__ */ __name(() => process.env.LOGGER_FORMAT || (process.env.APP_ENV === "development" ? "logfmt" : "json"), "getLoggerFormat");
+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 = {
   getLoggerFilePath,

package/lib/format.d.ts

@@ -4,6 +4,7 @@ export declare const getFormat: (format?: LoggerOptions['format']) => winston.Lo
 export declare const colorFormat: winston.Logform.Format;
 export declare const stripColorFormat: winston.Logform.Format;
 export declare const logfmtFormat: winston.Logform.Format;
+export declare const consoleFormat: winston.Logform.Format;
 export declare const delimiterFormat: winston.Logform.Format;
 export declare const escapeFormat: winston.Logform.Format;
 export declare const sortFormat: winston.Logform.Format;

package/lib/format.js

@@ -29,6 +29,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var format_exports = {};
 __export(format_exports, {
   colorFormat: () => colorFormat,
+  consoleFormat: () => consoleFormat,
   delimiterFormat: () => delimiterFormat,
   escapeFormat: () => escapeFormat,
   getFormat: () => getFormat,
@@ -40,17 +41,16 @@ module.exports = __toCommonJS(format_exports);
 var import_chalk = __toESM(require("chalk"));
 var import_winston = __toESM(require("winston"));
 var import_config = require("./config");
+var import_lodash = require("lodash");
 const DEFAULT_DELIMITER = "|";
-const colorize = {
-  errors: import_chalk.default.red,
-  module: import_chalk.default.cyan,
-  reqId: import_chalk.default.gray,
-  request: import_chalk.default.green
-};
+const colorize = {};
 const getFormat = /* @__PURE__ */ __name((format) => {
   const configFormat = format || (0, import_config.getLoggerFormat)();
   let logFormat;
   switch (configFormat) {
+    case "console":
+      logFormat = import_winston.default.format.combine(consoleFormat);
+      break;
     case "logfmt":
       logFormat = logfmtFormat;
       break;
@@ -58,7 +58,7 @@ const getFormat = /* @__PURE__ */ __name((format) => {
       logFormat = import_winston.default.format.combine(escapeFormat, delimiterFormat);
       break;
     case "json":
-      logFormat = import_winston.default.format.combine(stripColorFormat, import_winston.default.format.json({ deterministic: false }));
+      logFormat = import_winston.default.format.combine(import_winston.default.format.json({ deterministic: false }));
       break;
     default:
       return import_winston.default.format.combine(format);
@@ -67,17 +67,15 @@ const getFormat = /* @__PURE__ */ __name((format) => {
 }, "getFormat");
 const colorFormat = import_winston.default.format((info) => {
   Object.entries(info).forEach(([k, v]) => {
-    if (k === "message" && info["level"].includes("error")) {
-      info[k] = colorize.errors(v);
-    }
-    if (k === "reqId" && v) {
-      info[k] = colorize.reqId(v);
-    }
-    if ((k === "module" || k === "submodule") && v) {
-      info[k] = colorize.module(v);
+    var _a;
+    const level = info["level"];
+    if (colorize[k]) {
+      info[k] = colorize[k](v);
+      return;
     }
-    if (v === "request" || v === "response") {
-      info[k] = colorize.request(v);
+    if ((_a = colorize[level]) == null ? void 0 : _a[k]) {
+      info[k] = colorize[level][k](v);
+      return;
     }
   });
   return info;
@@ -107,6 +105,36 @@ const logfmtFormat = import_winston.default.format.printf(
     return `${k}=${v}`;
   }).join(" ")
 );
+const consoleFormat = import_winston.default.format.printf((info) => {
+  const keys = ["level", "timestamp", "message"];
+  Object.entries(info).forEach(([k, v]) => {
+    if (typeof v === "object") {
+      if ((0, import_lodash.isEmpty)(v)) {
+        info[k] = "";
+        return;
+      }
+      try {
+        info[k] = JSON.stringify(v);
+      } catch (error) {
+        info[k] = String(v);
+      }
+    }
+    if (v === void 0 || v === null) {
+      info[k] = "";
+    }
+  });
+  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 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
+  }[info.level] || import_chalk.default.white;
+  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(
   (info) => Object.entries(info).map(([, v]) => {
     if (typeof v === "object") {
@@ -127,10 +155,11 @@ const escapeFormat = import_winston.default.format((info) => {
   }
   return { ...info, message };
 })();
-const sortFormat = import_winston.default.format((info) => ({ level: info.level, timestamp: info.timestamp, ...info }))();
+const sortFormat = import_winston.default.format((info) => ({ level: info.level, ...info }))();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   colorFormat,
+  consoleFormat,
   delimiterFormat,
   escapeFormat,
   getFormat,

package/lib/index.d.ts

@@ -2,5 +2,4 @@ export * from './config';
 export * from './logger';
 export * from './system-logger';
 export * from './request-logger';
-export * from './app-logger';
 export * from './transports';

package/lib/index.js

@@ -18,7 +18,6 @@ __reExport(src_exports, require("./config"), module.exports);
 __reExport(src_exports, require("./logger"), module.exports);
 __reExport(src_exports, require("./system-logger"), module.exports);
 __reExport(src_exports, require("./request-logger"), module.exports);
-__reExport(src_exports, require("./app-logger"), module.exports);
 __reExport(src_exports, require("./transports"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -26,6 +25,5 @@ __reExport(src_exports, require("./transports"), module.exports);
   ...require("./logger"),
   ...require("./system-logger"),
   ...require("./request-logger"),
-  ...require("./app-logger"),
   ...require("./transports")
 });

package/lib/logger.d.ts

@@ -1,21 +1,11 @@
 import winston, { Logger } from 'winston';
-import { SystemLoggerOptions } from './system-logger';
 import 'winston-daily-rotate-file';
 interface LoggerOptions extends Omit<winston.LoggerOptions, 'transports' | 'format'> {
     dirname?: string;
     filename?: string;
-    format?: 'logfmt' | 'json' | 'delimiter' | winston.Logform.Format;
+    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 createConsoleLogger: (options?: winston.LoggerOptions) => winston.Logger;
 export { Logger, LoggerOptions };
-interface ReqeustLoggerOptions extends LoggerOptions {
-    skip?: (ctx?: any) => Promise<boolean>;
-    requestWhitelist?: string[];
-    responseWhitelist?: string[];
-}
-export interface AppLoggerOptions {
-    request: ReqeustLoggerOptions;
-    system: SystemLoggerOptions;
-}

package/lib/logger.js

@@ -58,7 +58,7 @@ const createConsoleLogger = /* @__PURE__ */ __name((options) => {
       import_winston.default.format.timestamp({
         format: "YYYY-MM-DD HH:mm:ss"
       }),
-      format || import_winston.default.format.combine(import_format.sortFormat, import_format.colorFormat, import_format.logfmtFormat)
+      format || import_format.consoleFormat
     ),
     ...rest || {},
     transports: [new import_winston.default.transports.Console()]

package/lib/request-logger.d.ts

@@ -1,2 +1,7 @@
-import { AppLoggerOptions } from './logger';
-export declare const requestLogger: (appName: string, options?: AppLoggerOptions) => (ctx: any, next: any) => Promise<void>;
+import { 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>;

package/lib/request-logger.js

@@ -37,10 +37,10 @@ const requestLogger = /* @__PURE__ */ __name((appName, options) => {
   const requestLogger2 = (0, import_logger.createLogger)({
     dirname: (0, import_config.getLoggerFilePath)(appName),
     filename: "request",
-    ...(options == null ? void 0 : options.request) || {}
+    ...options || {}
   });
   return async (ctx, next) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
+    var _a, _b, _c, _d, _e, _f, _g, _h;
     const reqId = ctx.reqId;
     const path = /^\/api\/(.+):(.+)/.exec(ctx.path);
     const contextLogger = ctx.app.log.child({ reqId, module: path == null ? void 0 : path[1], submodule: path == null ? void 0 : path[2] });
@@ -51,11 +51,12 @@ const requestLogger = /* @__PURE__ */ __name((appName, options) => {
       path: ctx.url
     };
     requestLogger2.info({
-      reqId,
-      message: "request",
+      message: `request ${ctx.method} ${ctx.url}`,
       ...requestInfo,
-      req: (0, import_lodash.pick)(ctx.request.toJSON(), ((_a = options == null ? void 0 : options.request) == null ? void 0 : _a.requestWhitelist) || defaultRequestWhitelist),
-      action: (_c = (_b = ctx.action) == null ? void 0 : _b.toJSON) == null ? void 0 : _c.call(_b)
+      req: (0, import_lodash.pick)(ctx.request.toJSON(), (options == null ? void 0 : options.requestWhitelist) || defaultRequestWhitelist),
+      action: (_b = (_a = ctx.action) == null ? void 0 : _a.toJSON) == null ? void 0 : _b.call(_a),
+      app: appName,
+      reqId
     });
     let error;
     try {
@@ -66,19 +67,20 @@ const requestLogger = /* @__PURE__ */ __name((appName, options) => {
       const cost = Date.now() - startTime;
       const status = ctx.status;
       const info = {
-        reqId,
-        message: "response",
+        message: `response ${ctx.url}`,
         ...requestInfo,
-        res: (0, import_lodash.pick)(ctx.response.toJSON(), ((_d = options == null ? void 0 : options.request) == null ? void 0 : _d.responseWhitelist) || defaultResponseWhitelist),
-        action: (_f = (_e = ctx.action) == null ? void 0 : _e.toJSON) == null ? void 0 : _f.call(_e),
-        userId: (_h = (_g = ctx.auth) == null ? void 0 : _g.user) == null ? void 0 : _h.id,
+        res: (0, import_lodash.pick)(ctx.response.toJSON(), (options == null ? void 0 : options.responseWhitelist) || defaultResponseWhitelist),
+        action: (_d = (_c = ctx.action) == null ? void 0 : _c.toJSON) == null ? void 0 : _d.call(_c),
+        userId: (_f = (_e = ctx.auth) == null ? void 0 : _e.user) == null ? void 0 : _f.id,
         status: ctx.status,
-        cost
+        cost,
+        app: appName,
+        reqId
       };
       if (Math.floor(status / 100) == 5) {
-        requestLogger2.error({ ...info, res: ((_i = ctx.body) == null ? void 0 : _i["errors"]) || ctx.body });
+        requestLogger2.error({ ...info, res: ((_g = ctx.body) == null ? void 0 : _g["errors"]) || ctx.body });
       } else if (Math.floor(status / 100) == 4) {
-        requestLogger2.warn({ ...info, res: ((_j = ctx.body) == null ? void 0 : _j["errors"]) || ctx.body });
+        requestLogger2.warn({ ...info, res: ((_h = ctx.body) == null ? void 0 : _h["errors"]) || ctx.body });
       } else {
         requestLogger2.info(info);
       }

package/lib/system-logger.d.ts

@@ -1,6 +1,18 @@
-import winston from 'winston';
+import { Logger } from 'winston';
 import { LoggerOptions } from './logger';
 export interface SystemLoggerOptions extends LoggerOptions {
     seperateError?: boolean;
 }
-export declare const createSystemLogger: (options: SystemLoggerOptions) => winston.Logger;
+export type logMethod = (message: string, meta?: {
+    module?: string;
+    submodule?: string;
+    method?: string;
+    [key: string]: any;
+}) => SystemLogger;
+export interface SystemLogger extends Omit<Logger, 'info' | 'warn' | 'error' | 'debug'> {
+    info: logMethod;
+    warn: logMethod;
+    error: logMethod;
+    debug: logMethod;
+}
+export declare const createSystemLogger: (options: SystemLoggerOptions) => SystemLogger;

package/lib/system-logger.js

@@ -58,17 +58,18 @@ const _SystemLoggerTransport = class _SystemLoggerTransport extends import_winst
     }
   }
   log(info, callback) {
-    const { level, message, reqId, [import_triple_beam.SPLAT]: args } = info;
+    const { level, message, reqId, app, [import_triple_beam.SPLAT]: args } = info;
     const logger = level === "error" && this.errorLogger ? this.errorLogger : this.logger;
     const { module: module2, submodule, method, ...meta } = (args == null ? void 0 : args[0]) || {};
     logger.log({
       level,
-      reqId,
       message,
+      meta,
       module: module2 || info["module"] || "",
       submodule: submodule || info["submodule"] || "",
       method: method || "",
-      meta
+      app,
+      reqId
     });
     callback(null, true);
   }

package/lib/transports.js

@@ -64,7 +64,7 @@ const getTransports = /* @__PURE__ */ __name((options) => {
   );
   const transports = {
     console: () => Transports.console({
-      format: import_winston.default.format.combine(import_winston.default.format.colorize(), import_format.colorFormat, format)
+      format: import_winston.default.format.combine(format)
     }),
     file: () => Transports.file({
       dirname,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/logger",
-  "version": "0.18.0-alpha.7",
+  "version": "0.18.0-alpha.9",
   "description": "nocobase logging library",
   "license": "Apache-2.0",
   "main": "./lib/index.js",
@@ -18,5 +18,5 @@
     "winston-daily-rotate-file": "^4.7.1",
     "winston-transport": "^4.5.0"
   },
-  "gitHead": "979a9c59a98c61a2287dd847580746a9b597cbde"
+  "gitHead": "34ca0df4eede2e83fc86297b0fe19eba970e2b1b"
 }

package/lib/app-logger.d.ts

@@ -1,17 +0,0 @@
-import { Logger } from 'winston';
-import { SystemLoggerOptions } from './system-logger';
-export declare const createAppLogger: ({ app, ...options }: SystemLoggerOptions & {
-    app?: string;
-}) => Logger;
-export type logMethod = (message: string, meta?: {
-    module?: string;
-    submodule?: string;
-    method?: string;
-    [key: string]: any;
-}) => AppLogger;
-export interface AppLogger extends Omit<Logger, 'info' | 'warn' | 'error' | 'debug'> {
-    info: logMethod;
-    warn: logMethod;
-    error: logMethod;
-    debug: logMethod;
-}

package/lib/app-logger.js

@@ -1,30 +0,0 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var app_logger_exports = {};
-__export(app_logger_exports, {
-  createAppLogger: () => createAppLogger
-});
-module.exports = __toCommonJS(app_logger_exports);
-var import_system_logger = require("./system-logger");
-var import_config = require("./config");
-const createAppLogger = /* @__PURE__ */ __name(({ app, ...options }) => (0, import_system_logger.createSystemLogger)({ dirname: (0, import_config.getLoggerFilePath)(app), filename: "system", seperateError: true, ...options }), "createAppLogger");
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  createAppLogger
-});