egg 4.0.10 → 4.1.0-beta.10

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

@@ -1,146 +0,0 @@
-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 BaseMessenger implements IMessenger {
-  readonly pid: string;
-  opids: string[] = [];
-
-  constructor(egg: EggApplicationCore) {
-    super(egg);
-    this.pid = String(process.pid);
-    // 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', 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);
-    if (!workerThreads.isMainThread) {
-      workerThreads.parentPort!.on('message', this.onMessage);
-    }
-  }
-
-  /**
-   * Send message to all agent and app
-   * @param {String} action - message key
-   * @param {Object} data - message value
-   * @return {Messenger} this
-   */
-  broadcast(action: string, data?: unknown): Messenger {
-    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;
-  }
-
-  /**
-   * send message to the specified process
-   * @param {String} workerId - the workerId of the receiver
-   * @param {String} action - message key
-   * @param {Object} data - message value
-   * @return {Messenger} this
-   */
-  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(workerId),
-      receiverWorkerId: String(workerId),
-    });
-    return this;
-  }
-
-  /**
-   * send message to one app worker by random
-   * - if it's running in agent, it will send to one of app workers
-   * - if it's running in app, it will send to agent
-   * @param {String} action - message key
-   * @param {Object} data - message value
-   * @return {Messenger} this
-   */
-  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 workerId = this.opids[index];
-    this.sendTo(workerId, action, data);
-    return this;
-  }
-
-  /**
-   * send message to app
-   * @param {String} action - message key
-   * @param {Object} data - message value
-   * @return {Messenger} this
-   */
-  sendToApp(action: string, data?: unknown): Messenger {
-    debug('[%s:%s] send %s with %j to all app', this.egg.type, this.pid, action, data);
-    this.send(action, data, 'app');
-    return this;
-  }
-
-  /**
-   * send message to agent
-   * @param {String} action - message key
-   * @param {Object} data - message value
-   * @return {Messenger} this
-   */
-  sendToAgent(action: string, data?: unknown): Messenger {
-    debug('[%s:%s] send %s with %j to all agent', this.egg.type, this.pid, action, data);
-    this.send(action, data, 'agent');
-    return this;
-  }
-
-  /**
-   * @param {String} action - message key
-   * @param {Object} data - message value
-   * @param {String} to - let master know how to send message
-   * @return {Messenger} this
-   */
-  send(action: string, data: unknown | undefined, to?: string): Messenger {
-    sendmessage(process, {
-      action,
-      data,
-      to,
-    });
-    return this;
-  }
-
-  onMessage(message: any) {
-    if (typeof message?.action === 'string') {
-      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);
-    }
-  }
-
-  close() {
-    process.removeListener('message', this.onMessage);
-    this.removeAllListeners();
-  }
-
-  /**
-   * @function Messenger#on
-   * @param {String} action - message key
-   * @param {Object} data - message value
-   */
-}

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

