Merge pull request #202 from openscript-ch/33-develop-questionnaire-completion-tracking-within-series

33 develop questionnaire completion tracking within series

Author: openscript

.changeset/olive-hats-turn.md

@@ -0,0 +1,7 @@
+---
+"@quassel/frontend": patch
+"@quassel/backend": patch
+"@quassel/ui": patch
+---
+
+Improve questionnaire completion handling

apps/backend/db/migrations/.snapshot-postgres.json

@@ -283,7 +283,7 @@
           "unsigned": false,
           "autoincrement": false,
           "primary": false,
-          "nullable": true,
+          "nullable": false,
           "length": 6,
           "mappedType": "datetime"
         },
@@ -293,7 +293,7 @@
           "unsigned": false,
           "autoincrement": false,
           "primary": false,
-          "nullable": true,
+          "nullable": false,
           "length": 6,
           "mappedType": "datetime"
         },
@@ -303,7 +303,7 @@
           "unsigned": false,
           "autoincrement": false,
           "primary": false,
-          "nullable": true,
+          "nullable": false,
           "length": 255,
           "mappedType": "string"
         },
@@ -316,13 +316,23 @@
           "nullable": true,
           "mappedType": "text"
         },
+        "completed_at": {
+          "name": "completed_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "length": 6,
+          "mappedType": "datetime"
+        },
         "study_id": {
           "name": "study_id",
           "type": "int",
           "unsigned": false,
           "autoincrement": false,
           "primary": false,
-          "nullable": true,
+          "nullable": false,
           "mappedType": "integer"
         },
         "participant_id": {
@@ -331,7 +341,7 @@
           "unsigned": false,
           "autoincrement": false,
           "primary": false,
-          "nullable": true,
+          "nullable": false,
           "mappedType": "bigint"
         }
       },
@@ -361,7 +371,6 @@
             "id"
           ],
           "referencedTableName": "public.study",
-          "deleteRule": "set null",
           "updateRule": "cascade"
         },
         "questionnaire_participant_id_foreign": {
@@ -374,7 +383,6 @@
             "id"
           ],
           "referencedTableName": "public.participant",
-          "deleteRule": "set null",
           "updateRule": "cascade"
         }
       },

apps/backend/db/migrations/Migration20241217133331.ts

@@ -0,0 +1,50 @@
+import { Migration } from "@mikro-orm/migrations";
+
+export class Migration20241217133331 extends Migration {
+  override async up(): Promise<void> {
+    this.addSql(`alter table "questionnaire" drop constraint "questionnaire_study_id_foreign";`);
+    this.addSql(`alter table "questionnaire" drop constraint "questionnaire_participant_id_foreign";`);
+
+    this.addSql(`alter table "questionnaire" add column "completed_at" timestamptz null;`);
+    this.addSql(`alter table "questionnaire" alter column "started_at" type timestamptz using ("started_at"::timestamptz);`);
+    this.addSql(`alter table "questionnaire" alter column "started_at" set not null;`);
+    this.addSql(`alter table "questionnaire" alter column "ended_at" type timestamptz using ("ended_at"::timestamptz);`);
+    this.addSql(`alter table "questionnaire" alter column "ended_at" set not null;`);
+    this.addSql(`alter table "questionnaire" alter column "title" type varchar(255) using ("title"::varchar(255));`);
+    this.addSql(`alter table "questionnaire" alter column "title" set not null;`);
+    this.addSql(`alter table "questionnaire" alter column "study_id" type int using ("study_id"::int);`);
+    this.addSql(`alter table "questionnaire" alter column "study_id" set not null;`);
+    this.addSql(`alter table "questionnaire" alter column "participant_id" type bigint using ("participant_id"::bigint);`);
+    this.addSql(`alter table "questionnaire" alter column "participant_id" set not null;`);
+    this.addSql(
+      `alter table "questionnaire" add constraint "questionnaire_study_id_foreign" foreign key ("study_id") references "study" ("id") on update cascade;`
+    );
+    this.addSql(
+      `alter table "questionnaire" add constraint "questionnaire_participant_id_foreign" foreign key ("participant_id") references "participant" ("id") on update cascade;`
+    );
+  }
+
+  override async down(): Promise<void> {
+    this.addSql(`alter table "questionnaire" drop constraint "questionnaire_study_id_foreign";`);
+    this.addSql(`alter table "questionnaire" drop constraint "questionnaire_participant_id_foreign";`);
+
+    this.addSql(`alter table "questionnaire" drop column "completed_at";`);
+
+    this.addSql(`alter table "questionnaire" alter column "started_at" type timestamptz using ("started_at"::timestamptz);`);
+    this.addSql(`alter table "questionnaire" alter column "started_at" drop not null;`);
+    this.addSql(`alter table "questionnaire" alter column "ended_at" type timestamptz using ("ended_at"::timestamptz);`);
+    this.addSql(`alter table "questionnaire" alter column "ended_at" drop not null;`);
+    this.addSql(`alter table "questionnaire" alter column "title" type varchar(255) using ("title"::varchar(255));`);
+    this.addSql(`alter table "questionnaire" alter column "title" drop not null;`);
+    this.addSql(`alter table "questionnaire" alter column "study_id" type int using ("study_id"::int);`);
+    this.addSql(`alter table "questionnaire" alter column "study_id" drop not null;`);
+    this.addSql(`alter table "questionnaire" alter column "participant_id" type bigint using ("participant_id"::bigint);`);
+    this.addSql(`alter table "questionnaire" alter column "participant_id" drop not null;`);
+    this.addSql(
+      `alter table "questionnaire" add constraint "questionnaire_study_id_foreign" foreign key ("study_id") references "study" ("id") on update cascade on delete set null;`
+    );
+    this.addSql(
+      `alter table "questionnaire" add constraint "questionnaire_participant_id_foreign" foreign key ("participant_id") references "participant" ("id") on update cascade on delete set null;`
+    );
+  }
+}

