N21-1885 refactor ctl dos

apps/server/src/modules/authorization/domain/rules/school-external-tool.rule.spec.ts

@@ -1,16 +1,10 @@
 import { SchoolExternalTool } from '@modules/tool/school-external-tool/domain';
 import { SchoolExternalToolEntity } from '@modules/tool/school-external-tool/entity';
-import { schoolExternalToolEntityFactory } from '@modules/tool/school-external-tool/testing';
+import { schoolExternalToolEntityFactory, schoolExternalToolFactory } from '@modules/tool/school-external-tool/testing';
 import { Test, TestingModule } from '@nestjs/testing';
 import { Role, User } from '@shared/domain/entity';
 import { Permission } from '@shared/domain/interface';
-import {
-	roleFactory,
-	schoolEntityFactory,
-	schoolExternalToolFactory,
-	setupEntities,
-	userFactory,
-} from '@shared/testing';
+import { roleFactory, schoolEntityFactory, setupEntities, userFactory } from '@shared/testing';
 import { AuthorizationHelper } from '../service/authorization.helper';
 import { Action } from '../type';
 import { SchoolExternalToolRule } from './school-external-tool.rule';

apps/server/src/modules/board/repo/board-do.repo.spec.ts

@@ -6,7 +6,10 @@ import { CollaborativeTextEditorService } from '@modules/collaborative-text-edit
 import { FilesStorageClientAdapterService } from '@modules/files-storage-client';
 import { DrawingElementAdapterService } from '@modules/tldraw-client';
 import { ContextExternalToolService } from '@modules/tool/context-external-tool/service';
