egg 4.0.0-beta.5 → 4.0.0-beta.7

package/dist/esm/lib/type.d.ts

@@ -1,15 +1,13 @@
 import type { Socket } from 'node:net';
-import type { EggCoreContext } from '@eggjs/core';
 import type { RequestOptions as HttpClientRequestOptions } from 'urllib';
 import type { EggLoggerOptions, EggLoggersOptions } from 'egg-logger';
 import type { FileLoaderOptions } from '@eggjs/core';
-import type { EggApplicationCore } from './egg.js';
+import type { EggApplicationCore, ContextDelegation } from './egg.js';
 import type { MetaMiddlewareOptions } from '../app/middleware/meta.js';
 import type { NotFoundMiddlewareOptions } from '../app/middleware/notfound.js';
 import type { SiteFileMiddlewareOptions } from '../app/middleware/site_file.js';
-type IgnoreItem = string | RegExp | ((ctx: EggCoreContext) => boolean);
+type IgnoreItem = string | RegExp | ((ctx: ContextDelegation) => boolean);
 type IgnoreOrMatch = IgnoreItem | IgnoreItem[];
-export type Next = () => Promise<void>;
 export interface ClientErrorResponse {
     body: string | Buffer;
     status: number;
@@ -89,7 +87,7 @@ export interface EggAppConfig {
         };
         /** Default is `'error'`, it will return `400` response when `Prototype-Poisoning` happen. */
         onProtoPoisoning: 'error' | 'remove' | 'ignore';
-        onerror(err: any, ctx: EggCoreContext): void;
+        onerror(err: any, ctx: ContextDelegation): void;
     };
     /**
      * logger options
@@ -292,5 +290,4 @@ export interface EggAppConfig {
     };
     [prop: string]: any;
 }
-export type { EggLogger, } from 'egg-logger';
-export type { ILifecycleBoot, } from '@eggjs/core';
+export {};

package/dist/esm/lib/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function getSourceDirname(): string;
+export declare function getSourceFile(filename: string): string;

package/dist/esm/lib/utils.js

@@ -0,0 +1,14 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+export function getSourceDirname() {
+    if (typeof __dirname !== 'undefined') {
+        return path.dirname(__dirname);
+    }
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    return path.dirname(path.dirname(fileURLToPath(import.meta.url)));
+}
+export function getSourceFile(filename) {
+    return path.join(getSourceDirname(), filename);
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sSUFBSSxNQUFNLFdBQVcsQ0FBQztBQUM3QixPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sVUFBVSxDQUFDO0FBRXpDLE1BQU0sVUFBVSxnQkFBZ0I7SUFDOUIsSUFBSSxPQUFPLFNBQVMsS0FBSyxXQUFXLEVBQUUsQ0FBQztRQUNyQyxPQUFPLElBQUksQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLENBQUM7SUFDakMsQ0FBQztJQUNELDZEQUE2RDtJQUM3RCxhQUFhO0lBQ2IsT0FBTyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsYUFBYSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDO0FBQ3BFLENBQUM7QUFFRCxNQUFNLFVBQVUsYUFBYSxDQUFDLFFBQWdCO0lBQzVDLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxnQkFBZ0IsRUFBRSxFQUFFLFFBQVEsQ0FBQyxDQUFDO0FBQ2pELENBQUMifQ==

package/dist/package.json

@@ -1,4 +1,4 @@
 {
   "name": "egg",
-  "version": "4.0.0-beta.5"
+  "version": "4.0.0-beta.7"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "egg",
-  "version": "4.0.0-beta.5",
+  "version": "4.0.0-beta.7",
   "engines": {
     "node": ">= 18.19.0"
   },
@@ -21,13 +21,10 @@
   "dependencies": {
     "@eggjs/cluster": "beta",
     "@eggjs/cookies": "^3.0.0",
-    "@eggjs/core": "^6.1.0",
-    "@eggjs/schedule": "^5.0.1",
+    "@eggjs/core": "^6.2.3",
+    "@eggjs/schedule": "^5.0.2",
     "@eggjs/utils": "^4.0.2",
-    "@eggjs/watcher": "^4.0.0",
-    "@types/accepts": "^1.3.5",
-    "accepts": "^1.3.8",
-    "cache-content-type": "^2.0.0",
+    "@eggjs/watcher": "^4.0.1",
     "circular-json-for-egg": "^1.0.0",
     "cluster-client": "^3.7.0",
     "delegates": "^1.0.0",
@@ -44,13 +41,13 @@
     "egg-static": "^2.2.0",
     "egg-view": "^2.1.3",
     "extend2": "^4.0.0",
-    "graceful": "^1.1.0",
+    "graceful": "^2.0.0",
+    "humanize-ms": "^2.0.0",
     "is-type-of": "^2.1.0",
     "koa-bodyparser": "^4.4.1",
-    "koa-is-json": "^1.0.0",
     "koa-override": "^4.0.0",
-    "ms": "^2.1.3",
     "onelogger": "^1.0.0",
+    "performance-ms": "^1.1.0",
     "sendmessage": "^3.0.1",
     "urllib": "^4.0.0",
     "utility": "^2.1.0",
@@ -71,7 +68,7 @@
     "coffee": "5",
     "cross-env": "7",
     "egg-bin": "beta",
-    "egg-mock": "beta",
+    "@eggjs/mock": "beta",
     "egg-plugin-puml": "^2.4.0",
     "egg-tracer": "^2.1.0",
     "egg-view-nunjucks": "^2.3.0",
@@ -79,6 +76,7 @@
     "eslint-config-egg": "14",
     "formstream": "^1.5.1",
     "koa-static": "^5.0.0",
+    "mm": "^3.4.0",
     "pedding": "^1.1.0",
     "prettier": "^2.7.1",
     "runscript": "^2.0.1",
@@ -93,6 +91,7 @@
     "lint": "eslint src test --ext .ts",
     "pretest": "npm run lint -- --fix && npm run prepublishOnly",
     "test": "egg-bin test",
+    "test-local": "egg-bin test",
     "test:changed": "egg-bin test --changed",
     "preci": "npm run lint && npm run prepublishOnly && attw --pack",
     "ci": "egg-bin cov",
@@ -110,11 +109,15 @@
     "url": "git://github.com/eggjs/egg.git"
   },
   "license": "MIT",
+  "tnpm": {
+    "mode": "npm"
+  },
   "egg": {
     "framework": true,
-    "baseDir": {
+    "exports": {
       "import": "./dist/esm",
-      "require": "./dist/commonjs"
+      "require": "./dist/commonjs",
+      "typescript": "./src"
     }
   },
   "files": [

package/src/app/extend/context.ts

@@ -1,38 +1,81 @@
-import { performance } from 'node:perf_hooks';
 import delegate from 'delegates';
 import { assign } from 'utility';
-import { utils } from '@eggjs/core';
+import { now, diff } from 'performance-ms';
+import {
+  utils, Context as EggCoreContext, Router,
+  type ContextDelegation as EggCoreContextDelegation,
+} from '@eggjs/core';
+import type { Cookies as ContextCookies } from '@eggjs/cookies';
+import { EggLogger } from 'egg-logger';
+import type { Application } from '../../lib/application.js';
+import type {
+  HttpClientRequestURL, HttpClientRequestOptions, HttpClient,
+} from '../../lib/core/httpclient.js';
+import type { ContextHttpClient } from '../../lib/core/context_httpclient.js';
+import type { BaseContextClass } from '../../lib//core/base_context_class.js';
+import Request from './request.js';
+import Response from './response.js';
+import type Helper from './helper.js';
 
-const HELPER = Symbol('Context#helper');
-const LOCALS = Symbol('Context#locals');
-const LOCALS_LIST = Symbol('Context#localsList');
-const COOKIES = Symbol('Context#cookies');
-const CONTEXT_LOGGERS = Symbol('Context#logger');
-const CONTEXT_HTTPCLIENT = Symbol('Context#httpclient');
-const CONTEXT_ROUTER = Symbol('Context#router');
+import './context.types.js';
+
+const HELPER = Symbol('ctx helper');
+const LOCALS = Symbol('ctx locals');
+const LOCALS_LIST = Symbol('ctx localsList');
+const COOKIES = Symbol('ctx cookies');
+const CONTEXT_HTTPCLIENT = Symbol('ctx httpclient');
+const CONTEXT_ROUTER = Symbol('ctx router');
+
+interface Cookies extends ContextCookies {
+  request: any;
+  response: any;
+}
+
+export default class Context extends EggCoreContext {
+  declare app: Application;
+  declare request: Request;
+  declare service: BaseContextClass;
+
+  /**
+   * Request start time
+   * @member {Number} Context#starttime
+   */
+  starttime: number;
+  /**
+   * Request start timer using `performance.now()`
+   * @member {Number} Context#performanceStarttime
+   */
+  performanceStarttime: number;
 
