egg 3.5.1 → 3.7.0

package/History.md

@@ -1,13 +1,41 @@
+# History
 
-3.5.1 / 2022-11-28
-==================
+## 2022-12-11, Version 3.7.0 @fengmk2
 
-**fixes**
-  * [[`c859506a0`](http://github.com/eggjs/egg/commit/c859506a094181f5f45db16a8501daaaea56b3d3)] - fix: dump config/timing when timeout (#5069) (killa <<killa123@126.com>>)
+### Notable Changes
 
-**others**
-  * [[`ee2f0614a`](http://github.com/eggjs/egg/commit/ee2f0614af85e4293240b768c09b2c4e3da0ec1d)] - chore: Change version to 3.5.0 (fengmk2 <<fengmk2@gmail.com>>),
-# History
+* **features**
+  * 📦 NEW: Set `config.logger.enableFastContextLogger = true` to enable faster context logger
+
+### Commits
+
+  * [[`e94c7df63`](http://github.com/eggjs/egg/commit/e94c7df63e1812da672dbaf7200e652cc4537c7b)] - 📦 NEW: Upgrade egg-logger v3 to enable localStorage (#5085) (fengmk2 <<fengmk2@gmail.com>>)
+  * [[`c76e16cf7`](http://github.com/eggjs/egg/commit/c76e16cf7fb67d5f2c1b19252e01a5e3fed9cf96)] - 📖 DOC: Use @eggjs/tsconfig for tsconfig.json (#5066) (fengmk2 <<fengmk2@gmail.com>>)
+
+## 2022-12-09, Version 3.6.0 @fengmk2
+
+### Notable Changes
+
+* **features**
+  * 🚀🚀🚀 Support `app.ctxStorage` and `app.currentContext` to get current execute ctx, see [koa#1455](https://github.com/koajs/koa/pull/1455)
+
+### Commits
+
+  * [[`bf36904e0`](http://github.com/eggjs/egg/commit/bf36904e0fb1d4477ebb7068dd8ad6726d29182f)] - 📦 NEW: Add ctxStorage and currentContext d.ts (#5079) (fengmk2 <<fengmk2@gmail.com>>)
+  * [[`c68992ab7`](http://github.com/eggjs/egg/commit/c68992ab71b854f825df0ff3ea4b82e7666ec828)] - chore: ignore gp-pages branch while deploying preview (#5077) (Suyi <<thonatos.yang@gmail.com>>)
+  * [[`13906825b`](http://github.com/eggjs/egg/commit/13906825bc3fab260aa0dd8888ce9fd19f2f70c5)] - chore: use actions to deploy vercel project (#5076) (Suyi <<thonatos.yang@gmail.com>>)
+  * [[`5d825bb59`](http://github.com/eggjs/egg/commit/5d825bb59ed691bd45c3a8b2f6c222496910e250)] - docs: update communite links (#5073) (Suyi <<thonatos.yang@gmail.com>>)
+
+## 2022-11-28, Version 3.5.1 @killagu
+
+### Notable Changes
+
+* **fixes**
+  * Dump `config/timing` when app start timeout
+
+### Commits
+
+  * [[`c859506a0`](http://github.com/eggjs/egg/commit/c859506a094181f5f45db16a8501daaaea56b3d3)] - fix: dump config/timing when timeout (#5069) (killa <<killa123@126.com>>)
 
 ## 2022-11-15, Version 3.5.0 @fengmk2
 

package/app/extend/context.js

@@ -95,6 +95,9 @@ const proto = module.exports = {
    * @return {Logger} logger
    */
   getLogger(name) {
+    if (this.app.config.logger.enableFastContextLogger) {
+      return this.app.getLogger(name);
+    }
     let cache = this[CONTEXT_LOGGERS];
     if (!cache) {
       cache = this[CONTEXT_LOGGERS] = {};

package/config/config.default.js

@@ -258,6 +258,7 @@ module.exports = appInfo => {
    * @property {Object} coreLogger - custom config of coreLogger
    * @property {Boolean} allowDebugAtProd - allow debug log at prod, defaults to false
    * @property {Boolean} enablePerformanceTimer - using performance.now() timer instead of Date.now() for more more precise milliseconds, defaults to false. e.g.: logger will set 1.456ms instead of 1ms.
+   * @property {Boolean} enableFastContextLogger - using the app logger instead of EggContextLogger, defaults to false
    */
   config.logger = {
     dir: path.join(appInfo.root, 'logs', appInfo.name),
@@ -275,6 +276,7 @@ module.exports = appInfo => {
     coreLogger: {},
     allowDebugAtProd: false,
     enablePerformanceTimer: false,
+    enableFastContextLogger: false,
   };
 
   /**

package/index.d.ts

@@ -2,11 +2,19 @@
 import accepts = require('accepts');
 import KoaApplication = require('koa');
 import KoaRouter = require('koa-router');
+import { AsyncLocalStorage } from 'async_hooks';
 import { EventEmitter } from 'events'
 import { Readable } from 'stream';
 import { Socket } from 'net';
 import { IncomingMessage, ServerResponse } from 'http';
-import { EggLogger as Logger, EggLoggers, LoggerLevel as EggLoggerLevel, EggLoggersOptions, EggLoggerOptions, EggContextLogger } from 'egg-logger';
+import {
+  EggLogger as Logger,
+  EggLoggers,
+  LoggerLevel as EggLoggerLevel,
+  EggLoggersOptions,
+  EggLoggerOptions,
+  EggContextLogger
+} from 'egg-logger';
 import { HttpClient, RequestOptions2 as RequestOptions } from 'urllib';
 import {
   EggCoreBase,
@@ -223,6 +231,8 @@ declare module 'egg' {
     disableConsoleAfterReady?: boolean;
     /** using performance.now() timer instead of Date.now() for more more precise milliseconds, defaults to `false`. e.g.: logger will set 1.456ms instead of 1ms. */
     enablePerformanceTimer?: boolean;
+    /** using the app logger instead of EggContextLogger, defaults to `false` */
+    enableFastContextLogger?: boolean;
   }
 
   /** Custom Loader Configuration */
@@ -335,6 +345,7 @@ declare module 'egg' {
      * @property {Object} coreLogger - custom config of coreLogger
      * @property {Boolean} allowDebugAtProd - allow debug log at prod, defaults to false
      * @property {Boolean} enablePerformanceTimer - using performance.now() timer instead of Date.now() for more more precise milliseconds, defaults to false. e.g.: logger will set 1.456ms instead of 1ms.
+     * @property {Boolean} enableFastContextLogger - using the app logger instead of EggContextLogger, defaults to false
      */
     logger: EggLoggerConfig;
 
@@ -683,6 +694,18 @@ declare module 'egg' {
      * @param {Function} scope - the first args is an anonymous ctx
      */
     runInBackground(scope: (ctx: Context) => void): void;
+
+    /**
+     * Get current execute ctx async local storage
+     * @returns {AsyncLocalStorage} localStorage - store current execute Context
+     */
+    get ctxStorage(): AsyncLocalStorage<Context>;
+
+    /**
+     * Get current execute ctx, maybe undefined
+     * @returns {Context} ctx - current execute Context
+     */
+    get currentConext(): Context;
   }
 
   export interface IApplicationLocals extends PlainObject { }

package/lib/core/logger.js

@@ -5,6 +5,7 @@ const Loggers = require('egg-logger').EggLoggers;
 module.exports = function createLoggers(app) {
   const loggerConfig = app.config.logger;
   loggerConfig.type = app.type;
+  loggerConfig.localStorage = app.ctxStorage;
 
   if (app.config.env === 'prod' && loggerConfig.level === 'DEBUG' && !loggerConfig.allowDebugAtProd) {
     loggerConfig.level = 'INFO';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "egg",
-  "version": "3.5.1",
+  "version": "3.7.0",
   "publishConfig": {
     "tag": "next"
   },
@@ -28,12 +28,12 @@
     "delegates": "^1.0.0",
     "egg-cluster": "^2.0.0",
     "egg-cookies": "^2.6.1",
-    "egg-core": "^4.26.1",
+    "egg-core": "^4.29.0",
     "egg-development": "^2.7.0",
     "egg-errors": "^2.3.1",
     "egg-i18n": "^2.1.1",
     "egg-jsonp": "^2.0.0",
-    "egg-logger": "^2.9.0",
+    "egg-logger": "^3.0.1",
     "egg-logrotator": "^3.1.0",
     "egg-multipart": "^3.1.0",
     "egg-onerror": "^2.1.1",