fix(winston): verify the length of winston transports

Tencent · Aug 10, 2021 · 6976a6e · 6976a6e
1 parent 44d0327
commit 6976a6e
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/lib/core/__test__/winston.test.ts b/lib/core/__test__/winston.test.ts
@@ -17,6 +17,11 @@ describe("test winstonHack env", () => {
     expect(logger.winstonLogger).toBe(undefined);
   });
 
+  test("test winstonHack while the length of winstonTransports is 0", () => {
+    winstonHack();
+    expect(logger.winstonLogger).toBe(undefined);
+  });
+
   test("test winstonHack while config with Console Transports ", () => {
     global.tswConfig.winstonTransports = [
       new winston.transports.Console()

diff --git a/lib/core/winston.ts b/lib/core/winston.ts
@@ -7,12 +7,11 @@
  */
 
 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) {
+  const { winstonTransports: transports } = global.tswConfig;
+  if (Array.isArray(transports) && transports.length) {
     logger.winstonLogger = winston.createLogger({
       format: winston.format.simple(),
       transports

diff --git a/typings/type.d.ts b/typings/type.d.ts
@@ -26,7 +26,7 @@ declare namespace NodeJS {
   interface Global {
     tswConfig: {
       plugins: any[];
-      winstonTransports: any[];
+      winstonTransports?: any[];
       cleanLog?: boolean;
       logLevel?: "DEBUG" | "INFO" | "WARN" | "ERROR";
     };