egg 4.0.0-beta.6 → 4.0.0-beta.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "egg",
-  "version": "4.0.0-beta.6",
+  "version": "4.0.0-beta.8",
   "engines": {
     "node": ">= 18.19.0"
   },
@@ -21,10 +21,10 @@
   "dependencies": {
     "@eggjs/cluster": "beta",
     "@eggjs/cookies": "^3.0.0",
-    "@eggjs/core": "^6.2.3",
-    "@eggjs/schedule": "^5.0.1",
-    "@eggjs/utils": "^4.0.2",
-    "@eggjs/watcher": "^4.0.0",
+    "@eggjs/core": "beta",
+    "@eggjs/schedule": "^5.0.2",
+    "@eggjs/utils": "^4.1.5",
+    "@eggjs/watcher": "^4.0.1",
     "circular-json-for-egg": "^1.0.0",
     "cluster-client": "^3.7.0",
     "delegates": "^1.0.0",
@@ -55,7 +55,9 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
+    "@eggjs/bin": "^7.0.0",
     "@eggjs/koa": "^2.19.1",
+    "@eggjs/mock": "beta",
     "@eggjs/tsconfig": "1",
     "@types/delegates": "^1.0.3",
     "@types/koa-bodyparser": "^4.3.12",
@@ -67,8 +69,6 @@
     "assert-file": "1",
     "coffee": "5",
     "cross-env": "7",
-    "egg-bin": "beta",
-    "egg-mock": "beta",
     "egg-plugin-puml": "^2.4.0",
     "egg-tracer": "^2.1.0",
     "egg-view-nunjucks": "^2.3.0",
@@ -76,8 +76,10 @@
     "eslint-config-egg": "14",
     "formstream": "^1.5.1",
     "koa-static": "^5.0.0",
+    "mm": "^3.4.0",
     "pedding": "^1.1.0",
     "prettier": "^2.7.1",
+    "rimraf": "6",
     "runscript": "^2.0.1",
     "sdk-base": "^4.2.1",
     "spy": "^1.0.0",
@@ -87,13 +89,16 @@
     "typescript": "5"
   },
   "scripts": {
+    "clean": "rimraf dist",
     "lint": "eslint src test --ext .ts",
-    "pretest": "npm run lint -- --fix && npm run prepublishOnly",
+    "pretest": "npm run clean && npm run lint -- --fix",
     "test": "egg-bin test",
+    "test-local": "egg-bin test",
     "test:changed": "egg-bin test --changed",
-    "preci": "npm run lint && npm run prepublishOnly && attw --pack",
+    "preci": "npm run clean &&  npm run lint",
     "ci": "egg-bin cov",
-    "prepublishOnly": "tshy && tshy-after",
+    "postci": "npm run prepublishOnly && npm run clean",
+    "prepublishOnly": "tshy && tshy-after && attw --pack",
     "site:dev": "cross-env NODE_OPTIONS=--openssl-legacy-provider APP_ROOT=./site dumi dev",
     "site:devWithNode14-16": "cross-env APP_ROOT=./site dumi dev",
     "site:build": "cross-env NODE_OPTIONS=--openssl-legacy-provider APP_ROOT=./site dumi build",
@@ -107,11 +112,15 @@
     "url": "git://github.com/eggjs/egg.git"
   },
   "license": "MIT",
