Track HiveGrid Cloud planning reference
This commit is contained in:
1 parent
b3d5ea6764
commit
e341c5938a
5784 files changed
+1104929
-3
No files matched your search
@@ -0,0 +1,225 @@
|
||||
// @vitest-environment node
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import type { ActionFunctionArgs } from "react-router";
|
||||
|
||||
vi.mock("~/locale/i18next.server", () => ({
|
||||
getTranslations: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/services/.server/urlService", () => ({
|
||||
getTenantIdFromUrl: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/helpers/.server/PermissionsService", () => ({
|
||||
verifyUserHasPermission: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/session.server", () => ({
|
||||
getUserInfo: vi.fn(),
|
||||
validateCSRFToken: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/db/tenants.db.server", () => ({
|
||||
getTenant: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/db/users.db.server", () => ({
|
||||
getUser: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/db/apiKeys.db.server", () => ({
|
||||
countApiKeyLogsForKey: vi.fn(),
|
||||
deleteApiKey: vi.fn(),
|
||||
getApiKeys: vi.fn(),
|
||||
getTenantApiKeyById: vi.fn(),
|
||||
rotateApiKey: vi.fn(),
|
||||
updateApiKey: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/db/logs.db.server", () => ({
|
||||
createLog: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/helpers/.server/ApiKeyHelperService", () => ({
|
||||
getApiKeyEntityPermissions: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/modules/events/services/.server/EventsService", () => ({
|
||||
default: { create: vi.fn() },
|
||||
}));
|
||||
vi.mock("~/utils/app/UrlUtils", () => ({
|
||||
default: { currentTenantUrl: vi.fn((_params: Record<string, string | undefined>, path: string) => `/acme/${path}`) },
|
||||
}));
|
||||
vi.mock("~/components/core/apiKeys/ApiKeyCreatedModal", () => ({ default: () => null }));
|
||||
vi.mock("~/components/core/apiKeys/ApiKeyForm", () => ({ default: () => null }));
|
||||
vi.mock("~/components/ui/modals/OpenModal", () => ({ default: ({ children }: { children: React.ReactNode }) => children }));
|
||||
vi.mock("~/utils/data/useAppData", () => ({ useAppData: () => ({ entities: [] }) }));
|
||||
vi.mock("~/utils/helpers/PermissionsHelper", () => ({ getUserHasPermission: vi.fn(() => true) }));
|
||||
|
||||
import EventsService from "~/modules/events/services/.server/EventsService";
|
||||
import { getTranslations } from "~/locale/i18next.server";
|
||||
import { countApiKeyLogsForKey, deleteApiKey, getApiKeys, getTenantApiKeyById, rotateApiKey, updateApiKey } from "~/utils/db/apiKeys.db.server";
|
||||
import { createLog } from "~/utils/db/logs.db.server";
|
||||
import { getTenant } from "~/utils/db/tenants.db.server";
|
||||
import { getUser } from "~/utils/db/users.db.server";
|
||||
import { getApiKeyEntityPermissions } from "~/utils/helpers/.server/ApiKeyHelperService";
|
||||
import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService";
|
||||
import { getTenantIdFromUrl } from "~/utils/services/.server/urlService";
|
||||
import { getUserInfo, validateCSRFToken } from "~/utils/session.server";
|
||||
import { action } from "./$id";
|
||||
|
||||
const params = { tenant: "acme", id: "api-key-1" };
|
||||
const tenant = { id: "tenant-1", name: "Acme", slug: "acme" };
|
||||
const user = { id: "user-1", email: "ada@example.test" };
|
||||
const entityPermission = { entityId: "entity-1", create: true, read: true, update: false, delete: false };
|
||||
const existingApiKey = {
|
||||
id: "api-key-1",
|
||||
tenantId: "tenant-1",
|
||||
alias: "Primary integration",
|
||||
expires: null,
|
||||
active: true,
|
||||
entities: [entityPermission],
|
||||
};
|
||||
const rotatedApiKey = { ...existingApiKey, key: "tc_live_rotated_plaintext_once" };
|
||||
|
||||
function createRequest(form: FormData) {
|
||||
return new Request("https://app.example.test/acme/settings/api/keys/api-key-1", {
|
||||
method: "POST",
|
||||
headers: { "Content-Type": "application/x-www-form-urlencoded" },
|
||||
body: new URLSearchParams(form as unknown as Record<string, string>),
|
||||
});
|
||||
}
|
||||
|
||||
function createForm(actionName: "edit" | "delete" | "rotate" = "edit", overrides: Record<string, string> = {}) {
|
||||
const form = new FormData();
|
||||
form.set("action", actionName);
|
||||
form.set("alias", "Primary integration updated");
|
||||
form.set("active", "on");
|
||||
form.append("entities[]", JSON.stringify(entityPermission));
|
||||
Object.entries(overrides).forEach(([key, value]) => form.set(key, value));
|
||||
return form;
|
||||
}
|
||||
|
||||
async function callAction(form: FormData) {
|
||||
return action({
|
||||
request: createRequest(form),
|
||||
params,
|
||||
context: {},
|
||||
unstable_pattern: "app.$tenant/settings/api/keys/$id",
|
||||
} as ActionFunctionArgs) as Promise<Response>;
|
||||
}
|
||||
|
||||
async function responseJson(response: Response) {
|
||||
return response.json() as Promise<Record<string, unknown>>;
|
||||
}
|
||||
|
||||
describe("tenant API key edit route", () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
vi.mocked(getTranslations).mockResolvedValue({ t: (key: string) => `translated:${key}` } as never);
|
||||
vi.mocked(getTenantIdFromUrl).mockResolvedValue("tenant-1");
|
||||
vi.mocked(verifyUserHasPermission).mockResolvedValue(undefined as never);
|
||||
vi.mocked(getUserInfo).mockResolvedValue({ userId: "user-1" } as never);
|
||||
vi.mocked(validateCSRFToken).mockResolvedValue(undefined as never);
|
||||
vi.mocked(getTenant).mockResolvedValue(tenant as never);
|
||||
vi.mocked(getUser).mockResolvedValue(user as never);
|
||||
vi.mocked(getTenantApiKeyById).mockResolvedValue(existingApiKey as never);
|
||||
vi.mocked(getApiKeys).mockResolvedValue([existingApiKey] as never);
|
||||
vi.mocked(updateApiKey).mockResolvedValue({ ...existingApiKey, alias: "Primary integration updated" } as never);
|
||||
vi.mocked(rotateApiKey).mockResolvedValue(rotatedApiKey as never);
|
||||
vi.mocked(deleteApiKey).mockResolvedValue(existingApiKey as never);
|
||||
vi.mocked(countApiKeyLogsForKey).mockResolvedValue(0 as never);
|
||||
vi.mocked(getApiKeyEntityPermissions).mockImplementation(async (permissions) => permissions as never);
|
||||
vi.mocked(EventsService.create).mockResolvedValue(undefined as never);
|
||||
vi.mocked(createLog).mockResolvedValue({} as never);
|
||||
});
|
||||
|
||||
it("rejects keys outside the tenant scope before update, rotation, or delete", async () => {
|
||||
vi.mocked(getTenantApiKeyById).mockResolvedValue(null as never);
|
||||
|
||||
for (const actionName of ["edit", "rotate", "delete"] as const) {
|
||||
const response = await callAction(createForm(actionName));
|
||||
const data = await responseJson(response);
|
||||
|
||||
expect(response.status).toBe(400);
|
||||
expect(data).toEqual({ error: "translated:shared.notFound" });
|
||||
}
|
||||
|
||||
expect(updateApiKey).not.toHaveBeenCalled();
|
||||
expect(rotateApiKey).not.toHaveBeenCalled();
|
||||
expect(deleteApiKey).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("returns one-time plaintext only after successful rotation", async () => {
|
||||
const response = await callAction(createForm("rotate"));
|
||||
const data = await responseJson(response);
|
||||
|
||||
expect(response.status).toBe(200);
|
||||
expect(data).toEqual({ apiKey: { key: rotatedApiKey.key, alias: rotatedApiKey.alias } });
|
||||
expect(rotateApiKey).toHaveBeenCalledWith("api-key-1", "tenant-1");
|
||||
expect(createLog).toHaveBeenCalledWith(
|
||||
expect.any(Request),
|
||||
"tenant-1",
|
||||
"settings.apiKeys.rotated",
|
||||
expect.stringContaining('"alias":"Primary integration"')
|
||||
);
|
||||
expect(updateApiKey).not.toHaveBeenCalled();
|
||||
expect(deleteApiKey).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("checks delete permission only for delete actions", async () => {
|
||||
await callAction(createForm("edit"));
|
||||
await callAction(createForm("rotate"));
|
||||
await callAction(createForm("delete"));
|
||||
|
||||
expect(verifyUserHasPermission).toHaveBeenCalledWith(expect.any(Request), "app.settings.apiKeys.update", "tenant-1");
|
||||
expect(verifyUserHasPermission).toHaveBeenCalledWith(expect.any(Request), "app.settings.apiKeys.delete", "tenant-1");
|
||||
expect(vi.mocked(verifyUserHasPermission).mock.calls.filter((call) => call[1] === "app.settings.apiKeys.delete")).toHaveLength(1);
|
||||
});
|
||||
|
||||
it("checks delete permission before probing delete usage logs", async () => {
|
||||
vi.mocked(verifyUserHasPermission).mockImplementation(async (_request, permission) => {
|
||||
if (permission === "app.settings.apiKeys.delete") {
|
||||
throw new Response("Forbidden", { status: 403 });
|
||||
}
|
||||
return true;
|
||||
});
|
||||
|
||||
await expect(callAction(createForm("delete"))).rejects.toMatchObject({ status: 403 });
|
||||
|
||||
expect(countApiKeyLogsForKey).not.toHaveBeenCalled();
|
||||
expect(deleteApiKey).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("scopes delete usage-log checks to the current tenant", async () => {
|
||||
const response = await callAction(createForm("delete"));
|
||||
|
||||
expect(response.status).toBe(302);
|
||||
expect(countApiKeyLogsForKey).toHaveBeenCalledWith("api-key-1", "tenant-1");
|
||||
expect(deleteApiKey).toHaveBeenCalledWith("api-key-1", "tenant-1");
|
||||
expect(createLog).toHaveBeenCalledWith(expect.any(Request), "tenant-1", "settings.apiKeys.deleted", "");
|
||||
});
|
||||
|
||||
it("preserves edited scope changes in logs and events", async () => {
|
||||
const response = await callAction(createForm("edit", { alias: "Primary integration updated" }));
|
||||
|
||||
expect(response.status).toBe(302);
|
||||
expect(updateApiKey).toHaveBeenCalledWith(
|
||||
"api-key-1",
|
||||
{
|
||||
tenantId: "tenant-1",
|
||||
alias: "Primary integration updated",
|
||||
expires: null,
|
||||
active: true,
|
||||
},
|
||||
[entityPermission]
|
||||
);
|
||||
expect(createLog).toHaveBeenCalledWith(
|
||||
expect.any(Request),
|
||||
"tenant-1",
|
||||
"settings.apiKeys.updated",
|
||||
expect.stringContaining('"entities":[{"entityId":"entity-1","create":true,"read":true,"update":false,"delete":false}]')
|
||||
);
|
||||
expect(createLog).toHaveBeenCalledTimes(1);
|
||||
expect(EventsService.create).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
event: "api_key.updated",
|
||||
data: expect.objectContaining({
|
||||
new: expect.objectContaining({ entities: [entityPermission] }),
|
||||
old: expect.objectContaining({ entities: [entityPermission] }),
|
||||
}),
|
||||
})
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,198 @@
|
||||
import { ActionFunction, LoaderFunctionArgs, redirect, useActionData, useLoaderData } from "react-router";
|
||||
import { useNavigate, useParams } from "react-router";
|
||||
import ApiKeyCreatedModal from "~/components/core/apiKeys/ApiKeyCreatedModal";
|
||||
import ApiKeyForm from "~/components/core/apiKeys/ApiKeyForm";
|
||||
import OpenModal from "~/components/ui/modals/OpenModal";
|
||||
import { getTranslations } from "~/locale/i18next.server";
|
||||
import UrlUtils from "~/utils/app/UrlUtils";
|
||||
import { useAppData } from "~/utils/data/useAppData";
|
||||
import {
|
||||
RedactedApiKeyWithDetails,
|
||||
countApiKeyLogsForKey,
|
||||
deleteApiKey,
|
||||
getApiKeys,
|
||||
getTenantApiKeyById,
|
||||
rotateApiKey,
|
||||
updateApiKey,
|
||||
} from "~/utils/db/apiKeys.db.server";
|
||||
import { createLog } from "~/utils/db/logs.db.server";
|
||||
import { getUser } from "~/utils/db/users.db.server";
|
||||
import { getApiKeyEntityPermissions } from "~/utils/helpers/.server/ApiKeyHelperService";
|
||||
import EventsService from "~/modules/events/services/.server/EventsService";
|
||||
import { getUserInfo, validateCSRFToken } from "~/utils/session.server";
|
||||
import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService";
|
||||
import { getUserHasPermission } from "~/utils/helpers/PermissionsHelper";
|
||||
import { getTenantIdFromUrl } from "~/utils/services/.server/urlService";
|
||||
import { ApiKeyUpdatedDto } from "~/modules/events/dtos/ApiKeyUpdatedDto";
|
||||
import { getTenant } from "~/utils/db/tenants.db.server";
|
||||
import { ApiKeyDeletedDto } from "~/modules/events/dtos/ApiKeyDeletedDto";
|
||||
|
||||
type LoaderData = {
|
||||
item: RedactedApiKeyWithDetails;
|
||||
};
|
||||
export const loader = async ({ request, params }: LoaderFunctionArgs) => {
|
||||
const tenantId = await getTenantIdFromUrl(params);
|
||||
await verifyUserHasPermission(request, "app.settings.apiKeys.update", tenantId);
|
||||
const item = await getTenantApiKeyById(params.id ?? "", tenantId);
|
||||
if (!item) {
|
||||
return redirect(UrlUtils.currentTenantUrl(params, "settings/api/keys"));
|
||||
}
|
||||
const data: LoaderData = {
|
||||
item,
|
||||
};
|
||||
return data;
|
||||
};
|
||||
|
||||
type ActionData = {
|
||||
error?: string;
|
||||
apiKey?: {
|
||||
key: string;
|
||||
alias: string;
|
||||
};
|
||||
};
|
||||
const badRequest = (data: ActionData) => Response.json(data, { status: 400 });
|
||||
export const action: ActionFunction = async ({ request, params }) => {
|
||||
const { t } = await getTranslations(request);
|
||||
const tenantId = await getTenantIdFromUrl(params);
|
||||
const userInfo = await getUserInfo(request);
|
||||
const currentUser = await getUser(userInfo.userId);
|
||||
const tenant = await getTenant(tenantId);
|
||||
if (!tenant || !currentUser) {
|
||||
return badRequest({ error: t("shared.notFound") });
|
||||
}
|
||||
await verifyUserHasPermission(request, "app.settings.apiKeys.update", tenantId);
|
||||
await validateCSRFToken(request);
|
||||
const form = await request.formData();
|
||||
const action = form.get("action")?.toString() ?? "";
|
||||
const existing = await getTenantApiKeyById(params.id ?? "", tenantId);
|
||||
if (!existing) {
|
||||
return badRequest({ error: t("shared.notFound") });
|
||||
}
|
||||
if (action === "edit") {
|
||||
const entities: { entityId: string; create: boolean; read: boolean; update: boolean; delete: boolean }[] = form
|
||||
.getAll("entities[]")
|
||||
.map((f: FormDataEntryValue) => {
|
||||
return JSON.parse(f.toString());
|
||||
});
|
||||
let expirationDate: Date | null = null;
|
||||
let expires = form.get("expires")?.toString();
|
||||
if (expires) {
|
||||
expirationDate = new Date(expires);
|
||||
}
|
||||
const alias = form.get("alias")?.toString() ?? "";
|
||||
const existingAlias = await getApiKeys(existing.tenantId);
|
||||
if (existingAlias.filter((f) => f.id !== existing.id && f.alias === alias).length > 0) {
|
||||
return badRequest({ error: t("models.apiKey.errors.aliasExists", { alias }) });
|
||||
}
|
||||
const active = Boolean(form.get("active"));
|
||||
await updateApiKey(
|
||||
params.id ?? "",
|
||||
{
|
||||
tenantId: tenantId,
|
||||
alias,
|
||||
expires: expirationDate,
|
||||
active,
|
||||
},
|
||||
entities
|
||||
);
|
||||
await createLog(request, tenantId, "settings.apiKeys.updated", JSON.stringify({ tenantId, alias, expirationDate, active, entities }));
|
||||
await EventsService.create({
|
||||
request,
|
||||
event: "api_key.updated",
|
||||
tenantId: tenant.id,
|
||||
userId: currentUser.id,
|
||||
data: {
|
||||
id: existing.id,
|
||||
new: {
|
||||
alias: alias,
|
||||
expires: expirationDate,
|
||||
active: active,
|
||||
entities: await getApiKeyEntityPermissions(entities),
|
||||
},
|
||||
old: {
|
||||
alias: existing.alias,
|
||||
expires: existing.expires,
|
||||
active: existing.active,
|
||||
entities: await getApiKeyEntityPermissions(existing.entities),
|
||||
},
|
||||
user: { id: currentUser?.id ?? "", email: currentUser?.email ?? "" },
|
||||
} satisfies ApiKeyUpdatedDto,
|
||||
});
|
||||
return redirect(UrlUtils.currentTenantUrl(params, "settings/api/keys"));
|
||||
} else if (action === "rotate") {
|
||||
const apiKey = await rotateApiKey(existing.id, tenantId);
|
||||
await createLog(request, tenantId, "settings.apiKeys.rotated", JSON.stringify({ tenantId, alias: existing.alias }));
|
||||
await EventsService.create({
|
||||
request,
|
||||
event: "api_key.updated",
|
||||
tenantId: tenant.id,
|
||||
userId: currentUser.id,
|
||||
data: {
|
||||
id: existing.id,
|
||||
new: {
|
||||
alias: existing.alias,
|
||||
expires: existing.expires,
|
||||
active: existing.active,
|
||||
entities: await getApiKeyEntityPermissions(existing.entities),
|
||||
},
|
||||
old: {
|
||||
alias: existing.alias,
|
||||
expires: existing.expires,
|
||||
active: existing.active,
|
||||
entities: await getApiKeyEntityPermissions(existing.entities),
|
||||
},
|
||||
user: { id: currentUser?.id ?? "", email: currentUser?.email ?? "" },
|
||||
} satisfies ApiKeyUpdatedDto,
|
||||
});
|
||||
return Response.json({ apiKey: { key: apiKey.key, alias: apiKey.alias } } satisfies ActionData);
|
||||
} else if (action === "delete") {
|
||||
await verifyUserHasPermission(request, "app.settings.apiKeys.delete", tenantId);
|
||||
const logs = await countApiKeyLogsForKey(params.id ?? "", tenantId);
|
||||
if (logs > 0) {
|
||||
return badRequest({ error: t("models.apiKey.errors.cannotDeleteUsed") });
|
||||
}
|
||||
await deleteApiKey(params.id ?? "", tenantId);
|
||||
await createLog(request, tenantId, "settings.apiKeys.deleted", "");
|
||||
await EventsService.create({
|
||||
request,
|
||||
event: "api_key.deleted",
|
||||
tenantId: tenant.id,
|
||||
userId: currentUser.id,
|
||||
data: {
|
||||
id: existing.id,
|
||||
alias: existing.alias,
|
||||
expires: existing.expires,
|
||||
active: existing.active,
|
||||
entities: await getApiKeyEntityPermissions(existing.entities),
|
||||
user: { id: currentUser?.id ?? "", email: currentUser?.email ?? "" },
|
||||
} satisfies ApiKeyDeletedDto,
|
||||
});
|
||||
return redirect(UrlUtils.currentTenantUrl(params, "settings/api/keys"));
|
||||
} else {
|
||||
return badRequest({ error: t("shared.invalidForm") });
|
||||
}
|
||||
};
|
||||
|
||||
export default function ApiEditKeyRoute() {
|
||||
const data = useLoaderData<LoaderData>();
|
||||
const actionData = useActionData<ActionData>();
|
||||
const navigate = useNavigate();
|
||||
const appData = useAppData();
|
||||
const params = useParams();
|
||||
return (
|
||||
<>
|
||||
<OpenModal className="sm:max-w-xl" onClose={() => navigate(UrlUtils.currentTenantUrl(params, "settings/api/keys"))}>
|
||||
<ApiKeyForm
|
||||
entities={appData.entities}
|
||||
item={data.item}
|
||||
canUpdate={getUserHasPermission(appData, "app.settings.apiKeys.update")}
|
||||
canDelete={getUserHasPermission(appData, "app.settings.apiKeys.delete")}
|
||||
canRotate={getUserHasPermission(appData, "app.settings.apiKeys.update")}
|
||||
/>
|
||||
{actionData?.apiKey !== undefined && (
|
||||
<ApiKeyCreatedModal apiKey={actionData?.apiKey} redirectTo={UrlUtils.currentTenantUrl(params, "settings/api/keys")} action="rotated" />
|
||||
)}
|
||||
</OpenModal>
|
||||
</>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,169 @@
|
||||
// @vitest-environment node
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import type { ActionFunctionArgs } from "react-router";
|
||||
|
||||
vi.mock("~/locale/i18next.server", () => ({
|
||||
getTranslations: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/services/.server/urlService", () => ({
|
||||
getTenantIdFromUrl: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/helpers/.server/PermissionsService", () => ({
|
||||
verifyUserHasPermission: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/session.server", () => ({
|
||||
getUserInfo: vi.fn(),
|
||||
validateCSRFToken: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/db/tenants.db.server", () => ({
|
||||
getTenant: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/db/users.db.server", () => ({
|
||||
getUser: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/db/apiKeys.db.server", () => ({
|
||||
createApiKey: vi.fn(),
|
||||
getApiKeyByAlias: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/db/logs.db.server", () => ({
|
||||
createLog: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/utils/helpers/.server/ApiKeyHelperService", () => ({
|
||||
getApiKeyEntityPermissions: vi.fn(),
|
||||
}));
|
||||
vi.mock("~/modules/events/services/.server/EventsService", () => ({
|
||||
default: { create: vi.fn() },
|
||||
}));
|
||||
vi.mock("~/utils/app/UrlUtils", () => ({
|
||||
default: { currentTenantUrl: vi.fn((_params: Record<string, string | undefined>, path: string) => `/acme/${path}`) },
|
||||
}));
|
||||
vi.mock("~/components/core/apiKeys/ApiKeyCreatedModal", () => ({ default: () => null }));
|
||||
vi.mock("~/components/core/apiKeys/ApiKeyForm", () => ({ default: () => null }));
|
||||
vi.mock("~/components/ui/modals/OpenModal", () => ({ default: ({ children }: { children: React.ReactNode }) => children }));
|
||||
vi.mock("~/utils/data/useAppData", () => ({ useAppData: () => ({ entities: [] }) }));
|
||||
|
||||
import EventsService from "~/modules/events/services/.server/EventsService";
|
||||
import { getTranslations } from "~/locale/i18next.server";
|
||||
import { createApiKey, getApiKeyByAlias } from "~/utils/db/apiKeys.db.server";
|
||||
import { createLog } from "~/utils/db/logs.db.server";
|
||||
import { getTenant } from "~/utils/db/tenants.db.server";
|
||||
import { getUser } from "~/utils/db/users.db.server";
|
||||
import { getApiKeyEntityPermissions } from "~/utils/helpers/.server/ApiKeyHelperService";
|
||||
import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService";
|
||||
import { getTenantIdFromUrl } from "~/utils/services/.server/urlService";
|
||||
import { getUserInfo, validateCSRFToken } from "~/utils/session.server";
|
||||
import { action } from "./new";
|
||||
|
||||
const params = { tenant: "acme" };
|
||||
const tenant = { id: "tenant-1", name: "Acme", slug: "acme" };
|
||||
const user = { id: "user-1", email: "ada@example.test" };
|
||||
const apiKey = {
|
||||
id: "api-key-1",
|
||||
alias: "Primary integration",
|
||||
key: "tc_live_plaintext_secret_once",
|
||||
active: true,
|
||||
};
|
||||
const entityPermission = { entityId: "entity-1", create: true, read: true, update: false, delete: false };
|
||||
|
||||
function createRequest(form: FormData) {
|
||||
return new Request("https://app.example.test/acme/settings/api/keys/new", {
|
||||
method: "POST",
|
||||
headers: { "Content-Type": "application/x-www-form-urlencoded" },
|
||||
body: new URLSearchParams(form as unknown as Record<string, string>),
|
||||
});
|
||||
}
|
||||
|
||||
function createForm(overrides: Record<string, string> = {}) {
|
||||
const form = new FormData();
|
||||
form.set("action", "create");
|
||||
form.set("alias", "Primary integration");
|
||||
form.set("active", "on");
|
||||
form.append("entities[]", JSON.stringify(entityPermission));
|
||||
Object.entries(overrides).forEach(([key, value]) => form.set(key, value));
|
||||
return form;
|
||||
}
|
||||
|
||||
async function callAction(form: FormData) {
|
||||
return action({
|
||||
request: createRequest(form),
|
||||
params,
|
||||
context: {},
|
||||
unstable_pattern: "app.$tenant/settings/api/keys/new",
|
||||
} as ActionFunctionArgs) as Promise<Response>;
|
||||
}
|
||||
|
||||
async function responseJson(response: Response) {
|
||||
return response.json() as Promise<Record<string, unknown>>;
|
||||
}
|
||||
|
||||
describe("tenant API key create route", () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
vi.mocked(getTranslations).mockResolvedValue({
|
||||
t: (key: string, values?: Record<string, unknown>) =>
|
||||
key === "models.apiKey.errors.aliasExists" ? `API key with this alias already exists: ${values?.alias}` : `translated:${key}`,
|
||||
} as never);
|
||||
vi.mocked(getTenantIdFromUrl).mockResolvedValue("tenant-1");
|
||||
vi.mocked(verifyUserHasPermission).mockResolvedValue(undefined as never);
|
||||
vi.mocked(getUserInfo).mockResolvedValue({ userId: "user-1" } as never);
|
||||
vi.mocked(validateCSRFToken).mockResolvedValue(undefined as never);
|
||||
vi.mocked(getTenant).mockResolvedValue(tenant as never);
|
||||
vi.mocked(getUser).mockResolvedValue(user as never);
|
||||
vi.mocked(getApiKeyByAlias).mockResolvedValue(null as never);
|
||||
vi.mocked(createApiKey).mockResolvedValue(apiKey as never);
|
||||
vi.mocked(getApiKeyEntityPermissions).mockResolvedValue([entityPermission] as never);
|
||||
vi.mocked(EventsService.create).mockResolvedValue(undefined as never);
|
||||
vi.mocked(createLog).mockResolvedValue({} as never);
|
||||
});
|
||||
|
||||
it("checks create permission before creating a key", async () => {
|
||||
const response = await callAction(createForm());
|
||||
|
||||
expect(response.status).toBe(200);
|
||||
expect(verifyUserHasPermission).toHaveBeenCalledWith(expect.any(Request), "app.settings.apiKeys.create", "tenant-1");
|
||||
expect(vi.mocked(verifyUserHasPermission).mock.invocationCallOrder[0]).toBeLessThan(vi.mocked(createApiKey).mock.invocationCallOrder[0]);
|
||||
});
|
||||
|
||||
it("returns one-time plaintext only in successful create action JSON", async () => {
|
||||
const response = await callAction(createForm());
|
||||
const data = await responseJson(response);
|
||||
|
||||
expect(response.status).toBe(200);
|
||||
expect(data).toEqual({ apiKey: { key: apiKey.key, alias: apiKey.alias } });
|
||||
expect(createApiKey).toHaveBeenCalledTimes(1);
|
||||
expect(EventsService.create).toHaveBeenCalledTimes(1);
|
||||
expect(createLog).toHaveBeenCalledWith(
|
||||
expect.any(Request),
|
||||
"tenant-1",
|
||||
"settings.apiKeys.created",
|
||||
expect.stringContaining('"alias":"Primary integration"')
|
||||
);
|
||||
expect(createLog).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("rejects duplicate aliases without creating or leaking generated key material", async () => {
|
||||
vi.mocked(getApiKeyByAlias).mockResolvedValueOnce({ id: "existing-key", alias: "Primary integration" } as never);
|
||||
|
||||
const response = await callAction(createForm());
|
||||
const data = await responseJson(response);
|
||||
|
||||
expect(response.status).toBe(400);
|
||||
expect(data).toEqual({ error: "API key with this alias already exists: Primary integration" });
|
||||
expect(JSON.stringify(data)).not.toContain(apiKey.key);
|
||||
expect(createApiKey).not.toHaveBeenCalled();
|
||||
expect(EventsService.create).not.toHaveBeenCalled();
|
||||
expect(createLog).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("rejects invalid actions without creating or leaking generated key material", async () => {
|
||||
const response = await callAction(createForm({ action: "rotate" }));
|
||||
const data = await responseJson(response);
|
||||
|
||||
expect(response.status).toBe(400);
|
||||
expect(data).toEqual({ error: "translated:shared.invalidForm" });
|
||||
expect(JSON.stringify(data)).not.toContain(apiKey.key);
|
||||
expect(createApiKey).not.toHaveBeenCalled();
|
||||
expect(EventsService.create).not.toHaveBeenCalled();
|
||||
expect(createLog).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,113 @@
|
||||
import { ActionFunction, LoaderFunctionArgs } from "react-router";
|
||||
import { useActionData, useNavigate, useParams } from "react-router";
|
||||
import ApiKeyCreatedModal from "~/components/core/apiKeys/ApiKeyCreatedModal";
|
||||
import ApiKeyForm from "~/components/core/apiKeys/ApiKeyForm";
|
||||
import OpenModal from "~/components/ui/modals/OpenModal";
|
||||
import { getTranslations } from "~/locale/i18next.server";
|
||||
import UrlUtils from "~/utils/app/UrlUtils";
|
||||
import { useAppData } from "~/utils/data/useAppData";
|
||||
import { createApiKey, getApiKeyByAlias } from "~/utils/db/apiKeys.db.server";
|
||||
import { createLog } from "~/utils/db/logs.db.server";
|
||||
import { getUser } from "~/utils/db/users.db.server";
|
||||
import { getApiKeyEntityPermissions } from "~/utils/helpers/.server/ApiKeyHelperService";
|
||||
import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService";
|
||||
import EventsService from "~/modules/events/services/.server/EventsService";
|
||||
import { getTenantIdFromUrl } from "~/utils/services/.server/urlService";
|
||||
import { getUserInfo, validateCSRFToken } from "~/utils/session.server";
|
||||
import { ApiKeyCreatedDto } from "~/modules/events/dtos/ApiKeyCreatedDto";
|
||||
import { getTenant } from "~/utils/db/tenants.db.server";
|
||||
|
||||
export const loader = async ({ request, params }: LoaderFunctionArgs) => {
|
||||
const tenantId = await getTenantIdFromUrl(params);
|
||||
await verifyUserHasPermission(request, "app.settings.apiKeys.create", tenantId);
|
||||
return Response.json({});
|
||||
};
|
||||
|
||||
type ActionData = {
|
||||
error?: string;
|
||||
apiKey?: {
|
||||
key: string;
|
||||
alias: string;
|
||||
};
|
||||
};
|
||||
const badRequest = (data: ActionData) => Response.json(data, { status: 400 });
|
||||
export const action: ActionFunction = async ({ request, params }) => {
|
||||
const { t } = await getTranslations(request);
|
||||
const tenantId = await getTenantIdFromUrl(params);
|
||||
await verifyUserHasPermission(request, "app.settings.apiKeys.create", tenantId);
|
||||
await validateCSRFToken(request);
|
||||
const userInfo = await getUserInfo(request);
|
||||
const tenant = await getTenant(tenantId);
|
||||
const currentUser = await getUser(userInfo.userId);
|
||||
|
||||
if (!tenant || !currentUser) {
|
||||
return badRequest({ error: t("shared.notFound") });
|
||||
}
|
||||
|
||||
const form = await request.formData();
|
||||
const action = form.get("action")?.toString() ?? "";
|
||||
if (action === "create") {
|
||||
const entities: { entityId: string; create: boolean; read: boolean; update: boolean; delete: boolean }[] = form
|
||||
.getAll("entities[]")
|
||||
.map((f: FormDataEntryValue) => {
|
||||
return JSON.parse(f.toString());
|
||||
});
|
||||
|
||||
let expirationDate: Date | null = null;
|
||||
let expires = form.get("expires")?.toString();
|
||||
if (expires) {
|
||||
expirationDate = new Date(expires);
|
||||
}
|
||||
const alias = form.get("alias")?.toString() ?? "";
|
||||
const existingAlias = await getApiKeyByAlias(tenantId, alias);
|
||||
if (existingAlias) {
|
||||
return badRequest({ error: t("models.apiKey.errors.aliasExists", { alias }) });
|
||||
}
|
||||
const active = Boolean(form.get("active"));
|
||||
const apiKey = await createApiKey(
|
||||
{
|
||||
tenantId: tenantId,
|
||||
createdByUserId: userInfo.userId,
|
||||
alias,
|
||||
expires: expirationDate,
|
||||
active,
|
||||
},
|
||||
entities
|
||||
);
|
||||
await EventsService.create({
|
||||
request,
|
||||
event: "api_key.created",
|
||||
tenantId: tenantId,
|
||||
userId: currentUser.id,
|
||||
data: {
|
||||
id: apiKey.id,
|
||||
alias: apiKey.alias,
|
||||
expires: expirationDate,
|
||||
active: active,
|
||||
entities: await getApiKeyEntityPermissions(entities),
|
||||
user: { id: currentUser?.id ?? "", email: currentUser?.email ?? "" },
|
||||
} satisfies ApiKeyCreatedDto,
|
||||
});
|
||||
await createLog(request, tenantId, "settings.apiKeys.created", JSON.stringify({ id: apiKey.id, alias, expirationDate, active, entities }));
|
||||
return Response.json({ apiKey: { key: apiKey.key, alias: apiKey.alias } } satisfies ActionData);
|
||||
} else {
|
||||
return badRequest({ error: t("shared.invalidForm") });
|
||||
}
|
||||
};
|
||||
|
||||
export default function ApiNewKeyRoute() {
|
||||
const navigate = useNavigate();
|
||||
const actionData = useActionData<ActionData>();
|
||||
const params = useParams();
|
||||
const appData = useAppData();
|
||||
return (
|
||||
<>
|
||||
<OpenModal className="sm:max-w-xl" onClose={() => navigate(UrlUtils.currentTenantUrl(params, "settings/api/keys"))}>
|
||||
<ApiKeyForm entities={appData.entities} />
|
||||
{actionData?.apiKey !== undefined && (
|
||||
<ApiKeyCreatedModal apiKey={actionData?.apiKey} redirectTo={UrlUtils.currentTenantUrl(params, "settings/api/keys")} />
|
||||
)}
|
||||
</OpenModal>
|
||||
</>
|
||||
);
|
||||
}
|
||||
Reference in new issue
Block a user