BC-5434 - meta data endpoint (#2876)

refactored implementation of the meta-data-extraction for link-elements with preview.

src/components/data-board/BoardApi.composable.ts

@@ -9,12 +9,12 @@ import {
 	ContentElementType,
 	CreateCardBodyParamsRequiredEmptyElementsEnum,
 	CreateContentElementBodyParams,
-	ExternalToolElementResponse,
-	FileElementContent,
-	LinkElementContent,
-	RichTextElementContent,
+	ExternalToolElementContentBody,
+	FileElementContentBody,
+	LinkElementContentBody,
+	RichTextElementContentBody,
 	RoomsApiFactory,
-	SubmissionContainerElementContent,
+	SubmissionContainerElementContentBody,
 } from "@/serverApi/v3";
 import { AnyContentElement } from "@/types/board/ContentElement";
 import { $axios, mapAxiosErrorToResponseError } from "@/utils/api";
@@ -73,51 +73,42 @@ export const useBoardApi = () => {
 	const generateDataProp = (element: AnyContentElement) => {
 		if (element.type === ContentElementType.RichText) {
 			return {
-				content: element.content as RichTextElementContent,
+				content: element.content,
 				type: element.type,
-			};
+			} as RichTextElementContentBody;
 		}
 
 		if (element.type === ContentElementType.File) {
 			return {
-				content: element.content as FileElementContent,
+				content: element.content,
 				type: ContentElementType.File,
-			};
+			} as FileElementContentBody;
 		}
 
 		if (element.type === ContentElementType.SubmissionContainer) {
 			return {
-				content: element.content as SubmissionContainerElementContent,
+				content: element.content,
 				type: ContentElementType.SubmissionContainer,
-			};
+			} as SubmissionContainerElementContentBody;
 		}
 
-		if (isExternalToolElement(element)) {
+		if (element.type === ContentElementType.Link) {
 			return {
-				content: {
-					contextExternalToolId:
-						element.content.contextExternalToolId ?? undefined,
-				},
-				type: ContentElementType.ExternalTool,
-			};
+				content: element.content,
+				type: ContentElementType.Link,
+			} as LinkElementContentBody;
 		}
 
-		if (element.type === ContentElementType.Link) {
+		if (element.type === ContentElementType.ExternalTool) {
 			return {
-				content: element.content as LinkElementContent,
-				type: ContentElementType.Link,
-			};
+				content: element.content,
+				type: ContentElementType.ExternalTool,
+			} as ExternalToolElementContentBody;
 		}
 
 		throw new Error("element.type mapping is undefined for updateElementCall");
 	};
 
-	const isExternalToolElement = (
-		element: AnyContentElement
-	): element is ExternalToolElementResponse => {
-		return element.type === ContentElementType.ExternalTool;
-	};
-
 	const createElementCall = async (
 		cardId: string,
 		params: CreateContentElementBodyParams

src/components/feature-board-file-element/shared/composables/FileStorageApi.composable.ts

@@ -3,6 +3,7 @@ import {
 	FileApiInterface,
 	FileRecordParentType,
 	FileRecordResponse,
+	FileUrlParams,
 	RenameFileParams,
 } from "@/fileStorageApi/v3";
 import { authModule } from "@/store/store-accessor";
@@ -65,6 +66,30 @@ export const useFileStorageApi = (
 		}
 	};
 
+	const uploadFromUrl = async (imageUrl: string): Promise<void> => {
+		try {
+			const { pathname } = new URL(imageUrl);
+			const fileName = pathname.substring(pathname.lastIndexOf("/") + 1);
+			const schoolId = authModule.getUser?.schoolId as string;
+			const fileUrlParams: FileUrlParams = {
+				url: imageUrl,
+				fileName,
+				headers: `User-Agent: Embed Request User Agent`,
+			};
+			const response = await fileApi.uploadFromUrl(
+				schoolId,
+				parentId,
+				parentType,
+				fileUrlParams
+			);
+
+			fileRecord.value = response.data;
+		} catch (error) {
+			showError(error);
+			throw error;
+		}
+	};
+
 	const rename = async (
 		fileRecordId: FileRecordResponse["id"],
 		params: RenameFileParams
@@ -110,6 +135,7 @@ export const useFileStorageApi = (
 		fetchFile,
 		rename,
 		upload,
+		uploadFromUrl,
 		fileRecord,
 	};
 };

src/components/feature-board-file-element/shared/composables/FileStorageApi.composable.unit.ts

@@ -246,6 +246,104 @@ describe("FileStorageApi Composable", () => {
 		});
 	});
 
+	describe("uploadFromUrl", () => {
+		describe("when file api uploads file successfully", () => {
+			const setup = () => {
+				const fileName = "example-picture.jpg";
+				const imageUrl = `https://www.example.com/${fileName}`;
+				const parentId = ObjectIdMock();
+				const parentType = FileRecordParentType.BOARDNODES;
+				const fileRecordResponse = fileRecordResponseFactory.build({
+					parentId,
+					parentType,
+					name: fileName,
+				});
+				const response = {
+					data: fileRecordResponse,
+				};
+
+				const uploadFromUrlMock = jest.fn().mockResolvedValueOnce(response);
+				const { fileApiFactory } = setupFileStorageFactoryMock({
+					uploadFromUrlMock,
+				});
+				setupFileStorageNotifier();
+
+				return {
+					parentId,
+					parentType,
+					fileApiFactory,
+					fileRecordResponse,
+					fileName,
+					imageUrl,
+				};
+			};
+
+			it("should call FileApiFactory.uploadFromUrl", async () => {
+				const { parentId, parentType, fileApiFactory, fileName, imageUrl } =
+					setup();
+				const { uploadFromUrl } = useFileStorageApi(parentId, parentType);
+
+				await uploadFromUrl(imageUrl);
+
+				expect(fileApiFactory.uploadFromUrl).toBeCalledWith(
+					"schoolId",
+					parentId,
+					parentType,
+					expect.objectContaining({
+						url: imageUrl,
+						fileName,
+					})
+				);
+			});
+
+			it("should set filerecord", async () => {
+				const { parentId, parentType, imageUrl, fileRecordResponse } = setup();
+				const { uploadFromUrl, fileRecord } = useFileStorageApi(
+					parentId,
+					parentType
+				);
+
+				await uploadFromUrl(imageUrl);
+
+				expect(fileRecord.value).toBe(fileRecordResponse);
+			});
+		});
+
+		describe("when file api returns error", () => {
+			const setup = () => {
+				const parentId = ObjectIdMock();
+				const parentType = FileRecordParentType.BOARDNODES;
+				const file = new File([""], "filename");
+
+				const { responseError, expectedPayload } = setupErrorResponse(
+					ErrorType.FILE_TOO_BIG
+				);
+
+				mockedMapAxiosErrorToResponseError.mockReturnValue(expectedPayload);
+
+				const uploadFromUrlMock = jest.fn().mockRejectedValue(responseError);
+				setupFileStorageFactoryMock({ uploadFromUrlMock });
+				setupFileStorageNotifier();
+
+				return {
+					parentId,
+					parentType,
+					file,
+					responseError,
+				};
+			};
+
+			it("should call showFileTooBigError and pass error", async () => {
+				const { parentId, parentType, responseError } = setup();
+				const { uploadFromUrl } = useFileStorageApi(parentId, parentType);
+
+				await expect(uploadFromUrl("abc:/not-an-url")).rejects.toBe(
+					responseError
+				);
+			});
+		});
+	});
+
 	describe("rename", () => {
 		describe("when file api rename file successfully", () => {
 			const setup = () => {