Open Administration on a dashboard of what the role can read

Administration used to open on its first section. It opens on a grid of cards now: users, domains, messages waiting in the delivery queue, server memory, and the last 24 hours' received and sent. Each card is there only when the role holds what its number needs -- a count is a query, the metric history a query and a get -- so a helpdesk role that reads accounts and domains sees those two cards and nothing about the server. What the cards count is whatever Stalwart answers for the signed-in account, which scopes a tenant administrator's accounts, domains and queue to the tenancy. The metric history has no tenant in it, and Stalwart's Tenant Administrator role does not hold it, so a tenant's dashboard is users, domains and pending. The history is Enterprise-only and switched off by default. A server that refuses it leaves those cards off; one that records nothing says so rather than showing zeroes. Received and sent add up the queue counters Stalwart's own dashboard uses, filtered with the comparison names the live server accepts (a bare timestamp is unsupportedFilter). The column count follows the number of cards so rows stay even, and falls back by the grid's own width rather than the window's. The server's test for whether an account is offered Administration matches the client's again, now that a count is enough. The mock answers the queue and an hourly history ending in the current hour; MOCK_METRICS=off refuses the history as Community does, a tenant administrator gets the queue, and helpdesk reads domains, as the demo's does. ROADMAP and FEATURES said reporting and queues were out of scope; they say the dashboard reads a handful of numbers and that managing queues, logs and settings stays out. KNOWN-ISSUES records what was settled on the live server and what was only read from source. Fourteen new strings, in all nine catalogues.
2026-09-15 08:06:59 -07:00
parent bb8d6eb92d
commit 0054b8a3ce
28 changed files with 838 additions and 37 deletions
@@ -0,0 +1,113 @@
+import { act } from "react";
+import { createRoot, type Root } from "react-dom/client";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { Router } from "wouter";
+import { memoryLocation } from "wouter/memory-location";
+import { JmapMethodError } from "@/jmap/client";
+import { useSession } from "@/store/session";
+import type { JmapSession } from "@/jmap/types";
+import type { MetricRecord } from "@/lib/adminDashboard";
+
+(globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
+
+const feeds = vi.hoisted(() => ({
+  counts: { Account: 35, Domain: 3, QueuedMessage: 9 } as Record<string, number>,
+  metrics: (): Promise<MetricRecord[]> => Promise.resolve([]),
+}));
+
+vi.mock("@/lib/adminDashboard", async (original) => ({
+  ...(await original<typeof import("@/lib/adminDashboard")>()),
+  countObjects: vi.fn(async (object: string) => feeds.counts[object]),
+  loadMetrics: vi.fn(() => feeds.metrics()),
+}));
+
+const { AdminDashboard } = await import("../AdminDashboard");
+
+const signIn = (permissions: string[]) =>
+  useSession.setState({ session: { capabilities: {}, accounts: {}, primaryAccounts: {}, username: "[email protected]", ihasmail: { permissions } } as unknown as JmapSession });
+
+const HELPDESK = ["sysAccountGet", "sysAccountQuery", "sysAccountUpdate", "sysDomainGet", "sysDomainQuery"];
+const TENANT = [...HELPDESK, "sysAccountCreate", "sysDomainCreate", "sysQueuedMessageGet", "sysQueuedMessageQuery"];
+const ADMIN = [...TENANT, "sysMetricGet", "sysMetricQuery"];
+
+/** The dashboard shows what the role may read, and nothing a server refuses. */
+describe("the Administration dashboard", () => {
+  let host: HTMLDivElement;
+  let root: Root;
+  const render = async () => {
+    const { hook } = memoryLocation({ path: "/admin" });
+    await act(async () => {
+      root.render(<Router hook={hook}><AdminDashboard /></Router>);
+    });
+    await act(async () => {});
+  };
+  const cards = () => [...host.querySelectorAll(".admin-card")].map((c) => [c.querySelector(".admin-card-label")?.textContent, c.querySelector(".admin-card-value")?.textContent, c.querySelector(".hint")?.textContent]);
+  beforeEach(() => {
+    host = document.createElement("div");
+    document.body.appendChild(host);
+    root = createRoot(host);
+    feeds.metrics = () => Promise.resolve([]);
+  });
+  afterEach(async () => {
+    await act(async () => root.unmount());
+    host.remove();
+  });
+
+  it("gives a helpdesk role its two counts and nothing about the server", async () => {
+    signIn(HELPDESK);
+    await render();
+    expect(cards()).toEqual([
+      ["Users", "35", "User accounts"],
+      ["Domains", "3", "Mail domains"],
+    ]);
+  });
+
+  it("gives a tenant administrator the queue as well, but no history", async () => {
+    signIn(TENANT);
+    await render();
+    expect(cards().map((c) => c[0])).toEqual(["Users", "Domains", "Pending"]);
+  });
+
+  it("adds the history for a role that reads metrics", async () => {
+    feeds.metrics = () =>
+      Promise.resolve([
+        { "@type": "Gauge", metric: "server.memory", count: 360_000_000, timestamp: "2026-09-15T15:00:00Z" },
+        { "@type": "Counter", metric: "queue.message-queued", count: 93, timestamp: "2026-09-15T15:00:00Z" },
+        { "@type": "Counter", metric: "queue.report-queued", count: 39, timestamp: "2026-09-15T15:00:00Z" },
+      ]);
+    signIn(ADMIN);
+    await render();
+    expect(cards().map((c) => [c[0], c[1]])).toEqual([
+      ["Users", "35"],
+      ["Domains", "3"],
+      ["Pending", "9"],
+      ["Server memory", "343 MB"],
+      ["Received", "93"],
+      ["Sent", "39"],
+    ]);
+  });
+
+  it("leaves the history off where the server refuses it, as Community does", async () => {
+    feeds.metrics = () => Promise.reject(new JmapMethodError("x:Metric/query", { type: "forbidden", description: "This feature is only available in the Enterprise edition" }));
+    signIn(ADMIN);
+    await render();
+    expect(cards().map((c) => c[0])).toEqual(["Users", "Domains", "Pending"]);
+  });
+
+  it("says the history is not recorded rather than showing a quiet day", async () => {
+    signIn(ADMIN);
+    await render();
+    expect(cards().slice(3)).toEqual([
+      ["Server memory", "—", "Not recorded on this server"],
+      ["Received", "—", "Not recorded on this server"],
+      ["Sent", "—", "Not recorded on this server"],
+    ]);
+  });
+
+  it("keeps a card that failed for another reason, and says so", async () => {
+    feeds.metrics = () => Promise.reject(new Error("offline"));
+    signIn(ADMIN);
+    await render();
+    expect(cards()[4]).toEqual(["Received", "—", "Could not be loaded"]);
+  });
+});