Files
Ekklesia/core/tests/module-permissions.test.ts
T
ekklesiaandClaude Opus 5 bd34c9c714
CI / verify (pull_request) Successful in 34s
CI / infrastructure-smoke (pull_request) Successful in 12s
CI / migration-smoke (pull_request) Successful in 44s
feat: add Dashboard navigation as presentation configuration
Phase 6D pass 1. The shell's navigation was a flat list of module ids, which
is not a usable experience — and the obvious fix carries an obvious trap.
Letting a module declare its folder, or modelling "Media" as something
Livestream and Video belong to, turns a rendering preference into
architecture: a folder becomes an owner, membership starts to look like a
dependency, and the flat module graph acquires a hierarchy nobody decided on.

So the rule comes first: a Dashboard group is a label on a rendering bucket.
No manifest, no version, no artifact, no API, no lifecycle; nothing depends on
it. Livestream depends on Video because it calls Video's functionality, and
that orders startup. Livestream is shown under Media, and that orders nothing.
No parent module, child module, owning module, or group-derived dependency
appears anywhere in the contracts.

No manifest change and no version 5. `manifest.name` has been required since
version 1 and already is the module's product identity, so the shell renders
"Livestream" instead of `livestream` with nothing added. `suggestedGroup` is
deliberately deferred rather than shipped: it would force a hard
manifest-version cutover for a hint, and its only correct semantics needs
initialization logic that risks a suggestion overwriting an administrator's
decision. Defaulting and ownership are different things.

Two Core tables (migration 0003) hold groups and placements — server-side,
because a church configures its Dashboard rather than one browser;
platform-global, because no organization model exists to scope them to.
`group_id` is `on delete set null`, so deleting a group ungroups its modules
and a dangling reference is impossible. `module_id` carries no foreign key,
because modules are packages rather than rows, so a placement for an
uninstalled module is retained and restores its position on reinstall.

`resolveDashboardNavigation` is a pure function of configuration plus the
mountable set: an unplaced module is ungrouped and visible with no
initialization write, an absent module renders nothing, empty groups are kept,
and ordering is total with the module id as final tie-break.

`GET /api/v1/dashboard/navigation` returns the resolved view, layered on top of
the host-neutral module UI inventory rather than merged into it — each generic
descriptor is embedded untouched, so a standalone host never inherits Dashboard
semantics. Reading needs the permission the inventory already needs; organizing
needs the new platform permission `core.dashboard.navigation.manage` through a
narrow, idempotent, closed-validation mutation contract. No editor UI.

The flatness rule is executable: a test discovers real fixtures with a genuine
dependency, arranges them four ways including both in one folder and the
dependency inverted in presentation, and asserts discovery order, dependency
declarations, and the module set stay byte-identical. The end-to-end test
organizes a real installation through the real API, mounts a module from inside
a group, moves it, and asserts the navigation entry is byte-identical across the
move and still mounts the same artifact.

The shell's client for the generic inventory became dead code and was removed
rather than kept speculatively; the endpoint itself is unchanged.

Co-Authored-By: Claude Opus 5 <[email protected]>
2026-08-22 12:44:40 -05:00

231 lines
9.3 KiB
TypeScript

