egg 4.0.0-beta.0 → 4.0.0-beta.11

package/src/lib/egg.ts

@@ -3,12 +3,22 @@ import path from 'node:path';
 import fs from 'node:fs';
 import http, { type IncomingMessage, type ServerResponse } from 'node:http';
 import inspector from 'node:inspector';
-import { fileURLToPath } from 'node:url';
-import { EggCore, type EggCoreContext, type EggCoreOptions } from '@eggjs/core';
+import { AsyncLocalStorage } from 'node:async_hooks';
+import {
+  EggCore,
+  Request as EggCoreRequest,
+  Response as EggCoreResponse,
+  Router,
+} from '@eggjs/core';
+import type {
+  EggCoreOptions,
+  Next, MiddlewareFunc as EggCoreMiddlewareFunc,
+  ILifecycleBoot,
+} from '@eggjs/core';
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 import createClusterClient, { close as closeClusterClient } from 'cluster-client';
-import extend from 'extend2';
+import { extend } from 'extend2';
 import { EggContextLogger as ContextLogger, EggLoggers, EggLogger } from 'egg-logger';
 import { Cookies as ContextCookies } from '@eggjs/cookies';
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -16,6 +26,7 @@ import { Cookies as ContextCookies } from '@eggjs/cookies';
 import CircularJSON from 'circular-json-for-egg';
 import type { Agent } from './agent.js';
 import type { Application } from './application.js';
+import Context, { type ContextDelegation } from '../app/extend/context.js';
 import type { EggAppConfig } from './type.js';
 import { create as createMessenger, IMessenger } from './core/messenger/index.js';
 import { ContextHttpClient } from './core/context_httpclient.js';
@@ -30,6 +41,9 @@ import { convertObject } from './core/utils.js';
 import { BaseContextClass } from './core/base_context_class.js';
 import { BaseHookClass } from './core/base_hook_class.js';
 import type { EggApplicationLoader } from './loader/index.js';
+import { getSourceDirname } from './utils.js';
+
+import './egg.types.js';
 
 const EGG_PATH = Symbol.for('egg#eggPath');
 
@@ -39,20 +53,35 @@ export interface EggApplicationCoreOptions extends Omit<EggCoreOptions, 'baseDir
   baseDir?: string;
 }
 
