N21-1248 Configure External Tools in Boards (#4471)

- move tool reference to context external tool module
- new endpoint for tool reference from context external tool id
- add new tool reference controller
- add board-element as context for context external tools

apps/server/src/modules/board/controller/dto/element/external-tool-element.response.ts

@@ -1,4 +1,4 @@
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { ApiProperty } from '@nestjs/swagger';
 import { ContentElementType } from '@shared/domain';
 import { TimestampsResponse } from '../timestamps.response';
 
@@ -7,8 +7,8 @@ export class ExternalToolElementContent {
 		this.contextExternalToolId = props.contextExternalToolId;
 	}
 
-	@ApiPropertyOptional()
-	contextExternalToolId?: string;
+	@ApiProperty({ type: String, required: true, nullable: true })
+	contextExternalToolId: string | null;
 }
 
 export class ExternalToolElementResponse {

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

@@ -18,7 +18,7 @@ export class ExternalToolElementResponseMapper implements BaseResponseMapper {
 			id: element.id,
 			timestamps: new TimestampsResponse({ lastUpdatedAt: element.updatedAt, createdAt: element.createdAt }),
 			type: ContentElementType.EXTERNAL_TOOL,
-			content: new ExternalToolElementContent({ contextExternalToolId: element.contextExternalToolId }),
+			content: new ExternalToolElementContent({ contextExternalToolId: element.contextExternalToolId ?? null }),
 		});
 
 		return result;

apps/server/src/modules/pseudonym/service/feathers-roster.service.spec.ts

@@ -2,13 +2,13 @@ import { createMock, DeepMocked } from '@golevelup/ts-jest';
 import { DatabaseObjectNotFoundException } from '@mikro-orm/core';
 import { Test, TestingModule } from '@nestjs/testing';
 import { NotFoundLoggableException } from '@shared/common/loggable-exception';
