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>

packages/editor-ui/src/components/SettingsLogStreaming/EventDestinationSettingsModal.ee.vue

@@ -0,0 +1,563 @@
+<template>
+	<Modal
+		:name="modalName"
+		:eventBus="modalBus"
+		:beforeClose="onModalClose"
+		:scrollable="true"
+		:center="true"
+		:loading="loading"
+		:minWidth="isTypeAbstract ? '460px' : '70%'"
+		:maxWidth="isTypeAbstract ? '460px' : '70%'"
+		:minHeight="isTypeAbstract ? '160px' : '650px'"
+		:maxHeight="isTypeAbstract ? '300px' : '650px'"
+		data-test-id="destination-modal"
+	>
+		<template #header>
+			<template v-if="isTypeAbstract">
+				<div :class="$style.headerCreate">
+					<span>Add new destination</span>
+				</div>
+			</template>
+			<template v-else>
+				<div :class="$style.header">
+					<div :class="$style.destinationInfo">
+						<InlineNameEdit
+							:name="headerLabel"
+							:subtitle="!isTypeAbstract ? $locale.baseText(typeLabelName) : 'Select type'"
+							:readonly="isTypeAbstract"
+							type="Credential"
+							data-test-id="subtitle-showing-type"
+							@input="onLabelChange"
+						/>
+					</div>
+					<div :class="$style.destinationActions">
+						<n8n-button
+							v-if="nodeParameters && hasOnceBeenSaved && unchanged"
+							:icon="testMessageSent ? (testMessageResult ? 'check' : 'exclamation-triangle') : ''"
+							:title="
+								testMessageSent && testMessageResult
+									? 'Event sent and returned OK'
+									: 'Event returned with error'
+							"
+							size="medium"
+							type="tertiary"
+							label="Send Test-Event"
+							:disabled="!hasOnceBeenSaved || !unchanged"
+							@click="sendTestEvent"
+							data-test-id="destination-test-button"
+						/>
+						<template v-if="isInstanceOwner">
+							<n8n-icon-button
+								v-if="nodeParameters && hasOnceBeenSaved"
+								:title="$locale.baseText('settings.log-streaming.delete')"
+								icon="trash"
+								size="medium"
+								type="tertiary"
+								:disabled="isSaving"
+								:loading="isDeleting"
+								@click="removeThis"
+								data-test-id="destination-delete-button"
+							/>
+							<SaveButton
+								:saved="unchanged && hasOnceBeenSaved"
+								:disabled="isTypeAbstract || unchanged"
+								:savingLabel="$locale.baseText('settings.log-streaming.saving')"
+								@click="saveDestination"
+								data-test-id="destination-save-button"
+							/>
+						</template>
+					</div>
+				</div>
+				<hr />
+			</template>
+		</template>
+		<template #content>
+			<div :class="$style.container">
+				<template v-if="isTypeAbstract">
+					<n8n-input-label
+						:class="$style.typeSelector"
+						:label="$locale.baseText('settings.log-streaming.selecttype')"
+						:tooltipText="$locale.baseText('settings.log-streaming.selecttypehint')"
+						:bold="false"
+						size="medium"
+						:underline="false"
+					>
+						<n8n-select
+							:value="typeSelectValue"
+							:placeholder="typeSelectPlaceholder"
+							@change="onTypeSelectInput"
+							data-test-id="select-destination-type"
+							name="name"
+							ref="typeSelectRef"
+						>
+							<n8n-option
+								v-for="option in typeSelectOptions || []"
+								:key="option.value"
+								:value="option.value"
+								:label="$locale.baseText(option.label)"
+							/>
+						</n8n-select>
+						<div class="mt-m text-right">
+							<n8n-button
+								size="large"
+								@click="onContinueAddClicked"
+								data-test-id="select-destination-button"
+								:disabled="!typeSelectValue"
+							>
+								{{ $locale.baseText(`settings.log-streaming.continue`) }}
+							</n8n-button>
+						</div>
+					</n8n-input-label>
+				</template>
+				<template v-else>
+					<div :class="$style.sidebar">
+						<n8n-menu mode="tabs" :items="sidebarItems" @select="onTabSelect"></n8n-menu>
+					</div>
+					<div v-if="activeTab === 'settings'" :class="$style.mainContent" ref="content">
+						<template v-if="isTypeWebhook">
+							<parameter-input-list
+								:parameters="webhookDescription"
+								:hideDelete="true"
+								:nodeValues="nodeParameters"
+								:isReadOnly="!isInstanceOwner"
+								path=""
+								@valueChanged="valueChanged"
+							/>
+						</template>
+						<template v-else-if="isTypeSyslog">
+							<parameter-input-list
+								:parameters="syslogDescription"
+								:hideDelete="true"
+								:nodeValues="nodeParameters"
+								:isReadOnly="!isInstanceOwner"
+								path=""
+								@valueChanged="valueChanged"
+							/>
+						</template>
+						<template v-else-if="isTypeSentry">
+							<parameter-input-list
+								:parameters="sentryDescription"
+								:hideDelete="true"
+								:nodeValues="nodeParameters"
+								:isReadOnly="!isInstanceOwner"
+								path=""
+								@valueChanged="valueChanged"
+							/>
+						</template>
+					</div>
+					<div v-if="activeTab === 'events'" :class="$style.mainContent">
+						<template>
+							<div class="">
+								<n8n-input-label
+									class="mb-m mt-m"
+									:label="$locale.baseText('settings.log-streaming.tab.events.title')"
+									:bold="true"
+									size="medium"
+									:underline="false"
+								/>
+								<event-selection
+									class=""
+									:destinationId="destination.id"
+									@input="onInput"
+									@change="valueChanged"
+									:readonly="!isInstanceOwner"
+								/>
+							</div>
+						</template>
+					</div>
+				</template>
+			</div>
+		</template>
+	</Modal>
+</template>
+
+<script lang="ts">
+import { get, set, unset } from 'lodash';
+import { mapStores } from 'pinia';
+import mixins from 'vue-typed-mixins';
+import { useLogStreamingStore } from '../../stores/logStreamingStore';
+import { useNDVStore } from '../../stores/ndv';
+import { useWorkflowsStore } from '../../stores/workflows';
+import { restApi } from '../../mixins/restApi';
+import ParameterInputList from '@/components/ParameterInputList.vue';
+import NodeCredentials from '@/components/NodeCredentials.vue';
+import { IMenuItem, INodeUi, ITab, IUpdateInformation } from '../../Interface';
+import {
+	deepCopy,
+	defaultMessageEventBusDestinationOptions,
+	defaultMessageEventBusDestinationWebhookOptions,
+	IDataObject,
+	INodeCredentials,
+	NodeParameterValue,
+	MessageEventBusDestinationTypeNames,
+	MessageEventBusDestinationOptions,
+	defaultMessageEventBusDestinationSyslogOptions,
+	defaultMessageEventBusDestinationSentryOptions,
+} from 'n8n-workflow';
+import Vue from 'vue';
+import { LOG_STREAM_MODAL_KEY } from '../../constants';
+import Modal from '@/components/Modal.vue';
+import { showMessage } from '@/mixins/showMessage';
+import { useUIStore } from '../../stores/ui';
+import { useUsersStore } from '../../stores/users';
+import { destinationToFakeINodeUi, saveDestinationToDb, sendTestMessage } from './Helpers.ee';
+import {
+	webhookModalDescription,
+	sentryModalDescription,
+	syslogModalDescription,
+} from './descriptions.ee';
+import { BaseTextKey } from '../../plugins/i18n';
+import InlineNameEdit from '../InlineNameEdit.vue';
+import SaveButton from '../SaveButton.vue';
+import EventSelection from '@/components/SettingsLogStreaming/EventSelection.ee.vue';
+import { Checkbox } from 'element-ui';
+
+export default mixins(showMessage, restApi).extend({
+	name: 'event-destination-settings-modal',
+	props: {
+		modalName: String,
+		destination: {
+			type: Object,
+			default: () => deepCopy(defaultMessageEventBusDestinationOptions),
+		},
+		isNew: Boolean,
+		eventBus: {
+			type: Vue,
+		},
+	},
+	components: {
+		Modal,
+		ParameterInputList,
+		NodeCredentials,
+		InlineNameEdit,
+		SaveButton,
+		EventSelection,
+		Checkbox,
+	},
+	data() {
+		return {
+			unchanged: !this.$props.isNew,
+			activeTab: 'settings',
+			hasOnceBeenSaved: !this.$props.isNew,
+			isSaving: false,
+			isDeleting: false,
+			loading: false,
+			showRemoveConfirm: false,
+			typeSelectValue: '',
+			typeSelectPlaceholder: 'Destination Type',
+			nodeParameters: deepCopy(defaultMessageEventBusDestinationOptions),
+			webhookDescription: webhookModalDescription,
+			sentryDescription: sentryModalDescription,
+			syslogDescription: syslogModalDescription,
+			modalBus: new Vue(),
+			headerLabel: this.$props.destination.label,
+			testMessageSent: false,
+			testMessageResult: false,
+			isInstanceOwner: false,
+			LOG_STREAM_MODAL_KEY,
+		};
+	},
+	computed: {
+		...mapStores(useUIStore, useUsersStore, useLogStreamingStore, useNDVStore, useWorkflowsStore),
+		typeSelectOptions(): Array<{ value: string; label: BaseTextKey }> {
+			const options: Array<{ value: string; label: BaseTextKey }> = [];
+			for (const t of Object.values(MessageEventBusDestinationTypeNames)) {
+				if (t === MessageEventBusDestinationTypeNames.abstract) {
+					continue;
+				}
+				options.push({
+					value: t,
+					label: `settings.log-streaming.${t}` as BaseTextKey,
+				});
+			}
+			return options;
+		},
+		isTypeAbstract(): boolean {
+			return this.nodeParameters.__type === MessageEventBusDestinationTypeNames.abstract;
+		},
+		isTypeWebhook(): boolean {
+			return this.nodeParameters.__type === MessageEventBusDestinationTypeNames.webhook;
+		},
+		isTypeSyslog(): boolean {
+			return this.nodeParameters.__type === MessageEventBusDestinationTypeNames.syslog;
+		},
+		isTypeSentry(): boolean {
+			return this.nodeParameters.__type === MessageEventBusDestinationTypeNames.sentry;
+		},
+		node(): INodeUi {
+			return destinationToFakeINodeUi(this.nodeParameters);
+		},
+		typeLabelName(): BaseTextKey {
+			return `settings.log-streaming.${this.nodeParameters.__type}` as BaseTextKey;
+		},
+		sidebarItems(): IMenuItem[] {
+			const items: IMenuItem[] = [
+				{
+					id: 'settings',
+					label: this.$locale.baseText('settings.log-streaming.tab.settings'),
+					position: 'top',
+				},
+			];
+			if (!this.isTypeAbstract) {
+				items.push({
+					id: 'events',
+					label: this.$locale.baseText('settings.log-streaming.tab.events'),
+					position: 'top',
+				});
+			}
+			return items;
+		},
+		tabItems(): ITab[] {
+			return [
+				{
+					label: this.$locale.baseText('settings.log-streaming.tab.settings'),
+					value: 'settings',
+				},
+				{
+					label: this.$locale.baseText('settings.log-streaming.tab.events'),
+					value: 'events',
+				},
+			];
+		},
+	},
+	mounted() {
+		this.isInstanceOwner = this.usersStore.currentUser?.globalRole?.name === 'owner';
+		this.setupNode(
+			Object.assign(deepCopy(defaultMessageEventBusDestinationOptions), this.destination),
+		);
+		this.workflowsStore.$onAction(
+			({
+				name, // name of the action
+				args, // array of parameters passed to the action
+			}) => {
+				if (name === 'updateNodeProperties') {
+					for (const arg of args) {
+						if (arg.name === this.destination.id) {
+							if ('credentials' in arg.properties) {
+								this.unchanged = false;
+								this.nodeParameters.credentials = arg.properties.credentials as INodeCredentials;
+							}
+						}
+					}
+				}
+			},
+		);
+	},
+	methods: {
+		onInput() {
+			this.unchanged = false;
+			this.testMessageSent = false;
+		},
+		onTabSelect(tab: string) {
+			this.activeTab = tab;
+		},
+		onLabelChange(value: string) {
+			this.onInput();
+			this.headerLabel = value;
+			this.nodeParameters.label = value;
+		},
+		setupNode(options: MessageEventBusDestinationOptions) {
+			this.workflowsStore.removeNode(this.node);
+			this.ndvStore.activeNodeName = options.id ?? 'thisshouldnothappen';
+			this.workflowsStore.addNode(destinationToFakeINodeUi(options));
+			this.nodeParameters = options;
+			this.logStreamingStore.items[this.destination.id].destination = options;
+		},
+		onTypeSelectInput(destinationType: MessageEventBusDestinationTypeNames) {
+			this.typeSelectValue = destinationType;
+		},
+		onContinueAddClicked() {
+			let newDestination;
+			switch (this.typeSelectValue) {
+				case MessageEventBusDestinationTypeNames.syslog:
+					newDestination = Object.assign(deepCopy(defaultMessageEventBusDestinationSyslogOptions), {
+						id: this.destination.id,
+					});
+					break;
+				case MessageEventBusDestinationTypeNames.sentry:
+					newDestination = Object.assign(deepCopy(defaultMessageEventBusDestinationSentryOptions), {
+						id: this.destination.id,
+					});
+					break;
+				case MessageEventBusDestinationTypeNames.webhook:
+					newDestination = Object.assign(
+						deepCopy(defaultMessageEventBusDestinationWebhookOptions),
+						{ id: this.destination.id },
+					);
+					break;
+			}
+			if (newDestination) {
+				this.headerLabel = newDestination?.label ?? this.headerLabel;
+				this.setupNode(newDestination);
+			}
+		},
+		valueChanged(parameterData: IUpdateInformation) {
+			this.unchanged = false;
+			this.testMessageSent = false;
+			const newValue: NodeParameterValue = parameterData.value as string | number;
+			const parameterPath = parameterData.name.startsWith('parameters.')
+				? parameterData.name.split('.').slice(1).join('.')
+				: parameterData.name;
+
+			const nodeParameters = deepCopy(this.nodeParameters);
+
+			// Check if the path is supposed to change an array and if so get
+			// the needed data like path and index
+			const parameterPathArray = parameterPath.match(/(.*)\[(\d+)\]$/);
+
+			// Apply the new value
+			if (parameterData.value === undefined && parameterPathArray !== null) {
+				// Delete array item
+				const path = parameterPathArray[1];
+				const index = parameterPathArray[2];
+				const data = get(nodeParameters, path);
+
+				if (Array.isArray(data)) {
+					data.splice(parseInt(index, 10), 1);
+					Vue.set(nodeParameters, path, data);
+				}
+			} else {
+				if (newValue === undefined) {
+					unset(nodeParameters, parameterPath);
+				} else {
+					set(nodeParameters, parameterPath, newValue);
+				}
+			}
+
+			this.nodeParameters = deepCopy(nodeParameters);
+			this.workflowsStore.updateNodeProperties({
+				name: this.node.name,
+				properties: { parameters: this.nodeParameters as unknown as IDataObject },
+			});
+			this.logStreamingStore.updateDestination(this.nodeParameters);
+		},
+		async sendTestEvent() {
+			this.testMessageResult = await sendTestMessage(this.restApi(), this.nodeParameters);
+			this.testMessageSent = true;
+		},
+		async removeThis() {
+			const deleteConfirmed = await this.confirmMessage(
+				this.$locale.baseText('settings.log-streaming.destinationDelete.message', {
+					interpolate: { destinationName: this.destination.label },
+				}),
+				this.$locale.baseText('settings.log-streaming.destinationDelete.headline'),
+				'warning',
+				this.$locale.baseText('settings.log-streaming.destinationDelete.confirmButtonText'),
+				this.$locale.baseText('settings.log-streaming.destinationDelete.cancelButtonText'),
+			);
+
+			if (deleteConfirmed === false) {
+				return;
+			} else {
+				this.$props.eventBus.$emit('remove', this.destination.id);
+				this.uiStore.closeModal(LOG_STREAM_MODAL_KEY);
+				this.uiStore.stateIsDirty = false;
+			}
+		},
+		onModalClose() {
+			if (!this.hasOnceBeenSaved) {
+				this.workflowsStore.removeNode(this.node);
+				this.logStreamingStore.removeDestination(this.nodeParameters.id!);
+			}
+			this.ndvStore.activeNodeName = null;
+			this.$props.eventBus.$emit('closing', this.destination.id);
+			this.uiStore.stateIsDirty = false;
+		},
+		async saveDestination() {
+			if (this.unchanged || !this.destination.id) {
+				return;
+			}
+			await saveDestinationToDb(this.restApi(), this.nodeParameters);
+			this.hasOnceBeenSaved = true;
+			this.testMessageSent = false;
+			this.unchanged = true;
+			this.$props.eventBus.$emit('destinationWasSaved', this.destination.id);
+			this.uiStore.stateIsDirty = false;
+		},
+	},
+});
+</script>
+
+<style lang="scss" module>
+.labelMargins {
+	margin-bottom: 1em;
+	margin-top: 1em;
+}
+.typeSelector {
+	width: 100%;
+	margin-bottom: 1em;
+	margin-top: 1em;
+}
+
+.sidebarSwitches {
+	margin-left: 1.5em;
+	margin-bottom: 0.5em;
+	span {
+		color: var(--color-text-dark) !important;
+	}
+}
+
+.tabbar {
+	margin-bottom: 1em;
+}
+
+.mainContent {
+	flex: 1;
+	overflow: auto;
+	padding-left: 1em;
+	padding-right: 1em;
+	padding-bottom: 2em;
+}
+
+.sidebar {
+	padding-top: 1em;
+	max-width: 170px;
+	min-width: 170px;
+	margin-right: var(--spacing-l);
+	flex-grow: 1;
+
+	ul {
+		padding: 0 !important;
+	}
+}
+
+.cardTitle {
+	font-size: 14px;
+	font-weight: bold;
+}
+
+.header {
+	display: flex;
+	min-height: 61px;
+}
+
+.headerCreate {
+	display: flex;
+	font-size: 20px;
+}
+
+.container {
+	display: flex;
+	height: 100%;
+}
+
+.destinationInfo {
+	display: flex;
+	align-items: center;
+	flex-direction: row;
+	flex-grow: 1;
+	margin-bottom: var(--spacing-l);
+}
+
+.destinationActions {
+	display: flex;
+	flex-direction: row;
+	align-items: center;
+	margin-right: var(--spacing-xl);
+	margin-bottom: var(--spacing-l);
+
+	> * {
+		margin-left: var(--spacing-2xs);
+	}
+}
+</style>