N21-1825 Group UUID auto param for synced course

apps/server/src/modules/tool/common/enum/custom-parameter-type.enum.ts

@@ -7,6 +7,7 @@ export enum CustomParameterType {
 	AUTO_SCHOOLID = 'auto_schoolid',
 	AUTO_SCHOOLNUMBER = 'auto_schoolnumber',
 	AUTO_MEDIUMID = 'auto_mediumid',
+	AUTO_GROUP_EXTERNALUUID = 'auto_group_externaluuid',
 }
 
 export const autoParameters: CustomParameterType[] = [
@@ -15,4 +16,5 @@ export const autoParameters: CustomParameterType[] = [
 	CustomParameterType.AUTO_SCHOOLID,
 	CustomParameterType.AUTO_SCHOOLNUMBER,
 	CustomParameterType.AUTO_MEDIUMID,
+	CustomParameterType.AUTO_GROUP_EXTERNALUUID,
 ];

apps/server/src/modules/tool/common/enum/request-response/custom-parameter-type.enum.ts

@@ -7,4 +7,5 @@ export enum CustomParameterTypeParams {
 	AUTO_SCHOOLID = 'auto_schoolid',
 	AUTO_SCHOOLNUMBER = 'auto_schoolnumber',
 	AUTO_MEDIUMID = 'auto_mediumid',
+	AUTO_GROUP_EXTERNALUUID = 'auto_group_externaluuid',
 }

apps/server/src/modules/tool/common/service/validation/tool-parameter-type-validation.util.spec.ts

@@ -106,5 +106,16 @@ describe(ToolParameterTypeValidationUtil.name, () => {
 				expect(result).toEqual(false);
 			});
 		});
+
+		describe('when the type is AUTO_GROUPUUID', () => {
+			it('should return false', () => {
+				const result: boolean = ToolParameterTypeValidationUtil.isValueValidForType(
+					CustomParameterType.AUTO_GROUP_EXTERNALUUID,
+					'any value'
+				);
+
+				expect(result).toEqual(false);
+			});
+		});
 	});
 });

apps/server/src/modules/tool/common/service/validation/tool-parameter-type-validation.util.ts

