egg 3.29.0 → 4.0.0-beta.10

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "egg",
-  "version": "3.29.0",
+  "version": "4.0.0-beta.10",
+  "engines": {
+    "node": ">= 18.19.0"
+  },
   "publishConfig": {
-    "tag": "release-3.x",
-    "access": "public"
+    "tag": "beta"
   },
-  "description": "A web framework's framework for Node.js",
+  "description": "A web application framework for Node.js",
   "keywords": [
     "web",
     "app",
@@ -17,119 +19,135 @@
     "egg"
   ],
   "dependencies": {
-    "@types/accepts": "^1.3.5",
-    "@types/koa": "^2.13.5",
-    "@types/koa-router": "^7.4.4",
-    "accepts": "^1.3.8",
-    "agentkeepalive": "^4.2.1",
-    "cache-content-type": "^1.0.1",
+    "@eggjs/cluster": "^3.0.0",
+    "@eggjs/cookies": "^3.0.0",
+    "@eggjs/core": "^6.2.5",
+    "@eggjs/schedule": "^5.0.2",
+    "@eggjs/utils": "^4.1.5",
+    "@eggjs/watcher": "^4.0.1",
     "circular-json-for-egg": "^1.0.0",
-    "cluster-client": "^3.3.0",
+    "cluster-client": "^3.7.0",
     "delegates": "^1.0.0",
-    "egg-cluster": "^2.0.0",
-    "egg-cookies": "^2.6.1",
-    "egg-core": "^5.4.0",
     "egg-development": "^3.0.0",
     "egg-errors": "^2.3.1",
     "egg-i18n": "^2.1.1",
     "egg-jsonp": "^2.0.0",
-    "egg-logger": "^3.0.1",
+    "egg-logger": "^3.6.0",
     "egg-logrotator": "^3.1.0",
     "egg-multipart": "^3.1.0",
     "egg-onerror": "^2.1.1",
-    "egg-schedule": "^4.0.0",
     "egg-security": "^3.0.0",
     "egg-session": "^3.3.0",
     "egg-static": "^2.2.0",
     "egg-view": "^2.1.3",
-    "egg-watcher": "^3.1.1",
-    "extend2": "^1.0.1",
-    "graceful": "^1.1.0",
-    "humanize-ms": "^1.2.1",
+    "extend2": "^4.0.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": "^3.0.0",
-    "ms": "^2.1.3",
-    "on-finished": "^2.4.1",
+    "koa-override": "^4.0.0",
     "onelogger": "^1.0.0",
-    "sendmessage": "^2.0.0",
-    "urllib": "^2.33.0",
-    "urllib-next": "npm:urllib@^3.27.1",
-    "urllib4": "npm:urllib@^4.5.0",
+    "performance-ms": "^1.1.0",
+    "sendmessage": "^3.0.1",
+    "urllib": "^4.0.0",
     "utility": "^2.1.0",
     "ylru": "^1.3.2"
   },
   "devDependencies": {
-    "@eggjs/tsconfig": "^1.1.0",
-    "@types/node": "^20.1.2",
-    "@umijs/preset-react": "^2.1.6",
-    "address": "^1.2.1",
-    "antd": "^4.23.2",
-    "assert-file": "^1.0.0",
-    "coffee": "^5.4.0",
-    "cross-env": "^7.0.3",
-    "dumi": "^1.1.47",
-    "dumi-theme-egg": "^1.2.2",
-    "egg-bin": "^6.4.1",
-    "egg-mock": "^5.10.7",
+    "@arethetypeswrong/cli": "^0.17.1",
+    "@eggjs/bin": "^7.0.0",
+    "@eggjs/koa": "^2.19.1",
+    "@eggjs/mock": "beta",
+    "@eggjs/tsconfig": "1",
+    "@types/delegates": "^1.0.3",
+    "@types/koa-bodyparser": "^4.3.12",
+    "@types/mocha": "^10.0.7",
+    "@types/ms": "^0.7.34",
+    "@types/node": "22",
+    "@types/supertest": "^6.0.2",
+    "address": "2",
+    "assert-file": "1",
+    "coffee": "5",
+    "cross-env": "7",
     "egg-plugin-puml": "^2.4.0",
-    "egg-tracer": "^2.0.0",
+    "egg-tracer": "^2.1.0",
     "egg-view-nunjucks": "^2.3.0",
-    "eslint": "^8.23.1",
-    "eslint-config-egg": "^12.0.0",
-    "formstream": "^1.1.1",
-    "https-pem": "^3.0.0",
-    "jsdoc": "^3.6.11",
-    "koa": "^2.13.4",
+    "eslint": "8",
+    "eslint-config-egg": "14",
+    "formstream": "^1.5.1",
     "koa-static": "^5.0.0",
-    "node-libs-browser": "^2.2.1",
+    "mm": "^3.4.0",
     "pedding": "^1.1.0",
     "prettier": "^2.7.1",
-    "react": "^16.14.0",
-    "react-dom": "^16.14.0",
-    "react-router": "^5.3.4",
+    "rimraf": "6",
+    "runscript": "^2.0.1",
     "sdk-base": "^4.2.1",
     "spy": "^1.0.0",
-    "supertest": "^6.2.4",
-    "ts-node": "^10.9.1",
-    "tsd": "^0.28.1",
-    "typescript": "^5.0.4",
-    "umi": "^3.5.36"
+    "supertest": "^7.0.0",
+    "tshy": "^3.0.2",
+    "tshy-after": "1",
+    "typescript": "5"
   },
