Merge pull request #1201 from AletheiaFact/add-informative-news-claim…

…-review-type

Add new Informative News report type

cypress/support/locators.ts

@@ -37,7 +37,7 @@ const locators = {
     },
 
     claimReview: {
-        BTN_START_CLAIM_REVIEW: "[data-cy=testAddReviewButton]",
+        BTN_START_CLAIM_REVIEW: "[data-cy=testAddFactCheckReviewButton]",
         INPUT_USER: "[data-cy=testClaimReviewusersId]",
         BTN_ASSIGN_USER: "[data-cy=testClaimReviewASSIGN_USER]",
         INPUT_SUMMARY: "[data-cy=testClaimReviewsummary]",

lib/editor-parser.ts

@@ -1,30 +1,48 @@
 import { ObjectMark, RemirrorJSON } from "remirror";
 import { ReviewTaskMachineContextReviewData } from "../server/claim-review-task/dto/create-claim-review-task.dto";
+import { ReportModelEnum } from "../server/types/enums";
+
+type SchemaType = {
+    summary: string;
+    verification?: string;
+    report?: string;
+    sources: any[];
+    questions?: any[];
+};
 
-const EditorSchemaArray = ["summary", "report", "verification", "questions"];
+const getEditorSchemaArray = (reportModel = ReportModelEnum.FactChecking) =>
+    reportModel === ReportModelEnum.FactChecking
+        ? ["summary", "report", "verification", "questions"]
+        : ["summary"];
 
 const MarkupCleanerRegex = /{{[^|]+\|([^}]+)}}/;
 
