Refactorings from user management walkthrough

packages/cli/commands/start.ts

@@ -389,6 +389,12 @@ export class Start extends Command {
 				const editorUrl = GenericHelpers.getBaseUrl();
 				this.log(`\nEditor is now accessible via:\n${editorUrl}`);
 
+				const saveManualExecutions = config.get('executions.saveDataManualExecutions') as boolean;
+
+				if (saveManualExecutions) {
+					this.log('\nManual executions will be visible only for the owner');
+				}
+
 				// Allow to open n8n editor by pressing "o"
 				if (Boolean(process.stdout.isTTY) && process.stdin.setRawMode) {
 					process.stdin.setRawMode(true);

packages/cli/commands/user-management/reset.ts

@@ -50,7 +50,10 @@ export class Reset extends Command {
 			await Db.collections.User!.delete({ id: Not(owner.id) });
 			await Db.collections.User!.save(Object.assign(owner, this.defaultUserProps));
 
-			await Db.collections.Settings!.update({ key: 'userManagement.hasOwner' }, { value: 'false' });
+			await Db.collections.Settings!.update(
+				{ key: 'userManagement.isInstanceOwnerSetUp' },
+				{ value: 'false' },
+			);
 		} catch (error) {
 			console.error('Error resetting database. See log messages for details.');
 			if (error instanceof Error) logger.error(error.message);

packages/cli/src/CredentialsHelper.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
 /* eslint-disable no-restricted-syntax */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
@@ -218,40 +219,40 @@ export class CredentialsHelper extends ICredentialsHelper {
 	/**
 	 * Returns the credentials instance
 	 *
-	 * @param {INodeCredentialsDetails} nodeCredentials id and name to return instance of
-	 * @param {string} type Type of the credentials to return instance of
+	 * @param {INodeCredentialsDetails} nodeCredential id and name to return instance of
+	 * @param {string} type Type of the credential to return instance of
 	 * @returns {Credentials}
 	 * @memberof CredentialsHelper
 	 */
 	async getCredentials(
-		nodeCredentials: INodeCredentialsDetails,
+		nodeCredential: INodeCredentialsDetails,
 		type: string,
 		userId?: string,
 	): Promise<Credentials> {
-		if (!nodeCredentials.id) {
-			throw new Error(`Credentials "${nodeCredentials.name}" for type "${type}" don't have an ID.`);
+		if (!nodeCredential.id) {
+			throw new Error(`Credential "${nodeCredential.name}" of type "${type}" has no ID.`);
 		}
 
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		const qb = Db.collections.Credentials!.createQueryBuilder('c');
-		qb.where('c.id = :id and c.type = :type', { id: nodeCredentials.id, type });
-		if (userId) {
-			// TODO UM: implement this.
-			// qb.
-		}
-		const credentials = await qb.getOne();
+		const credential = userId
+			? await Db.collections
+					.SharedCredentials!.findOneOrFail({
+						relations: ['credentials'],
+						where: { credentials: { id: nodeCredential.id, type }, user: { id: userId } },
+					})
+					.then((shared) => shared.credentials)
+			: await Db.collections.Credentials!.findOneOrFail({ id: nodeCredential.id, type });
 
-		if (!credentials) {
+		if (!credential) {
 			throw new Error(
-				`Credentials with ID "${nodeCredentials.id}" don't exist for type "${type}".`,
+				`Credential with ID "${nodeCredential.id}" does not exist for type "${type}".`,
 			);
 		}
 
 		return new Credentials(
-			{ id: credentials.id.toString(), name: credentials.name },
-			credentials.type,
-			credentials.nodesAccess,
-			credentials.data,
+			{ id: credential.id.toString(), name: credential.name },
+			credential.type,
+			credential.nodesAccess,
+			credential.data,
 		);
 	}
 

packages/cli/src/Server.ts

@@ -315,7 +315,7 @@ class App {
 			userManagement: {
 				enabled:
 					config.get('userManagement.disabled') === false ||
-					config.get('userManagement.hasOwner') === true,
+					config.get('userManagement.isInstanceOwnerSetUp') === true,
 				// showSetupOnFirstLoad: config.get('userManagement.disabled') === false, // && config.get('userManagement.skipOwnerSetup') === true
 				smtpSetup: config.get('userManagement.emails.mode') === 'smtp',
 			},
@@ -1269,7 +1269,7 @@ class App {
 					throw new ResponseHelper.ResponseError('Workflow tags are disabled');
 				}
 				if (
-					config.get('userManagement.hasOwner') === true &&
+					config.get('userManagement.isInstanceOwnerSetUp') === true &&
 					(req.user as User).globalRole.name !== 'owner'
 				) {
 					throw new ResponseHelper.ResponseError(

packages/cli/src/UserManagement/UserManagementHelper.ts

@@ -56,6 +56,15 @@ export function sanitizeUser(user: User): PublicUser {
 	return sanitizedUser;
 }
 
+/**
+ * Check if a URL contains an auth-excluded endpoint.
+ */
+export function isAuthExcluded(url: string, ignoredEndpoints: string[]): boolean {
+	return !!ignoredEndpoints
+		.filter(Boolean) // skip empty paths
+		.find((ignoredEndpoint) => url.includes(ignoredEndpoint));
+}
+
 /**
  * Check if the endpoint is `POST /users/:id`.
  */

packages/cli/src/UserManagement/email/UserManagementMailer.ts

@@ -1,6 +1,8 @@
+/* eslint-disable import/no-cycle */
 import { existsSync, readFileSync } from 'fs';
 import { IDataObject } from 'n8n-workflow';
 import { join as pathJoin } from 'path';
+import { GenericHelpers } from '../..';
 import config = require('../../../config');
 import {
 	InviteEmailData,
@@ -10,8 +12,11 @@ import {
 } from './Interfaces';
 import { NodeMailer } from './NodeMailer';
 
-function getTemplate(configKeyName: string, defaultFilename: string) {
-	const templateOverride = config.get(`userManagement.emails.templates.${configKeyName}`) as string;
+async function getTemplate(configKeyName: string, defaultFilename: string) {
+	const templateOverride = (await GenericHelpers.getConfigValue(
+		`userManagement.emails.templates.${configKeyName}`,
+	)) as string;
+
 	let template;
 	if (templateOverride && existsSync(templateOverride)) {
 		template = readFileSync(templateOverride, {
@@ -46,7 +51,7 @@ export class UserManagementMailer {
 	}
 
 	async invite(inviteEmailData: InviteEmailData): Promise<SendEmailResult> {
-		let template = getTemplate('invite', 'invite.html');
+		let template = await getTemplate('invite', 'invite.html');
 		template = replaceStrings(template, inviteEmailData);
 
 		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -61,7 +66,7 @@ export class UserManagementMailer {
 	}
 
 	async passwordReset(passwordResetData: PasswordResetData): Promise<SendEmailResult> {
-		let template = getTemplate('passwordReset', 'passwordReset.html');
+		let template = await getTemplate('passwordReset', 'passwordReset.html');
 		template = replaceStrings(template, passwordResetData);
 
 		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion

packages/cli/src/UserManagement/email/index.ts

@@ -1,3 +1,4 @@
+/* eslint-disable import/no-cycle */
 import { getInstance, UserManagementMailer } from './UserManagementMailer';
 
 export { getInstance, UserManagementMailer };

packages/cli/src/UserManagement/routes/index.ts

@@ -19,7 +19,7 @@ import { usersNamespace } from './users';
 import { passwordResetNamespace } from './passwordReset';
 import { AuthenticatedRequest } from '../../requests';
 import { ownerNamespace } from './owner';
-import { isAuthenticatedRequest, isPostUsersId } from '../UserManagementHelper';
+import { isAuthExcluded, isPostUsersId, isAuthenticatedRequest } from '../UserManagementHelper';
 
 export function addRoutes(this: N8nApp, ignoredEndpoints: string[], restEndpoint: string): void {
 	// needed for testing; not adding overhead since it directly returns if req.cookies exists
@@ -65,22 +65,12 @@ export function addRoutes(this: N8nApp, ignoredEndpoints: string[], restEndpoint
 			isPostUsersId(req, restEndpoint) ||
 			req.url.startsWith(`/${restEndpoint}/forgot-password`) ||
 			req.url.startsWith(`/${restEndpoint}/resolve-password-token`) ||
-			req.url.startsWith(`/${restEndpoint}/change-password`)
+			req.url.startsWith(`/${restEndpoint}/change-password`) ||
+			isAuthExcluded(req.url, ignoredEndpoints)
 		) {
 			return next();
 		}
 
-		for (let i = 0; i < ignoredEndpoints.length; i++) {
-			const path = ignoredEndpoints[i];
-			if (!path) {
-				// Skip empty paths (they might exist)
-				// eslint-disable-next-line no-continue
-				continue;
-			}
-			if (req.url.includes(path)) {
-				return next();
-			}
-		}
 		return passport.authenticate('jwt', { session: false })(req, res, next);
 	});
 

packages/cli/src/UserManagement/routes/owner.ts

@@ -17,15 +17,15 @@ import { sanitizeUser, validatePassword } from '../UserManagementHelper';
 export function ownerNamespace(this: N8nApp): void {
 	/**
 	 * Promote a shell into the owner of the n8n instance,
-	 * and enable `hasOwner` instance setting.
+	 * and enable `isInstanceOwnerSetUp` setting.
 	 */
 	this.app.post(
 		`/${this.restEndpoint}/owner`,
 		ResponseHelper.send(async (req: OwnerRequest.Post, res: express.Response) => {
 			const { email, firstName, lastName, password } = req.body;
 			const { id: userId } = req.user;
 
-			if (config.get('userManagement.hasOwner')) {
+			if (config.get('userManagement.isInstanceOwnerSetUp')) {
 				Logger.debug(
 					'Request to claim instance ownership failed because instance owner already exists',
 					{
@@ -79,14 +79,14 @@ export function ownerNamespace(this: N8nApp): void {
 
 			Logger.info('Owner updated successfully', { userId: req.user.id });
 
-			config.set('userManagement.hasOwner', true);
+			config.set('userManagement.isInstanceOwnerSetUp', true);
 
 			await Db.collections.Settings!.update(
-				{ key: 'userManagement.hasOwner' },
+				{ key: 'userManagement.isInstanceOwnerSetUp' },
 				{ value: JSON.stringify(true) },
 			);
 
-			Logger.debug('Setting hasOwner updated successfully', { userId: req.user.id });
+			Logger.debug('Setting isInstanceOwnerSetUp updated successfully', { userId: req.user.id });
 
 			await issueCookie(res, owner);
 

packages/cli/src/UserManagement/routes/users.ts

@@ -41,7 +41,7 @@ export function usersNamespace(this: N8nApp): void {
 				);
 			}
 
-			if (!config.get('userManagement.hasOwner')) {
+			if (!config.get('userManagement.isInstanceOwnerSetUp')) {
 				Logger.debug(
 					'Request to send email invite(s) to user(s) failed because emailing was not set up',
 				);

packages/cli/src/databases/entities/User.ts

@@ -10,6 +10,7 @@ import {
 	ManyToOne,
 	PrimaryGeneratedColumn,
 	UpdateDateColumn,
+	AfterLoad,
 } from 'typeorm';
 import { IsEmail, IsString, Length } from 'class-validator';
 import config = require('../../../config');
@@ -119,4 +120,14 @@ export class User {
 	setUpdateDate(): void {
 		this.updatedAt = new Date();
 	}
+
+	/**
+	 * Whether the user is pending setup completion.
+	 */
+	isPending: boolean;
+
+	@AfterLoad()
+	computeIsPending(): void {
+		this.isPending = !!this.password;
+	}
 }

packages/cli/src/databases/mysqldb/migrations/1626183952959-AddWaitColumn.ts

@@ -1,11 +1,15 @@
 import {MigrationInterface, QueryRunner} from "typeorm";
 import * as config from '../../../../config';
+import { isTestRun } from "../../../../test/integration/shared/utils";
 
 export class AddWaitColumnId1626183952959 implements MigrationInterface {
 	name = 'AddWaitColumnId1626183952959';
 
 	async up(queryRunner: QueryRunner): Promise<void> {
 		const tablePrefix = config.get('database.tablePrefix');
+		!isTestRun && console.log(
+			'\n\nINFO: Started with migration for wait functionality.\n Depending on the number of saved executions, that may take a little bit.\n\n',
+		);
 
 		await queryRunner.query('ALTER TABLE `' + tablePrefix + 'execution_entity` ADD `waitTill` DATETIME NULL');
 		await queryRunner.query('CREATE INDEX `IDX_' + tablePrefix + 'ca4a71b47f28ac6ea88293a8e2` ON `' + tablePrefix + 'execution_entity` (`waitTill`)');

packages/cli/src/databases/mysqldb/migrations/1630451444017-UpdateWorkflowCredentials.ts

@@ -1,5 +1,6 @@
 import { MigrationInterface, QueryRunner } from 'typeorm';
 import config = require('../../../../config');
+import { isTestRun } from '../../../../test/integration/shared/utils';
 import { MigrationHelpers } from '../../MigrationHelpers';
 
 // replacing the credentials in workflows and execution
@@ -9,6 +10,8 @@ export class UpdateWorkflowCredentials1630451444017 implements MigrationInterfac
 	name = 'UpdateWorkflowCredentials1630451444017';
 
 	public async up(queryRunner: QueryRunner): Promise<void> {
+		!isTestRun && console.log('Start migration', this.name);
+		!isTestRun && console.time(this.name);
 		const tablePrefix = config.get('database.tablePrefix');
 		const helpers = new MigrationHelpers(queryRunner);
 

packages/cli/src/databases/mysqldb/migrations/1636626154933-CreateUserManagement.ts

@@ -244,7 +244,7 @@ export class CreateUserManagement1636626154933 implements MigrationInterface {
 			'INSERT INTO `' +
 				tablePrefix +
 				'settings` (`key`, value, loadOnStartup) values  ' +
-				'("userManagement.hasOwner", "false", 1)',
+				'("userManagement.isInstanceOwnerSetUp", "false", 1)',
 		);
 	}
 

packages/cli/src/databases/postgresdb/migrations/1626176912946-AddwaitTill.ts

@@ -1,5 +1,6 @@
 import {MigrationInterface, QueryRunner} from "typeorm";
 import * as config from '../../../../config';
+import { isTestRun } from "../../../../test/integration/shared/utils";
 
 export class AddwaitTill1626176912946 implements MigrationInterface {
 	name = 'AddwaitTill1626176912946';
@@ -12,6 +13,11 @@ export class AddwaitTill1626176912946 implements MigrationInterface {
 			tablePrefix = schema + '.' + tablePrefix;
 		}
 
+		!isTestRun &&
+			console.log(
+				'\n\nINFO: Started with migration for wait functionality.\n Depending on the number of saved executions, that may take a little bit.\n\n',
+			);
+
 		await queryRunner.query(`ALTER TABLE ${tablePrefix}execution_entity ADD "waitTill" TIMESTAMP`);
 		await queryRunner.query(`CREATE INDEX IF NOT EXISTS IDX_${tablePrefixPure}ca4a71b47f28ac6ea88293a8e2 ON ${tablePrefix}execution_entity ("waitTill")`);
 	}

packages/cli/src/databases/postgresdb/migrations/1630419189837-UpdateWorkflowCredentials.ts

@@ -1,5 +1,6 @@
 import { MigrationInterface, QueryRunner } from 'typeorm';
 import config = require('../../../../config');
+import { isTestRun } from '../../../../test/integration/shared/utils';
 import { MigrationHelpers } from '../../MigrationHelpers';
 
 // replacing the credentials in workflows and execution
@@ -9,6 +10,8 @@ export class UpdateWorkflowCredentials1630419189837 implements MigrationInterfac
 	name = 'UpdateWorkflowCredentials1630419189837';
 
 	public async up(queryRunner: QueryRunner): Promise<void> {
+		!isTestRun && console.log('Start migration', this.name);
+		!isTestRun && console.time(this.name);
 		let tablePrefix = config.get('database.tablePrefix');
 		const schema = config.get('database.postgresdb.schema');
 		if (schema) {

packages/cli/src/databases/postgresdb/migrations/1636626154934-CreateUserManagement.ts

@@ -230,7 +230,7 @@ export class CreateUserManagement1636626154934 implements MigrationInterface {
 			'INSERT INTO "' +
 				tablePrefix +
 				'settings" ("key", "value", "loadOnStartup") values  ' +
-				"('userManagement.hasOwner', 'false', true)",
+				"('userManagement.isInstanceOwnerSetUp', 'false', true)",
 		);
 	}
 

packages/cli/src/databases/sqlite/migrations/1621707690587-AddWaitColumn.ts

@@ -1,11 +1,16 @@
 import { MigrationInterface, QueryRunner } from 'typeorm';
 import * as config from '../../../../config';
+import { isTestRun } from '../../../../test/integration/shared/utils';
 
 export class AddWaitColumn1621707690587 implements MigrationInterface {
 	name = 'AddWaitColumn1621707690587';
 
 	async up(queryRunner: QueryRunner): Promise<void> {
 		const tablePrefix = config.get('database.tablePrefix');
+		!isTestRun &&
+			console.log(
+				'\n\nINFO: Started with migration for wait functionality.\n Depending on the number of saved executions, that may take a little bit.\n\n',
+			);
 
 		await queryRunner.query(`DROP TABLE IF EXISTS "${tablePrefix}temporary_execution_entity"`);
 		await queryRunner.query(`CREATE TABLE "${tablePrefix}temporary_execution_entity" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "data" text NOT NULL, "finished" boolean NOT NULL, "mode" varchar NOT NULL, "retryOf" varchar, "retrySuccessId" varchar, "startedAt" datetime NOT NULL, "stoppedAt" datetime, "workflowData" text NOT NULL, "workflowId" varchar, "waitTill" DATETIME)`, undefined);

packages/cli/src/databases/sqlite/migrations/1630330987096-UpdateWorkflowCredentials.ts

@@ -1,5 +1,6 @@
 import { MigrationInterface, QueryRunner } from 'typeorm';
 import config = require('../../../../config');
+import { isTestRun } from '../../../../test/integration/shared/utils';
 import { MigrationHelpers } from '../../MigrationHelpers';
 
 // replacing the credentials in workflows and execution
@@ -9,6 +10,8 @@ export class UpdateWorkflowCredentials1630330987096 implements MigrationInterfac
 	name = 'UpdateWorkflowCredentials1630330987096';
 
 	public async up(queryRunner: QueryRunner): Promise<void> {
+		!isTestRun && console.log('Start migration', this.name);
+		!isTestRun && console.time(this.name);
 		const tablePrefix = config.get('database.tablePrefix');
 		const helpers = new MigrationHelpers(queryRunner);
 

packages/cli/src/databases/sqlite/migrations/1636626154932-CreateUserManagement.ts

@@ -95,7 +95,7 @@ export class CreateUserManagement1636626154932 implements MigrationInterface {
 
 		await queryRunner.query(`
 			INSERT INTO "${tablePrefix}settings" (key, value, loadOnStartup) values
-			('userManagement.hasOwner', 'false', true)
+			('userManagement.isInstanceOwnerSetUp', 'false', true)
 		`);
 	}