♻️ refactor(error): fix 401 error code

dashpresshq · Sep 20, 2023 · 279b0c4 · 279b0c4
1 parent 67b46af
commit 279b0c4
Show file tree

Hide file tree

Showing 25 changed files with 111 additions and 80 deletions.
diff --git a/src/__tests__/api/account/mine.spec.ts b/src/__tests__/api/account/mine.spec.ts
@@ -75,7 +75,7 @@ describe("/api/account/mine", () => {
         "errorCode": "NOT_AUTHENTICATED",
         "message": "root not found for 'users'",
         "method": "GET",
-        "name": "ForbiddenError",
+        "name": "UnauthorizedError",
         "path": "",
         "statusCode": 401,
       }
@@ -100,7 +100,7 @@ describe("/api/account/mine", () => {
 
     await handler(req, res);
 
-    expect(res._getStatusCode()).toBe(401);
+    expect(res._getStatusCode()).toBe(403);
 
     expect(res._getJSONData()).toMatchInlineSnapshot(`
       {
@@ -109,7 +109,7 @@ describe("/api/account/mine", () => {
         "method": "GET",
         "name": "ForbiddenError",
         "path": "",
-        "statusCode": 401,
+        "statusCode": 403,
       }
     `);
   });

diff --git a/src/__tests__/api/auth/signin.spec.ts b/src/__tests__/api/auth/signin.spec.ts
@@ -50,7 +50,7 @@ describe("/api/auth/signin", () => {
         "errorCode": "",
         "message": "Invalid Login",
         "method": "POST",
-        "name": "ForbiddenError",
+        "name": "UnauthorizedError",
         "path": "",
         "statusCode": 401,
       }
@@ -75,7 +75,7 @@ describe("/api/auth/signin", () => {
         "errorCode": "",
         "message": "Invalid Login",
         "method": "POST",
-        "name": "ForbiddenError",
+        "name": "UnauthorizedError",
         "path": "",
         "statusCode": 401,
       }

diff --git a/src/__tests__/api/data/[entity]/[id]/index.spec.ts b/src/__tests__/api/data/[entity]/[id]/index.spec.ts
@@ -89,15 +89,15 @@ describe("/api/data/[entity]/[id]/index", () => {
 
       await handler(req, res);
 
-      expect(res._getStatusCode()).toBe(401);
+      expect(res._getStatusCode()).toBe(403);
       expect(res._getJSONData()).toMatchInlineSnapshot(`
         {
           "errorCode": "",
           "message": "Action 'details' has been disabled for 'tests'",
           "method": "GET",
           "name": "ForbiddenError",
           "path": "",
-          "statusCode": 401,
+          "statusCode": 403,
         }
       `);
     });
@@ -237,15 +237,15 @@ describe("/api/data/[entity]/[id]/index", () => {
 
       await handler(req, res);
 
-      expect(res._getStatusCode()).toBe(401);
+      expect(res._getStatusCode()).toBe(403);
       expect(res._getJSONData()).toMatchInlineSnapshot(`
         {
           "errorCode": "",
           "message": "Action 'update' has been disabled for 'tests'",
           "method": "PATCH",
           "name": "ForbiddenError",
           "path": "",
-          "statusCode": 401,
+          "statusCode": 403,
         }
       `);
 
@@ -330,15 +330,15 @@ describe("/api/data/[entity]/[id]/index", () => {
 
       await handler(req, res);
 
-      expect(res._getStatusCode()).toBe(401);
+      expect(res._getStatusCode()).toBe(403);
       expect(res._getJSONData()).toMatchInlineSnapshot(`
         {
           "errorCode": "",
           "message": "Action 'delete' has been disabled for 'tests'",
           "method": "DELETE",
           "name": "ForbiddenError",
           "path": "",
-          "statusCode": 401,
+          "statusCode": 403,
         }
       `);
 

diff --git a/src/__tests__/api/data/[entity]/index.spec.ts b/src/__tests__/api/data/[entity]/index.spec.ts
@@ -156,15 +156,15 @@ describe("/api/data/[entity]/index", () => {
 
       await handler(req, res);
 
-      expect(res._getStatusCode()).toBe(401);
+      expect(res._getStatusCode()).toBe(403);
       expect(res._getJSONData()).toMatchInlineSnapshot(`
         {
           "errorCode": "",
           "message": "Action 'create' has been disabled for 'tests'",
           "method": "POST",
           "name": "ForbiddenError",
           "path": "",
-          "statusCode": 401,
+          "statusCode": 403,
         }
       `);
 

diff --git a/src/__tests__/api/integrations/constants/index.spec.ts b/src/__tests__/api/integrations/constants/index.spec.ts
@@ -47,15 +47,15 @@ describe("/api/integrations/constants", () => {
 
     await handler(req, res);
 
-    expect(res._getStatusCode()).toBe(401);
+    expect(res._getStatusCode()).toBe(403);
     expect(res._getJSONData()).toMatchInlineSnapshot(`
       {
         "errorCode": "",
         "message": "Your account doesn't have enough priviledge to perform this action: (Can Configure App)",
         "method": "GET",
         "name": "ForbiddenError",
         "path": "",
-        "statusCode": 401,
+        "statusCode": 403,
       }
     `);
   });

diff --git a/src/__tests__/api/integrations/credentials/index.spec.ts b/src/__tests__/api/integrations/credentials/index.spec.ts
@@ -47,15 +47,15 @@ describe("/api/integrations/credentials", () => {
 
     await handler(req, res);
 
-    expect(res._getStatusCode()).toBe(401);
+    expect(res._getStatusCode()).toBe(403);
     expect(res._getJSONData()).toMatchInlineSnapshot(`
       {
         "errorCode": "",
         "message": "Your account doesn't have enough priviledge to perform this action: (Can Configure App)",
         "method": "GET",
         "name": "ForbiddenError",
         "path": "",
-        "statusCode": 401,
+        "statusCode": 403,
       }
     `);
   });

diff --git a/src/__tests__/api/integrations/credentials/reveal.spec.ts b/src/__tests__/api/integrations/credentials/reveal.spec.ts
@@ -98,15 +98,15 @@ describe("/api/integrations/credentials/reveal", () => {
     });
     await handler(req, res);
 
-    expect(res._getStatusCode()).toBe(401);
+    expect(res._getStatusCode()).toBe(403);
     expect(res._getJSONData()).toMatchInlineSnapshot(`
       {
         "errorCode": "",
         "message": "Your account doesn't have enough priviledge to perform this action: (Can Manage Integrations)",
         "method": "POST",
         "name": "ForbiddenError",
         "path": "",
-        "statusCode": 401,
+        "statusCode": 403,
       }
     `);
   });

diff --git a/src/__tests__/api/integrations/env/index.spec.ts b/src/__tests__/api/integrations/env/index.spec.ts
@@ -47,15 +47,15 @@ describe("/api/integrations/env", () => {
 
     await handler(req, res);
 
-    expect(res._getStatusCode()).toBe(401);
+    expect(res._getStatusCode()).toBe(403);
     expect(res._getJSONData()).toMatchInlineSnapshot(`
       {
         "errorCode": "",
         "message": "Your account doesn't have enough priviledge to perform this action: (Can Configure App)",
         "method": "GET",
         "name": "ForbiddenError",
         "path": "",
-        "statusCode": 401,
+        "statusCode": 403,
       }
     `);
   });

diff --git a/src/__tests__/roles/index.spec.tsx b/src/__tests__/roles/index.spec.tsx
@@ -74,9 +74,6 @@ describe("pages/roles", () => {
     const tableRows = await screen.findAllByRole("link", { name: "Edit" });
 
     expect(tableRows).toHaveLength(2);
-
-    expect(tableRows[0]).toHaveAttribute("href", "/roles/role-1");
-    expect(tableRows[1]).toHaveAttribute("href", "/roles/role-2");
   });
 
   it("should delete role for only non-system roles", async () => {

diff --git a/src/backend/lib/errors/error-handler.spec.ts b/src/backend/lib/errors/error-handler.spec.ts
@@ -1,6 +1,11 @@
 import { createUnAuthenticatedMocks } from "__tests__/api/_test-utils/_authenticatedMock";
 import { requestHandler } from "../request";
-import { BadRequestError, ForbiddenError, NotFoundError } from ".";
+import {
+  BadRequestError,
+  ForbiddenError,
+  NotFoundError,
+  UnauthorizedError,
+} from ".";
 
 describe("/api/error/handling", () => {
   it("should transform BadRequestError correctly", async () => {
@@ -66,6 +71,36 @@ describe("/api/error/handling", () => {
     `);
   });
 
+  it("should transform UnauthorizedError correctly", async () => {
+    const { req, res } = createUnAuthenticatedMocks({
+      method: "GET",
+    });
+
+    await requestHandler(
+      {
+        GET: async () => {
+          throw new UnauthorizedError("Invalid Login");
+        },
+      },
+      [
+        {
+          _type: "guest",
+        },
+      ]
+    )(req, res);
+
+    expect(res._getStatusCode()).toBe(401);
+    expect(res._getJSONData()).toMatchInlineSnapshot(`
+      {
+        "message": "Invalid Login",
+        "method": "GET",
+        "name": "UnauthorizedError",
+        "path": "",
+        "statusCode": 401,
+      }
+    `);
+  });
+
   it("should transform ForbiddenError correctly", async () => {
     const { req, res } = createUnAuthenticatedMocks({
       method: "GET",
@@ -87,15 +122,15 @@ describe("/api/error/handling", () => {
       ]
     )(req, res);
 
-    expect(res._getStatusCode()).toBe(401);
+    expect(res._getStatusCode()).toBe(403);
     expect(res._getJSONData()).toMatchInlineSnapshot(`
       {
         "errorCode": "DEMO_ERROR_CODE",
         "message": "Access to resource is denied",
         "method": "GET",
         "name": "ForbiddenError",
         "path": "",
-        "statusCode": 401,
+        "statusCode": 403,
       }
     `);
   });

diff --git a/src/backend/lib/errors/index.ts b/src/backend/lib/errors/index.ts
@@ -29,9 +29,15 @@ export class NotFoundError extends CustomError {
   }
 }
 
+export class UnauthorizedError extends CustomError {
+  constructor(message = "Unauthorized", errorCode = "") {
+    super(401, "UnauthorizedError", message, errorCode);
+  }
+}
+
 export class ForbiddenError extends CustomError {
   constructor(message = "Access to resource is denied", errorCode = "") {
-    super(401, "ForbiddenError", message, errorCode);
+    super(403, "ForbiddenError", message, errorCode);
   }
 }
 

diff --git a/src/backend/lib/request/validations/implementations/__tests__/authenticated-user.spec.ts b/src/backend/lib/request/validations/implementations/__tests__/authenticated-user.spec.ts
@@ -93,7 +93,7 @@ describe("Request Validations => authenticatedUserValidationImpl", () => {
         "errorCode": "ALREADY_AUTHENTICATED",
         "message": "You are already authenticated, Please logout to continue with request",
         "method": "GET",
-        "name": "ForbiddenError",
+        "name": "UnauthorizedError",
         "path": "",
         "statusCode": 401,
       }

diff --git a/src/backend/lib/request/validations/implementations/__tests__/crud-enabled.spec.ts b/src/backend/lib/request/validations/implementations/__tests__/crud-enabled.spec.ts
@@ -156,15 +156,15 @@ describe("Request Validations => crudEnabledValidationImpl", () => {
       });
 
       await handler(req, res);
-      expect(res._getStatusCode()).toBe(401);
+      expect(res._getStatusCode()).toBe(403);
       expect(res._getJSONData()).toMatchInlineSnapshot(`
         {
           "errorCode": "",
           "message": "Action 'create' has been disabled for 'tests'",
           "method": "POST",
           "name": "ForbiddenError",
           "path": "",
-          "statusCode": 401,
+          "statusCode": 403,
         }
       `);
     });
@@ -178,15 +178,15 @@ describe("Request Validations => crudEnabledValidationImpl", () => {
       });
 
       await handler(req, res);
-      expect(res._getStatusCode()).toBe(401);
+      expect(res._getStatusCode()).toBe(403);
       expect(res._getJSONData()).toMatchInlineSnapshot(`
         {
           "errorCode": "",
           "message": "Action 'details' has been disabled for 'tests'",
           "method": "GET",
           "name": "ForbiddenError",
           "path": "",
-          "statusCode": 401,
+          "statusCode": 403,
         }
       `);
     });
@@ -200,15 +200,15 @@ describe("Request Validations => crudEnabledValidationImpl", () => {
       });
 
       await handler(req, res);
-      expect(res._getStatusCode()).toBe(401);
+      expect(res._getStatusCode()).toBe(403);
       expect(res._getJSONData()).toMatchInlineSnapshot(`
         {
           "errorCode": "",
           "message": "Action 'delete' has been disabled for 'tests'",
           "method": "DELETE",
           "name": "ForbiddenError",
           "path": "",
-          "statusCode": 401,
+          "statusCode": 403,
         }
       `);
     });
@@ -222,15 +222,15 @@ describe("Request Validations => crudEnabledValidationImpl", () => {
       });
 
       await handler(req, res);
-      expect(res._getStatusCode()).toBe(401);
+      expect(res._getStatusCode()).toBe(403);
       expect(res._getJSONData()).toMatchInlineSnapshot(`
         {
           "errorCode": "",
           "message": "Action 'update' has been disabled for 'tests'",
           "method": "PATCH",
           "name": "ForbiddenError",
           "path": "",
-          "statusCode": 401,
+          "statusCode": 403,
         }
       `);
     });

diff --git a/src/backend/lib/request/validations/implementations/__tests__/guest.spec.ts b/src/backend/lib/request/validations/implementations/__tests__/guest.spec.ts
@@ -44,7 +44,7 @@ describe("Request Validations => guestValidationImpl", () => {
                   "errorCode": "ALREADY_AUTHENTICATED",
                   "message": "You are already authenticated, Please logout to continue with request",
                   "method": "GET",
-                  "name": "ForbiddenError",
+                  "name": "UnauthorizedError",
                   "path": "",
                   "statusCode": 401,
                 }