@midwayjs/web 3.12.10 → 3.13.1

package/dist/config/config.default.js

@@ -4,11 +4,12 @@ const path = require("path");
 const mkdirp = require("mkdirp");
 const os = require("os");
 const fs = require("fs");
+const loggerModule = require("@midwayjs/logger");
 exports.default = appInfo => {
     const exports = {};
     exports.rundir = path.join(appInfo.appDir, 'run');
-    // 修改默认的日志名
-    exports.midwayLogger = {
+    // v2 格式
+    let defaultLoggerConfig = {
         clients: {
             appLogger: {
                 fileLogName: 'midway-web.log',
@@ -19,6 +20,30 @@ exports.default = appInfo => {
             },
         },
     };
+    // v3 格式
+    if (loggerModule['formatLegacyLoggerOptions']) {
+        defaultLoggerConfig = {
+            clients: {
+                appLogger: {
+                    transports: {
+                        file: {
+                            fileLogName: 'midway-web.log',
+                        },
+                    },
+                    aliasName: 'logger',
+                },
+                agentLogger: {
+                    transports: {
+                        file: {
+                            fileLogName: 'midway-agent.log',
+                        },
+                    },
+                },
+            },
+        };
+    }
+    // 修改默认的日志名
+    exports.midwayLogger = defaultLoggerConfig;
     exports.egg = {
         dumpConfig: true,
         contextLoggerFormat: info => {

package/dist/interface.d.ts

@@ -5,11 +5,13 @@ import { DefaultState, Middleware } from 'koa';
 import { ILogger, LoggerOptions } from '@midwayjs/logger';
 export declare const RUN_IN_AGENT_KEY = "egg:run_in_agent";
 export declare const EGG_AGENT_APP_KEY = "egg_agent_app";
+export interface State extends DefaultState {
+}
 export interface IMidwayWebBaseApplication {
     applicationContext: IMidwayContainer;
     getLogger(name?: string): ILogger;
     getCoreLogger(): ILogger;
-    generateMiddleware?(middlewareId: any): Promise<Middleware<DefaultState, EggContext>>;
+    generateMiddleware?(middlewareId: any): Promise<Middleware<State, EggContext>>;
     createLogger(name: string, options: LoggerOptions): ILogger;
 }
 /**
@@ -56,6 +58,7 @@ export interface Context<ResponseBodyT = unknown> extends IMidwayWebContext<Resp
          */
         [_: string]: any;
     };
+    state: State;
 }
 /**
  * @deprecated since version 3.0.0
@@ -112,7 +115,7 @@ export interface IMidwayWebConfigurationOptions extends IConfigurationOptions {
  * @deprecated since version 3.0.0
  * Please use IMiddleware from '@midwayjs/core'
  */
-export type MidwayWebMiddleware = Middleware<DefaultState, Context>;
+export type MidwayWebMiddleware = Middleware<State, Context>;
 /**
  * @deprecated since version 3.0.0
  * Please use IMiddleware from '@midwayjs/core'

package/dist/logger.js

@@ -3,16 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createLoggers = void 0;
 const logger_1 = require("@midwayjs/logger");
 const path_1 = require("path");
-const fs_1 = require("fs");
-const utils_1 = require("./utils");
-const os = require("os");
 const core_1 = require("@midwayjs/core");
 const util_1 = require("util");
+const core_2 = require("@midwayjs/core");
+const loggerModule = require("@midwayjs/logger");
+const isV3Logger = loggerModule['formatLegacyLoggerOptions'];
 const debug = (0, util_1.debuglog)('midway:debug');
-const isWindows = os.platform() === 'win32';
-function isEmptyFile(p) {
-    return (0, fs_1.statSync)(p).size === 0;
-}
 const levelTransform = level => {
     // egg 自定义日志，不设置 level，默认是 info
     if (!level) {
@@ -42,27 +38,6 @@ const levelTransform = level => {
             return 'silly';
     }
 };
-function checkEggLoggerExistsAndBackup(dir, fileName) {
-    const file = (0, path_1.isAbsolute)(fileName) ? fileName : (0, path_1.join)(dir, fileName);
-    try {
-        if ((0, fs_1.existsSync)(file) && !(0, fs_1.lstatSync)(file).isSymbolicLink()) {
-            // 如果是空文件，则直接删了，否则加入备份队列
-            if (isEmptyFile(file)) {
-                // midway 的软链在 windows 底下也不会创建出来，在 windows 底下就不做文件删除了
-                if (!isWindows) {
-                    (0, fs_1.unlinkSync)(file);
-                }
-            }
-            else {
-                const timeFormat = (0, utils_1.getCurrentDateString)();
-                (0, fs_1.renameSync)(file, file + '.' + timeFormat + '_eggjs_bak');
-            }
-        }
-    }
-    catch (err) {
-        // ignore
-    }
-}
 function cleanUndefinedProperty(obj) {
     Object.keys(obj).forEach(key => {
         if (obj[key] === undefined) {
@@ -109,10 +84,17 @@ class MidwayLoggers extends Map {
                 configService.addObject(eggLoggerConfig);
             }
         }
-        const loggerConfig = configService.getConfiguration('midwayLogger');
+        let loggerConfig = configService.getConfiguration('midwayLogger');
+        // 这里属于 hack 了，cluster 模式下会先走这里，找不到默认值
+        if (!loggerConfig['default']['dir']) {
+            // 先合并一遍默认配置
+            configService.addObject(logger_1.loggers.getDefaultMidwayLoggerConfig(configService.getAppInfo()));
+            loggerConfig = configService.getConfiguration('midwayLogger');
+        }
+        // 这里利用了 loggers 缓存的特性，提前初始化 logger
         if (loggerConfig) {
             for (const id of Object.keys(loggerConfig.clients)) {
-                const config = Object.assign({}, loggerConfig['default'], loggerConfig.clients[id]);
+                const config = (0, core_2.extend)(true, {}, loggerConfig['default'], loggerConfig.clients[id]);
                 this.createLogger(config, id);
             }
         }
@@ -121,17 +103,18 @@ class MidwayLoggers extends Map {
             this.set('logger', logger_1.loggers.getLogger('appLogger'));
         }
         // 初始化日志服务
-        this.loggerService = (0, core_1.getCurrentApplicationContext)().get(core_1.MidwayLoggerService, [(0, core_1.getCurrentApplicationContext)()]);
+        this.loggerService = (0, core_1.getCurrentApplicationContext)().get(core_1.MidwayLoggerService, [
+            (0, core_1.getCurrentApplicationContext)(),
+            {
+                loggerFactory: logger_1.loggers,
+            },
+        ]);
         // 防止循环枚举报错
         Object.defineProperty(this, 'loggerService', {
             enumerable: false,
         });
     }
     createLogger(options, loggerKey) {
-        /**
-         * 提前备份 egg 日志
-         */
-        checkEggLoggerExistsAndBackup(options.dir, options.fileLogName);
         let logger = logger_1.loggers.createLogger(loggerKey, options);
         // overwrite values for pandora collect
         logger.values = () => {
@@ -152,13 +135,20 @@ class MidwayLoggers extends Map {
         return logger;
     }
     disableConsole() {
+        var _a;
         for (const value of this.values()) {
-            if (value === null || value === void 0 ? void 0 : value.disableConsole) {
-                value === null || value === void 0 ? void 0 : value.disableConsole();
+            if (value === null || value === void 0 ? void 0 : value['disableConsole']) {
+                value.disableConsole();
             }
             else if (value.disable) {
                 value.disable('console');
             }
+            else if (isV3Logger) {
+                // v3
+                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                // @ts-ignore
+                (_a = value.get('console')) === null || _a === void 0 ? void 0 : _a.level = 'none';
+            }
         }
     }
     reload() {
@@ -170,7 +160,7 @@ class MidwayLoggers extends Map {
         }
     }
     transformEggLogger(eggCustomLogger, midwayLoggerConfig) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
         const transformLoggerConfig = {
             midwayLogger: {
                 clients: {},
@@ -186,22 +176,42 @@ class MidwayLoggers extends Map {
                 // 绝对路径，单独处理
                 options.dir = (0, path_1.dirname)(file);
                 options.fileLogName = (0, path_1.basename)(file);
-                options.auditFileDir =
-                    midwayLoggerConfig.auditFileDir === '.audit'
-                        ? (0, path_1.join)(midwayLoggerConfig.dir, '.audit')
-                        : midwayLoggerConfig.auditFileDir;
-                options.errorDir =
-                    (_b = midwayLoggerConfig.errorDir) !== null && _b !== void 0 ? _b : midwayLoggerConfig.dir;
+                if (isV3Logger) {
+                    options.auditFileDir =
+                        ((_c = (_b = midwayLoggerConfig === null || midwayLoggerConfig === void 0 ? void 0 : midwayLoggerConfig.transports) === null || _b === void 0 ? void 0 : _b.file) === null || _c === void 0 ? void 0 : _c['auditFileDir']) === '.audit'
+                            ? (0, path_1.join)((_e = (_d = midwayLoggerConfig === null || midwayLoggerConfig === void 0 ? void 0 : midwayLoggerConfig.transports) === null || _d === void 0 ? void 0 : _d.file) === null || _e === void 0 ? void 0 : _e['dir'], '.audit')
+                            : (_g = (_f = midwayLoggerConfig === null || midwayLoggerConfig === void 0 ? void 0 : midwayLoggerConfig.transports) === null || _f === void 0 ? void 0 : _f.file) === null || _g === void 0 ? void 0 : _g['auditFileDir'];
+                    options.errorDir =
+                        (_k = (_j = (_h = midwayLoggerConfig === null || midwayLoggerConfig === void 0 ? void 0 : midwayLoggerConfig.transports) === null || _h === void 0 ? void 0 : _h.error) === null || _j === void 0 ? void 0 : _j['dir']) !== null && _k !== void 0 ? _k : (_m = (_l = midwayLoggerConfig === null || midwayLoggerConfig === void 0 ? void 0 : midwayLoggerConfig.transports) === null || _l === void 0 ? void 0 : _l.file) === null || _m === void 0 ? void 0 : _m['dir'];
+                }
+                else {
+                    options.auditFileDir =
+                        midwayLoggerConfig['auditFileDir'] === '.audit'
+                            ? (0, path_1.join)(midwayLoggerConfig['dir'], '.audit')
+                            : midwayLoggerConfig['auditFileDir'];
+                    options.errorDir =
+                        (_o = midwayLoggerConfig['errorDir']) !== null && _o !== void 0 ? _o : midwayLoggerConfig['dir'];
+                }
             }
             else {
                 // 相对路径，使用默认的 dir 即可
                 options.fileLogName = file;
             }
-            transformLoggerConfig.midwayLogger.clients[name] = {
-                level: levelTransform((_c = eggCustomLogger[name]) === null || _c === void 0 ? void 0 : _c.level),
-                consoleLevel: levelTransform((_d = eggCustomLogger[name]) === null || _d === void 0 ? void 0 : _d.consoleLevel),
-                ...options,
-            };
+            // v3 logger，格式化一下 options
+            if (isV3Logger) {
+                transformLoggerConfig.midwayLogger.clients[name] = loggerModule['formatLegacyLoggerOptions']({
+                    level: levelTransform((_p = eggCustomLogger[name]) === null || _p === void 0 ? void 0 : _p.level),
+                    consoleLevel: levelTransform((_q = eggCustomLogger[name]) === null || _q === void 0 ? void 0 : _q.consoleLevel),
+                    ...options,
+                });
+            }
+            else {
+                transformLoggerConfig.midwayLogger.clients[name] = {
+                    level: levelTransform((_r = eggCustomLogger[name]) === null || _r === void 0 ? void 0 : _r.level),
+                    consoleLevel: levelTransform((_s = eggCustomLogger[name]) === null || _s === void 0 ? void 0 : _s.consoleLevel),
+                    ...options,
+                };
+            }
             cleanUndefinedProperty(transformLoggerConfig.midwayLogger.clients[name]);
         }
         return transformLoggerConfig;

package/index.d.ts

@@ -6,6 +6,7 @@ import {
   IMidwayWebBaseApplication,
   IMidwayWebConfigurationOptions,
   Context as EggContext,
+  State,
 } from './dist';
 import { ILogger, LoggerOptions } from '@midwayjs/logger';
 import { EggAppConfig } from 'egg';
@@ -30,6 +31,7 @@ declare module 'egg' {
   interface Context<ResponseBodyT = any> extends IMidwayBaseContext {
     getLogger(name?: string): ILogger;
     forward: (url: string) => void;
+    state: State;
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/web",
-  "version": "3.12.10",
+  "version": "3.13.1",
   "description": "Midway Web Framework for Egg.js",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -28,8 +28,8 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/logger": "^2.15.0",
-    "@midwayjs/mock": "^3.12.10",
+    "@midwayjs/logger": "^3.0.0",
+    "@midwayjs/mock": "^3.13.0",
     "dayjs": "1.11.10",
     "egg-logger": "2.9.1",
     "egg-mock": "4.2.1",
@@ -45,7 +45,7 @@
   },
   "dependencies": {
     "@eggjs/router": "^2.0.0",
-    "@midwayjs/core": "^3.12.3",
+    "@midwayjs/core": "^3.13.0",
     "egg": "^2.28.0",
     "egg-cluster": "^1.27.1",
     "find-up": "5.0.0",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=12"
   },
-  "gitHead": "8d92c54424843d437fd5f77f6ff93f00c055117b"
+  "gitHead": "bc7378899b34cc2846a7429777d052b0ed7cdb24"
 }