import "@testing-library/jest-dom"; import React from "react"; import { render, screen } from "@testing-library/react"; import { MemoryRouter } from "react-router"; import { afterEach, describe, expect, it, vi } from "vitest"; import type { SideBarItem } from "~/application/sidebar/SidebarItem"; import { UI_NAV_IDS, UI_SURFACE_IDS, getSidebarSurfaceId, type UiLayout } from "~/application/ui/uiRegistry"; import { SidebarProvider } from "~/components/ui/sidebar"; import { ShadcnAppSidebar } from "./app-sidebar"; vi.mock("~/hooks/use-mobile", () => ({ useIsMobile: () => false, })); vi.mock("react-i18next", () => ({ useTranslation: () => ({ t: (value: string) => value }), })); vi.mock("~/utils/data/useRootData", () => ({ useRootData: () => ({ appConfiguration: null }), })); let mockedPermissions = ["app.dashboard.view"]; let mockedCurrentTenant: null | { slug: string; logo: string } = null; vi.mock("~/utils/data/useAppOrAdminData", () => ({ useAppOrAdminData: () => ({ currentTenant: mockedCurrentTenant, entities: [], entityGroups: [], myTenants: [], permissions: mockedPermissions, user: { id: "user_1", email: "user@example.com", firstName: "User", lastName: "Example" }, }), })); vi.mock("./nav-user", () => ({ NavUser: ({ layout }: { layout: string }) =>
User {layout}
, })); const baseItems = [ { id: "ui.nav.test.main", title: "Main", path: "", items: [{ id: UI_NAV_IDS.appDashboard, title: "Dashboard", path: "/acme/dashboard" }], }, { id: "ui.nav.test.quick", title: "Quick", path: "", isQuickLink: true, items: [{ id: "ui.nav.test.quick.reports", title: "Reports", path: "/reports" }], }, { id: "ui.nav.test.secondary", title: "Secondary", path: "", isSecondary: true, items: [{ id: UI_NAV_IDS.appSettings, title: "Settings", path: "/acme/settings" }], }, ]; function renderSidebar(layout: UiLayout = "app", initialPath = "/") { return render( ); } function expectNoDuplicateDataUiIds() { const ids = [...document.querySelectorAll("[data-ui-id]")].map((element) => element.getAttribute("data-ui-id")); expect(new Set(ids).size).toBe(ids.length); } describe("ShadcnAppSidebar UI IDs", () => { afterEach(() => { mockedPermissions = ["app.dashboard.view"]; mockedCurrentTenant = null; }); it.each(["app", "admin", "docs"])("renders %s sidebar structure with stable data-ui-id attributes", (layout) => { renderSidebar(layout); const surfaceId = getSidebarSurfaceId(layout); expect(document.querySelector(`[data-ui-id="${surfaceId}"]`)).toBeInTheDocument(); expect(document.querySelector(`[data-ui-id="${surfaceId}.header"]`)).toBeInTheDocument(); expect(document.querySelector(`[data-ui-id="${surfaceId}.content"]`)).toBeInTheDocument(); expect(document.querySelector(`[data-ui-id="${surfaceId}.footer"]`)).toBeInTheDocument(); expect(screen.getByRole("link", { name: "Dashboard" })).toHaveAttribute("data-ui-id", UI_NAV_IDS.appDashboard); expect(screen.getByRole("link", { name: "Settings" })).toHaveAttribute("data-ui-id", UI_NAV_IDS.appSettings); expect(screen.getByRole("link", { name: "Reports" })).toHaveAttribute("data-ui-id", "ui.nav.test.quick.reports"); expect(screen.queryByText("View Project")).not.toBeInTheDocument(); expectNoDuplicateDataUiIds(); }); it("marks only exact host-aware sibling routes as active without mutating source items", () => { const nestedItems: SideBarItem[] = [ { id: "ui.nav.test.main", title: "Main", path: "", items: [ { id: "ui.nav.test.accounts", title: "Accounts", path: "/acme/accounts", exact: true }, { id: "ui.nav.test.accounting", title: "Accounting", path: "/acme/accounting" }, ], }, ]; render( ); expect(screen.getByRole("link", { name: "Accounts" })).toHaveAttribute("data-active", "true"); expect(screen.getByRole("link", { name: "Accounting" })).toHaveAttribute("data-active", "false"); expect(nestedItems[0]?.items?.[0]?.isActive).toBeUndefined(); }); it("uses redirect targets for links but base paths for active matching", () => { const secondaryItems: SideBarItem[] = [ { id: "ui.nav.test.secondary", title: "Secondary", path: "", isSecondary: true, items: [ { id: UI_NAV_IDS.appSettings, title: "Settings", path: "/acme/settings", redirectTo: "/acme/settings/profile", }, ], }, ]; render( ); expect(screen.getByRole("link", { name: "Settings" })).toHaveAttribute("href", "/acme/settings/profile"); expect(screen.getByRole("link", { name: "Settings" })).toHaveAttribute("data-active", "true"); }); it("does not render tenant logo links inside the admin sidebar", () => { mockedCurrentTenant = { slug: "acme", logo: "/tenant-logo.svg" }; renderSidebar("admin", "/dashboard"); expect(screen.queryByAltText("Logo")).not.toBeInTheDocument(); expect(screen.queryByRole("link", { name: "Logo" })).not.toBeInTheDocument(); }); it("filters sidebar items by declared permission", () => { const permissionItems: SideBarItem[] = [ { id: "ui.nav.test.main", title: "Main", path: "", items: [ { id: "ui.nav.test.allowed", title: "Allowed", path: "/acme/allowed", permission: "app.dashboard.view" }, { id: "ui.nav.test.denied", title: "Denied", path: "/acme/denied", permission: "app.settings.account.update" }, ], }, ]; render( ); expect(screen.getByRole("link", { name: "Allowed" })).toBeInTheDocument(); expect(screen.queryByRole("link", { name: "Denied" })).not.toBeInTheDocument(); }); it("hides disabled quick links", () => { const quickLinkItems: SideBarItem[] = [ { id: "ui.nav.test.quick", title: "Quick", path: "", isQuickLink: true, items: [ { id: "ui.nav.test.quick.allowed", title: "Reports", path: "/reports" }, { id: "ui.nav.test.quick.disabled", title: "Disabled Report", path: "/disabled-report", disabled: true }, ], }, ]; render( ); expect(screen.getByRole("link", { name: "Reports" })).toBeInTheDocument(); expect(screen.queryByRole("link", { name: "Disabled Report" })).not.toBeInTheDocument(); }); it("renders permitted expandable parents as flat section headers", () => { mockedPermissions = ["admin.accounts.view", "admin.users.view"]; const permissionItems: SideBarItem[] = [ { id: "ui.nav.test.main", title: "Main", path: "", items: [ { id: "ui.nav.test.accounts", title: "Accounts", path: "/accounts", permission: "admin.accounts.view", items: [{ id: "ui.nav.test.accounts.users", title: "Users", path: "/accounts/users", permission: "admin.users.view" }], }, ], }, ]; render( ); // Subframe flat sidebar: an expandable parent is a non-interactive section header (not a button/link). expect(document.querySelector('[data-ui-id="ui.nav.test.accounts"]')).toBeInTheDocument(); expect(screen.queryByRole("button", { name: "Accounts" })).not.toBeInTheDocument(); expect(screen.queryByRole("link", { name: "Accounts" })).not.toBeInTheDocument(); }); it("keeps a denied parent visible when at least one child is allowed", () => { mockedPermissions = ["admin.users.view"]; const permissionItems: SideBarItem[] = [ { id: "ui.nav.test.main", title: "Main", path: "", items: [ { id: "ui.nav.test.accounts", title: "Accounts", path: "/accounts", permission: "admin.accounts.view", items: [ { id: "ui.nav.test.accounts.users", title: "Users", path: "/accounts/users", permission: "admin.users.view" }, { id: "ui.nav.test.accounts.roles", title: "Roles", path: "/accounts/roles", permission: "admin.roles.view" }, ], }, ], }, ]; render( ); expect(screen.getByText("Accounts")).toBeInTheDocument(); expect(screen.queryByRole("button", { name: /Accounts/ })).not.toBeInTheDocument(); expect(screen.queryByRole("link", { name: "Accounts" })).not.toBeInTheDocument(); expect(screen.getByRole("link", { name: "Users" })).toBeInTheDocument(); expect(screen.queryByRole("link", { name: "Roles" })).not.toBeInTheDocument(); }); it("keeps central surface constants stable", () => { expect(UI_SURFACE_IDS.appSidebar).toBe("ui.surface.app.sidebar"); expect(UI_SURFACE_IDS.adminSidebar).toBe("ui.surface.admin.sidebar"); expect(UI_SURFACE_IDS.docsSidebar).toBe("ui.surface.docs.sidebar"); }); });