feat: add zlib logger file (#1038)

packages/decorator/package.json

@@ -28,8 +28,7 @@
   ],
   "files": [
     "dist/**/*.js",
-    "dist/**/*.d.ts",
-    "version.json"
+    "dist/**/*.d.ts"
   ],
   "engines": {
     "node": ">= 10.0.0"

packages/grpc/tsconfig.json

@@ -3,8 +3,7 @@
   "compileOnSave": true,
   "compilerOptions": {
     "rootDir": "src",
-    "outDir": "dist",
-    "jsx": "react"
+    "outDir": "dist"
   },
   "include": [
     "./src/**/*.ts"

packages/logger/src/interface.ts

@@ -38,7 +38,7 @@ export interface IMidwayLogger extends ILogger {
   close(): any;
 }
 
-export type LoggerLevel = 'silly' | 'debug' | 'info' | 'warn' | 'error';
+export type LoggerLevel = 'all' | 'silly' | 'debug' | 'info' | 'warn' | 'error' | 'none';
 
 export interface LoggerOptions {
   format?: logform.Format;
@@ -62,6 +62,8 @@ export interface LoggerOptions {
   errMaxSize?: string;
   errMaxFiles?: string;
   eol?: string;
+  fileZippedArchive?: boolean;
+  errZippedArchive?: boolean;
 }
 
 export interface DelegateLoggerOptions {

packages/logger/src/logger.ts

@@ -18,13 +18,14 @@ const isWindows = os.platform() === 'win32';
 export const EmptyLogger: Logger = createLogger().constructor as Logger;
 
 const midwayLogLevels = {
-  all: 0,
+  none: 0,
   error: 1,
   warn: 2,
   info: 3,
   verbose: 4,
   debug: 5,
   silly: 6,
+  all: 7,
 };
 
 /**
@@ -81,13 +82,14 @@ export class MidwayBaseLogger extends EmptyLogger implements IMidwayLogger {
         format.colorize({
           all: true,
           colors: {
-            all: 'reset',
+            none: 'reset',
             error: 'red',
             warn: 'yellow',
             info: 'reset',
             verbose: 'reset',
             debug: 'blue',
             silly: 'reset',
+            all: 'reset',
           },
         })
       ),
@@ -144,6 +146,7 @@ export class MidwayBaseLogger extends EmptyLogger implements IMidwayLogger {
         maxSize: this.loggerOptions.fileMaxSize || '200m',
         maxFiles: this.loggerOptions.fileMaxFiles || '31d',
         eol: this.loggerOptions.eol || os.EOL,
+        zippedArchive: this.loggerOptions.fileZippedArchive,
       });
     }
     this.add(this.fileTransport);
@@ -165,6 +168,7 @@ export class MidwayBaseLogger extends EmptyLogger implements IMidwayLogger {
         maxSize: this.loggerOptions.errMaxSize || '200m',
         maxFiles: this.loggerOptions.errMaxFiles || '31d',
         eol: this.loggerOptions.eol || os.EOL,
+        zippedArchive: this.loggerOptions.errZippedArchive,
       });
     }
     this.add(this.errTransport);
@@ -259,7 +263,8 @@ export class MidwayBaseLogger extends EmptyLogger implements IMidwayLogger {
       (args.length === 1 && typeof args[0] !== 'object') ||
       !args[0]['level']
     ) {
-      return super.log.apply(this, ['all', ...args, { ignoreFormat: true }]);
+      // 这里必须要用 none
+      return super.log.apply(this, ['none', ...args, { ignoreFormat: true }]);
     } else {
       return super.write.apply(this, args);
     }

packages/logger/src/rotate.ts

@@ -1,6 +1,9 @@
+// fork from https://github.com/winstonjs/winston-daily-rotate-file v4.5.5
+
 import * as fs from 'fs';
 import * as os from 'os';
 import * as path from 'path';
+import * as zlib from 'zlib';
 import * as hash from 'object-hash';
 import { MESSAGE } from 'triple-beam';
 import { PassThrough } from 'stream';
@@ -131,6 +134,29 @@ export class DailyRotateFileTransport extends Transport {
         }
         this.emit('logRemoved', params.name);
       });
+
+      if (options.zippedArchive) {
+        this.logStream.on('rotate', oldFile => {
+          const oldFileExist = fs.existsSync(oldFile);
+          const gzExist = fs.existsSync(oldFile + '.gz');
+          if (!oldFileExist || gzExist) {
+            return;
+          }
+
+          const gzip = zlib.createGzip();
+          const inp = fs.createReadStream(oldFile);
+          const out = fs.createWriteStream(oldFile + '.gz');
+          inp
+            .pipe(gzip)
+            .pipe(out)
+            .on('finish', () => {
+              if (fs.existsSync(oldFile)) {
+                fs.unlinkSync(oldFile);
+              }
+              this.emit('archive', oldFile + '.gz');
+            });
+        });
+      }
     }
   }
 

packages/logger/test/index.test.ts

@@ -542,6 +542,7 @@ describe('/test/index.test.ts', () => {
     const logger = createLogger<IMidwayLogger>('logger', {
       dir: logsDir,
       disableError: true,
+      level: 'error',
     });
     logger.write('hello world');
     const buffer = Buffer.from('hello world', 'utf-8');
@@ -742,4 +743,45 @@ describe('/test/index.test.ts', () => {
     await removeFileOrDir(logsDir);
   });
 
+  it('should no output when level = none', async  ()  => {
+    clearAllLoggers();
+    const logsDir = join(__dirname, 'logs');
+    await removeFileOrDir(logsDir);
+
+    const logger = createFileLogger('file', {
+      dir: logsDir,
+      fileLogName: 'test-logger.log',
+      level: 'none',
+    });
+
+    logger.info('file logger');
+    logger.info('file logger1');
+    logger.info('file logger2');
+    await sleep();
+
+    expect(matchContentTimes(join(logsDir, 'test-logger.log'), 'file logger')).toEqual(0);
+    await removeFileOrDir(logsDir);
+  });
+
+  it('should output all level when level = all', async  ()  => {
+    clearAllLoggers();
+    const logsDir = join(__dirname, 'logs');
+    await removeFileOrDir(logsDir);
+
+    const logger = createFileLogger('file', {
+      dir: logsDir,
+      fileLogName: 'test-logger.log',
+      level: 'all',
+    });
+
+    logger.info('file logger');
+    logger.info('file logger1');
+    logger.info('file logger2');
+    await sleep();
+
+    expect(matchContentTimes(join(logsDir, 'test-logger.log'), 'file logger')).toEqual(3);
+    await removeFileOrDir(logsDir);
+  });
+
+
 });

packages/logger/test/rotate.test.ts

@@ -174,5 +174,27 @@ describe('winston/transports/daily-rotate-file', function () {
       sendLogItem(transport, 'info', randomString(1056));
       transport.close();
     });
+
+    describe('when setting zippedArchive', function () {
+      it('should archive the log after rotating', function (done) {
+        const opts: any = Object.assign({}, options);
+        opts.zippedArchive = true;
+        opts.maxSize = '1k';
+
+        transport = new DailyRotateFile(opts);
+
+        transport.on('finish', function () {
+          fs.readdir(logDir, function (err, files) {
+            expect(files.filter(function (file) {
+              return path.extname(file) === '.gz';
+            }).length).toEqual(1);
+            done();
+          });
+        });
+        sendLogItem(transport, 'info', randomString(1056));
+        sendLogItem(transport, 'info', randomString(1056));
+        transport.close();
+      });
+    });
   });
 });

packages/prometheus/tsconfig.json

@@ -1,23 +1,11 @@
 {
+  "extends": "../../tsconfig.json",
   "compileOnSave": true,
   "compilerOptions": {
-    "target": "ES2018",
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "inlineSourceMap":false,
-    "noImplicitThis": true,
-    "noUnusedLocals": true,
-    "stripInternal": true,
-    "noImplicitReturns": false,
-    "pretty": true,
-    "declaration": true,
+    "rootDir": "src",
     "outDir": "dist"
   },
-  "exclude": [
-    "dist",
-    "node_modules",
-    "test"
+  "include": [
+    "./src/**/*.ts"
   ]
 }

packages/web-express/tsconfig.json

@@ -3,8 +3,7 @@
   "compileOnSave": true,
   "compilerOptions": {
     "rootDir": "src",
-    "outDir": "dist",
-    "jsx": "react"
+    "outDir": "dist"
   },
   "include": [
     "./src/**/*.ts"

packages/web-koa/tsconfig.json

@@ -3,8 +3,7 @@
   "compileOnSave": true,
   "compilerOptions": {
     "rootDir": "src",
-    "outDir": "dist",
-    "jsx": "react"
+    "outDir": "dist"
   },
   "include": [
     "./src/**/*.ts"