MCR-4447: Q&A by rates database tables, domain types, and feature flag (

#2794)

* Q&A by rates prisma update and migration.

* RateQuestion domain type and zod schema

* Add new flag to featureFlags

services/app-api/prisma/migrations/20240930221546_add_question_response_by_rates_tables/migration.sql

@@ -0,0 +1,68 @@
+BEGIN;
+
+-- CreateTable
+CREATE TABLE "RateQuestion" (
+    "id" TEXT NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "rateID" TEXT NOT NULL,
+    "addedByUserID" TEXT NOT NULL,
+    "division" "Division" NOT NULL,
+
+    CONSTRAINT "RateQuestion_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "RateQuestionResponse" (
+    "id" TEXT NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+    "questionID" TEXT NOT NULL,
+    "addedByUserID" TEXT NOT NULL,
+
+    CONSTRAINT "RateQuestionResponse_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "RateQuestionDocument" (
+    "id" TEXT NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "name" TEXT NOT NULL,
+    "s3URL" TEXT NOT NULL,
+    "questionID" TEXT NOT NULL,
+
+    CONSTRAINT "RateQuestionDocument_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "RateQuestionResponseDocument" (
+    "id" TEXT NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+    "name" TEXT NOT NULL,
+    "s3URL" TEXT NOT NULL,
+    "responseID" TEXT NOT NULL,
+
+    CONSTRAINT "RateQuestionResponseDocument_pkey" PRIMARY KEY ("id")
+);
+
+-- AddForeignKey
+ALTER TABLE "RateQuestion" ADD CONSTRAINT "RateQuestion_rateID_fkey" FOREIGN KEY ("rateID") REFERENCES "RateTable"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "RateQuestion" ADD CONSTRAINT "RateQuestion_addedByUserID_fkey" FOREIGN KEY ("addedByUserID") REFERENCES "User"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "RateQuestionResponse" ADD CONSTRAINT "RateQuestionResponse_questionID_fkey" FOREIGN KEY ("questionID") REFERENCES "RateQuestion"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "RateQuestionResponse" ADD CONSTRAINT "RateQuestionResponse_addedByUserID_fkey" FOREIGN KEY ("addedByUserID") REFERENCES "User"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "RateQuestionDocument" ADD CONSTRAINT "RateQuestionDocument_questionID_fkey" FOREIGN KEY ("questionID") REFERENCES "RateQuestion"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "RateQuestionResponseDocument" ADD CONSTRAINT "RateQuestionResponseDocument_responseID_fkey" FOREIGN KEY ("responseID") REFERENCES "RateQuestionResponse"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+COMMIT;

services/app-api/prisma/schema.prisma

@@ -64,6 +64,8 @@ model RateTable {
   withdrawInfoID String?
   withdrawInfo   UpdateInfoTable? @relation("withdrawRateInfo", fields: [withdrawInfoID], references: [id])
 
+  questions RateQuestion[]
+
   draftContracts DraftRateJoinTable[]
 
   revisions RateRevisionTable[]
@@ -300,20 +302,22 @@ model StateProgram {
 }
 
 model User {
-  id                    String             @id @default(uuid())
-  createdAt             DateTime           @default(now())
-  updatedAt             DateTime           @default(now()) @updatedAt
+  id                    String                 @id @default(uuid())
+  createdAt             DateTime               @default(now())
+  updatedAt             DateTime               @default(now()) @updatedAt
   givenName             String
   familyName            String
   email                 String
   role                  Role
   divisionAssignment    Division?
   stateCode             String?
-  stateAssignments      State[]            @relation("StateToAssignedCMSUser")
+  stateAssignments      State[]                @relation("StateToAssignedCMSUser")
   questions             Question[]
+  rateQuestions         RateQuestion[]
   responses             QuestionResponse[]
+  rateResponses         RateQuestionResponse[]
   audits                UserAudit[]
-  updatedByAuditEntries UserAudit[]        @relation("UpdatedBy")
+  updatedByAuditEntries UserAudit[]            @relation("UpdatedBy")
   updateInfos           UpdateInfoTable[]
 }
 
@@ -374,6 +378,50 @@ model QuestionResponse {
   documents     QuestionResponseDocument[]
 }
 
+model RateQuestion {
+  id            String                 @id @default(uuid())
+  createdAt     DateTime               @default(now())
+  updatedAt     DateTime               @default(now()) @updatedAt
+  rateID        String
+  rate          RateTable              @relation(fields: [rateID], references: [id])
+  addedBy       User                   @relation(fields: [addedByUserID], references: [id])
+  addedByUserID String
+  division      Division
+  documents     RateQuestionDocument[]
+  responses     RateQuestionResponse[]
+}
+
+model RateQuestionResponse {
+  id            String                         @id @default(uuid())
+  createdAt     DateTime                       @default(now())
+  updatedAt     DateTime                       @updatedAt
+  questionID    String
+  question      RateQuestion                   @relation(fields: [questionID], references: [id])
+  addedByUserID String
+  addedBy       User                           @relation(fields: [addedByUserID], references: [id])
+  documents     RateQuestionResponseDocument[]
+}
+
+model RateQuestionDocument {
+  id         String       @id @default(uuid())
+  createdAt  DateTime     @default(now())
+  updatedAt  DateTime     @default(now()) @updatedAt
+  name       String
+  s3URL      String
+  questionID String
+  question   RateQuestion @relation(fields: [questionID], references: [id])
+}
+
+model RateQuestionResponseDocument {
+  id         String               @id @default(uuid())
+  createdAt  DateTime             @default(now())
+  updatedAt  DateTime             @updatedAt
+  name       String
+  s3URL      String
+  responseID String
+  response   RateQuestionResponse @relation(fields: [responseID], references: [id])
+}
+
 enum Division {
   DMCO
   DMCP

services/app-api/src/domain-models/QuestionsType.ts

@@ -9,16 +9,23 @@ const document = z.object({
     downloadURL: z.string().optional(),
 })
 
-const question = z.object({
+const commonQuestionSchema = z.object({
     id: z.string().uuid(),
-    contractID: z.string().uuid(),
     createdAt: z.date(),
     addedBy: cmsUserSchema,
     division: divisionType, // DMCO, DMCP, OACT
     documents: z.array(document),
     responses: z.array(questionResponseType),
 })
 
+const question = commonQuestionSchema.extend({
+    contractID: z.string().uuid(),
+})
+
+const rateQuestion = commonQuestionSchema.extend({
+    rateID: z.string().uuid(),
+})
+
 const questionEdge = z.object({
     node: question,
 })
@@ -51,6 +58,8 @@ type IndexQuestionsPayload = z.infer<typeof indexQuestionsPayload>
 
 type Question = z.infer<typeof question>
 
+type RateQuestion = z.infer<typeof rateQuestion>
+
 type QuestionList = z.infer<typeof questionList>
 
 type Document = z.infer<typeof document>
@@ -62,6 +71,7 @@ export type {
     Question,
     Document,
     QuestionList,
+    RateQuestion,
 }
 
 export {
@@ -71,4 +81,5 @@ export {
     question,
     document,
     questionList,
+    rateQuestion,
 }

services/app-api/src/domain-models/index.ts

@@ -69,6 +69,7 @@ export type {
     Question,
     Document,
     QuestionList,
+    RateQuestion,
 } from './QuestionsType'
 
 export type {

services/app-web/src/common-code/featureFlags/flags.ts

@@ -32,8 +32,11 @@ const featureFlags = {
         flag: 'read-write-state-assignments',
         defaultValue: false
     },
+    QA_BY_RATES: {
+        flag: 'qa-by-rates',
+        defaultValue: false
+    },
     // PERMANENT FLAGS
-
     /**
      Enables the modal that alerts the user to an expiring session
     */