Skip to content

Open-source status page, incident response and uptime monitoring

15.3 KB
Raw Blame
import { db, eq } from "@openstatus/db";
import {
  monitor,
  notification,
  notificationsToMonitors,
  selectWorkspaceSchema,
  workspace,
} from "@openstatus/db/src/schema";
import { getLimits } from "@openstatus/db/src/schema/plan/utils";
import { afterAll, beforeAll, describe, expect, test } from "vitest";

import {
  expectAuditRow,
  createWorkspaceFixture,
  makeApiKeyCtx,
  makeUserCtx,
  withTestTransaction,
} from "../../../test/helpers";
import type { ServiceContext } from "../../context";
import {
  ForbiddenError,
  LimitExceededError,
  NotFoundError,
  ValidationError,
} from "../../errors";
import { createNotification } from "../create";
import { deleteNotification } from "../delete";
import { getNotification, listNotifications } from "../list";
import { updateNotification } from "../update";

const TEST_PREFIX = "svc-notification-test";

let teamCtx: ServiceContext;
let freeCtx: ServiceContext;
let teamMonitorId: number;

// Dedicated, freshly-inserted free-plan workspace for the quota-sensitive
// negative-path tests (`notification-channels: 1`). The shared seeded free
// workspace (#2) is written concurrently by the apps/server RPC suites under
// parallel test execution, which intermittently exhausts the quota and fails
// the wrong assertion. An isolated workspace removes that cross-suite race;
// every test writes inside a rolled-back transaction, so its committed
// notification count stays at zero for the whole suite.
const FREE_WS_SLUG = `${TEST_PREFIX}-free-ws`;

beforeAll(async () => {
  const team = (await createWorkspaceFixture("team")).workspace;
  teamCtx = makeUserCtx(team, { userId: 1 });

  await db
    .delete(workspace)
    .where(eq(workspace.slug, FREE_WS_SLUG))
    .catch(() => undefined);
  const freeRow = await db
    .insert(workspace)
    .values({
      slug: FREE_WS_SLUG,
      name: `${TEST_PREFIX}-free`,
      plan: "free",
      limits: JSON.stringify(getLimits("free")),
    })
    .returning()
    .get();
  freeCtx = makeUserCtx(selectWorkspaceSchema.parse(freeRow), { userId: 2 });

  const monitorRow = await db
    .insert(monitor)
    .values({
      workspaceId: team.id,
      active: true,
      url: "https://example.com",
      name: `${TEST_PREFIX}-monitor`,
      method: "GET",
      periodicity: "10m",
      regions: "ams",
    })
    .returning()
    .get();
  teamMonitorId = monitorRow.id;
});

afterAll(async () => {
  await db
    .delete(monitor)
    .where(eq(monitor.id, teamMonitorId))
    .catch(() => undefined);
  await db
    .delete(workspace)
    .where(eq(workspace.slug, FREE_WS_SLUG))
    .catch(() => undefined);
});