-const Context = {
   /**
    * Get the current visitor's cookies.
    */
   get cookies() {
-    if (!this[COOKIES]) {
-      this[COOKIES] = new this.app.ContextCookies(this, this.app.keys, this.app.config.cookies);
+    let cookies = this[COOKIES];
+    if (!cookies) {
+      this[COOKIES] = cookies = new this.app.ContextCookies(this, this.app.keys, this.app.config.cookies);
     }
-    return this[COOKIES];
-  },
+    return cookies as Cookies;
+  }
 
   /**
    * Get a wrapper httpclient instance contain ctx in the hold request process
    *
    * @return {ContextHttpClient} the wrapper httpclient instance
    */
-  get httpclient() {
+  get httpclient(): ContextHttpClient {
     if (!this[CONTEXT_HTTPCLIENT]) {
-      this[CONTEXT_HTTPCLIENT] = new this.app.ContextHttpClient(this);
+      this[CONTEXT_HTTPCLIENT] = new this.app.ContextHttpClient(this as any);
     }
-    return this[CONTEXT_HTTPCLIENT];
-  },
+    return this[CONTEXT_HTTPCLIENT] as ContextHttpClient;
+  }
+
+  /**
+   * Alias to {@link Context#httpclient}
+   */
+  get httpClient(): ContextHttpClient {
+    return this.httpclient;
+  }
 
   /**
    * Shortcut for httpclient.curl
@@ -42,9 +85,9 @@ const Context = {
    * @param {Object} [options] - options for request.
    * @return {Object} see {@link ContextHttpClient#curl}
    */
-  curl(url: string, options?: object) {
-    return this.httpclient.curl(url, options);
-  },
+  async curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']> {
+    return await this.httpclient.curl(url, options);
+  }
 
   /**
    * Alias to {@link Application#router}
@@ -56,20 +99,20 @@ const Context = {
    * this.router.pathFor('post', { id: 12 });
    * ```
    */