-import { contextExternalToolEntityFactory } from '@modules/tool/context-external-tool/testing';
+import {
+	contextExternalToolEntityFactory,
+	contextExternalToolFactory,
+} from '@modules/tool/context-external-tool/testing';
 import { NotFoundException } from '@nestjs/common';
 import { Test, TestingModule } from '@nestjs/testing';
 import {
@@ -33,7 +36,6 @@ import {
 	columnBoardNodeFactory,
 	columnFactory,
 	columnNodeFactory,
-	contextExternalToolFactory,
 	courseFactory,
 	externalToolElementNodeFactory,
 	fileElementFactory,

apps/server/src/modules/board/repo/recursive-delete.visitor.spec.ts

@@ -5,12 +5,12 @@ import { CollaborativeTextEditorService } from '@modules/collaborative-text-edit
 import { FileDto, FilesStorageClientAdapterService } from '@modules/files-storage-client';
 import { DrawingElementAdapterService } from '@modules/tldraw-client';
 import { ContextExternalToolService } from '@modules/tool/context-external-tool/service';
+import { contextExternalToolFactory } from '@modules/tool/context-external-tool/testing';
 import { Test, TestingModule } from '@nestjs/testing';
 import {
 	collaborativeTextEditorElementFactory,
 	columnBoardFactory,
 	columnFactory,
-	contextExternalToolFactory,
 	drawingElementFactory,
 	externalToolElementFactory,
 	fileElementFactory,

apps/server/src/modules/board/service/board-do-copy-service/board-do-copy.service.spec.ts

@@ -1,8 +1,11 @@
 import { createMock, DeepMocked } from '@golevelup/ts-jest';
 import { FileRecordParentType } from '@infra/rabbitmq';
+import { ObjectId } from '@mikro-orm/mongodb';
 import { CopyElementType, CopyStatus, CopyStatusEnum } from '@modules/copy-helper';
 import { ContextExternalTool } from '@modules/tool/context-external-tool/domain';
 import { ContextExternalToolService } from '@modules/tool/context-external-tool/service';
+import { contextExternalToolFactory } from '@modules/tool/context-external-tool/testing';
+import { ToolFeatures } from '@modules/tool/tool-config';
 import { Test, TestingModule } from '@nestjs/testing';
 import {
 	Card,
@@ -28,7 +31,6 @@ import {
 	cardFactory,
 	columnBoardFactory,
 	columnFactory,
-	contextExternalToolFactory,
 	drawingElementFactory,
 	externalToolElementFactory,
 	fileElementFactory,
@@ -38,8 +40,6 @@ import {
 	submissionContainerElementFactory,
 	submissionItemFactory,
 } from '@shared/testing';
-import { ObjectId } from '@mikro-orm/mongodb';
-import { ToolFeatures } from '@modules/tool/tool-config';
 import { BoardDoCopyService } from './board-do-copy.service';
 import { SchoolSpecificFileCopyService } from './school-specific-file-copy.interface';
 

apps/server/src/modules/board/service/content-element.service.spec.ts

@@ -12,14 +12,14 @@ import {
 import { InputFormat } from '@shared/domain/types';
 import {
 	cardFactory,
-	contextExternalToolFactory,
 	drawingElementFactory,
 	fileElementFactory,
 	linkElementFactory,
 	richTextElementFactory,
 	setupEntities,
 	submissionContainerElementFactory,
 } from '@shared/testing';
+import { contextExternalToolFactory } from '@src/modules/tool/context-external-tool/testing';
 import {
 	DrawingContentBody,
 	FileContentBody,

apps/server/src/modules/board/service/media-board/media-available-line.service.spec.ts

@@ -3,22 +3,17 @@ import { ExternalToolService } from '@modules/tool';
 import { CustomParameterScope, ToolContextType } from '@modules/tool/common/enum';
 import { ContextExternalToolService } from '@modules/tool/context-external-tool';
 import { ContextExternalTool } from '@modules/tool/context-external-tool/domain';
+import { contextExternalToolFactory } from '@modules/tool/context-external-tool/testing';
 import { ExternalTool } from '@modules/tool/external-tool/domain';
 import { ExternalToolLogoService } from '@modules/tool/external-tool/service';
+import { externalToolFactory } from '@modules/tool/external-tool/testing';
 import { SchoolExternalToolService } from '@modules/tool/school-external-tool';
 import { SchoolExternalTool } from '@modules/tool/school-external-tool/domain';
+import { schoolExternalToolFactory } from '@modules/tool/school-external-tool/testing';
 import { Test, TestingModule } from '@nestjs/testing';
 import { MediaAvailableLine, MediaBoard, MediaExternalToolElement, Page } from '@shared/domain/domainobject';
 import { User } from '@shared/domain/entity';
-import {
-	contextExternalToolFactory,
-	externalToolFactory,
-	mediaBoardFactory,
-	mediaExternalToolElementFactory,
-	schoolExternalToolFactory,
-	setupEntities,
-	userFactory,
-} from '@shared/testing';
+import { mediaBoardFactory, mediaExternalToolElementFactory, setupEntities, userFactory } from '@shared/testing';
 import { MediaAvailableLineService } from './media-available-line.service';
 
 describe(MediaAvailableLineService.name, () => {
@@ -82,7 +77,7 @@ describe(MediaAvailableLineService.name, () => {
 				.buildWithId();
 
 			const usedContextExternalTool: ContextExternalTool = contextExternalToolFactory
-				.withSchoolExternalToolRef(usedSchoolExternalTool.id as string, user.school.id)
+				.withSchoolExternalToolRef(usedSchoolExternalTool.id, user.school.id)
 				.buildWithId();
 
 			const mediaExternalToolElement: MediaExternalToolElement = mediaExternalToolElementFactory.build({

apps/server/src/modules/board/service/media-board/media-element.service.spec.ts

@@ -1,17 +1,17 @@
 import { createMock, type DeepMocked } from '@golevelup/ts-jest';
 import { ObjectId } from '@mikro-orm/mongodb';
 import { ToolContextType } from '@modules/tool/common/enum';
-import type { ContextExternalToolWithId } from '@modules/tool/context-external-tool/domain';
+import { ContextExternalTool } from '@modules/tool/context-external-tool/domain';
 import { ContextExternalToolService } from '@modules/tool/context-external-tool/service';
-import { SchoolExternalToolWithId } from '@modules/tool/school-external-tool/domain';
+import { contextExternalToolFactory } from '@modules/tool/context-external-tool/testing';
+import { SchoolExternalTool } from '@modules/tool/school-external-tool/domain';
+import { schoolExternalToolFactory } from '@modules/tool/school-external-tool/testing';
 import { NotFoundException } from '@nestjs/common';
 import { Test, TestingModule } from '@nestjs/testing';
 import {
-	contextExternalToolFactory,
 	mediaBoardFactory,
 	mediaExternalToolElementFactory,
 	mediaLineFactory,
-	schoolExternalToolFactory,
 	setupEntities,
 	userFactory,
 } from '@shared/testing';
@@ -106,14 +106,12 @@ describe(MediaElementService.name, () => {
 		describe('when creating a new context external tool', () => {
 			const setup = () => {
 				const user = userFactory.build();
-				const schoolExternalTool = schoolExternalToolFactory
-					.withSchoolId(user.school.id)
-					.build() as SchoolExternalToolWithId;
+				const schoolExternalTool: SchoolExternalTool = schoolExternalToolFactory.withSchoolId(user.school.id).build();
 				const mediaBoard = mediaBoardFactory.build();
-				const contextExternalTool = contextExternalToolFactory
+				const contextExternalTool: ContextExternalTool = contextExternalToolFactory
 					.withSchoolExternalToolRef(schoolExternalTool.id, user.school.id)
 					.withContextRef(mediaBoard.id, ToolContextType.MEDIA_BOARD)
-					.buildWithId() as ContextExternalToolWithId;
+					.buildWithId();
 
 				contextExternalToolService.saveContextExternalTool.mockResolvedValueOnce(contextExternalTool);
 
@@ -130,39 +128,42 @@ describe(MediaElementService.name, () => {
 
 				const result = await service.createContextExternalToolForMediaBoard(user, schoolExternalTool, mediaBoard);
 
-				expect(result).toEqual({
-					id: contextExternalTool.id,
-					displayName: contextExternalTool.displayName,
-					schoolToolRef: {
-						schoolId: user.school.id,
-						schoolToolId: schoolExternalTool.id,
-					},
-					contextRef: {
-						id: mediaBoard.id,
-						type: ToolContextType.MEDIA_BOARD,
-					},
-					toolVersion: contextExternalTool.toolVersion,
-					parameters: contextExternalTool.parameters,
-				});
+				expect(result).toEqual(
+					new ContextExternalTool({
+						id: expect.any(String),
+						displayName: contextExternalTool.displayName,
+						schoolToolRef: {
+							schoolId: user.school.id,
+							schoolToolId: schoolExternalTool.id,
+						},
+						contextRef: {
+							id: mediaBoard.id,
+							type: ToolContextType.MEDIA_BOARD,
+						},
+						parameters: contextExternalTool.parameters,
+					})
+				);
 			});
 
 			it('should save the new context external tool', async () => {
 				const { user, schoolExternalTool, mediaBoard } = setup();
 
 				await service.createContextExternalToolForMediaBoard(user, schoolExternalTool, mediaBoard);
 
-				expect(contextExternalToolService.saveContextExternalTool).toHaveBeenCalledWith({
-					schoolToolRef: {
-						schoolId: user.school.id,
-						schoolToolId: schoolExternalTool.id,
-					},
-					contextRef: {
-						id: mediaBoard.id,
-						type: ToolContextType.MEDIA_BOARD,
-					},
-					toolVersion: 0,
-					parameters: [],
-				});
+				expect(contextExternalToolService.saveContextExternalTool).toHaveBeenCalledWith(
+					new ContextExternalTool({
+						id: expect.any(String),
+						schoolToolRef: {
+							schoolId: user.school.id,
+							schoolToolId: schoolExternalTool.id,
+						},
+						contextRef: {
+							id: mediaBoard.id,
+							type: ToolContextType.MEDIA_BOARD,
+						},
+						parameters: [],
+					})
+				);
 			});
 		});
 	});
@@ -171,7 +172,7 @@ describe(MediaElementService.name, () => {
 		describe('when creating a new element', () => {
 			const setup = () => {
 				const line = mediaLineFactory.build();
-				const contextExternalTool = contextExternalToolFactory.buildWithId() as ContextExternalToolWithId;
+				const contextExternalTool: ContextExternalTool = contextExternalToolFactory.buildWithId();
 
 				return {
 					line,
@@ -250,8 +251,10 @@ describe(MediaElementService.name, () => {
 	describe('checkElementExists', () => {
 		describe('when an element exists', () => {
 			const setup = () => {
-				const schoolExternalTool = schoolExternalToolFactory.buildWithId() as SchoolExternalToolWithId;
-				const contextExternalTool = contextExternalToolFactory.withSchoolExternalToolRef(schoolExternalTool.id).build();
+				const schoolExternalTool: SchoolExternalTool = schoolExternalToolFactory.buildWithId();
+				const contextExternalTool: ContextExternalTool = contextExternalToolFactory
+					.withSchoolExternalToolRef(schoolExternalTool.id)
+					.build();
 				const element = mediaExternalToolElementFactory.build({ contextExternalToolId: contextExternalTool.id });
 				const line = mediaLineFactory.addChild(element).build();
 				const mediaBoard = mediaBoardFactory.addChild(line).build();
@@ -275,8 +278,10 @@ describe(MediaElementService.name, () => {
 
 		describe('when an element does not exist', () => {
 			const setup = () => {
-				const schoolExternalTool = schoolExternalToolFactory.buildWithId() as SchoolExternalToolWithId;
-				const contextExternalTool = contextExternalToolFactory.withSchoolExternalToolRef(schoolExternalTool.id).build();
+				const schoolExternalTool: SchoolExternalTool = schoolExternalToolFactory.buildWithId();
+				const contextExternalTool: ContextExternalTool = contextExternalToolFactory
+					.withSchoolExternalToolRef(schoolExternalTool.id)
+					.build();
 				const element = mediaExternalToolElementFactory.build({ contextExternalToolId: new ObjectId().toHexString() });
 				const line = mediaLineFactory.addChild(element).build();
 				const mediaBoard = mediaBoardFactory.addChild(line).build();

apps/server/src/modules/board/service/media-board/media-element.service.ts

@@ -1,8 +1,8 @@
 import { ObjectId } from '@mikro-orm/mongodb';
 import { ToolContextType } from '@modules/tool/common/enum';
 import { ContextExternalToolService } from '@modules/tool/context-external-tool';
-import { ContextExternalTool, ContextExternalToolWithId, ContextRef } from '@modules/tool/context-external-tool/domain';
-import { SchoolExternalToolRefDO, SchoolExternalToolWithId } from '@modules/tool/school-external-tool/domain';
+import { ContextExternalTool, ContextRef } from '@modules/tool/context-external-tool/domain';
+import { SchoolExternalTool, SchoolExternalToolRef } from '@modules/tool/school-external-tool/domain';
 import { Injectable, NotFoundException } from '@nestjs/common';
 import {
 	AnyBoardDo,
@@ -35,10 +35,7 @@ export class MediaElementService {
 		return element;
 	}
 
-	public async checkElementExists(
-		mediaBoard: MediaBoard,
-		schoolExternalTool: SchoolExternalToolWithId
-	): Promise<boolean> {
+	public async checkElementExists(mediaBoard: MediaBoard, schoolExternalTool: SchoolExternalTool): Promise<boolean> {
 		const contextExternalTools: ContextExternalTool[] = await this.contextExternalToolService.findContextExternalTools({
 			schoolToolRef: { schoolToolId: schoolExternalTool.id },
 		});
@@ -52,26 +49,25 @@ export class MediaElementService {
 
 	public async createContextExternalToolForMediaBoard(
 		user: User,
-		schoolExternalTool: SchoolExternalToolWithId,
+		schoolExternalTool: SchoolExternalTool,
 		mediaBoard: MediaBoard
-	): Promise<ContextExternalToolWithId> {
-		const contextExternalTool: ContextExternalToolWithId =
-			await this.contextExternalToolService.saveContextExternalTool(
-				new ContextExternalTool({
-					schoolToolRef: new SchoolExternalToolRefDO({ schoolId: user.school.id, schoolToolId: schoolExternalTool.id }),
-					contextRef: new ContextRef({ id: mediaBoard.id, type: ToolContextType.MEDIA_BOARD }),
-					toolVersion: 0,
-					parameters: [],
-				})
-			);
+	): Promise<ContextExternalTool> {
+		const contextExternalTool: ContextExternalTool = await this.contextExternalToolService.saveContextExternalTool(
+			new ContextExternalTool({
+				id: new ObjectId().toHexString(),
+				schoolToolRef: new SchoolExternalToolRef({ schoolId: user.school.id, schoolToolId: schoolExternalTool.id }),
+				contextRef: new ContextRef({ id: mediaBoard.id, type: ToolContextType.MEDIA_BOARD }),
+				parameters: [],
+			})
+		);
 
 		return contextExternalTool;
 	}
 
 	public async createExternalToolElement(
 		parent: MediaLine,
 		position: number,
-		contextExternalTool: ContextExternalToolWithId
+		contextExternalTool: ContextExternalTool
 	): Promise<MediaExternalToolElement> {
 		const element: MediaExternalToolElement = new MediaExternalToolElement({
 			id: new ObjectId().toHexString(),

apps/server/src/modules/board/uc/media-board/media-available-line.uc.spec.ts

@@ -2,7 +2,9 @@ import { createMock, DeepMocked } from '@golevelup/ts-jest';
 import { ObjectId } from '@mikro-orm/mongodb';
 import { AuthorizationService } from '@modules/authorization';
 import { ExternalTool } from '@modules/tool/external-tool/domain';
+import { externalToolFactory } from '@modules/tool/external-tool/testing';
 import { SchoolExternalTool } from '@modules/tool/school-external-tool/domain';
+import { schoolExternalToolFactory } from '@modules/tool/school-external-tool/testing';
 import { MediaUserLicense, mediaUserLicenseFactory, UserLicenseService } from '@modules/user-license';
 import { MediaUserLicenseService } from '@modules/user-license/service';
 import { ConfigService } from '@nestjs/config';
@@ -18,12 +20,10 @@ import {
 import { User } from '@shared/domain/entity';
 import {
 	boardDoAuthorizableFactory,
-	externalToolFactory,
 	mediaAvailableLineElementFactory,
 	mediaAvailableLineFactory,
 	mediaBoardFactory,
 	mediaExternalToolElementFactory,
-	schoolExternalToolFactory,
 	setupEntities,
 	userFactory,
 } from '@shared/testing';