feat: support logging with winston

Author: realyuyanan

README.md

@@ -127,6 +127,31 @@ module.exports = {
 | -- | -- | -- | -- |
 | plugins | 否 | `new Plugin[]` | 插件列表 |
 
+<h2 align="center">winston</h2>
+
+### winston 是什么？
+
+`winston` 是一个通用且轻量的日志包。`winston` 支持多个日志通道，并且可以分别定义日志优先级。除了内置的三个日志传输通道[`Console`、 `File`、`HTTP`](https://github.com/winstonjs/winston#common-transport-options)，在 Winston 项目外部还会维护一些[传输模块](https://github.com/winstonjs)。查看 `winston` [官方文档](https://github.com/winstonjs/winston)。
+
+TSW 2.0 支持使用 `winston` 传输通道记录日志信息，用户在配置文件中可以添加 `winston.transports` 实例，日志会落到对应配置中。
+
+### 一个简单的示例
+
+使用 `winston` 记录 `error` 级别 以及 `debug` 级别以下的日志信息到对应文件中，当前 `config` 文件配置如下：
+
+```js
+module.exports = {
+  winston: [
+    new winston.transports.File({ filename: 'error.log', level: 'error'}),
+    new winston.transports.File({ filename: 'debug.log', level: 'debug'})
+  ]
+}
+```
+
+**日志记录**
+
+![log](./static/images/winston-log.png)
+
 <h2 align="center">License</h2>
 
 Tencent Server Web 的开源协议为 MIT, 详情参见 [LICENSE](https://github.com/Tencent/TSW/blob/master/LICENSE) 。

examples/koa/package.json

@@ -7,9 +7,11 @@
   "main": "index.js",
   "license": "MIT",
   "dependencies": {
-    "@tswjs/open-platform-plugin": "^0.0.7",
+    "@tswjs/open-platform-plugin": "0.0.7",
     "@tswjs/tsw": "^2.0.0-alpha",
-    "axios": "^0.19.0",
-    "koa": "^2.11.0"
+    "axios": "^0.19.2",
+    "koa": "^2.11.0",
+    "winston": "^3.2.1",
+    "winston-transport": "^4.3.0"
   }
 }

examples/koa/tswconfig.js

@@ -1,3 +1,4 @@
+const winston = require("winston");
 const OpenPlatformPlugin = require("@tswjs/open-platform-plugin");
 
 module.exports = {
@@ -23,5 +24,9 @@ module.exports = {
         };
       }
     })
+  ],
+  winstonTransports: [
+    new winston.transports.File({ filename: 'error.log', level: 'error'}),
+    new winston.transports.File({ filename: 'debug.log', level: 'debug'})
   ]
 };

lib/core/__test__/winston.test.ts

@@ -0,0 +1,14 @@
+import { winstonHack } from "../winston";
+import logger from "../../core/logger/index";
+
+describe("test winstonHack env", () => {
+  test("test logger's winstonLogger when it hasn't hacked", () => {
+    expect(logger.winstonLogger).toBe(undefined);
+  });
+
+  global.tswConfig.winstonTransports = undefined;
+  winstonHack();
+  test("test winstonHack while config without winstonTransports ", () => {
+    expect(logger.winstonLogger.log).toBe(undefined);
+  });
+});

lib/core/logger/index.ts

@@ -15,6 +15,7 @@ import isLinux from "../util/isLinux";
 import isInspect from "../util/isInspect";
 import getCallInfo from "./callInfo";
 import { Stream } from "stream";
+import { config as winstonConfig, Logger as WinstonLogger } from "winston";
 
 enum LOG_LEVEL {
   "DEBUG" = 10,
@@ -32,9 +33,13 @@ enum LOG_COLOR {
 
 type LogLevelStrings = keyof typeof LOG_LEVEL;
 
+type WinstonLogLevel = keyof typeof winstonConfig.syslog.levels;
+
 export class Logger {
   public logLevel: number
 
+  public winstonLogger: WinstonLogger
+
   public setLogLevel(level: LogLevelStrings): number {
     this.logLevel = LOG_LEVEL[level];
     return this.logLevel;
@@ -103,6 +108,11 @@ export class Logger {
     // Store log
     Logger.fillBuffer(type, logStr);
 
+    if (this.winstonLogger) {
+      const winstonLogType = Logger.getWinstonType(type);
+      this.winstonLogger.log(`${winstonLogType}`, logStr);
+    }
+
     if (isInspect()) {
       // When started with inspect, log will send to 2 places
       // 1. Local stdout
@@ -124,6 +134,24 @@ export class Logger {
     }
   }
 
+  /**
+   * Convert TSW log level to winston log level
+   * @param type Type of tsw log level
+   */
+  private static getWinstonType(type: LogLevelStrings): WinstonLogLevel {
+    const logType = type.toLowerCase();
+    const winstonLogLevel = winstonConfig.syslog.levels;
+    if (winstonLogLevel[logType]) {
+      return logType;
+    }
+
+    /**
+     * Take the least important level from Winston syslog levels
+     */
+    const levels = Object.keys(winstonLogLevel);
+    return levels[levels.length - 1];
+  }
+
   /**
    * Format a string based on it's type(DEBUG/INFO/...)
    * @param str String need to be formatted

lib/core/winston.ts

@@ -0,0 +1,21 @@
+/* !
+ * Tencent is pleased to support the open source community by making Tencent Server Web available.
+ * Copyright (C) 2018 THL A29 Limited, a Tencent company. All rights reserved.
+ * Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+ * http://opensource.org/licenses/MIT
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+
+import * as winston from "winston";
+import * as Transports from "winston-transport";
+import logger from "./logger/index";
+
+export const winstonHack = (): void => {
+  const transports: Array<Transports> = global.tswConfig.winstonTransports;
+  if (transports) {
+    logger.winstonLogger = winston.createLogger({
+      format: winston.format.simple(),
+      transports
+    });
+  }
+};

lib/index.ts

@@ -4,6 +4,7 @@ import { httpCreateServerHack } from "./core/runtime/create-server.hack";
 import { dnsHack } from "./core/runtime/dns.hack";
 import { requestHack } from "./core/runtime/capture/index";
 import { eventBus } from "./core/bus";
+import { winstonHack } from "./core/winston";
 
 export default async (
   basePath: string,
@@ -12,7 +13,6 @@ export default async (
 ): Promise<void> => {
   const configAbsolutePath = path.resolve(basePath, configPath);
   global.tswConfig = await import(configAbsolutePath);
-
   // eslint-disable-next-line no-restricted-syntax
   for (const plugin of global.tswConfig.plugins) {
     // eslint-disable-next-line no-await-in-loop
@@ -26,6 +26,7 @@ export default async (
   dnsHack();
   consoleHack();
   requestHack();
+  winstonHack();
 
   await import(path.resolve(basePath, mainPath));
 };

package.json

@@ -65,6 +65,8 @@
     "ip": "^1.1.5",
     "lodash": "^4.17.15",
     "moment": "^2.24.0",
+    "winston": "^3.2.1",
+    "winston-transport": "^4.3.0",
     "yargs": "^15.0.2"
   }
 }

static/images/winston-log.png

@@ -23,10 +23,10 @@ declare namespace NodeJS {
   interface Domain {
     currentContext?: any;
   }
-
   interface Global {
     tswConfig: {
       plugins: any[];
+      winstonTransports: any[];
     };
   }
 }