Add POST checkin form endpoint

CHANGELOG.md

@@ -25,6 +25,7 @@ Another example [here](https://co-pilot.dev/changelog)
 - Add new endpoint to revoke refresh token ([#116](https://github.com/chingu-x/chingu-dashboard-be/pull/116))
 - Add meetingId to sprints/teams endpoint (([#119](https://github.com/chingu-x/chingu-dashboard-be/pull/119)))
 - Add new endpoint to select tech stack items ([#125](https://github.com/chingu-x/chingu-dashboard-be/pull/125))
+- Add check in form response table, seed data, POST endpoint for submitting check in form ([#126](https://github.com/chingu-x/chingu-dashboard-be/pull/126))
 - Add multiple device support ([#128](https://github.com/chingu-x/chingu-dashboard-be/pull/128))
 
 ### Changed

README.md

@@ -176,6 +176,11 @@ $ yarn docker:down
 $ yarn docker:clean
 ```
 
+## Custom Pipes
+### FormInputValidationPipe
+For use with form responses, this pipe validates that the responses or response (array) values include a questionId and at least one input value of any type. 
+
+Example: `@Body(new FormInputValidationPipe())`
 
 ## Custom Decorators 
 

package.json

@@ -48,7 +48,7 @@
     "@nestjs/platform-express": "^10.0.0",
     "@nestjs/schedule": "^4.0.0",
     "@nestjs/swagger": "^7.1.11",
-    "@prisma/client": "^5.3.1",
+    "@prisma/client": "^5.10.2",
     "bcrypt": "^5.1.1",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",

prisma/migrations/20240401064842_add_checkin_form_tables_and_fields/migration.sql

@@ -0,0 +1,31 @@
+-- DropIndex
+DROP INDEX "Response_questionId_responseGroupId_key";
+
+-- CreateTable
+CREATE TABLE "FormResponseCheckin" (
+    "id" SERIAL NOT NULL,
+    "voyageTeamMemberId" INTEGER NOT NULL,
+    "sprintId" INTEGER NOT NULL,
+    "adminComments" TEXT,
+    "feedbackSent" BOOLEAN NOT NULL DEFAULT false,
+    "responseGroupId" INTEGER NOT NULL,
+    "createdAt" TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "FormResponseCheckin_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "FormResponseCheckin_responseGroupId_key" ON "FormResponseCheckin"("responseGroupId");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "FormResponseCheckin_voyageTeamMemberId_sprintId_key" ON "FormResponseCheckin"("voyageTeamMemberId", "sprintId");
+
+-- AddForeignKey
+ALTER TABLE "FormResponseCheckin" ADD CONSTRAINT "FormResponseCheckin_voyageTeamMemberId_fkey" FOREIGN KEY ("voyageTeamMemberId") REFERENCES "VoyageTeamMember"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "FormResponseCheckin" ADD CONSTRAINT "FormResponseCheckin_sprintId_fkey" FOREIGN KEY ("sprintId") REFERENCES "Sprint"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "FormResponseCheckin" ADD CONSTRAINT "FormResponseCheckin_responseGroupId_fkey" FOREIGN KEY ("responseGroupId") REFERENCES "ResponseGroup"("id") ON DELETE RESTRICT ON UPDATE CASCADE;

prisma/schema.prisma

@@ -139,6 +139,7 @@ model Sprint {
   updatedAt DateTime @updatedAt
 
   teamMeetings TeamMeeting[]
+  checkinForms FormResponseCheckin[]
 
   @@unique(fields: [voyageId, number], name: "voyageSprintNumber")
 }
@@ -221,6 +222,7 @@ model VoyageTeamMember {
   projectIdeaVotes       ProjectIdeaVote[]
   teamResources          TeamResource[]
   projectFeatures        ProjectFeature[]
+  checkinForms           FormResponseCheckin[]
 
   @@unique(fields: [userId, voyageTeamId], name: "userVoyageId")
 }
@@ -532,8 +534,6 @@ model Response {
 
   createdAt DateTime @default(now()) @db.Timestamptz()
   updatedAt DateTime @updatedAt
-
-  @@unique(fields: [questionId, responseGroupId], name: "questionResponseGroup")
 }
 
 model ResponseGroup {
@@ -546,20 +546,37 @@ model ResponseGroup {
   soloProject         SoloProject?
   voyageApplication   VoyageApplication?
   formResponseMeeting FormResponseMeeting?
+  formResponseCheckin FormResponseCheckin?
 }
 
 model FormResponseMeeting {
-  id        Int         @id @default(autoincrement())
-  formId    Int
-  form      Form        @relation(fields: [formId], references: [id])
-  meetingId Int
-  meeting   TeamMeeting @relation(fields: [meetingId], references: [id], onDelete: Cascade)
+  id              Int            @id @default(autoincrement())
+  formId          Int
+  form            Form           @relation(fields: [formId], references: [id])
+  meetingId       Int
+  meeting         TeamMeeting    @relation(fields: [meetingId], references: [id], onDelete: Cascade)
+  responseGroupId Int?           @unique
+  responseGroup   ResponseGroup? @relation(fields: [responseGroupId], references: [id], onDelete: Restrict)
 
   createdAt DateTime @default(now()) @db.Timestamptz()
   updatedAt DateTime @updatedAt
 
-  responseGroupId Int?           @unique
-  responseGroup   ResponseGroup? @relation(fields: [responseGroupId], references: [id], onDelete: Restrict)
-
   @@unique(fields: [formId, meetingId], name: "meetingFormId")
 }
+
+model FormResponseCheckin {
+  id                 Int              @id @default(autoincrement())
+  voyageTeamMemberId Int
+  voyageTeamMember   VoyageTeamMember @relation(fields: [voyageTeamMemberId], references: [id], onDelete: Cascade)
+  sprintId           Int
+  sprint             Sprint           @relation(fields: [sprintId], references: [id], onDelete: Cascade)
+  adminComments      String?
+  feedbackSent       Boolean          @default(false)
+  responseGroupId    Int              @unique
+  responseGroup      ResponseGroup    @relation(fields: [responseGroupId], references: [id], onDelete: Restrict)
+
+  createdAt DateTime @default(now()) @db.Timestamptz()
+  updatedAt DateTime @updatedAt
+
+  @@unique(fields: [voyageTeamMemberId, sprintId], name: "voyageTeamMemberSprintId")
+}

prisma/seed/checkinform-responses.ts

@@ -0,0 +1,234 @@
+import { formSelect } from "../../src/forms/forms.service";
+import { prisma } from "./prisma-client";
+
+// TODO: move these to a  helper function file
+const getRandomOptionId = async (
+    optionGroupId: number,
+    numberOfChoices: number,
+) => {
+    const choicesArray = [];
+    const choices = await prisma.optionChoice.findMany({
+        where: {
+            optionGroupId,
+        },
+    });
+    while (choicesArray.length < numberOfChoices) {
+        const choice = choices[Math.floor(Math.random() * choices.length)].id;
+        if (!choicesArray.includes(choice)) {
+            choicesArray.push(choice);
+        }
+    }
+    return choicesArray;
+};
+
+const getTeamMembers = async (teamMemberId: number) => {
+    const team = await prisma.voyageTeam.findFirst({
+        where: {
+            voyageTeamMembers: {
+                some: {
+                    id: teamMemberId,
+                },
+            },
+        },
+        select: {
+            voyageTeamMembers: {
+                select: {
+                    member: {
+                        select: {
+                            discordId: true,
+                        },
+                    },
+                },
+            },
+        },
+    });
+    return team.voyageTeamMembers.map((m) => m.member.discordId);
+};
+
+const populateQuestionResponses = async (
+    question: any,
+    teamMemberId: number,
+    responseGroupId: number,
+) => {
+    const data: any = {
+        questionId: question.id,
+        responseGroupId: responseGroupId,
+    };
+    switch (question.inputType.name) {
+        case "text": {
+            await prisma.response.create({
+                data: {
+                    ...data,
+                    text: `Text response for Question id ${question.id}.`,
+                },
+            });
+            break;
+        }
+        case "radio": {
+            const radioChoices = await getRandomOptionId(
+                question.optionGroupId,
+                1,
+            );
+            await prisma.response.create({
+                data: {
+                    ...data,
+                    optionChoiceId: radioChoices[0],
+                },
+            });
+            break;
+        }
+        case "radioGroup": {
+            // get all subquestions
+            const subQuestions = await prisma.question.findMany({
+                where: {
+                    parentQuestionId: question.id,
+                },
+                select: {
+                    id: true,
+                    inputType: {
+                        select: {
+                            name: true,
+                        },
+                    },
+                    optionGroupId: true,
+                },
+            });
+            // popuate all subquestions
+            await Promise.all(
+                subQuestions.map((subq) => {
+                    // assign subquestion optionGroupId to be same as parent, as it's null for subquestions
+                    subq.optionGroupId = question.optionGroupId;
+                    populateQuestionResponses(
+                        subq,
+                        teamMemberId,
+                        responseGroupId,
+                    );
+                }),
+            );
+            break;
+        }
+        case "checkbox": {
+            // check 2 randomly,
+            // 2 response entries as scalar list or optional list is not supported for relations
+            const checkboxChoices = await getRandomOptionId(
+                question.optionGroupId,
+                2,
+            );
+
+            await prisma.response.createMany({
+                data: [
+                    {
+                        ...data,
+                        optionChoiceId: checkboxChoices[0],
+                    },
+                    {
+                        ...data,
+                        optionChoiceId: checkboxChoices[1],
+                    },
+                ],
+            });
+            break;
+        }
+        case "teamMembersCheckbox": {
+            const selectedTeamMembers = await getTeamMembers(teamMemberId);
+            await prisma.response.create({
+                data: {
+                    ...data,
+                    text: selectedTeamMembers
+                        .filter((m) => m !== null)
+                        .join(";"),
+                },
+            });
+            break;
+        }
+        case "number": {
+            await prisma.response.create({
+                data: {
+                    ...data,
+                    numeric: Math.floor(Math.random() * 100),
+                },
+            });
+            break;
+        }
+        case "yesNo": {
+            await prisma.response.create({
+                data: {
+                    ...data,
+                    boolean: Math.random() > 0.5,
+                },
+            });
+            break;
+        }
+        default: {
+            throw new Error("Prisma seed: Unexpected question type");
+        }
+    }
+};
+
+export const populateCheckinFormResponse = async () => {
+    const teamMemberId = 1;
+    const teamMember = await prisma.voyageTeamMember.findUnique({
+        where: {
+            id: teamMemberId,
+        },
+        select: {
+            id: true,
+            voyageTeam: {
+                select: {
+                    voyage: {
+                        select: {
+                            sprints: true,
+                        },
+                    },
+                },
+            },
+        },
+    });
+
+    // get questions
+    const checkinForm = await prisma.form.findUnique({
+        where: {
+            title: "Sprint Check-in",
+        },
+        select: formSelect,
+    });
+
+    const questions = await prisma.question.findMany({
+        where: {
+            formId: checkinForm.id,
+            parentQuestionId: null,
+        },
+        select: {
+            id: true,
+            order: true,
+            inputType: {
+                select: {
+                    name: true,
+                },
+            },
+            optionGroupId: true,
+            parentQuestionId: true,
+        },
+        orderBy: {
+            order: "asc",
+        },
+    });
+
+    const responseGroup = await prisma.responseGroup.create({
+        data: {},
+    });
+
+    await Promise.all(
+        questions.map((question) => {
+            populateQuestionResponses(question, teamMemberId, responseGroup.id);
+        }),
+    );
+
+    await prisma.formResponseCheckin.create({
+        data: {
+            voyageTeamMemberId: teamMember.id,
+            sprintId: teamMember.voyageTeam.voyage.sprints[0].id,
+            responseGroupId: responseGroup.id,
+        },
+    });
+};

prisma/seed/checklist.ts

@@ -1,5 +1,4 @@
-import { PrismaClient } from "@prisma/client";
-const prisma = new PrismaClient();
+import { prisma } from "./prisma-client";
 
 export const populateChecklists = async () => {
     await prisma.checklistItem.createMany({

prisma/seed/forms/checkinform.ts

@@ -1,6 +1,4 @@
-import { PrismaClient } from "@prisma/client";
-
-const prisma = new PrismaClient();
+import { prisma } from "../prisma-client";
 
 export const populateCheckinForm = async () => {
     // Sprint - checkin form

prisma/seed/forms/index.ts

@@ -1,9 +1,7 @@
-import { PrismaClient } from "@prisma/client";
 import { populateCheckinForm } from "./checkinform";
 import { populateSoloProjectForm } from "./solo-project";
 import { populateVoyageApplicationForm } from "./voyage-app";
-
-const prisma = new PrismaClient();
+import { prisma } from "../prisma-client";
 
 export const populateFormsAndResponses = async () => {
     // test option choices for Voyage Application form