BC-11264 - Enhance Helpdesk functionality by adding instanceName to UserContext and updating user agent parsing with consent handling (#6111)

* BC-11264 - Enhance Helpdesk functionality by adding instanceName to UserContext and updating user agent parsing with consent handling

* Add Helpdesk configuration and enhance user context with instance name

* Update text formatting to include dynamic subject lines in problem and wish texts

* Enhance Helpdesk functionality by integrating AccountService and updating text formatting to include account details in problem and wish texts

* Integrate AccountService into HelpdeskUc and update user context creation; refactor text formatting to use user context data

---------

Co-authored-by: Max Bischof <maximilian.bischof@dataport.de>

Author: 2 people

apps/server/src/modules/helpdesk/api/helpdesk.controller.ts

@@ -27,7 +27,7 @@ export class HelpdeskController {
 		@UploadedFiles(new HelpdeskFileValidationPipe())
 		files?: Express.Multer.File[]
 	): Promise<void> {
-		const userAgent: IResult = this.parseUserAgent(userAgentHeader);
+		const userAgent = this.parseUserAgent(userAgentHeader, body.consent);
 
 		await this.helpdeskUc.createHelpdeskProblem(currentUser.userId, body, files, userAgent);
 	}
@@ -45,12 +45,15 @@ export class HelpdeskController {
 		@UploadedFiles(new HelpdeskFileValidationPipe())
 		files?: Express.Multer.File[]
 	): Promise<void> {
-		const userAgent: IResult = this.parseUserAgent(userAgentHeader);
+		const userAgent = this.parseUserAgent(userAgentHeader, body.consent);
 
 		await this.helpdeskUc.createHelpdeskWish(currentUser.userId, body, files, userAgent);
 	}
 
-	private parseUserAgent(userAgentHeader: string): IResult {
+	private parseUserAgent(userAgentHeader: string, consent?: boolean): IResult | undefined {
+		if (!consent) {
+			return undefined;
+		}
 		const ua = new UAParser(userAgentHeader);
 
 		return ua.getResult();

apps/server/src/modules/helpdesk/api/helpdesk.uc.ts

@@ -1,19 +1,23 @@
+import { Account, AccountService } from '@modules/account';
 import { AuthorizationContextBuilder, AuthorizationService } from '@modules/authorization';
 import { School, SchoolService } from '@modules/school';
 import { User } from '@modules/user/repo';
-import { Injectable } from '@nestjs/common';
+import { Inject, Injectable } from '@nestjs/common';
 import { Permission } from '@shared/domain/interface';
 import { EntityId } from '@shared/domain/types';
 import { IResult } from 'ua-parser-js';
 import { HelpdeskService, UserContext, UserDevice } from '../domain';
+import { HELPDESK_CONFIG_TOKEN, HelpdeskConfig } from '../helpdesk-config';
 import { HelpdeskProblemCreateParams, HelpdeskWishCreateParams } from './dto';
 
 @Injectable()
 export class HelpdeskUc {
 	constructor(
 		private readonly helpdeskProblemService: HelpdeskService,
 		private readonly authorizationService: AuthorizationService,
-		private readonly schoolService: SchoolService
+		private readonly schoolService: SchoolService,
+		private readonly accountService: AccountService,
+		@Inject(HELPDESK_CONFIG_TOKEN) private readonly config: HelpdeskConfig
 	) {}
 
 	public async createHelpdeskProblem(
@@ -24,7 +28,8 @@ export class HelpdeskUc {
 	): Promise<void> {
 		const { user, school } = await this.authorizeUserForSchool(userId);
 
-		const userContext = this.createUserContext(user, school);
+		const account = await this.accountService.findByUserIdOrFail(userId);
+		const userContext = this.createUserContext(user, school, account);
 		const userDevice = this.createUserDevice(userAgent);
 
 		await this.helpdeskProblemService.createProblem(params, userContext, userDevice, files);
@@ -38,7 +43,8 @@ export class HelpdeskUc {
 	): Promise<void> {
 		const { user, school } = await this.authorizeUserForSchool(userId);
 
-		const userContext = this.createUserContext(user, school);
+		const account = await this.accountService.findByUserIdOrFail(userId);
+		const userContext = this.createUserContext(user, school, account);
 		const userDevice = this.createUserDevice(userAgent);
 
 		await this.helpdeskProblemService.createWish(params, userContext, userDevice, files);
@@ -60,14 +66,15 @@ export class HelpdeskUc {
 		};
 	}
 
-	private createUserContext(user: User, school: School): UserContext {
+	private createUserContext(user: User, school: School, account: Account): UserContext {
 		const userContext = new UserContext({
 			userId: user.id,
-			userName: `${user.firstName} ${user.lastName}`,
+			userName: account.username,
 			userEmail: user.email,
 			userRoles: user.roles?.getItems()?.map((role) => role.name),
 			schoolId: school.id,
 			schoolName: school.getProps().name,
+			instanceName: this.config.instanceName,
 		});
 
 		return userContext;

apps/server/src/modules/helpdesk/domain/interface/helpdesk.interface.ts

@@ -34,4 +34,5 @@ export interface UserContextProps {
 	userRoles: string[];
 	schoolId: EntityId;
 	schoolName: string;
+	instanceName: string;
 }