fix: give Doctor the host configuration the runtime receives
`pnpm doctor` and `startApi` each read their own subset of the same environment variables, and the subsets had drifted. Doctor never read `S3_*` or module secrets at all, so a correctly configured installation was told its object storage was "not configured" and every module requiring a bucket or a secret was reported blocked -- while the runtime, from the identical environment, bound those buckets and ran the modules. Both executables now map the environment through one `loadHostConfiguration(env)` in Core, which takes the environment as an argument and never reads `process.env` itself. Validation stays with the existing per-domain validators, so each caller keeps its own failure behaviour: startup refuses a rejected value, Doctor reports it as a sanitized code. Doctor's storage option becomes raw input like its mail option, so a half-configured provider is reported as a blocking configuration failure instead of throwing before a report exists. The outbound-email check -- computed, counted toward the result, but absent from every rendered section -- is now printed, and the rendered set is asserted against a real report so a future check cannot go missing the same way. Co-Authored-By: Claude Opus 5 <[email protected]>
This commit is contained in:
co-authored by
Claude Opus 5
parent
a835215eb8
commit
2b4f0afb72
@@ -73,9 +73,12 @@ import {
|
||||
} from "../modules/index.js";
|
||||
import {
|
||||
createS3StorageProvider,
|
||||
createStorageProviderConfig,
|
||||
describeStorageProvider,
|
||||
physicalBucketName,
|
||||
StorageConfigError,
|
||||
type StorageProviderConfig,
|
||||
type StorageProviderConfigInput,
|
||||
} from "../storage/index.js";
|
||||
|
||||
export type DoctorCheckId =
|
||||
@@ -129,19 +132,27 @@ export interface DoctorOptions {
|
||||
readonly identityConfiguration?: DoctorIdentityConfigurationOptions | undefined;
|
||||
readonly moduleDiscovery: ModuleDiscoveryOptions;
|
||||
/** Where deployment-supplied module secrets come from, so Doctor's answer about a required secret
|
||||
* matches what `startApi` would resolve. Omitted supplies nothing — Doctor then reports a required
|
||||
* secret as missing, which is the honest answer for a deployment that has not set it. */
|
||||
* matches what `startApi` would resolve. Omitted supplies nothing — Doctor then reports every
|
||||
* required secret as missing, which is only the honest answer for a deployment that has actually
|
||||
* set none, so an executable must pass the same source it would give the runtime. */
|
||||
readonly moduleSecrets?: ModuleSecretSource;
|
||||
/** The validated host storage provider, or `undefined` when this installation has none. Doctor
|
||||
* never receives raw environment values and never prints a credential. */
|
||||
readonly storage?: StorageProviderConfig | undefined;
|
||||
/**
|
||||
* The host's object-storage settings as the executable read them, validated here.
|
||||
*
|
||||
* **Raw input**, for the same reason `mailConfiguration` below is raw: a half-configured provider
|
||||
* is precisely the thing an operator runs Doctor to find, so Doctor has to be the one that
|
||||
* validates it and reports the sanitized code. A pre-validated option meant a bad value threw
|
||||
* before a report existed, and — because the executable then had to validate it itself — meant
|
||||
* `pnpm doctor` simply never passed one at all, reporting configured storage as absent.
|
||||
*/
|
||||
readonly storageConfiguration?: StorageProviderConfigInput | undefined;
|
||||
/**
|
||||
* The host's outbound mail settings as the executable read them, validated here.
|
||||
*
|
||||
* Deliberately **raw input** rather than a validated config, exactly like `identityConfiguration`:
|
||||
* a malformed SMTP setting is precisely the thing an operator runs Doctor to find, so Doctor has
|
||||
* to be the one that validates it and reports the sanitized code. A pre-validated option would
|
||||
* mean a bad value crashed the command instead of appearing in its report.
|
||||
* Deliberately **raw input**, exactly like `identityConfiguration` and `storageConfiguration`: a
|
||||
* malformed SMTP setting is precisely the thing an operator runs Doctor to find, so Doctor has to
|
||||
* be the one that validates it and reports the sanitized code. A pre-validated option would mean
|
||||
* a bad value crashed the command instead of appearing in its report.
|
||||
*/
|
||||
readonly mailConfiguration?: MailProviderConfigInput | undefined;
|
||||
readonly runtimeRange: string;
|
||||
@@ -851,6 +862,23 @@ export async function diagnoseEkklesia(
|
||||
options: DoctorOptions,
|
||||
dependencies: DoctorDependencies = productionDependencies,
|
||||
): Promise<DoctorReport> {
|
||||
// Resolved first, before module eligibility is decided: whether a provider is configured is an
|
||||
// input to whether a module that declares a bucket can run, so validating it later would mean
|
||||
// deciding eligibility against a question that had not been answered yet.
|
||||
const hostEnvironment =
|
||||
options.databaseEnvironment === "development" ? "development" : "production";
|
||||
let storageConfig: StorageProviderConfig | undefined;
|
||||
let storageConfigurationError: string | undefined;
|
||||
try {
|
||||
storageConfig = createStorageProviderConfig(options.storageConfiguration, {
|
||||
environment: hostEnvironment,
|
||||
});
|
||||
} catch (error) {
|
||||
// The sanitized code only — never the endpoint, the access key, or the secret key.
|
||||
storageConfigurationError =
|
||||
error instanceof StorageConfigError ? error.code : "STORAGE_CONFIGURATION_INVALID";
|
||||
}
|
||||
|
||||
let runtimeCheck: DoctorCheck;
|
||||
try {
|
||||
runtimeCheck = dependencies.runtimeSatisfies(options.runtimeVersion, options.runtimeRange)
|
||||
@@ -960,7 +988,7 @@ export async function diagnoseEkklesia(
|
||||
discoveredModules,
|
||||
configuration,
|
||||
{ secrets: options.moduleSecrets ?? EMPTY_MODULE_SECRET_SOURCE, settings },
|
||||
{ providerConfigured: options.storage !== undefined },
|
||||
{ providerConfigured: storageConfig !== undefined },
|
||||
);
|
||||
eligibilityEntries = resolution.entries;
|
||||
lifecycleCheck = moduleLifecycleCheck(resolution.entries);
|
||||
@@ -1075,7 +1103,20 @@ export async function diagnoseEkklesia(
|
||||
// whether modules run. Conflating them would let a momentary network blip read as a module
|
||||
// problem (ADR 0030).
|
||||
let storageCheck: DoctorCheck;
|
||||
if (!options.storage) {
|
||||
if (storageConfigurationError !== undefined) {
|
||||
// A failure, unlike an unreachable provider: this is not a network condition an operator can
|
||||
// wait out. `startApi` refuses to start on exactly this input, so a deployment carrying it is
|
||||
// genuinely not ready, and saying so is what stops the operator from discovering it at boot.
|
||||
storageCheck = freezeCheck(
|
||||
"object-storage.integration",
|
||||
"failure",
|
||||
"Object storage configuration invalid",
|
||||
[
|
||||
`The object-storage settings were rejected: ${storageConfigurationError}.`,
|
||||
"Nothing was connected to and no credential is shown. Correct the S3_* values and run Doctor again.",
|
||||
],
|
||||
);
|
||||
} else if (!storageConfig) {
|
||||
storageCheck = freezeCheck(
|
||||
"object-storage.integration",
|
||||
"skipped",
|
||||
@@ -1084,14 +1125,14 @@ export async function diagnoseEkklesia(
|
||||
);
|
||||
} else {
|
||||
try {
|
||||
await dependencies.probeStorage(options.storage);
|
||||
await dependencies.probeStorage(storageConfig);
|
||||
storageCheck = freezeCheck("object-storage.integration", "pass", "Object storage reachable", [
|
||||
describeStorageProvider(options.storage),
|
||||
describeStorageProvider(storageConfig),
|
||||
// Said plainly rather than implied: this probe used the endpoint Core talks to, and a
|
||||
// separate browser-facing origin is by definition something a browser reaches and this
|
||||
// process may not. Reporting "reachable" without that caveat would let an operator conclude
|
||||
// direct delivery works when only half of it was tested.
|
||||
...(options.storage.deliveryEndpoint === options.storage.endpoint
|
||||
...(storageConfig.deliveryEndpoint === storageConfig.endpoint
|
||||
? []
|
||||
: [
|
||||
"The browser delivery origin is configured separately and was not probed; verify it from a browser. Any reverse proxy in front of it must pass the original Host header through unchanged, or signed read URLs will be rejected.",
|
||||
@@ -1106,7 +1147,7 @@ export async function diagnoseEkklesia(
|
||||
"warning",
|
||||
"Object storage unreachable",
|
||||
[
|
||||
describeStorageProvider(options.storage),
|
||||
describeStorageProvider(storageConfig),
|
||||
"The configured storage service did not respond. Modules already running are unaffected.",
|
||||
],
|
||||
);
|
||||
@@ -1114,7 +1155,7 @@ export async function diagnoseEkklesia(
|
||||
}
|
||||
|
||||
const storageBindings = discoveredModules
|
||||
? storageBindingsCheck(discoveredModules, eligibilityEntries, options.storage)
|
||||
? storageBindingsCheck(discoveredModules, eligibilityEntries, storageConfig)
|
||||
: freezeCheck("object-storage.bindings", "skipped", "Storage bindings skipped", [
|
||||
"Complete module discovery is required.",
|
||||
]);
|
||||
@@ -1128,7 +1169,7 @@ export async function diagnoseEkklesia(
|
||||
let mailConfigurationError: string | undefined;
|
||||
try {
|
||||
mailConfig = createMailProviderConfig(options.mailConfiguration, {
|
||||
environment: options.databaseEnvironment === "development" ? "development" : "production",
|
||||
environment: hostEnvironment,
|
||||
});
|
||||
} catch (error) {
|
||||
// The sanitized code only — never the host, the username, or the password.
|
||||
|
||||
Reference in New Issue
Block a user