Track HiveGrid Cloud planning reference

This commit is contained in:
david committed 2026-06-26 20:48:01 +02:00
1 parent b3d5ea6764
commit e341c5938a
5784 files changed
+1104929 -3

No files matched your search

@@ -0,0 +1,36 @@
import { LoaderFunctionArgs } from "react-router";
import { getTranslations } from "~/locale/i18next.server";
import { getOnboardingSessionsWithPagination, OnboardingSessionWithDetails } from "../../db/onboardingSessions.db.server";
import { OnboardingFilterMetadataDto } from "../../dtos/OnboardingFilterMetadataDto";
import OnboardingService, { OnboardingSummaryDto } from "../../services/OnboardingService";
import { MetaTagsDto } from "~/application/dtos/seo/MetaTagsDto";
import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService";
export namespace OnboardingSummaryApi {
export type LoaderData = {
meta: MetaTagsDto;
summary: OnboardingSummaryDto;
sessions: {
items: OnboardingSessionWithDetails[];
metadata: OnboardingFilterMetadataDto;
};
};
export const loader = async ({ request }: LoaderFunctionArgs) => {
await verifyUserHasPermission(request, "admin.onboarding.view");
const { t } = await getTranslations(request);
const data: LoaderData = {
meta: [{ title: `${t("onboarding.title")} | ${process.env.APP_NAME}` }],
summary: await OnboardingService.getSummary(),
sessions: {
items: (
await getOnboardingSessionsWithPagination({
pagination: { page: 1, pageSize: 10 },
})
).items,
metadata: await OnboardingService.getMetadata(),
},
};
return data;
};
}
@@ -0,0 +1,82 @@
import { ActionFunction, LoaderFunctionArgs, redirect } from "react-router";
import { getTranslations } from "~/locale/i18next.server";
import { getUserInfo, validateCSRFToken } from "~/utils/session.server";
import { createOnboarding, getOnboardings, OnboardingWithDetails } from "../../../db/onboarding.db.server";
import { MetaTagsDto } from "~/application/dtos/seo/MetaTagsDto";
import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService";
import { adminPath } from "~/utils/app/CanonicalUrlUtils";
export namespace OnboardingIndexApi {
export type LoaderData = {
meta: MetaTagsDto;
items: OnboardingWithDetails[];
groupByStatus: { status: string; count: number }[];
};
export const loader = async ({ request }: LoaderFunctionArgs) => {
await verifyUserHasPermission(request, "admin.onboarding.view");
const { t } = await getTranslations(request);
const urlSearchParams = new URL(request.url).searchParams;
// const currentPagination = getPaginationFromCurrentUrl(urlSearchParams);
const status = urlSearchParams.get("status");
const items = await getOnboardings({
active: status === "active" ? true : status === "inactive" ? false : undefined,
});
const groupByStatus: { status: string; count: number }[] = [];
items.forEach((item) => {
if (item.active) {
const index = groupByStatus.findIndex((item) => item.status === "active");
if (index === -1) {
groupByStatus.push({ status: "active", count: 1 });
} else {
groupByStatus[index].count++;
}
} else if (!item.active) {
const index = groupByStatus.findIndex((item) => item.status === "inactive");
if (index === -1) {
groupByStatus.push({ status: "inactive", count: 1 });
} else {
groupByStatus[index].count++;
}
}
});
const data: LoaderData = {
meta: [{ title: `${t("onboarding.title")} | ${process.env.APP_NAME}` }],
items,
groupByStatus,
};
return data;
};
export type ActionData = {
error?: string;
};
export const action: ActionFunction = async ({ request }) => {
await verifyUserHasPermission(request, "admin.onboarding.update");
const { t } = await getTranslations(request);
await validateCSRFToken(request);
const form = await request.formData();
const userInfo = await getUserInfo(request);
const action = form.get("action");
if (action === "create") {
await verifyUserHasPermission(request, "admin.onboarding.create");
const title = form.get("title")?.toString() ?? "";
if (!title) {
return Response.json({ error: t("onboarding.errors.titleRequired") }, { status: 400 });
}
const onboarding = await createOnboarding({
title,
type: "modal",
active: false,
realtime: false,
canBeDismissed: true,
height: "xl",
filters: [{ type: "user.is", value: userInfo.userId }],
steps: [],
});
return redirect(adminPath(`onboarding/onboardings/${onboarding.id}`, { mode: "host-aware" }));
} else {
return Response.json({ error: t("shared.invalidForm") }, { status: 400 });
}
};
}
@@ -0,0 +1,69 @@
import { ActionFunction, LoaderFunctionArgs, redirect } from "react-router";
import { MetaTagsDto } from "~/application/dtos/seo/MetaTagsDto";
import { getTranslations } from "~/locale/i18next.server";
import {
deleteOnboardingSession,
getOnboardingSession,
OnboardingSessionWithDetails,
updateOnboardingSession,
} from "~/modules/onboarding/db/onboardingSessions.db.server";
import { OnboardingSessionStatus } from "~/modules/onboarding/dtos/OnboardingSessionStatus";
import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService";
import { validateCSRFToken } from "~/utils/session.server";
import { adminPath } from "~/utils/app/CanonicalUrlUtils";
const onboardingSessionsPath = () => adminPath("onboarding/sessions", { mode: "host-aware" });
export namespace OnboardingSessionOverviewApi {
export type LoaderData = {
meta: MetaTagsDto;
item: OnboardingSessionWithDetails;
};
export const loader = async ({ request, params }: LoaderFunctionArgs) => {
await verifyUserHasPermission(request, "admin.onboarding.view");
const { t } = await getTranslations(request);
const item = await getOnboardingSession(params.id!);
if (!item) {
throw redirect(onboardingSessionsPath());
}
const data: LoaderData = {
meta: [{ title: `${t("onboarding.session.object")} | ${process.env.APP_NAME}` }],
item,
};
return data;
};
export type ActionData = {
error?: string;
};
export const action: ActionFunction = async ({ request, params }) => {
await verifyUserHasPermission(request, "admin.onboarding.update");
const { t } = await getTranslations(request);
await validateCSRFToken(request);
const form = await request.formData();
const action = form.get("action");
const item = await getOnboardingSession(params.id!);
if (!item) {
return redirect(onboardingSessionsPath());
}
if (action === "update") {
const status = form.get("status")?.toString();
const startedAt = form.get("startedAt")?.toString();
const completedAt = form.get("completedAt")?.toString();
const dismissedAt = form.get("dismissedAt")?.toString();
await updateOnboardingSession(item.id, {
status: status !== undefined ? (status as OnboardingSessionStatus) : undefined,
startedAt: startedAt !== undefined ? new Date(startedAt) : undefined,
completedAt: completedAt !== undefined ? new Date(completedAt) : undefined,
dismissedAt: dismissedAt !== undefined ? new Date(dismissedAt) : undefined,
});
return Response.json({ success: true });
} else if (action === "delete") {
await verifyUserHasPermission(request, "admin.onboarding.delete");
await deleteOnboardingSession({ id: item.id, onboardingId: item.onboardingId });
return redirect(onboardingSessionsPath());
} else {
return Response.json({ error: t("shared.invalidForm") }, { status: 400 });
}
};
}
@@ -0,0 +1,115 @@
import { ActionFunction, LoaderFunctionArgs } from "react-router";
import { FilterablePropertyDto } from "~/application/dtos/data/FilterablePropertyDto";
import { PaginationDto } from "~/application/dtos/data/PaginationDto";
import { getTranslations } from "~/locale/i18next.server";
import { getOnboardings } from "~/modules/onboarding/db/onboarding.db.server";
import { deleteOnboardingSessionStepsInOnboardingSession } from "~/modules/onboarding/db/onboardingSessionSteps.db.server";
import { OnboardingFilterMetadataDto } from "~/modules/onboarding/dtos/OnboardingFilterMetadataDto";
import OnboardingService from "~/modules/onboarding/services/OnboardingService";
import { adminGetAllTenantsIdsAndNames } from "~/utils/db/tenants.db.server";
import { getUsersById } from "~/utils/db/users.db.server";
import { getFiltersFromCurrentUrl, getPaginationFromCurrentUrl } from "~/utils/helpers/RowPaginationHelper";
import {
deleteOnboardingSession,
getOnboardingSessionInOnboarding,
getOnboardingSessionsWithPagination,
groupOnboardingSessionsByUser,
OnboardingSessionWithDetails,
} from "../../../db/onboardingSessions.db.server";
import { MetaTagsDto } from "~/application/dtos/seo/MetaTagsDto";
import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService";
import { validateCSRFToken } from "~/utils/session.server";
export namespace OnboardingSessionsIndexApi {
export type LoaderData = {
meta: MetaTagsDto;
items: OnboardingSessionWithDetails[];
pagination: PaginationDto;
filterableProperties: FilterablePropertyDto[];
metadata: OnboardingFilterMetadataDto;
};
export const loader = async ({ request, params }: LoaderFunctionArgs) => {
await verifyUserHasPermission(request, "admin.onboarding.view");
const { t } = await getTranslations(request);
const allOnboardings = await getOnboardings({});
const usersInSessions = await groupOnboardingSessionsByUser();
const users = await getUsersById(usersInSessions.map((x) => x.userId));
const filterableProperties: FilterablePropertyDto[] = [
{
name: "onboardingId",
title: t("onboarding.title"),
options: [
...allOnboardings.map((i) => {
return { value: i.id, name: i.title };
}),
],
},
{
name: "userId",
title: t("models.user.object"),
options: [
...users.map((i) => {
return { value: i.id, name: i.email + " - " + i.firstName + " " + i.lastName };
}),
],
},
{
name: "tenantId",
title: t("models.tenant.object"),
options: [
{ name: "{Admin}", value: "null" },
...(await adminGetAllTenantsIdsAndNames()).map((i) => {
return { value: i.id, name: i.name };
}),
],
},
];
const filters = getFiltersFromCurrentUrl(request, filterableProperties);
const urlSearchParams = new URL(request.url).searchParams;
const currentPagination = getPaginationFromCurrentUrl(urlSearchParams);
const tenantId = filters.properties.find((f) => f.name === "tenantId")?.value;
const { items, pagination } = await getOnboardingSessionsWithPagination({
pagination: currentPagination,
where: {
onboardingId: params.id,
tenantId: tenantId === "null" ? null : tenantId ?? undefined,
},
});
const data: LoaderData = {
meta: [{ title: `${t("onboarding.title")} | ${process.env.APP_NAME}` }],
items,
pagination,
filterableProperties,
metadata: await OnboardingService.getMetadata(),
};
return data;
};
export type ActionData = {
error?: string;
success?: string;
};
export const action: ActionFunction = async ({ request, params }) => {
await verifyUserHasPermission(request, "admin.onboarding.update");
const { t } = await getTranslations(request);
await validateCSRFToken(request);
const form = await request.formData();
const action = form.get("action");
if (action === "delete") {
await verifyUserHasPermission(request, "admin.onboarding.delete");
const id = form.get("id")?.toString() ?? "";
if (!id) {
return Response.json({ error: t("onboarding.session.errors.idRequired") }, { status: 400 });
}
const session = await getOnboardingSessionInOnboarding({ id, onboardingId: params.id! });
if (!session) {
return Response.json({ error: t("shared.notFound") }, { status: 404 });
}
await deleteOnboardingSessionStepsInOnboardingSession({ onboardingSessionId: session.id, onboardingId: params.id! });
await deleteOnboardingSession({ id, onboardingId: params.id! });
return Response.json({ success: t("onboarding.session.deleted") });
} else {
return Response.json({ error: t("shared.invalidForm") }, { status: 400 });
}
};
}
@@ -0,0 +1,151 @@
import type { LoaderFunctionArgs } from "react-router";
import { beforeEach, describe, expect, it, vi } from "vitest";
import { getTranslations } from "~/locale/i18next.server";
import { getOnboardings } from "~/modules/onboarding/db/onboarding.db.server";
import {
deleteOnboardingSession,
getOnboardingSessionInOnboarding,
getOnboardingSessionsWithPagination,
groupOnboardingSessionsByUser,
} from "~/modules/onboarding/db/onboardingSessions.db.server";
import { deleteOnboardingSessionStepsInOnboardingSession } from "~/modules/onboarding/db/onboardingSessionSteps.db.server";
import OnboardingService from "~/modules/onboarding/services/OnboardingService";
import { adminGetAllTenantsIdsAndNames } from "~/utils/db/tenants.db.server";
import { getUsersById } from "~/utils/db/users.db.server";
import { getFiltersFromCurrentUrl, getPaginationFromCurrentUrl } from "~/utils/helpers/RowPaginationHelper";
import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService";
import { validateCSRFToken } from "~/utils/session.server";
import { OnboardingSessionsIndexApi } from "./OnboardingSessionsIndexApi.server";
vi.mock("~/locale/i18next.server", () => ({ getTranslations: vi.fn() }));
vi.mock("~/modules/onboarding/db/onboarding.db.server", () => ({ getOnboardings: vi.fn() }));
vi.mock("~/modules/onboarding/db/onboardingSessionSteps.db.server", () => ({ deleteOnboardingSessionStepsInOnboardingSession: vi.fn() }));
vi.mock("~/modules/onboarding/db/onboardingSessions.db.server", () => ({
deleteOnboardingSession: vi.fn(),
getOnboardingSessionInOnboarding: vi.fn(),
getOnboardingSessionsWithPagination: vi.fn(),
groupOnboardingSessionsByUser: vi.fn(),
}));
vi.mock("~/modules/onboarding/services/OnboardingService", () => ({ default: { getMetadata: vi.fn() } }));
vi.mock("~/utils/db/tenants.db.server", () => ({ adminGetAllTenantsIdsAndNames: vi.fn() }));
vi.mock("~/utils/db/users.db.server", () => ({ getUsersById: vi.fn() }));
vi.mock("~/utils/helpers/RowPaginationHelper", () => ({ getFiltersFromCurrentUrl: vi.fn(), getPaginationFromCurrentUrl: vi.fn() }));
vi.mock("~/utils/helpers/.server/PermissionsService", () => ({ verifyUserHasPermission: vi.fn() }));
vi.mock("~/utils/session.server", () => ({ validateCSRFToken: vi.fn() }));
const mockedGetTranslations = vi.mocked(getTranslations);
const mockedGetOnboardings = vi.mocked(getOnboardings);
const mockedGroupOnboardingSessionsByUser = vi.mocked(groupOnboardingSessionsByUser);
const mockedGetUsersById = vi.mocked(getUsersById);
const mockedAdminGetAllTenantsIdsAndNames = vi.mocked(adminGetAllTenantsIdsAndNames);
const mockedGetFiltersFromCurrentUrl = vi.mocked(getFiltersFromCurrentUrl);
const mockedGetPaginationFromCurrentUrl = vi.mocked(getPaginationFromCurrentUrl);
const mockedGetOnboardingSessionsWithPagination = vi.mocked(getOnboardingSessionsWithPagination);
const mockedGetOnboardingSessionInOnboarding = vi.mocked(getOnboardingSessionInOnboarding);
const mockedDeleteOnboardingSessionStepsInOnboardingSession = vi.mocked(deleteOnboardingSessionStepsInOnboardingSession);
const mockedDeleteOnboardingSession = vi.mocked(deleteOnboardingSession);
const mockedGetMetadata = vi.mocked(OnboardingService.getMetadata);
const mockedVerifyUserHasPermission = vi.mocked(verifyUserHasPermission);
const mockedValidateCSRFToken = vi.mocked(validateCSRFToken);
function requestWithTenantFilter(tenantId?: string) {
const url = new URL("https://admin.example.test/onboardings/onboarding-1/sessions");
if (tenantId !== undefined) {
url.searchParams.set("tenantId", tenantId);
}
return new Request(url);
}
async function callLoader(tenantFilterValue: string | null) {
mockedGetFiltersFromCurrentUrl.mockReturnValue({
query: undefined,
properties: [
{ name: "onboardingId", title: "onboarding.title", options: [], value: null },
{ name: "userId", title: "models.user.object", options: [], value: null },
{ name: "tenantId", title: "models.tenant.object", options: [], value: tenantFilterValue },
],
});
await OnboardingSessionsIndexApi.loader({
request: requestWithTenantFilter(tenantFilterValue ?? undefined),
params: { id: "onboarding-1" },
context: {},
} as unknown as LoaderFunctionArgs);
}
describe("OnboardingSessionsIndexApi tenant filter composition", () => {
beforeEach(() => {
vi.clearAllMocks();
mockedVerifyUserHasPermission.mockResolvedValue(undefined as any);
mockedGetTranslations.mockResolvedValue({ t: (key: string) => key } as any);
mockedGetOnboardings.mockResolvedValue([{ id: "onboarding-1", title: "Tenant onboarding" }] as any);
mockedGroupOnboardingSessionsByUser.mockResolvedValue([{ userId: "user-1" }] as any);
mockedGetUsersById.mockResolvedValue([{ id: "user-1", email: "user@example.test", firstName: "User", lastName: "One" }] as any);
mockedAdminGetAllTenantsIdsAndNames.mockResolvedValue([{ id: "tenant-1", name: "Tenant One" }] as any);
mockedGetPaginationFromCurrentUrl.mockReturnValue({ page: 2, pageSize: 25, sortedBy: [], query: "" });
mockedGetOnboardingSessionsWithPagination.mockResolvedValue({
items: [],
pagination: { page: 2, pageSize: 25, totalItems: 0, totalPages: 0 },
} as any);
mockedValidateCSRFToken.mockResolvedValue(undefined as never);
mockedGetMetadata.mockResolvedValue({} as any);
});
it("maps the admin {Admin} tenant filter to null while preserving the onboarding id", async () => {
await callLoader("null");
expect(mockedGetOnboardingSessionsWithPagination).toHaveBeenCalledWith({
pagination: { page: 2, pageSize: 25, sortedBy: [], query: "" },
where: {
onboardingId: "onboarding-1",
tenantId: null,
},
});
});
it("passes a concrete tenant filter through while preserving the onboarding id", async () => {
await callLoader("tenant-1");
expect(mockedGetOnboardingSessionsWithPagination).toHaveBeenCalledWith({
pagination: { page: 2, pageSize: 25, sortedBy: [], query: "" },
where: {
onboardingId: "onboarding-1",
tenantId: "tenant-1",
},
});
});
it("leaves tenantId undefined when no tenant filter is selected", async () => {
await callLoader(null);
expect(mockedGetOnboardingSessionsWithPagination).toHaveBeenCalledWith({
pagination: { page: 2, pageSize: 25, sortedBy: [], query: "" },
where: {
onboardingId: "onboarding-1",
tenantId: undefined,
},
});
});
it("scopes session deletes to the current onboarding before deleting child steps", async () => {
mockedGetOnboardingSessionInOnboarding.mockResolvedValue({ id: "session-1", sessionSteps: [{ id: "step-1" }] } as any);
const response = await OnboardingSessionsIndexApi.action({
request: new Request("https://admin.example.test/onboardings/onboarding-1/sessions", {
method: "POST",
headers: { "Content-Type": "application/x-www-form-urlencoded" },
body: new URLSearchParams({ action: "delete", id: "session-1" }).toString(),
}),
params: { id: "onboarding-1" },
context: {},
} as any);
expect(response.status).toBe(200);
expect(mockedGetOnboardingSessionInOnboarding).toHaveBeenCalledWith({ id: "session-1", onboardingId: "onboarding-1" });
expect(mockedDeleteOnboardingSessionStepsInOnboardingSession).toHaveBeenCalledWith({
onboardingSessionId: "session-1",
onboardingId: "onboarding-1",
});
expect(mockedDeleteOnboardingSession).toHaveBeenCalledWith({ id: "session-1", onboardingId: "onboarding-1" });
});
});