-import { Course, Pseudonym, RoleName, LegacySchoolDo, UserDO, SchoolEntity } from '@shared/domain';
+import { Course, LegacySchoolDo, Pseudonym, RoleName, SchoolEntity, UserDO } from '@shared/domain';
 import {
 	contextExternalToolFactory,
 	courseFactory,
 	externalToolFactory,
-	pseudonymFactory,
 	legacySchoolDoFactory,
+	pseudonymFactory,
 	schoolExternalToolFactory,
 	schoolFactory,
 	setupEntities,
@@ -249,10 +249,10 @@ describe('FeathersRosterService', () => {
 				]);
 				contextExternalToolService.findAllByContext.mockResolvedValueOnce([otherContextExternalTool]);
 				contextExternalToolService.findAllByContext.mockResolvedValueOnce([]);
-				schoolExternalToolService.getSchoolExternalToolById.mockResolvedValueOnce(schoolExternalTool);
-				schoolExternalToolService.getSchoolExternalToolById.mockResolvedValueOnce(otherSchoolExternalTool);
-				externalToolService.findExternalToolById.mockResolvedValueOnce(externalTool);
-				externalToolService.findExternalToolById.mockResolvedValueOnce(otherExternalTool);
+				schoolExternalToolService.findById.mockResolvedValueOnce(schoolExternalTool);
+				schoolExternalToolService.findById.mockResolvedValueOnce(otherSchoolExternalTool);
+				externalToolService.findById.mockResolvedValueOnce(externalTool);
+				externalToolService.findById.mockResolvedValueOnce(otherExternalTool);
 
 				return {
 					pseudonym,
@@ -299,7 +299,7 @@ describe('FeathersRosterService', () => {
 
 				await service.getUserGroups(pseudonym.pseudonym, clientId);
 
-				expect(schoolExternalToolService.getSchoolExternalToolById.mock.calls).toEqual([
+				expect(schoolExternalToolService.findById.mock.calls).toEqual([
 					[schoolExternalTool.id],
 					[otherSchoolExternalTool.id],
 				]);
@@ -310,7 +310,7 @@ describe('FeathersRosterService', () => {
 
 				await service.getUserGroups(pseudonym.pseudonym, clientId);
 
-				expect(externalToolService.findExternalToolById.mock.calls).toEqual([[externalToolId], [otherExternalTool.id]]);
+				expect(externalToolService.findById.mock.calls).toEqual([[externalToolId], [otherExternalTool.id]]);
 			});
 
 			it('should return a group for each course where the tool of the users pseudonym is used', async () => {

apps/server/src/modules/pseudonym/service/feathers-roster.service.ts

@@ -179,12 +179,10 @@ export class FeathersRosterService {
 				);
 
 				for await (const contextExternalTool of contextExternalTools) {
-					const schoolExternalTool: SchoolExternalTool = await this.schoolExternalToolService.getSchoolExternalToolById(
+					const schoolExternalTool: SchoolExternalTool = await this.schoolExternalToolService.findById(
 						contextExternalTool.schoolToolRef.schoolToolId
 					);
-					const externalTool: ExternalTool = await this.externalToolService.findExternalToolById(
-						schoolExternalTool.toolId
-					);
+					const externalTool: ExternalTool = await this.externalToolService.findById(schoolExternalTool.toolId);
 					const isRequiredTool: boolean = externalTool.id === externalToolId;
 
 					if (isRequiredTool) {

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

@@ -1,3 +1,4 @@
 export enum ToolContextType {
 	COURSE = 'course',
+	BOARD_ELEMENT = 'board-element',
 }

apps/server/src/modules/tool/common/mapper/context-type.mapper.ts

@@ -3,6 +3,7 @@ import { ToolContextType } from '../enum';
 
 const typeMapping: Record<ToolContextType, AuthorizableReferenceType> = {
 	[ToolContextType.COURSE]: AuthorizableReferenceType.Course,
+	[ToolContextType.BOARD_ELEMENT]: AuthorizableReferenceType.BoardNode,
 };
 
 export class ContextTypeMapper {

apps/server/src/modules/tool/common/mapper/tool-status-response.mapper.ts

@@ -0,0 +1,14 @@
+import { ToolConfigurationStatusResponse } from '../../context-external-tool/controller/dto/tool-configuration-status.response';
+import { ToolConfigurationStatus } from '../enum';
+
+export const statusMapping: Record<ToolConfigurationStatus, ToolConfigurationStatusResponse> = {
+	[ToolConfigurationStatus.LATEST]: ToolConfigurationStatusResponse.LATEST,
+	[ToolConfigurationStatus.OUTDATED]: ToolConfigurationStatusResponse.OUTDATED,
+	[ToolConfigurationStatus.UNKNOWN]: ToolConfigurationStatusResponse.UNKNOWN,
+};
+
+export class ToolStatusResponseMapper {
+	static mapToResponse(status: ToolConfigurationStatus): ToolConfigurationStatusResponse {
+		return statusMapping[status];
+	}
+}

apps/server/src/modules/tool/context-external-tool/context-external-tool.module.ts

@@ -1,25 +1,28 @@
-import { forwardRef, Module } from '@nestjs/common';
+import { Module } from '@nestjs/common';
 import { LoggerModule } from '@src/core/logger';
-import { AuthorizationModule } from '@src/modules/authorization';
+import { CommonToolModule } from '../common';
 import { ExternalToolModule } from '../external-tool';
 import { SchoolExternalToolModule } from '../school-external-tool';
 import {
 	ContextExternalToolAuthorizableService,
 	ContextExternalToolService,
 	ContextExternalToolValidationService,
+	ToolReferenceService,
 } from './service';
-import { CommonToolModule } from '../common';
 
 @Module({
-	// TODO: remove authorization module here N21-1055
-	imports: [
-		CommonToolModule,
-		ExternalToolModule,
-		SchoolExternalToolModule,
-		LoggerModule,
-		forwardRef(() => AuthorizationModule),
+	imports: [CommonToolModule, ExternalToolModule, SchoolExternalToolModule, LoggerModule],
+	providers: [
+		ContextExternalToolService,
+		ContextExternalToolValidationService,
+		ContextExternalToolAuthorizableService,
+		ToolReferenceService,
+	],
+	exports: [
+		ContextExternalToolService,
+		ContextExternalToolValidationService,
+		ContextExternalToolAuthorizableService,
+		ToolReferenceService,
 	],
-	providers: [ContextExternalToolService, ContextExternalToolValidationService, ContextExternalToolAuthorizableService],
-	exports: [ContextExternalToolService, ContextExternalToolValidationService, ContextExternalToolAuthorizableService],
 })
 export class ContextExternalToolModule {}