N21-1494 Contextual info outdated CTL

apps/server/src/modules/tool/common/controller/dto/tool-configuration-status.response.ts

@@ -0,0 +1,22 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class ToolConfigurationStatusResponse {
+	@ApiProperty({
+		type: Boolean,
+		description:
+			'Is the tool outdated on school scope, because of non matching versions or required parameter changes on ExternalTool?',
+	})
+	isOutdatedOnScopeSchool: boolean;
+
+	@ApiProperty({
+		type: Boolean,
+		description:
+			'Is the tool outdated on context scope, because of non matching versions or required parameter changes on SchoolExternalTool?',
+	})
+	isOutdatedOnScopeContext: boolean;
+
+	constructor(props: ToolConfigurationStatusResponse) {
+		this.isOutdatedOnScopeSchool = props.isOutdatedOnScopeSchool;
+		this.isOutdatedOnScopeContext = props.isOutdatedOnScopeContext;
+	}
+}

apps/server/src/modules/tool/common/domain/index.ts

@@ -1,3 +1,3 @@
 export * from './custom-parameter.do';
 export * from './custom-parameter-entry.do';
-export * from '../enum/tool-configuration-status';
+export * from './tool-configuration-status';

apps/server/src/modules/tool/common/domain/tool-configuration-status.ts

@@ -0,0 +1,10 @@
+export class ToolConfigurationStatus {
+	isOutdatedOnScopeSchool: boolean;
+
+	isOutdatedOnScopeContext: boolean;
+
+	constructor(props: ToolConfigurationStatus) {
+		this.isOutdatedOnScopeSchool = props.isOutdatedOnScopeSchool;
+		this.isOutdatedOnScopeContext = props.isOutdatedOnScopeContext;
+	}
+}

apps/server/src/modules/tool/common/enum/index.ts

@@ -10,4 +10,3 @@ export * from './tool-context-type.enum';
 export * from './custom-parameter-location.enum';
 export * from './custom-parameter-scope.enum';
 export * from './custom-parameter-type.enum';
-export * from './tool-configuration-status';

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

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

apps/server/src/modules/tool/common/service/common-tool.service.spec.ts

@@ -1,9 +1,15 @@
 import { Test, TestingModule } from '@nestjs/testing';
-import { contextExternalToolFactory, externalToolFactory, schoolExternalToolFactory } from '@shared/testing';
+import {
+	contextExternalToolFactory,
+	externalToolFactory,
+	schoolExternalToolFactory,
+	toolConfigurationStatusFactory,
+} from '@shared/testing';
 import { CommonToolService } from './common-tool.service';
 import { ExternalTool } from '../../external-tool/domain';
 import { SchoolExternalTool } from '../../school-external-tool/domain';
