N21-1494 Generate Info outdated ctl tools

src/components/administration/ExternalToolSection.unit.ts

@@ -1,5 +1,4 @@
 import AuthModule from "@/store/auth";
-import { ToolConfigurationStatus } from "@/store/external-tool";
 import NotifierModule from "@/store/notifier";
 import SchoolExternalToolsModule from "@/store/school-external-tools";
 import { User } from "@/store/types/auth";
@@ -21,6 +20,7 @@ import { useSchoolExternalToolUsage } from "@data-external-tool";
 import {
 	schoolExternalToolFactory,
 	schoolExternalToolMetadataFactory,
+	toolConfigurationStatusFactory,
 } from "@@/tests/test-utils/factory";
 
 jest.mock("@data-external-tool");
@@ -119,7 +119,7 @@ describe("ExternalToolSection", () => {
 						schoolId: "schoolId",
 						parameters: [],
 						name: firstToolName,
-						status: ToolConfigurationStatus.Latest,
+						status: toolConfigurationStatusFactory.build(),
 						version: 1,
 					},
 					{
@@ -128,7 +128,9 @@ describe("ExternalToolSection", () => {
 						schoolId: "schoolId",
 						parameters: [],
 						name: secondToolName,
-						status: ToolConfigurationStatus.Outdated,
+						status: toolConfigurationStatusFactory.build({
+							isOutdatedOnScopeSchool: true,
+						}),
 						version: 1,
 					},
 				],
@@ -246,7 +248,7 @@ describe("ExternalToolSection", () => {
 									schoolId: "schoolId",
 									parameters: [],
 									name: "firstToolName",
-									status: ToolConfigurationStatus.Latest,
+									status: toolConfigurationStatusFactory.build(),
 									version: 1,
 								},
 							],
@@ -278,7 +280,7 @@ describe("ExternalToolSection", () => {
 									schoolId: "schoolId",
 									parameters: [],
 									name: "firstToolName",
-									status: ToolConfigurationStatus.Latest,
+									status: toolConfigurationStatusFactory.build(),
 									version: 1,
 								},
 							],
@@ -313,7 +315,7 @@ describe("ExternalToolSection", () => {
 				//@ts-ignore
 				wrapper.vm.itemToDelete = {
 					name: expectedName,
-					status: ToolConfigurationStatus.Latest,
+					status: toolConfigurationStatusFactory.build(),
 					outdated: false,
 				};
 

src/components/administration/external-tool-section-utils.composable.ts

@@ -1,9 +1,6 @@
 import { DataTableHeader } from "vuetify";
 import { SchoolExternalToolItem } from "./school-external-tool-item";
-import {
-	SchoolExternalTool,
-	ToolConfigurationStatus,
-} from "@/store/external-tool";
+import { SchoolExternalTool } from "@/store/external-tool";
 import { ToolConfigurationStatusTranslationMapping } from "@/composables/external-tool-mappings.composable";
 import SchoolExternalToolsModule from "@/store/school-external-tools";
 
@@ -35,10 +32,9 @@ export function useExternalToolsSectionUtils(
 		const schoolExternalTools: SchoolExternalTool[] =
 			schoolExternalToolsModule.getSchoolExternalTools;
 		return schoolExternalTools.map((tool: SchoolExternalTool) => {
-			const outdated: boolean =
-				tool.status === ToolConfigurationStatus.Outdated;
+			const outdated: boolean = tool.status.isOutdatedOnScopeSchool;
 			const statusTranslationKey: string =
-				ToolConfigurationStatusTranslationMapping[tool.status];
+				ToolConfigurationStatusTranslationMapping(tool.status);
 
 			return {
 				id: tool.id,

src/components/administration/external-tool-section-utils.composable.unit.ts

@@ -3,11 +3,10 @@ import { DataTableHeader } from "vuetify";
 import { schoolExternalToolsModule } from "@/store";
 import {
 	SchoolExternalToolResponse,
-	SchoolExternalToolResponseStatusEnum,
 	SchoolExternalToolSearchListResponse,
 } from "@/serverApi/v3";
 import { SchoolExternalToolItem } from "./school-external-tool-item";
-import { ToolConfigurationStatus } from "@/store/external-tool";
+import { toolConfigurationStatusFactory } from "@@/tests/test-utils";
 
 const schoolExternalToolsModuleMock = () => {
 	return {
@@ -16,7 +15,10 @@ const schoolExternalToolsModuleMock = () => {
 				id: "id",
 				name: "toolName",
 				version: 1,
-				status: "Latest",
+				status: {
+					isOutdatedOnScopeSchool: false,
+					isOutdatedOnScopeContext: false,
+				},
 			},
 		],
 	};
@@ -45,7 +47,10 @@ describe("useSchoolExternalToolUtils", () => {
 					value: "value",
 				},
 			],
-			status: SchoolExternalToolResponseStatusEnum.Latest,
+			status: toolConfigurationStatusFactory.build({
+				isOutdatedOnScopeSchool: false,
+				isOutdatedOnScopeContext: false,
+			}),
 		};
 		const listResponse: SchoolExternalToolSearchListResponse = {
 			data: [toolResponse],
@@ -54,7 +59,7 @@ describe("useSchoolExternalToolUtils", () => {
 		const schoolExternaToolItem: SchoolExternalToolItem = {
 			name: toolResponse.name,
 			id: toolResponse.id,
-			status: ToolConfigurationStatus.Latest,
+			status: "translationKey",
 			outdated: false,
 		};
 

src/components/data-external-tool/ContextExternalToolApi.composable.unit.ts

@@ -1,15 +1,13 @@
 import * as serverApi from "@/serverApi/v3/api";
 import { ToolReferenceResponse } from "@/serverApi/v3/api";
-import {
-	ExternalToolDisplayData,
-	ToolConfigurationStatus,
-} from "@/store/external-tool";
+import { ExternalToolDisplayData } from "@/store/external-tool";
 import {
 	mockApiResponse,
 	toolReferenceResponseFactory,
 } from "@@/tests/test-utils";
 import { createMock, DeepMocked } from "@golevelup/ts-jest";
 import { useContextExternalToolApi } from "./ContextExternalToolApi.composable";
+import { toolConfigurationStatusFactory } from "../../../tests/test-utils/factory/toolConfigurationSatusFactory";
 
 describe("ContextExternalToolApi.composable", () => {
 	let toolApi: DeepMocked<serverApi.ToolApiInterface>;
@@ -62,7 +60,7 @@ describe("ContextExternalToolApi.composable", () => {
 				contextExternalToolId: displayData.contextToolId,
 				name: displayData.displayName,
 				logoUrl: displayData.logoUrl,
-				status: ToolConfigurationStatus.Latest,
+				status: toolConfigurationStatusFactory.build(),
 				openInNewTab: displayData.openInNewTab,
 			});
 		});

src/components/data-external-tool/ToolConfigurationStatus.composable.ts

@@ -0,0 +1,32 @@
+import { ToolConfigurationStatus } from "@/store/external-tool";
+import AuthModule from "@/store/auth";
+import { AUTH_MODULE_KEY, injectStrict } from "@/utils/inject";
+
+export const useToolConfigurationStatus = () => {
+	const authModule: AuthModule = injectStrict(AUTH_MODULE_KEY);
+
+	const determineOutdatedTranslationKey = (
+		toolConfigStatus: ToolConfigurationStatus | undefined
+	): string => {
+		const userRoles = authModule.getUserRoles;
+
+		if (userRoles.includes("teacher")) {
+			if (
+				toolConfigStatus?.isOutdatedOnScopeContext &&
+				toolConfigStatus.isOutdatedOnScopeSchool
+			) {
+				return "common.information.outdatedOnSchoolAndContext.teacher";
+			} else if (toolConfigStatus?.isOutdatedOnScopeSchool) {
+				return "common.information.outdatedOnSchool.teacher";
+			} else {
+				return "common.information.outdatedOnContext.teacher";
+			}
+		} else {
+			return "common.information.outdated.student";
+		}
+	};
+
+	return {
+		determineOutdatedTranslationKey,
+	};
+};

src/components/data-external-tool/index.ts

@@ -3,3 +3,4 @@ export * from "./ExternalToolElementDisplayState.composable";
 export * from "./ExternalToolLaunchState.composable";
 export * from "./SchoolExternalToolApi.composable";
 export * from "./SchoolExternalToolUsage.composable";
+export * from "./ToolConfigurationStatus.composable";

src/components/feature-board-external-tool-element/ExternalToolElement.unit.ts

@@ -2,10 +2,7 @@ import {
 	ContentElementType,
 	ExternalToolElementResponse,
 } from "@/serverApi/v3";
-import {
-	ExternalToolDisplayData,
-	ToolConfigurationStatus,
-} from "@/store/external-tool";
+import { ExternalToolDisplayData } from "@/store/external-tool";
 import { ContextExternalTool } from "@/store/external-tool/context-external-tool";
 import { BusinessError } from "@/store/types/commons";
 import { I18N_KEY } from "@/utils/inject";
@@ -14,12 +11,14 @@ import {
 	externalToolDisplayDataFactory,
 	i18nMock,
 	timestampsResponseFactory,
+	toolConfigurationStatusFactory,
 } from "@@/tests/test-utils";
 import createComponentMocks from "@@/tests/test-utils/componentMocks";
 import { useBoardFocusHandler, useContentElementState } from "@data-board";
 import {
 	useExternalToolElementDisplayState,
 	useExternalToolLaunchState,
+	useToolConfigurationStatus,
 } from "@data-external-tool";
 import { createMock, DeepMocked } from "@golevelup/ts-jest";
 import { mdiPuzzleOutline } from "@mdi/js";
@@ -58,6 +57,10 @@ describe("ExternalToolElement", () => {
 		ReturnType<typeof useSharedLastCreatedElement>
 	>;
 
+	let useToolConfigurationStatusMock: DeepMocked<
+		ReturnType<typeof useToolConfigurationStatus>
+	>;
+
 	beforeEach(() => {
 		useContentElementStateMock =
 			createMock<ReturnType<typeof useContentElementState>>();
@@ -69,6 +72,8 @@ describe("ExternalToolElement", () => {
 			createMock<ReturnType<typeof useExternalToolLaunchState>>();
 		useSharedLastCreatedElementMock =
 			createMock<ReturnType<typeof useSharedLastCreatedElement>>();
+		useToolConfigurationStatusMock =
+			createMock<ReturnType<typeof useToolConfigurationStatus>>();
 
 		jest
 			.mocked(useContentElementState)
@@ -83,6 +88,9 @@ describe("ExternalToolElement", () => {
 		jest
 			.mocked(useSharedLastCreatedElement)
 			.mockReturnValue(useSharedLastCreatedElementMock);
+		jest
+			.mocked(useToolConfigurationStatus)
+			.mockReturnValue(useToolConfigurationStatusMock);
 	});
 
 	afterEach(() => {
@@ -143,7 +151,7 @@ describe("ExternalToolElement", () => {
 						isEditMode: false,
 					},
 					externalToolDisplayDataFactory.build({
-						status: ToolConfigurationStatus.Latest,
+						status: toolConfigurationStatusFactory.build(),
 					})
 				);
 
@@ -164,7 +172,7 @@ describe("ExternalToolElement", () => {
 						isEditMode: false,
 					},
 					externalToolDisplayDataFactory.build({
-						status: ToolConfigurationStatus.Latest,
+						status: toolConfigurationStatusFactory.build(),
 					})
 				);
 
@@ -187,7 +195,10 @@ describe("ExternalToolElement", () => {
 						isEditMode: false,
 					},
 					externalToolDisplayDataFactory.build({
-						status: ToolConfigurationStatus.Outdated,
+						status: toolConfigurationStatusFactory.build({
+							isOutdatedOnScopeContext: true,
+							isOutdatedOnScopeSchool: true,
+						}),
 					})
 				);
 
@@ -677,13 +688,18 @@ describe("ExternalToolElement", () => {
 					message: "Loading error",
 				};
 
+				const toolOautdatedStatus = toolConfigurationStatusFactory.build({
+					isOutdatedOnScopeContext: true,
+					isOutdatedOnScopeSchool: true,
+				});
+
 				const { wrapper } = getWrapper(
 					{
 						element: EMPTY_TEST_ELEMENT,
 						isEditMode: true,
 					},
 					externalToolDisplayDataFactory.build({
-						status: ToolConfigurationStatus.Outdated,
+						status: toolOautdatedStatus,
 					})
 				);
 
@@ -692,17 +708,18 @@ describe("ExternalToolElement", () => {
 				return {
 					wrapper,
 					error,
+					toolOautdatedStatus,
 				};
 			};
 
 			it("should display an outdated alert", async () => {
-				const { wrapper } = setup();
+				const { wrapper, toolOautdatedStatus } = setup();
 
 				const alert = wrapper.find(
 					'[data-testid="board-external-tool-element-alert"]'
 				);
 
-				expect(alert.props("isToolOutdated")).toEqual(true);
+				expect(alert.props("toolOutdatedStatus")).toEqual(toolOautdatedStatus);
 			});
 
 			it("should display an error alert", async () => {

src/components/feature-board-external-tool-element/ExternalToolElement.vue

@@ -45,6 +45,7 @@
 		<ExternalToolElementAlert
 			:error="error"
 			:is-tool-outdated="isToolOutdated"
+			:tool-outdated-status="toolOutdatedStatus"
 			data-testid="board-external-tool-element-alert"
 		/>
 		<ExternalToolElementConfigurationDialog
@@ -61,7 +62,6 @@
 <script lang="ts">
 import { useI18n } from "@/composables/i18n.composable";
 import { ExternalToolElementResponse } from "@/serverApi/v3";
-import { ToolConfigurationStatus } from "@/store/external-tool";
 import { ContextExternalTool } from "@/store/external-tool/context-external-tool";
 import { useBoardFocusHandler, useContentElementState } from "@data-board";
 import {
@@ -84,6 +84,7 @@ import {
 import ExternalToolElementAlert from "./ExternalToolElementAlert.vue";
 import ExternalToolElementConfigurationDialog from "./ExternalToolElementConfigurationDialog.vue";
 import ExternalToolElementMenu from "./ExternalToolElementMenu.vue";
+import { ToolConfigurationStatus } from "@/store/external-tool";
 
 export default defineComponent({
 	components: {
@@ -115,6 +116,7 @@ export default defineComponent({
 			isLoading: isDisplayDataLoading,
 			error,
 		} = useExternalToolElementDisplayState();
+
 		const { launchTool, fetchLaunchRequest } = useExternalToolLaunchState();
 
 		const autofocus: Ref<boolean> = ref(false);
@@ -142,9 +144,17 @@ export default defineComponent({
 		);
 
 		const isToolOutdated: ComputedRef<boolean> = computed(
-			() => displayData.value?.status === ToolConfigurationStatus.Outdated
+			() =>
+				(displayData.value?.status.isOutdatedOnScopeSchool ||
+					displayData.value?.status.isOutdatedOnScopeContext) ??
+				false
 		);
 
+		const toolOutdatedStatus: ComputedRef<ToolConfigurationStatus | undefined> =
+			computed(() => {
+				return displayData.value?.status;
+			});
+
 		const isLoading = computed(
 			() =>
 				hasLinkedTool.value && !displayData.value && isDisplayDataLoading.value
@@ -214,6 +224,7 @@ export default defineComponent({
 			isLoading,
 			isToolOutdated,
 			isConfigurationDialogOpen,
+			toolOutdatedStatus,
 			mdiPuzzleOutline,
 			onMoveElementDown,
 			onMoveElementUp,