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. justkey007/tsc-alias#152 Co-authored-by: कारतोफ्फेलस्क्रिप्ट™ <aditya@netroy.in>
n8n-io · Jan 4, 2023 · b67f803 · b67f803
1 parent 0795cdb
commit b67f803
Show file tree

Hide file tree

Showing 104 changed files with 5,866 additions and 218 deletions.
diff --git a/cypress.config.js b/cypress.config.js
@@ -24,6 +24,8 @@ module.exports = defineConfig({
 						body: JSON.stringify(payload),
 						headers: { 'Content-Type': 'application/json' },
 					}),
+				'enable-feature': (feature) =>
+					fetch(BASE_URL + `/e2e/enable-feature/${feature}`, { method: 'POST' }),
 			});
 		},
 	},

diff --git a/cypress/e2e/10-settings-log-streaming.cy.ts b/cypress/e2e/10-settings-log-streaming.cy.ts
@@ -0,0 +1,120 @@
+import { randFirstName, randLastName } from '@ngneat/falso';
+import { DEFAULT_USER_EMAIL, DEFAULT_USER_PASSWORD } from '../constants';
+import { SettingsLogStreamingPage } from '../pages';
+
+const email = DEFAULT_USER_EMAIL;
+const password = DEFAULT_USER_PASSWORD;
+const firstName = randFirstName();
+const lastName = randLastName();
+const settingsLogStreamingPage = new SettingsLogStreamingPage();
+
+describe('Log Streaming Settings', () => {
+	before(() => {
+		cy.resetAll();
+		cy.setup({ email, firstName, lastName, password });
+	});
+
+	beforeEach(() => {
+		cy.signin({ email, password });
+	});
+
+	it('should show the unlicensed view when the feature is disabled', () => {
+		cy.visit('/settings/log-streaming');
+		settingsLogStreamingPage.getters.getActionBoxUnlicensed().should('be.visible');
+		settingsLogStreamingPage.getters.getContactUsButton().should('be.visible');
+		settingsLogStreamingPage.getters.getActionBoxLicensed().should('not.exist');
+	});
+
+	it('should show the licensed view when the feature is enabled', () => {
+		cy.enableFeature('logStreaming');
+		cy.visit('/settings/log-streaming');
+		settingsLogStreamingPage.getters.getActionBoxLicensed().should('be.visible');
+		settingsLogStreamingPage.getters.getAddFirstDestinationButton().should('be.visible');
+		settingsLogStreamingPage.getters.getActionBoxUnlicensed().should('not.exist');
+	});
+
+	it('should show the add destination modal', () => {
+		cy.visit('/settings/log-streaming');
+		settingsLogStreamingPage.actions.clickAddFirstDestination();
+		cy.wait(100);
+		settingsLogStreamingPage.getters.getDestinationModal().should('be.visible');
+		settingsLogStreamingPage.getters.getSelectDestinationType().should('be.visible');
+		settingsLogStreamingPage.getters.getSelectDestinationButton().should('be.visible');
+		settingsLogStreamingPage.getters.getSelectDestinationButton().should('have.attr', 'disabled');
+		settingsLogStreamingPage.getters
+			.getDestinationModalDialog()
+			.invoke('css', 'width')
+			.then((widthStr) => parseInt((widthStr as unknown as string).replace('px', '')))
+			.should('be.lessThan', 500);
+		settingsLogStreamingPage.getters.getSelectDestinationType().click();
+		settingsLogStreamingPage.getters.getSelectDestinationTypeItems().eq(0).click();
+		settingsLogStreamingPage.getters
+			.getSelectDestinationButton()
+			.should('not.have.attr', 'disabled');
+		settingsLogStreamingPage.getters.getDestinationModal().click(1, 1);
+		settingsLogStreamingPage.getters.getDestinationModal().should('not.exist');
+	});
+
+	it('should create a destination and delete it', () => {
+		cy.visit('/settings/log-streaming');
+		settingsLogStreamingPage.actions.clickAddFirstDestination();
+		cy.wait(100);
+		settingsLogStreamingPage.getters.getDestinationModal().should('be.visible');
+		settingsLogStreamingPage.getters.getSelectDestinationType().click();
+		settingsLogStreamingPage.getters.getSelectDestinationTypeItems().eq(0).click();
+		settingsLogStreamingPage.getters.getSelectDestinationButton().click();
+		settingsLogStreamingPage.getters
+			.getDestinationNameInput()
+			.click()
+			.clear()
+			.type('Destination 0');
+		settingsLogStreamingPage.getters.getDestinationSaveButton().click();
+		cy.wait(100);
+		settingsLogStreamingPage.getters.getDestinationModal().click(1, 1);
+		cy.reload();
+		settingsLogStreamingPage.getters.getDestinationCards().eq(0).click();
+		settingsLogStreamingPage.getters.getDestinationDeleteButton().should('be.visible').click();
+		cy.get('.el-message-box').should('be.visible').find('.btn--cancel').click();
+		settingsLogStreamingPage.getters.getDestinationDeleteButton().click();
+		cy.get('.el-message-box').should('be.visible').find('.btn--confirm').click();
+		cy.reload();
+	});
+
+	it('should create a destination and delete it via card actions', () => {
+		cy.visit('/settings/log-streaming');
+		settingsLogStreamingPage.actions.clickAddFirstDestination();
+		cy.wait(100);
+		settingsLogStreamingPage.getters.getDestinationModal().should('be.visible');
+		settingsLogStreamingPage.getters.getSelectDestinationType().click();
+		settingsLogStreamingPage.getters.getSelectDestinationTypeItems().eq(1).click();
+		settingsLogStreamingPage.getters.getSelectDestinationButton().click();
+		settingsLogStreamingPage.getters
+			.getDestinationNameInput()
+			.click()
+			.clear()
+			.type('Destination 1');
+		settingsLogStreamingPage.getters.getDestinationSaveButton().should('not.have.attr', 'disabled');
+		settingsLogStreamingPage.getters.getDestinationSaveButton().click();
+		cy.wait(100);
+		settingsLogStreamingPage.getters.getDestinationModal().click(1, 1);
+		cy.reload();
+
+		settingsLogStreamingPage.getters
+			.getDestinationCards()
+			.eq(0)
+			.find('.el-dropdown-selfdefine')
+			.click();
+		cy.get('.el-dropdown-menu').find('.el-dropdown-menu__item').eq(0).click();
+		settingsLogStreamingPage.getters.getDestinationSaveButton().should('not.exist');
+		settingsLogStreamingPage.getters.getDestinationModal().click(1, 1);
+
+		settingsLogStreamingPage.getters
+			.getDestinationCards()
+			.eq(0)
+			.find('.el-dropdown-selfdefine')
+			.click();
+		cy.get('.el-dropdown-menu').find('.el-dropdown-menu__item').eq(1).click();
+		cy.get('.el-message-box').should('be.visible').find('.btn--confirm').click();
+		cy.reload();
+	});
+});
diff --git a/cypress/e2e/11-inline-expression-editor.cy.ts b/cypress/e2e/11-inline-expression-editor.cy.ts
@@ -4,7 +4,7 @@ const WorkflowPage = new WorkflowPageClass();
 
 describe('Inline expression editor', () => {
 	before(() => {
-		cy.task('reset');
+		cy.resetAll();
 		cy.skipSetup();
 	});
 

diff --git a/cypress/e2e/9-expression-editor-modal.cy.ts b/cypress/e2e/9-expression-editor-modal.cy.ts
@@ -4,7 +4,7 @@ const WorkflowPage = new WorkflowPageClass();
 
 describe('Expression editor modal', () => {
 	before(() => {
-		cy.task('reset');
+		cy.resetAll();
 		cy.skipSetup();
 	});
 

diff --git a/cypress/pages/index.ts b/cypress/pages/index.ts
@@ -6,4 +6,5 @@ export * from './workflows';
 export * from './workflow';
 export * from './modals';
 export * from './settings-users';
+export * from './settings-log-streaming';
 export * from './ndv';
diff --git a/cypress/pages/settings-log-streaming.ts b/cypress/pages/settings-log-streaming.ts
@@ -0,0 +1,26 @@
+import { BasePage } from './base';
+
+export class SettingsLogStreamingPage extends BasePage {
+	url = '/settings/log-streaming';
+	getters = {
+		getActionBoxUnlicensed: () => cy.getByTestId('action-box-unlicensed'),
+		getActionBoxLicensed: () => cy.getByTestId('action-box-licensed'),
+		getDestinationModal: () => cy.getByTestId('destination-modal'),
+		getDestinationModalDialog: () => this.getters.getDestinationModal().find('.el-dialog'),
+		getSelectDestinationType: () => cy.getByTestId('select-destination-type'),
+		getDestinationNameInput: () => cy.getByTestId('subtitle-showing-type'),
+		getSelectDestinationTypeItems: () =>
+			this.getters.getSelectDestinationType().find('.el-select-dropdown__item'),
+		getSelectDestinationButton: () => cy.getByTestId('select-destination-button'),
+		getContactUsButton: () => this.getters.getActionBoxUnlicensed().find('button'),
+		getAddFirstDestinationButton: () => this.getters.getActionBoxLicensed().find('button'),
+		getDestinationSaveButton: () => cy.getByTestId('destination-save-button').find('button'),
+		getDestinationDeleteButton: () => cy.getByTestId('destination-delete-button'),
+		getDestinationCards: () => cy.getByTestId('destination-card'),
+	};
+	actions = {
+		clickContactUs: () => this.getters.getContactUsButton().click(),
+		clickAddFirstDestination: () => this.getters.getAddFirstDestinationButton().click(),
+		clickSelectDestinationButton: () => this.getters.getSelectDestinationButton().click(),
+	};
+}
diff --git a/cypress/support/commands.ts b/cypress/support/commands.ts
@@ -140,6 +140,10 @@ Cypress.Commands.add('setupOwner', (payload) => {
 	cy.task('setup-owner', payload);
 });
 
+Cypress.Commands.add('enableFeature', (feature) => {
+	cy.task('enable-feature', feature);
+});
+
 Cypress.Commands.add('grantBrowserPermissions', (...permissions: string[]) => {
 	if (Cypress.isBrowser('chrome')) {
 		cy.wrap(

diff --git a/cypress/support/index.ts b/cypress/support/index.ts
@@ -27,6 +27,7 @@ declare global {
 			setupOwner(payload: SetupPayload): void;
 			skipSetup(): void;
 			resetAll(): void;
+			enableFeature(feature: string): void;
 			waitForLoad(): void;
 			grantBrowserPermissions(...permissions: string[]): void;
 			readClipboard(): Chainable<string>;

diff --git a/package.json b/package.json
@@ -27,6 +27,7 @@
     "webhook": "./packages/cli/bin/n8n webhook",
     "worker": "./packages/cli/bin/n8n worker",
     "cypress:install": "cypress install",
+    "cypress:open": "CYPRESS_BASE_URL=http://localhost:8080 cypress open",
     "test:e2e:ui": "cross-env E2E_TESTS=true start-server-and-test start http://localhost:5678/favicon.ico 'cypress open'",
     "test:e2e:dev": "cross-env E2E_TESTS=true CYPRESS_BASE_URL=http://localhost:8080 start-server-and-test dev http://localhost:8080/favicon.ico 'cypress open'",
     "test:e2e:smoke": "cross-env E2E_TESTS=true start-server-and-test start http://localhost:5678/favicon.ico 'cypress run --headless --spec \"cypress/e2e/0-smoke.cy.ts\"'",

diff --git a/packages/cli/jest.config.js b/packages/cli/jest.config.js
@@ -6,6 +6,7 @@ module.exports = {
 	},
 	globalSetup: '<rootDir>/test/setup.ts',
 	globalTeardown: '<rootDir>/test/teardown.ts',
+	setupFilesAfterEnv: ['<rootDir>/test/setup-mocks.ts'],
 	moduleNameMapper: {
 		'^@/(.*)$': '<rootDir>/src/$1',
 		'^@db/(.*)$': '<rootDir>/src/databases/$1',

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -75,11 +75,15 @@
     "@types/localtunnel": "^1.9.0",
     "@types/lodash.get": "^4.4.6",
     "@types/lodash.intersection": "^4.4.7",
+    "@types/lodash.iteratee": "^4.7.7",
     "@types/lodash.merge": "^4.6.6",
     "@types/lodash.omit": "^4.5.7",
     "@types/lodash.pick": "^4.4.7",
+    "@types/lodash.remove": "^4.7.7",
     "@types/lodash.set": "^4.3.6",
     "@types/lodash.split": "^4.4.7",
+    "@types/lodash.unionby": "^4.8.7",
+    "@types/lodash.uniqby": "^4.7.7",
     "@types/lodash.unset": "^4.5.7",
     "@types/parseurl": "^1.3.1",
     "@types/passport-jwt": "^3.0.6",
@@ -90,6 +94,7 @@
     "@types/superagent": "4.1.13",
     "@types/supertest": "^2.0.11",
     "@types/swagger-ui-express": "^4.1.3",
+    "@types/syslog-client": "^1.1.2",
     "@types/uuid": "^8.3.2",
     "@types/validator": "^13.7.0",
     "@types/yamljs": "^0.2.31",
@@ -142,12 +147,17 @@
     "localtunnel": "^2.0.0",
     "lodash.get": "^4.4.2",
     "lodash.intersection": "^4.4.0",
+    "lodash.iteratee": "^4.7.0",
     "lodash.merge": "^4.6.2",
     "lodash.omit": "^4.5.0",
     "lodash.pick": "^4.4.0",
+    "lodash.remove": "^4.7.0",
     "lodash.set": "^4.3.2",
     "lodash.split": "^4.4.2",
+    "lodash.unionby": "^4.8.0",
+    "lodash.uniqby": "^4.7.0",
     "lodash.unset": "^4.5.2",
+    "luxon": "^3.1.0",
     "mysql2": "~2.3.0",
     "n8n-core": "~0.149.2",
     "n8n-editor-ui": "~0.175.4",
@@ -174,6 +184,8 @@
     "sqlite3": "^5.1.2",
     "sse-channel": "^4.0.0",
     "swagger-ui-express": "^4.3.0",
+    "syslog-client": "^1.1.1",
+    "threads": "^1.7.0",
     "tslib": "1.14.1",
     "typeorm": "0.2.45",
     "uuid": "^8.3.2",

diff --git a/packages/cli/src/Db.ts b/packages/cli/src/Db.ts
@@ -180,6 +180,8 @@ export async function init(
 	collections.InstalledNodes = linkRepository(entities.InstalledNodes);
 	collections.WorkflowStatistics = linkRepository(entities.WorkflowStatistics);
 
+	collections.EventDestinations = linkRepository(entities.EventDestinations);
+
 	isInitialized = true;
 
 	return collections;