-  get router() {
-    if (!this[CONTEXT_ROUTER]) {
-      this[CONTEXT_ROUTER] = this.app.router;
+  get router(): Router {
+    if (this[CONTEXT_ROUTER]) {
+      return this[CONTEXT_ROUTER] as Router;
     }
-    return this[CONTEXT_ROUTER];
-  },
+    return this.app.router;
+  }
 
   /**
    * Set router to Context, only use on EggRouter
-   * @param {EggRouter} val router instance
+   * @param {Router} val router instance
    */
-  set router(val) {
+  set router(val: Router) {
     this[CONTEXT_ROUTER] = val;
-  },
+  }
 
   /**
    * Get helper instance from {@link Application#Helper}
@@ -77,45 +120,27 @@ const Context = {
    * @member {Helper} Context#helper
    * @since 1.0.0
    */
-  get helper() {
+  get helper(): Helper {
     if (!this[HELPER]) {
-      this[HELPER] = new this.app.Helper(this);
+      this[HELPER] = new this.app.Helper(this as any);
     }
-    return this[HELPER];
-  },
+    return this[HELPER] as Helper;
+  }
 
   /**
    * Wrap app.loggers with context information,
    * if a custom logger is defined by naming aLogger, then you can `ctx.getLogger('aLogger')`
    *
    * @param {String} name - logger name
-   * @return {Logger} logger
    */
-  getLogger(name: string) {
-    if (this.app.config.logger.enableFastContextLogger) {
-      return this.app.getLogger(name);
-    }
-    let cache = this[CONTEXT_LOGGERS];
-    if (!cache) {
-      cache = this[CONTEXT_LOGGERS] = {};
-    }
-
-    // read from cache
-    if (cache[name]) return cache[name];
-
-    // get no exist logger
-    const appLogger = this.app.getLogger(name);
-    if (!appLogger) return null;
-
-    // write to cache
-    cache[name] = new this.app.ContextLogger(this, appLogger);
-    return cache[name];
-  },
+  getLogger(name: string): EggLogger {
+    return this.app.getLogger(name);
+  }
 
   /**
-   * Logger for Application, wrapping app.coreLogger with context infomation
+   * Logger for Application
    *
-   * @member {ContextLogger} Context#logger
+   * @member {Logger} Context#logger
    * @since 1.0.0
    * @example
    * ```js
@@ -123,20 +148,19 @@ const Context = {
    * this.logger.warn('WARNING!!!!');
    * ```
    */
-  get logger() {
+  get logger(): EggLogger {
     return this.getLogger('logger');
-  },
+  }
 
   /**
-   * Logger for frameworks and plugins,
-   * wrapping app.coreLogger with context infomation
+   * Logger for frameworks and plugins
    *
-   * @member {ContextLogger} Context#coreLogger
+   * @member {Logger} Context#coreLogger
    * @since 1.0.0
    */
-  get coreLogger() {
+  get coreLogger(): EggLogger {
     return this.getLogger('coreLogger');
-  },
+  }
 
   /**
    * locals is an object for view, you can use `app.locals` and `ctx.locals` to set variables,
@@ -169,19 +193,18 @@ const Context = {
     if (!this[LOCALS]) {
       this[LOCALS] = assign({}, this.app.locals);
     }
-    if (this[LOCALS_LIST] && this[LOCALS_LIST].length) {
+    if (Array.isArray(this[LOCALS_LIST]) && this[LOCALS_LIST].length > 0) {
       assign(this[LOCALS], this[LOCALS_LIST]);
       this[LOCALS_LIST] = null;
     }
-    return this[LOCALS];
-  },
+    return this[LOCALS] as Record<string, any>;
+  }
 
   set locals(val) {
-    if (!this[LOCALS_LIST]) {
-      this[LOCALS_LIST] = [];
-    }
-    this[LOCALS_LIST].push(val);
-  },
+    const localsList = this[LOCALS_LIST] as Record<string, any>[] ?? [];
+    localsList.push(val);
+    this[LOCALS_LIST] = localsList;
+  }
 
   /**
    * alias to {@link Context#locals}, compatible with koa that use this variable
@@ -190,11 +213,11 @@ const Context = {
    */
   get state() {
     return this.locals;
-  },
+  }
 
   set state(val) {
     this.locals = val;
-  },
+  }
 
   /**
    * Run async function in the background
@@ -208,43 +231,40 @@ const Context = {
    * });
    * ```
    */
