Phase 6C pass 2. Every link in the module UI chain existed except the one that closes it: a module could be authored, built, validated, published at a browser URL, and loaded by a generic loader — and nothing in Ekklesia did any of it. There was no browser application at all. Two pieces were missing. A browser could not discover what to mount, and it must not work that out for itself. GET /api/v1/module-ui is the inventory: per publishable module, its id and version, the server-produced artifact URL, the server-produced root of the module's own API, and the subset of that module's declared permissions the caller holds. Five fields, each because building a ModuleUiHostContext needs it — no filesystem paths, and no name/icon/folder/order, because navigation metadata is a design that does not exist yet. Its module set is the ADR 0025 publication registry rather than a rescan, so the inventory and the artifact route cannot disagree. It requires a new Core permission, core.modules.ui.read (baseline authenticated), because it is precisely the enumeration the anonymous artifact route deliberately withholds. Both URLs are server-produced. moduleUiArtifactUrl already existed; moduleApiBaseUrl is now exported and moduleRoutePath builds on it, so each URL shape has exactly one author. Without it the shell would hardcode /api/v1/modules/<id> — the prefix ADR 0022 forbids a module UI from spelling, reappearing in the host instead. surfaces/shell (@ekklesia/shell) is the repository's first surface: a small React application built to static files by its own esbuild script. It resolves the principal, fetches the inventory, builds the host context entirely from server-derived data, and hands the artifact URL to @ekklesia/module-ui-host. One frame per selection — keyed by module identity — defeats the stale-load race; the host owns the container, the loading state, and every failure, so a broken module costs its own panel rather than the shell. The shell statically imports no module, and both levels are checked: no source import may name a module, and the emitted bundle must contain exactly one dynamic import (the loader's) with no module id, no /api/v1/modules, no eval, and no blob URL. Permission hints come from Core's own evaluator and stay presentation-only — the end-to-end test has a UI holding no grant call its API anyway and still receive 403. Surfaces may now depend only on browser-safe shared roles; @ekklesia/contracts is deliberately excluded, since its barrel pulls Drizzle's types and Node's globals into the browser — the hole ADR 0024 closed one layer down. Not the Dashboard: no navigation, grouping, icons, ordering, design system, or routing. The selector is a list of module ids. Co-Authored-By: Claude Opus 5 <[email protected]>
189 lines
8.7 KiB
TypeScript
189 lines
8.7 KiB
TypeScript
import path from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
import { describe, expect, it } from "vitest";
|
|
import { checkBoundaries } from "../scripts/check-boundaries.js";
|
|
|
|
const testDirectory = path.dirname(fileURLToPath(import.meta.url));
|
|
const fixtures = path.join(testDirectory, "fixtures", "boundaries");
|
|
|
|
describe("repository dependency boundaries", () => {
|
|
it("accepts public contracts below Core", async () => {
|
|
const result = await checkBoundaries(path.join(fixtures, "legal"));
|
|
expect(result.violations).toEqual([]);
|
|
});
|
|
|
|
it("accepts generated module composition only through the generated bootstrap boundary", async () => {
|
|
const result = await checkBoundaries(path.join(fixtures, "legal-generated-bootstrap"));
|
|
expect(result.violations).toEqual([]);
|
|
});
|
|
|
|
it("honors explicit pnpm workspace exclusions", async () => {
|
|
const result = await checkBoundaries(path.join(fixtures, "workspace-exclusion"));
|
|
expect(result.violations).toEqual([]);
|
|
});
|
|
|
|
it.each([
|
|
["core-imports-module", "core-is-feature-agnostic"],
|
|
["app-imports-module", "apps-are-composition-roots"],
|
|
["module-imports-core", "modules-use-public-platform-contracts"],
|
|
["module-imports-surface", "modules-use-public-platform-contracts"],
|
|
["package-boundary-direction", "modules-use-public-platform-contracts"],
|
|
["cross-module-import", "modules-do-not-import-other-modules"],
|
|
["module-schema-imports-module", "modules-do-not-import-other-modules"],
|
|
["surface-imports-module", "surfaces-use-public-contracts"],
|
|
["surface-imports-contracts", "surfaces-use-public-contracts"],
|
|
["cross-surface-import", "surfaces-are-independent"],
|
|
["builder-imports-module", "builder-composes-contracts"],
|
|
["contracts-import-core", "contracts-do-not-depend-upward"],
|
|
["sdk-imports-core", "sdks-do-not-depend-on-implementations"],
|
|
["shared-role-order", "sdks-do-not-depend-on-implementations"],
|
|
["package-without-exports", "workspace-imports-use-public-exports"],
|
|
["private-package-import", "workspace-imports-use-public-exports"],
|
|
["non-workspace-version", "internal-dependencies-use-workspace-protocol"],
|
|
["workspace-alias", "workspace-dependency-aliases-are-forbidden"],
|
|
["undeclared-workspace-dependency", "workspace-dependencies-are-declared"],
|
|
["duplicate-package-name", "workspace-package-names-are-unique"],
|
|
["unknown-shared-role", "shared-packages-declare-known-roles"],
|
|
["workspace-unsupported-pattern", "workspace-patterns-use-supported-syntax"],
|
|
["package-cycle", "no-circular-package-dependencies"],
|
|
["module-has-ui", "modules-do-not-own-ui"],
|
|
["module-ui-framework", "modules-do-not-own-ui"],
|
|
["module-ui-aliased-framework", "modules-do-not-own-ui"],
|
|
["module-ui-imports-core", "modules-use-public-platform-contracts"],
|
|
["module-ui-bundler-plugin", "modules-do-not-own-ui"],
|
|
["module-imports-ui-host", "modules-use-public-platform-contracts"],
|
|
["module-imports-ui-package", "modules-use-public-platform-contracts"],
|
|
["cross-package-relative", "workspace-imports-use-public-exports"],
|
|
["cycle", "no-circular-source-dependencies"],
|
|
])("rejects %s", async (fixture, expectedRule) => {
|
|
const result = await checkBoundaries(path.join(fixtures, fixture));
|
|
expect(result.violations.map((violation) => violation.rule)).toContain(expectedRule);
|
|
});
|
|
|
|
it("rejects stylesheet and case-insensitive view files inside a module, but not TSX", async () => {
|
|
const result = await checkBoundaries(path.join(fixtures, "module-has-ui"));
|
|
const uiViolations = result.violations.filter(
|
|
(violation) => violation.rule === "modules-do-not-own-ui",
|
|
);
|
|
|
|
expect(uiViolations).toHaveLength(2);
|
|
expect(uiViolations.map((violation) => violation.from)).toEqual(
|
|
expect.arrayContaining([
|
|
"modules/calendar/src/calendar.css",
|
|
"modules/calendar/src/view.ASTRO",
|
|
]),
|
|
);
|
|
// React is the supported module UI authoring model (ADR 0022), so a module's own `.tsx` is
|
|
// legitimate source and must no longer be reported.
|
|
expect(uiViolations.map((violation) => violation.from)).not.toContain(
|
|
"modules/calendar/src/calendar.tsx",
|
|
);
|
|
});
|
|
|
|
it("rejects unsupported UI frameworks, their imports, and view formats inside a module", async () => {
|
|
const result = await checkBoundaries(path.join(fixtures, "module-ui-framework"));
|
|
const uiViolations = result.violations.filter(
|
|
(violation) => violation.rule === "modules-do-not-own-ui",
|
|
);
|
|
|
|
expect(uiViolations).toHaveLength(3);
|
|
expect(uiViolations.map((violation) => violation.message)).toEqual(
|
|
expect.arrayContaining([
|
|
"Module package depends on UI framework preact.",
|
|
"Module source imports UI framework preact.",
|
|
]),
|
|
);
|
|
// The fixture also aliases `compat` to react, which is now the supported framework and is
|
|
// therefore no longer a violation.
|
|
expect(uiViolations.map((violation) => violation.message).join(" ")).not.toContain("compat");
|
|
});
|
|
|
|
it("still rejects module UI source that reaches into Core internals", async () => {
|
|
// Allowing `.tsx` inside a module changed which *formats* a module may contain. It did not
|
|
// change which layers a module may import: module UI is subject to the identical layer rules
|
|
// as module backend source.
|
|
const result = await checkBoundaries(path.join(fixtures, "module-ui-imports-core"));
|
|
|
|
expect(result.violations).toEqual([
|
|
{
|
|
from: "modules/announcements/src/ui/editor.tsx",
|
|
message: "module code may not import core code directly.",
|
|
rule: "modules-use-public-platform-contracts",
|
|
to: "core/src/index.ts",
|
|
},
|
|
]);
|
|
});
|
|
|
|
it("accepts the canonical module UI dependency set: React, the UI SDK, and the build tool", async () => {
|
|
// Mirrors what `templates/module` actually declares (ADR 0023). The build tool is a `tooling`
|
|
// shared package, a role modules were already permitted to depend on, so the module UI build
|
|
// pipeline required no boundary relaxation at all.
|
|
const result = await checkBoundaries(path.join(fixtures, "module-owns-react-ui"));
|
|
|
|
expect(result.violations).toEqual([]);
|
|
});
|
|
|
|
it("keeps the host loader out of module packages", async () => {
|
|
// `@ekklesia/module-ui-host` is host infrastructure. A module that depended on it would bundle
|
|
// loader code into its own artifact and blur the author/host split (ADR 0024), so the
|
|
// `module-ui-host` role is deliberately absent from the roles a module may depend on.
|
|
const result = await checkBoundaries(path.join(fixtures, "module-imports-ui-host"));
|
|
|
|
expect(result.violations.map((violation) => violation.rule)).toEqual([
|
|
"modules-use-public-platform-contracts",
|
|
"modules-use-public-platform-contracts",
|
|
]);
|
|
});
|
|
|
|
it("still rejects a module reaching for a bundler plugin ecosystem", async () => {
|
|
// Module authors do not configure a bundler; `@ekklesia/module-ui-build` owns that entirely.
|
|
const result = await checkBoundaries(path.join(fixtures, "module-ui-bundler-plugin"));
|
|
|
|
expect(result.violations.map((violation) => violation.message)).toEqual([
|
|
"Module package depends on UI framework @vitejs/plugin-react.",
|
|
]);
|
|
});
|
|
|
|
it("rejects an unsupported framework aliased behind the supported one", async () => {
|
|
const result = await checkBoundaries(path.join(fixtures, "module-ui-aliased-framework"));
|
|
|
|
expect(result.violations.map((violation) => violation.message)).toEqual([
|
|
"Module package depends on UI framework vue aliased as react.",
|
|
]);
|
|
});
|
|
|
|
it("requires workspace: ranges in every dependency field", async () => {
|
|
const result = await checkBoundaries(path.join(fixtures, "non-workspace-version"));
|
|
expect(
|
|
result.violations.filter(
|
|
(violation) => violation.rule === "internal-dependencies-use-workspace-protocol",
|
|
),
|
|
).toHaveLength(4);
|
|
});
|
|
|
|
it("resolves forbidden workspace aliases before applying layer rules", async () => {
|
|
const result = await checkBoundaries(path.join(fixtures, "workspace-alias"));
|
|
expect(
|
|
result.violations.filter(
|
|
(violation) => violation.rule === "workspace-dependency-aliases-are-forbidden",
|
|
),
|
|
).toHaveLength(2);
|
|
expect(result.violations.map((violation) => violation.rule)).toEqual(
|
|
expect.arrayContaining([
|
|
"workspace-dependency-aliases-are-forbidden",
|
|
"modules-use-public-platform-contracts",
|
|
]),
|
|
);
|
|
});
|
|
|
|
it("prevents contracts and SDKs from depending upward through shared packages", async () => {
|
|
const result = await checkBoundaries(path.join(fixtures, "shared-role-order"));
|
|
expect(result.violations.map((violation) => violation.rule)).toEqual(
|
|
expect.arrayContaining([
|
|
"contracts-do-not-depend-upward",
|
|
"sdks-do-not-depend-on-implementations",
|
|
]),
|
|
);
|
|
});
|
|
});
|