Files
HiveGrid-Wireframes/hivegrid-cloud/apps/web/app/routes/app.$tenant/settings/logs/index.test.tsx
T

176 lines
7.1 KiB
TypeScript

// @vitest-environment node
import { beforeEach, describe, expect, it, vi } from "vitest";
import type { LoaderFunctionArgs } from "react-router";
import { loader } from "./index";
import { getTenantAuditLogList, serializeAdminAuditLogsCsv } from "@toolctrl/db/logs.server";
import { getTranslations } from "~/locale/i18next.server";
import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService";
import { getTenantIdFromUrl } from "~/utils/services/.server/urlService";
import { readRepoFile } from "~/utils/testing/repoPaths";
vi.mock("react-i18next", () => ({
useTranslation: () => ({ t: (key: string) => key }),
}));
vi.mock("react-router", async () => {
const actual = await vi.importActual<typeof import("react-router")>("react-router");
return {
...actual,
Link: () => null,
useLoaderData: () => ({}),
useParams: () => ({ tenant: "acme" }),
};
});
vi.mock("~/components/activity/TenantActivityLogToolbar", () => ({ default: () => null }));
vi.mock("~/components/app/events/LogsTable", () => ({ default: () => null }));
vi.mock("~/components/ui/layouts/EditPageLayout", () => ({ default: () => null }));
vi.mock("~/components/ui/tabs/Tabs", () => ({ default: () => null }));
vi.mock("~/locale/i18next.server", () => ({
getTranslations: vi.fn(),
}));
vi.mock("~/utils/helpers/.server/PermissionsService", () => ({
verifyUserHasPermission: vi.fn(),
}));
vi.mock("~/utils/services/.server/urlService", () => ({
getTenantIdFromUrl: vi.fn(),
}));
vi.mock("@toolctrl/db/logs.server", () => ({
getTenantAuditLogList: vi.fn(),
serializeAdminAuditLogsCsv: vi.fn(),
}));
const params = { tenant: "acme" };
const auditRows = [
{
id: "log-1",
createdAt: new Date("2026-05-08T10:00:00.000Z"),
tenantId: "tenant-1",
userId: "user-1",
apiKeyId: null,
action: "create",
url: "/acme/contacts",
details: "redacted details",
rowId: null,
commentId: null,
tenant: { id: "tenant-1", name: "Acme", slug: "acme" },
user: { id: "user-1", email: "admin@example.test", firstName: "Ada", lastName: "Admin" },
apiKey: null,
comment: null,
},
];
function callLoader(url: string) {
const request = new Request(url);
return loader({ request, params, context: {}, unstable_pattern: "app.$tenant/settings/logs" } as LoaderFunctionArgs);
}
function readTenantLogsRoute() {
return readRepoFile("apps/web/app/routes/app.$tenant/settings/logs/index.tsx");
}
describe("tenant settings logs route", () => {
beforeEach(() => {
vi.clearAllMocks();
process.env.APP_NAME = "ToolCTRL";
vi.mocked(getTenantIdFromUrl).mockResolvedValue("tenant-1");
vi.mocked(verifyUserHasPermission).mockResolvedValue(undefined as never);
vi.mocked(getTranslations).mockResolvedValue({ t: (key: string) => `translated:${key}` } as never);
vi.mocked(getTenantAuditLogList).mockResolvedValue({ rows: auditRows, total: 1, take: 25, skip: 25 } as never);
vi.mocked(serializeAdminAuditLogsCsv).mockReturnValue("csv-body\n");
});
it("checks permission before reading the tenant-scoped filtered table data", async () => {
const data = await callLoader(
"https://app.example.test/acme/settings/logs?q=contact&action=create&url=%2Fcontacts&tenantId=other-tenant&userId=user-1&createdAtFrom=2026-05-01&createdAtTo=2026-05-08&page=2&pageSize=25",
);
expect(getTenantIdFromUrl).toHaveBeenCalledWith(params);
expect(verifyUserHasPermission).toHaveBeenCalledWith(expect.any(Request), "app.settings.auditTrails.view", "tenant-1");
expect(vi.mocked(verifyUserHasPermission).mock.invocationCallOrder[0]).toBeLessThan(vi.mocked(getTenantAuditLogList).mock.invocationCallOrder[0]);
expect(getTenantAuditLogList).toHaveBeenCalledWith("tenant-1", {
q: "contact",
action: "create",
url: "/contacts",
userId: "user-1",
createdAtFrom: "2026-05-01",
createdAtTo: "2026-05-08",
take: 25,
skip: 25,
});
expect(JSON.stringify(vi.mocked(getTenantAuditLogList).mock.calls[0]?.[1])).not.toContain("other-tenant");
expect(data).toMatchObject({
title: "translated:models.log.plural | ToolCTRL",
items: auditRows,
pagination: { page: 2, pageSize: 25, totalItems: 1, totalPages: 1 },
});
});
it("exports CSV with the same tenant filters and a capped export window", async () => {
const response = (await callLoader(
"https://app.example.test/acme/settings/logs?export=csv&q=login&action=auth&url=%2Flogin&tenantId=other-tenant&userId=user-2&createdAtFrom=bad-date&createdAtTo=2026-05-08&page=9&pageSize=5",
)) as Response;
expect(verifyUserHasPermission).toHaveBeenCalledWith(expect.any(Request), "app.settings.auditTrails.view", "tenant-1");
expect(vi.mocked(verifyUserHasPermission).mock.invocationCallOrder[0]).toBeLessThan(vi.mocked(getTenantAuditLogList).mock.invocationCallOrder[0]);
expect(getTenantAuditLogList).toHaveBeenCalledWith("tenant-1", {
q: "login",
action: "auth",
url: "/login",
userId: "user-2",
createdAtFrom: "bad-date",
createdAtTo: "2026-05-08",
take: 500,
skip: 0,
});
expect(JSON.stringify(vi.mocked(getTenantAuditLogList).mock.calls[0]?.[1])).not.toContain("other-tenant");
expect(serializeAdminAuditLogsCsv).toHaveBeenCalledWith(auditRows);
expect(response.headers.get("Content-Type")).toBe("text/csv; charset=utf-8");
expect(response.headers.get("Content-Disposition")).toBe('attachment; filename="tenant-audit-logs.csv"');
expect(await response.text()).toBe("csv-body\n");
});
it("rejects table and CSV reads without permission before helper calls", async () => {
const rejection = new Response("Forbidden", { status: 403 });
vi.mocked(verifyUserHasPermission).mockRejectedValue(rejection as never);
await expect(callLoader("https://app.example.test/acme/settings/logs?export=csv")).rejects.toBe(rejection);
expect(getTenantAuditLogList).not.toHaveBeenCalled();
expect(serializeAdminAuditLogsCsv).not.toHaveBeenCalled();
});
it("does not crash on malformed numeric and date filters", async () => {
vi.mocked(getTenantAuditLogList).mockResolvedValue({ rows: [], total: 0, take: 10, skip: 0 } as never);
const data = await callLoader("https://app.example.test/acme/settings/logs?page=abc&pageSize=-5&createdAtFrom=not-a-date&createdAtTo=also-bad");
expect(getTenantAuditLogList).toHaveBeenCalledWith("tenant-1", {
q: null,
action: null,
url: null,
userId: null,
createdAtFrom: "not-a-date",
createdAtTo: "also-bad",
take: 10,
skip: 0,
});
expect(data).toMatchObject({ pagination: { page: 1, pageSize: 10, totalItems: 0, totalPages: 0 } });
});
it("uses the package audit-log boundary instead of the legacy app DB helper", () => {
const source = readTenantLogsRoute();
expect(source).toContain('from "@toolctrl/db/logs.server"');
expect(source).toContain("getTenantAuditLogList");
expect(source).toContain("serializeAdminAuditLogsCsv");
expect(source).toContain("TenantActivityLogToolbar");
expect(source).not.toContain("getLogs");
expect(source).not.toContain('from "~/utils/db/logs.db.server"');
});
});