-  runInBackground(scope: (ctx: any) => Promise<void>) {
+  runInBackground(scope: (ctx: ContextDelegation) => Promise<void>, taskName?: string): void {
     // try to use custom function name first
-    /* istanbul ignore next */
-    const taskName = Reflect.get(scope, '_name') || scope.name || utils.getCalleeFromStack(true);
-    this._runInBackground(scope, taskName);
-  },
+    if (!taskName) {
+      taskName = Reflect.get(scope, '_name') || scope.name || utils.getCalleeFromStack(true);
+    }
+    // use setImmediate to ensure all sync logic will run async
+    setImmediate(() => {
+      this._runInBackground(scope, taskName!);
+    });
+  }
 
   // let plugins or frameworks to reuse _runInBackground in some cases.
   // e.g.: https://github.com/eggjs/egg-mock/pull/78
-  _runInBackground(scope: (ctx: any) => Promise<void>, taskName: string) {
-    // eslint-disable-next-line @typescript-eslint/no-this-alias
-    const ctx = this;
-    const start = performance.now();
-    // use setImmediate to ensure all sync logic will run async
-    return new Promise(resolve => setImmediate(resolve))
-      .then(() => scope(ctx))
-      .then(() => {
-        ctx.coreLogger.info('[egg:background] task:%s success (%dms)',
-          taskName, Math.floor((performance.now() - start) * 1000) / 1000);
-      })
-      .catch(err => {
-        // background task process log
-        ctx.coreLogger.info('[egg:background] task:%s fail (%dms)',
-          taskName, Math.floor((performance.now() - start) * 1000) / 1000);
+  async _runInBackground(scope: (ctx: ContextDelegation) => Promise<void>, taskName: string) {
+    const startTime = now();
+    try {
+      await scope(this as any);
+      this.coreLogger.info('[egg:background] task:%s success (%dms)', taskName, diff(startTime));
+    } catch (err: any) {
+      // background task process log
+      this.coreLogger.info('[egg:background] task:%s fail (%dms)', taskName, diff(startTime));
 
-        // emit error when promise catch, and set err.runInBackground flag
-        err.runInBackground = true;
-        ctx.app.emit('error', err, ctx);
-      });
-  },
-} as any;
+      // emit error when promise catch, and set err.runInBackground flag
+      err.runInBackground = true;
+      this.app.emit('error', err, this);
+    }
+  }
+}
 
 /**
  * Context delegation.
  */
 
