feat: add host-provided module object storage
`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]>
This commit is contained in:
co-authored by
Claude Opus 5
parent
527239f6de
commit
b9ca0d560d
@@ -10,6 +10,11 @@ import {
|
||||
type IdentityConfig,
|
||||
type IdentityConfigInput,
|
||||
} from "@ekklesia/core/identity";
|
||||
import {
|
||||
createStorageProviderConfig,
|
||||
type StorageProviderConfig,
|
||||
type StorageProviderConfigInput,
|
||||
} from "@ekklesia/core/storage";
|
||||
import {
|
||||
type ClientAddressConfig,
|
||||
type ClientAddressConfigInput,
|
||||
@@ -55,6 +60,16 @@ export interface ApiRuntimeConfig {
|
||||
readonly host: string;
|
||||
readonly identity: IdentityConfig;
|
||||
readonly port: number;
|
||||
/**
|
||||
* The validated host object-storage provider, or `undefined` when this installation has none
|
||||
* (ADR 0030).
|
||||
*
|
||||
* `undefined` is a complete, valid deployment: modules that declare no logical buckets are
|
||||
* unaffected, and a module that does declare one is reported blocked rather than crashing
|
||||
* anything. These values reach Core's provider and nowhere else — no module, module UI, browser
|
||||
* bundle, diagnostic, or API response ever sees the endpoint or the credentials.
|
||||
*/
|
||||
readonly storage: StorageProviderConfig | undefined;
|
||||
}
|
||||
|
||||
export interface ApiRuntimeConfigInput {
|
||||
@@ -68,6 +83,8 @@ export interface ApiRuntimeConfigInput {
|
||||
readonly host?: unknown;
|
||||
readonly identity: IdentityConfigInput;
|
||||
readonly port?: unknown;
|
||||
/** Optional. Omitted, or with no endpoint, means this installation has no object storage. */
|
||||
readonly storage?: StorageProviderConfigInput;
|
||||
}
|
||||
|
||||
export interface CreateApiRuntimeConfigOptions {
|
||||
@@ -142,6 +159,11 @@ export function createApiRuntimeConfig(
|
||||
// the URL carries TLS parameters that could override the policy.
|
||||
assertProductionDatabaseTransport(databaseUrl, databaseTransport, environment);
|
||||
|
||||
// Validated in the same pass as every other runtime value, before `startApi` constructs a pool,
|
||||
// a provider client, or a listener — so a malformed endpoint or a half-supplied credential pair
|
||||
// fails startup with a sanitized code rather than surfacing later as a confusing storage error.
|
||||
const storage = createStorageProviderConfig(input.storage, { environment });
|
||||
|
||||
return Object.freeze({
|
||||
clientAddress,
|
||||
databaseTransport,
|
||||
@@ -149,5 +171,6 @@ export function createApiRuntimeConfig(
|
||||
host,
|
||||
identity,
|
||||
port,
|
||||
storage,
|
||||
});
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user