feat(application-feedback): update route name and add new schema chagnes

Author: Hariom01010

constants/application.ts

@@ -1,7 +1,8 @@
 const APPLICATION_STATUS_TYPES = ["accepted", "rejected", "pending"];
+const NEW_APPLICATION_STATUS_TYPES = ["not_submitted", "pending", "accepted", "rejected", "requested_changes"]
 
 const API_RESPONSE_MESSAGES = {
   APPLICATION_RETURN_SUCCESS: "Applications returned successfully",
 };
 
-module.exports = { APPLICATION_STATUS_TYPES, API_RESPONSE_MESSAGES };
+module.exports = { APPLICATION_STATUS_TYPES, API_RESPONSE_MESSAGES, NEW_APPLICATION_STATUS_TYPES };

controllers/applications.ts

@@ -102,21 +102,32 @@ const addApplication = async (req: CustomRequest, res: CustomResponse) => {
 
 const updateApplication = async (req: CustomRequest, res: CustomResponse) => {
   try {
+    const devFeatureFlag = req?.query?.dev === "true";
     const { applicationId } = req.params;
     const rawBody = req.body;
 
+    const updatePayload = devFeatureFlag
+      ? {
+          status: rawBody.status,
+          adminFeedback: admin.firestore.FieldValue.arrayUnion({
+            status: rawBody.status,
+            feedback: rawBody.feedback,
+            createdAt: admin.firestore.Timestamp.now(),
+          }),
+        }
+      : rawBody;
     const applicationLog = {
       type: logType.APPLICATION_UPDATED,
       meta: {
         applicationId,
         username: req.userData.username,
         userId: req.userData.id,
       },
-      body: rawBody,
+      body: updatePayload,
     };
 
     const promises = [
-      ApplicationModel.updateApplication(rawBody, applicationId),
+      ApplicationModel.updateApplication(updatePayload, applicationId),
       addLog(applicationLog.type, applicationLog.meta, applicationLog.body),
     ];
 

middlewares/validators/application.ts

@@ -2,7 +2,7 @@ import { NextFunction } from "express";
 import { CustomRequest, CustomResponse } from "../../types/global";
 import { customWordCountValidator } from "../../utils/customWordCountValidator";
 const joi = require("joi");
-const { APPLICATION_STATUS_TYPES } = require("../../constants/application");
+const { APPLICATION_STATUS_TYPES, NEW_APPLICATION_STATUS_TYPES } = require("../../constants/application");
 const logger = require("../../utils/logger");
 
 const validateApplicationData = async (req: CustomRequest, res: CustomResponse, next: NextFunction) => {
@@ -46,6 +46,7 @@ const validateApplicationData = async (req: CustomRequest, res: CustomResponse,
 };
 
 const validateApplicationUpdateData = async (req: CustomRequest, res: CustomResponse, next: NextFunction) => {
+  const devFeatureFlag = req?.query?.dev === "true"
   const schema = joi
     .object()
     .strict()
@@ -55,7 +56,8 @@ const validateApplicationUpdateData = async (req: CustomRequest, res: CustomResp
         .min(1)
         .optional()
         .custom((value, helper) => {
-          if (!APPLICATION_STATUS_TYPES.includes(value)) {
+          const allowedStatus= devFeatureFlag? NEW_APPLICATION_STATUS_TYPES: APPLICATION_STATUS_TYPES
+          if (!allowedStatus.includes(value)) {
             return helper.message("Status is not valid");
           }
           return value;

routes/applications.ts

@@ -18,7 +18,7 @@ router.get(
 router.get("/:applicationId", authenticate, authorizeRoles([SUPERUSER]), applications.getApplicationById);
 router.post("/", authenticate, applicationValidator.validateApplicationData, applications.addApplication);
 router.patch(
-  "/:applicationId",
+  "/:applicationId/feedback",
   authenticate,
   authorizeRoles([SUPERUSER]),
   applicationValidator.validateApplicationUpdateData,

test/integration/application.test.ts

@@ -207,7 +207,7 @@ describe("Application", function () {
         });
     });
 
-        it("should return application with status accepted if status accepted is passed in query params", function (done) {
+    it("should return application with status accepted if status accepted is passed in query params", function (done) {
       chai
         .request(app)
         .get("/applications?status=accepted")
@@ -247,7 +247,7 @@ describe("Application", function () {
         });
     });
 
-
+    
     it("should return application with status rejected and the total count of the rejected applications if  dev = true ", function (done) {
       chai
         .request(app)
@@ -271,7 +271,7 @@ describe("Application", function () {
         });
     });
 
-        it("should return application with status accepted and the total count of the accepted applications if  dev = true ", function (done) {
+    it("should return application with status accepted and the total count of the accepted applications if  dev = true ", function (done) {
       chai
         .request(app)
         .get("/applications?status=accepted&dev=true")
@@ -372,11 +372,11 @@ describe("Application", function () {
     });
   });
 
-  describe("PATCH /application/:applicationId", function () {
+  describe("PATCH /application/:applicationId/feedback", function () {
     it("should return 200 if the user is super user and application is updated", function (done) {
       chai
         .request(app)
-        .patch(`/applications/${applicationId1}`)
+        .patch(`/applications/${applicationId1}/feedback`)
         .set("cookie", `${cookieName}=${superUserJwt}`)
         .send({
           status: "accepted",
@@ -395,7 +395,7 @@ describe("Application", function () {
     it("should return 401 if the user is not super user", function (done) {
       chai
         .request(app)
-        .patch(`/applications/${applicationId1}`)
+        .patch(`/applications/${applicationId1}/feedback`)
         .set("cookie", `${cookieName}=${jwt}`)
         .send({
           status: "accepted",
@@ -414,7 +414,7 @@ describe("Application", function () {
     it("should return 400 if anything other than status and feedback is passed in the body", function (done) {
       chai
         .request(app)
-        .patch(`/applications/${applicationId1}`)
+        .patch(`/applications/${applicationId1}/feedback`)
         .set("cookie", `${cookieName}=${superUserJwt}`)
         .send({
           status: "accepted",
@@ -432,10 +432,48 @@ describe("Application", function () {
         });
     });
 
-    it("should return 400 if any status other than accepted, reject or pending is passed", function (done) {
+    it("should return 400 if any status other than accepted, reject or pending is passed when dev flag is not present", function (done) {
+      chai
+        .request(app)
+        .patch(`/applications/${applicationId1}/feedback`)
+        .set("cookie", `${cookieName}=${superUserJwt}`)
+        .send({
+          status: "something",
+        })
+        .end((err, res) => {
+          if (err) {
+            return done(err);
+          }
+
+          expect(res).to.have.status(400);
+          expect(res.body.error).to.be.equal("Bad Request");
+          expect(res.body.message).to.be.equal("Status is not valid");
+          return done();
+        });
+    });
+
+    it("should return 200 if status is from not_submitted, pending, accepted, rejected, requested_changes when dev flag is present", function (done) {
+      chai
+        .request(app)
+        .patch(`/applications/${applicationId1}/feedback?dev=true`)
+        .set("cookie", `${cookieName}=${superUserJwt}`)
+        .send({
+          status: "not_submitted",
+        })
+        .end((err, res) => {
+          if (err) {
+            return done(err);
+          }
+
+          expect(res).to.have.status(200);
+          expect(res.body.message).to.be.equal("Application updated successfully!");
+          return done();
+        });
+    });
+    it("should return 400 if any status other than not_submitted, pending, accepted, rejected, requested_changes is passed when dev flag is present", function (done) {
       chai
         .request(app)
-        .patch(`/applications/${applicationId1}`)
+        .patch(`/applications/${applicationId1}/feedback?dev=true`)
         .set("cookie", `${cookieName}=${superUserJwt}`)
         .send({
           status: "something",

test/unit/middlewares/application-validator.test.ts

@@ -8,8 +8,8 @@ describe("application validator test", function () {
   describe("validateApplicationData", function () {
     it("should call next function if everything is according to the validator", async function () {
       const rawData = {
-        ...applicationsData[6]
-      }
+        ...applicationsData[6],
+      };
 
       const req = {
         body: rawData,
@@ -21,7 +21,7 @@ describe("application validator test", function () {
     });
 
     it("should not call the next function if a required field is missed", async function () {
-      const rawData = { ...applicationsData[6] }
+      const rawData = { ...applicationsData[6] };
       delete rawData.numberOfHours;
 
       const req = {
@@ -40,10 +40,10 @@ describe("application validator test", function () {
     });
 
     it("should not call the next function if any of the values which have a wordCount restriction doesn't contain the expected number of words", async function () {
-       const rawData = {
-         ...applicationsData[6],
-         whyRds: 'jfaskdfjsd'
-       };
+      const rawData = {
+        ...applicationsData[6],
+        whyRds: "jfaskdfjsd",
+      };
 
       const req = {
         body: rawData,
@@ -61,10 +61,10 @@ describe("application validator test", function () {
     });
 
     it("should not call the next function if number of hours is not a number", async function () {
-       const rawData = {
-         ...applicationsData[6],
-         numberOfHours: '10'
-       };
+      const rawData = {
+        ...applicationsData[6],
+        numberOfHours: "10",
+      };
 
       const req = {
         body: rawData,
@@ -133,6 +133,55 @@ describe("application validator test", function () {
       await applicationValidator.validateApplicationUpdateData(req, res, nextSpy);
       expect(nextSpy.callCount).to.equal(0);
     });
+
+    it("should call next function if only status and feedback is passed, and status has any of the allowed values and dev flag is true", async function () {
+      const req = {
+        query: { dev: "true" },
+        body: {
+          status: "accepted",
+          feedback: "good job",
+        },
+      };
+      const res = { boom: { badRequest: Sinon.spy() } };
+      const nextSpy = Sinon.spy();
+
+      await applicationValidator.validateApplicationUpdateData(req, res, nextSpy);
+
+      expect(nextSpy.callCount).to.equal(1);
+      expect(res.boom.badRequest.callCount).to.equal(0);
+    });
+
+    it("should not call next function if any value which is not allowed is sent in status and dev flag is true", async function () {
+      const req = {
+        query: { dev: "true" },
+        body: {
+          status: "invalid-status",
+          feedback: "good job",
+        },
+      };
+      const res = { boom: { badRequest: Sinon.spy() } };
+      const nextSpy = Sinon.spy();
+
+      await applicationValidator.validateApplicationUpdateData(req, res, nextSpy);
+      expect(nextSpy.callCount).to.equal(0);
+    });
+    it("should not call next function if any value other than status and feedback is passed and dev flag is true", async function () {
+      const req = {
+        query: { dev: "true" },
+        body: {
+          batman: true,
+        },
+      };
+      const res = {
+        boom: {
+          badRequest: () => {},
+        },
+      };
+
+      const nextSpy = Sinon.spy();
+      await applicationValidator.validateApplicationUpdateData(req, res, nextSpy);
+      expect(nextSpy.callCount).to.equal(0);
+    });
   });
 
   describe("validateApplicationQueryParam", function () {

types/application.d.ts

@@ -23,6 +23,13 @@ export type application = {
   status?: string;
   createdAt?: string;
   foundFrom: string;
+  adminFeedback?: AdminFeedbackItem[];
+};
+
+export type AdminFeedbackItem = {
+  status: string;
+  feedback?: string | null;
+  createdAt: string;
 };
 
 export type applicationPayload = {