`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]>
184 lines
6.8 KiB
TypeScript
184 lines
6.8 KiB
TypeScript
import path from "node:path";
|
|
import { readFile } from "node:fs/promises";
|
|
import { pathToFileURL } from "node:url";
|
|
import {
|
|
createModuleLifecycleDatabase,
|
|
createModuleLifecycleStore,
|
|
discoverModules,
|
|
isDependencyBlockedDetail,
|
|
isStorageBlockedDetail,
|
|
ModuleDiscoveryError,
|
|
ModuleLifecycleStoreError,
|
|
resolveModuleEligibility,
|
|
} from "../modules/index.js";
|
|
import { resolveExecutableDatabaseTransport } from "./database-transport-environment.js";
|
|
|
|
/**
|
|
* Enables or disables one installed module, out of band from the running API.
|
|
*
|
|
* This exists because module startup is deliberately all-or-nothing (ADR 0015, ADR 0020, preserved
|
|
* by ADR 0028): a module whose `start` hook throws takes API startup down with it, and the HTTP
|
|
* lifecycle API that could otherwise turn it off is served by that same process. Without an
|
|
* out-of-band path, the only recovery from one bad module would be editing the database by hand.
|
|
* This command is that path — the same shape as `pnpm authorization:bootstrap-owner`: explicit,
|
|
* operator-invoked, never HTTP-exposed, and never inferred.
|
|
*
|
|
* It writes configuration and nothing else. It starts nothing, stops nothing, imports no module
|
|
* server entrypoint, runs no lifecycle hook, and applies no migration. The change takes effect on
|
|
* the next API start.
|
|
*/
|
|
class ModuleLifecycleCliError extends Error {
|
|
constructor(message: string) {
|
|
super(message);
|
|
this.name = "ModuleLifecycleCliError";
|
|
this.stack = `${this.name}: ${this.message}`;
|
|
}
|
|
}
|
|
|
|
const usage =
|
|
"Usage: pnpm modules:enable -- --module <module-id> | pnpm modules:disable -- --module <module-id>";
|
|
|
|
interface ParsedArgs {
|
|
readonly enabled: boolean;
|
|
readonly moduleId: string;
|
|
}
|
|
|
|
/** A minimal, hand-rolled flag parser, exactly like `bootstrap-platform-owner.ts`: this command
|
|
* takes one named flag plus one mode flag, so a general-purpose argument dependency is not
|
|
* warranted. `--enable` and `--disable` are mutually exclusive and one is required, so the intent
|
|
* is always stated rather than defaulted. */
|
|
function parseArgs(argv: readonly string[]): ParsedArgs {
|
|
let moduleId: string | undefined;
|
|
let enabled: boolean | undefined;
|
|
for (let index = 0; index < argv.length; index += 1) {
|
|
const flag = argv[index];
|
|
if (flag === "--module") {
|
|
moduleId = argv[index + 1];
|
|
index += 1;
|
|
} else if (flag === "--enable") {
|
|
if (enabled === false) {
|
|
throw new ModuleLifecycleCliError(usage);
|
|
}
|
|
enabled = true;
|
|
} else if (flag === "--disable") {
|
|
if (enabled === true) {
|
|
throw new ModuleLifecycleCliError(usage);
|
|
}
|
|
enabled = false;
|
|
}
|
|
}
|
|
if (moduleId === undefined || enabled === undefined) {
|
|
throw new ModuleLifecycleCliError(usage);
|
|
}
|
|
return { enabled, moduleId };
|
|
}
|
|
|
|
interface PackageVersion {
|
|
readonly version?: unknown;
|
|
}
|
|
|
|
async function readPackageVersion(packagePath: string): Promise<string> {
|
|
const packageData = JSON.parse(await readFile(packagePath, "utf8")) as PackageVersion;
|
|
if (typeof packageData.version !== "string" || packageData.version.trim().length === 0) {
|
|
throw new ModuleLifecycleCliError("The repository package metadata could not be read.");
|
|
}
|
|
return packageData.version;
|
|
}
|
|
|
|
async function main(): Promise<void> {
|
|
const { enabled, moduleId } = parseArgs(process.argv.slice(2));
|
|
const repositoryRoot = process.cwd();
|
|
const [platformVersion, moduleSdkVersion] = await Promise.all([
|
|
readPackageVersion(path.join(repositoryRoot, "package.json")),
|
|
readPackageVersion(path.join(repositoryRoot, "packages/module-sdk/package.json")),
|
|
]);
|
|
|
|
// The same rule the HTTP API enforces: a module this deployment cannot currently see may not be
|
|
// configured. Manifest-only, exactly like `pnpm modules:validate` — no module server entrypoint
|
|
// is imported and no lifecycle hook runs, so a module that crashes during `start` is still fully
|
|
// configurable here, which is the case this command exists for.
|
|
const discovered = await discoverModules({
|
|
moduleSdkVersion,
|
|
modulesDirectory: path.join(repositoryRoot, "modules"),
|
|
platformVersion,
|
|
});
|
|
if (!discovered.some((module) => module.manifest.id === moduleId)) {
|
|
throw new ModuleLifecycleCliError(
|
|
`No installed module declares the id "${moduleId}". No changes were made.`,
|
|
);
|
|
}
|
|
|
|
// Read only when this command actually executes — never merely by importing this module.
|
|
const databaseUrl = process.env.DATABASE_URL;
|
|
if (typeof databaseUrl !== "string" || databaseUrl.trim().length === 0) {
|
|
throw new ModuleLifecycleCliError("DATABASE_URL is required.");
|
|
}
|
|
|
|
// Asserted before the connection is constructed, so an unsafe production transport never opens a
|
|
// client at all.
|
|
const transport = resolveExecutableDatabaseTransport(databaseUrl);
|
|
const { close, db } = createModuleLifecycleDatabase(databaseUrl, {
|
|
connectionTimeoutMs: 10_000,
|
|
operationTimeoutMs: 10_000,
|
|
transport,
|
|
});
|
|
try {
|
|
const store = createModuleLifecycleStore(db);
|
|
await store.setEnabled({ enabled, moduleId });
|
|
const resolution = resolveModuleEligibility(discovered, await store.readConfiguration());
|
|
console.log(
|
|
`Module "${moduleId}" is now configured ${enabled ? "enabled" : "disabled"}. Restart the API to apply it.`,
|
|
);
|
|
for (const entry of resolution.entries) {
|
|
const blocked = entry.blocked;
|
|
if (!blocked) {
|
|
continue;
|
|
}
|
|
// Names the dependency, the configuration key, or the logical storage bucket — never a
|
|
// configuration value, an endpoint, or a credential.
|
|
const cause = isDependencyBlockedDetail(blocked)
|
|
? blocked.dependency.moduleId
|
|
: isStorageBlockedDetail(blocked)
|
|
? blocked.storageBucketId
|
|
: blocked.configurationKey;
|
|
console.log(`- "${entry.moduleId}" will not start: ${blocked.reason} (${cause}).`);
|
|
}
|
|
} finally {
|
|
await close().catch(() => undefined);
|
|
}
|
|
}
|
|
|
|
function reportCliError(error: unknown): void {
|
|
if (error instanceof ModuleLifecycleCliError) {
|
|
console.error(error.message);
|
|
return;
|
|
}
|
|
if (error instanceof ModuleLifecycleStoreError) {
|
|
console.error(`[${error.code}] ${error.message}`);
|
|
return;
|
|
}
|
|
if (error instanceof ModuleDiscoveryError) {
|
|
console.error(error.message);
|
|
for (const issue of error.issues) {
|
|
const issuePath = issue.path ? ` (${issue.path})` : "";
|
|
console.error(`[${issue.code}] ${issue.moduleDirectory}${issuePath}: ${issue.message}`);
|
|
}
|
|
return;
|
|
}
|
|
console.error("The module enablement change failed.");
|
|
}
|
|
|
|
function isDirectExecution(): boolean {
|
|
const entrypoint = process.argv[1];
|
|
return (
|
|
entrypoint !== undefined && import.meta.url === pathToFileURL(path.resolve(entrypoint)).href
|
|
);
|
|
}
|
|
|
|
if (isDirectExecution()) {
|
|
main().catch((error: unknown) => {
|
|
reportCliError(error);
|
|
process.exitCode = 1;
|
|
});
|
|
}
|