@@ -11,6 +11,7 @@ export class ToolParameterTypeValidationUtil {
 		[CustomParameterType.AUTO_SCHOOLID]: () => false,
 		[CustomParameterType.AUTO_SCHOOLNUMBER]: () => false,
 		[CustomParameterType.AUTO_MEDIUMID]: () => false,
+		[CustomParameterType.AUTO_GROUP_EXTERNALUUID]: () => false,
 	};
 
 	public static isValueValidForType(type: CustomParameterType, val: string): boolean {

apps/server/src/modules/tool/external-tool/mapper/external-tool-request.mapper.ts

@@ -57,6 +57,7 @@ const typeMapping: Record<CustomParameterTypeParams, CustomParameterType> = {
 	[CustomParameterTypeParams.AUTO_SCHOOLID]: CustomParameterType.AUTO_SCHOOLID,
 	[CustomParameterTypeParams.AUTO_SCHOOLNUMBER]: CustomParameterType.AUTO_SCHOOLNUMBER,
 	[CustomParameterTypeParams.AUTO_MEDIUMID]: CustomParameterType.AUTO_MEDIUMID,
+	[CustomParameterTypeParams.AUTO_GROUP_EXTERNALUUID]: CustomParameterType.AUTO_GROUP_EXTERNALUUID,
 };
 
 @Injectable()

apps/server/src/modules/tool/external-tool/mapper/external-tool-response.mapper.ts

@@ -42,6 +42,7 @@ const typeMapping: Record<CustomParameterType, CustomParameterTypeParams> = {
 	[CustomParameterType.AUTO_SCHOOLID]: CustomParameterTypeParams.AUTO_SCHOOLID,
 	[CustomParameterType.AUTO_SCHOOLNUMBER]: CustomParameterTypeParams.AUTO_SCHOOLNUMBER,
 	[CustomParameterType.AUTO_MEDIUMID]: CustomParameterTypeParams.AUTO_MEDIUMID,
+	[CustomParameterType.AUTO_GROUP_EXTERNALUUID]: CustomParameterTypeParams.AUTO_GROUP_EXTERNALUUID,
 };
 
 @Injectable()

apps/server/src/modules/tool/tool-launch/error/index.ts

@@ -3,3 +3,4 @@ export * from './missing-tool-parameter-value.loggable-exception';
 export * from './parameter-type-not-implemented.loggable-exception';
 export { MissingMediaLicenseLoggableException } from './missing-licence.loggable-exception';
 export { LaunchContextUnavailableLoggableException } from './launch-context-unavailable.loggable-exception';
+export { MissingAutoParameterValueLoggableException } from './missing-auto-parameter-value.loggable-exception';

apps/server/src/modules/tool/tool-launch/error/missing-auto-parameter-value.loggable-exception.spec.ts

@@ -0,0 +1,40 @@
+import { contextExternalToolFactory } from '../../context-external-tool/testing';
+import { ContextExternalTool } from '../../context-external-tool/domain';
+import { CustomParameterType } from '../../common/enum';
+import { MissingAutoParameterValueLoggableException } from './missing-auto-parameter-value.loggable-exception';
+
+describe(MissingAutoParameterValueLoggableException.name, () => {
+	describe('getLogMessage', () => {
+		const setup = () => {
+			const contextExternalTool: ContextExternalTool = contextExternalToolFactory.build();
+
+			const parameterType: CustomParameterType = CustomParameterType.AUTO_GROUP_EXTERNALUUID;
+
+			const exception = new MissingAutoParameterValueLoggableException(contextExternalTool, parameterType);
+
+			return {
+				contextExternalTool,
+				parameterType,
+				exception,
+			};
+		};
+
+		it('should give the correct log message', () => {
+			const { contextExternalTool, parameterType, exception } = setup();
+
+			const result = exception.getLogMessage();
+
+			expect(result).toEqual({
+				type: 'MISSING_AUTO_PARAMETER_VALUE',
+				message:
+					'The external tool was attempted to launch, but the value to fill an auto parameter was not found ' +
+					'or could not be retrieved successfully',
+				stack: expect.any(String),
+				data: {
+					contextExternalToolId: contextExternalTool.id,
+					parameterType,
+				},
+			});
+		});
+	});
+});

apps/server/src/modules/tool/tool-launch/error/missing-auto-parameter-value.loggable-exception.ts

@@ -0,0 +1,38 @@
+import { HttpStatus } from '@nestjs/common';
+import { BusinessError } from '@shared/common';
+import { ErrorLogMessage, Loggable, LogMessage, ValidationErrorLogMessage } from '@src/core/logger';
+import { ContextExternalToolLaunchable } from '../../context-external-tool/domain';
+import { CustomParameterType } from '../../common/enum';
+
+export class MissingAutoParameterValueLoggableException extends BusinessError implements Loggable {
+	constructor(
+		private readonly contextExternalTool: ContextExternalToolLaunchable,
+		private readonly parameterType: CustomParameterType
+	) {
+		super(
+			{
+				type: 'MISSING_AUTO_PARAMETER_VALUE',
+				title: 'Missing auto parameter value',
+				defaultMessage:
+					'The external tool was attempted to launch, but the value to fill an auto parameter was not found ' +
+					'or could not be retrieved successfully',
+			},
+			HttpStatus.UNPROCESSABLE_ENTITY,
+			{
+				parameterType,
+			}
+		);
+	}
+
+	getLogMessage(): LogMessage | ErrorLogMessage | ValidationErrorLogMessage {
+		return {
+			type: this.type,
+			message: this.message,
+			stack: this.stack,
+			data: {
+				contextExternalToolId: this.contextExternalTool.id,
+				parameterType: this.parameterType,
+			},
+		};
+	}
+}

apps/server/src/modules/tool/tool-launch/service/auto-parameter-strategy/auto-group-external-uuid-strategy.service.ts

@@ -0,0 +1,51 @@
+import { Injectable } from '@nestjs/common';
+import { CourseService } from '@modules/learnroom';
+import { Group, GroupService } from '@modules/group';
+import { Course } from '@shared/domain/entity';
+import { CustomParameterType, ToolContextType } from '../../../common/enum';
+import { ContextExternalToolLaunchable } from '../../../context-external-tool/domain';
+import { SchoolExternalTool } from '../../../school-external-tool/domain';
+import { MissingAutoParameterValueLoggableException } from '../../error';
+import { AutoParameterStrategy } from './auto-parameter.strategy';
+
+@Injectable()
+export class AutoGroupExternalUuidStrategy implements AutoParameterStrategy {
+	constructor(private readonly courseService: CourseService, private readonly groupService: GroupService) {}
+
+	async getValue(
+		_schoolExternalTool: SchoolExternalTool,
+		contextExternalTool: ContextExternalToolLaunchable
+	): Promise<string | undefined> {
+		if (contextExternalTool.contextRef.type !== ToolContextType.COURSE) {
+			return undefined;
+		}
+
+		const courseId = contextExternalTool.contextRef.id;
+		const course: Course = await this.courseService.findById(courseId);
+
+		const syncedGroup: Group | undefined = await this.getSyncedGroup(course);
+		if (!syncedGroup) {
+			return undefined;
+		}
+
+		const groupUuid = syncedGroup.externalSource?.externalId;
+		if (!groupUuid) {
+			throw new MissingAutoParameterValueLoggableException(
+				contextExternalTool,
+				CustomParameterType.AUTO_GROUP_EXTERNALUUID
+			);
+		}
+
+		return groupUuid;
+	}
+
+	private async getSyncedGroup(course: Course): Promise<Group | undefined> {
+		const syncedGroupId = course.syncedWithGroup?.id;
+		if (!syncedGroupId) {
+			return undefined;
+		}
+
+		const syncedGroup = await this.groupService.findById(syncedGroupId);
+		return syncedGroup;
+	}
+}