+  "tnpm": {
+    "mode": "npm"
+  },
   "egg": {
     "framework": true,
     "exports": {
       "import": "./dist/esm",
-      "require": "./dist/commonjs"
+      "require": "./dist/commonjs",
+      "typescript": "./src"
     }
   },
   "files": [

package/src/app/extend/context.ts

@@ -6,12 +6,18 @@ import {
   type ContextDelegation as EggCoreContextDelegation,
 } from '@eggjs/core';
 import type { Cookies as ContextCookies } from '@eggjs/cookies';
+import { EggLogger } from 'egg-logger';
 import type { Application } from '../../lib/application.js';
+import type {
+  HttpClientRequestURL, HttpClientRequestOptions, HttpClient,
+} from '../../lib/core/httpclient.js';
 import type { ContextHttpClient } from '../../lib/core/context_httpclient.js';
 import type { BaseContextClass } from '../../lib//core/base_context_class.js';
 import Request from './request.js';
 import Response from './response.js';
-import { EggLogger } from 'egg-logger';
+import type Helper from './helper.js';
+
+import './context.types.js';
 
 const HELPER = Symbol('ctx helper');
 const LOCALS = Symbol('ctx locals');
@@ -79,7 +85,7 @@ export default class Context extends EggCoreContext {
    * @param {Object} [options] - options for request.
    * @return {Object} see {@link ContextHttpClient#curl}
    */
-  async curl(url: string, options?: object): ReturnType<ContextHttpClient['curl']> {
+  async curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']> {
     return await this.httpclient.curl(url, options);
   }
 
@@ -114,11 +120,11 @@ export default class Context extends EggCoreContext {
    * @member {Helper} Context#helper
    * @since 1.0.0
    */
-  get helper() {
+  get helper(): Helper {
     if (!this[HELPER]) {
       this[HELPER] = new this.app.Helper(this as any);
     }
-    return this[HELPER];
+    return this[HELPER] as Helper;
   }
 
   /**

package/src/app/extend/context.types.ts

@@ -0,0 +1,24 @@
+import type {
+  Router,
+} from '@eggjs/core';
+import type {
+  HttpClientRequestURL, HttpClientRequestOptions, HttpClient,
+} from '../../lib/core/httpclient.js';
+import type {
+  ContextHttpClient,
+} from '../../lib/core/context_httpclient.js';
+import type Helper from './helper.js';
+import type { EggLogger } from 'egg-logger';
+
+declare module '@eggjs/core' {
+  // add Context overrides types
+  interface Context {
+    curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']>;
+    get router(): Router;
+    set router(val: Router);
+    get helper(): Helper;
+    get httpclient(): ContextHttpClient;
+    get httpClient(): ContextHttpClient;
+    getLogger(name: string): EggLogger;
+  }
+}

package/src/app/middleware/site_file.ts

@@ -13,7 +13,7 @@ export interface SiteFileMiddlewareOptions {
 
 const BUFFER_CACHE = Symbol('siteFile URL buffer cache');
 
-module.exports = (options: SiteFileMiddlewareOptions) => {
+export default (options: SiteFileMiddlewareOptions) => {
   return async function siteFile(ctx: ContextDelegation, next: Next) {
     if (ctx.method !== 'HEAD' && ctx.method !== 'GET') {
       return next();

package/src/index.ts

@@ -4,6 +4,10 @@
 
 import { BaseContextClass } from './lib/core/base_context_class.js';
 import { startEgg } from './lib/start.js';
+import Helper from './app/extend/helper.js';
+
+// export extends
+export { Helper };
 
 // export types
 export * from './lib/egg.js';

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

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

@@ -3,24 +3,28 @@ 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';
 
-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);
@@ -36,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;
@@ -44,21 +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,
       /**
        * @deprecated Keep compatible, please use receiverWorkerId instead
        */
-      receiverPid: String(pid),
-      receiverWorkerId: String(pid),
+      receiverPid: String(workerId),
+      receiverWorkerId: String(workerId),
     });
     return this;
   }
@@ -73,11 +77,12 @@ export class Messenger extends EventEmitter implements IMessenger {
    */
   sendRandom(action: string, data?: unknown): Messenger {
     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;
   }
 
@@ -88,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;
   }
@@ -100,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;
   }
@@ -122,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, receiverWorkerId: %s',
-        this.pid, message.action, message.data, message.receiverWorkerId ?? 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;
   }
@@ -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

@@ -43,6 +43,8 @@ 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'> {

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

@@ -15,6 +15,9 @@ 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';
 
+// import @eggjs/watcher types
+// import '@eggjs/watcher';
+
 type IgnoreItem = string | RegExp | ((ctx: ContextDelegation) => boolean);
 type IgnoreOrMatch = IgnoreItem | IgnoreItem[];