ADR 0022 defined what a module UI is and selected React and TypeScript as the authoring model, but closed by recording that it was not buildable end to end: `browser.json` preserves JSX, bundler plugins are denied, and nothing turned a module's `.tsx` into the artifact its manifest declares. This closes exactly that gap. esbuild produces the artifact. It was already the right answer before it was chosen: this workspace resolves esbuild 0.28.1 through Vite/Vitest today and `pnpm-workspace.yaml` already carries `allowBuilds: esbuild`, so the pinned dependency adds no second copy and no new trust decision. It is also the smallest tool that covers TSX, ESM, browser platform, bundling, source maps, and a define-time constant with no plugin ecosystem. Vite library mode would drag in `@vitejs/plugin-react`, which the module boundary denies on purpose; `tsc` alone cannot bundle, so its output would carry bare `react/jsx-runtime` imports no browser resolves. React is bundled, not externalized. That follows from ADR 0022 rather than from convenience: `mount()` was made the ABI precisely so React would not be part of the host contract, and externalizing it would reverse that through the build system — every host would have to supply a compatible React, and a standalone host might not use React at all. The cost is real and accepted: duplicate runtimes and a ~570 KB unminified artifact. Sharing one runtime later is a build optimization that cannot change the contract, because the contract is a mount function. Output is browser ESM at `es2022`, unminified so an operator can review what they install, with `process.env.NODE_ENV` substituted — React reads it at module scope and would otherwise touch a Node global that does not exist in a browser. The output path is read from the module's own manifest rather than a build convention, so declared and produced artifacts cannot drift, and it is validated with the same `packageRelativePathSchema` discovery enforces, so a build can never write where discovery would later reject. `@ekklesia/module-ui-build` owns every option; modules own none. It uses the existing `tooling` role that modules could already depend on, so this pass required no boundary relaxation at all. Its `bin` points at a committed launcher rather than compiled output because pnpm links bins during install, before Turborepo builds anything — a bin targeting `dist/cli.js` fails to link on a fresh clone and breaks every module's UI build in CI. A module with no `entrypoints.ui` is not an error; the CLI reports nothing to build and exits zero, so one script serves both kinds of module. Styling is React inline style objects. A stylesheet import fails the build rather than emitting a sidecar `.css` that no manifest declares and no host loads — an undeclared asset would appear to work in tests and silently do nothing in a real host. `templates/module` is the canonical example and now ships optional UI. Its tests build the artifact from source, validate it with `parseModuleUiExport`, mount it into a real DOM, assert the rendered output, and unmount it; the artifact is rebuilt per run so the proof can never pass against stale output, and `dist/` stays gitignored. Because verify runs both `pnpm test` and `pnpm build`, a UI that cannot be produced fails CI through two independent paths. One correction worth stating plainly: the UI TypeScript project declares `"types": []`, and a UI file referencing `process` does fail in isolation, but TypeScript still pulls Node globals in transitively — a file importing `@ekklesia/module-ui-sdk` reaches `@ekklesia/contracts` and through its Zod and Drizzle types `process.env` typechecks again. The docs and ADR describe this as the convention it is rather than the guard it is not. Core is untouched. Building is an authoring step; discovery still only validates the artifact a module shipped and never executes or produces one. Co-Authored-By: Claude Opus 5 <[email protected]>
175 lines
8.0 KiB
TypeScript
175 lines
8.0 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"],
|
|
["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-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("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",
|
|
]),
|
|
);
|
|
});
|
|
});
|