CAD - Get All Part Review FAQs

src/backend/src/controllers/organizations.controllers.ts

@@ -179,4 +179,13 @@ export default class OrganizationsController {
       next(error);
     }
   }
+
+  static async getAllPartReviewFAQS(req: Request, res: Response, next: NextFunction) {
+    try {
+      const partReviewFAQS = await OrganizationsService.getAllPartReviewFAQs(req.organization.organizationId);
+      res.status(200).json(partReviewFAQS);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
 }

src/backend/src/prisma-query-args/faq.query.args.ts

@@ -0,0 +1,12 @@
+import { Prisma } from '@prisma/client';
+import { getUserQueryArgs } from './user.query-args';
+
+export type FaqQueryArgs = ReturnType<typeof getFaqQueryArgs>;
+
+export const getFaqQueryArgs = (organizationId: string) =>
+  Prisma.validator<Prisma.FrequentlyAskedQuestionDefaultArgs>()({
+    include: {
+      userCreated: getUserQueryArgs(organizationId),
+      userDeleted: getUserQueryArgs(organizationId)
+    }
+  });

src/backend/src/prisma/migrations/20250124235046_cad_part_file_review/migration.sql

@@ -10,6 +10,7 @@ CREATE TYPE "Review_Status" AS ENUM ('IN_PROGRESS', 'READY_FOR_REVIEW', 'IN_REVI
 -- DropForeignKey
 ALTER TABLE "FrequentlyAskedQuestion" DROP CONSTRAINT "FrequentlyAskedQuestion_organizationId_fkey";
 ALTER TABLE "FrequentlyAskedQuestion" RENAME COLUMN "organizationId" TO "regularFaqOrgId";
+ALTER TABLE "FrequentlyAskedQuestion" ALTER "regularFaqOrgId" DROP NOT NULL;
 ALTER TABLE "FrequentlyAskedQuestion" ADD COLUMN     "partReviewFaqOrgId" TEXT;
 ALTER TABLE "FrequentlyAskedQuestion" ADD CONSTRAINT "FrequentlyAskedQuestion_regularFaqOrgId_fkey" FOREIGN KEY ("regularFaqOrgId") REFERENCES "Organization"("organizationId") ON DELETE SET NULL ON UPDATE CASCADE;
 ALTER TABLE "FrequentlyAskedQuestion" ADD CONSTRAINT "FrequentlyAskedQuestion_partReviewFaqOrgId_fkey" FOREIGN KEY ("partReviewFaqOrgId") REFERENCES "Organization"("organizationId") ON DELETE SET NULL ON UPDATE CASCADE;

src/backend/src/prisma/seed.ts

@@ -2012,6 +2012,17 @@ const performSeed: () => Promise<void> = async () => {
     ner
   );
 
+  await prisma.frequentlyAskedQuestion.create({
+    data: {
+      faqId: '1',
+      question: 'question',
+      answer: 'answer',
+      userCreated: { connect: { userId: batman.userId } },
+      dateCreated: new Date(),
+      partReviewFaqOrg: { connect: { organizationId: ner.organizationId } }
+    }
+  });
+
   await AnnouncementService.createAnnouncement(
     'Welcome to Finishline!',
     [regina.userId],

src/backend/src/routes/organizations.routes.ts

@@ -62,4 +62,7 @@ organizationRouter.post(
   nonEmptyString(body('workspaceId')),
   OrganizationsController.setSlackWorkspaceId
 );
+
+organizationRouter.get('/getAllPartReviewFAQs', OrganizationsController.getAllPartReviewFAQS);
+
 export default organizationRouter;

src/backend/src/services/organizations.services.ts

@@ -10,6 +10,8 @@ import { uploadFile } from '../utils/google-integration.utils';
 import { getProjects } from '../utils/projects.utils';
 import { getProjectQueryArgs } from '../prisma-query-args/projects.query-args';
 import projectTransformer from '../transformers/projects.transformer';
+import { faqTransformer } from '../transformers/faq.transformer';
+import { getFaqQueryArgs } from '../prisma-query-args/faq.query.args';
 
 export default class OrganizationsService {
   /**
@@ -407,4 +409,18 @@ export default class OrganizationsService {
 
     return updatedOrg;
   }
+
+  /**
+   * Gets all part review FAQs for the given organization Id
+   * @param organizationId organization Id of the FAQ
+   * @returns all the part review faqs from the given organization
+   */
+  static async getAllPartReviewFAQs(organizationId: string) {
+    const partReviewFAQs = await prisma.frequentlyAskedQuestion.findMany({
+      where: { dateDeleted: null, partReviewFaqOrgId: organizationId },
+      ...getFaqQueryArgs(organizationId)
+    });
+
+    return partReviewFAQs.map(faqTransformer);
+  }
 }

src/backend/src/services/recruitment.services.ts

@@ -3,6 +3,8 @@ import { isAdmin } from 'shared';
 import prisma from '../prisma/prisma';
 import { AccessDeniedAdminOnlyException, DeletedException, NotFoundException } from '../utils/errors.utils';
 import { userHasPermission } from '../utils/users.utils';
+import { faqTransformer } from '../transformers/faq.transformer';
+import { getFaqQueryArgs } from '../prisma-query-args/faq.query.args';
 
 export default class RecruitmentServices {
   /**
@@ -106,10 +108,11 @@ export default class RecruitmentServices {
    */
   static async getAllOrganizationFaqs(organization: Organization) {
     const allFaqs = await prisma.frequentlyAskedQuestion.findMany({
-      where: { dateDeleted: null, regularFaqOrgId: organization.organizationId }
+      where: { dateDeleted: null, regularFaqOrgId: organization.organizationId },
+      ...getFaqQueryArgs(organization.organizationId)
     });
 
-    return allFaqs;
+    return allFaqs.map(faqTransformer);
   }
 
   /*

src/backend/src/transformers/faq.transformer.ts

@@ -0,0 +1,13 @@
+import { Prisma } from '@prisma/client';
+import { FrequentlyAskedQuestion } from 'shared';
+import { FaqQueryArgs } from '../prisma-query-args/faq.query.args';
+import { userTransformer } from './user.transformer';
+
+export const faqTransformer = (faq: Prisma.FrequentlyAskedQuestionGetPayload<FaqQueryArgs>): FrequentlyAskedQuestion => ({
+  faqId: faq.faqId,
+  question: faq.question,
+  answer: faq.answer,
+  userCreated: userTransformer(faq.userCreated),
+  dateCreated: faq.dateCreated,
+  dateDeleted: faq.dateDeleted ?? undefined
+});

src/backend/tests/unit/recruitment.test.ts

@@ -52,7 +52,11 @@ describe('Recruitment Tests', () => {
         organization
       );
       const result = await RecruitmentServices.getAllOrganizationFaqs(organization);
-      expect(result).toStrictEqual([faq1, faq2]);
+      expect(result).toHaveLength(2);
+      expect(result[0].question).toEqual(faq1.question);
+      expect(result[0].answer).toEqual(faq1.answer);
+      expect(result[1].question).toEqual(faq2.question);
+      expect(result[1].answer).toEqual(faq2.answer);
     });
 
     describe('Edit FAQ', () => {

src/backend/tests/unmocked/organization.test.ts

@@ -260,4 +260,71 @@ describe('Organization Tests', () => {
       expect(allContacts.some((contact) => contact.userId === testSuperman.userId)).toBeTruthy();
     });
   });
+
+  describe('Get all part FAQS', () => {
+    it('Succeeds and gets all part review FAQS in the organization', async () => {
+      const testBatman = await createTestUser(batmanAppAdmin, orgId);
+      const faq1 = await prisma.frequentlyAskedQuestion.create({
+        data: {
+          faqId: '1',
+          question: 'question1',
+          answer: 'answer1',
+          userCreated: { connect: { userId: testBatman.userId } },
+          dateCreated: new Date(),
+          partReviewFaqOrg: { connect: { organizationId: orgId } }
+        }
+      });
+      const faq2 = await prisma.frequentlyAskedQuestion.create({
+        data: {
+          faqId: '2',
+          question: 'question2',
+          answer: 'answer2',
+          userCreated: { connect: { userId: testBatman.userId } },
+          dateCreated: new Date(),
+          partReviewFaqOrg: { connect: { organizationId: orgId } }
+        }
+      });
+      const partReviews = await OrganizationsService.getAllPartReviewFAQs(orgId);
+      expect(partReviews).toHaveLength(2);
+      expect(partReviews[0].question).toEqual(faq1.question);
+      expect(partReviews[0].answer).toEqual(faq1.answer);
+      expect(partReviews[1].question).toEqual(faq2.question);
+      expect(partReviews[1].answer).toEqual(faq2.answer);
+    });
+
+    it('Retrieves empty list of part review FAQS in the organization', async () => {
+      const partReviews = await OrganizationsService.getAllPartReviewFAQs(orgId);
+      expect(partReviews).toHaveLength(0);
+    });
+
+    it('Does not retrieve regular FAQS in the organization', async () => {
+      const testBatman = await createTestUser(batmanAppAdmin, orgId);
+      const partFaq = await prisma.frequentlyAskedQuestion.create({
+        data: {
+          faqId: '1',
+          question: 'faq question',
+          answer: 'faq answer',
+          userCreated: { connect: { userId: testBatman.userId } },
+          dateCreated: new Date(),
+          partReviewFaqOrg: { connect: { organizationId: orgId } }
+        }
+      });
+      const regularFaq = await prisma.frequentlyAskedQuestion.create({
+        data: {
+          faqId: '2',
+          question: 'regular question',
+          answer: 'regular answer',
+          userCreated: { connect: { userId: testBatman.userId } },
+          dateCreated: new Date(),
+          regularFaqOrg: { connect: { organizationId: orgId } }
+        }
+      });
+      const partReviews = await OrganizationsService.getAllPartReviewFAQs(orgId);
+      expect(partReviews).toHaveLength(1);
+      expect(partReviews[0].question).toEqual(partFaq.question);
+      expect(partReviews[0].answer).toEqual(partFaq.answer);
+      expect(partReviews[0].question).not.toEqual(regularFaq.question);
+      expect(partReviews[0].answer).not.toEqual(regularFaq.answer);
+    });
+  });
 });

src/backend/tests/unmocked/recruitment.test.ts

@@ -52,7 +52,11 @@ describe('Recruitment Tests', () => {
         organization
       );
       const result = await RecruitmentServices.getAllOrganizationFaqs(organization);
-      expect(result).toStrictEqual([faq1, faq2]);
+      expect(result).toHaveLength(2);
+      expect(result[0].question).toEqual(faq1.question);
+      expect(result[0].answer).toEqual(faq1.answer);
+      expect(result[1].question).toEqual(faq2.question);
+      expect(result[1].answer).toEqual(faq2.answer);
     });
 
     describe('Edit FAQ', () => {