egg/dist/lib/core/messenger/local.js

A web application framework for Node.js

import { BaseMessenger } from "./base.js";
import { debuglog } from "node:util";
//#region src/lib/core/messenger/local.ts
const debug = debuglog("egg/lib/core/messenger/local");
/**
* Communication between app worker and agent worker with EventEmitter
*/
var Messenger = class extends BaseMessenger {
	pid;
	constructor(egg) {
		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, data) {
		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, action, data) {
		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, data) {
		debug("[%s:%s] send %s with %o 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, data) {
		debug("[%s:%s] send %s with %o 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, data) {
		debug("[%s:%s] send %s with %o 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, data, to) {
		if (to === "app") to = "application";
		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";
			debug("[%s:%s] send action:%s with %o to %s", this.egg.type, this.pid, action, data, to);
			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) {
		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();
	}
};
//#endregion
export { Messenger };