egg 4.0.0-beta.0 → 4.0.0-beta.10

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/base_hook_class.ts

@@ -10,7 +10,7 @@ export class BaseHookClass implements ILifecycleBoot {
     this.#instance = instance;
   }
 
-  get logger() {
+  get logger(): any {
     return this.#instance.logger;
   }
 

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/IMessenger.ts

@@ -11,12 +11,12 @@ export interface IMessenger extends EventEmitter {
 
   /**
    * send message to the specified process
-   * @param {String} pid - the process id of the receiver
+   * @param {String} workerId - the workerId of the receiver
    * @param {String} action - message key
    * @param {Object} data - message value
    * @return {Messenger} this
    */
-  sendTo(pid: string, action: string, data?: unknown): IMessenger;
+  sendTo(workerId: string, action: string, data?: unknown): IMessenger;
 
   /**
    * send message to one app worker by random
@@ -50,7 +50,7 @@ export interface IMessenger extends EventEmitter {
    * @param {String} to - let master know how to send message
    * @return {Messenger} this
    */
-  send(action: string, data: unknown | undefined, to: string): IMessenger;
+  send(action: string, data: unknown | undefined, to?: string): IMessenger;
 
   close(): void;
 

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

@@ -11,5 +11,5 @@ export type { IMessenger } from './IMessenger.js';
 export function create(egg: EggApplicationCore): IMessenger {
   return egg.options.mode === 'single'
     ? new LocalMessenger(egg)
-    : new IPCMessenger();
+    : new IPCMessenger(egg);
 }

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

@@ -1,27 +1,30 @@
-
 import { EventEmitter } from 'node:events';
 import { debuglog } from 'node:util';
 import workerThreads from 'node:worker_threads';
-import sendmessage from 'sendmessage';
+import { sendmessage } from 'sendmessage';
 import type { IMessenger } from './IMessenger.js';
+import type { EggApplicationCore } from '../../egg.js';
 
-const debug = debuglog('egg:lib:core:messenger:ipc');
+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 {
   readonly pid: string;
+  readonly egg: EggApplicationCore;
   opids: string[] = [];
 
-  constructor() {
+  constructor(egg: EggApplicationCore) {
     super();
     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
-    this.on('egg-pids', pids => {
-      this.opids = pids;
+    this.on('egg-pids', workerIds => {
+      debug('[%s:%s] got egg-pids %j', this.egg.type, this.pid, workerIds);
+      this.opids = workerIds.map((workerId: number) => String(workerId));
     });
     this.onMessage = this.onMessage.bind(this);
     process.on('message', this.onMessage);
@@ -37,7 +40,7 @@ export class Messenger extends EventEmitter implements IMessenger {
    * @return {Messenger} this
    */
   broadcast(action: string, data?: unknown): Messenger {
-    debug('[%s] broadcast %s with %j', this.pid, action, data);
+    debug('[%s:%s] broadcast %s with %j', this.egg.type, this.pid, action, data);
     this.send(action, data, 'app');
     this.send(action, data, 'agent');
     return this;
@@ -45,17 +48,21 @@ export class Messenger extends EventEmitter implements IMessenger {
 
   /**
    * send message to the specified process
-   * @param {String} pid - the process id of the receiver
+   * @param {String} workerId - the workerId of the receiver
    * @param {String} action - message key
    * @param {Object} data - message value
    * @return {Messenger} this
    */
-  sendTo(pid: string, action: string, data?: unknown): Messenger {
-    debug('[%s] send %s with %j to %s', this.pid, action, data, pid);
+  sendTo(workerId: string, action: string, data?: unknown): Messenger {
+    debug('[%s:%s] send %s with %j to workerId:%s', this.egg.type, this.pid, action, data, workerId);
     sendmessage(process, {
       action,
       data,
-      receiverPid: String(pid),
+      /**
+       * @deprecated Keep compatible, please use receiverWorkerId instead
+       */
+      receiverPid: String(workerId),
+      receiverWorkerId: String(workerId),
     });
     return this;
   }
@@ -69,11 +76,13 @@ 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;
+    if (this.opids.length === 0) {
+      debug('[%s:%s] no pids, ignore sendRandom %s with %j', this.egg.type, this.pid, action, data);
+      return this;
+    }
     const index = Math.floor(Math.random() * this.opids.length);
-    const pid = this.opids[index];
-    this.sendTo(String(pid), action, data);
+    const workerId = this.opids[index];
+    this.sendTo(workerId, action, data);
     return this;
   }
 
@@ -84,7 +93,7 @@ export class Messenger extends EventEmitter implements IMessenger {
    * @return {Messenger} this
    */
   sendToApp(action: string, data?: unknown): Messenger {
-    debug('[%s] send %s with %j to all app', this.pid, action, data);
+    debug('[%s:%s] send %s with %j to all app', this.egg.type, this.pid, action, data);
     this.send(action, data, 'app');
     return this;
   }
@@ -96,7 +105,7 @@ export class Messenger extends EventEmitter implements IMessenger {
    * @return {Messenger} this
    */
   sendToAgent(action: string, data?: unknown): Messenger {
-    debug('[%s] send %s with %j to all agent', this.pid, action, data);
+    debug('[%s:%s] send %s with %j to all agent', this.egg.type, this.pid, action, data);
     this.send(action, data, 'agent');
     return this;
   }
@@ -107,7 +116,7 @@ export class Messenger extends EventEmitter implements IMessenger {
    * @param {String} to - let master know how to send message
    * @return {Messenger} this
    */
-  send(action: string, data: unknown | undefined, to: string): Messenger {
+  send(action: string, data: unknown | undefined, to?: string): Messenger {
     sendmessage(process, {
       action,
       data,
@@ -118,9 +127,11 @@ export class Messenger extends EventEmitter implements IMessenger {
 
   onMessage(message: any) {
     if (typeof message?.action === 'string') {
-      debug('[%s] got message %s with %j, receiverPid: %s',
-        this.pid, message.action, message.data, message.receiverPid);
+      debug('[%s:%s] got message %s with %j, receiverWorkerId: %s',
+        this.egg.type, this.pid, message.action, message.data, message.receiverWorkerId ?? message.receiverPid);
       this.emit(message.action, message.data);
+    } else {
+      debug('[%s:%s] got an invalid message %j', this.egg.type, this.pid, message);
     }
   }
 

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

@@ -3,7 +3,7 @@ import EventEmitter from 'node:events';
 import type { IMessenger } from './IMessenger.js';
 import type { EggApplicationCore } from '../../egg.js';
 
-const debug = debuglog('egg:lib:core:messenger:local');
+const debug = debuglog('egg/lib/core/messenger/local');
 
 /**
  * Communication between app worker and agent worker with EventEmitter
@@ -25,7 +25,7 @@ export class Messenger extends EventEmitter implements IMessenger {
    * @return {Messenger} this
    */
   broadcast(action: string, data?: unknown): Messenger {
-    debug('[%s] broadcast %s with %j', this.pid, action, data);
+    debug('[%s:%s] broadcast %s with %j', this.egg.type, this.pid, action, data);
     this.send(action, data, 'both');
     return this;
   }
@@ -34,14 +34,14 @@ export class Messenger extends EventEmitter implements IMessenger {
    * send message to the specified process
    * Notice: in single process mode, it only can send to self process,
    * and it will send to both agent and app's messengers.
-   * @param {String} pid - the process id of the receiver
+   * @param {String} workerId - the workerId of the receiver
    * @param {String} action - message key
    * @param {Object} data - message value
    * @return {Messenger} this
    */
-  sendTo(pid: string, action: string, data?: unknown): Messenger {
-    debug('[%s] send %s with %j to %s', this.pid, action, data, pid);
-    if (String(pid) !== this.pid) {
+  sendTo(workerId: string, action: string, data?: unknown): Messenger {
+    debug('[%s:%s] send %s with %j to %s', this.egg.type, this.pid, action, data, workerId);
+    if (String(workerId) !== this.pid) {
       return this;
     }
     this.send(action, data, 'both');
@@ -58,7 +58,7 @@ export class Messenger extends EventEmitter implements IMessenger {
    * @return {Messenger} this
    */
   sendRandom(action: string, data?: unknown): Messenger {
-    debug('[%s] send %s with %j to opposite', this.pid, action, data);
+    debug('[%s:%s] send %s with %j to opposite', this.egg.type, this.pid, action, data);
     this.send(action, data, 'opposite');
     return this;
   }
@@ -70,7 +70,7 @@ export class Messenger extends EventEmitter implements IMessenger {
    * @return {Messenger} this
    */
   sendToApp(action: string, data?: unknown): Messenger {
-    debug('[%s] send %s with %j to all app', this.pid, action, data);
+    debug('[%s:%s] send %s with %j to all app', this.egg.type, this.pid, action, data);
     this.send(action, data, 'application');
     return this;
   }
@@ -82,7 +82,7 @@ export class Messenger extends EventEmitter implements IMessenger {
    * @return {Messenger} this
    */
   sendToAgent(action: string, data?: unknown): Messenger {
-    debug('[%s] send %s with %j to all agent', this.pid, action, data);
+    debug('[%s:%s] send %s with %j to all agent', this.egg.type, this.pid, action, data);
     this.send(action, data, 'agent');
     return this;
   }
@@ -93,7 +93,7 @@ export class Messenger extends EventEmitter implements IMessenger {
    * @param {String} to - let master know how to send message
    * @return {Messenger} this
    */
-  send(action: string, data: unknown | undefined, to: string): Messenger {
+  send(action: string, data: unknown | undefined, to?: string): Messenger {
     // use nextTick to keep it async as IPC messenger
     process.nextTick(() => {
       const { egg } = this;
@@ -130,8 +130,10 @@ export class Messenger extends EventEmitter implements IMessenger {
 
   onMessage(message: any) {
     if (typeof message?.action === 'string') {
-      debug('[%s] got message %s with %j', this.pid, message.action, message.data);
+      debug('[%s:%s] got message %s with %j', this.egg.type, this.pid, message.action, message.data);
       this.emit(message.action, message.data);
+    } else {
+      debug('[%s:%s] got an invalid message %j', this.egg.type, this.pid, message);
     }
   }
 

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);
+}