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>
2026-07-31 09:07:25 +02:00 · 2023-01-04 09:47:48 +01:00
parent 0795cdb74c
commit b67f803cbe
104 changed files with 5867 additions and 219 deletions
@@ -0,0 +1,125 @@
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+import { v4 as uuid } from 'uuid';
+import {
+	INodeCredentials,
+	LoggerProxy,
+	MessageEventBusDestinationOptions,
+	MessageEventBusDestinationTypeNames,
+} from 'n8n-workflow';
+import * as Db from '@/Db';
+import { AbstractEventMessage } from '../EventMessageClasses/AbstractEventMessage';
+import { EventMessageTypes } from '../EventMessageClasses';
+import { eventBus } from '..';
+import { DeleteResult, InsertResult } from 'typeorm';
+
+export abstract class MessageEventBusDestination implements MessageEventBusDestinationOptions {
+	// Since you can't have static abstract functions - this just serves as a reminder that you need to implement these. Please.
+	// static abstract deserialize(): MessageEventBusDestination | null;
+	readonly id: string;
+
+	__type: MessageEventBusDestinationTypeNames;
+
+	label: string;
+
+	enabled: boolean;
+
+	subscribedEvents: string[];
+
+	credentials: INodeCredentials = {};
+
+	anonymizeAuditMessages: boolean;
+
+	constructor(options: MessageEventBusDestinationOptions) {
+		this.id = !options.id || options.id.length !== 36 ? uuid() : options.id;
+		this.__type = options.__type ?? MessageEventBusDestinationTypeNames.abstract;
+		this.label = options.label ?? 'Log Destination';
+		this.enabled = options.enabled ?? false;
+		this.subscribedEvents = options.subscribedEvents ?? [];
+		this.anonymizeAuditMessages = options.anonymizeAuditMessages ?? false;
+		if (options.credentials) this.credentials = options.credentials;
+		LoggerProxy.debug(`${this.__type}(${this.id}) event destination constructed`);
+	}
+
+	startListening() {
+		if (this.enabled) {
+			eventBus.on(this.getId(), async (msg: EventMessageTypes) => {
+				await this.receiveFromEventBus(msg);
+			});
+			LoggerProxy.debug(`${this.id} listener started`);
+		}
+	}
+
+	stopListening() {
+		eventBus.removeAllListeners(this.getId());
+	}
+
+	enable() {
+		this.enabled = true;
+		this.startListening();
+	}
+
+	disable() {
+		this.enabled = false;
+		this.stopListening();
+	}
+
+	getId() {
+		return this.id;
+	}
+
+	hasSubscribedToEvent(msg: AbstractEventMessage) {
+		if (!this.enabled) return false;
+		for (const eventName of this.subscribedEvents) {
+			if (eventName === '*' || msg.eventName.startsWith(eventName)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+	async saveToDb() {
+		const data = {
+			id: this.getId(),
+			destination: this.serialize(),
+		};
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
+		const dbResult: InsertResult = await Db.collections.EventDestinations.upsert(data, {
+			skipUpdateIfNoValuesChanged: true,
+			conflictPaths: ['id'],
+		});
+		Db.collections.EventDestinations.createQueryBuilder().insert().into('something').onConflict('');
+		return dbResult;
+	}
+
+	async deleteFromDb() {
+		return MessageEventBusDestination.deleteFromDb(this.getId());
+	}
+
+	static async deleteFromDb(id: string): Promise<DeleteResult> {
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+		const dbResult = await Db.collections.EventDestinations.delete({ id });
+		return dbResult;
+	}
+
+	serialize(): MessageEventBusDestinationOptions {
+		return {
+			__type: this.__type,
+			id: this.getId(),
+			label: this.label,
+			enabled: this.enabled,
+			subscribedEvents: this.subscribedEvents,
+			anonymizeAuditMessages: this.anonymizeAuditMessages,
+		};
+	}
+
+	abstract receiveFromEventBus(msg: AbstractEventMessage): Promise<boolean>;
+
+	toString() {
+		return JSON.stringify(this.serialize());
+	}
+
+	close(): void | Promise<void> {
+		this.stopListening();
+	}
+}