egg 4.0.0-beta.5 → 4.0.0-beta.6

package/src/app/extend/response.ts

@@ -0,0 +1,36 @@
+import { Response as KoaResponse } from '@eggjs/core';
+
+const REAL_STATUS = Symbol('response realStatus');
+
+export default class Response extends KoaResponse {
+  /**
+   * 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(): number {
+    if (this[REAL_STATUS]) {
+      return this[REAL_STATUS] as number;
+    }
+    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: number) {
+    this[REAL_STATUS] = status;
+  }
+}

package/src/app/middleware/meta.ts

@@ -3,8 +3,7 @@
  */
 
 import { performance } from 'node:perf_hooks';
-import type { EggCoreContext } from '@eggjs/core';
-import type { Next } from '../../lib/type.js';
+import type { ContextDelegation, Next } from '../../lib/egg.js';
 
 export interface MetaMiddlewareOptions {
   enable: boolean;
@@ -12,7 +11,7 @@ export interface MetaMiddlewareOptions {
 }
 
 export default (options: MetaMiddlewareOptions) => {
-  return async function meta(ctx: EggCoreContext, next: Next) {
+  return async function meta(ctx: ContextDelegation, next: Next) {
     if (options.logging) {
       ctx.coreLogger.info('[meta] request started, host: %s, user-agent: %s',
         ctx.host, ctx.header['user-agent']);

package/src/app/middleware/notfound.ts

@@ -1,5 +1,4 @@
-import type { EggCoreContext } from '@eggjs/core';
-import type { Next } from '../../lib/type.js';
+import type { Next, ContextDelegation } from '../../lib/egg.js';
 
 export interface NotFoundMiddlewareOptions {
   enable: boolean;
@@ -7,7 +6,7 @@ export interface NotFoundMiddlewareOptions {
 }
 
 export default (options: NotFoundMiddlewareOptions) => {
-  return async function notfound(ctx: EggCoreContext, next: Next) {
+  return async function notfound(ctx: ContextDelegation, next: Next) {
     await next();
 
     if (ctx.status !== 404 || ctx.body) {

package/src/app/middleware/site_file.ts

@@ -1,10 +1,9 @@
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { readFile } from 'node:fs/promises';
-import type { EggCoreContext } from '@eggjs/core';
-import type { Next } from '../../lib/type.js';
+import type { Next, ContextDelegation } from '../../lib/egg.js';
 
-export type SiteFileContentFun = (ctx: EggCoreContext) => Promise<Buffer | string>;
+export type SiteFileContentFun = (ctx: ContextDelegation) => Promise<Buffer | string>;
 
 export interface SiteFileMiddlewareOptions {
   enable: boolean;
@@ -15,11 +14,10 @@ export interface SiteFileMiddlewareOptions {
 const BUFFER_CACHE = Symbol('siteFile URL buffer cache');
 
 module.exports = (options: SiteFileMiddlewareOptions) => {
-  return async function siteFile(ctx: EggCoreContext, next: Next) {
+  return async function siteFile(ctx: ContextDelegation, next: Next) {
     if (ctx.method !== 'HEAD' && ctx.method !== 'GET') {
       return next();
     }
-    /* istanbul ignore if */
     if (ctx.path[0] !== '/') {
       return next();
     }

package/src/config/config.default.ts

@@ -2,6 +2,7 @@ import path from 'node:path';
 import { pathToFileURL } from 'node:url';
 import type { EggAppInfo } from '@eggjs/core';
 import type { EggAppConfig } from '../lib/type.js';
+import { getSourceFile } from '../lib/utils.js';
 
 /**
  * The configuration of egg application, can be access by `app.config`
@@ -201,7 +202,7 @@ export default (appInfo: EggAppInfo) => {
    */
   config.siteFile = {
     enable: true,
-    '/favicon.ico': pathToFileURL(path.join(__dirname, 'favicon.png')),
+    '/favicon.ico': pathToFileURL(getSourceFile('config/favicon.png')),
     // default cache in 30 days
     cacheControl: 'public, max-age=2592000',
   };

package/src/lib/application.ts

@@ -2,14 +2,16 @@ import path from 'node:path';
 import fs from 'node:fs';
 import http from 'node:http';
 import { Socket } from 'node:net';
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import graceful from 'graceful';
+import { graceful } from 'graceful';
 import { assign } from 'utility';
 import { utils as eggUtils } from '@eggjs/core';
-import { EggApplicationCore, EggContext, EggApplicationCoreOptions } from './egg.js';
+import {
+  EggApplicationCore,
+  type EggApplicationCoreOptions,
+  type ContextDelegation,
+} from './egg.js';
 import { AppWorkerLoader } from './loader/index.js';
-import { BaseContextClass } from './core/base_context_class.js';
+import Helper from '../app/extend/helper.js';
 
 const EGG_LOADER = Symbol.for('egg#loader');
 
@@ -34,13 +36,6 @@ function escapeHeaderValue(value: string) {
   return /[\r\n]/.test(value) ? value.replace(/[\r\n]+[ \t]*/g, '') : value;
 }
 
-/**
- * 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.
- */
-class HelperClass extends BaseContextClass {}
-
 /**
  * Singleton instance in App Worker, extend {@link EggApplicationCore}
  * @augments EggApplicationCore
@@ -53,7 +48,7 @@ export class Application extends EggApplicationCore {
    * reference to {@link Helper}
    * @member {Helper} Application#Helper
    */
-  Helper = HelperClass;
+  Helper = Helper;
 
   /**
    * @class
@@ -77,8 +72,7 @@ export class Application extends EggApplicationCore {
   }
 
   #responseRaw(socket: Socket, raw?: any) {
-    /* istanbul ignore next */
-    if (!socket.writable) return;
+    if (!socket?.writable) return;
     if (!raw) {
       return socket.end(DEFAULT_BAD_REQUEST_RESPONSE);
     }
@@ -152,7 +146,6 @@ export class Application extends EggApplicationCore {
     // set ignore code
     const serverGracefulIgnoreCode = this.config.serverGracefulIgnoreCode || [];
 
-    /* istanbul ignore next */
     graceful({
       server: [ server ],
       error: (err: Error, throwErrorCount: number) => {
@@ -228,13 +221,13 @@ export class Application extends EggApplicationCore {
    * @see Context#runInBackground
    * @param {Function} scope - the first args is an anonymous ctx
    */
-  runInBackground(scope: (ctx: EggContext) => void) {
-    const ctx = this.createAnonymousContext();
+  runInBackground(scope: (ctx: ContextDelegation) => Promise<void>, req?: unknown) {
+    const ctx = this.createAnonymousContext(req);
     if (!scope.name) {
       Reflect.set(scope, '_name', eggUtils.getCalleeFromStack(true));
     }
     this.ctxStorage.run(ctx, () => {
-      ctx.runInBackground(scope);
+      return ctx.runInBackground(scope);
     });
   }
 
@@ -244,13 +237,13 @@ export class Application extends EggApplicationCore {
    * @param {Function} scope - the first args is an anonymous ctx, scope should be async function
    * @param {Request} [req] - if you want to mock request like querystring, you can pass an object to this function.
    */
-  async runInAnonymousContextScope(scope: (ctx: EggContext) => Promise<void>, req?: unknown) {
+  async runInAnonymousContextScope(scope: (ctx: ContextDelegation) => Promise<void>, req?: unknown) {
     const ctx = this.createAnonymousContext(req);
     if (!scope.name) {
       Reflect.set(scope, '_name', eggUtils.getCalleeFromStack(true));
     }
     return await this.ctxStorage.run(ctx, async () => {
-      return await scope(ctx as EggContext);
+      return await scope(ctx);
     });
   }
 

package/src/lib/core/base_context_class.ts

@@ -1,5 +1,5 @@
 import { BaseContextClass as EggCoreBaseContextClass } from '@eggjs/core';
-import type { EggContext } from '../egg.js';
+import type { ContextDelegation } from '../egg.js';
 import { BaseContextLogger } from './base_context_logger.js';
 
 /**
@@ -8,7 +8,7 @@ import { BaseContextLogger } from './base_context_logger.js';
  * {@link Helper}, {@link Service} is extending it.
  */
 export class BaseContextClass extends EggCoreBaseContextClass {
-  declare ctx: EggContext;
+  declare ctx: ContextDelegation;
   protected pathName?: string;
   #logger?: BaseContextLogger;
 

package/src/lib/core/context_httpclient.ts

@@ -1,13 +1,13 @@
-import type { EggContext, EggApplicationCore } from '../egg.js';
+import type { ContextDelegation, EggApplicationCore } from '../egg.js';
 import type {
   HttpClientRequestURL, HttpClientRequestOptions,
 } from './httpclient.js';
 
 export class ContextHttpClient {
-  ctx: EggContext;
+  ctx: ContextDelegation;
   app: EggApplicationCore;
 
-  constructor(ctx: EggContext) {
+  constructor(ctx: ContextDelegation) {
     this.ctx = ctx;
     this.app = ctx.app;
   }

package/src/lib/core/httpclient.ts

@@ -1,11 +1,10 @@
-import { EggCoreContext } from '@eggjs/core';
 import {
   HttpClient as RawHttpClient,
   RequestURL as HttpClientRequestURL,
   RequestOptions,
 } from 'urllib';
-import ms from 'ms';
-import type { EggApplicationCore } from '../egg.js';
+import { ms } from 'humanize-ms';
+import type { EggApplicationCore, ContextDelegation } from '../egg.js';
 
 export type {
   HttpClientResponse,
@@ -13,7 +12,7 @@ export type {
 } from 'urllib';
 
 export interface HttpClientRequestOptions extends RequestOptions {
-  ctx?: EggCoreContext;
+  ctx?: ContextDelegation;
   tracer?: unknown;
 }
 
@@ -47,6 +46,6 @@ export class HttpClient extends RawHttpClient {
 function normalizeConfig(app: EggApplicationCore) {
   const config = app.config.httpclient;
   if (typeof config.request?.timeout === 'string') {
-    config.request.timeout = ms(config.request.timeout as string);
+    config.request.timeout = ms(config.request.timeout);
   }
 }

package/src/lib/core/messenger/ipc.ts

@@ -72,7 +72,6 @@ export class Messenger extends EventEmitter implements IMessenger {
    * @return {Messenger} this
    */
   sendRandom(action: string, data?: unknown): Messenger {
-    /* istanbul ignore if */
     if (this.opids.length === 0) {
       return this;
     }

package/src/lib/egg.ts

@@ -3,8 +3,18 @@ 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';
@@ -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,7 @@ 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';
 
 const EGG_PATH = Symbol.for('egg#eggPath');
 
@@ -39,20 +51,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 +87,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;
@@ -412,7 +440,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;
@@ -420,7 +447,6 @@ export class EggApplicationCore extends EggCore {
       }
       err = newError;
     }
-    /* istanbul ignore else */
     if (err.name === 'Error') {
       err.name = 'unhandledRejectionError';
     }
@@ -500,12 +526,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() {
@@ -589,7 +610,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',
@@ -633,7 +654,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/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,17 +9,15 @@ 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 IgnoreItem = string | RegExp | ((ctx: ContextDelegation) => boolean);
 type IgnoreOrMatch = IgnoreItem | IgnoreItem[];
 
-export type Next = () => Promise<void>;
-
 export interface ClientErrorResponse {
   body: string | Buffer;
   status: number;
@@ -103,7 +100,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;
   };
 
   /**
@@ -327,10 +324,3 @@ export interface EggAppConfig {
 
   [prop: string]: any;
 }
-
-export type {
-  EggLogger,
-} from 'egg-logger';
-export type {
-  ILifecycleBoot,
-} from '@eggjs/core';

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/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;
-  },
-};