N21-2159 Refactoring from Review 11 (#3404)

hpi-schul-cloud · Sep 23, 2024 · 94ac68b · 94ac68b
1 parent a2c47db
commit 94ac68b
Show file tree

Hide file tree

Showing 57 changed files with 461 additions and 479 deletions.
diff --git a/src/modules/data/board/Board.store.ts b/src/modules/data/board/Board.store.ts
@@ -1,12 +1,8 @@
+import { envConfigModule } from "@/store";
 import { Board } from "@/types/board/Board";
-import { nextTick, ref } from "vue";
+import { useSharedEditMode } from "@util-board";
 import { defineStore } from "pinia";
-import { useBoardRestApi } from "./boardActions/boardRestApi.composable";
-import { useBoardSocketApi } from "./boardActions/boardSocketApi.composable";
-import { useBoardFocusHandler } from "./BoardFocusHandler.composable";
-import { useSharedEditMode } from "./EditMode.composable";
-import { envConfigModule } from "@/store";
-import { useCardStore } from "./Card.store";
+import { nextTick, ref } from "vue";
 import {
 	CreateCardRequestPayload,
 	CreateCardSuccessPayload,
@@ -28,6 +24,10 @@ import {
 	UpdateColumnTitleRequestPayload,
 	UpdateColumnTitleSuccessPayload,
 } from "./boardActions/boardActionPayload";
+import { useBoardRestApi } from "./boardActions/boardRestApi.composable";
+import { useBoardSocketApi } from "./boardActions/boardSocketApi.composable";
+import { useBoardFocusHandler } from "./BoardFocusHandler.composable";
+import { useCardStore } from "./Card.store";
 import { DeleteCardSuccessPayload } from "./cardActions/cardActionPayload";
 
 export const useBoardStore = defineStore("boardStore", () => {

diff --git a/src/modules/data/board/Board.store.unit.ts b/src/modules/data/board/Board.store.unit.ts
@@ -1,25 +1,28 @@
 import { useErrorHandler } from "@/components/error-handling/ErrorHandler.composable";
+import { envConfigModule } from "@/store";
+import EnvConfigModule from "@/store/env-config";
 import { ColumnMove } from "@/types/board/DragAndDrop";
+import { mockedPiniaStoreTyping } from "@@/tests/test-utils";
 import {
 	boardResponseFactory,
 	cardSkeletonResponseFactory,
 	columnResponseFactory,
 	envsFactory,
 } from "@@/tests/test-utils/factory";
+import { cardResponseFactory } from "@@/tests/test-utils/factory/cardResponseFactory";
+import setupStores from "@@/tests/test-utils/setupStores";
+import { useCardStore, useSocketConnection } from "@data-board";
 import { createMock, DeepMocked } from "@golevelup/ts-jest";
-import { useBoardNotifier, useSharedLastCreatedElement } from "@util-board";
+import {
+	useBoardNotifier,
+	useSharedEditMode,
+	useSharedLastCreatedElement,
+} from "@util-board";
 import { createPinia, setActivePinia } from "pinia";
 import { computed, ref } from "vue";
 import { useBoardStore } from "./Board.store";
-import { useSharedEditMode } from "./EditMode.composable";
-import { envConfigModule } from "@/store";
-import EnvConfigModule from "@/store/env-config";
-import { cardResponseFactory } from "@@/tests/test-utils/factory/cardResponseFactory";
-import setupStores from "@@/tests/test-utils/setupStores";
-import { useCardStore, useSocketConnection } from "@data-board";
 import { useBoardRestApi } from "./boardActions/boardRestApi.composable";
 import { useBoardSocketApi } from "./boardActions/boardSocketApi.composable";
-import { mockedPiniaStoreTyping } from "@@/tests/test-utils";
 import { useCardSocketApi } from "./cardActions/cardSocketApi.composable";
 
 jest.mock("./boardActions/boardSocketApi.composable");
@@ -28,10 +31,8 @@ const mockedUseBoardSocketApi = jest.mocked(useBoardSocketApi);
 jest.mock("./boardActions/boardRestApi.composable");
 const mockedUseBoardRestApi = jest.mocked(useBoardRestApi);
 
-jest.mock("./EditMode.composable");
-const mockedSharedEditMode = jest.mocked(useSharedEditMode);
-
 jest.mock("@util-board");
+const mockedSharedEditMode = jest.mocked(useSharedEditMode);
 const mockedUseBoardNotifier = jest.mocked(useBoardNotifier);
 const mockUseSharedLastCreatedElement = jest.mocked(
 	useSharedLastCreatedElement
@@ -89,6 +90,7 @@ describe("BoardStore", () => {
 		mockedSharedEditMode.mockReturnValue({
 			setEditModeId,
 			editModeId: ref(undefined),
+			isInEditMode: computed(() => true),
 		});
 
 		mockUseSharedLastCreatedElement.mockReturnValue({

diff --git a/src/modules/data/board/BoardFocusHandler.composable.ts b/src/modules/data/board/BoardFocusHandler.composable.ts
@@ -1,6 +1,7 @@
 import { BoardColumn } from "@/types/board/Board";
 import { BoardCard } from "@/types/board/Card";
 import { AnyContentElement } from "@/types/board/ContentElement";
+import { useInlineEditInteractionHandler } from "@util-board";
 import {
 	createSharedComposable,
 	MaybeRefOrGetter,
@@ -9,8 +10,6 @@ import {
 	useFocusWithin,
 } from "@vueuse/core";
 import { computed, nextTick, onMounted, onUnmounted, ref, Ref } from "vue";
-// WIP: InlineEditInteractionHandler needs to be extracted into it's own module... :: Feature-Modules have to be imported using the pattern '@feature-<name>'eslint@typescript-eslint/no-restricted-imports
-import { useInlineEditInteractionHandler } from "../../feature/board/shared/InlineEditInteractionHandler.composable";
 
 declare type FocusableId =
 	| BoardColumn["id"]

diff --git a/src/modules/data/board/Card.store.ts b/src/modules/data/board/Card.store.ts
@@ -1,10 +1,11 @@
+import { CardResponse, ContentElementType } from "@/serverApi/v3";
+import { envConfigModule } from "@/store";
+import { useSharedEditMode, useSharedLastCreatedElement } from "@util-board";
 import { defineStore } from "pinia";
 import { nextTick, ref } from "vue";
-import { envConfigModule } from "@/store";
+import { CreateCardSuccessPayload } from "./boardActions/boardActionPayload";
 
 import { useBoardFocusHandler } from "./BoardFocusHandler.composable";
-import { CardResponse, ContentElementType } from "@/serverApi/v3";
-import { CreateCardSuccessPayload } from "./boardActions/boardActionPayload";
 import {
 	CreateElementSuccessPayload,
 	DeleteCardSuccessPayload,
@@ -17,8 +18,6 @@ import {
 } from "./cardActions/cardActionPayload";
 import { useCardRestApi } from "./cardActions/cardRestApi.composable";
 import { useCardSocketApi } from "./cardActions/cardSocketApi.composable";
-import { useSharedLastCreatedElement } from "@util-board";
-import { useSharedEditMode } from "@data-board";
 
 export const useCardStore = defineStore("cardStore", () => {
 	const cards = ref<Record<string, CardResponse>>({});

diff --git a/src/modules/data/board/Card.store.unit.ts b/src/modules/data/board/Card.store.unit.ts
@@ -1,26 +1,29 @@
 import { useErrorHandler } from "@/components/error-handling/ErrorHandler.composable";
-import { useBoardNotifier, useSharedLastCreatedElement } from "@util-board";
-import { useBoardApi } from "./BoardApi.composable";
-import { useSharedEditMode } from "./EditMode.composable";
-import { useI18n } from "vue-i18n";
-import { useSocketConnection, useCardStore } from "@data-board";
-import { useCardSocketApi } from "./cardActions/cardSocketApi.composable";
-import { useCardRestApi } from "./cardActions/cardRestApi.composable";
-import { DeepMocked, createMock } from "@golevelup/ts-jest";
-import { createPinia, setActivePinia } from "pinia";
-import setupStores from "@@/tests/test-utils/setupStores";
-import EnvConfigModule from "@/store/env-config";
-import { Ref, ref } from "vue";
+import { ContentElementType } from "@/serverApi/v3";
 import { envConfigModule } from "@/store";
+import EnvConfigModule from "@/store/env-config";
 import {
 	envsFactory,
 	richTextElementContentFactory,
 	richTextElementResponseFactory,
 } from "@@/tests/test-utils";
 import { cardResponseFactory } from "@@/tests/test-utils/factory/cardResponseFactory";
-import { ContentElementType } from "@/serverApi/v3";
 import { drawingElementResponseFactory } from "@@/tests/test-utils/factory/drawingElementResponseFactory";
+import setupStores from "@@/tests/test-utils/setupStores";
+import { useCardStore, useSocketConnection } from "@data-board";
+import { createMock, DeepMocked } from "@golevelup/ts-jest";
+import {
+	useBoardNotifier,
+	useSharedEditMode,
+	useSharedLastCreatedElement,
+} from "@util-board";
 import { cloneDeep } from "lodash";
+import { createPinia, setActivePinia } from "pinia";
+import { computed, Ref, ref } from "vue";
+import { useI18n } from "vue-i18n";
+import { useBoardApi } from "./BoardApi.composable";
+import { useCardRestApi } from "./cardActions/cardRestApi.composable";
+import { useCardSocketApi } from "./cardActions/cardSocketApi.composable";
 
 jest.mock("vue-i18n");
 (useI18n as jest.Mock).mockReturnValue({ t: (key: string) => key });
@@ -34,10 +37,8 @@ const mockedUseCardSocketApi = jest.mocked(useCardSocketApi);
 jest.mock("./cardActions/cardRestApi.composable");
 const mockedUseCardRestApi = jest.mocked(useCardRestApi);
 
-jest.mock("./EditMode.composable");
-const mockedSharedEditMode = jest.mocked(useSharedEditMode);
-
 jest.mock("@util-board");
+const mockedSharedEditMode = jest.mocked(useSharedEditMode);
 const mockedUseBoardNotifier = jest.mocked(useBoardNotifier);
 const mockedSharedLastCreatedElement = jest.mocked(useSharedLastCreatedElement);
 
@@ -99,6 +100,7 @@ describe("CardStore", () => {
 		mockedSharedEditMode.mockReturnValue({
 			setEditModeId,
 			editModeId,
+			isInEditMode: computed(() => true),
 		});
 	});
 

diff --git a/src/modules/data/board/ContentElementState.unit.ts b/src/modules/data/board/ContentElementState.unit.ts
@@ -1,17 +1,17 @@
 import { ContentElementType, RichTextElementResponse } from "@/serverApi/v3";
-import { mountComposable } from "@@/tests/test-utils/mountComposable";
-import { useContentElementState } from "./ContentElementState.composable";
+import { envConfigModule } from "@/store";
+import EnvConfigModule from "@/store/env-config";
+import NotifierModule from "@/store/notifier";
 import { NOTIFIER_MODULE_KEY } from "@/utils/inject";
 import { createModuleMocks } from "@/utils/mock-store-module";
-import NotifierModule from "@/store/notifier";
-import { createTestingPinia } from "@pinia/testing";
-import { setActivePinia } from "pinia";
-import { envConfigModule } from "@/store";
 import { envsFactory } from "@@/tests/test-utils";
+import { mountComposable } from "@@/tests/test-utils/mountComposable";
 import setupStores from "@@/tests/test-utils/setupStores";
-import EnvConfigModule from "@/store/env-config";
+import { createTestingPinia } from "@pinia/testing";
+import { setActivePinia } from "pinia";
+import { useContentElementState } from "./ContentElementState.composable";
 
-jest.mock("@feature-board/shared/InlineEditInteractionHandler.composable");
+jest.mock("@util-board/InlineEditInteractionHandler.composable");
 
 const notifierModule = createModuleMocks(NotifierModule);
 const TEST_ELEMENT: RichTextElementResponse = {

diff --git a/src/modules/data/board/EditMode.composable.ts b/src/modules/data/board/EditMode.composable.ts
diff --git a/src/modules/data/board/EditMode.composable.unit.ts b/src/modules/data/board/EditMode.composable.unit.ts
diff --git a/src/modules/data/board/boardActions/boardRestApi.composable.ts b/src/modules/data/board/boardActions/boardRestApi.composable.ts
@@ -1,12 +1,11 @@
-import { useBoardStore } from "../Board.store";
-import { useBoardApi } from "../BoardApi.composable";
-import { useSharedEditMode } from "../EditMode.composable";
-import * as BoardActions from "./boardActions";
 import {
 	BoardObjectType,
 	ErrorType,
 	useErrorHandler,
 } from "@/components/error-handling/ErrorHandler.composable";
+import { useSharedEditMode } from "@util-board";
+import { useBoardStore } from "../Board.store";
+import { useBoardApi } from "../BoardApi.composable";
 import {
 	CreateCardRequestPayload,
 	DeleteColumnRequestPayload,
@@ -17,6 +16,7 @@ import {
 	UpdateBoardVisibilityRequestPayload,
 	UpdateColumnTitleRequestPayload,
 } from "./boardActionPayload";
+import * as BoardActions from "./boardActions";
 
 export const useBoardRestApi = () => {
 	const boardStore = useBoardStore();

diff --git a/src/modules/data/board/boardActions/boardRestApi.composable.unit.ts b/src/modules/data/board/boardActions/boardRestApi.composable.unit.ts
@@ -1,9 +1,7 @@
-import { setActivePinia } from "pinia";
-import { createTestingPinia } from "@pinia/testing";
-import { ref } from "vue";
+import { useErrorHandler } from "@/components/error-handling/ErrorHandler.composable";
 import { envConfigModule } from "@/store";
 import EnvConfigModule from "@/store/env-config";
-import setupStores from "@@/tests/test-utils/setupStores";
+import { ColumnMove } from "@/types/board/DragAndDrop";
 import {
 	boardResponseFactory,
 	cardSkeletonResponseFactory,
@@ -12,21 +10,23 @@ import {
 	mockedPiniaStoreTyping,
 } from "@@/tests/test-utils";
 import { cardResponseFactory } from "@@/tests/test-utils/factory/cardResponseFactory";
+import setupStores from "@@/tests/test-utils/setupStores";
+import { useBoardStore, useSocketConnection } from "@data-board";
 import { createMock, DeepMocked } from "@golevelup/ts-jest";
-import { useErrorHandler } from "@/components/error-handling/ErrorHandler.composable";
-import { useSocketConnection, useBoardStore } from "@data-board";
-import { useBoardRestApi } from "./boardRestApi.composable";
+import { createTestingPinia } from "@pinia/testing";
+import { useSharedEditMode } from "@util-board";
+import { setActivePinia } from "pinia";
+import { computed, ref } from "vue";
 import { useBoardApi } from "../BoardApi.composable";
-import { useSharedEditMode } from "../EditMode.composable";
-import { ColumnMove } from "@/types/board/DragAndDrop";
+import { useBoardRestApi } from "./boardRestApi.composable";
 
 jest.mock("@/components/error-handling/ErrorHandler.composable");
 const mockedUseErrorHandler = jest.mocked(useErrorHandler);
 
 jest.mock("../BoardApi.composable");
 const mockedUseBoardApi = jest.mocked(useBoardApi);
 
-jest.mock("../EditMode.composable");
+jest.mock("@util-board/editMode.composable");
 const mockedSharedEditMode = jest.mocked(useSharedEditMode);
 
 jest.mock("../socket/socket");
@@ -57,6 +57,7 @@ describe("boardRestApi", () => {
 		mockedSharedEditMode.mockReturnValue({
 			setEditModeId,
 			editModeId: ref(undefined),
+			isInEditMode: computed(() => true),
 		});
 	});
 

diff --git a/src/modules/data/board/boardActions/boardSocketApi.composable.unit.ts b/src/modules/data/board/boardActions/boardSocketApi.composable.unit.ts
@@ -11,8 +11,8 @@ import {
 import setupStores from "@@/tests/test-utils/setupStores";
 import {
 	useBoardStore,
-	useSocketConnection,
 	useForceRender,
+	useSocketConnection,
 } from "@data-board";
 import { createMock, DeepMocked } from "@golevelup/ts-jest";
 import { createTestingPinia } from "@pinia/testing";
@@ -49,7 +49,8 @@ const mockedUseBoardRestApi = jest.mocked(useBoardRestApi);
 jest.mock("vue-i18n");
 (useI18n as jest.Mock).mockReturnValue({ t: (key: string) => key });
 
-jest.mock("@util-board");
+jest.mock("@util-board/BoardNotifier.composable");
+jest.mock("@util-board/LastCreatedElement.composable");
 const mockedUseBoardNotifier = jest.mocked(useBoardNotifier);
 const mockedSharedLastCreatedElement = jest.mocked(useSharedLastCreatedElement);