-export interface EggContext extends EggCoreContext {
-  app: EggApplicationCore;
-  /**
-   * Request start time
-   * @member {Number} Context#starttime
-   */
-  starttime: number;
-  /**
-   * Request start timer using `performance.now()`
-   * @member {Number} Context#performanceStarttime
-   */
-  performanceStarttime: number;
+// export egg classes
+export {
+  Context,
+  Router,
+  EggLogger,
+};
+
+export class Request extends EggCoreRequest {
+  declare app: EggCore;
+  declare response: Response;
+  declare ctx: ContextDelegation;
+}
+
+export class Response extends EggCoreResponse {
+  declare app: EggCore;
+  declare request: Request;
+  declare ctx: ContextDelegation;
 }
 
+// export egg types
+export type {
+  ContextDelegation,
+  ILifecycleBoot,
+  Next,
+};
+// keep compatible with egg version 3.x
+export type EggContext = ContextDelegation;
+export type MiddlewareFunc<T extends ContextDelegation = ContextDelegation> = EggCoreMiddlewareFunc<T>;
+
 /**
  * Based on koa's Application
  * @see https://github.com/eggjs/egg-core
@@ -60,6 +89,7 @@ export interface EggContext extends EggCoreContext {
  * @augments EggCore
  */
 export class EggApplicationCore extends EggCore {
+  declare ctxStorage: AsyncLocalStorage<ContextDelegation>;
   // export context base classes, let framework can impl sub class and over context extend easily.
   ContextCookies = ContextCookies;
   ContextLogger = ContextLogger;
@@ -144,7 +174,16 @@ export class EggApplicationCore extends EggCore {
     this.messenger.once('egg-ready', () => {
       this.lifecycle.triggerServerDidReady();
     });
-    this.load();
+    this.lifecycle.registerBeforeStart(async () => {
+      await this.load();
+    }, 'load files');
+  }
+
+  /**
+   * @deprecated please use `options` property instead
+   */
+  get _options() {
+    return this.options;
   }
 
   protected async loadConfig() {
@@ -212,7 +251,7 @@ export class EggApplicationCore extends EggCore {
    *   - {Number} [maxWaitTime|30000] - leader startup max time, default is 30 seconds
    * @return {ClientWrapper} wrapper
    */
-  cluster(clientClass: unknown, options: object) {
+  cluster(clientClass: unknown, options?: object) {
     const clientClassOptions = {
       ...this.config.clusterClient,
       ...options,
@@ -403,7 +442,6 @@ export class EggApplicationCore extends EggCore {
     if (!(err instanceof Error)) {
       const newError = new Error(String(err));
       // err maybe an object, try to copy the name, message and stack to the new error instance
-      /* istanbul ignore else */
       if (err) {
         if (err.name) newError.name = err.name;
         if (err.message) newError.message = err.message;
@@ -411,7 +449,6 @@ export class EggApplicationCore extends EggCore {
       }
       err = newError;
     }
-    /* istanbul ignore else */
     if (err.name === 'Error') {
       err.name = 'unhandledRejectionError';
     }
@@ -491,12 +528,7 @@ export class EggApplicationCore extends EggCore {
   }
 
   get [EGG_PATH]() {
-    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)));
+    return getSourceDirname();
   }
 
   #setupTimeoutTimer() {
@@ -538,7 +570,7 @@ export class EggApplicationCore extends EggCore {
    * @deprecated
    */
   get proxy() {
-    this.deprecate('please use app.config.proxy instead');
+    // this.deprecate('please use app.config.proxy instead');
     return this.config.proxy;
   }
   /* eslint no-empty-function: off */
@@ -580,7 +612,7 @@ export class EggApplicationCore extends EggCore {
    * @param {Request} [req] - if you want to mock request like querystring, you can pass an object to this function.
    * @return {Context} context
    */
-  createAnonymousContext(req?: any): EggCoreContext {
+  createAnonymousContext(req?: any): EggContext {
     const request: any = {
       headers: {
         host: '127.0.0.1',
@@ -624,7 +656,7 @@ export class EggApplicationCore extends EggCore {
     const context = Object.create(this.context) as EggContext;
     const request = context.request = Object.create(this.request);
     const response = context.response = Object.create(this.response);
-    context.app = request.app = response.app = this;
+    context.app = request.app = response.app = this as any;
     context.req = request.req = response.req = req;
     context.res = request.res = response.res = res;
     request.ctx = response.ctx = context;

package/src/lib/egg.types.ts

@@ -0,0 +1,6 @@
+declare module '@eggjs/core' {
+  // add EggApplicationCore overrides types
+  interface EggCore {
+    inspect(): any;
+  }
+}

package/src/lib/type.ts

@@ -1,5 +1,4 @@
 import type { Socket } from 'node:net';
-import type { EggCoreContext } from '@eggjs/core';
 import type {
   RequestOptions as HttpClientRequestOptions,
 } from 'urllib';
@@ -10,16 +9,17 @@ import type {
   FileLoaderOptions,
 } from '@eggjs/core';
 import type {
-  EggApplicationCore,
+  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 IgnoreOrMatch = IgnoreItem | IgnoreItem[];
+// import @eggjs/watcher types
+// import '@eggjs/watcher';
 
-export type Next = () => Promise<void>;
+type IgnoreItem = string | RegExp | ((ctx: ContextDelegation) => boolean);
+type IgnoreOrMatch = IgnoreItem | IgnoreItem[];
 
 export interface ClientErrorResponse {
   body: string | Buffer;
@@ -103,7 +103,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;
   };
 
   /**

package/src/lib/utils.ts

@@ -0,0 +1,16 @@
+
+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: string) {
+  return path.join(getSourceDirname(), filename);
+}

package/src/urllib.ts

@@ -0,0 +1 @@
+export * from 'urllib';

package/src/app/extend/context.js

@@ -1,285 +0,0 @@
-'use strict';
-
-const { performance } = require('perf_hooks');
-const delegate = require('delegates');
-const { assign } = require('utility');
-const eggUtils = require('egg-core').utils;
-
-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');
-
-const proto = module.exports = {
-
-  /**
-   * 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);
-    }
-    return this[COOKIES];
-  },
-
-  /**
-   * Get a wrapper httpclient instance contain ctx in the hold request process
-   *
-   * @return {ContextHttpClient} the wrapper httpclient instance
-   */
-  get httpclient() {
-    if (!this[CONTEXT_HTTPCLIENT]) {
-      this[CONTEXT_HTTPCLIENT] = new this.app.ContextHttpClient(this);
-    }
-    return this[CONTEXT_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}
-   */
-  curl(url, options) {
-    return 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() {
-    if (!this[CONTEXT_ROUTER]) {
-      this[CONTEXT_ROUTER] = this.app.router;
-    }
-    return this[CONTEXT_ROUTER];
-  },
-
-  /**
-   * Set router to Context, only use on EggRouter
-   * @param {EggRouter} val router instance
-   */
-  set router(val) {
-    this[CONTEXT_ROUTER] = val;
-  },
-
-  /**
-   * Get helper instance from {@link Application#Helper}
-   *
-   * @member {Helper} Context#helper
-   * @since 1.0.0
-   */
-  get helper() {
-    if (!this[HELPER]) {
-      this[HELPER] = new this.app.Helper(this);
-    }
-    return this[HELPER];
-  },
-
-  /**
-   * Wrap app.loggers with context infomation,
-   * 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) {
-    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];
-  },
-
-  /**
-   * Logger for Application, wrapping app.coreLogger with context infomation
-   *
-   * @member {ContextLogger} Context#logger
-   * @since 1.0.0
-   * @example
-   * ```js
-   * this.logger.info('some request data: %j', this.request.body);
-   * this.logger.warn('WARNING!!!!');
-   * ```
-   */
-  get logger() {
-    return this.getLogger('logger');
-  },
-
-  /**
-   * Logger for frameworks and plugins,
-   * wrapping app.coreLogger with context infomation
-   *
-   * @member {ContextLogger} Context#coreLogger
-   * @since 1.0.0
-   */
-  get coreLogger() {
-    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 (this[LOCALS_LIST] && this[LOCALS_LIST].length) {
-      assign(this[LOCALS], this[LOCALS_LIST]);
-      this[LOCALS_LIST] = null;
-    }
-    return this[LOCALS];
-  },
-
-  set locals(val) {
-    if (!this[LOCALS_LIST]) {
-      this[LOCALS_LIST] = [];
-    }
-    this[LOCALS_LIST].push(val);
-  },
-
-  /**
-   * 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) {
-    // try to use custom function name first
-    /* istanbul ignore next */
-    const taskName = scope._name || scope.name || eggUtils.getCalleeFromStack(true);
-    scope._name = taskName;
-    this._runInBackground(scope);
-  },
-
-  // let plugins or frameworks to reuse _runInBackground in some cases.
-  // e.g.: https://github.com/eggjs/egg-mock/pull/78
-  _runInBackground(scope) {
-    const ctx = this;
-    const start = performance.now();
-    /* istanbul ignore next */
-    const taskName = scope._name || scope.name || eggUtils.getCalleeFromStack(true);
-    // use setImmediate to ensure all sync logic will run async
-    return new Promise(resolve => setImmediate(resolve))
-      // use app.toAsyncFunction to support both generator function and async function
-      .then(() => ctx.app.toAsyncFunction(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);
-
-        // emit error when promise catch, and set err.runInBackground flag
-        err.runInBackground = true;
-        ctx.app.emit('error', err, ctx);
-      });
-  },
-};
-
-/**
- * Context delegation.
- */
-
-delegate(proto, '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(proto, 'response')
-  /**
-   * @member {Number} Context#realStatus
-   * @see Response#realStatus
-   * @since 1.0.0
-   */
-  .access('realStatus');

package/src/app/extend/response.js

@@ -1,101 +0,0 @@
-'use strict';
-
-const getType = require('cache-content-type');
-const isJSON = require('koa-is-json');
-
-const REAL_STATUS = Symbol('Context#realStatus');
-
-module.exports = {
-
-  /**
-   * Get or set the length of content.
-   *
-   * For Get: If the original content length is null or undefined, it will read out
-   * the body's content length as the return value.
-   *
-   * @member {Number} Response#type
-   * @param {Number} len The content-length to be set.
-   */
-  set length(len) {
-    // copy from koa
-    // change header name to lower case
-    this.set('content-length', len);
-  },
-
-  get length() {
-    // copy from koa
-    const len = this.header['content-length'];
-    const body = this.body;
-
-    if (len == null) {
-      if (!body) return;
-      if (typeof body === 'string') return Buffer.byteLength(body);
-      if (Buffer.isBuffer(body)) return body.length;
-      if (isJSON(body)) return Buffer.byteLength(JSON.stringify(body));
-      return;
-    }
-
-    return parseInt(len, 10);
-  },
-
-  /**
-   * Get or set the content-type.
-   *
-   * For Set: If type is null or undefined, this property will be removed.
-   *
-   * For Get: If the value is null or undefined, an empty string will be returned;
-   * if you have multiple values seperated by `;`, ONLY the first one will be returned.
-   *
-   * @member {String} Response#type
-   * @param {String} type The content-type to be set.
-   */
-  set type(type) {
-    // copy from koa
-    // Different:
-    //  - change header name to lower case
-    type = getType(type);
-    if (type) {
-      this.set('content-type', type);
-    } else {
-      this.remove('content-type');
-    }
-  },
-
-  get type() {
-    // copy from koa
-    const type = this.get('content-type');
-    if (!type) return '';
-    return type.split(';')[0];
-  },
-
-  /**
-   * Get or set a real status code.
-   *
-   * e.g.: Using 302 status redirect to the global error page
-   * instead of show current 500 status page.
-   * And access log should save 500 not 302,
-   * then the `realStatus` can help us find out the real status code.
-   * @member {Number} Response#realStatus
-   * @return {Number} The status code to be set.
-   */
-  get realStatus() {
-    if (this[REAL_STATUS]) {
-      return this[REAL_STATUS];
-    }
-    return this.status;
-  },
-
-  /**
-   * Set a real status code.
-   *
-   * e.g.: Using 302 status redirect to the global error page
-   * instead of show current 500 status page.
-   * And access log should save 500 not 302,
-   * then the `realStatus` can help us find out the real status code.
-   * @member {Number} Response#realStatus
-   * @param {Number} status The status code to be set.
-   */
-  set realStatus(status) {
-    this[REAL_STATUS] = status;
-  },
-};