Merge branch 'main' into BC-6059-tldraw-application-metrics

hpi-schul-cloud · Jan 8, 2024 · a219c74 · a219c74
2 parents dcd73f2 + fdfcf51
commit a219c74
Show file tree

Hide file tree

Showing 56 changed files with 935 additions and 28 deletions.
diff --git a/...modules/tool/common/controller/dto/context-external-tool-configuration-status.response.ts b/...modules/tool/common/controller/dto/context-external-tool-configuration-status.response.ts
@@ -15,8 +15,15 @@ export class ContextExternalToolConfigurationStatusResponse {
 	})
 	isOutdatedOnScopeContext: boolean;
 
+	@ApiProperty({
+		type: Boolean,
+		description: 'Is the tool deactivated, because of superhero or school administrator',
+	})
+	isDeactivated: boolean;
+
 	constructor(props: ContextExternalToolConfigurationStatusResponse) {
 		this.isOutdatedOnScopeSchool = props.isOutdatedOnScopeSchool;
 		this.isOutdatedOnScopeContext = props.isOutdatedOnScopeContext;
+		this.isDeactivated = props.isDeactivated;
 	}
 }
diff --git a/apps/server/src/modules/tool/common/domain/context-external-tool-configuration-status.ts b/apps/server/src/modules/tool/common/domain/context-external-tool-configuration-status.ts
@@ -3,8 +3,11 @@ export class ContextExternalToolConfigurationStatus {
 
 	isOutdatedOnScopeContext: boolean;
 
+	isDeactivated: boolean;
+
 	constructor(props: ContextExternalToolConfigurationStatus) {
 		this.isOutdatedOnScopeSchool = props.isOutdatedOnScopeSchool;
 		this.isOutdatedOnScopeContext = props.isOutdatedOnScopeContext;
+		this.isDeactivated = props.isDeactivated;
 	}
 }
diff --git a/apps/server/src/modules/tool/common/mapper/tool-status-response.mapper.ts b/apps/server/src/modules/tool/common/mapper/tool-status-response.mapper.ts
@@ -7,6 +7,7 @@ export class ToolStatusResponseMapper {
 			new ContextExternalToolConfigurationStatusResponse({
 				isOutdatedOnScopeSchool: status.isOutdatedOnScopeSchool,
 				isOutdatedOnScopeContext: status.isOutdatedOnScopeContext,
+				isDeactivated: status.isDeactivated,
 			});
 
 		return configurationStatus;

diff --git a/apps/server/src/modules/tool/common/service/common-tool.service.spec.ts b/apps/server/src/modules/tool/common/service/common-tool.service.spec.ts
@@ -86,6 +86,7 @@ describe('CommonToolService', () => {
 					toolConfigurationStatusFactory.build({
 						isOutdatedOnScopeContext: true,
 						isOutdatedOnScopeSchool: true,
+						isDeactivated: false,
 					})
 				);
 			});
@@ -117,6 +118,7 @@ describe('CommonToolService', () => {
 					toolConfigurationStatusFactory.build({
 						isOutdatedOnScopeContext: true,
 						isOutdatedOnScopeSchool: true,
+						isDeactivated: false,
 					})
 				);
 			});
@@ -210,6 +212,7 @@ describe('CommonToolService', () => {
 					toolConfigurationStatusFactory.build({
 						isOutdatedOnScopeContext: false,
 						isOutdatedOnScopeSchool: false,
+						isDeactivated: false,
 					})
 				);
 			});
