feat: show right schema for dev and non-dev conditions (#2467)

* feat: enhance request handling for OOO types and update tests

* added support for transforming OOO request data based on the development environment
* updated unit tests to verify behavior for both old and new schemas regarding request states
* included a temporary note for future database cleanup of old OOO requests

* feat: implement transformation functions for OOO requests and update related tests

* added functions to transform old and new OOO request schemas
* updated request handling logic to utilize new transformation functions based on the development environment
* modified unit tests to reflect changes in request status handling
* included a temporary note regarding future cleanup of old OOO requests in the database

* fix:reverse-dev-schema

* refactor/moved-logic-uitls-fixed-type

* fix/types-in-tests

* Update models/requests.ts

Co-authored-by: Anuj Chhikara <[email protected]>

---------

Co-authored-by: Anuj Chhikara <[email protected]>

Author: RishiChaubey31

models/requests.ts

@@ -1,15 +1,18 @@
 import firestore from "../utils/firestore";
+import type { OooStatusRequest } from "../types/oooRequest";
 const requestModel = firestore.collection("requests");
-import { REQUEST_ALREADY_APPROVED, REQUEST_ALREADY_REJECTED, REQUEST_STATE } from "../constants/requests";
+import { REQUEST_ALREADY_APPROVED, REQUEST_ALREADY_REJECTED, REQUEST_STATE, REQUEST_TYPE } from "../constants/requests";
 import {
   ERROR_WHILE_FETCHING_REQUEST,
   ERROR_WHILE_CREATING_REQUEST,
   ERROR_WHILE_UPDATING_REQUEST,
   REQUEST_DOES_NOT_EXIST,
 } from "../constants/requests";
 import { getUserId } from "../utils/users";
+import { transformRequestResponse } from "../utils/requests";
 const SIZE = 5;
 
+
 export const createRequest = async (body: any) => {
   try {
     const requestBody: any = {
@@ -149,6 +152,8 @@ export const getRequests = async (query: any) => {
       return null;
     }
 
+    allRequests = transformRequestResponse(allRequests, dev);
+
     return {
       allRequests,
       prev: prevDoc.empty ? null : prevDoc.docs[0].id,

test/integration/requests.test.ts

@@ -579,7 +579,7 @@ describe("/requests OOO", function () {
     it("should return all requests", function (done) {
       chai
         .request(app)
-        .get("/requests")
+        .get("/requests?dev=true")
         .end(function (err, res) {
           expect(res).to.have.status(200);
           expect(res.body.data).to.have.lengthOf(2);

test/unit/models/requests.test.ts

@@ -11,6 +11,7 @@ import {
 import { REQUEST_STATE, REQUEST_TYPE } from "../../../constants/requests";
 import userDataFixture from "./../../fixtures/user/user";
 import addUser from "../../utils/addUser";
+import { oldOooStatusRequest, OooStatusRequest } from "../../../types/oooRequest";
 const userData = userDataFixture();
 
 let testUserId: string;
@@ -46,8 +47,8 @@ describe("models/oooRequests", () => {
 
   describe("updateRequest", () => {
     it("should update an existing OOO request", async () => {
-      const oooRequest: any = await createRequest(createOooStatusRequests);
-      const updatedOooRequest: any = await updateRequest(
+      const oooRequest: oldOooStatusRequest = await createRequest(createOooStatusRequests);
+      const updatedOooRequest: oldOooStatusRequest = await updateRequest(
         oooRequest.id,
         updateOooApprovedRequests,
         updateOooApprovedRequests.lastModifiedBy
@@ -112,17 +113,42 @@ describe("models/oooRequests", () => {
       expect(oooRequestData.allRequests).to.be.have.length(2);
     });
 
-    it("Should return a list of all the requests with specified state - APPROVED", async () => {
-      const oooRequest: any = await createRequest(createOooStatusRequests);
-      await updateRequest(oooRequest.id, updateOooApprovedRequests, updateOooApprovedRequests.lastModifiedBy, REQUEST_TYPE.OOO)
+    it("Should return APPROVED state in old schema when dev=false", async () => {
+      const oooRequest: OooStatusRequest = await createRequest(createOooStatusRequests);
+      await updateRequest(
+        oooRequest.id,
+        updateOooApprovedRequests,
+        updateOooApprovedRequests.lastModifiedBy,
+        REQUEST_TYPE.OOO
+      );
+      const query = { dev: "false", status: REQUEST_STATE.APPROVED };
+      const oooRequestData = await getRequests(query);
+      expect(oooRequestData.allRequests[0].status).to.be.equal(REQUEST_STATE.APPROVED);
+    });
+
+    it("Should return APPROVED status in new schema when dev=true", async () => {
+      const oooRequest: OooStatusRequest = await createRequest(createOooStatusRequests);
+      await updateRequest(
+        oooRequest.id,
+        updateOooApprovedRequests,
+        updateOooApprovedRequests.lastModifiedBy,
+        REQUEST_TYPE.OOO
+      );
       const query = { dev: "true", state: REQUEST_STATE.APPROVED };
       const oooRequestData = await getRequests(query);
       expect(oooRequestData.allRequests[0].state).to.be.equal(REQUEST_STATE.APPROVED);
     });
 
-    it("Should return a list of all the requests with specified state - PENDING", async () => {
+    it("Should return PENDING state in old schema when dev=false", async () => {
+      await createRequest(createOooStatusRequests);
+      const query = { dev: "false", status: REQUEST_STATE.PENDING };
+      const oooRequestData = await getRequests(query);
+      expect(oooRequestData.allRequests[0].status).to.be.equal(REQUEST_STATE.PENDING);
+    });
+
+    it("Should return PENDING status in new schema when dev=true", async () => {
       await createRequest(createOooStatusRequests);
-      const query = { dev: "true", state: REQUEST_STATE.PENDING };
+      const query = { dev: "true", status: REQUEST_STATE.PENDING };
       const oooRequestData = await getRequests(query);
       expect(oooRequestData.allRequests[0].state).to.be.equal(REQUEST_STATE.PENDING);
     });
@@ -144,7 +170,7 @@ describe("models/oooRequests", () => {
     });
 
     it("Should return empty array if no data is found", async () => {
-      const query = { dev: "true", state: REQUEST_STATE.PENDING };
+      const query = { dev: "true", status: REQUEST_STATE.PENDING };
       const oooRequestData = await getRequests(query);
       expect(oooRequestData).to.be.equal(null);
     });

types/oooRequest.d.ts

@@ -13,11 +13,24 @@ export type OooStatusRequest = {
   status: REQUEST_STATE;
   lastModifiedBy: string | null;
   requestedBy: string;
-  userId: string;
   createdAt: Timestamp;
   updatedAt: Timestamp;
   comment: string | null;
 };
+
+export type oldOooStatusRequest = {
+  id: string;
+  type: REQUEST_TYPE.OOO;
+  from: number;
+  until: number;
+  message: string;
+  state: REQUEST_STATE;
+  lastModifiedBy: string | null;
+  requestedBy: string;
+  reason: string | null;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+};
 export type OooStatusRequestBody = {
   from: number;
   until: number;

utils/requests.ts

@@ -1,3 +1,6 @@
+import { REQUEST_TYPE } from "../constants/requests";
+import { OooStatusRequest, oldOooStatusRequest } from "../types/oooRequest";
+
 /**
  * Calculates the new deadline based on the current date, the old end date, and the additional duration in milliseconds.
  *
@@ -31,4 +34,62 @@ export const convertDateStringToMilliseconds = (date: string): { isDate: boolean
         isDate: true,
         milliseconds,
     };
+};
+
+export const oldOOOSchema = (request: OooStatusRequest) => ({
+  id: request.id,
+  type: request.type,
+  from: request.from,
+  until: request.until,
+  message: request.reason,
+  state: request.status,
+  lastModifiedBy: request.lastModifiedBy ?? "",
+  requestedBy: request.requestedBy,
+  reason: request.comment ?? "",
+  createdAt: request.createdAt,
+  updatedAt: request.updatedAt,
+});
+
+export const newOOOSchema = (request: oldOooStatusRequest) => ({
+  id: request.id,
+  type: request.type,
+  from: request.from,
+  until: request.until,
+  reason: request.message,
+  status: request.state,
+  lastModifiedBy: request.lastModifiedBy ?? null,
+  requestedBy: request.requestedBy,
+  comment: request.reason ?? null,
+  createdAt: request.createdAt,
+  updatedAt: request.updatedAt,
+});
+
+/**
+ * Transforms request responses based on request type and dev flag
+ * @param {boolean} dev - Development flag to determine transformation logic
+ */
+export const transformRequestResponse = (allRequests: (OooStatusRequest | oldOooStatusRequest)[], dev: boolean = false): (OooStatusRequest | oldOooStatusRequest)[] => {
+  const transformedRequests: (OooStatusRequest | oldOooStatusRequest)[] = [];
+  
+  for (const request of allRequests) {
+    if (request.type === REQUEST_TYPE.OOO) {
+      if (dev) {
+        if ('status' in request) {
+          transformedRequests.push(oldOOOSchema(request as OooStatusRequest));
+        } else {
+          transformedRequests.push(request);
+        }
+      } else {
+        if ('state' in request) {
+          transformedRequests.push(newOOOSchema(request as oldOooStatusRequest));
+        } else {
+          transformedRequests.push(request);
+        }
+      }
+    } else {
+      transformedRequests.push(request);
+    }
+  }
+  
+  return transformedRequests;
 };