describe("createNotification", () => {
  test("creates a discord channel with monitors + audits", async () => {
    await withTestTransaction(async (tx) => {
      const ctx = { ...teamCtx, db: tx };
      const row = await createNotification({
        ctx,
        input: {
          name: `${TEST_PREFIX}-discord`,
          provider: "discord",
          data: { discord: "https://discord.com/api/webhooks/1/abc" },
          monitors: [teamMonitorId],
        },
      });
      expect(row.provider).toBe("discord");

      const assoc = await tx
        .select()
        .from(notificationsToMonitors)
        .where(eq(notificationsToMonitors.notificationId, row.id))
        .all();
      expect(assoc.map((a) => a.monitorId)).toEqual([teamMonitorId]);

      await expectAuditRow({
        workspaceId: teamCtx.workspace.id,
        action: "notification.create",
        entityType: "notification",
        entityId: row.id,
        db: tx,
      });
    });
  });

  test("throws ValidationError for malformed data", async () => {
    await withTestTransaction(async (tx) => {
      await expect(
        createNotification({
          ctx: { ...teamCtx, db: tx },
          input: {
            name: `${TEST_PREFIX}-bad`,
            provider: "discord",
            // missing the required `discord` key
            data: {},
            monitors: [],
          },
        }),
      ).rejects.toBeInstanceOf(ValidationError);
    });
  });

  test("throws ValidationError when data payload key doesn't match provider", async () => {
    await withTestTransaction(async (tx) => {
      await expect(
        createNotification({
          ctx: { ...teamCtx, db: tx },
          input: {
            name: `${TEST_PREFIX}-mismatch`,
            provider: "discord",
            // Valid slack payload, but provider is discord → rejected.
            data: { slack: "https://hooks.slack.com/services/x/y/z" },
            monitors: [],
          },
        }),
      ).rejects.toBeInstanceOf(ValidationError);
    });
  });

  test("throws ValidationError when provider payload is malformed but another provider's is valid", async () => {
    await withTestTransaction(async (tx) => {
      // The canonical data schema for the selected provider must match.
      // A plain key-presence check would have missed this: `discord: "not-a-url"`
      // fails `urlSchema`, but a valid `slack` field could've hidden it.
      await expect(
        createNotification({
          ctx: { ...teamCtx, db: tx },
          input: {
            name: `${TEST_PREFIX}-invalid-payload`,
            provider: "discord",
            data: {
              discord: "not-a-url",
              slack: "https://hooks.slack.com/services/x/y/z",
            },
            monitors: [],
          },
        }),
      ).rejects.toBeInstanceOf(ValidationError);
    });
  });

  test("throws LimitExceededError when plan blocks the provider", async () => {
    await withTestTransaction(async (tx) => {
      // free plan has `pagerduty: false`.
      await expect(
        createNotification({
          ctx: { ...freeCtx, db: tx },
          input: {
            name: `${TEST_PREFIX}-gated`,
            provider: "pagerduty",
            data: {
              pagerduty: JSON.stringify({
                integration_keys: [{ id: "k1", integration_key: "x" }],
              }),
            },
            monitors: [],
          },
        }),
      ).rejects.toBeInstanceOf(LimitExceededError);
    });
  });

  test("throws ValidationError for deprecated sms before quota and plan gates", async () => {
    await withTestTransaction(async (tx) => {
      const grandfathered = {
        ...teamCtx,
        workspace: {
          ...teamCtx.workspace,
          // quota 0 proves the guard runs before assertWithinLimit
          limits: {
            ...teamCtx.workspace.limits,
            sms: true,
            "notification-channels": 0,
          },
        },
        db: tx,
      };
      await expect(
        createNotification({
          ctx: grandfathered,
          input: {
            name: `${TEST_PREFIX}-deprecated-sms`,
            provider: "sms",
            data: { sms: "+10000000000" },
            monitors: [],
          },
        }),
      ).rejects.toBeInstanceOf(ValidationError);
    });
  });

  test("rejects read-only actor", async () => {
    await withTestTransaction(async (tx) => {
      const readOnlyCtx = {
        ...makeApiKeyCtx(teamCtx.workspace, {
          keyId: "k-read",
          userId: 1,
          scopes: ["read"],
        }),
        db: tx,
      };
      await expect(
        createNotification({
          ctx: readOnlyCtx,
          input: {
            name: `${TEST_PREFIX}-read-only`,
            provider: "discord",
            data: { discord: "https://discord.com/api/webhooks/1/abc" },
            monitors: [],
          },
        }),
      ).rejects.toBeInstanceOf(ForbiddenError);
    });
  });

  test("throws ForbiddenError for cross-workspace monitor", async () => {
    await withTestTransaction(async (tx) => {
      await expect(
        createNotification({
          ctx: { ...freeCtx, db: tx },
          input: {
            name: `${TEST_PREFIX}-cross-ws`,
            provider: "discord",
            data: { discord: "https://discord.com/api/webhooks/1/abc" },
            monitors: [teamMonitorId], // team's monitor
          },
        }),
      ).rejects.toBeInstanceOf(ForbiddenError);
    });
  });
});

