ekklesiaandClaude Opus 5
b9ca0d560d
`manifest.storage.buckets` has existed since manifest version 1 and meant nothing — discovery validated it and no code read it. This turns it into a real capability, which is what stands between Announcements and the module system: that product currently fetches a hardcoded LAN S3 endpoint, parses ListObjectsV2 XML by hand, and hands the browser direct object URLs. - A module declares a logical bucket and receives a scoped facade at `context.storage` — list, head, get, put, delete. The contract names no provider: no endpoint, region, credential, or physical bucket is reachable from it, which is what lets the same module run under a future standalone host over its own or a shared S3-compatible service. - Core's first provider speaks S3 through the AWS SDK. SeaweedFS is the deployment target (ADR 0004), never an API name. Probing the pinned image found `CreateBucket` reporting `BucketAlreadyExists` rather than AWS's `BucketAlreadyOwnedByYou`; treating only the AWS spelling as success would have failed every second boot. A live test pins it. - Logical → physical mapping is deterministic and collision-safe: an installation prefix, the module and bucket ids joined by `--` (which cannot occur inside either identifier, so `a-b`+`c` and `a`+`b-c` cannot collide), and a digest over the full untruncated identity. Two modules declaring `assets` always get separate namespaces; neither can see the physical name. - Declaring a bucket is now a requirement: with no provider configured the module is `blocked · storage_unavailable` through ADR 0028's existing resolver, propagating to required dependents. An installation with no object storage stays a complete deployment. - Binding availability is not provider health. Eligibility asks whether storage is configured, never whether it answered; bucket creation is lazy on first use so a storage outage cannot stop the platform booting; a running module whose store blinks stays running and retries. Nothing deletes a bucket. - Credentials are deployment-supplied, never persisted, never routed through module configuration, and never visible to modules, module UI, diagnostics, or API responses. Provider errors translate to a closed code set carrying no endpoint, bucket, request id, or XML. - Retires ADR 0029's transitional `bucket` configuration key. No manifest version change. The template declares no bucket, so it still runs without S3. See ADR 0030. Co-Authored-By: Claude Opus 5 <[email protected]>
64 lines
2.0 KiB
TypeScript
64 lines
2.0 KiB
TypeScript
import type { DoctorCheck, DoctorCheckId, DoctorReport, DoctorResult } from "./doctor.js";
|
|
|
|
interface DoctorSection {
|
|
readonly checkIds: readonly DoctorCheckId[];
|
|
readonly title: string;
|
|
}
|
|
|
|
function section(title: string, checkIds: readonly DoctorCheckId[]): DoctorSection {
|
|
return Object.freeze({ checkIds: Object.freeze([...checkIds]), title });
|
|
}
|
|
|
|
const sections: readonly DoctorSection[] = Object.freeze([
|
|
section("Platform", ["platform.runtime"]),
|
|
section("Modules", [
|
|
"modules.discovery",
|
|
"modules.dependencies",
|
|
"modules.permissions",
|
|
"modules.lifecycle",
|
|
"modules.configuration",
|
|
]),
|
|
section("Data definitions", ["schemas.discovery", "migrations.discovery"]),
|
|
section("PostgreSQL", ["database.transport", "postgresql.connection", "postgresql.plan"]),
|
|
section("Identity", ["identity.configuration", "identity.client-address"]),
|
|
section("Object storage", ["object-storage.integration", "object-storage.bindings"]),
|
|
]);
|
|
|
|
const statusSymbols: Readonly<Record<DoctorCheck["status"], string>> = Object.freeze({
|
|
failure: "✗",
|
|
pass: "✓",
|
|
skipped: "○",
|
|
warning: "!",
|
|
});
|
|
|
|
const resultLabels: Readonly<Record<DoctorResult, string>> = Object.freeze({
|
|
"not-ready": "NOT READY",
|
|
ready: "READY",
|
|
"ready-with-warnings": "READY WITH WARNINGS",
|
|
});
|
|
|
|
export function formatDoctorReport(report: DoctorReport): readonly string[] {
|
|
const checks = new Map(report.checks.map((check) => [check.id, check]));
|
|
const lines = ["Ekklesia Doctor", ""];
|
|
|
|
for (const [sectionIndex, section] of sections.entries()) {
|
|
lines.push(section.title);
|
|
for (const checkId of section.checkIds) {
|
|
const check = checks.get(checkId);
|
|
if (!check) {
|
|
continue;
|
|
}
|
|
lines.push(` ${statusSymbols[check.status]} ${check.summary}`);
|
|
for (const detail of check.details) {
|
|
lines.push(` ${detail}`);
|
|
}
|
|
}
|
|
if (sectionIndex < sections.length - 1) {
|
|
lines.push("");
|
|
}
|
|
}
|
|
|
|
lines.push("", `Result: ${resultLabels[report.result]}`);
|
|
return Object.freeze(lines);
|
|
}
|