-  "main": "index.js",
-  "types": "index.d.ts",
-  "files": [
-    "index.js",
-    "lib",
-    "app",
-    "config",
-    "agent.js",
-    "index.d.ts"
-  ],
   "scripts": {
-    "lint": "eslint app config lib test *.js",
-    "tsd": "tsd",
-    "test": "npm run lint -- --fix && npm run tsd && npm run test-local",
-    "test-local": "egg-bin test --ts false",
-    "test-local-changed": "egg-bin test --changed --ts false",
-    "cov": "egg-bin cov --timeout 100000 --ts false",
-    "ci": "npm run lint && npm run tsd && npm run cov",
+    "clean": "rimraf dist",
+    "lint": "eslint src test --ext .ts",
+    "pretest": "npm run clean && npm run lint -- --fix",
+    "test": "egg-bin test",
+    "test-local": "egg-bin test",
+    "test:changed": "egg-bin test --changed",
+    "preci": "npm run clean &&  npm run lint",
+    "ci": "egg-bin cov",
+    "postci": "npm run prepublishOnly && npm run clean",
+    "prepublishOnly": "tshy && tshy-after && attw --pack",
     "site:dev": "cross-env NODE_OPTIONS=--openssl-legacy-provider APP_ROOT=./site dumi dev",
     "site:devWithNode14-16": "cross-env APP_ROOT=./site dumi dev",
     "site:build": "cross-env NODE_OPTIONS=--openssl-legacy-provider APP_ROOT=./site dumi build",
     "site:buildWithNode14-16": "cross-env APP_ROOT=./site dumi build",
     "site:prettier": "prettier --config site/.prettierrc --ignore-path site/.prettierignore --write \"site/**/*.{js,jsx,tsx,ts,less,md,json}\"",
-    "puml": "puml . --dest ./site",
-    "commits": "./scripts/commits.sh"
+    "puml": "puml . --dest ./site"
   },
   "homepage": "https://github.com/eggjs/egg",
   "repository": {
     "type": "git",
-    "url": "https://github.com/eggjs/egg.git"
+    "url": "git://github.com/eggjs/egg.git"
   },
-  "engines": {
-    "node": ">= 14.20.0"
+  "license": "MIT",
+  "tnpm": {
+    "mode": "npm"
+  },
+  "egg": {
+    "framework": true,
+    "exports": {
+      "import": "./dist/esm",
+      "require": "./dist/commonjs",
+      "typescript": "./src"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "type": "module",
+  "tshy": {
+    "exports": {
+      ".": "./src/index.ts",
+      "./package.json": "./package.json"
+    }
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/index.d.ts",
+        "default": "./dist/commonjs/index.js"
+      }
+    },
+    "./package.json": "./package.json"
   },
-  "license": "MIT"
+  "types": "./dist/commonjs/index.d.ts",
+  "main": "./dist/commonjs/index.js",
+  "module": "./dist/esm/index.js"
 }

package/src/agent.ts

@@ -0,0 +1,7 @@
+import { BaseHookClass } from './lib/core/base_hook_class.js';
+
+export default class EggAgentHook extends BaseHookClass {
+  configDidLoad() {
+    this.agent._wrapMessenger();
+  }
+}

package/src/app/extend/context.ts

