feat: Add global event bus (#4860)

* fix branch * fix deserialize, add filewriter * add catchAll eventGroup/Name * adding simple Redis sender and receiver to eventbus * remove native node threads * improve eventbus * refactor and simplify * more refactoring and syslog client * more refactor, improved endpoints and eventbus * remove local broker and receivers from mvp * destination de/serialization * create MessageEventBusDestinationEntity * db migrations, load destinations at startup * add delete destination endpoint * pnpm merge and circular import fix * delete destination fix * trigger log file shuffle after size reached * add environment variables for eventbus * reworking event messages * serialize to thread fix * some refactor and lint fixing * add emit to eventbus * cleanup and fix sending unsent * quicksave frontend trial * initial EventTree vue component * basic log streaming settings in vue * http request code merge * create destination settings modals * fix eventmessage options types * credentials are loaded * fix and clean up frontend code * move request code to axios * update lock file * merge fix * fix redis build * move destination interfaces into workflow pkg * revive sentry as destination * migration fixes and frontend cleanup * N8N-5777 / N8N-5789 N8N-5788 * N8N-5784 * N8N-5782 removed event levels * N8N-5790 sentry destination cleanup * N8N-5786 and refactoring * N8N-5809 and refactor/cleanup * UI fixes and anonymize renaming * N8N-5837 * N8N-5834 * fix no-items UI issues * remove card / settings label in modal * N8N-5842 fix * disable webhook auth for now and update ui * change sidebar to tabs * remove payload option * extend audit events with more user data * N8N-5853 and UI revert to sidebar * remove redis destination * N8N-5864 / N8N-5868 / N8N-5867 / N8N-5865 * ui and licensing fixes * add node events and info bubbles to frontend * ui wording changes * frontend tests * N8N-5896 and ee rename * improves backend tests * merge fix * fix backend test * make linter happy * remove unnecessary cfg / limit actions to owners * fix multiple sentry DSN and anon bug * eslint fix * more tests and fixes * merge fix * fix workflow audit events * remove 'n8n.workflow.execution.error' event * merge fix * lint fix * lint fix * review fixes * fix merge * prettier fixes * merge * review changes * use loggerproxy * remove catch from internal hook promises * fix tests * lint fix * include review PR changes * review changes * delete duplicate lines from a bad merge * decouple log-streaming UI options from public API * logstreaming -> log-streaming for consistency * do not make unnecessary api calls when log streaming is disabled * prevent sentryClient.close() from being called if init failed * fix the e2e test for log-streaming * review changes * cleanup * use `private` for one last private property * do not use node prefix package names.. just yet * remove unused import * fix the tests because there is a folder called `events`, tsc-alias is messing up all imports for native events module. https://github.com/justkey007/tsc-alias/issues/152 Co-authored-by: कारतोफ्फेलस्क्रिप्ट™ <aditya@netroy.in>
2025-12-20 03:12:15 +00:00 · 2023-01-04 09:47:48 +01:00
parent 0795cdb74c
commit b67f803cbe
104 changed files with 5867 additions and 219 deletions
--- a/packages/cli/src/eventbus/MessageEventBusDestination/MessageEventBusDestinationSyslog.ee.ts
+++ b/packages/cli/src/eventbus/MessageEventBusDestination/MessageEventBusDestinationSyslog.ee.ts
@@ -0,0 +1,149 @@
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+import syslog from 'syslog-client';
+import { eventBus } from '../MessageEventBus/MessageEventBus';
+import {
+	LoggerProxy,
+	MessageEventBusDestinationOptions,
+	MessageEventBusDestinationSyslogOptions,
+	MessageEventBusDestinationTypeNames,
+} from 'n8n-workflow';
+import { MessageEventBusDestination } from './MessageEventBusDestination.ee';
+import { isLogStreamingEnabled } from '../MessageEventBus/MessageEventBusHelper';
+import { EventMessageTypes } from '../EventMessageClasses';
+import { eventMessageGenericDestinationTestEvent } from '../EventMessageClasses/EventMessageGeneric';
+
+export const isMessageEventBusDestinationSyslogOptions = (
+	candidate: unknown,
+): candidate is MessageEventBusDestinationSyslogOptions => {
+	const o = candidate as MessageEventBusDestinationSyslogOptions;
+	if (!o) return false;
+	return o.host !== undefined;
+};
+
+export class MessageEventBusDestinationSyslog
+	extends MessageEventBusDestination
+	implements MessageEventBusDestinationSyslogOptions
+{
+	client: syslog.Client;
+
+	expectedStatusCode?: number;
+
+	host: string;
+
+	port: number;
+
+	protocol: 'udp' | 'tcp';
+
+	facility: syslog.Facility;
+
+	app_name: string;
+
+	eol: string;
+
+	constructor(options: MessageEventBusDestinationSyslogOptions) {
+		super(options);
+		this.__type = options.__type ?? MessageEventBusDestinationTypeNames.syslog;
+		this.label = options.label ?? 'Syslog Server';
+
+		this.host = options.host ?? 'localhost';
+		this.port = options.port ?? 514;
+		this.protocol = options.protocol ?? 'udp';
+		this.facility = options.facility ?? syslog.Facility.Local0;
+		this.app_name = options.app_name ?? 'n8n';
+		this.eol = options.eol ?? '\n';
+		this.expectedStatusCode = options.expectedStatusCode ?? 200;
+
+		this.client = syslog.createClient(this.host, {
+			appName: this.app_name,
+			facility: syslog.Facility.Local0,
+			// severity: syslog.Severity.Error,
+			port: this.port,
+			transport:
+				options.protocol !== undefined && options.protocol === 'tcp'
+					? syslog.Transport.Tcp
+					: syslog.Transport.Udp,
+		});
+		LoggerProxy.debug(`MessageEventBusDestinationSyslog with id ${this.getId()} initialized`);
+		this.client.on('error', function (error) {
+			console.error(error);
+		});
+	}
+
+	async receiveFromEventBus(msg: EventMessageTypes): Promise<boolean> {
+		let sendResult = false;
+		if (msg.eventName !== eventMessageGenericDestinationTestEvent) {
+			if (!isLogStreamingEnabled()) return sendResult;
+			if (!this.hasSubscribedToEvent(msg)) return sendResult;
+		}
+		try {
+			const serializedMessage = msg.serialize();
+			if (this.anonymizeAuditMessages) {
+				serializedMessage.payload = msg.anonymize();
+			}
+			delete serializedMessage.__type;
+			this.client.log(
+				JSON.stringify(serializedMessage),
+				{
+					severity: msg.eventName.toLowerCase().endsWith('error')
+						? syslog.Severity.Error
+						: syslog.Severity.Debug,
+					msgid: msg.id,
+					timestamp: msg.ts.toJSDate(),
+				},
+				async (error) => {
+					if (error) {
+						console.log(error);
+					} else {
+						await eventBus.confirmSent(msg, { id: this.id, name: this.label });
+						sendResult = true;
+					}
+				},
+			);
+		} catch (error) {
+			console.log(error);
+		}
+		if (msg.eventName === eventMessageGenericDestinationTestEvent) {
+			await new Promise((resolve) => setTimeout(resolve, 500));
+		}
+		return sendResult;
+	}
+
+	serialize(): MessageEventBusDestinationSyslogOptions {
+		const abstractSerialized = super.serialize();
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+		return {
+			...abstractSerialized,
+			expectedStatusCode: this.expectedStatusCode,
+			host: this.host,
+			port: this.port,
+			protocol: this.protocol,
+			facility: this.facility,
+			app_name: this.app_name,
+			eol: this.eol,
+		};
+	}
+
+	static deserialize(
+		data: MessageEventBusDestinationOptions,
+	): MessageEventBusDestinationSyslog | null {
+		if (
+			'__type' in data &&
+			data.__type === MessageEventBusDestinationTypeNames.syslog &&
+			isMessageEventBusDestinationSyslogOptions(data)
+		) {
+			return new MessageEventBusDestinationSyslog(data);
+		}
+		return null;
+	}
+
+	toString() {
+		return JSON.stringify(this.serialize());
+	}
+
+	async close() {
+		await super.close();
+		this.client.close();
+	}
+}