Refresh HiveGrid Cloud reference snapshot
This commit is contained in:
1 parent
5e99e14772
commit
7f88026f79
5955 files changed
+1177325
-188362
No files matched your search
+41
-45
@@ -1,22 +1,29 @@
|
||||
import { ActionFunctionArgs, Form, Link, LoaderFunctionArgs, useLoaderData, useParams } from "react-router";
|
||||
import { useTranslation } from "react-i18next";
|
||||
import type { FirstStepsChecklistVM } from "@hivegrid/view-models";
|
||||
import { toFirstStepsChecklistVM } from "@hivegrid/view-models";
|
||||
import { ActionFunctionArgs, LoaderFunctionArgs, useActionData, useLoaderData, useNavigate, useNavigation, useRevalidator, useSubmit } from "react-router";
|
||||
|
||||
import EditPageLayout from "~/components/ui/layouts/EditPageLayout";
|
||||
import SettingSection from "~/components/ui/sections/SettingSection";
|
||||
import { FirstStepsChecklistPage } from "~/components/screens/onboarding/FirstStepsChecklistPage";
|
||||
import UrlUtils from "~/utils/app/UrlUtils";
|
||||
import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService";
|
||||
import { getTenantIdFromUrl } from "~/utils/services/.server/urlService";
|
||||
import { getUserInfo, validateCSRFToken } from "~/utils/session.server";
|
||||
import { getFirstStepsChecklist, updateFirstStepsChecklist } from "~/utils/services/.server/akP20OnboardingService";
|
||||
import { useRootData } from "~/utils/data/useRootData";
|
||||
import { useSaveToast, type SaveActionResult } from "~/hooks/use-save-toast";
|
||||
|
||||
type LoaderData = Awaited<ReturnType<typeof getFirstStepsChecklist>>;
|
||||
type LoaderData = { vm: FirstStepsChecklistVM };
|
||||
|
||||
export const loader = async ({ request, params }: LoaderFunctionArgs) => {
|
||||
const tenantId = await getTenantIdFromUrl(params);
|
||||
await verifyUserHasPermission(request, "app.onboarding.checklist.update", tenantId);
|
||||
const userInfo = await getUserInfo(request);
|
||||
return await getFirstStepsChecklist({ tenantId, userId: userInfo.userId });
|
||||
const checklist = await getFirstStepsChecklist({ tenantId, userId: userInfo.userId });
|
||||
return {
|
||||
vm: toFirstStepsChecklistVM({
|
||||
...checklist,
|
||||
items: checklist.items.map((item) => ({ ...item, href: UrlUtils.currentTenantUrl(params, item.href) })),
|
||||
}),
|
||||
} satisfies LoaderData;
|
||||
};
|
||||
|
||||
export const action = async ({ request, params }: ActionFunctionArgs) => {
|
||||
@@ -27,59 +34,48 @@ export const action = async ({ request, params }: ActionFunctionArgs) => {
|
||||
const form = await request.formData();
|
||||
const action = form.get("action")?.toString();
|
||||
|
||||
if (action === "complete" || action === "hide") {
|
||||
if (action === "complete" || action === "hide" || action === "show") {
|
||||
await updateFirstStepsChecklist({
|
||||
tenantId,
|
||||
userId: userInfo.userId,
|
||||
action,
|
||||
sessionStepId: form.get("sessionStepId")?.toString(),
|
||||
});
|
||||
return Response.json({ ok: true });
|
||||
return Response.json({ intent: action, ok: true });
|
||||
}
|
||||
return Response.json({ error: "shared.invalidAction" }, { status: 400 });
|
||||
};
|
||||
|
||||
export default function FirstStepsChecklistRoute() {
|
||||
const { t } = useTranslation();
|
||||
const { csrf } = useRootData();
|
||||
const routeParams = useParams();
|
||||
const data = useLoaderData<LoaderData>();
|
||||
const navigate = useNavigate();
|
||||
const navigation = useNavigation();
|
||||
const revalidator = useRevalidator();
|
||||
const submit = useSubmit();
|
||||
const actionData = useActionData<SaveActionResult>();
|
||||
|
||||
useSaveToast(actionData, { reportSuccess: false });
|
||||
|
||||
const submitAction = (action: "complete" | "hide" | "show", sessionStepId?: string) => {
|
||||
const formData = new FormData();
|
||||
formData.set("csrf", csrf ?? "");
|
||||
formData.set("action", action);
|
||||
if (sessionStepId) formData.set("sessionStepId", sessionStepId);
|
||||
void submit(formData, { method: "post" });
|
||||
};
|
||||
|
||||
return (
|
||||
<EditPageLayout title={t("onboarding.firstSteps.title")}>
|
||||
<SettingSection title={t("onboarding.firstSteps.title")} description={t("onboarding.firstSteps.description")}>
|
||||
<div className="space-y-3">
|
||||
{data.items.map((item) => (
|
||||
<div key={item.id} className="flex items-center justify-between gap-3 rounded-md border p-3">
|
||||
<div>
|
||||
<div className="font-medium">{t(item.titleKey)}</div>
|
||||
<Link className="text-primary text-sm underline" to={UrlUtils.currentTenantUrl(routeParams, item.href)}>
|
||||
{t("onboarding.firstSteps.open")}
|
||||
</Link>
|
||||
</div>
|
||||
{!item.completed ? (
|
||||
<Form method="post">
|
||||
<input type="hidden" name="csrf" value={csrf ?? ""} />
|
||||
<input type="hidden" name="action" value="complete" />
|
||||
<input type="hidden" name="sessionStepId" value={item.id} />
|
||||
<button type="submit" className="rounded-md border px-3 py-2 text-sm font-medium">
|
||||
{t("onboarding.firstSteps.complete")}
|
||||
</button>
|
||||
</Form>
|
||||
) : (
|
||||
<span className="text-muted-foreground text-sm">{t("onboarding.firstSteps.completed")}</span>
|
||||
)}
|
||||
</div>
|
||||
))}
|
||||
<Form method="post">
|
||||
<input type="hidden" name="csrf" value={csrf ?? ""} />
|
||||
<input type="hidden" name="action" value="hide" />
|
||||
<button type="submit" className="text-muted-foreground text-sm underline">
|
||||
{t("onboarding.firstSteps.hide")}
|
||||
</button>
|
||||
</Form>
|
||||
</div>
|
||||
</SettingSection>
|
||||
</EditPageLayout>
|
||||
<FirstStepsChecklistPage
|
||||
vm={data.vm}
|
||||
busy={navigation.state !== "idle"}
|
||||
actions={{
|
||||
onComplete: (sessionStepId) => submitAction("complete", sessionStepId),
|
||||
onDismiss: () => submitAction("hide"),
|
||||
onReopen: () => submitAction("show"),
|
||||
onOpen: (href) => navigate(href),
|
||||
onRetry: () => revalidator.revalidate(),
|
||||
}}
|
||||
/>
|
||||
);
|
||||
}
|
||||
+91
@@ -0,0 +1,91 @@
|
||||
// @vitest-environment node
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import type { LoaderFunctionArgs } from "react-router";
|
||||
|
||||
const mocks = vi.hoisted(() => ({
|
||||
getTranslations: vi.fn(),
|
||||
getTenantIdFromUrl: vi.fn(),
|
||||
getUserInfo: vi.fn(),
|
||||
verifyUserHasPermission: vi.fn(),
|
||||
getUser: vi.fn(),
|
||||
getTenant: vi.fn(),
|
||||
getFirstStepsChecklist: vi.fn(),
|
||||
runWithRlsContext: vi.fn((_context: unknown, operation: () => unknown) => operation()),
|
||||
}));
|
||||
|
||||
vi.mock("@hivegrid/db/rls-context.server", () => ({ runWithRlsContext: (...args: unknown[]) => mocks.runWithRlsContext(...args) }));
|
||||
vi.mock("~/locale/i18next.server", () => ({ getTranslations: (...args: unknown[]) => mocks.getTranslations(...args) }));
|
||||
vi.mock("~/utils/services/.server/urlService", () => ({ getTenantIdFromUrl: (...args: unknown[]) => mocks.getTenantIdFromUrl(...args) }));
|
||||
vi.mock("~/utils/session.server", () => ({ getUserInfo: (...args: unknown[]) => mocks.getUserInfo(...args) }));
|
||||
vi.mock("~/utils/helpers/.server/PermissionsService", () => ({
|
||||
verifyUserHasPermission: (...args: unknown[]) => mocks.verifyUserHasPermission(...args),
|
||||
}));
|
||||
vi.mock("~/utils/db/users.db.server", () => ({ getUser: (...args: unknown[]) => mocks.getUser(...args) }));
|
||||
vi.mock("~/utils/db/tenants.db.server", () => ({ getTenant: (...args: unknown[]) => mocks.getTenant(...args) }));
|
||||
vi.mock("~/utils/services/.server/akP20OnboardingService", () => ({
|
||||
getFirstStepsChecklist: (...args: unknown[]) => mocks.getFirstStepsChecklist(...args),
|
||||
}));
|
||||
vi.mock("~/utils/app/UrlUtils", () => ({
|
||||
default: { currentTenantUrl: ({ tenant }: { tenant?: string }, path: string) => `/${tenant}/${path}` },
|
||||
}));
|
||||
|
||||
import { loader } from "./welcome";
|
||||
|
||||
const request = new Request("https://app.example.test/acme/onboarding/welcome");
|
||||
const params = { tenant: "acme" };
|
||||
|
||||
describe("welcome setup loader", () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
process.env.APP_NAME = "HiveGrid";
|
||||
mocks.getTranslations.mockResolvedValue({ t: (key: string) => key });
|
||||
mocks.getTenantIdFromUrl.mockResolvedValue("tenant_1");
|
||||
mocks.getUserInfo.mockResolvedValue({ userId: "user_1" });
|
||||
mocks.getUser.mockResolvedValue({ id: "user_1", firstName: "Ada" });
|
||||
mocks.getTenant.mockResolvedValue({ id: "tenant_1", name: "Acme", slug: "acme" });
|
||||
mocks.getFirstStepsChecklist.mockResolvedValue({
|
||||
id: "session_1",
|
||||
status: "active",
|
||||
dismissed: false,
|
||||
items: [
|
||||
{ id: "profile", block: "profile", titleKey: "onboarding.firstSteps.profile", href: "settings/profile", completed: true },
|
||||
{
|
||||
id: "team",
|
||||
block: "team",
|
||||
titleKey: "onboarding.firstSteps.team",
|
||||
href: "settings/team/members/new",
|
||||
completed: false,
|
||||
canComplete: false,
|
||||
},
|
||||
],
|
||||
});
|
||||
});
|
||||
|
||||
it("builds a tenant-scoped welcome VM with the first unfinished task", async () => {
|
||||
const data = await loader({ request, params, context: {}, unstable_pattern: "app.$tenant/onboarding/welcome" } as LoaderFunctionArgs);
|
||||
|
||||
expect(mocks.verifyUserHasPermission).toHaveBeenCalledWith(request, "app.onboarding.checklist.update", "tenant_1");
|
||||
expect(mocks.runWithRlsContext).toHaveBeenCalledWith({ tenantId: "tenant_1", userId: "user_1" }, expect.any(Function));
|
||||
expect(data).toMatchObject({
|
||||
title: "onboarding.welcome.metaTitle | HiveGrid",
|
||||
homeHref: "/acme/dashboard",
|
||||
vm: {
|
||||
status: "ready",
|
||||
data: {
|
||||
firstName: "Ada",
|
||||
workspaceName: "Acme",
|
||||
dashboardHref: "/acme/dashboard",
|
||||
nextItem: { id: "team", href: "/acme/settings/team/members/new", canComplete: false },
|
||||
},
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it("fails closed when the tenant is no longer visible in the bound RLS context", async () => {
|
||||
mocks.getTenant.mockResolvedValueOnce(null);
|
||||
|
||||
await expect(loader({ request, params, context: {}, unstable_pattern: "app.$tenant/onboarding/welcome" } as LoaderFunctionArgs)).rejects.toMatchObject({
|
||||
status: 404,
|
||||
});
|
||||
});
|
||||
});
|
||||
+57
@@ -0,0 +1,57 @@
|
||||
import { runWithRlsContext } from "@hivegrid/db/rls-context.server";
|
||||
import { toFirstStepsChecklistVM, toWelcomeSetupVM, type WelcomeSetupVM } from "@hivegrid/view-models";
|
||||
import { LoaderFunctionArgs, useLoaderData, useNavigate, useRevalidator } from "react-router";
|
||||
|
||||
import { WelcomeSetupPage } from "~/components/screens/onboarding/WelcomeSetupPage";
|
||||
import { getTranslations } from "~/locale/i18next.server";
|
||||
import UrlUtils from "~/utils/app/UrlUtils";
|
||||
import { getTenant } from "~/utils/db/tenants.db.server";
|
||||
import { getUser } from "~/utils/db/users.db.server";
|
||||
import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService";
|
||||
import { getTenantIdFromUrl } from "~/utils/services/.server/urlService";
|
||||
import { getFirstStepsChecklist } from "~/utils/services/.server/akP20OnboardingService";
|
||||
import { getUserInfo } from "~/utils/session.server";
|
||||
|
||||
type LoaderData = { title: string; vm: WelcomeSetupVM; homeHref: string };
|
||||
|
||||
export const loader = async ({ request, params }: LoaderFunctionArgs) => {
|
||||
const [{ t }, tenantId, userInfo] = await Promise.all([getTranslations(request), getTenantIdFromUrl(params), getUserInfo(request)]);
|
||||
await verifyUserHasPermission(request, "app.onboarding.checklist.update", tenantId);
|
||||
const [user, tenant, checklist] = await runWithRlsContext({ tenantId, userId: userInfo.userId }, () =>
|
||||
Promise.all([getUser(userInfo.userId), getTenant(tenantId), getFirstStepsChecklist({ tenantId, userId: userInfo.userId })])
|
||||
);
|
||||
if (!user || !tenant) throw new Response(null, { status: 404 });
|
||||
|
||||
const checklistVm = toFirstStepsChecklistVM({
|
||||
...checklist,
|
||||
items: checklist.items.map((item) => ({ ...item, href: UrlUtils.currentTenantUrl(params, item.href) })),
|
||||
});
|
||||
return {
|
||||
title: `${t("onboarding.welcome.metaTitle")} | ${process.env.APP_NAME}`,
|
||||
homeHref: UrlUtils.currentTenantUrl(params, "dashboard"),
|
||||
vm: toWelcomeSetupVM({
|
||||
firstName: user.firstName,
|
||||
workspaceName: tenant.name,
|
||||
dashboardHref: UrlUtils.currentTenantUrl(params, "dashboard"),
|
||||
checklist: checklistVm,
|
||||
}),
|
||||
} satisfies LoaderData;
|
||||
};
|
||||
|
||||
export default function WelcomeSetupRoute() {
|
||||
const data = useLoaderData<LoaderData>();
|
||||
const navigate = useNavigate();
|
||||
const revalidator = useRevalidator();
|
||||
|
||||
return (
|
||||
<WelcomeSetupPage
|
||||
vm={data.vm}
|
||||
homeHref={data.homeHref}
|
||||
actions={{
|
||||
onOpen: (href) => navigate(href),
|
||||
onDashboard: (href) => navigate(href),
|
||||
onRetry: () => revalidator.revalidate(),
|
||||
}}
|
||||
/>
|
||||
);
|
||||
}
|
||||
Reference in new issue
Block a user