/*
Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
Copyright (C) 2023 Spacebar and Spacebar Contributors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import EventEmitter from "node:events";
import path from "node:path";
import { Channel } from "amqplib";
import { yellow } from "picocolors";
import { Event } from "../../interfaces";
import { Config } from "../Config";
import { rabbitListen, RabbitMQ } from "./RabbitMQ";
import { BaseEventListener } from "./listener/BaseEventListener";
import { BaseEventWriter } from "./writer/BaseEventWriter";
import { UnixSocketWriter } from "./writer/UnixSocketWriter";
import { UnixSocketListener } from "./listener/UnixSocketListener";
import { RabbitMqSingleListener } from "./listener/RabbitMqSingleListener";
import { RabbitMqSingleWriter } from "./writer/RabbitMqSingleWriter";
export const events = new EventEmitter();
let listener: BaseEventListener | null = null;
let writer: BaseEventWriter | null = null;
export async function emitEvent(payload: Omit<Event, "created_at">) {
const id = (payload.guild_id || payload.channel_id || payload.user_id || payload.session_id) as string;
if (!id) return console.error("event doesn't contain any id", payload);
if (writer) {
await writer.emit(payload);
} else if (process.env.EVENT_TRANSMISSION === "process") {
process.send?.({ type: "event", event: payload, id } as ProcessEvent);
} else if (RabbitMQ.connection) {
await RabbitMQ.publishEvent(id, payload);
} else {
events.emit(id, payload);
}
}
export async function initEvent() {
if (process.env.EVENT_TRANSMISSION === "rabbitmq-single") {
if (!Config.get().rabbitmq.host!) {
throw new Error("[Events] rabbitmq.host is not configured.");
}
if (!writer) {
writer = new RabbitMqSingleWriter(Config.get().rabbitmq.host!);
await writer.init();
}
} else if (process.env.EVENT_TRANSMISSION === "unix" && process.env.EVENT_SOCKET_PATH) {
if (!process.env.EVENT_SOCKET_PATH) {
throw new Error("[Events] EVENT_SOCKET_PATH is not configured.");
}
if (!writer) {
writer = new UnixSocketWriter(process.env.EVENT_SOCKET_PATH);
await writer.init();
}
} else await RabbitMQ.init(); // does nothing if rabbitmq is not setup
// Set up the spacebar event listener (used for config reload, etc.)
const setupSpacebarListener = async () => {
console.log("[Event] Setting up spacebar event listener");
await listenEvent("spacebar", async (event) => {
console.log("[Event] Received spacebar event:", event);
if ((event.event as string) === "SB_RELOAD_CONFIG") {
console.log("[Event] Reloading config due to RELOAD_CONFIG event");
await Config.init(true);
}
});
};
// Initial setup
await setupSpacebarListener();
// Re-establish listener on reconnection
RabbitMQ.on("reconnected", async () => {
console.log("[Event] RabbitMQ reconnected, re-establishing spacebar listener");
await setupSpacebarListener();
});
}
export interface EventOpts extends Event {
acknowledge?: () => unknown;
channel?: Channel;
cancel: (id?: string) => unknown;
}
export interface ListenEventOpts {
channel?: Channel;
acknowledge?: boolean;
}
export interface ProcessEvent {
type: "event";
event: Event;
id: string;
}
export async function listenEvent(event: string, callback: (event: EventOpts) => unknown, opts?: ListenEventOpts): Promise<() => Promise<void>> {
if (process.env.EVENT_TRANSMISSION === "rabbitmq-single") {
if (!Config.get().rabbitmq.host) {
throw new Error("[Events] rabbitmq.host is not configured.");
}
if (!listener) {
listener = new RabbitMqSingleListener(Config.get().rabbitmq.host!);
await listener.init();
}
return await listener.listen(event, callback);
} else if (process.env.EVENT_TRANSMISSION === "unix") {
if (!process.env.EVENT_SOCKET_PATH) {
throw new Error("[Events] EVENT_SOCKET_PATH is not configured.");
}
if (!listener) {
listener = listener = new UnixSocketListener(path.join(process.env.EVENT_SOCKET_PATH, `${process.pid}.sock`));
await listener.init();
}
return await listener.listen(event, callback);
} else if (process.env.EVENT_TRANSMISSION === "process") {
const cancel = async () => {
process.removeListener("message", listener);
process.setMaxListeners(process.getMaxListeners() - 1);
};
const listener = (msg: ProcessEvent) => {
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
msg.type === "event" && msg.id === event && callback({ ...msg.event, cancel });
};
// TODO: assert the type is correct?
process.addListener("message", (msg) => listener(msg as ProcessEvent));
process.setMaxListeners(process.getMaxListeners() + 1);
return cancel;
} else if (RabbitMQ.connection) {
if (process.env.EVENT_TRANSMISSION !== "rabbitmq-legacy") {
console.warn(yellow("[Events] Warning:"), "RabbitMQ replication without configuring EVENT_TRANSMISSION is deprecated.");
console.warn(yellow("[Events] Warning:"), "Set EVENT_TRANSMISSION to 'rabbitmq-legacy' in environment variables to silence this warning.");
}
const rabbitMQChannel = await RabbitMQ.getSafeChannel();
const channel = opts?.channel || rabbitMQChannel;
if (!channel) throw new Error("[Events] An event was sent without an associated channel");
return await rabbitListen(channel, event, callback, {
acknowledge: opts?.acknowledge,
});
} else {
const listener = (opts: EventOpts) => callback({ ...opts, cancel });
const cancel = async () => {
events.removeListener(event, listener);
events.setMaxListeners(events.getMaxListeners() - 1);
};
events.setMaxListeners(events.getMaxListeners() + 1);
events.addListener(event, listener);
return cancel;
}
}