import type { LoaderFunctionArgs } from "react-router"; import { beforeEach, describe, expect, it, vi } from "vitest"; vi.mock("~/modules/api/services/ApiSpecsService", () => ({ default: { generateSpecs: vi.fn(async () => ({ openApi: { openapi: "3.1.0" }, postmanCollection: { info: {}, item: [] }, apiDocsUrl: "https://api.example.com/v1/docs", })), }, })); vi.mock("~/utils/db/appConfiguration.db.server", () => ({ getAppConfiguration: vi.fn(async () => ({ app: { features: { tenantApiKeys: true } } })), })); vi.mock("~/utils/helpers/.server/PermissionsService", () => ({ verifyUserHasPermission: vi.fn(async () => undefined) })); vi.mock("~/utils/services/.server/urlService", () => ({ getTenantIdFromUrl: vi.fn(async () => "tenant-1") })); vi.mock("~/locale/i18next.server", () => ({ getTranslations: vi.fn(async () => ({ t: (key: string) => (key === "settings.api.errors.tenantApiKeysNotEnabled" ? "API keys are not enabled" : key), })), })); import ApiSpecsService from "~/modules/api/services/ApiSpecsService"; import { getTranslations } from "~/locale/i18next.server"; import { getAppConfiguration } from "~/utils/db/appConfiguration.db.server"; import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService"; import { getTenantIdFromUrl } from "~/utils/services/.server/urlService"; import { loader } from "./docs"; describe("tenant API docs route", () => { beforeEach(() => { vi.clearAllMocks(); vi.mocked(getTenantIdFromUrl).mockResolvedValue("tenant-1"); vi.mocked(getAppConfiguration).mockResolvedValue({ app: { features: { tenantApiKeys: true } } } as never); vi.mocked(verifyUserHasPermission).mockResolvedValue(undefined as never); }); it("checks tenant permission and feature gate before generating docs", async () => { const request = new Request("https://app.example.com/acme/settings/api/docs"); const data = await loader({ request, params: { tenant: "acme" }, context: {} } as unknown as LoaderFunctionArgs); expect(getTenantIdFromUrl).toHaveBeenCalledWith({ tenant: "acme" }); expect(verifyUserHasPermission).toHaveBeenCalledWith(request, "app.settings.apiKeys.view", "tenant-1"); expect(getAppConfiguration).toHaveBeenCalledWith({ request }); expect(ApiSpecsService.generateSpecs).toHaveBeenCalledWith({ request }); expect(data).toMatchObject({ apiSpecs: { apiDocsUrl: "https://api.example.com/v1/docs" } }); expect(vi.mocked(verifyUserHasPermission).mock.invocationCallOrder[0]).toBeLessThan( vi.mocked(ApiSpecsService.generateSpecs).mock.invocationCallOrder[0] ); }); it("does not generate docs when tenant API keys are disabled", async () => { vi.mocked(getAppConfiguration).mockResolvedValue({ app: { features: { tenantApiKeys: false } } } as never); try { await loader({ request: new Request("https://app.example.com/acme/settings/api/docs"), params: { tenant: "acme" }, context: {} } as never); throw new Error("Expected loader to throw"); } catch (error) { expect(error).toBeInstanceOf(Response); const response = error as Response; expect(response.status).toBe(404); await expect(response.json()).resolves.toEqual({ error: "API keys are not enabled" }); } expect(getTranslations).toHaveBeenCalledWith(expect.any(Request)); expect(ApiSpecsService.generateSpecs).not.toHaveBeenCalled(); }); });