-delegate(Context, 'request')
+delegate(Context.prototype, 'request')
   /**
    * @member {Boolean} Context#acceptJSON
    * @see Request#acceptJSON
@@ -270,7 +290,7 @@ delegate(Context, 'request')
    */
   .access('ip');
 
-delegate(Context, 'response')
+delegate(Context.prototype, 'response')
   /**
    * @member {Number} Context#realStatus
    * @see Response#realStatus
@@ -278,4 +298,6 @@ delegate(Context, 'response')
    */
   .access('realStatus');
 
-export default Context;
+export type ContextDelegation = EggCoreContextDelegation & Context
+& Pick<Request, 'acceptJSON' | 'queries' | 'accept' | 'ip'>
+& Pick<Response, 'realStatus'>;

package/src/app/extend/context.types.ts

@@ -0,0 +1,24 @@
+import type {
+  Router,
+} from '@eggjs/core';
+import type {
+  HttpClientRequestURL, HttpClientRequestOptions, HttpClient,
+} from '../../lib/core/httpclient.js';
+import type {
+  ContextHttpClient,
+} from '../../lib/core/context_httpclient.js';
+import type Helper from './helper.js';
+import type { EggLogger } from 'egg-logger';
+
+declare module '@eggjs/core' {
+  // add Context overrides types
+  interface Context {
+    curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']>;
+    get router(): Router;
+    set router(val: Router);
+    get helper(): Helper;
+    get httpclient(): ContextHttpClient;
+    get httpClient(): ContextHttpClient;
+    getLogger(name: string): EggLogger;
+  }
+}

package/src/app/extend/{helper.js → helper.ts}

@@ -1,10 +1,12 @@
-'use strict';
-
-const url = require('url');
-
-
-module.exports = {
+import url from 'node:url';
+import { BaseContextClass } from '../../lib/core/base_context_class.js';
 
+/**
+ * The Helper class which can be used as utility function.
+ * We support developers to extend Helper through ${baseDir}/app/extend/helper.js ,
+ * then you can use all method on `ctx.helper` that is a instance of Helper.
+ */
+export default class Helper extends BaseContextClass {
   /**
    * Generate URL path(without host) for route. Takes the route name and a map of named params.
    * @function Helper#pathFor
@@ -19,9 +21,9 @@ module.exports = {
    * ```
    * @return {String} url path(without host)
    */
-  pathFor(name, params) {
+  pathFor(name: string, params: Record<string, any>): string {
     return this.app.router.url(name, params);
-  },
+  }
 
   /**
    * Generate full URL(with host) for route. Takes the route name and a map of named params.
@@ -36,8 +38,7 @@ module.exports = {
    * ```
    * @return {String} full url(with host)
    */
-  urlFor(name, params) {
-    return this.ctx.protocol + '://' + this.ctx.host + url.resolve('/', this.app.router.url(name, params));
-  },
-
-};
+  urlFor(name: string, params: Record<string, any>): string {
+    return this.ctx.protocol + '://' + this.ctx.host + url.resolve('/', this.pathFor(name, params));
+  }
+}