@@ -1,147 +0,0 @@
-import { debuglog } from 'node:util';
-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 BaseMessenger implements IMessenger {
-  readonly pid: string;
-
-  constructor(egg: EggApplicationCore) {
-    super(egg);
-    this.pid = String(process.pid);
-  }
-
-  /**
-   * Send message to all agent and app
-   * @param {String} action - message key
-   * @param {Object} data - message value
-   * @return {Messenger} this
-   */
-  broadcast(action: string, data?: unknown): Messenger {
-    debug('[%s:%s] broadcast %s with %j', this.egg.type, this.pid, action, data);
-    this.send(action, data, 'both');
-    return this;
-  }
-
-  /**
-   * 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} workerId - the workerId of the receiver
-   * @param {String} action - message key
-   * @param {Object} data - message value
-   * @return {Messenger} this
-   */
-  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');
-    return this;
-  }
-
-  /**
-   * send message to one worker by random
-   * Notice: in single process mode, we only start one agent worker and one app worker
-   * - if it's running in agent, it will send to one of app workers
-   * - if it's running in app, it will send to agent
-   * @param {String} action - message key
-   * @param {Object} data - message value
-   * @return {Messenger} this
-   */
-  sendRandom(action: string, data?: unknown): Messenger {
-    debug('[%s:%s] send %s with %j to opposite', this.egg.type, this.pid, action, data);
-    this.send(action, data, 'opposite');
-    return this;
-  }
-
-  /**
-   * send message to app
-   * @param {String} action - message key
-   * @param {Object} data - message value
-   * @return {Messenger} this
-   */
-  sendToApp(action: string, data?: unknown): Messenger {
-    debug('[%s:%s] send %s with %j to all app', this.egg.type, this.pid, action, data);
-    this.send(action, data, 'application');
-    return this;
-  }
-
-  /**
-   * send message to agent
-   * @param {String} action - message key
-   * @param {Object} data - message value
-   * @return {Messenger} this
-   */
-  sendToAgent(action: string, data?: unknown): Messenger {
-    debug('[%s:%s] send %s with %j to all agent', this.egg.type, this.pid, action, data);
-    this.send(action, data, 'agent');
-    return this;
-  }
-
-  /**
-   * @param {String} action - message key
-   * @param {Object} data - message value
-   * @param {String} to - let master know how to send message
-   * @return {Messenger} this
-   */
-  send(action: string, data: unknown | undefined, to?: string): Messenger {
-    // use nextTick to keep it async as IPC messenger
-    process.nextTick(() => {
-      const { egg } = this;
-      let application;
-      let agent;
-      let opposite;
-
-      if (egg.type === 'application') {
-        application = egg;
-        agent = egg.agent;
-        opposite = agent;
-      } else {
-        agent = egg;
-        application = egg.application;
-        opposite = application;
-      }
-      if (!to) {
-        to = egg.type === 'application' ? 'agent' : 'application';
-      }
-
-      if (application && application.messenger && (to === 'application' || to === 'both')) {
-        application.messenger.onMessage({ action, data });
-      }
-      if (agent && agent.messenger && (to === 'agent' || to === 'both')) {
-        agent.messenger.onMessage({ action, data });
-      }
-      if (opposite && opposite.messenger && to === 'opposite') {
-        opposite.messenger.onMessage({ action, data });
-      }
-    });
-
-    return this;
-  }
-
-  onMessage(message: any) {
-    if (typeof message?.action === 'string') {
-      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);
-    }
-  }
-
-  close() {
-    this.removeAllListeners();
-  }
-
-  /**
-   * @function Messenger#on
-   * @param {String} action - message key
-   * @param {Object} data - message value
-   */
-}

package/src/lib/core/utils.ts

@@ -1,77 +0,0 @@
-import util from 'node:util';
-import {
-  isSymbol, isRegExp, isPrimitive,
-  isClass, isFunction, isGeneratorFunction, isAsyncFunction,
-} from 'is-type-of';
-
-export function convertObject(obj: any, ignore: string | RegExp | (string | RegExp)[] = []) {
-  if (!Array.isArray(ignore)) {
-    ignore = [ ignore ];
-  }
-  for (const key of Object.keys(obj)) {
-    obj[key] = convertValue(key, obj[key], ignore);
-  }
-  return obj;
-}
-
-function convertValue(key: string, value: any, ignore: (string | RegExp)[]) {
-  if (value === null || value === undefined) {
-    return value;
-  }
-
-  let hit = false;
-  for (const matchKey of ignore) {
-    if (typeof matchKey === 'string' && matchKey === key) {
-      hit = true;
-      break;
-    } else if (isRegExp(matchKey) && matchKey.test(key)) {
-      hit = true;
-      break;
-    }
-  }
-  if (!hit) {
-    if (isSymbol(value) || isRegExp(value) || value instanceof URL) {
-      return value.toString();
-    }
-    if (isPrimitive(value) || Array.isArray(value)) {
-      return value;
-    }
-  }
-
-  // only convert recursively when it's a plain object,
-  // o = {}
-  if (Object.getPrototypeOf(value) === Object.prototype) {
-    return convertObject(value, ignore);
-  }
-
-  // support class
-  const name = value.name || 'anonymous';
-  if (isClass(value)) {
-    return `<Class ${name}>`;
-  }
-
-  // support generator function
-  if (isFunction(value)) {
-    if (isGeneratorFunction(value)) return `<GeneratorFunction ${name}>`;
-    if (isAsyncFunction(value)) return `<AsyncFunction ${name}>`;
-    return `<Function ${name}>`;
-  }
-
-  const typeName = value.constructor.name;
-  if (typeName) {
-    if (Buffer.isBuffer(value) || typeof value === 'string') {
-      return `<${typeName} len: ${value.length}>`;
-    }
-    return `<${typeName}>`;
-  }
-
-  return util.format(value);
-}
-
-export function safeParseURL(url: string) {
-  try {
-    return new URL(url);
-  } catch {
-    return null;
-  }
-}