@oneuptime/common 13.0.7 → 14.0.0

package/Tests/Server/API/OnCallSetupReminderAPI.test.ts

@@ -18,12 +18,16 @@ import DatabaseCommonInteractionProps from "../../../Types/BaseDatabase/Database
 import Dictionary from "../../../Types/Dictionary";
 import BadDataException from "../../../Types/Exception/BadDataException";
 import NotAuthorizedException from "../../../Types/Exception/NotAuthorizedException";
+import NotAuthenticatedException from "../../../Types/Exception/NotAuthenticatedException";
+import Exception from "../../../Types/Exception/Exception";
+import ExceptionCode from "../../../Types/Exception/ExceptionCode";
 import { JSONObject } from "../../../Types/JSON";
 import ObjectID from "../../../Types/ObjectID";
 import Permission, {
   UserPermission,
   UserTenantAccessPermission,
 } from "../../../Types/Permission";
+import UserType from "../../../Types/UserType";
 import { beforeEach, describe, expect, test } from "@jest/globals";
 
 /*
@@ -38,7 +42,12 @@ import { beforeEach, describe, expect, test } from "@jest/globals";
  *   admits anonymous callers as UserType.Public and takes the project from a
  *   caller-supplied `tenantid` header. So the handler is the only gate, and it
  *   has to refuse BEFORE any mail-sending work starts - a route that refuses
- *   after the send has not refused anything.
+ *   after the send has not refused anything. An anonymous caller is refused
+ *   with a 401, not the 422 below: this is the route from the customer report,
+ *   where an admin's tab sat open past the access-token lifetime, the cookie
+ *   stopped being sent, and "Send setup reminder" answered "You are not
+ *   authorized to access this project's data." The dashboard refreshes the
+ *   session and resends only on a 401.
  *
  *   WITH WHAT STANDING. Membership is the bar for the READS on this router and
  *   was, wrongly, the bar for this write too. Every read-only Viewer holds an
@@ -97,11 +106,28 @@ const REMINDER_ROUTE: string = "/on-call-readiness/send-setup-reminder";
 
 /*
  * The message every authorisation refusal on this router carries. Asserted on
- * the literal so "you are in the wrong project" cannot drift apart from "you are
- * not logged in" - a caller must not be able to tell them apart.
+ * the literal so "you are in the wrong project" cannot drift apart from "you may
+ * not do this here" - an authenticated caller must not be able to tell them
+ * apart.
+ *
+ * "You are not logged in" is deliberately a different answer (401, below). It
+ * is decided before the tenant, the body or anything else project-specific is
+ * looked at, so it is the same for every project and discloses nothing.
  */
 const REFUSAL: string = "You are not authorized to access this project's data.";
 
