refactor(core): Improve instance owner setup and add unit tests (no-changelog) (#5499)

* refactor(core): Avoid fetching all workflows and credentials for the owner setup screen

* refactor(core): Add unit tests for the owner controller

packages/cli/src/controllers/owner.controller.ts

@@ -1,6 +1,6 @@
 import validator from 'validator';
 import { validateEntity } from '@/GenericHelpers';
-import { Post, RestController } from '@/decorators';
+import { Get, Post, RestController } from '@/decorators';
 import { BadRequestError } from '@/ResponseHelper';
 import {
 	hashPassword,
@@ -13,9 +13,10 @@ import type { Repository } from 'typeorm';
 import type { ILogger } from 'n8n-workflow';
 import type { Config } from '@/config';
 import { OwnerRequest } from '@/requests';
-import type { IDatabaseCollections, IInternalHooksClass } from '@/Interfaces';
+import type { IDatabaseCollections, IInternalHooksClass, ICredentialsDb } from '@/Interfaces';
 import type { Settings } from '@db/entities/Settings';
 import type { User } from '@db/entities/User';
+import type { WorkflowEntity } from '@db/entities/WorkflowEntity';
 
 @RestController('/owner')
 export class OwnerController {
@@ -29,6 +30,10 @@ export class OwnerController {
 
 	private readonly settingsRepository: Repository<Settings>;
 
+	private readonly credentialsRepository: Repository<ICredentialsDb>;
+
+	private readonly workflowsRepository: Repository<WorkflowEntity>;
+
 	constructor({
 		config,
 		logger,
@@ -38,23 +43,38 @@ export class OwnerController {
 		config: Config;
 		logger: ILogger;
 		internalHooks: IInternalHooksClass;
-		repositories: Pick<IDatabaseCollections, 'User' | 'Settings'>;
+		repositories: Pick<IDatabaseCollections, 'User' | 'Settings' | 'Credentials' | 'Workflow'>;
 	}) {
 		this.config = config;
 		this.logger = logger;
 		this.internalHooks = internalHooks;
 		this.userRepository = repositories.User;
 		this.settingsRepository = repositories.Settings;
+		this.credentialsRepository = repositories.Credentials;
+		this.workflowsRepository = repositories.Workflow;
+	}
+
+	@Get('/pre-setup')
+	async preSetup(): Promise<{ credentials: number; workflows: number }> {
+		if (this.config.getEnv('userManagement.isInstanceOwnerSetUp')) {
+			throw new BadRequestError('Instance owner already setup');
+		}
+
+		const [credentials, workflows] = await Promise.all([
+			this.credentialsRepository.countBy({}),
+			this.workflowsRepository.countBy({}),
+		]);
+		return { credentials, workflows };
 	}
 
 	/**
 	 * Promote a shell into the owner of the n8n instance,
 	 * and enable `isInstanceOwnerSetUp` setting.
 	 */
-	@Post('/')
-	async promoteOwner(req: OwnerRequest.Post, res: Response) {
+	@Post('/setup')
+	async setupOwner(req: OwnerRequest.Post, res: Response) {
 		const { email, firstName, lastName, password } = req.body;
-		const { id: userId } = req.user;
+		const { id: userId, globalRole } = req.user;
 
 		if (this.config.getEnv('userManagement.isInstanceOwnerSetUp')) {
 			this.logger.debug(
@@ -63,7 +83,7 @@ export class OwnerController {
 					userId,
 				},
 			);
-			throw new BadRequestError('Invalid request');
+			throw new BadRequestError('Instance owner already setup');
 		}
 
 		if (!email || !validator.isEmail(email)) {
@@ -84,12 +104,8 @@ export class OwnerController {
 			throw new BadRequestError('First and last names are mandatory');
 		}
 
-		let owner = await this.userRepository.findOne({
-			relations: ['globalRole'],
-			where: { id: userId },
-		});
-
-		if (!owner || (owner.globalRole.scope === 'global' && owner.globalRole.name !== 'owner')) {
+		// TODO: This check should be in a middleware outside this class
+		if (globalRole.scope === 'global' && globalRole.name !== 'owner') {
 			this.logger.debug(
 				'Request to claim instance ownership failed because user shell does not exist or has wrong role!',
 				{
@@ -99,6 +115,8 @@ export class OwnerController {
 			throw new BadRequestError('Invalid request');
 		}
 
+		let owner = req.user;
+
 		Object.assign(owner, {
 			email,
 			firstName,
@@ -110,7 +128,7 @@ export class OwnerController {
 
 		owner = await this.userRepository.save(owner);
 
-		this.logger.info('Owner was set up successfully', { userId: req.user.id });
+		this.logger.info('Owner was set up successfully', { userId });
 
 		await this.settingsRepository.update(
 			{ key: 'userManagement.isInstanceOwnerSetUp' },
@@ -119,7 +137,7 @@ export class OwnerController {
 
 		this.config.set('userManagement.isInstanceOwnerSetUp', true);
 
-		this.logger.debug('Setting isInstanceOwnerSetUp updated successfully', { userId: req.user.id });
+		this.logger.debug('Setting isInstanceOwnerSetUp updated successfully', { userId });
 
 		await issueCookie(res, owner);