Modules had no way to be told anything. Announcements — the first real product Ekklesia will absorb — has zero environment variables and compiles a LAN IP address into its source, so this is the contract standing between it and the module system. - A module declares what it needs in its manifest, using six bounded types (string, integer, boolean, enum, url, secret) with no nesting and no regular expressions. Static declaration is what lets the platform validate configuration *before* deciding whether a module may start: an enabled module missing a required value is reported `blocked · configuration_missing · <key>` rather than taking startup down from inside its own `start` hook, and Doctor reports the same while still importing no module code. That forces `manifestVersion: 5`, a hard cutover. - Ordinary values persist in one Core table (migration 0005), one row per (module_id, key), stored as text until validated against the declaring module's current manifest. Nothing is coerced; an invalid stored value blocks the module rather than falling back to the default. A key the manifest no longer declares is retained and ignored. - Secrets are never persisted. There is no encryption at rest in this repository, so a `secret` key is deployment-supplied and mapped in by the host under a name the module never sees. A secret declaration has no `default` field, the write API refuses secret material, and the HTTP view has no `value` field for one — absent by construction, not filtered. - Modules receive a frozen `context.config` on the registration, runtime, and HTTP handler contexts: the same object identity, per module, beside `services` rather than inside it (services is deliberately one shared instance). No environment access, no database reference, no way to reach another module's values. - Configuration decides eligibility through ADR 0028's existing resolver: three new blocked reasons, each with a distinct operator fix, propagating to required dependents through the same mechanism as a disabled module. - Changes take effect at the next restart; both resources report restartRequired. New restricted permission `core.modules.configuration.manage`, separate from lifecycle, at the sibling prefix `/api/v1/module-configuration`. - Migration participation stays independent of configuration validity. Endpoints and credentials for shared infrastructure stay platform concerns; a module declares which bucket it needs, not an S3 endpoint. See ADR 0029. Co-Authored-By: Claude Opus 5 <[email protected]>
185 lines
7.7 KiB
TypeScript
185 lines
7.7 KiB
TypeScript
import { parsePermissionId } from "@ekklesia/contracts";
|
|
import { describe, expect, it } from "vitest";
|
|
import {
|
|
CORE_AUTHORIZATION_GRANTS_MANAGE,
|
|
CORE_DASHBOARD_NAVIGATION_MANAGE,
|
|
CORE_MODULES_CONFIGURATION_MANAGE,
|
|
CORE_MODULES_LIFECYCLE_MANAGE,
|
|
CORE_MODULES_UI_READ,
|
|
CORE_PERMISSION_DECLARATIONS,
|
|
CORE_PERMISSION_REGISTRY,
|
|
createPermissionRegistry,
|
|
PermissionRegistryError,
|
|
} from "../src/authorization/index.js";
|
|
|
|
describe("createPermissionRegistry", () => {
|
|
it("builds an immutable registry from a fixed declaration list", () => {
|
|
const id = parsePermissionId("test.example.read");
|
|
const registry = createPermissionRegistry([
|
|
{ baseline: "public", description: "An example permission.", id },
|
|
]);
|
|
|
|
expect(registry.has(id)).toBe(true);
|
|
expect(registry.get(id)).toEqual({
|
|
baseline: "public",
|
|
description: "An example permission.",
|
|
id,
|
|
});
|
|
expect(Object.isFrozen(registry)).toBe(true);
|
|
expect(Object.isFrozen(registry.declarations)).toBe(true);
|
|
expect(Object.isFrozen(registry.get(id))).toBe(true);
|
|
});
|
|
|
|
it("rejects a duplicate permission id at composition time, not per request", () => {
|
|
const id = parsePermissionId("test.example.read");
|
|
expect(() =>
|
|
createPermissionRegistry([
|
|
{ baseline: "public", description: "First.", id },
|
|
{ baseline: "restricted", description: "Second.", id },
|
|
]),
|
|
).toThrow(PermissionRegistryError);
|
|
});
|
|
|
|
it("carries the offending permission id on the duplicate-declaration error (a composition-time, developer-facing detail, not a runtime response)", () => {
|
|
const id = parsePermissionId("test.example.read");
|
|
let captured: unknown;
|
|
try {
|
|
createPermissionRegistry([
|
|
{ baseline: "public", description: "First.", id },
|
|
{ baseline: "restricted", description: "Second.", id },
|
|
]);
|
|
} catch (error) {
|
|
captured = error;
|
|
}
|
|
expect(captured).toBeInstanceOf(PermissionRegistryError);
|
|
expect(captured).toMatchObject({
|
|
code: "PERMISSION_REGISTRY_DUPLICATE_DECLARATION",
|
|
permissionId: id,
|
|
});
|
|
});
|
|
|
|
it("treats an unregistered permission the same as a malformed one: get/has both fail closed", () => {
|
|
const registered = parsePermissionId("test.example.read");
|
|
const unregistered = parsePermissionId("test.example.unregistered");
|
|
const registry = createPermissionRegistry([
|
|
{ baseline: "public", description: "Registered.", id: registered },
|
|
]);
|
|
|
|
expect(registry.has(unregistered)).toBe(false);
|
|
expect(registry.get(unregistered)).toBeUndefined();
|
|
});
|
|
|
|
it("fails closed for a malformed permission id passed to get/has, without throwing", () => {
|
|
const registry = createPermissionRegistry([]);
|
|
|
|
expect(registry.has("not a valid permission")).toBe(false);
|
|
expect(registry.get(null)).toBeUndefined();
|
|
expect(registry.get(undefined)).toBeUndefined();
|
|
expect(registry.get(42)).toBeUndefined();
|
|
expect(registry.get("media.*")).toBeUndefined();
|
|
});
|
|
|
|
it("builds an empty registry from an empty list without error", () => {
|
|
const registry = createPermissionRegistry([]);
|
|
expect(registry.declarations).toEqual([]);
|
|
});
|
|
});
|
|
|
|
describe("CORE_PERMISSION_REGISTRY", () => {
|
|
it("registers exactly core.authorization.grants.manage as restricted", () => {
|
|
const declaration = CORE_PERMISSION_REGISTRY.get(CORE_AUTHORIZATION_GRANTS_MANAGE);
|
|
expect(declaration).toBeDefined();
|
|
expect(declaration?.baseline).toBe("restricted");
|
|
expect(declaration?.id).toBe("core.authorization.grants.manage");
|
|
});
|
|
|
|
it("registers core.modules.ui.read as authenticated, not restricted", () => {
|
|
const declaration = CORE_PERMISSION_REGISTRY.get(CORE_MODULES_UI_READ);
|
|
expect(declaration).toBeDefined();
|
|
// Any signed-in user may learn which module UIs the browser host can mount; a shell that
|
|
// rendered nothing until an operator granted each user a permission would be unusable, and the
|
|
// module UIs gate their own content on their own permissions regardless (ADR 0026).
|
|
expect(declaration?.baseline).toBe("authenticated");
|
|
expect(declaration?.id).toBe("core.modules.ui.read");
|
|
});
|
|
|
|
it("registers core.dashboard.navigation.manage as restricted", () => {
|
|
const declaration = CORE_PERMISSION_REGISTRY.get(CORE_DASHBOARD_NAVIGATION_MANAGE);
|
|
expect(declaration).toBeDefined();
|
|
// Reorganizing the Dashboard is administrative, not something every signed-in user may do —
|
|
// unlike merely reading which module UIs exist (ADR 0027).
|
|
expect(declaration?.baseline).toBe("restricted");
|
|
expect(declaration?.id).toBe("core.dashboard.navigation.manage");
|
|
});
|
|
|
|
it("registers core.modules.lifecycle.manage as restricted", () => {
|
|
const declaration = CORE_PERMISSION_REGISTRY.get(CORE_MODULES_LIFECYCLE_MANAGE);
|
|
expect(declaration).toBeDefined();
|
|
// Deciding which installed modules run is administrative, and so is *reading* that: the
|
|
// lifecycle view is the only place a disabled or blocked module is visible at all, unlike the
|
|
// merely-authenticated mountable inventory (ADR 0028).
|
|
expect(declaration?.baseline).toBe("restricted");
|
|
expect(declaration?.id).toBe("core.modules.lifecycle.manage");
|
|
});
|
|
|
|
it("registers core.modules.configuration.manage as restricted, separately from lifecycle", () => {
|
|
const declaration = CORE_PERMISSION_REGISTRY.get(CORE_MODULES_CONFIGURATION_MANAGE);
|
|
expect(declaration).toBeDefined();
|
|
expect(declaration?.baseline).toBe("restricted");
|
|
expect(declaration?.id).toBe("core.modules.configuration.manage");
|
|
// Deliberately a different permission from lifecycle management: tuning how a module behaves
|
|
// and deciding whether it runs at all are different authorities (ADR 0029).
|
|
expect(CORE_MODULES_CONFIGURATION_MANAGE).not.toBe(CORE_MODULES_LIFECYCLE_MANAGE);
|
|
});
|
|
|
|
it("contains exactly these five permissions and no others", () => {
|
|
expect(CORE_PERMISSION_REGISTRY.declarations.map((declaration) => declaration.id)).toEqual([
|
|
CORE_AUTHORIZATION_GRANTS_MANAGE,
|
|
CORE_MODULES_UI_READ,
|
|
CORE_DASHBOARD_NAVIGATION_MANAGE,
|
|
CORE_MODULES_LIFECYCLE_MANAGE,
|
|
CORE_MODULES_CONFIGURATION_MANAGE,
|
|
]);
|
|
});
|
|
});
|
|
|
|
describe("CORE_PERMISSION_DECLARATIONS", () => {
|
|
it("is Core's own declaration list, exported separately from the registry in deeply immutable form", () => {
|
|
expect(CORE_PERMISSION_DECLARATIONS).toEqual([
|
|
{
|
|
baseline: "restricted",
|
|
description: "Create, list, and revoke another user's explicit authorization grants.",
|
|
id: CORE_AUTHORIZATION_GRANTS_MANAGE,
|
|
},
|
|
{
|
|
baseline: "authenticated",
|
|
description: "List the installed module UIs a browser host may mount.",
|
|
id: CORE_MODULES_UI_READ,
|
|
},
|
|
{
|
|
baseline: "restricted",
|
|
description: "Organize the Dashboard: create, rename, order, and delete navigation groups.",
|
|
id: CORE_DASHBOARD_NAVIGATION_MANAGE,
|
|
},
|
|
{
|
|
baseline: "restricted",
|
|
description: "Read and change which installed modules are enabled.",
|
|
id: CORE_MODULES_LIFECYCLE_MANAGE,
|
|
},
|
|
{
|
|
baseline: "restricted",
|
|
description: "Read and change an installed module's own configuration values.",
|
|
id: CORE_MODULES_CONFIGURATION_MANAGE,
|
|
},
|
|
]);
|
|
expect(Object.isFrozen(CORE_PERMISSION_DECLARATIONS)).toBe(true);
|
|
for (const declaration of CORE_PERMISSION_DECLARATIONS) {
|
|
expect(Object.isFrozen(declaration)).toBe(true);
|
|
}
|
|
});
|
|
|
|
it("matches exactly what CORE_PERMISSION_REGISTRY exposes as its own declarations, so a composer building on top of it never diverges from what Core itself registers", () => {
|
|
expect(CORE_PERMISSION_DECLARATIONS).toEqual(CORE_PERMISSION_REGISTRY.declarations);
|
|
});
|
|
});
|