egg 4.0.0-beta.6 → 4.0.0-beta.7

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[];