egg 4.0.0-beta.9 → 4.0.1

package/src/app/middleware/notfound.ts

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

package/src/app/middleware/site_file.ts

@@ -1,9 +1,9 @@
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { readFile } from 'node:fs/promises';
-import type { Next, ContextDelegation } from '../../lib/egg.js';
+import type { Next, Context } from '../../lib/egg.js';
 
-export type SiteFileContentFun = (ctx: ContextDelegation) => Promise<Buffer | string>;
+export type SiteFileContentFun = (ctx: Context) => Promise<Buffer | string>;
 
 export interface SiteFileMiddlewareOptions {
   enable: boolean;
@@ -14,7 +14,7 @@ export interface SiteFileMiddlewareOptions {
 const BUFFER_CACHE = Symbol('siteFile URL buffer cache');
 
 export default (options: SiteFileMiddlewareOptions) => {
-  return async function siteFile(ctx: ContextDelegation, next: Next) {
+  return async function siteFile(ctx: Context, next: Next) {
     if (ctx.method !== 'HEAD' && ctx.method !== 'GET') {
       return next();
     }

package/src/config/config.default.ts

@@ -1,7 +1,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 type { EggAppConfig } from '../lib/types.js';
 import { getSourceFile } from '../lib/utils.js';
 
 /**

package/src/config/config.local.ts

@@ -1,4 +1,4 @@
-import type { EggAppConfig } from '../lib/type.js';
+import type { EggAppConfig } from '../lib/types.js';
 
 export default () => {
   return {

package/src/config/config.unittest.ts

@@ -1,4 +1,4 @@
-import type { EggAppConfig } from '../lib/type.js';
+import type { EggAppConfig } from '../lib/types.js';
 
 export default () => {
   return {

package/src/config/plugin.ts

@@ -1,6 +1,4 @@
 export default {
-  // enable plugins
-
   /**
    * app global Error Handling
    * @member {Object} Plugin#onerror
@@ -30,7 +28,7 @@ export default {
    */
   i18n: {
     enable: true,
-    package: 'egg-i18n',
+    package: '@eggjs/i18n',
   },
 
   /**
@@ -74,7 +72,7 @@ export default {
    */
   development: {
     enable: true,
-    package: 'egg-development',
+    package: '@eggjs/development',
   },
 
   /**
@@ -107,7 +105,7 @@ export default {
    */
   static: {
     enable: true,
-    package: 'egg-static',
+    package: '@eggjs/static',
   },
 
   /**
@@ -118,7 +116,7 @@ export default {
    */
   jsonp: {
     enable: true,
-    package: 'egg-jsonp',
+    package: '@eggjs/jsonp',
   },
 
   /**

package/src/index.ts

@@ -3,17 +3,40 @@
  */
 
 import { BaseContextClass } from './lib/core/base_context_class.js';
-import { startEgg } from './lib/start.js';
+import {
+  startEgg,
+  SingleModeApplication,
+  SingleModeAgent,
+} from './lib/start.js';
 import Helper from './app/extend/helper.js';
 
 // export extends
-export { Helper };
+export {
+  Helper,
+};
+export type {
+  // keep compatible with egg v3
+  Helper as IHelper,
+};
 
 // export types
 export * from './lib/egg.js';
-export * from './lib/type.js';
+export * from './lib/types.js';
 export * from './lib/start.js';
 
+// export errors
+export * from './lib/error/index.js';
+
+// export loggers
+export type {
+  LoggerLevel,
+  EggLogger,
+} from 'egg-logger';
+
+// export httpClients
+export * from './lib/core/httpclient.js';
+export * from './lib/core/context_httpclient.js';
+
 /**
  * Start egg application with cluster mode
  * @since 1.0.0
@@ -24,7 +47,11 @@ export * from '@eggjs/cluster';
  * Start egg application with single process mode
  * @since 1.0.0
  */
-export const start = startEgg;
+export {
+  startEgg as start,
+  SingleModeApplication,
+  SingleModeAgent,
+};
 
 /**
  * @member {Application} Egg#Application
@@ -54,19 +81,25 @@ export { AppWorkerLoader, AgentWorkerLoader } from './lib/loader/index.js';
  * @member {Controller} Egg#Controller
  * @since 1.1.0
  */
-export const Controller = BaseContextClass;
+export {
+  BaseContextClass as Controller,
+};
 
 /**
  * @member {Service} Egg#Service
  * @since 1.1.0
  */
-export const Service = BaseContextClass;
+export {
+  BaseContextClass as Service,
+};
 
 /**
  * @member {Subscription} Egg#Subscription
  * @since 1.10.0
  */
-export const Subscription = BaseContextClass;
+export {
+  BaseContextClass as Subscription,
+};
 
 /**
  * @member {BaseContextClass} Egg#BaseContextClass

package/src/lib/agent.ts

@@ -1,4 +1,4 @@
-import { EggLogger } from 'egg-logger';
+import type { EggLogger } from 'egg-logger';
 import { EggApplicationCore, EggApplicationCoreOptions } from './egg.js';
 import { AgentWorkerLoader } from './loader/index.js';
 

package/src/lib/application.ts

@@ -5,13 +5,15 @@ import { Socket } from 'node:net';
 import { graceful } from 'graceful';
 import { assign } from 'utility';
 import { utils as eggUtils } from '@eggjs/core';
+import { isGeneratorFunction } from 'is-type-of';
 import {
   EggApplicationCore,
   type EggApplicationCoreOptions,
-  type ContextDelegation,
+  type Context,
 } from './egg.js';
 import { AppWorkerLoader } from './loader/index.js';
 import Helper from '../app/extend/helper.js';
+import { CookieLimitExceedError } from './error/index.js';
 
 const EGG_LOADER = Symbol.for('egg#loader');
 
@@ -221,7 +223,7 @@ export class Application extends EggApplicationCore {
    * @see Context#runInBackground
    * @param {Function} scope - the first args is an anonymous ctx
    */
-  runInBackground(scope: (ctx: ContextDelegation) => Promise<void>, req?: unknown) {
+  runInBackground(scope: (ctx: Context) => Promise<void>, req?: unknown) {
     const ctx = this.createAnonymousContext(req);
     if (!scope.name) {
       Reflect.set(scope, '_name', eggUtils.getCalleeFromStack(true));
@@ -237,7 +239,7 @@ 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: ContextDelegation) => Promise<void>, req?: unknown) {
+  async runInAnonymousContextScope(scope: (ctx: Context) => Promise<void>, req?: unknown) {
     const ctx = this.createAnonymousContext(req);
     if (!scope.name) {
       Reflect.set(scope, '_name', eggUtils.getCalleeFromStack(true));
@@ -266,16 +268,26 @@ export class Application extends EggApplicationCore {
     return this._keys;
   }
 
+  /**
+   * @deprecated keep compatible with egg 3.x
+   */
+  toAsyncFunction(fn: (...args: any[]) => any) {
+    if (isGeneratorFunction(fn)) {
+      throw new Error('Generator function is not supported');
+    }
+    return fn;
+  }
+
   /**
    * bind app's events
    *
    * @private
    */
   #bindEvents() {
-    // Browser Cookie Limits: http://browsercookielimits.squawky.net/
+    // Browser Cookie Limits: http://browsercookielimits.iain.guru/
+    // https://github.com/eggjs/egg-cookies/blob/58ef4ea497a0eb4dd711d7e9751e56bc5fcee004/src/cookies.ts#L145
     this.on('cookieLimitExceed', ({ name, value, ctx }) => {
-      const err = new Error(`cookie ${name}'s length(${value.length}) exceed the limit(4093)`);
-      err.name = 'CookieLimitExceedError';
+      const err = new CookieLimitExceedError(name, value);
       ctx.coreLogger.error(err);
     });
     // expose server to support websocket

package/src/lib/core/base_context_class.ts

@@ -1,5 +1,5 @@
 import { BaseContextClass as EggCoreBaseContextClass } from '@eggjs/core';
-import type { ContextDelegation } from '../egg.js';
+import type { Context, EggApplicationCore } from '../egg.js';
 import { BaseContextLogger } from './base_context_logger.js';
 
 /**
@@ -8,8 +8,11 @@ import { BaseContextLogger } from './base_context_logger.js';
  * {@link Helper}, {@link Service} is extending it.
  */
 export class BaseContextClass extends EggCoreBaseContextClass {
-  declare ctx: ContextDelegation;
-  protected pathName?: string;
+  [key: string | symbol]: any;
+  declare ctx: Context;
+  declare pathName?: string;
+  declare app: EggApplicationCore;
+  declare service: BaseContextClass;
   #logger?: BaseContextLogger;
 
   get logger() {

package/src/lib/core/base_hook_class.ts

@@ -3,14 +3,14 @@ import type { ILifecycleBoot } from '@eggjs/core';
 import type { Application, Agent } from '../../index.js';
 
 export class BaseHookClass implements ILifecycleBoot {
-  fullPath?: string;
+  declare fullPath?: string;
   #instance: Application | Agent;
 
   constructor(instance: Application | Agent) {
     this.#instance = instance;
   }
 
-  get logger(): any {
+  get logger() {
     return this.#instance.logger;
   }
 

package/src/lib/core/context_httpclient.ts

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

package/src/lib/core/httpclient.ts

@@ -2,29 +2,36 @@ import {
   HttpClient as RawHttpClient,
   RequestURL as HttpClientRequestURL,
   RequestOptions,
+  ClientOptions as HttpClientOptions,
 } from 'urllib';
 import { ms } from 'humanize-ms';
-import type { EggApplicationCore, ContextDelegation } from '../egg.js';
+import type { EggApplicationCore } from '../egg.js';
 
 export type {
   HttpClientResponse,
   RequestURL as HttpClientRequestURL,
+  ClientOptions as HttpClientOptions,
 } from 'urllib';
 
 export interface HttpClientRequestOptions extends RequestOptions {
-  ctx?: ContextDelegation;
-  tracer?: unknown;
+  ctx?: any;
+  tracer?: any;
 }
 
 export class HttpClient extends RawHttpClient {
-  readonly #app: EggApplicationCore & { tracer?: unknown };
+  readonly #app: EggApplicationCore & { tracer?: any };
 
-  constructor(app: EggApplicationCore) {
+  constructor(app: EggApplicationCore, options: HttpClientOptions = {}) {
     normalizeConfig(app);
     const config = app.config.httpclient;
-    super({
-      defaultArgs: config.request,
-    });
+    const initOptions: HttpClientOptions = {
+      ...options,
+      defaultArgs: {
+        ...config.request,
+        ...options.defaultArgs,
+      },
+    };
+    super(initOptions);
     this.#app = app;
   }
 
@@ -43,6 +50,12 @@ export class HttpClient extends RawHttpClient {
   }
 }
 
+// keep compatible
+export type {
+  HttpClient as EggHttpClient,
+  HttpClient as EggContextHttpClient,
+};
+
 function normalizeConfig(app: EggApplicationCore) {
   const config = app.config.httpclient;
   if (typeof config.request?.timeout === 'string') {

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

@@ -0,0 +1,30 @@
+import { EventEmitter, captureRejectionSymbol } from 'node:events';
+import { MessageUnhandledRejectionError } from '../../error/index.js';
+import { EggApplicationCore } from '../../egg.js';
+
+export class BaseMessenger extends EventEmitter {
+  protected readonly egg: EggApplicationCore;
+
+  constructor(egg: EggApplicationCore) {
+    super({ captureRejections: true });
+    this.egg = egg;
+  }
+
+  [captureRejectionSymbol](err: Error, event: string | symbol, ...args: any[]) {
+    this.egg.coreLogger.error(new MessageUnhandledRejectionError(err, event, args));
+  }
+
+  emit(eventName: string | symbol, ...args: any[]): boolean {
+    const hasListeners = this.listenerCount(eventName) > 0;
+    try {
+      return super.emit(eventName, ...args);
+    } catch (e: unknown) {
+      let err = e as Error;
+      if (!(err instanceof Error)) {
+        err = new Error(String(err));
+      }
+      this.egg.coreLogger.error(new MessageUnhandledRejectionError(err, eventName, args));
+      return hasListeners;
+    }
+  }
+}

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

@@ -9,7 +9,8 @@ export type { IMessenger } from './IMessenger.js';
  * @class Messenger
  */
 export function create(egg: EggApplicationCore): IMessenger {
-  return egg.options.mode === 'single'
+  const messenger = egg.options.mode === 'single'
     ? new LocalMessenger(egg)
     : new IPCMessenger(egg);
+  return messenger;
 }

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

@@ -1,24 +1,22 @@
-import { EventEmitter } from 'node:events';
 import { debuglog } from 'node:util';
 import workerThreads from 'node:worker_threads';
 import { sendmessage } from 'sendmessage';
 import type { IMessenger } from './IMessenger.js';
 import type { EggApplicationCore } from '../../egg.js';
+import { BaseMessenger } from './base.js';
 
 const debug = debuglog('egg/lib/core/messenger/ipc');
 
 /**
  * Communication between app worker and agent worker by IPC channel
  */
-export class Messenger extends EventEmitter implements IMessenger {
+export class Messenger extends BaseMessenger implements IMessenger {
   readonly pid: string;
-  readonly egg: EggApplicationCore;
   opids: string[] = [];
 
   constructor(egg: EggApplicationCore) {
-    super();
+    super(egg);
     this.pid = String(process.pid);
-    this.egg = egg;
     // pids of agent or app managed by master
     // - retrieve app worker pids when it's an agent worker
     // - retrieve agent worker pids when it's an app worker

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

@@ -1,20 +1,18 @@
 import { debuglog } from 'node:util';
-import EventEmitter from 'node:events';
 import type { IMessenger } from './IMessenger.js';
 import type { EggApplicationCore } from '../../egg.js';
+import { BaseMessenger } from './base.js';
 
 const debug = debuglog('egg/lib/core/messenger/local');
 
 /**
  * Communication between app worker and agent worker with EventEmitter
  */
-export class Messenger extends EventEmitter implements IMessenger {
+export class Messenger extends BaseMessenger implements IMessenger {
   readonly pid: string;
-  readonly egg: EggApplicationCore;
 
   constructor(egg: EggApplicationCore) {
-    super();
-    this.egg = egg;
+    super(egg);
     this.pid = String(process.pid);
   }
 

package/src/lib/core/utils.ts

@@ -4,7 +4,7 @@ import {
   isClass, isFunction, isGeneratorFunction, isAsyncFunction,
 } from 'is-type-of';
 
-export function convertObject(obj: any, ignore: string | RegExp | (string | RegExp)[]) {
+export function convertObject(obj: any, ignore: string | RegExp | (string | RegExp)[] = []) {
   if (!Array.isArray(ignore)) {
     ignore = [ ignore ];
   }
@@ -30,7 +30,7 @@ function convertValue(key: string, value: any, ignore: (string | RegExp)[]) {
     }
   }
   if (!hit) {
-    if (isSymbol(value) || isRegExp(value)) {
+    if (isSymbol(value) || isRegExp(value) || value instanceof URL) {
       return value.toString();
     }
     if (isPrimitive(value) || Array.isArray(value)) {

package/src/lib/egg.ts

@@ -26,12 +26,14 @@ 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 Context from '../app/extend/context.js';
+import type { EggAppConfig } from './types.js';
 import { create as createMessenger, IMessenger } from './core/messenger/index.js';
 import { ContextHttpClient } from './core/context_httpclient.js';
 import {
-  HttpClient, type HttpClientRequestOptions, type HttpClientRequestURL, type HttpClientResponse,
+  HttpClient,
+  type HttpClientRequestOptions, type HttpClientRequestURL, type HttpClientResponse,
+  type HttpClientOptions,
 } from './core/httpclient.js';
 import { createLoggers } from './core/logger.js';
 import {
@@ -43,8 +45,6 @@ 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');
 
 export interface EggApplicationCoreOptions extends Omit<EggCoreOptions, 'baseDir'> {
@@ -53,34 +53,34 @@ export interface EggApplicationCoreOptions extends Omit<EggCoreOptions, 'baseDir
   baseDir?: string;
 }
 
-// export egg classes
-export {
-  Context,
-  Router,
-  EggLogger,
-};
-
 export class Request extends EggCoreRequest {
   declare app: EggCore;
   declare response: Response;
-  declare ctx: ContextDelegation;
+  declare ctx: Context;
 }
 
 export class Response extends EggCoreResponse {
   declare app: EggCore;
   declare request: Request;
-  declare ctx: ContextDelegation;
+  declare ctx: Context;
 }
 
 // export egg types
 export type {
-  ContextDelegation,
   ILifecycleBoot,
+  // keep compatible with egg version 3.x
+  ILifecycleBoot as IBoot,
   Next,
 };
 // keep compatible with egg version 3.x
-export type EggContext = ContextDelegation;
-export type MiddlewareFunc<T extends ContextDelegation = ContextDelegation> = EggCoreMiddlewareFunc<T>;
+export type EggContext = Context;
+export type MiddlewareFunc<T extends Context = Context> = EggCoreMiddlewareFunc<T>;
+
+// export egg classes
+export {
+  Context,
+  Router,
+};
 
 /**
  * Based on koa's Application
@@ -89,12 +89,14 @@ export type MiddlewareFunc<T extends ContextDelegation = ContextDelegation> = Eg
  * @augments EggCore
  */
 export class EggApplicationCore extends EggCore {
-  declare ctxStorage: AsyncLocalStorage<ContextDelegation>;
+  declare ctxStorage: AsyncLocalStorage<Context>;
   // export context base classes, let framework can impl sub class and over context extend easily.
   ContextCookies = ContextCookies;
   ContextLogger = ContextLogger;
   ContextHttpClient = ContextHttpClient;
   HttpClient = HttpClient;
+  // keep compatible with egg version 3.x
+  HttpClientNext = HttpClient;
   /**
    * Retrieve base context class
    * @member {BaseContextClass} BaseContextClass
@@ -132,6 +134,7 @@ export class EggApplicationCore extends EggCore {
   /**
    * Retrieve base boot
    * @member {Boot}
+   * @alias BaseHookClass
    */
   Boot = BaseHookClass;
 
@@ -233,6 +236,13 @@ export class EggApplicationCore extends EggCore {
     await this.loader.load();
   }
 
+  /**
+   * Usage: new ApiClient({ cluster: app.cluster })
+   */
+  get cluster() {
+    return this.clusterWrapper.bind(this);
+  }
+
   /**
    * Wrap the Client with Leader/Follower Pattern
    *
@@ -251,7 +261,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) {
+  clusterWrapper(clientClass: unknown, options?: object) {
     const clientClassOptions = {
       ...this.config.clusterClient,
       ...options,
@@ -377,14 +387,22 @@ export class EggApplicationCore extends EggCore {
     return await this.httpClient.request<T>(url, options);
   }
 
+  /**
+   * Create a new HttpClient instance with custom options
+   * @param {Object} [options] HttpClient init options
+   */
+  createHttpClient(options?: HttpClientOptions): HttpClient {
+    return new this.HttpClient(this, options);
+  }
+
   /**
    * HttpClient instance
    * @see https://github.com/node-modules/urllib
    * @member {HttpClient}
    */
-  get httpClient() {
+  get httpClient(): HttpClient {
     if (!this.#httpClient) {
-      this.#httpClient = new this.HttpClient(this);
+      this.#httpClient = this.createHttpClient();
     }
     return this.#httpClient;
   }
@@ -439,6 +457,7 @@ export class EggApplicationCore extends EggCore {
   }
 
   _unhandledRejectionHandler(err: any) {
+    this.coreLogger.error('[egg:unhandledRejection] %s', err && err.message || err);
     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
@@ -652,8 +671,8 @@ export class EggApplicationCore extends EggCore {
    * @param  {Res} res - node native Response object
    * @return {Context} context object
    */
-  createContext(req: IncomingMessage, res: ServerResponse): EggContext {
-    const context = Object.create(this.context) as EggContext;
+  createContext(req: IncomingMessage, res: ServerResponse): Context {
+    const context = Object.create(this.context) as Context;
     const request = context.request = Object.create(this.request);
     const response = context.response = Object.create(this.response);
     context.app = request.app = response.app = this as any;
@@ -669,3 +688,19 @@ export class EggApplicationCore extends EggCore {
     return context;
   }
 }
+
+declare module '@eggjs/core' {
+  // add EggApplicationCore overrides types
+  interface EggCore {
+    inspect(): any;
+    get currentContext(): EggContext | undefined;
+    ctxStorage: AsyncLocalStorage<EggContext>;
+    get logger(): EggLogger;
+    get coreLogger(): EggLogger;
+    getLogger(name: string): EggLogger;
+    createHttpClient(options?: HttpClientOptions): HttpClient;
+    HttpClient: typeof HttpClient;
+    get httpClient(): HttpClient;
+    curl<T = any>(url: HttpClientRequestURL, options?: HttpClientRequestOptions): Promise<HttpClientResponse<T>>;
+  }
+}