fix/removed createdBy and createdFor for filtering and impersonation collection

Author: Suvidh-kaushik

controllers/impersonationRequests.ts

@@ -39,11 +39,9 @@ export const createImpersonationRequestController = async (
   try {
     const { impersonatedUserId, reason } = req.body as CreateImpersonationRequestBody;
     const userId = req.userData?.id;
-    const createdBy = req.userData?.username;
 
     const impersonationRequest = await createImpersonationRequestService({
       userId,
-      createdBy,
       impersonatedUserId,
       reason
     });

models/impersonationRequests.ts

@@ -110,13 +110,13 @@ export const getImpersonationRequests = async (
     let requestQuery: Query<ImpersonationRequest> = impersonationRequestModel as CollectionReference<ImpersonationRequest>;
 
     if (createdBy) {
-      requestQuery = requestQuery.where("createdBy", "==", createdBy);
+      requestQuery = requestQuery.where("userId", "==", createdBy);
     }
     if (status) {
       requestQuery = requestQuery.where("status", "==", status);
     }
     if (createdFor) {
-      requestQuery = requestQuery.where("createdFor", "==", createdFor);
+      requestQuery = requestQuery.where("impersonatedUserId", "==", createdFor);
     }
 
     requestQuery = requestQuery.orderBy("createdAt", "desc");

services/impersonationRequests.ts

@@ -41,20 +41,17 @@ export const createImpersonationRequestService = async (
   body: CreateImpersonationRequestServiceBody
 ): Promise<ImpersonationRequest> => {
   try {
-    const { userExists, user: impersonatedUser } = await fetchUser({ userId: body.impersonatedUserId });
+    const { userExists } = await fetchUser({ userId: body.impersonatedUserId });
     if (!userExists) {
       throw new NotFound(TASK_REQUEST_MESSAGES.USER_NOT_FOUND);
     }
 
-    const { username: createdFor } = impersonatedUser as User;
 
     const impersonationRequest = await createImpersonationRequest({
       status: REQUEST_STATE.PENDING,
       userId: body.userId,
       impersonatedUserId: body.impersonatedUserId,
       isImpersonationFinished: false,
-      createdBy: body.createdBy,
-      createdFor: createdFor,
       reason: body.reason,
     });
 

test/fixtures/impersonation-requests/impersonationRequests.ts

@@ -4,62 +4,48 @@ export const impersonationRequestsBodyData = [
   {
     status: REQUEST_STATE.PENDING,
     isImpersonationFinished: false,
-    createdBy: "superuser-1",
-    createdFor: "suvidh-kaushik",
     userId: "userId123",
     reason: "User assistance required for account debugging.",
     impersonatedUserId: "userId345",
   },
   {
     status: REQUEST_STATE.PENDING,
     isImpersonationFinished: false,
-    createdBy: "superuser-2",
-    createdFor: "suvidh-kaushik-2",
     userId: "userId124",
     reason: "User assistance required for account debugging.",
     impersonatedUserId: "userId445",
   },
   {
     status: REQUEST_STATE.PENDING,
     isImpersonationFinished: false,
-    createdBy: "admin222",
-    createdFor: "user321",
     userId: "admin222",
     reason: "Investigating bug in user workflow.",
     impersonatedUserId: "user321",
   },
   {
     status: REQUEST_STATE.PENDING,
     isImpersonationFinished: false,
-    createdBy: "adminUsername",
-    createdFor: "user322",
     userId: "admin2223",
     reason: "Verifying permissions for support case.",
     impersonatedUserId: "user322",
   },
   {
     status: REQUEST_STATE.PENDING,
     isImpersonationFinished: false,
-    createdBy: "adminUsername",
-    createdFor: "user321",
     userId: "admin222",
     reason: "Testing impersonation feature for QA.",
     impersonatedUserId: "user321",
   },
   {
     status: REQUEST_STATE.APPROVED,
     isImpersonationFinished: false,
-    createdBy: "approverUser",
-    createdFor: "approvedUser",
     userId: "approverId",
     reason: "Approved for troubleshooting session.",
     impersonatedUserId: "approvedUserId",
   },
   {
     status: REQUEST_STATE.REJECTED,
     isImpersonationFinished: false,
-    createdBy: "reviewerUser",
-    createdFor: "rejectedUser",
     userId: "reviewerId",
     reason: "Request rejected due to insufficient details.",
     impersonatedUserId: "rejectedUserId",

test/integration/impersonationRequests.test.ts

@@ -76,16 +76,12 @@ describe("Impersonation Requests", () => {
     unapprovedImpersonationRequest = await impersonationModel.createImpersonationRequest({
       ...impersonationRequestsBodyData[0],
       impersonatedUserId: testUserId2,
-      createdFor: userData[19].username,
       userId: testSuperUserId,
-      createdBy: userData[4].username
     });
 
     approvedImpersonationRequest = await impersonationModel.createImpersonationRequest({
       ...impersonationRequestsBodyData[0],
       impersonatedUserId: testUserId3,
-      createdFor: userData[12].username,
-      createdBy: userData[4].username,
       userId: testSuperUserId,
       status: REQUEST_STATE.APPROVED
     });
@@ -300,19 +296,15 @@ describe("Impersonation Requests", () => {
       await impersonationModel.createImpersonationRequest({
         ...impersonationRequestsBodyData[3],
         impersonatedUserId: testUserId4,
-        createdFor: userData[0].username,
         userId: testSuperUserId,
         status: REQUEST_STATE.REJECTED,
-        createdBy: userData[4].username
       });
 
       await impersonationModel.createImpersonationRequest({
         ...impersonationRequestsBodyData[4],
         impersonatedUserId: testUserId5,
-        createdFor: userData[1].username,
         userId: testSuperUserId,
-        status: REQUEST_STATE.REJECTED,
-        createdBy: userData[4].username
+        status: REQUEST_STATE.REJECTED
       });
     });
 
@@ -353,7 +345,7 @@ describe("Impersonation Requests", () => {
           expect(res.body.data).to.be.an("array");
           expect(res.body.data.length).to.be.equal(4);
           expect(res.body.data[0]).to.include.all.keys(
-            "id", "createdBy", "userId", "impersonatedUserId", "createdFor"
+            "id", "userId", "impersonatedUserId"
           );
           done();
         });
@@ -363,28 +355,27 @@ describe("Impersonation Requests", () => {
     it("should return all requests created by a specific user", function (done) {
       chai
         .request(app)
-        .get(`${requestsEndpoint}&createdBy=${userData[4].username}`)
+        .get(`${requestsEndpoint}&createdBy=${testSuperUserId}`)
         .set("cookie", `${cookieName}=${authToken}`)
         .end(function (err, res) {
           if (err) return done(err);
           expect(res).to.have.status(200);
           expect(res.body.data).to.be.an("array");
           expect(res.body.data.every((r) => r.userId === testSuperUserId)).to.be.true;
-          expect(res.body.data.every((r)=>r.createdBy === userData[4].username)).to.be.true;
           done();
         });
     });
 
     it("should return all requests created for a specific user", function (done) {
       chai
         .request(app)
-        .get(`${requestsEndpoint}&createdFor=${userData[19].username}`)
+        .get(`${requestsEndpoint}&createdFor=${testUserId2}`)
         .set("cookie", `${cookieName}=${authToken}`)
         .end(function (err, res) {
           if (err) return done(err);
           expect(res).to.have.status(200);
           expect(res.body.data).to.be.an("array");
-          expect(res.body.data.every((r) => r.createdFor === userData[19].username)).to.be.true;
+          expect(res.body.data.every((r) => r.impersonatedUserId === testUserId2)).to.be.true;
           expect(res.body.data.length).to.equal(1);
           done();
         });
@@ -601,14 +592,12 @@ describe("Impersonation Requests", () => {
       approvedImpersonationRequest = await impersonationModel.createImpersonationRequest({
         ...impersonationRequestsBodyData[0],
         impersonatedUserId: testUserId1,
-        createdBy: userData[16].username,
         status: REQUEST_STATE.APPROVED
       });
 
       unapprovedImpersonationRequest = await impersonationModel.createImpersonationRequest({
         ...impersonationRequestsBodyData[1],
         impersonatedUserId: testUserId3,
-        createdFor: userData[12].username
       });
 
       unapprovedImpersonationRequest2 = await impersonationModel.createImpersonationRequest({
@@ -827,11 +816,9 @@ describe("Impersonation Requests", () => {
     finishedImpersonationRequest = await impersonationModel.createImpersonationRequest({
       ...impersonationRequestsBodyData[0],
       impersonatedUserId: testUserId4,
-      createdFor: userData[0].username,
       userId: testSuperUserId,
       status: "APPROVED",
       isImpersonationFinished: true,
-      createdBy: userData[4].username,
     });
   });
 

test/unit/models/impersonationRequests.test.ts

@@ -35,9 +35,8 @@ describe("models/impersonationRequests", () => {
       impersonationRequest = await impersonationModel.createImpersonationRequest(mockRequestBody);
       expect(impersonationRequest).to.have.property("id");
       expect(impersonationRequest).to.include({
-        createdBy: mockRequestBody.createdBy,
         impersonatedUserId: mockRequestBody.impersonatedUserId,
-        createdFor: mockRequestBody.createdFor,
+        userId: mockRequestBody.userId,
         status: REQUEST_STATE.PENDING,
       });
     });
@@ -52,13 +51,13 @@ describe("models/impersonationRequests", () => {
     });
 
     it("should allow different super users to create requests for same user", async () => {
-      const request1 = await impersonationModel.createImpersonationRequest({ ...impersonationRequestsBodyData[0], createdBy: "user1" });
-      const request2 = await impersonationModel.createImpersonationRequest({ ...impersonationRequestsBodyData[0], createdBy: "user2", userId: "122" });
+      const request1 = await impersonationModel.createImpersonationRequest({ ...impersonationRequestsBodyData[0], userId: "121" });
+      const request2 = await impersonationModel.createImpersonationRequest({ ...impersonationRequestsBodyData[0], userId: "122" });
       expect(request1).to.have.property("id");
-      expect(request1.createdBy).to.equal("user1");
+      expect(request1.userId).to.equal("121");
       expect(request1.impersonatedUserId).to.equal(impersonationRequestsBodyData[0].impersonatedUserId);
       expect(request2).to.have.property("id");
-      expect(request2.createdBy).to.equal("user2");
+      expect(request2.userId).to.equal("122");
       expect(request2.impersonatedUserId).to.equal(impersonationRequestsBodyData[0].impersonatedUserId);
     });
 
@@ -153,10 +152,10 @@ describe("models/impersonationRequests", () => {
     });
 
     it("should filter requests by createdBy", async () => {
-      const query = { createdBy: impersonationRequests[0].createdBy };
+      const query = { createdBy: impersonationRequests[0].userId };
       const result = await impersonationModel.getImpersonationRequests(query);
       expect(result.allRequests.length).to.be.equal(1);
-      expect(result.allRequests.every(r => r.createdBy === impersonationRequests[0].createdBy)).to.be.true;
+      expect(result.allRequests.every(r => r.userId === impersonationRequests[0].userId)).to.be.true;
     });
 
     it("should return requests by size", async () => {
@@ -166,10 +165,10 @@ describe("models/impersonationRequests", () => {
     });
 
     it("should filter requests by createdFor", async () => {
-      const query = { createdFor: impersonationRequests[0].createdFor };
+      const query = { createdFor: impersonationRequests[0].impersonatedUserId };
       const result = await impersonationModel.getImpersonationRequests(query);
       expect(result.allRequests.length).to.be.equal(1);
-      expect(result.allRequests.every(r => r.createdFor === impersonationRequests[0].createdFor)).to.be.true;
+      expect(result.allRequests.every(r => r.impersonatedUserId === impersonationRequests[0].impersonatedUserId)).to.be.true;
     });
 
 

test/unit/services/impersonationRequests.test.ts

@@ -49,7 +49,6 @@ describe("Tests Impersonation Requests Service", () => {
       try {
         await impersonationService.createImpersonationRequestService({
           userId: "randomIs",
-          createdBy: "randomName",
           impersonatedUserId: "randomImpersonatedId",
           reason: "He asked",
         });
@@ -74,13 +73,11 @@ describe("Tests Impersonation Requests Service", () => {
 
       const response = await impersonationService.createImpersonationRequestService({
         userId: mockRequestBody.userId,
-        createdBy: mockRequestBody.createdBy,
         impersonatedUserId: userData[20].id,
         reason: mockRequestBody.reason,
       });
 
       expect(response).to.not.be.null;
-      expect(response.createdBy).to.equal(mockRequestBody.createdBy);
       expect(response.id).to.not.be.null;
       expect(response.userId).to.equal(mockRequestBody.userId);
       expect(response.impersonatedUserId).to.equal(userData[20].id);
@@ -92,7 +89,6 @@ describe("Tests Impersonation Requests Service", () => {
       try {
         await impersonationService.createImpersonationRequestService({
           userId: mockRequestBody.userId,
-          createdBy: mockRequestBody.createdBy,
           impersonatedUserId: "112",
           reason: mockRequestBody.reason,
         });

types/impersonationRequest.d.ts

@@ -9,8 +9,6 @@ export type ImpersonationRequest = {
     id: string;
     status: REQUEST_STATE;
     isImpersonationFinished: boolean;
-    createdBy: string;
-    createdFor: string;
     userId: string;
     reason: string;
     message?: string;
@@ -29,8 +27,6 @@ export type CreateImpersonationRequestBody = {
 export type CreateImpersonationRequestModelDto = {
     status: REQUEST_STATE;
     isImpersonationFinished: boolean;
-    createdBy: string;
-    createdFor: string;
     userId: string;
     reason: string;
     impersonatedUserId: string;
@@ -118,7 +114,6 @@ export type GetImpersonationControllerRequest = Request & {
 
 export type CreateImpersonationRequestServiceBody={
    userId: string;
-   createdBy: string;
    impersonatedUserId: string;
    reason: string;
 }