@@ -241,6 +244,76 @@ describe('CommonToolService', () => {
 					toolConfigurationStatusFactory.build({
 						isOutdatedOnScopeContext: false,
 						isOutdatedOnScopeSchool: false,
+						isDeactivated: false,
+					})
+				);
+			});
+		});
+
+		describe('when schoolExternalTool is deactivated', () => {
+			const setup = () => {
+				const externalTool: ExternalTool = externalToolFactory.buildWithId({ version: 1 });
+				const schoolExternalTool: SchoolExternalTool = schoolExternalToolFactory.buildWithId({
+					toolVersion: 2,
+					status: { isDeactivated: true },
+				});
+				const contextExternalTool: ContextExternalTool = contextExternalToolFactory.buildWithId({ toolVersion: 2 });
+
+				return {
+					externalTool,
+					schoolExternalTool,
+					contextExternalTool,
+				};
+			};
+
+			it('should return a configuration status with deactivated true', () => {
+				const { externalTool, schoolExternalTool, contextExternalTool } = setup();
+
+				const result: ContextExternalToolConfigurationStatus = service.determineToolConfigurationStatus(
+					externalTool,
+					schoolExternalTool,
+					contextExternalTool
+				);
+
+				expect(result).toEqual(
+					toolConfigurationStatusFactory.build({
+						isOutdatedOnScopeContext: false,
+						isOutdatedOnScopeSchool: false,
+						isDeactivated: true,
+					})
+				);
+			});
+		});
+
+		describe('when externalTool is deactivated', () => {
+			const setup = () => {
+				const externalTool: ExternalTool = externalToolFactory.buildWithId({ version: 1, isDeactivated: true });
+				const schoolExternalTool: SchoolExternalTool = schoolExternalToolFactory.buildWithId({
+					toolVersion: 2,
+				});
+				const contextExternalTool: ContextExternalTool = contextExternalToolFactory.buildWithId({ toolVersion: 2 });
+
+				return {
+					externalTool,
+					schoolExternalTool,
+					contextExternalTool,
+				};
+			};
+
+			it('should return a configuration status with deactivated true', () => {
+				const { externalTool, schoolExternalTool, contextExternalTool } = setup();
+
+				const result: ContextExternalToolConfigurationStatus = service.determineToolConfigurationStatus(
+					externalTool,
+					schoolExternalTool,
+					contextExternalTool
+				);
+
+				expect(result).toEqual(
+					toolConfigurationStatusFactory.build({
+						isOutdatedOnScopeContext: false,
+						isOutdatedOnScopeSchool: false,
+						isDeactivated: true,
 					})
 				);
 			});

diff --git a/apps/server/src/modules/tool/common/service/common-tool.service.ts b/apps/server/src/modules/tool/common/service/common-tool.service.ts
@@ -20,6 +20,7 @@ export class CommonToolService {
 		const configurationStatus: ContextExternalToolConfigurationStatus = new ContextExternalToolConfigurationStatus({
 			isOutdatedOnScopeContext: true,
 			isOutdatedOnScopeSchool: true,
+			isDeactivated: false,
 		});
 
 		if (
@@ -34,6 +35,10 @@ export class CommonToolService {
 			configurationStatus.isOutdatedOnScopeSchool = true;
 		}
 
+		if (externalTool.isDeactivated || schoolExternalTool.status?.isDeactivated) {
+			configurationStatus.isDeactivated = true;
+		}
+
 		return configurationStatus;
 	}
 

diff --git a/apps/server/src/modules/tool/context-external-tool/service/tool-version-service.spec.ts b/apps/server/src/modules/tool/context-external-tool/service/tool-version-service.spec.ts
@@ -5,6 +5,7 @@ import {
 	contextExternalToolFactory,
 	externalToolFactory,
 	schoolExternalToolFactory,
+	schoolToolConfigurationStatusFactory,
 	toolConfigurationStatusFactory,
 } from '@shared/testing';
 import { ContextExternalToolConfigurationStatus } from '../../common/domain';
@@ -319,5 +320,132 @@ describe('ToolVersionService', () => {
 				expect(contextExternalToolValidationService.validate).toHaveBeenCalledWith(contextExternalTool);
 			});
 		});
+
+		describe('when FEATURE_COMPUTE_TOOL_STATUS_WITHOUT_VERSIONS_ENABLED is true and  SchoolExternalTool is deactivated', () => {
+			const setup = () => {
+				const externalTool = externalToolFactory.buildWithId();
+				const schoolExternalTool = schoolExternalToolFactory.buildWithId({
+					toolId: externalTool.id as string,
+				});
+				schoolExternalTool.status = schoolToolConfigurationStatusFactory.build({ isDeactivated: true });
+				const contextExternalTool = contextExternalToolFactory
+					.withSchoolExternalToolRef(schoolExternalTool.id as string)
+					.buildWithId();
+
+				toolFeatures.toolStatusWithoutVersions = true;
+
+				schoolExternalToolValidationService.validate.mockRejectedValueOnce(Promise.resolve());
+				contextExternalToolValidationService.validate.mockRejectedValueOnce(Promise.resolve());
+
+				return {
+					externalTool,
+					schoolExternalTool,
+					contextExternalTool,
+				};
+			};
+
+			it('should return status is deactivated', async () => {
+				const { externalTool, schoolExternalTool, contextExternalTool } = setup();
+
+				const status: ContextExternalToolConfigurationStatus = await service.determineToolConfigurationStatus(
+					externalTool,
+					schoolExternalTool,
+					contextExternalTool
+				);
+
+				expect(status).toEqual(
+					toolConfigurationStatusFactory.build({
+						isOutdatedOnScopeContext: true,
+						isOutdatedOnScopeSchool: true,
+						isDeactivated: true,
+					})
+				);
+			});
+		});
+
+		describe('when FEATURE_COMPUTE_TOOL_STATUS_WITHOUT_VERSIONS_ENABLED is true and  externalTool is deactivated', () => {
+			const setup = () => {
+				const externalTool = externalToolFactory.buildWithId({
+					isDeactivated: true,
+				});
+				const schoolExternalTool = schoolExternalToolFactory.buildWithId({
+					toolId: externalTool.id as string,
+				});
+				const contextExternalTool = contextExternalToolFactory
+					.withSchoolExternalToolRef(schoolExternalTool.id as string)
+					.buildWithId();
+
+				toolFeatures.toolStatusWithoutVersions = true;
+
+				schoolExternalToolValidationService.validate.mockRejectedValueOnce(Promise.resolve());
+				contextExternalToolValidationService.validate.mockRejectedValueOnce(Promise.resolve());
+
+				return {
+					externalTool,
+					schoolExternalTool,
+					contextExternalTool,
+				};
+			};
+
+			it('should return deactivated tool status', async () => {
+				const { externalTool, schoolExternalTool, contextExternalTool } = setup();
+
+				const status: ContextExternalToolConfigurationStatus = await service.determineToolConfigurationStatus(
+					externalTool,
+					schoolExternalTool,
+					contextExternalTool
+				);
+
+				expect(status).toEqual(
+					toolConfigurationStatusFactory.build({
+						isOutdatedOnScopeContext: true,
+						isOutdatedOnScopeSchool: true,
+						isDeactivated: true,
+					})
+				);
+			});
+		});
+
+		describe('when FEATURE_COMPUTE_TOOL_STATUS_WITHOUT_VERSIONS_ENABLED is true,  externalTool and schoolExternalTool are not deactivated', () => {
+			const setup = () => {
+				const externalTool = externalToolFactory.buildWithId({});
+
+				const schoolExternalTool = schoolExternalToolFactory.buildWithId({
+					toolId: externalTool.id as string,
+				});
+				const contextExternalTool = contextExternalToolFactory
+					.withSchoolExternalToolRef(schoolExternalTool.id as string)
+					.buildWithId();
+
+				toolFeatures.toolStatusWithoutVersions = true;
+
+				schoolExternalToolValidationService.validate.mockRejectedValueOnce(Promise.resolve());
+				contextExternalToolValidationService.validate.mockRejectedValueOnce(Promise.resolve());
+
+				return {
+					externalTool,
+					schoolExternalTool,
+					contextExternalTool,
+				};
+			};
+
+			it('should return deactivated tool status', async () => {
+				const { externalTool, schoolExternalTool, contextExternalTool } = setup();
+
+				const status: ContextExternalToolConfigurationStatus = await service.determineToolConfigurationStatus(
+					externalTool,
+					schoolExternalTool,
+					contextExternalTool
+				);
+
+				expect(status).toEqual(
+					toolConfigurationStatusFactory.build({
+						isOutdatedOnScopeContext: true,
+						isOutdatedOnScopeSchool: true,
+						isDeactivated: false,
+					})
+				);
+			});
+		});
 	});
 });