-const defaultDoc: RemirrorJSON = {
-    type: "doc",
-    content: [
-        {
-            type: "summary",
-            content: [{ type: "paragraph" }],
-        },
-        {
-            type: "questions",
-            content: [{ type: "paragraph" }],
-        },
-        {
-            type: "report",
-            content: [{ type: "paragraph" }],
-        },
-        {
-            type: "verification",
-            content: [{ type: "paragraph" }],
-        },
-    ],
+const createParagraphBlock = (
+    type: string
+): { type: string; content: [{ type: "paragraph" }] } => ({
+    type: type,
+    content: [{ type: "paragraph" }],
+});
+
+const getDefaultDoc = (reportModel: string): RemirrorJSON => {
+    const baseContent = [
+        createParagraphBlock("summary"),
+        createParagraphBlock("questions"),
+        createParagraphBlock("report"),
+        createParagraphBlock("verification"),
+    ];
+
+    if (reportModel === ReportModelEnum.InformativeNews) {
+        return {
+            type: "doc",
+            content: [createParagraphBlock("summary")],
+        };
+    }
+
+    return {
+        type: "doc",
+        content: baseContent,
+    };
 };
 
 export class EditorParser {
@@ -109,7 +127,8 @@ export class EditorParser {
     }
 
     schema2html(
-        schema: ReviewTaskMachineContextReviewData
+        schema: ReviewTaskMachineContextReviewData,
+        reportModel = ReportModelEnum.FactChecking
     ): ReviewTaskMachineContextReviewData {
         const newSchema = {
             ...schema,
@@ -118,7 +137,7 @@ export class EditorParser {
         const hasSources = this.hasSources(newSchema?.sources);
 
         for (const key in newSchema) {
-            if (EditorSchemaArray.includes(key)) {
+            if (getEditorSchemaArray(reportModel).includes(key)) {
                 const content = newSchema[key];
                 if (!hasSources) {
                     newSchema[key] =
@@ -146,16 +165,13 @@ export class EditorParser {
     }
 
     editor2schema(data: RemirrorJSON): ReviewTaskMachineContextReviewData {
-        const schema = {
+        const schema: SchemaType = {
             summary: "",
-            verification: "",
-            report: "",
             sources: [],
-            questions: [],
         };
         const questions = [];
         for (const cardContent of data?.content) {
-            if (EditorSchemaArray?.includes(cardContent?.type)) {
+            if (getEditorSchemaArray().includes(cardContent?.type)) {
                 if (cardContent?.type === "questions") {
                     for (const { content } of cardContent.content) {
                         if (content) {
@@ -173,7 +189,13 @@ export class EditorParser {
             }
         }
 
-        schema.questions = questions;
+        /**
+         * Needed to do this conditional because the form validation when the reportModel
+         * is equal to Informative news requires the questions field.
+         */
+        if (schema.report || schema.verification) {
+            schema.questions = questions;
+        }
         schema.sources = this.replaceSourceContentToTextRange(schema);
 
         return schema;
@@ -260,18 +282,19 @@ export class EditorParser {
     }
 
     async schema2editor(
-        schema: ReviewTaskMachineContextReviewData
+        schema: ReviewTaskMachineContextReviewData,
+        reportModel = ReportModelEnum.FactChecking
     ): Promise<RemirrorJSON> {
         if (!schema) {
-            return defaultDoc;
+            return getDefaultDoc(reportModel);
         }
 
         const doc: RemirrorJSON = {
             type: "doc",
             content: [],
         };
         for (const key of Object.keys(schema).filter((key) =>
-            EditorSchemaArray.includes(key)
+            getEditorSchemaArray(reportModel).includes(key)
         )) {
             const content = schema[key];
             if (!this.hasSources(schema?.sources)) {

migrations/20240523215235-add-report-model-field-in-claim-review-schema.ts

@@ -0,0 +1,13 @@
+import { Db } from "mongodb";
+
+export async function up(db: Db) {
+    await db
+        .collection("claimreviews")
+        .updateMany({}, { $set: { reportModel: "Fact-checking" } });
+}
+
+export async function down(db: Db) {
+    await db
+        .collection("claimreviews")
+        .updateMany({}, { $unset: { reportModel: "" } });
+}

migrations/20240523215659-add-report-model-field-in-reports-schema.ts

@@ -0,0 +1,13 @@
+import { Db } from "mongodb";
+
+export async function up(db: Db) {
+    await db
+        .collection("reports")
+        .updateMany({}, { $set: { reportModel: "Fact-checking" } });
+}
+
+export async function down(db: Db) {
+    await db
+        .collection("reports")
+        .updateMany({}, { $unset: { reportModel: "" } });
+}

migrations/20240523215811-add-report-model-field-in-claimreviewtasks-schema.ts

@@ -0,0 +1,13 @@
+import { Db } from "mongodb";
+
+export async function up(db: Db) {
+    await db
+        .collection("claimreviewtasks")
+        .updateMany({}, { $set: { reportModel: "Fact-checking" } });
+}
+
+export async function down(db: Db) {
+    await db
+        .collection("claimreviewtasks")
+        .updateMany({}, { $unset: { reportModel: "" } });
+}

public/locales/en/claimReviewForm.json

@@ -2,7 +2,8 @@
     "titleEmpty": "Choose a sentence to review",
     "title": "Review the sentence",
     "classificationLabel": "Review this claim",
-    "addReviewButton": "Start Review",
+    "addReviewButton": "Start a fact-check",
+    "addInformativeNewsButton": "Start an informative news",
     "cancelButton": "Cancel",
     "classificationPlaceholder": "Choose a classification",
     "not-fact": "Not fact",
@@ -22,6 +23,7 @@
     "assignUserPlaceholder": "Select a user",
     "summaryLabel": "Conclusion summary",
     "summaryPlaceholder": "Insert summary here",
+    "informativeNewsLabel": "Material checado",
     "questionsLabel": "Which questions must be answered",
     "questionsPlaceholder": "Insert question here",
     "addQuestionLabel": "Add another question",

public/locales/pt/claimReviewForm.json

@@ -2,7 +2,8 @@
     "titleEmpty": "Escolha uma frase para revisar",
     "title": "Classifique a frase",
     "classificationLabel": "Revise essa frase",
-    "addReviewButton": "Comece uma Revisão",
+    "addReviewButton": "Comece uma checagem de fatos",
+    "addInformativeNewsButton": "Comece uma noticia informativa",
     "cancelButton": "Cancelar",
     "classificationPlaceholder": "Selecione uma classificação",
     "not-fact": "Não é fato",
@@ -22,6 +23,7 @@
     "assignUserPlaceholder": "Selecione um usuário",
     "summaryLabel": "Resumo da conclusão",
     "summaryPlaceholder": "Insira o resumo da conclusão",
+    "informativeNewsLabel": "Material checado",
     "questionsLabel": "Quais perguntas a verificação deverá responder?",
     "questionsPlaceholder": "Insira uma pergunta",
     "addQuestionLabel": "Incluir outra pergunta",

server/claim-review-task/claim-review-task.controller.ts

@@ -110,6 +110,7 @@ export class ClaimReviewController {
                         data_hash,
                         claimReviewTaskBody,
                         claimReviewTaskBody.nameSpace,
+                        claimReviewTaskBody.reportModel,
                         history
                     );
                 }
@@ -129,14 +130,18 @@ export class ClaimReviewController {
     @ApiTags("claim-review-task")
     @Get("api/claimreviewtask/editor-content/:data_hash")
     @Header("Cache-Control", "no-cache")
-    async getEditorContentByDataHash(@Param("data_hash") data_hash: string) {
+    async getEditorContentByDataHash(
+        @Param("data_hash") data_hash: string,
+        @Query() query: { reportModel: string }
+    ) {
         const claimReviewTask =
             await this.claimReviewTaskService.getClaimReviewTaskByDataHash(
                 data_hash
             );
 
         return this.claimReviewTaskService.getEditorContentObject(
-            claimReviewTask?.machine?.context?.reviewData
+            claimReviewTask?.machine?.context?.reviewData,
+            query.reportModel
         );
     }
 

server/claim-review-task/claim-review-task.service.ts

@@ -233,11 +233,12 @@ export class ClaimReviewTaskService {
         this.stateEventService.createStateEvent(stateEvent);
     }
 
-    async _createReportAndClaimReview(data_hash, machine) {
+    async _createReportAndClaimReview(data_hash, machine, reportModel) {
         const claimReviewData = machine.context.claimReview;
 
         const newReport = Object.assign(machine.context.reviewData, {
             data_hash,
+            reportModel,
         });
 
         const report = await this.reportService.create(newReport);
@@ -247,7 +248,8 @@ export class ClaimReviewTaskService {
                 ...claimReviewData,
                 report,
             },
-            data_hash
+            data_hash,
+            reportModel
         );
     }
 
@@ -322,7 +324,8 @@ export class ClaimReviewTaskService {
             return this.update(
                 claimReviewTaskBody.data_hash,
                 claimReviewTaskBody,
-                claimReviewTaskBody.nameSpace
+                claimReviewTaskBody.nameSpace,
+                claimReviewTask.reportModel
             );
         } else {
             const newClaimReviewTask = new this.ClaimReviewTaskModel(
@@ -339,6 +342,7 @@ export class ClaimReviewTaskService {
         data_hash: string,
         { machine }: UpdateClaimReviewTaskDTO,
         nameSpace: string,
+        reportModel: string,
         history: boolean = true
     ) {
         const loggedInUser = this.req.user;
@@ -370,7 +374,8 @@ export class ClaimReviewTaskService {
             }
             this._createReportAndClaimReview(
                 data_hash,
-                newClaimReviewTask.machine
+                newClaimReviewTask.machine,
+                reportModel
             );
         }
 
@@ -547,8 +552,8 @@ export class ClaimReviewTaskService {
         }
     }
 
-    getEditorContentObject(schema) {
-        return this.editorParseService.schema2editor(schema);
+    getEditorContentObject(schema, reportModel) {
+        return this.editorParseService.schema2editor(schema, reportModel);
     }
 
     async addComment(data_hash, comment) {

server/claim-review-task/dto/create-claim-review-task.dto.ts

@@ -1,10 +1,11 @@
-import { IsNotEmpty, IsObject, IsString } from "class-validator";
+import { IsEnum, IsNotEmpty, IsObject, IsString } from "class-validator";
 
 import { ClassificationEnum } from "../../claim-review/dto/create-claim-review.dto";
 import { Claim } from "../../claim/schemas/claim.schema";
 import { Personality } from "../../personality/schemas/personality.schema";
 import { User } from "../../users/schemas/user.schema";
 import { ApiProperty } from "@nestjs/swagger";
+import { ReportModelEnum } from "../../types/enums";
 
 export type ReviewTaskMachineContextReviewData = {
     usersId?: any[];
@@ -57,6 +58,12 @@ export class CreateClaimReviewTaskDTO {
     @ApiProperty()
     data_hash: string;
 
+    @IsNotEmpty()
+    @IsEnum(ReportModelEnum)
+    @IsString()
+    @ApiProperty()
+    reportModel: string;
+
     @IsNotEmpty()
     @IsString()
     @ApiProperty()

server/claim-review-task/schemas/claim-review-task.schema.ts

@@ -1,6 +1,7 @@
 import * as mongoose from "mongoose";
 import { Prop, Schema, SchemaFactory } from "@nestjs/mongoose";
 import type { Machine } from "../dto/create-claim-review-task.dto";
+import { ReportModelEnum } from "../../types/enums";
 
 export type ClaimReviewTaskDocument = ClaimReviewTask & mongoose.Document;
 
@@ -11,6 +12,17 @@ export class ClaimReviewTask {
 
     @Prop({ unique: true, required: true })
     data_hash: string;
+
+    @Prop({
+        required: true,
+        validate: {
+            validator: (v) => {
+                return Object.values(ReportModelEnum).includes(v);
+            },
+        },
+        message: (tag) => `${tag} is not a valid report type.`,
+    })
+    reportModel: ReportModelEnum;
 }
 
 export const ClaimReviewTaskSchema =