@@ -0,0 +1,303 @@
+import delegate from 'delegates';
+import { assign } from 'utility';
+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';
+
+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;
+
+  /**
+   * Get the current visitor's cookies.
+   */
+  get cookies() {
+    let cookies = this[COOKIES];
+    if (!cookies) {
+      this[COOKIES] = cookies = new this.app.ContextCookies(this, this.app.keys, this.app.config.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(): ContextHttpClient {
+    if (!this[CONTEXT_HTTPCLIENT]) {
+      this[CONTEXT_HTTPCLIENT] = new this.app.ContextHttpClient(this as any);
+    }
+    return this[CONTEXT_HTTPCLIENT] as ContextHttpClient;
+  }
+
+  /**
+   * Alias to {@link Context#httpclient}
+   */
+  get httpClient(): ContextHttpClient {
+    return this.httpclient;
+  }
+
+  /**
+   * Shortcut for httpclient.curl
+   *
+   * @function Context#curl
+   * @param {String|Object} url - request url address.
+   * @param {Object} [options] - options for request.
+   * @return {Object} see {@link ContextHttpClient#curl}
+   */
+  async curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']> {
+    return await this.httpclient.curl(url, options);
+  }
+
+  /**
+   * Alias to {@link Application#router}
+   *
+   * @member {Router} Context#router
+   * @since 1.0.0
+   * @example
+   * ```js
+   * this.router.pathFor('post', { id: 12 });
+   * ```
+   */
+  get router(): Router {
+    if (this[CONTEXT_ROUTER]) {
+      return this[CONTEXT_ROUTER] as Router;
+    }
+    return this.app.router;
+  }
+
+  /**
+   * Set router to Context, only use on EggRouter
+   * @param {Router} val router instance
+   */
+  set router(val: Router) {
+    this[CONTEXT_ROUTER] = val;
+  }
+
+  /**
+   * Get helper instance from {@link Application#Helper}
+   *
+   * @member {Helper} Context#helper
+   * @since 1.0.0
+   */
+  get helper(): Helper {
+    if (!this[HELPER]) {
+      this[HELPER] = new this.app.Helper(this as any);
+    }
+    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
+   */
+  getLogger(name: string): EggLogger {
+    return this.app.getLogger(name);
+  }
+
+  /**
+   * Logger for Application
+   *
+   * @member {Logger} Context#logger
+   * @since 1.0.0
+   * @example
+   * ```js
+   * this.logger.info('some request data: %j', this.request.body);
+   * this.logger.warn('WARNING!!!!');
+   * ```
+   */
+  get logger(): EggLogger {
+    return this.getLogger('logger');
+  }
+
+  /**
+   * Logger for frameworks and plugins
+   *
+   * @member {Logger} Context#coreLogger
+   * @since 1.0.0
+   */
+  get coreLogger(): EggLogger {
+    return this.getLogger('coreLogger');
+  }
+
+  /**
+   * locals is an object for view, you can use `app.locals` and `ctx.locals` to set variables,
+   * which will be used as data when view is rendering.
+   * The difference between `app.locals` and `ctx.locals` is the context level, `app.locals` is global level, and `ctx.locals` is request level. when you get `ctx.locals`, it will merge `app.locals`.
+   *
+   * when you set locals, only object is available
+   *
+   * ```js
+   * this.locals = {
+   *   a: 1
+   * };
+   * this.locals = {
+   *   b: 1
+   * };
+   * this.locals.c = 1;
+   * console.log(this.locals);
+   * {
+   *   a: 1,
+   *   b: 1,
+   *   c: 1,
+   * };
+   * ```
+   *
+   * `ctx.locals` has cache, it only merges `app.locals` once in one request.
+   *
+   * @member {Object} Context#locals
+   */
+  get locals() {
+    if (!this[LOCALS]) {
+      this[LOCALS] = assign({}, this.app.locals);
+    }
+    if (Array.isArray(this[LOCALS_LIST]) && this[LOCALS_LIST].length > 0) {
+      assign(this[LOCALS], this[LOCALS_LIST]);
+      this[LOCALS_LIST] = null;
+    }
+    return this[LOCALS] as Record<string, any>;
+  }
+
+  set locals(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
+   * @member {Object} state
+   * @see Context#locals
+   */
+  get state() {
+    return this.locals;
+  }
+
+  set state(val) {
+    this.locals = val;
+  }
+
+  /**
+   * Run async function in the background
+   * @param {Function} scope - the first args is ctx
+   * ```js
+   * this.body = 'hi';
+   *
+   * this.runInBackground(async ctx => {
+   *   await ctx.mysql.query(sql);
+   *   await ctx.curl(url);
+   * });
+   * ```
+   */
+  runInBackground(scope: (ctx: ContextDelegation) => Promise<void>, taskName?: string): void {
+    // try to use custom function name first
+    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
+  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;
+      this.app.emit('error', err, this);
+    }
+  }
+}
+
+/**
+ * Context delegation.
+ */
+
+delegate(Context.prototype, 'request')
+  /**
+   * @member {Boolean} Context#acceptJSON
+   * @see Request#acceptJSON
+   * @since 1.0.0
+   */
+  .getter('acceptJSON')
+  /**
+   * @member {Array} Context#queries
+   * @see Request#queries
+   * @since 1.0.0
+   */
+  .getter('queries')
+  /**
+   * @member {Boolean} Context#accept
+   * @see Request#accept
+   * @since 1.0.0
+   */
+  .getter('accept')
+  /**
+   * @member {string} Context#ip
+   * @see Request#ip
+   * @since 1.0.0
+   */
+  .access('ip');
+
+delegate(Context.prototype, 'response')
+  /**
+   * @member {Number} Context#realStatus
+   * @see Response#realStatus
+   * @since 1.0.0
+   */
+  .access('realStatus');
+
+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/{app/extend/helper.js → src/app/extend/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));
+  }
+}