feat: add self-hosted operations module with initial user creation and configuration checks

Author: Artuomka

backend/src/app.module.ts

@@ -47,6 +47,7 @@ import { PersonalTableSettingsModule } from './entities/table-settings/personal-
 import { SavedDbQueryModule } from './entities/visualizations/saved-db-query/saved-db-query.module.js';
 import { DashboardModule } from './entities/visualizations/dashboard/dashboards.module.js';
 import { DashboardWidgetModule } from './entities/visualizations/dashboard-widget/dashboard-widget.module.js';
+import { SelfHostedOperationsModule } from './selfhosted-operations/selhosted-operations.module.js';
 
 @Module({
 	imports: [
@@ -98,6 +99,7 @@ import { DashboardWidgetModule } from './entities/visualizations/dashboard-widge
 		SavedDbQueryModule,
 		DashboardModule,
 		DashboardWidgetModule,
+		SelfHostedOperationsModule,
 	],
 	controllers: [AppController],
 	providers: [

backend/src/common/data-injection.tokens.ts

@@ -202,4 +202,7 @@ export enum UseCaseType {
 	CREATE_DASHBOARD_WIDGET = 'CREATE_DASHBOARD_WIDGET',
 	UPDATE_DASHBOARD_WIDGET = 'UPDATE_DASHBOARD_WIDGET',
 	DELETE_DASHBOARD_WIDGET = 'DELETE_DASHBOARD_WIDGET',
+
+	IS_CONFIGURED = 'IS_CONFIGURED',
+	CREATE_INITIAL_USER = 'CREATE_INITIAL_USER',
 }

backend/src/entities/ai/ai-conversation-history/ai-chat-messages/ai-chat-message.entity.ts

@@ -34,6 +34,7 @@ export class AiChatMessageEntity {
 	@ManyToOne(
 		() => UserAiChatEntity,
 		(ai_chat) => ai_chat.messages,
+		{ onDelete: 'CASCADE' },
 	)
 	@JoinColumn({ name: 'ai_chat_id' })
 	ai_chat: Relation<UserAiChatEntity>;

backend/src/entities/ai/ai-conversation-history/user-ai-chat/user-ai-chat.entity.ts

@@ -29,6 +29,7 @@ export class UserAiChatEntity {
 	@ManyToOne(
 		() => UserEntity,
 		(user) => user.ai_chats,
+		{ onDelete: 'CASCADE' },
 	)
 	@JoinColumn({ name: 'user_id' })
 	user: Relation<UserEntity>;

backend/src/exceptions/text/messages.ts

@@ -382,4 +382,6 @@ export const Messages = {
 	SECRET_DELETED_SUCCESSFULLY: 'Secret deleted successfully',
 	USER_NOT_FOUND_OR_NOT_IN_COMPANY: 'User not found or not associated with a company',
 	PERSONAL_TABLE_SETTINGS_NOT_FOUND: 'Personal table settings with this parameters not found',
+	SELF_HOSTED_ALREADY_CONFIGURED: 'Instance is already configured',
+	ENDPOINT_NOT_AVAILABLE_IN_THIS_MODE: 'This endpoint is not available in the current mode',
 };

backend/src/migrations/1770043047971-AddedCascadeOptionToAiChatEntities.ts

@@ -0,0 +1,27 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class AddedCascadeOptionToAiChatEntities1770043047971 implements MigrationInterface {
+	name = 'AddedCascadeOptionToAiChatEntities1770043047971';
+
+	public async up(queryRunner: QueryRunner): Promise<void> {
+		await queryRunner.query(`ALTER TABLE "ai_chat_message" DROP CONSTRAINT "FK_03bc49058afd5262d6a503bf123"`);
+		await queryRunner.query(`ALTER TABLE "user_ai_chat" DROP CONSTRAINT "FK_0f95dbd767d42e637345636cb5d"`);
+		await queryRunner.query(
+			`ALTER TABLE "ai_chat_message" ADD CONSTRAINT "FK_03bc49058afd5262d6a503bf123" FOREIGN KEY ("ai_chat_id") REFERENCES "user_ai_chat"("id") ON DELETE CASCADE ON UPDATE NO ACTION`,
+		);
+		await queryRunner.query(
+			`ALTER TABLE "user_ai_chat" ADD CONSTRAINT "FK_0f95dbd767d42e637345636cb5d" FOREIGN KEY ("user_id") REFERENCES "user"("id") ON DELETE CASCADE ON UPDATE NO ACTION`,
+		);
+	}
+
+	public async down(queryRunner: QueryRunner): Promise<void> {
+		await queryRunner.query(`ALTER TABLE "user_ai_chat" DROP CONSTRAINT "FK_0f95dbd767d42e637345636cb5d"`);
+		await queryRunner.query(`ALTER TABLE "ai_chat_message" DROP CONSTRAINT "FK_03bc49058afd5262d6a503bf123"`);
+		await queryRunner.query(
+			`ALTER TABLE "user_ai_chat" ADD CONSTRAINT "FK_0f95dbd767d42e637345636cb5d" FOREIGN KEY ("user_id") REFERENCES "user"("id") ON DELETE NO ACTION ON UPDATE NO ACTION`,
+		);
+		await queryRunner.query(
+			`ALTER TABLE "ai_chat_message" ADD CONSTRAINT "FK_03bc49058afd5262d6a503bf123" FOREIGN KEY ("ai_chat_id") REFERENCES "user_ai_chat"("id") ON DELETE NO ACTION ON UPDATE NO ACTION`,
+		);
+	}
+}

backend/src/selfhosted-operations/application/data-structures/create-initial-user.ds.ts

@@ -0,0 +1,4 @@
+export class CreateInitialUserDs {
+	email: string;
+	password: string;
+}

backend/src/selfhosted-operations/application/dto/create-initial-admin-user.dto.ts

@@ -0,0 +1,17 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsEmail, IsNotEmpty, IsString, MaxLength, MinLength } from 'class-validator';
+
+export class CreateInitialUserDto {
+  @ApiProperty({ description: 'User email' })
+  @IsNotEmpty()
+  @IsString()
+  @IsEmail()
+  readonly email: string;
+
+  @ApiProperty({ description: 'Admin user password' })
+  @IsNotEmpty()
+  @IsString()
+  @MinLength(8)
+  @MaxLength(255)
+  readonly password: string;
+}

backend/src/selfhosted-operations/application/responce-objects/is-configured.ro.ts

@@ -0,0 +1,6 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class IsConfiguredRo {
+	@ApiProperty({ example: true, description: 'Indicates whether the self-hosted instance is configured' })
+	public isConfigured: boolean;
+}

backend/src/selfhosted-operations/application/use-cases/create-initial-user.use.case.ts

@@ -0,0 +1,60 @@
+import { BadRequestException, Inject, Injectable } from '@nestjs/common';
+import AbstractUseCase from '../../../common/abstract-use.case.js';
+import { IGlobalDatabaseContext } from '../../../common/application/global-database-context.interface.js';
+import { BaseType } from '../../../common/data-injection.tokens.js';
+import { SimpleFoundUserInfoDs } from '../../../entities/user/dto/found-user.dto.js';
+import { ICreateInitialUserUseCase } from './selfhosted-use-cases.interfaces.js';
+import { CreateInitialUserDs } from '../data-structures/create-initial-user.ds.js';
+import { isSaaS } from '../../../helpers/app/is-saas.js';
+import { Messages } from '../../../exceptions/text/messages.js';
+import { RegisterUserDs } from '../../../entities/user/application/data-structures/register-user-ds.js';
+import { UserRoleEnum } from '../../../entities/user/enums/user-role.enum.js';
+import { buildRegisteringUser } from '../../../entities/user/utils/build-registering-user.util.js';
+import { CompanyInfoEntity } from '../../../entities/company-info/company-info.entity.js';
+import { Encryptor } from '../../../helpers/encryption/encryptor.js';
+import { buildSimpleUserInfoDs } from '../../../entities/user/utils/build-created-user.ds.js';
+
+@Injectable()
+export class CreateInitialUserUseCase
+	extends AbstractUseCase<CreateInitialUserDs, SimpleFoundUserInfoDs>
+	implements ICreateInitialUserUseCase
+{
+	constructor(
+		@Inject(BaseType.GLOBAL_DB_CONTEXT)
+		protected _dbContext: IGlobalDatabaseContext,
+	) {
+		super();
+	}
+
+	protected async implementation(inputData: CreateInitialUserDs): Promise<SimpleFoundUserInfoDs> {
+		if (isSaaS()) {
+			throw new BadRequestException(Messages.ENDPOINT_NOT_AVAILABLE_IN_THIS_MODE);
+		}
+
+		const userCount = await this._dbContext.userRepository.count();
+		if (userCount > 0) {
+			throw new BadRequestException(Messages.SELF_HOSTED_ALREADY_CONFIGURED);
+		}
+
+		const { email, password } = inputData;
+		const registerUserData: RegisterUserDs = {
+			email: email,
+			password: password,
+			isActive: true,
+			gclidValue: null,
+			name: 'Admin',
+			role: UserRoleEnum.ADMIN,
+		};
+
+		const savedUser = await this._dbContext.userRepository.saveUserEntity(buildRegisteringUser(registerUserData));
+
+		const newCompanyInfo = new CompanyInfoEntity();
+		newCompanyInfo.id = Encryptor.generateUUID();
+		const savedCompanyInfo = await this._dbContext.companyInfoRepository.save(newCompanyInfo);
+
+		savedUser.company = savedCompanyInfo;
+		const finalUser = await this._dbContext.userRepository.saveUserEntity(savedUser);
+
+		return buildSimpleUserInfoDs(finalUser);
+	}
+}