describe("updateNotification", () => {
  test("replaces name / data / monitor associations", async () => {
    await withTestTransaction(async (tx) => {
      const ctx = { ...teamCtx, db: tx };
      const row = await createNotification({
        ctx,
        input: {
          name: `${TEST_PREFIX}-update`,
          provider: "discord",
          data: { discord: "https://discord.com/api/webhooks/1/abc" },
          monitors: [teamMonitorId],
        },
      });

      const updated = await updateNotification({
        ctx,
        input: {
          id: row.id,
          name: `${TEST_PREFIX}-update-renamed`,
          data: { discord: "https://discord.com/api/webhooks/2/def" },
          monitors: [],
        },
      });
      expect(updated.name).toBe(`${TEST_PREFIX}-update-renamed`);

      const assoc = await tx
        .select()
        .from(notificationsToMonitors)
        .where(eq(notificationsToMonitors.notificationId, row.id))
        .all();
      expect(assoc).toHaveLength(0);
    });
  });

  test("throws NotFoundError for cross-workspace update", async () => {
    await withTestTransaction(async (tx) => {
      const row = await createNotification({
        ctx: { ...teamCtx, db: tx },
        input: {
          name: `${TEST_PREFIX}-cross-ws-update`,
          provider: "discord",
          data: { discord: "https://discord.com/api/webhooks/1/abc" },
          monitors: [],
        },
      });

      await expect(
        updateNotification({
          ctx: { ...freeCtx, db: tx },
          input: {
            id: row.id,
            name: "blocked",
            data: { discord: "https://discord.com/api/webhooks/x/y" },
            monitors: [],
          },
        }),
      ).rejects.toBeInstanceOf(NotFoundError);
    });
  });

  test("emits a notification.update audit row", async () => {
    await withTestTransaction(async (tx) => {
      const ctx = { ...teamCtx, db: tx };
      const row = await createNotification({
        ctx,
        input: {
          name: `${TEST_PREFIX}-update-audit`,
          provider: "discord",
          data: { discord: "https://discord.com/api/webhooks/1/abc" },
          monitors: [],
        },
      });

      await updateNotification({
        ctx,
        input: {
          id: row.id,
          name: `${TEST_PREFIX}-update-audit-renamed`,
          data: { discord: "https://discord.com/api/webhooks/2/def" },
          monitors: [],
        },
      });

      await expectAuditRow({
        workspaceId: teamCtx.workspace.id,
        action: "notification.update",
        entityType: "notification",
        entityId: row.id,
        db: tx,
      });
    });
  });

  test("throws LimitExceededError when plan gate blocks update", async () => {
    await withTestTransaction(async (tx) => {
      // Regression for the post-downgrade case: the row was created on a
      // plan that allowed pagerduty, but the current workspace no longer
      // does. The pre-fix update flow never re-checked the gate, so an
      // editable form field remained open to channels the plan had since
      // revoked. Simulate it by bypassing the create-time gate with a
      // direct db insert bound to the free workspace.
      const [inserted] = await tx
        .insert(notification)
        .values({
          workspaceId: freeCtx.workspace.id,
          name: `${TEST_PREFIX}-downgrade-gate`,
          provider: "pagerduty",
          data: JSON.stringify({
            pagerduty: JSON.stringify({
              integration_keys: [{ id: "k1", integration_key: "x" }],
            }),
          }),
        })
        .returning();
      if (!inserted) throw new Error("direct insert failed");

      await expect(
        updateNotification({
          ctx: { ...freeCtx, db: tx },
          input: {
            id: inserted.id,
            name: "would-be-rename",
            data: {
              pagerduty: JSON.stringify({
                integration_keys: [{ id: "k1", integration_key: "y" }],
              }),
            },
            monitors: [],
          },
        }),
      ).rejects.toBeInstanceOf(LimitExceededError);
    });
  });

  test("keeps a deprecated sms channel editable when the plan flag is off", async () => {
    await withTestTransaction(async (tx) => {
      const [inserted] = await tx
        .insert(notification)
        .values({
          workspaceId: freeCtx.workspace.id,
          name: `${TEST_PREFIX}-deprecated-sms`,
          provider: "sms",
          data: JSON.stringify({ sms: "+10000000000" }),
        })
        .returning();
      if (!inserted) throw new Error("direct insert failed");

      const updated = await updateNotification({
        ctx: { ...freeCtx, db: tx },
        input: {
          id: inserted.id,
          name: `${TEST_PREFIX}-deprecated-sms-renamed`,
          data: { sms: "+10000000000" },
          monitors: [],
        },
      });

      expect(updated.name).toBe(`${TEST_PREFIX}-deprecated-sms-renamed`);
    });
  });
});

describe("deleteNotification", () => {
  test("removes the row", async () => {
    await withTestTransaction(async (tx) => {
      const ctx = { ...teamCtx, db: tx };
      const row = await createNotification({
        ctx,
        input: {
          name: `${TEST_PREFIX}-delete`,
          provider: "discord",
          data: { discord: "https://discord.com/api/webhooks/1/abc" },
          monitors: [],
        },
      });

      await deleteNotification({ ctx, input: { id: row.id } });

      const remaining = await tx
        .select()
        .from(notification)
        .where(eq(notification.id, row.id))
        .all();
      expect(remaining).toHaveLength(0);
    });
  });
});

describe("list / get", () => {
  test("list returns enriched monitors scoped to the workspace", async () => {
    await withTestTransaction(async (tx) => {
      const teamCtxTx = { ...teamCtx, db: tx };
      const freeCtxTx = { ...freeCtx, db: tx };
      const row = await createNotification({
        ctx: teamCtxTx,
        input: {
          name: `${TEST_PREFIX}-enrich`,
          provider: "discord",
          data: { discord: "https://discord.com/api/webhooks/1/abc" },
          monitors: [teamMonitorId],
        },
      });

      const full = await getNotification({
        ctx: teamCtxTx,
        input: { id: row.id },
      });
      expect(full.monitors.map((m) => m.id)).toEqual([teamMonitorId]);

      await expect(
        getNotification({ ctx: freeCtxTx, input: { id: row.id } }),
      ).rejects.toBeInstanceOf(NotFoundError);

      const { items: freeItems } = await listNotifications({
        ctx: freeCtxTx,
        input: { limit: 100, offset: 0, order: "desc" },
      });
      expect(freeItems.find((n) => n.id === row.id)).toBeUndefined();
    });
  });
});

describe("notification-channel count quota", () => {
  const input = (name: string) => ({
    name,
    provider: "email" as const,
    data: { email: `${name}@openstatus.dev` },
    monitors: [],
  });

  test("createNotification rejects once the plan's channel cap is spent", async () => {
    await withTestTransaction(async (tx) => {
      // Free plan caps notification channels at 1.
      const ctx = { ...freeCtx, db: tx };
      await createNotification({ ctx, input: input(`${TEST_PREFIX}-cap-1`) });

      await expect(
        createNotification({ ctx, input: input(`${TEST_PREFIX}-cap-2`) }),
      ).rejects.toBeInstanceOf(LimitExceededError);
    });
  });
});