egg 4.0.0-beta.12 → 4.0.0-beta.13

package/src/index.ts

@@ -7,13 +7,32 @@ import { startEgg } 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 +43,9 @@ export * from '@eggjs/cluster';
  * Start egg application with single process mode
  * @since 1.0.0
  */
-export const start = startEgg;
+export {
+  startEgg as start,
+};
 
 /**
  * @member {Application} Egg#Application
@@ -54,19 +75,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

@@ -4,7 +4,7 @@ import {
   RequestOptions,
 } from 'urllib';
 import { ms } from 'humanize-ms';
-import type { EggApplicationCore, ContextDelegation } from '../egg.js';
+import type { EggApplicationCore } from '../egg.js';
 
 export type {
   HttpClientResponse,
@@ -12,12 +12,12 @@ export type {
 } 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) {
     normalizeConfig(app);
@@ -43,6 +43,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,8 +26,8 @@ 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 {
@@ -56,30 +56,30 @@ export interface EggApplicationCoreOptions extends Omit<EggCoreOptions, 'baseDir
 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,
-  EggLogger,
 };
 
 /**
@@ -89,12 +89,14 @@ export {
  * @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,
@@ -439,6 +449,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 +663,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;

package/src/lib/egg.types.ts

@@ -1,11 +1,15 @@
-import { AsyncLocalStorage } from 'node:async_hooks';
-import { ContextDelegation } from '../app/extend/context.js';
+import type { AsyncLocalStorage } from 'node:async_hooks';
+import type EggContext from '../app/extend/context.js';
+import type { EggLogger } from 'egg-logger';
 
 declare module '@eggjs/core' {
   // add EggApplicationCore overrides types
   interface EggCore {
     inspect(): any;
-    get currentContext(): ContextDelegation | undefined;
-    ctxStorage: AsyncLocalStorage<ContextDelegation>;
+    get currentContext(): EggContext | undefined;
+    ctxStorage: AsyncLocalStorage<EggContext>;
+    get logger(): EggLogger;
+    get coreLogger(): EggLogger;
+    getLogger(name: string): EggLogger;
   }
 }

package/src/lib/error/CookieLimitExceedError.ts

@@ -0,0 +1,12 @@
+export class CookieLimitExceedError extends Error {
+  key: string;
+  cookie: string;
+
+  constructor(key: string, cookie: string) {
+    super(`cookie ${key}'s length(${cookie.length}) exceed the limit(4093)`);
+    this.name = this.constructor.name;
+    this.key = key;
+    this.cookie = cookie;
+    Error.captureStackTrace(this, this.constructor);
+  }
+}

package/src/lib/error/MessageUnhandledRejectionError.ts

@@ -0,0 +1,12 @@
+export class MessageUnhandledRejectionError extends Error {
+  event: string | symbol;
+  args: any[];
+
+  constructor(err: Error, event: string | symbol, ...args: any[]) {
+    super(`event: ${String(event)}, error: ${err.message}`, { cause: err });
+    this.name = this.constructor.name;
+    this.event = event;
+    this.args = args;
+    Error.captureStackTrace(this, this.constructor);
+  }
+}

package/src/lib/error/index.ts

@@ -0,0 +1,2 @@
+export * from './CookieLimitExceedError.js';
+export * from './MessageUnhandledRejectionError.js';

package/src/lib/{type.ts → types.ts}

@@ -9,7 +9,7 @@ import type {
   FileLoaderOptions,
 } from '@eggjs/core';
 import type {
-  EggApplicationCore, ContextDelegation,
+  EggApplicationCore, Context,
 } from './egg.js';
 import type { MetaMiddlewareOptions } from '../app/middleware/meta.js';
 import type { NotFoundMiddlewareOptions } from '../app/middleware/notfound.js';
@@ -18,7 +18,7 @@ import type { SiteFileMiddlewareOptions } from '../app/middleware/site_file.js';
 // import @eggjs/watcher types
 // import '@eggjs/watcher';
 
-type IgnoreItem = string | RegExp | ((ctx: ContextDelegation) => boolean);
+type IgnoreItem = string | RegExp | ((ctx: Context) => boolean);
 type IgnoreOrMatch = IgnoreItem | IgnoreItem[];
 
 export interface ClientErrorResponse {
@@ -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: ContextDelegation): void;
+    onerror(err: any, ctx: Context): void;
   };
 
   /**
@@ -136,6 +136,10 @@ export interface EggAppConfig {
     timeout?: number;
     /** Default request args for httpclient */
     request?: HttpClientRequestOptions;
+    /**
+     * @deprecated keep compatible with egg 3.x, no more used
+     */
+    useHttpClientNext?: boolean;
   };
 
   development: {
@@ -327,3 +331,37 @@ export interface EggAppConfig {
 
   [prop: string]: any;
 }
+
+export type RequestObjectBody = Record<string, any>;
+
+/**
+ * plugin config item interface
+ */
+export interface IEggPluginItem {
+  env?: EggEnvType[];
+  path?: string;
+  package?: string;
+  enable?: boolean;
+}
+
+export type EggPluginItem = IEggPluginItem | boolean;
+
+/**
+ * build-in plugin list
+ */
+export interface EggPlugin {
+  [key: string]: EggPluginItem | undefined;
+  onerror?: EggPluginItem;
+  session?: EggPluginItem;
+  i18n?: EggPluginItem;
+  watcher?: EggPluginItem;
+  multipart?: EggPluginItem;
+  security?: EggPluginItem;
+  development?: EggPluginItem;
+  logrotator?: EggPluginItem;
+  schedule?: EggPluginItem;
+  static?: EggPluginItem;
+  jsonp?: EggPluginItem;
+  view?: EggPluginItem;
+}
+

package/dist/esm/lib/type.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvdHlwZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=