+function expectAuthenticationRequired(thrown: unknown): void {
+  expect(thrown).toBeInstanceOf(NotAuthenticatedException);
+  expect(thrown).not.toBeInstanceOf(NotAuthorizedException);
+  expect((thrown as Exception).code).toBe(
+    ExceptionCode.NotAuthenticatedException,
+  );
+  expect((thrown as Exception).code).toBe(401);
+  expect((thrown as Exception).message).toBe(
+    CommonAPI.AUTHENTICATION_REQUIRED_MESSAGE,
+  );
+}
+
 interface RegisteredRoute {
   method: string;
   uri: string;
@@ -365,7 +391,12 @@ describe("OnCallReadinessAPI POST /send-setup-reminder - registration", () => {
 });
 
 describe("OnCallReadinessAPI POST /send-setup-reminder - who may call it", () => {
-  test("an anonymous caller is refused and nothing is sent", async () => {
+  /*
+   * Was the 422 REFUSAL. An anonymous caller with a tenant header is, in
+   * practice, an admin whose session expired while the page sat open; the 401
+   * is what makes the dashboard refresh and resend the same POST.
+   */
+  test("an anonymous caller is refused with 401 and nothing is sent", async () => {
     propsSpy.mockResolvedValue({
       tenantId: projectId,
       userTenantAccessPermission: {},
@@ -375,10 +406,52 @@ describe("OnCallReadinessAPI POST /send-setup-reminder - who may call it", () =>
       userIds: [userA.toString()],
     });
 
+    expectAuthenticationRequired(result.thrownToNext);
+    expect(result.nextCallCount).toBe(1);
+    expect(sendRemindersSpy).not.toHaveBeenCalled();
+    expect(Response.sendJsonObjectResponse).not.toHaveBeenCalled();
+  });
+
+  test("an explicitly Public caller is refused with 401 and nothing is sent", async () => {
+    propsSpy.mockResolvedValue({
+      tenantId: projectId,
+      userType: UserType.Public,
+    } as never);
+
+    const result: RouteCallResult = await callRoute({
+      userIds: [userA.toString()],
+    });
+
+    expectAuthenticationRequired(result.thrownToNext);
+    expect(sendRemindersSpy).not.toHaveBeenCalled();
+  });
+
+  test("a project API key is authenticated, so it gets the member refusal (422), not a 401", async () => {
+    /*
+     * The route sends mail as a person acting for the project and only admits
+     * logged-in members. A key that even holds ProjectOwner is refused - but
+     * as an authorisation failure, because a 401 would send an API client off
+     * to refresh a session it never had.
+     */
+    propsSpy.mockResolvedValue({
+      ...buildProps({
+        projectId: projectId,
+        userId: callerUserId,
+        permissions: [Permission.ProjectOwner],
+      }),
+      userId: undefined,
+      userType: UserType.API,
+    } as never);
+
+    const result: RouteCallResult = await callRoute({
+      userIds: [userA.toString()],
+    });
+
     expect(result.thrownToNext).toBeInstanceOf(NotAuthorizedException);
-    expect((result.thrownToNext as NotAuthorizedException).message).toBe(
-      REFUSAL,
+    expect((result.thrownToNext as Exception).code).toBe(
+      ExceptionCode.NotAuthorizedException,
     );
+    expect((result.thrownToNext as Exception).message).toBe(REFUSAL);
     expect(sendRemindersSpy).not.toHaveBeenCalled();
   });
 
@@ -401,7 +474,11 @@ describe("OnCallReadinessAPI POST /send-setup-reminder - who may call it", () =>
   });
 
   test("a request with no tenant header is refused before the body is even parsed", async () => {
-    propsSpy.mockResolvedValue({} as never);
+    /*
+     * A logged-in caller who sent no tenant header. (With no session as well,
+     * the refusal is the 401 - next test.)
+     */
+    propsSpy.mockResolvedValue({ userId: callerUserId } as never);
 
     const result: RouteCallResult = await callRoute({
       userIds: ["obviously-not-a-uuid"],
@@ -418,6 +495,33 @@ describe("OnCallReadinessAPI POST /send-setup-reminder - who may call it", () =>
     );
     expect(sendRemindersSpy).not.toHaveBeenCalled();
   });
+
+  test("a request with no session and no tenant header is a 401, decided before the tenant or the body", async () => {
+    /*
+     * This used to be the 400 above. "Who are you?" now comes first, so a
+     * signed-out caller cannot learn anything about the tenant rules or the
+     * body format, and the dashboard gets the 401 it refreshes on.
+     */
+    propsSpy.mockResolvedValue({} as never);
+
+    const result: RouteCallResult = await callRoute({
+      userIds: ["obviously-not-a-uuid"],
+    });
+
+    expectAuthenticationRequired(result.thrownToNext);
+    expect(sendRemindersSpy).not.toHaveBeenCalled();
+  });
+
+  test("an anonymous caller with a malformed body is still the 401, not the body's 400", async () => {
+    propsSpy.mockResolvedValue({ tenantId: projectId } as never);
+
+    const result: RouteCallResult = await callRoute({
+      userIds: "not-even-an-array",
+    } as unknown as JSONObject);
+
+    expectAuthenticationRequired(result.thrownToNext);
+    expect(sendRemindersSpy).not.toHaveBeenCalled();
+  });
 });
 
 /*
@@ -448,6 +552,14 @@ describe("OnCallReadinessAPI POST /send-setup-reminder - membership is not enoug
     expect((result.thrownToNext as NotAuthorizedException).message).toBe(
       REFUSAL,
     );
+    /*
+     * 422, not 401: this member IS logged in. Answering with a 401 would make
+     * the dashboard refresh a perfectly good session and replay the POST, only
+     * to be refused again.
+     */
+    expect((result.thrownToNext as Exception).code).toBe(
+      ExceptionCode.NotAuthorizedException,
+    );
     expect(sendRemindersSpy).not.toHaveBeenCalled();
   });
 

package/Tests/Server/API/ProjectScopedCustomRouteAuth.test.ts

@@ -16,11 +16,15 @@ import DatabaseCommonInteractionProps from "../../../Types/BaseDatabase/Database
 import Dictionary from "../../../Types/Dictionary";
 import BadDataException from "../../../Types/Exception/BadDataException";
 import NotAuthorizedException from "../../../Types/Exception/NotAuthorizedException";
+import NotAuthenticatedException from "../../../Types/Exception/NotAuthenticatedException";
+import Exception from "../../../Types/Exception/Exception";
+import ExceptionCode from "../../../Types/Exception/ExceptionCode";
 import ObjectID from "../../../Types/ObjectID";
 import Permission, {
   UserPermission,
   UserTenantAccessPermission,
 } from "../../../Types/Permission";
+import UserType from "../../../Types/UserType";
 import {
   afterEach,
   beforeAll,
@@ -46,6 +50,13 @@ import {
  * path belongs to that same project. Checking only the first would let a
  * member of project A send their own tenant header while targeting project
  * B's resource id.
+ *
+ * A caller with no credentials at all is refused with NotAuthenticatedException
+ * (401) before either check, and before the tenant header is even looked at.
+ * That is almost always a signed-in user whose access-token cookie expired, and
+ * the dashboard only refreshes the session and resends on a 401. Authenticated
+ * callers keep the refusals they always had (400 no tenant, 422 not a member /
+ * wrong project).
  */
 
 jest.mock("../../../Server/Utils/Express", () => {
@@ -109,6 +120,17 @@ type RouteCallResult = {
   nextCallCount: number;
 };
 
+function expectAuthenticationRequired(thrown: unknown): void {
+  expect(thrown).toBeInstanceOf(NotAuthenticatedException);
+  expect((thrown as Exception).code).toBe(
+    ExceptionCode.NotAuthenticatedException,
+  );
+  expect((thrown as Exception).code).toBe(401);
+  expect((thrown as Exception).message).toBe(
+    CommonAPI.AUTHENTICATION_REQUIRED_MESSAGE,
+  );
+}
+
 async function callGetRoute(data: {
   uri: string;
   params: Dictionary<string>;
@@ -246,7 +268,8 @@ describe("Project-scoped custom routes require an authenticated member of the re
       expect(readArgs.props["isRoot"]).toBe(true);
     });
 
-    test("rejects an unauthenticated caller with BadDataException and never reads the monitor", async () => {
+    // Was BadDataException (400) before the credential check.
+    test("rejects an unauthenticated caller with NotAuthenticatedException (401) and never reads the monitor", async () => {
       mockProps({});
 
       const result: RouteCallResult = await callGetRoute({
@@ -254,12 +277,29 @@ describe("Project-scoped custom routes require an authenticated member of the re
         params: { monitorId: monitorId.toString() },
       });
 
+      expectAuthenticationRequired(result.thrownToNext);
+      expect(findOneByIdSpy).not.toHaveBeenCalled();
+      expect(refreshSpy).not.toHaveBeenCalled();
+    });
+
+    test("rejects a logged-in caller with no tenant header with BadDataException (400) and never reads the monitor", async () => {
+      mockProps({ userId: callerUserId, userType: UserType.User });
+
+      const result: RouteCallResult = await callGetRoute({
+        uri: MONITOR_REFRESH_ROUTE,
+        params: { monitorId: monitorId.toString() },
+      });
+
       expect(result.thrownToNext).toBeInstanceOf(BadDataException);
+      expect((result.thrownToNext as Exception).code).toBe(
+        ExceptionCode.BadDataException,
+      );
       expect(findOneByIdSpy).not.toHaveBeenCalled();
       expect(refreshSpy).not.toHaveBeenCalled();
     });
 
-    test("rejects a public caller that supplies a tenant header it is not a member of", async () => {
+    // Was NotAuthorizedException (422) before the credential check.
+    test("rejects a public caller that supplies a tenant header it is not a member of with 401", async () => {
       mockProps({
         tenantId: callerProjectId,
         userId: undefined,
@@ -271,7 +311,28 @@ describe("Project-scoped custom routes require an authenticated member of the re
         params: { monitorId: monitorId.toString() },
       });
 
+      expectAuthenticationRequired(result.thrownToNext);
+      expect(findOneByIdSpy).not.toHaveBeenCalled();
+      expect(refreshSpy).not.toHaveBeenCalled();
+    });
+
+    test("rejects a logged-in caller whose tenant header names a project they are not in with 422", async () => {
+      mockProps({
+        tenantId: callerProjectId,
+        userId: callerUserId,
+        userType: UserType.User,
+        userTenantAccessPermission: {},
+      });
+
+      const result: RouteCallResult = await callGetRoute({
+        uri: MONITOR_REFRESH_ROUTE,
+        params: { monitorId: monitorId.toString() },
+      });
+
       expect(result.thrownToNext).toBeInstanceOf(NotAuthorizedException);
+      expect((result.thrownToNext as Exception).code).toBe(
+        ExceptionCode.NotAuthorizedException,
+      );
       expect(findOneByIdSpy).not.toHaveBeenCalled();
       expect(refreshSpy).not.toHaveBeenCalled();
     });
@@ -383,7 +444,8 @@ describe("Project-scoped custom routes require an authenticated member of the re
       expect(Response.sendEmptySuccessResponse).toHaveBeenCalledTimes(1);
     });
 
-    test("rejects an unauthenticated caller with BadDataException and never reads the rule", async () => {
+    // Was BadDataException (400) before the credential check.
+    test("rejects an unauthenticated caller with NotAuthenticatedException (401) and never reads the rule", async () => {
       mockProps({});
 
       const result: RouteCallResult = await callGetRoute({
@@ -391,12 +453,29 @@ describe("Project-scoped custom routes require an authenticated member of the re
         params: { workspaceNotifcationRuleId: ruleId.toString() },
       });
 
+      expectAuthenticationRequired(result.thrownToNext);
+      expect(findOneByIdSpy).not.toHaveBeenCalled();
+      expect(testRuleSpy).not.toHaveBeenCalled();
+    });
+
+    test("rejects a logged-in caller with no tenant header with BadDataException (400) and never reads the rule", async () => {
+      mockProps({ userId: callerUserId, userType: UserType.User });
+
+      const result: RouteCallResult = await callGetRoute({
+        uri: TEST_RULE_ROUTE,
+        params: { workspaceNotifcationRuleId: ruleId.toString() },
+      });
+
       expect(result.thrownToNext).toBeInstanceOf(BadDataException);
+      expect((result.thrownToNext as Exception).code).toBe(
+        ExceptionCode.BadDataException,
+      );
       expect(findOneByIdSpy).not.toHaveBeenCalled();
       expect(testRuleSpy).not.toHaveBeenCalled();
     });
 
-    test("rejects a public caller that supplies a tenant header it is not a member of", async () => {
+    // Was NotAuthorizedException (422) before the credential check.
+    test("rejects a public caller that supplies a tenant header it is not a member of with 401", async () => {
       mockProps({
         tenantId: callerProjectId,
         userId: undefined,
@@ -408,7 +487,35 @@ describe("Project-scoped custom routes require an authenticated member of the re
         params: { workspaceNotifcationRuleId: ruleId.toString() },
       });
 
+      expectAuthenticationRequired(result.thrownToNext);
+      expect(findOneByIdSpy).not.toHaveBeenCalled();
+      expect(testRuleSpy).not.toHaveBeenCalled();
+    });
+
+    /*
+     * The rule test posts a message as a person (testByUserId), so a project
+     * API key - authenticated, but nobody - is refused. With the 422, not a
+     * 401: the key's client has no session to refresh.
+     */
+    test("rejects a project API key with 422 and never reads the rule", async () => {
+      mockProps({
+        ...buildMemberProps({
+          projectId: callerProjectId,
+          userId: callerUserId,
+        }),
+        userId: undefined,
+        userType: UserType.API,
+      });
+
+      const result: RouteCallResult = await callGetRoute({
+        uri: TEST_RULE_ROUTE,
+        params: { workspaceNotifcationRuleId: ruleId.toString() },
+      });
+
       expect(result.thrownToNext).toBeInstanceOf(NotAuthorizedException);
+      expect((result.thrownToNext as Exception).code).toBe(
+        ExceptionCode.NotAuthorizedException,
+      );
       expect(findOneByIdSpy).not.toHaveBeenCalled();
       expect(testRuleSpy).not.toHaveBeenCalled();
     });