diff --git a/apps/server/src/modules/tool/context-external-tool/service/tool-version-service.ts b/apps/server/src/modules/tool/context-external-tool/service/tool-version-service.ts
@@ -28,6 +28,7 @@ export class ToolVersionService {
 			const configurationStatus: ContextExternalToolConfigurationStatus = new ContextExternalToolConfigurationStatus({
 				isOutdatedOnScopeContext: false,
 				isOutdatedOnScopeSchool: false,
+				isDeactivated: this.isToolDeactivated(externalTool, schoolExternalTool),
 			});
 
 			try {
@@ -52,4 +53,12 @@ export class ToolVersionService {
 
 		return status;
 	}
+
+	private isToolDeactivated(externalTool: ExternalTool, schoolExternalTool: SchoolExternalTool) {
+		if (externalTool.isDeactivated || (schoolExternalTool.status && schoolExternalTool.status.isDeactivated)) {
+			return true;
+		}
+
+		return false;
+	}
 }
diff --git a/apps/server/src/modules/tool/external-tool/controller/api-test/tool.api.spec.ts b/apps/server/src/modules/tool/external-tool/controller/api-test/tool.api.spec.ts
@@ -87,6 +87,7 @@ describe('ToolController (API)', () => {
 				baseUrl: 'https://link.to-my-tool.com/:key',
 			},
 			isHidden: false,
+			isDeactivated: false,
 			logoUrl: 'https://link.to-my-logo.com',
 			url: 'https://link.to-my-tool.com',
 			openNewTab: true,
@@ -151,6 +152,7 @@ describe('ToolController (API)', () => {
 						baseUrl: 'https://link.to-my-tool.com/:key',
 					},
 					isHidden: false,
+					isDeactivated: false,
 					logoUrl: 'https://link.to-my-logo.com',
 					url: 'https://link.to-my-tool.com',
 					openNewTab: true,
@@ -382,6 +384,7 @@ describe('ToolController (API)', () => {
 				baseUrl: 'https://link.to-my-tool.com/:key',
 			},
 			isHidden: false,
+			isDeactivated: false,
 			logoUrl: 'https://link.to-my-logo.com',
 			url: 'https://link.to-my-tool.com',
 			openNewTab: true,
@@ -449,6 +452,7 @@ describe('ToolController (API)', () => {
 						baseUrl: 'https://link.to-my-tool.com/:key',
 					},
 					isHidden: false,
+					isDeactivated: false,
 					logoUrl: 'https://link.to-my-logo.com',
 					url: 'https://link.to-my-tool.com',
 					openNewTab: true,

diff --git a/...rver/src/modules/tool/external-tool/controller/dto/request/external-tool-create.params.ts b/...rver/src/modules/tool/external-tool/controller/dto/request/external-tool-create.params.ts
@@ -58,6 +58,14 @@ export class ExternalToolCreateParams {
 	@ApiProperty()
 	isHidden!: boolean;
 
+	@IsBoolean()
+	@ApiProperty({
+		type: Boolean,
+		default: false,
+		description: 'Tool can be deactivated, related tools can not be added to e.g. school, course or board anymore',
+	})
+	isDeactivated!: boolean;
+
 	@IsBoolean()
 	@ApiProperty()
 	openNewTab!: boolean;

diff --git a/...rver/src/modules/tool/external-tool/controller/dto/request/external-tool-update.params.ts b/...rver/src/modules/tool/external-tool/controller/dto/request/external-tool-update.params.ts
@@ -62,6 +62,13 @@ export class ExternalToolUpdateParams {
 	@ApiProperty()
 	isHidden!: boolean;
 
+	@IsBoolean()
+	@ApiProperty({
+		type: Boolean,
+		default: false,
+	})
+	isDeactivated!: boolean;
+
 	@IsBoolean()
 	@ApiProperty()
 	openNewTab!: boolean;

diff --git a/apps/server/src/modules/tool/external-tool/controller/dto/response/external-tool.response.ts b/apps/server/src/modules/tool/external-tool/controller/dto/response/external-tool.response.ts
@@ -25,6 +25,9 @@ export class ExternalToolResponse {
 	@ApiProperty()
 	isHidden: boolean;
 
+	@ApiProperty()
+	isDeactivated: boolean;
+
 	@ApiProperty()
 	openNewTab: boolean;
 
@@ -42,6 +45,7 @@ export class ExternalToolResponse {
 		this.config = response.config;
 		this.parameters = response.parameters;
 		this.isHidden = response.isHidden;
+		this.isDeactivated = response.isDeactivated;
 		this.openNewTab = response.openNewTab;
 		this.version = response.version;
 		this.restrictToContexts = response.restrictToContexts;