Merge pull request #204 from istex/fix/166-image-caption

Fix(latex): Display formula if latex fails to be parsed

Author: ClementDreptin

packages/react-tei/src/SidePanel/authors/PersNamePart.spec.tsx

@@ -1,4 +1,4 @@
-import { describe, expect, it, vi } from "vitest";
+import { describe, expect, it } from "vitest";
 import { render } from "vitest-browser-react";
 import type { DocumentJson } from "../../parser/document";
 import { TagCatalogProvider } from "../../tags/TagCatalogProvider";
@@ -14,7 +14,6 @@ describe("PersNamePart", () => {
 					value: [],
 				},
 				"forename",
-				null,
 			],
 			[
 				{
@@ -23,7 +22,6 @@ describe("PersNamePart", () => {
 					value: [],
 				},
 				"honorific",
-				null,
 			],
 			[
 				{
@@ -32,7 +30,6 @@ describe("PersNamePart", () => {
 					value: [],
 				},
 				"degree",
-				null,
 			],
 			[
 				{
@@ -41,7 +38,6 @@ describe("PersNamePart", () => {
 					value: [],
 				},
 				null,
-				"PersNamePart roleName missing or invalid @type:",
 			],
 			[
 				{
@@ -50,73 +46,55 @@ describe("PersNamePart", () => {
 					value: [],
 				},
 				null,
-				"PersNamePart roleName missing or invalid @type:",
 			],
 			[
 				{
 					tag: "surname",
 					value: [],
 				},
 				"surname",
-				null,
 			],
 			[
 				{
 					tag: "genName",
 					value: [],
 				},
 				"genName",
-				null,
 			],
 			[
 				{
 					tag: "nameLink",
 					value: [],
 				},
 				"nameLink",
-				null,
 			],
 			[
 				{
 					tag: "addName",
 					value: [],
 				},
 				"addName",
-				null,
 			],
 			[
 				{
 					tag: "orgName",
 					value: [],
 				},
 				"orgName",
-				null,
 			],
 			[
 				{
 					tag: "unknownTag",
 					value: [],
 				},
 				null,
-				"PersNamePart unknown tag:",
 			],
 		])("should return description type", (input: DocumentJson, expected:
 			| string
-			| null, warning: string | null) => {
-			const consoleWarnSpy = vi
-				.spyOn(console, "warn")
-				.mockImplementation(() => {});
+			| null) => {
 			const descriptionKey = getDescriptionKey(input);
 
 			expect(descriptionKey).toBe(expected);
-
-			if (warning) {
-				expect(consoleWarnSpy).toHaveBeenCalledWith(warning, input);
-			} else {
-				expect(consoleWarnSpy).not.toHaveBeenCalled();
-			}
-
-			consoleWarnSpy.mockRestore();
 		});
 	});
 
@@ -146,9 +124,6 @@ describe("PersNamePart", () => {
 	});
 
 	it("should render PersNamePart value without aria-description for unknown description type", async () => {
-		const consoleWarnSpy = vi
-			.spyOn(console, "warn")
-			.mockImplementation(() => {});
 		const { getByText } = await render(
 			<PersNamePart
 				data={{
@@ -169,24 +144,9 @@ describe("PersNamePart", () => {
 		const spanElement = getByText("Unknown Role");
 		expect(spanElement).toBeInTheDocument();
 		expect(spanElement).not.toHaveAttribute("aria-description");
-
-		expect(consoleWarnSpy).toHaveBeenCalledWith(
-			"PersNamePart roleName missing or invalid @type:",
-			{
-				tag: "roleName",
-				attributes: { "@type": "unknown" },
-				value: [{ tag: "#text", value: "Unknown Role" }],
-			},
-		);
-
-		consoleWarnSpy.mockRestore();
 	});
 
-	it("should render nothing and  log a warning if data.value is not an array", async () => {
-		const consoleWarnSpy = vi
-			.spyOn(console, "warn")
-			.mockImplementation(() => {});
-
+	it("should render nothing if data.value is not an array", async () => {
 		const { container } = await render(
 			<PersNamePart
 				data={{
@@ -204,20 +164,9 @@ describe("PersNamePart", () => {
 		);
 
 		expect(container).toBeEmptyDOMElement();
-
-		expect(consoleWarnSpy).toHaveBeenCalledWith(
-			"PersName data.value is not an array:",
-			"Not an array",
-		);
-
-		consoleWarnSpy.mockRestore();
 	});
 
-	it("should render nothing and log a warning if data.value is an empty array", async () => {
-		const consoleWarnSpy = vi
-			.spyOn(console, "warn")
-			.mockImplementation(() => {});
-
+	it("should render nothing if data.value is an empty array", async () => {
 		const { container } = await render(
 			<PersNamePart
 				data={{
@@ -235,15 +184,5 @@ describe("PersNamePart", () => {
 		);
 
 		expect(container).toBeEmptyDOMElement();
-
-		expect(consoleWarnSpy).toHaveBeenCalledWith(
-			"PersNamePart data.value is empty:",
-			{
-				tag: "forename",
-				value: [],
-			},
-		);
-
-		consoleWarnSpy.mockRestore();
 	});
 });

packages/react-tei/src/SidePanel/authors/PersNamePart.tsx

@@ -1,5 +1,6 @@
 import { useMemo } from "react";
 import { useTranslation } from "react-i18next";
+import { IS_DEBUG } from "../../debug/debug.const";
 import type { DocumentJson } from "../../parser/document";
 import { Value } from "../../tags/Value";
 
@@ -11,7 +12,8 @@ export const getDescriptionKey = (data: DocumentJson) => {
 			!attributes?.["@type"] ||
 			!["honorific", "degree"].includes(attributes["@type"])
 		) {
-			console.warn("PersNamePart roleName missing or invalid @type:", data);
+			IS_DEBUG &&
+				console.warn("PersNamePart roleName missing or invalid @type:", data);
 			return null;
 		}
 		return attributes["@type"];
@@ -31,7 +33,7 @@ export const getDescriptionKey = (data: DocumentJson) => {
 		return tag;
 	}
 
-	console.warn("PersNamePart unknown tag:", data);
+	IS_DEBUG && console.warn("PersNamePart unknown tag:", data);
 	return null;
 };
 
@@ -42,12 +44,13 @@ export type PersNamePartProps = {
 export function PersNamePart({ data }: PersNamePartProps) {
 	const { t } = useTranslation();
 	if (!Array.isArray(data.value)) {
-		console.warn("PersName data.value is not an array:", data.value);
+		IS_DEBUG &&
+			console.warn("PersName data.value is not an array:", data.value);
 		return null;
 	}
 
 	if (data.value.length === 0) {
-		console.warn("PersNamePart data.value is empty:", data);
+		IS_DEBUG && console.warn("PersNamePart data.value is empty:", data);
 		return null;
 	}
 

packages/react-tei/src/SidePanel/authors/useAuthors.spec.tsx

@@ -1,4 +1,4 @@
-import { describe, expect, it, vi } from "vitest";
+import { describe, expect, it } from "vitest";
 import { renderHook } from "vitest-browser-react";
 import { DocumentContextProvider } from "../../DocumentContextProvider";
 import type { DocumentJson } from "../../parser/document";
@@ -128,11 +128,7 @@ describe("useAuthors", () => {
 		expect(result.result.current).toEqual([]);
 	});
 
-	it("should log a warning if an author tag has no value or value is not an array and remove it form result", async () => {
-		const consoleWarnSpy = vi
-			.spyOn(console, "warn")
-			.mockImplementation(() => {});
-
+	it("should remove author tags with no value or value is not an array from the result", async () => {
 		const invalidJsonDocument = [
 			{
 				tag: "TEI",
@@ -194,27 +190,6 @@ describe("useAuthors", () => {
 				value: [{ tag: "persName", value: "Valid Author" }],
 			},
 		]);
-		expect(consoleWarnSpy).toHaveBeenCalledTimes(2);
-		expect(consoleWarnSpy).toHaveBeenCalledWith(
-			"Author tag has no value or value is not an array",
-			{
-				author: {
-					tag: "author",
-					value: null,
-				},
-			},
-		);
-		expect(consoleWarnSpy).toHaveBeenCalledWith(
-			"Author tag has no value or value is not an array",
-			{
-				author: {
-					tag: "author",
-					value: "Just a string value",
-				},
-			},
-		);
-
-		consoleWarnSpy.mockRestore();
 	});
 
 	it("should only return 10 authors at most", async () => {

packages/react-tei/src/SidePanel/authors/useAuthors.tsx

@@ -1,5 +1,6 @@
 import { useMemo } from "react";
 import { useDocumentContext } from "../../DocumentContextProvider";
+import { IS_DEBUG } from "../../debug/debug.const";
 import type { DocumentJson } from "../../parser/document";
 import { getDocumentJsonAtPath } from "../../parser/getDocumentJsonAtPath";
 
@@ -21,9 +22,10 @@ export const useAuthors = (): DocumentJson[] => {
 		return authors
 			.filter((author) => {
 				if (!author.value || !Array.isArray(author.value)) {
-					console.warn("Author tag has no value or value is not an array", {
-						author,
-					});
+					IS_DEBUG &&
+						console.warn("Author tag has no value or value is not an array", {
+							author,
+						});
 					return false;
 				}
 				return true;