-import { ToolConfigurationStatus, ToolContextType } from '../enum';
+import { ToolContextType } from '../enum';
+import { ToolConfigurationStatus } from '../domain';
 import { ContextExternalTool } from '../../context-external-tool/domain';
 
 describe('CommonToolService', () => {
@@ -36,7 +42,7 @@ describe('CommonToolService', () => {
 				};
 			};
 
-			it('should return ToolConfigurationStatus.LATEST', () => {
+			it('should return a configuration status with latest true', () => {
 				const { externalTool, schoolExternalTool, contextExternalTool } = setup();
 
 				const result: ToolConfigurationStatus = service.determineToolConfigurationStatus(
@@ -45,7 +51,12 @@ describe('CommonToolService', () => {
 					contextExternalTool
 				);
 
-				expect(result).toBe(ToolConfigurationStatus.LATEST);
+				expect(result).toEqual(
+					toolConfigurationStatusFactory.build({
+						isOutdatedOnScopeContext: false,
+						isOutdatedOnScopeSchool: false,
+					})
+				);
 			});
 		});
 
@@ -62,7 +73,7 @@ describe('CommonToolService', () => {
 				};
 			};
 
-			it('should return ToolConfigurationStatus.OUTDATED', () => {
+			it('should return outdated status for school level', () => {
 				const { externalTool, schoolExternalTool, contextExternalTool } = setup();
 
 				const result: ToolConfigurationStatus = service.determineToolConfigurationStatus(
@@ -71,7 +82,12 @@ describe('CommonToolService', () => {
 					contextExternalTool
 				);
 
-				expect(result).toBe(ToolConfigurationStatus.OUTDATED);
+				expect(result).toEqual(
+					toolConfigurationStatusFactory.build({
+						isOutdatedOnScopeContext: false,
+						isOutdatedOnScopeSchool: true,
+					})
+				);
 			});
 		});
 
@@ -88,7 +104,7 @@ describe('CommonToolService', () => {
 				};
 			};
 
-			it('should return ToolConfigurationStatus.OUTDATED', () => {
+			it('should return outdated status for context level', () => {
 				const { externalTool, schoolExternalTool, contextExternalTool } = setup();
 
 				const result: ToolConfigurationStatus = service.determineToolConfigurationStatus(
@@ -97,7 +113,12 @@ describe('CommonToolService', () => {
 					contextExternalTool
 				);
 
-				expect(result).toBe(ToolConfigurationStatus.OUTDATED);
+				expect(result).toEqual(
+					toolConfigurationStatusFactory.build({
+						isOutdatedOnScopeContext: true,
+						isOutdatedOnScopeSchool: false,
+					})
+				);
 			});
 		});
 
@@ -114,7 +135,7 @@ describe('CommonToolService', () => {
 				};
 			};
 
-			it('should return ToolConfigurationStatus.OUTDATED', () => {
+			it('should return outdated status for context and school level', () => {
 				const { externalTool, schoolExternalTool, contextExternalTool } = setup();
 
 				const result: ToolConfigurationStatus = service.determineToolConfigurationStatus(
@@ -123,7 +144,12 @@ describe('CommonToolService', () => {
 					contextExternalTool
 				);
 
-				expect(result).toBe(ToolConfigurationStatus.OUTDATED);
+				expect(result).toEqual(
+					toolConfigurationStatusFactory.build({
+						isOutdatedOnScopeContext: true,
+						isOutdatedOnScopeSchool: false,
+					})
+				);
 			});
 		});
 
@@ -140,7 +166,7 @@ describe('CommonToolService', () => {
 				};
 			};
 
-			it('should return ToolConfigurationStatus.LATEST', () => {
+			it('should return a configuration status with latest true', () => {
 				const { externalTool, schoolExternalTool, contextExternalTool } = setup();
 
 				const result: ToolConfigurationStatus = service.determineToolConfigurationStatus(
@@ -149,7 +175,12 @@ describe('CommonToolService', () => {
 					contextExternalTool
 				);
 
-				expect(result).toBe(ToolConfigurationStatus.LATEST);
+				expect(result).toEqual(
+					toolConfigurationStatusFactory.build({
+						isOutdatedOnScopeContext: false,
+						isOutdatedOnScopeSchool: false,
+					})
+				);
 			});
 		});
 
@@ -166,7 +197,7 @@ describe('CommonToolService', () => {
 				};
 			};
 
-			it('should return ToolConfigurationStatus.LATEST', () => {
+			it('should return a configuration status with latest true', () => {
 				const { externalTool, schoolExternalTool, contextExternalTool } = setup();
 
 				const result: ToolConfigurationStatus = service.determineToolConfigurationStatus(
@@ -175,7 +206,12 @@ describe('CommonToolService', () => {
 					contextExternalTool
 				);
 
-				expect(result).toBe(ToolConfigurationStatus.LATEST);
+				expect(result).toEqual(
+					toolConfigurationStatusFactory.build({
+						isOutdatedOnScopeContext: false,
+						isOutdatedOnScopeSchool: false,
+					})
+				);
 			});
 		});
 
@@ -192,7 +228,7 @@ describe('CommonToolService', () => {
 				};
 			};
 
-			it('should return ToolConfigurationStatus.LATEST', () => {
+			it('should return a configuration status with latest true', () => {
 				const { externalTool, schoolExternalTool, contextExternalTool } = setup();
 
 				const result: ToolConfigurationStatus = service.determineToolConfigurationStatus(
@@ -201,7 +237,12 @@ describe('CommonToolService', () => {
 					contextExternalTool
 				);
 
-				expect(result).toBe(ToolConfigurationStatus.LATEST);
+				expect(result).toEqual(
+					toolConfigurationStatusFactory.build({
+						isOutdatedOnScopeContext: false,
+						isOutdatedOnScopeSchool: false,
+					})
+				);
 			});
 		});
 	});

apps/server/src/modules/tool/common/service/common-tool.service.ts

@@ -2,7 +2,8 @@ import { Injectable } from '@nestjs/common';
 import { ExternalTool } from '../../external-tool/domain';
 import { SchoolExternalTool } from '../../school-external-tool/domain';
 import { ContextExternalTool } from '../../context-external-tool/domain';
-import { ToolConfigurationStatus, ToolContextType } from '../enum';
+import { ToolContextType } from '../enum';
+import { ToolConfigurationStatus } from '../domain';
 import { ToolVersion } from '../interface';
 
 // TODO N21-1337 remove class when tool versioning is removed
@@ -16,15 +17,26 @@ export class CommonToolService {
 		schoolExternalTool: SchoolExternalTool,
 		contextExternalTool: ContextExternalTool
 	): ToolConfigurationStatus {
-		if (
-			this.isLatest(schoolExternalTool, externalTool) &&
-			this.isLatest(contextExternalTool, schoolExternalTool) &&
-			this.isLatest(contextExternalTool, externalTool)
-		) {
-			return ToolConfigurationStatus.LATEST;
+		const configurationStatus: ToolConfigurationStatus = new ToolConfigurationStatus({
+			isOutdatedOnScopeContext: true,
+			isOutdatedOnScopeSchool: true,
+		});
+
+		if (!this.isLatest(schoolExternalTool, externalTool)) {
+			configurationStatus.isOutdatedOnScopeContext = false;
+			configurationStatus.isOutdatedOnScopeSchool = true;
+		} else if (!this.isLatest(contextExternalTool, schoolExternalTool)) {
+			configurationStatus.isOutdatedOnScopeContext = true;
+			configurationStatus.isOutdatedOnScopeSchool = false;
+		} else if (!this.isLatest(contextExternalTool, externalTool)) {
+			configurationStatus.isOutdatedOnScopeContext = true;
+			configurationStatus.isOutdatedOnScopeSchool = true;
+		} else {
+			configurationStatus.isOutdatedOnScopeContext = false;
+			configurationStatus.isOutdatedOnScopeSchool = false;
 		}
 
-		return ToolConfigurationStatus.OUTDATED;
+		return configurationStatus;
 	}
 
 	private isLatest(tool1: ToolVersion, tool2: ToolVersion): boolean {

apps/server/src/modules/tool/context-external-tool/controller/api-test/tool-reference.api.spec.ts

@@ -15,13 +15,14 @@ import {
 	schoolExternalToolEntityFactory,
 	schoolFactory,
 } from '@shared/testing';
+
+import { toolConfigurationStatusResponseFactory } from '@shared/testing/factory/tool-configuration-status-response.factory';
 import { Response } from 'supertest';
 import { CustomParameterLocation, CustomParameterScope, ToolContextType } from '../../../common/enum';
 import { ExternalToolEntity } from '../../../external-tool/entity';
 import { SchoolExternalToolEntity } from '../../../school-external-tool/entity';
 import { ContextExternalToolEntity, ContextExternalToolType } from '../../entity';
 import { ContextExternalToolContextParams, ToolReferenceListResponse, ToolReferenceResponse } from '../dto';
-import { ToolConfigurationStatusResponse } from '../dto/tool-configuration-status.response';
 
 describe('ToolReferenceController (API)', () => {
 	let app: INestApplication;
@@ -174,7 +175,10 @@ describe('ToolReferenceController (API)', () => {
 						{
 							contextToolId: contextExternalToolEntity.id,
 							displayName: contextExternalToolEntity.displayName as string,
-							status: ToolConfigurationStatusResponse.LATEST,
+							status: toolConfigurationStatusResponseFactory.build({
+								isOutdatedOnScopeSchool: false,
+								isOutdatedOnScopeContext: false,
+							}),
 							logoUrl: `http://localhost:3030/api/v3/tools/external-tools/${externalToolEntity.id}/logo`,
 							openInNewTab: externalToolEntity.openNewTab,
 						},
@@ -303,7 +307,10 @@ describe('ToolReferenceController (API)', () => {
 				expect(response.body).toEqual<ToolReferenceResponse>({
 					contextToolId: contextExternalToolEntity.id,
 					displayName: contextExternalToolEntity.displayName as string,
-					status: ToolConfigurationStatusResponse.LATEST,
+					status: toolConfigurationStatusResponseFactory.build({
+						isOutdatedOnScopeSchool: false,
+						isOutdatedOnScopeContext: false,
+					}),
 					logoUrl: `http://localhost:3030/api/v3/tools/external-tools/${externalToolEntity.id}/logo`,
 					openInNewTab: externalToolEntity.openNewTab,
 				});

apps/server/src/modules/tool/context-external-tool/controller/dto/index.ts

@@ -5,4 +5,3 @@ export * from './context-external-tool-context.params';
 export * from './context-external-tool.response';
 export * from './tool-reference-list.response';
 export * from './tool-reference.response';
-export * from './tool-configuration-status.response';

apps/server/src/modules/tool/context-external-tool/controller/dto/tool-reference.response.ts

@@ -1,5 +1,5 @@
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import { ToolConfigurationStatusResponse } from './tool-configuration-status.response';
+import { ToolConfigurationStatusResponse } from '../../../common/controller/dto/tool-configuration-status.response';
 
 export class ToolReferenceResponse {
 	@ApiProperty({ nullable: false, required: true, description: 'The id of the tool in the context' })
@@ -19,8 +19,7 @@ export class ToolReferenceResponse {
 	openInNewTab: boolean;
 
 	@ApiProperty({
-		enum: ToolConfigurationStatusResponse,
-		enumName: 'ToolConfigurationStatusResponse',
+		type: ToolConfigurationStatusResponse,
 		nullable: false,
 		required: true,
 		description: 'The status of the tool',

apps/server/src/modules/tool/context-external-tool/controller/tool-reference.controller.ts

@@ -60,7 +60,8 @@ export class ToolReferenceController {
 
 		const toolReferenceResponses: ToolReferenceResponse[] =
 			ContextExternalToolResponseMapper.mapToToolReferenceResponses(toolReferences);
-		const toolReferenceListResponse = new ToolReferenceListResponse(toolReferenceResponses);
+
+		const toolReferenceListResponse: ToolReferenceListResponse = new ToolReferenceListResponse(toolReferenceResponses);
 
 		return toolReferenceListResponse;
 	}

apps/server/src/modules/tool/context-external-tool/domain/tool-reference.ts

@@ -1,4 +1,4 @@
-import { ToolConfigurationStatus } from '../../common/enum';
+import { ToolConfigurationStatus } from '../../common/domain';
 
 export class ToolReference {
 	contextToolId: string;

apps/server/src/modules/tool/context-external-tool/mapper/tool-reference.mapper.ts

@@ -1,4 +1,4 @@
-import { ToolConfigurationStatus } from '../../common/enum';
+import { ToolConfigurationStatus } from '../../common/domain';
 import { ExternalTool } from '../../external-tool/domain';
 import { ContextExternalTool, ToolReference } from '../domain';