mirror of
https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git
synced 2025-12-17 10:02:05 +00:00
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>
This commit is contained in:
Michael Auerswald
committed by
GitHub
GitHub
parent
0795cdb74c
commit
b67f803cbe
@@ -0,0 +1,143 @@
|
||||
/* eslint-disable @typescript-eslint/no-unsafe-argument */
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import { DateTime } from 'luxon';
|
||||
import type { EventMessageTypeNames, JsonObject } from 'n8n-workflow';
|
||||
import { v4 as uuid } from 'uuid';
|
||||
import type { AbstractEventPayload } from './AbstractEventPayload';
|
||||
import type { AbstractEventMessageOptions } from './AbstractEventMessageOptions';
|
||||
|
||||
function modifyUnderscoredKeys(
|
||||
input: { [key: string]: any },
|
||||
modifier: (secret: string) => string | undefined = () => '*',
|
||||
) {
|
||||
const result: { [key: string]: any } = {};
|
||||
if (!input) return input;
|
||||
Object.keys(input).forEach((key) => {
|
||||
if (typeof input[key] === 'string') {
|
||||
if (key.substring(0, 1) === '_') {
|
||||
const modifierResult = modifier(input[key]);
|
||||
if (modifierResult !== undefined) {
|
||||
result[key] = modifier(input[key]);
|
||||
}
|
||||
} else {
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
||||
result[key] = input[key];
|
||||
}
|
||||
} else if (typeof input[key] === 'object') {
|
||||
if (Array.isArray(input[key])) {
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
|
||||
result[key] = input[key].map((item: any) => {
|
||||
if (typeof item === 'object' && !Array.isArray(item)) {
|
||||
return modifyUnderscoredKeys(item, modifier);
|
||||
} else {
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
|
||||
return item;
|
||||
}
|
||||
});
|
||||
} else {
|
||||
result[key] = modifyUnderscoredKeys(input[key], modifier);
|
||||
}
|
||||
} else {
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
||||
result[key] = input[key];
|
||||
}
|
||||
});
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
export const isEventMessage = (candidate: unknown): candidate is AbstractEventMessage => {
|
||||
const o = candidate as AbstractEventMessage;
|
||||
if (!o) return false;
|
||||
return (
|
||||
o.eventName !== undefined &&
|
||||
o.id !== undefined &&
|
||||
o.ts !== undefined &&
|
||||
o.getEventName !== undefined
|
||||
);
|
||||
};
|
||||
|
||||
export const isEventMessageOptions = (
|
||||
candidate: unknown,
|
||||
): candidate is AbstractEventMessageOptions => {
|
||||
const o = candidate as AbstractEventMessageOptions;
|
||||
if (!o) return false;
|
||||
if (o.eventName !== undefined) {
|
||||
if (o.eventName.match(/^[\w\s]+\.[\w\s]+\.[\w\s]+/)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
};
|
||||
|
||||
export const isEventMessageOptionsWithType = (
|
||||
candidate: unknown,
|
||||
expectedType: string,
|
||||
): candidate is AbstractEventMessageOptions => {
|
||||
const o = candidate as AbstractEventMessageOptions;
|
||||
if (!o) return false;
|
||||
return o.eventName !== undefined && o.__type !== undefined && o.__type === expectedType;
|
||||
};
|
||||
|
||||
export abstract class AbstractEventMessage {
|
||||
abstract readonly __type: EventMessageTypeNames;
|
||||
|
||||
id: string;
|
||||
|
||||
ts: DateTime;
|
||||
|
||||
eventName: string;
|
||||
|
||||
message: string;
|
||||
|
||||
abstract payload: AbstractEventPayload;
|
||||
|
||||
/**
|
||||
* Creates a new instance of Event Message
|
||||
* @param props.eventName The specific events name e.g. "n8n.workflow.workflowStarted"
|
||||
* @param props.level The log level, defaults to. "info"
|
||||
* @param props.severity The severity of the event e.g. "normal"
|
||||
* @returns instance of EventMessage
|
||||
*/
|
||||
constructor(options: AbstractEventMessageOptions) {
|
||||
this.setOptionsOrDefault(options);
|
||||
}
|
||||
|
||||
abstract deserialize(data: JsonObject): this;
|
||||
abstract setPayload(payload: AbstractEventPayload): this;
|
||||
|
||||
anonymize(): AbstractEventPayload {
|
||||
const anonymizedPayload = modifyUnderscoredKeys(this.payload);
|
||||
return anonymizedPayload;
|
||||
}
|
||||
|
||||
serialize(): AbstractEventMessageOptions {
|
||||
return {
|
||||
__type: this.__type,
|
||||
id: this.id,
|
||||
ts: this.ts.toISO(),
|
||||
eventName: this.eventName,
|
||||
message: this.message,
|
||||
payload: this.payload,
|
||||
};
|
||||
}
|
||||
|
||||
setOptionsOrDefault(options: AbstractEventMessageOptions) {
|
||||
this.id = options.id ?? uuid();
|
||||
this.eventName = options.eventName;
|
||||
this.message = options.message ?? options.eventName;
|
||||
if (typeof options.ts === 'string') {
|
||||
this.ts = DateTime.fromISO(options.ts) ?? DateTime.now();
|
||||
} else {
|
||||
this.ts = options.ts ?? DateTime.now();
|
||||
}
|
||||
}
|
||||
|
||||
getEventName(): string {
|
||||
return this.eventName;
|
||||
}
|
||||
|
||||
toString() {
|
||||
return JSON.stringify(this.serialize());
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user