apps/backend/src/research/questionnaires/questionnaire.dto.ts

@@ -1,6 +1,6 @@
 import { ApiProperty, OmitType, PartialType } from "@nestjs/swagger";
 import { Type } from "class-transformer";
-import { IsDateString, IsNotEmpty } from "class-validator";
+import { IsDateString, IsNotEmpty, IsOptional } from "class-validator";
 import { ParticipantDto } from "../participants/participant.dto";
 import { StudyDto } from "../studies/study.dto";
 import { QuestionnaireEntryDto } from "../entries/entry.dto";
@@ -11,24 +11,29 @@ export class QuestionnaireDto {
 
   @ApiProperty({ example: "2024-11-01T07:00:00.000Z", description: "The starting date of the questionnaire" })
   @IsDateString()
-  startedAt?: Date;
+  startedAt: Date;
 
   @ApiProperty({ example: "2024-11-01T08:00:00.00Z", description: "The ending date of the questionnaire" })
   @IsDateString()
-  endedAt?: Date;
+  endedAt: Date;
 
   @ApiProperty({ example: "First few months", description: "The title of the questionnaire" })
   @IsNotEmpty()
-  title?: string;
+  title: string;
 
   @ApiProperty({ example: "We went on holidays for 2 weeks and only spoke Esperanto", description: "The remark of the questionnaire" })
   remark?: string;
 
+  @ApiProperty({ example: "2024-11-01T07:00:00.000Z", description: "The date the questionnaire was completed" })
+  @IsOptional()
+  @IsDateString()
+  completedAt?: Date;
+
   @Type(() => StudyDto)
-  study?: StudyDto;
+  study: StudyDto;
 
   @Type(() => ParticipantDto)
-  participant?: ParticipantDto;
+  participant: ParticipantDto;
 
   @Type(() => Array<QuestionnaireEntryDto>)
   entries?: QuestionnaireEntryDto[];

apps/backend/src/research/questionnaires/questionnaire.entity.ts

@@ -7,22 +7,25 @@ import { Entry } from "../entries/entry.entity";
 @Entity()
 export class Questionnaire extends BaseEntity {
   @Property()
-  startedAt?: Date;
+  startedAt: Date;
 
   @Property()
-  endedAt?: Date;
+  endedAt: Date;
 
   @Property()
-  title?: string;
+  title: string;
 
   @Property({ columnType: "text" })
   remark?: string;
 
+  @Property()
+  completedAt?: Date;
+
   @ManyToOne()
-  study?: Study;
+  study: Study;
 
   @ManyToOne()
-  participant?: Participant;
+  participant: Participant;
 
   @OneToMany(() => Entry, (entry) => entry.questionnaire)
   entries = new Collection<Entry>(this);

apps/backend/src/research/questionnaires/questionnaires.service.ts

@@ -1,6 +1,6 @@
 import { EntityRepository, EntityManager, UniqueConstraintViolationException, FilterQuery } from "@mikro-orm/core";
 import { InjectRepository } from "@mikro-orm/nestjs";
-import { Injectable, UnprocessableEntityException } from "@nestjs/common";
+import { BadRequestException, Injectable, UnprocessableEntityException } from "@nestjs/common";
 import { QuestionnaireCreationDto, QuestionnaireMutationDto } from "./questionnaire.dto";
 import { Questionnaire } from "./questionnaire.entity";
 import { Entry } from "../entries/entry.entity";
@@ -20,6 +20,10 @@ export class QuestionnairesService {
     questionnaire.assign(questionnaireCreationDto, { em: this.em });
 
     const prevQuestionnaire = await this.findLatestByParticipant(questionnaire.participant!.id);
+
+    if (prevQuestionnaire && !prevQuestionnaire.completedAt)
+      throw new BadRequestException("Complete the previous questionniare before starting a new one.");
+
     this.validateStartDate(questionnaire, prevQuestionnaire);
 
     await prevQuestionnaire?.populate(["entries.entryLanguages"]);