import { type PermissionBaseline, parseModuleManifest } from "@ekklesia/contracts";
import { describe, expect, it } from "vitest";
import {
CORE_AUTHORIZATION_GRANTS_MANAGE,
CORE_DASHBOARD_NAVIGATION_MANAGE,
CORE_MODULES_UI_READ,
CORE_PERMISSION_DECLARATIONS,
PermissionRegistryError,
} from "../src/authorization/index.js";
import type { DiscoveredModule } from "../src/modules/discovery.js";
import {
composePlatformPermissionRegistry,
ModulePermissionCompositionError,
} from "../src/modules/permissions.js";
interface PermissionInput {
readonly id: string;
readonly baseline: PermissionBaseline;
readonly description: string;
}
/** A minimal, in-memory `DiscoveredModule` double — no filesystem, no real discovery. The manifest
* is still built through `parseModuleManifest`, so a fixture that would not actually pass manifest
* validation cannot silently misrepresent what real discovery would ever produce. Only `manifest`
* is read by `composePlatformPermissionRegistry`; the rest exist only to satisfy the type. */
function fakeModule(id: string, permissions: readonly PermissionInput[] = []): DiscoveredModule {
const manifest = parseModuleManifest({
manifestVersion: 4,
id,
name: `${id} module`,
version: "0.1.0",
compatibility: { platform: "^0.1.0", moduleSdk: "^0.1.0" },
permissions,
entrypoints: {
// Deliberately a path nothing will ever resolve, proving composition never imports or
// otherwise touches a module's server entrypoint.
server: "./dist/does-not-exist/index.js",
},
});
return {
directory: `/modules/${id}`,
entrypoints: { server: `/modules/${id}/dist/does-not-exist/index.js` },
manifest,
manifestPath: `/modules/${id}/ekklesia.module.json`,
packageName: `@test/${id}`,
};
}
describe("composePlatformPermissionRegistry", () => {
it("composes a Core-only registry when no modules are supplied", () => {
const registry = composePlatformPermissionRegistry([]);
expect(registry.declarations).toEqual(CORE_PERMISSION_DECLARATIONS);
expect(registry.has(CORE_AUTHORIZATION_GRANTS_MANAGE)).toBe(true);
});
it("composes Core and multiple discovered modules' declarations into one registry", () => {
const calendar = fakeModule("calendar", [
{ id: "calendar.events.read", baseline: "restricted", description: "Read events." },
]);
const people = fakeModule("people", [
{ id: "people.directory.read", baseline: "authenticated", description: "Read directory." },
]);
const registry = composePlatformPermissionRegistry([calendar, people]);
expect(registry.has(CORE_AUTHORIZATION_GRANTS_MANAGE)).toBe(true);
expect(registry.has(CORE_MODULES_UI_READ)).toBe(true);
expect(registry.has("calendar.events.read")).toBe(true);
expect(registry.has("people.directory.read")).toBe(true);
expect(registry.has(CORE_DASHBOARD_NAVIGATION_MANAGE)).toBe(true);
// Core's own three declarations plus one from each module.
expect(registry.declarations).toHaveLength(5);
});
it("preserves deterministic order: Core first, then modules in the supplied order, then declarations in manifest order", () => {
const calendar = fakeModule("calendar", [
{ id: "calendar.events.read", baseline: "restricted", description: "Read events." },
{ id: "calendar.events.write", baseline: "restricted", description: "Write events." },
]);
const people = fakeModule("people", [
{ id: "people.directory.read", baseline: "authenticated", description: "Read directory." },
]);
const registry = composePlatformPermissionRegistry([calendar, people]);
expect(registry.declarations.map((declaration) => declaration.id)).toEqual([
CORE_AUTHORIZATION_GRANTS_MANAGE,
CORE_MODULES_UI_READ,
CORE_DASHBOARD_NAVIGATION_MANAGE,
"calendar.events.read",
"calendar.events.write",
"people.directory.read",
]);
});
it.each([
"public",
"authenticated",
"restricted",
] as const)("preserves the exact %s baseline and description of a module declaration", (baseline) => {
const calendar = fakeModule("calendar", [
{ id: "calendar.events.read", baseline, description: "Read calendar events." },
]);
const registry = composePlatformPermissionRegistry([calendar]);
expect(registry.get("calendar.events.read")).toEqual({
id: "calendar.events.read",
baseline,
description: "Read calendar events.",
});
});
it("still fails closed for a permission no module or Core ever declared", () => {
const registry = composePlatformPermissionRegistry([]);
expect(registry.has("calendar.events.read")).toBe(false);
expect(registry.get("calendar.events.read")).toBeUndefined();
});
it("fails composition on an exact duplicate permission id supplied by two module entries", () => {
// A permission id must start with its own module's id, so a genuine cross-module collision is
// only reachable if the supplied list itself contains the same module id twice — real
// discovery already guarantees module-id uniqueness (`MODULE_ID_DUPLICATE`), but composition
// re-derives duplicate detection from the flat declaration list regardless, rather than
// trusting that upstream guarantee alone.
const first = fakeModule("calendar", [
{ id: "calendar.events.read", baseline: "restricted", description: "Read events." },
]);
const second = fakeModule("calendar", [
{ id: "calendar.events.read", baseline: "public", description: "Also read events." },
]);
expect(() => composePlatformPermissionRegistry([first, second])).toThrow(
PermissionRegistryError,
);
});
it("rejects a module contributing a permission in the reserved core.* namespace, without leaking a module path", () => {
// Only a module whose own id is literally "core" can produce a "core."-prefixed permission
// that still passes the manifest's own module-namespace check — this proves composition
// catches that case rather than trusting the manifest's self-consistency alone.
const impostor = fakeModule("core", [
{ id: "core.rogue.permission", baseline: "restricted", description: "Not really Core's." },
]);
let captured: unknown;
try {
composePlatformPermissionRegistry([impostor]);
} catch (error) {
captured = error;
}
expect(captured).toBeInstanceOf(ModulePermissionCompositionError);
expect(captured).toMatchObject({
code: "MODULE_PERMISSION_RESERVED_NAMESPACE",
moduleId: "core",
permissionId: "core.rogue.permission",
});
const publicText = String(captured);
expect(publicText).not.toContain("/modules/core");
expect(publicText).not.toContain("ekklesia.module.json");
});
it("rejects a reserved-namespace collision even when it would not otherwise duplicate an existing id", () => {
const impostor = fakeModule("core", [
{
id: "core.authorization.grants.manage",
baseline: "restricted",
description: "Attempting to shadow Core's own permission.",
},
]);
expect(() => composePlatformPermissionRegistry([impostor])).toThrow(
ModulePermissionCompositionError,
);
});
it("removes a module's permissions from the resulting registry once that module is absent from the supplied list", () => {
const calendar = fakeModule("calendar", [
{ id: "calendar.events.read", baseline: "restricted", description: "Read events." },
]);
const withCalendar = composePlatformPermissionRegistry([calendar]);
expect(withCalendar.has("calendar.events.read")).toBe(true);
const withoutCalendar = composePlatformPermissionRegistry([]);
expect(withoutCalendar.has("calendar.events.read")).toBe(false);
});
it("performs no I/O: composition is synchronous and never imports a module's entrypoint", () => {
const calendar = fakeModule("calendar", [
{ id: "calendar.events.read", baseline: "restricted", description: "Read events." },
]);
// A synchronous return (not a Promise) from a fixture whose entrypoint deliberately resolves
// to nothing on disk is direct evidence no filesystem or module-code operation occurred.
const result = composePlatformPermissionRegistry([calendar]);
expect(result).not.toBeInstanceOf(Promise);
expect(result.has("calendar.events.read")).toBe(true);
});
it("does not mutate the supplied module list or Core's own declaration list", () => {
const calendar = fakeModule("calendar", [
{ id: "calendar.events.read", baseline: "restricted", description: "Read events." },
]);
const modules = Object.freeze([calendar]);
const coreDeclarationsBefore = [...CORE_PERMISSION_DECLARATIONS];
composePlatformPermissionRegistry(modules);
expect(modules).toEqual([calendar]);
expect(CORE_PERMISSION_DECLARATIONS).toEqual(coreDeclarationsBefore);
});
it("returns a registry and declarations that remain immutable, including module-contributed ones", () => {
const calendar = fakeModule("calendar", [
{ id: "calendar.events.read", baseline: "restricted", description: "Read events." },
]);
const registry = composePlatformPermissionRegistry([calendar]);
expect(Object.isFrozen(registry)).toBe(true);
expect(Object.isFrozen(registry.declarations)).toBe(true);
for (const declaration of registry.declarations) {
expect(Object.isFrozen(declaration)).toBe(true);
}
});
});