import { describe, expect, it, vi } from "vitest"; import { DefaultFeatures } from "~/application/dtos/shared/DefaultFeatures"; import { evaluateDashboardModuleGates, getDashboardModuleDiagnostics, getVisibleDashboardModules, type DashboardModuleGateDiagnostic, } from "./gating.server"; import { dashboardRegistryEvidence, getDashboardModuleDefinitions, type DashboardModuleDefinition } from "./registry.server"; const request = new Request("https://app.example.com/acme/dashboard?tenantId=tenant_123&token=secret-token"); const params = { tenant: "acme", tenantId: "tenant_123" }; const summaryModule = { id: "summary-stats", titleKey: "app.dashboard.modules.summaryStats.title", descriptionKey: "app.dashboard.modules.summaryStats.description", } as const satisfies DashboardModuleDefinition; const featureModule = { id: "subscription-health", titleKey: "app.dashboard.modules.subscriptionHealth.title", descriptionKey: "app.dashboard.modules.subscriptionHealth.description", featureFlagKey: "tenant.subscription.active", } as const satisfies DashboardModuleDefinition; const planModule = { id: "priority-insights", titleKey: "app.dashboard.modules.priorityInsights.title", descriptionKey: "app.dashboard.modules.priorityInsights.description", planFeatureKey: DefaultFeatures.PrioritySupport, } as const satisfies DashboardModuleDefinition; function entitlementService(allowed: boolean) { return vi.fn(() => ({ allowed, reason: allowed ? ("included" as const) : ("missing-subscription" as const), featureKey: DefaultFeatures.PrioritySupport, })); } const sensitiveSamples = [ "tenant_123", "secret-token", "user_456", "subscription_789", "provider_api_key_live", "raw-feature-input=tenant.subscription.active", "DATABASE_URL", "bearer jwt-token", ] as const; function expectSafeStaticPayload(payload: unknown) { const serialized = JSON.stringify(payload); for (const sample of sensitiveSamples) { expect(serialized).not.toContain(sample); } expect(serialized).not.toMatch(/user[_-]?\d+|subscription[_-]?\d+|provider[_-]?api[_-]?key|bearer\s+jwt|jwt-token|secret-token/i); } function expectDiagnosticsRedacted(diagnostics: readonly DashboardModuleGateDiagnostic[]) { expectSafeStaticPayload(diagnostics); } describe("dashboard module registry", () => { it("defines stable module contracts for summary, plan-gated, and feature-gated modules", () => { expect(getDashboardModuleDefinitions()).toEqual( expect.arrayContaining([ expect.objectContaining({ id: "summary-stats" }), expect.objectContaining({ id: "priority-insights", planFeatureKey: DefaultFeatures.PrioritySupport }), expect.objectContaining({ id: "subscription-health", featureFlagKey: "tenant.subscription.active" }), ]), ); }); it("exports source-backed registry evidence with stable IDs and gate coverage", () => { const definitions = getDashboardModuleDefinitions(); expect(dashboardRegistryEvidence.registryName).toBe("Tenant/Workspace Dashboard"); expect(dashboardRegistryEvidence.registryScope).toBe("tenant-workspace-dashboard-modules"); expect(dashboardRegistryEvidence.expectedModuleIds).toEqual(definitions.map((module) => module.id)); expect(dashboardRegistryEvidence.expectedModuleIds).toEqual(["summary-stats", "priority-insights", "subscription-health"]); expect(dashboardRegistryEvidence.gatingSourcesRepresented).toEqual(["feature-flag", "plan"]); expect(definitions.find((module) => module.id === "summary-stats")).toEqual(expect.not.objectContaining({ featureFlagKey: expect.any(String) })); expect(definitions.find((module) => module.id === "summary-stats")).toEqual(expect.not.objectContaining({ planFeatureKey: expect.any(String) })); expect(definitions.find((module) => module.id === "priority-insights")).toEqual( expect.objectContaining({ planFeatureKey: DefaultFeatures.PrioritySupport }), ); expect(definitions.find((module) => module.id === "subscription-health")).toEqual( expect.objectContaining({ featureFlagKey: "tenant.subscription.active" }), ); }); it("keeps registry evidence limited to safe static metadata", () => { expect(dashboardRegistryEvidence.redactionGuarantee).toContain("static source metadata only"); expect(dashboardRegistryEvidence.redactionGuarantee).toContain("excludes request, tenant, subscription, user, token, environment, and raw feature input values"); expect(dashboardRegistryEvidence.expectedModuleIds.length).toBe(getDashboardModuleDefinitions().length); expectSafeStaticPayload(dashboardRegistryEvidence); }); }); describe("evaluateDashboardModuleGates", () => { it("returns visible modules when all gates allow access", async () => { const decisions = await evaluateDashboardModuleGates({ request, params, definitions: [summaryModule, featureModule, planModule], services: { hasFeatureFlag: vi.fn(async () => true), evaluateSubscriptionEntitlement: entitlementService(true), }, }); expect(getVisibleDashboardModules(decisions).map((module) => module.id)).toEqual(["summary-stats", "subscription-health", "priority-insights"]); expect(getDashboardModuleDiagnostics(decisions)).toEqual([]); }); it("denies only a disabled feature-flagged module", async () => { const decisions = await evaluateDashboardModuleGates({ request, params, definitions: [summaryModule, featureModule, planModule], services: { hasFeatureFlag: vi.fn(async () => false), evaluateSubscriptionEntitlement: entitlementService(true), }, }); expect(getVisibleDashboardModules(decisions).map((module) => module.id)).toEqual(["summary-stats", "priority-insights"]); expect(getDashboardModuleDiagnostics(decisions)).toEqual([ { moduleId: "subscription-health", source: "feature-flag", reason: "feature-disabled", redirectPath: "/feature-disabled", }, ]); }); it("denies only the gated module when feature flag lookup fails", async () => { const decisions = await evaluateDashboardModuleGates({ request, params, definitions: [summaryModule, featureModule], services: { hasFeatureFlag: vi.fn(async () => { throw new Error("backend unavailable for tenant_123 with token secret-token"); }), }, }); expect(getVisibleDashboardModules(decisions).map((module) => module.id)).toEqual(["summary-stats"]); expect(getDashboardModuleDiagnostics(decisions)).toEqual([ { moduleId: "subscription-health", source: "feature-flag", reason: "feature-check-failed", redirectPath: "/feature-disabled", }, ]); }); it("denies missing plan entitlement with plan-required diagnostics", async () => { const decisions = await evaluateDashboardModuleGates({ request, params, definitions: [summaryModule, planModule], subscription: { products: [] }, services: { evaluateSubscriptionEntitlement: entitlementService(false), }, }); expect(getVisibleDashboardModules(decisions).map((module) => module.id)).toEqual(["summary-stats"]); expect(getDashboardModuleDiagnostics(decisions)).toEqual([ { moduleId: "priority-insights", source: "plan", reason: "plan-required", redirectPath: "plan-required", }, ]); }); it("keeps denied diagnostics redacted from tenant, subscription, user, and token inputs", async () => { const decisions = await evaluateDashboardModuleGates({ request, params, definitions: [featureModule, planModule], subscription: { products: [] }, services: { hasFeatureFlag: vi.fn(async () => false), evaluateSubscriptionEntitlement: entitlementService(false), }, redirectPaths: { "feature-flag": "/feature-disabled", plan: "plan-required", }, }); expect(getDashboardModuleDiagnostics(decisions)).toEqual([ expect.objectContaining({ moduleId: "subscription-health", source: "feature-flag", reason: "feature-disabled" }), expect.objectContaining({ moduleId: "priority-insights", source: "plan", reason: "plan-required" }), ]); expectDiagnosticsRedacted(getDashboardModuleDiagnostics(decisions)); }); });