, , and elements
- *
+ *
* Validates:
* - Correct HTML structure generation (div containers, paragraphs)
* - Source reference conversion to citation links
@@ -244,19 +244,19 @@ describe("EditorParseService", () => {
/**
* Test: Source Position Accuracy - Citation Placement Validation
- *
+ *
* Purpose: Validates accurate positioning of source citations in HTML output
* Business Logic:
* - Ensures source citations appear at correct text positions
* - Maintains source reference integrity during HTML conversion
* - Preserves citation context and readability
* - Validates superscript numbering and link formatting
- *
+ *
* Test Data:
* - Report text: "duplicated word {{uniqueId|duplicated}}"
* - Expected HTML: "duplicated word duplicated1"
* - Source citation with proper attributes and superscript
- *
+ *
* Validates:
* - Exact text position of source citations
* - Correct HTML link generation with href and rel attributes
@@ -272,19 +272,19 @@ describe("EditorParseService", () => {
/**
* Test: Bidirectional Source Processing - Editor Link Mark Accuracy
- *
+ *
* Purpose: Validates accurate source processing in editor-to-schema conversion
* Business Logic:
* - Converts Remirror link marks back to schema markup format
* - Maintains source reference position and metadata accuracy
* - Ensures bidirectional conversion consistency
* - Preserves source attribution and text relationships
- *
+ *
* Test Data:
* - Remirror editor content with link marks containing source metadata
* - Link marks with id, href, target attributes on specific text ranges
* - Expected schema markup: "duplicated word {{uniqueId|duplicated}}"
- *
+ *
* Validates:
* - Accurate conversion from link marks to schema markup
* - Source position preservation in text content
@@ -340,12 +340,14 @@ describe("EditorParseService", () => {
};
const expectedSchemaWithLineBreaks = {
- summary: "First paragraph with important information.\nSecond paragraph after line break.\nThird paragraph with conclusion.",
+ summary:
+ "First paragraph with important information.\nSecond paragraph after line break.\nThird paragraph with conclusion.",
sources: [],
};
const expectedHtmlWithLineBreaks = {
- summary: " First paragraph with important information. Second paragraph after line break. Third paragraph with conclusion. First paragraph with important information. Second paragraph after line break. Third paragraph with conclusion. elements in HTML output for semantic HTML", async () => {
const schemaWithLineBreaks = {
- summary: "First paragraph with important information.\nSecond paragraph after line break.\nThird paragraph with conclusion.",
+ summary:
+ "First paragraph with important information.\nSecond paragraph after line break.\nThird paragraph with conclusion.",
sources: [],
};
@@ -367,14 +372,17 @@ describe("EditorParseService", () => {
schemaWithLineBreaks
);
- expect(htmlResult.summary).toEqual(expectedHtmlWithLineBreaks.summary);
- expect(htmlResult.summary.includes(' ')).toBe(true);
- expect(htmlResult.summary.split(' ').length - 1).toBe(3); // Should have 3 paragraphs
+ expect(htmlResult.summary).toEqual(
+ expectedHtmlWithLineBreaks.summary
+ );
+ expect(htmlResult.summary.includes(" ")).toBe(true);
+ expect(htmlResult.summary.split(" ").length - 1).toBe(3); // Should have 3 paragraphs
});
it("Should convert schema with line breaks back to multiple paragraphs in editor", async () => {
const schemaWithLineBreaks = {
- summary: "First paragraph with important information.\nSecond paragraph after line break.\nThird paragraph with conclusion.",
+ summary:
+ "First paragraph with important information.\nSecond paragraph after line break.\nThird paragraph with conclusion.",
sources: [],
};
@@ -385,16 +393,23 @@ describe("EditorParseService", () => {
expect(editorResult.content).toHaveLength(1);
expect(editorResult.content[0].type).toBe("summary");
expect(editorResult.content[0].content).toHaveLength(3); // Should have 3 paragraphs
-
+
// Verify each paragraph content
- expect(editorResult.content[0].content[0].content[0].text).toBe("First paragraph with important information.");
- expect(editorResult.content[0].content[1].content[0].text).toBe("Second paragraph after line break.");
- expect(editorResult.content[0].content[2].content[0].text).toBe("Third paragraph with conclusion.");
+ expect(editorResult.content[0].content[0].content[0].text).toBe(
+ "First paragraph with important information."
+ );
+ expect(editorResult.content[0].content[1].content[0].text).toBe(
+ "Second paragraph after line break."
+ );
+ expect(editorResult.content[0].content[2].content[0].text).toBe(
+ "Third paragraph with conclusion."
+ );
});
it("Should handle empty paragraphs (multiple consecutive line breaks)", async () => {
const schemaWithEmptyLines = {
- summary: "First paragraph.\n\nThird paragraph after empty line.",
+ summary:
+ "First paragraph.\n\nThird paragraph after empty line.",
sources: [],
};
@@ -403,9 +418,13 @@ describe("EditorParseService", () => {
);
expect(editorResult.content[0].content).toHaveLength(3);
- expect(editorResult.content[0].content[0].content[0].text).toBe("First paragraph.");
+ expect(editorResult.content[0].content[0].content[0].text).toBe(
+ "First paragraph."
+ );
expect(editorResult.content[0].content[1].content).toHaveLength(0); // Empty paragraph
- expect(editorResult.content[0].content[2].content[0].text).toBe("Third paragraph after empty line.");
+ expect(editorResult.content[0].content[2].content[0].text).toBe(
+ "Third paragraph after empty line."
+ );
});
it("Should maintain backward compatibility with single paragraph content", async () => {
@@ -417,9 +436,11 @@ describe("EditorParseService", () => {
const editorResult = await editorParseService.schema2editor(
singleParagraphSchema
);
-
+
expect(editorResult.content[0].content).toHaveLength(1);
- expect(editorResult.content[0].content[0].content[0].text).toBe("Single paragraph without line breaks.");
+ expect(editorResult.content[0].content[0].content[0].text).toBe(
+ "Single paragraph without line breaks."
+ );
});
it("Should preserve line breaks with sources (marked content)", async () => {
@@ -471,8 +492,10 @@ describe("EditorParseService", () => {
multiParagraphWithSource
);
- expect(schemaResult.report).toContain('\n');
- expect(schemaResult.report).toEqual("First paragraph with {{sourceId|source}}\nSecond paragraph continues here.");
+ expect(schemaResult.report).toContain("\n");
+ expect(schemaResult.report).toEqual(
+ "First paragraph with {{sourceId|source}}\nSecond paragraph continues here."
+ );
});
});
@@ -550,11 +573,13 @@ describe("EditorParseService", () => {
);
// Verify content structure
- expect(schemaResult.report).toEqual("First paragraph with {{source1|first source}} and more text.\nSecond paragraph has {{source2|second source}} here.");
-
+ expect(schemaResult.report).toEqual(
+ "First paragraph with {{source1|first source}} and more text.\nSecond paragraph has {{source2|second source}} here."
+ );
+
// Verify both sources are captured
expect(schemaResult.sources).toHaveLength(2);
-
+
// Verify first source
expect(schemaResult.sources[0]).toMatchObject({
href: "https://source1.com",
@@ -562,9 +587,9 @@ describe("EditorParseService", () => {
field: "report",
targetText: "first source",
id: "source1",
- })
+ }),
});
-
+
// Verify second source
expect(schemaResult.sources[1]).toMatchObject({
href: "https://source2.com",
@@ -572,7 +597,7 @@ describe("EditorParseService", () => {
field: "report",
targetText: "second source",
id: "source2",
- })
+ }),
});
});
@@ -586,8 +611,10 @@ describe("EditorParseService", () => {
schemaWithLineBreaks
);
- expect(htmlResult.report).toContain(' ');
- expect(htmlResult.report).toBe(' First paragraph with some text. Second paragraph with more text. ");
+ expect(htmlResult.report).toBe(
+ " First paragraph with some text. Second paragraph with more text. First paragraph with content. First paragraph with content. ) → schema2editor → removeTrailingParagraph → frontend
+ */
+
+ it("Should produce clean editor content from schema round-trip", async () => {
+ const schema: ReviewTaskMachineContextReviewData = {
+ sources: [],
+ questions: ["What is the claim?"],
+ summary: "Summary of the report",
+ report: "Report content here",
+ verification: "Verification details",
+ };
+
+ const editorResult = await editorParseService.schema2editor(schema);
+ const cleaned =
+ editorParseService.removeTrailingParagraph(editorResult);
+
+ cleaned.content.forEach((node) => {
+ expect([
+ "questions",
+ "summary",
+ "report",
+ "verification",
+ ]).toContain(node.type);
+ });
+ });
+
+ it("Should preserve content integrity after trailing paragraph removal", async () => {
+ const schema: ReviewTaskMachineContextReviewData = {
+ sources: [],
+ questions: ["Question A", "Question B"],
+ summary: "A summary",
+ report: "Report content here",
+ verification: "Verified",
+ };
+
+ const editorResult = await editorParseService.schema2editor(schema);
+ const cleaned =
+ editorParseService.removeTrailingParagraph(editorResult);
+ const roundTripSchema = await editorParseService.editor2schema(
+ cleaned
+ );
+
+ expect(roundTripSchema.questions).toEqual(schema.questions);
+ expect(roundTripSchema.summary).toEqual(schema.summary);
+ expect(roundTripSchema.verification).toEqual(schema.verification);
+ expect(roundTripSchema.report).toEqual(schema.report);
});
});
});
diff --git a/server/review-task/review-task.service.ts b/server/review-task/review-task.service.ts
index b6825d3d4..da3cc699f 100644
--- a/server/review-task/review-task.service.ts
+++ b/server/review-task/review-task.service.ts
@@ -757,12 +757,13 @@ export class ReviewTaskService {
}
}
- getEditorContentObject(schema, reportModel, reviewTaskType) {
- return this.editorParseService.schema2editor(
+ async getEditorContentObject(schema, reportModel, reviewTaskType) {
+ const editorContent = await this.editorParseService.schema2editor(
schema,
reportModel,
reviewTaskType
);
+ return this.editorParseService.removeTrailingParagraph(editorContent);
}
async addComment(data_hash, comment) {
diff --git a/src/components/Collaborative/VisualEditorProvider.tsx b/src/components/Collaborative/VisualEditorProvider.tsx
index 70fdea2c1..c9b3d383e 100644
--- a/src/components/Collaborative/VisualEditorProvider.tsx
+++ b/src/components/Collaborative/VisualEditorProvider.tsx
@@ -13,7 +13,6 @@ import { RemirrorContentType } from "remirror";
import { SourceType } from "../../types/Source";
import { ReviewTaskMachineContext } from "../../machines/reviewTask/ReviewTaskMachineProvider";
import { EditorConfig } from "./utils/getEditorConfig";
-import { removeTrailingParagraph } from "./utils/removeTrailingParagraph";
import {
crossCheckingSelector,
addCommentCrossCheckingSelector,
@@ -89,7 +88,7 @@ export const VisualEditorProvider = (props: VisualEditorProviderProps) => {
if (reportModel) {
fetchEditorContentObject(props.data_hash).then((content) => {
- setEditorContentObject(removeTrailingParagraph(content));
+ setEditorContentObject(content);
setIsFetchingEditor(false);
});
}
diff --git a/src/components/Collaborative/utils/removeTrailingParagraph.ts b/src/components/Collaborative/utils/removeTrailingParagraph.ts
deleted file mode 100644
index c3190a0e6..000000000
--- a/src/components/Collaborative/utils/removeTrailingParagraph.ts
+++ /dev/null
@@ -1,21 +0,0 @@
-import { RemirrorJSON } from "remirror";
-
-/**
- * Removes the last paragraph from a Remirror document if it is of type "paragraph"
- * @param doc - Remirror document in JSON format
- * @returns Document without the last paragraph, if it exists
- */
-export function removeTrailingParagraph(
- doc: RemirrorJSON | null | undefined
-): RemirrorJSON | null | undefined {
- if (!doc || !Array.isArray(doc.content)) return doc;
-
- const items = [...doc.content];
- const last = items[items.length - 1];
-
- if (last?.type === "paragraph") {
- items.pop();
- }
-
- return { ...doc, content: items };
-}
diff --git a/src/machines/reviewTask/actions.ts b/src/machines/reviewTask/actions.ts
index 4056f0a5a..0a51e6c59 100644
--- a/src/machines/reviewTask/actions.ts
+++ b/src/machines/reviewTask/actions.ts
@@ -18,9 +18,13 @@ const saveContext = assign
tags for content with empty lines (visual spacing)", async () => {
@@ -600,13 +627,16 @@ describe("EditorParseService", () => {
schemaWithEmptyLines
);
- expect(htmlResult.report).toContain('
');
- expect(htmlResult.report).toBe('
Third paragraph after empty line.
");
+ expect(htmlResult.report).toBe(
+ "
Third paragraph after empty line.