Files
reverse-engineering-anything/src/application/SetupClientConfiguration.ts
T
morluto cef87c498a refactor(architecture): add the ports and resources layers, move ports and shared resource owners there, and ratchet the layer baseline (#11208)
* test(architecture): fail on a stale layer baseline and document the declared layers

verify:module-boundaries reported a layer baseline entry whose imports were
gone but still passed, so main kept process -> artifacts at 20 after it fell
to 17 and a later change could add three imports back unnoticed. A stale
entry now fails like growth; --shrink-layer-baseline lowers it in the change
that removes the imports. The architecture map and CONTRIBUTING name
scripts/lib/module-layers.mjs as the per-directory layer declaration.

* test(architecture): refuse to lower the layer baseline after an inspection failure

A file that cannot be parsed contributes no imports, so a shrink run would record counts that fail as growth once the file is fixed. Whole-command tests cover stale rejection, shrinking, refused growth and the inspection failure.

* refactor(ports): move the progress, work-scope and inspection-scope ports to src/ports (#11214)

* refactor(ports): move the progress, work-scope and inspection-scope ports to src/ports

Pure move with git mv and import specifier updates.

* test(architecture): declare the ports layer and lower the layer baseline

src/ports sits between the foundation and the providers. Moving the three
ports removes 11 provider -> application imports.

* refactor(ports): move AnalysisProvider to src/ports (#11217)

* refactor(ports): move AnalysisProvider to src/ports

Pure move with git mv and import specifier updates in its importers, the
built-fixture path, the CI scope glob and the lint-rule test spellings.

* test(architecture): lower the layer baseline after moving AnalysisProvider

* refactor(ports): move the per-feature provider ports to src/ports (#11226)

* refactor(ports): move the per-feature provider ports to src/ports

Pure move with git mv and import specifier updates: the 47 *Port.ts and
*Ports.ts files that providers implement, plus OptionalObservationProviders,
which only composes the observation ports.

* test(architecture): lower the layer baseline after moving the feature ports

* refactor(providers): move closeAnalysisClient and the Frida session input errors to their owners (#11233)

* refactor(providers): move closeAnalysisClient to src/providers and the Frida session input errors to src/frida

Pure move with git mv and import specifier updates.

* test(architecture): drop the application-providers and application-frida cycles from the layer baseline

* fix(ci): keep provider lanes selecting the ports moved to src/ports

Each lane glob that matched a moved port under src/application gains its src/ports counterpart; the change-scope test pins one moved port per lane.

* refactor(domain): declare the localPath host exception and read HOST_PLATFORM there (#11256)

absoluteLocalPathStringSchema decides which paths are absolute on the running host, so it reads HOST_PLATFORM instead of process.platform. Domain may not import outside domain/contracts; module-layers now declares LAYER_EXCEPTIONS, exact file-to-file imports with a reason, and both the layer count and the pure-layer boundary skip only that import. Any other domain -> platform import still fails.

* refactor(ports): move the doctor check and provider inspection types to src/ports (#11246)

* refactor(ports): move the doctor check and provider inspection types to src/ports

Declaration move from application/Doctor.ts (unchanged text) and import updates; no re-export from Doctor.ts.

* test(architecture): lower the layer baseline after moving the doctor provider types

* refactor(ports): move the packet capture and signal recording ports to src/ports (#11249)

* refactor(ports): move the packet capture and signal recording ports to src/ports

Declaration move (unchanged text) out of the two application services, with import updates.

* test(architecture): lower the layer baseline after moving the capture and signal ports

* refactor(domain): move the analysis error projection schema from contracts to domain (#11251)

* refactor(domain): move the analysis error projection schema from contracts to domain

Declaration move (unchanged text) of the projection schemas that domain modules embed; contracts/errorSchemas.ts keeps the CLI envelope and the published JSON Schema. Import updates only.

* test(architecture): drop the contracts-domain cycle from the layer baseline

* refactor(ports): drop the imports the moved capture, signal and doctor types left behind

Also give the packet capture and signal recording lanes the new port paths, with change-scope cases.

* refactor(resources): add src/resources and move AnalysisCleanupLease and ArtifactReader there (#11259)

* refactor(resources): move AnalysisCleanupLease to src/resources

Pure move: git mv plus import specifier rewrites (source, tests, and the dist paths the verifier scripts load).

* refactor(resources): declare src/resources as a foundation unit

src/resources owns the shared analysis resource modules that process, windows and providers hold; AnalysisCleanupLease is the first. Its tests join the adapters project, the apk signature lane selects it beside src/artifacts, and the layer baseline drops the process and windows imports of the lease.

* test(ci): pin the apk signature lane on the moved cleanup lease

* refactor(resources): move ArtifactReader to src/resources

Pure move: git mv plus import specifier rewrites (source, tests, and the dist path a verifier script loads).

* test(architecture): lower the layer baseline after moving ArtifactReader

windows no longer imports src/artifacts; process -> artifacts 11 -> 9. The CI lanes that selected src/artifacts/ArtifactReader.ts select its new path, pinned in the change-scope test.

* refactor(resources): move ArtifactResourceScope to src/resources (#11265)

* refactor(artifacts): name the output tree and private root capabilities the resource scope releases

ArtifactResourceScope typed its output-tree and private-runtime-root owners with SafeOutputTree (src/artifacts) and PrivateRuntimeRoot (src/process). It only calls rollback() and close(), so it now declares those capabilities itself and names neither unit, which lets it move to src/resources without a resources <-> process cycle. The withheld-export test narrows to SafeOutputTree where it reads the published flag.

* refactor(resources): move ArtifactResourceScope to src/resources

Pure move: git mv plus import specifier rewrites (source, tests, the dist paths verifier scripts load, and the FIFO probe's module-relative URL).

* test(architecture): lower the layer baseline after moving ArtifactResourceScope

process -> artifacts 9 -> 5, and the artifacts <-> dotnet mutual pair is gone. The sqlite and agentenv lanes select the scope at its new path, pinned in the change-scope test.

* refactor(resources): move ArtifactFileOperation to src/resources (#11269)

* refactor(resources): move ArtifactFileOperation to src/resources

Pure move: git mv plus import specifier rewrites (source, tests, and the dist paths verifier scripts load).

* test(architecture): lower the layer baseline after moving ArtifactFileOperation

process -> artifacts 5 -> 1.

* refactor(resources): move readStableArtifact to src/resources (#11271)

* refactor(resources): move readStableArtifact to src/resources

Pure move: git mv plus import specifier rewrites.

* test(architecture): lower the layer baseline after moving readStableArtifact

process no longer imports src/artifacts: process -> artifacts 1 -> 0 and the artifacts <-> process mutual pair is gone. The seven lanes that selected readStableArtifact select its new path, pinned in the change-scope test; the architecture map lists what src/resources owns.

* refactor(hopper): take Linux launcher verification from composition through a port (#11278)

The Hopper launcher imported inspectLinuxHopperLauncher and retryLinuxHopperPublisherCleanup from src/application (the two hopper -> application imports). src/ports/LinuxHopperLauncherVerification.ts now names that capability; src/application/LinuxHopper.ts provides LINUX_HOPPER_LAUNCHER_VERIFICATION, binary composition passes it to HopperProvider, and the provider hands it to the launcher. A launcher built without one refuses a Linux demo launch with reason verification_unavailable before running the launcher. Layer baseline: hopper -> application 2 -> 0.

* refactor(config): move Hopper launcher discovery to a src/hopperPaths foundation unit (#11292)

* refactor(hopper): move the launcher discovery and macOS Hopper paths to src/hopperPaths

Pure move: git mv plus import specifier rewrites.

* refactor(hopper): declare src/hopperPaths as a foundation unit with the Linux launcher candidates

Hopper install paths and launcher discovery are pure path facts that the
Hopper provider, doctor and setup all read. Declare src/hopperPaths in the
foundation layer, add it to the adapters test project, the architecture
map and the package-baseline CI lane, and move the Linux launcher
candidates out of src/application/LinuxHopper.ts into
src/hopperPaths/LinuxHopperPaths.ts so discovery no longer imports
application code.

* refactor(config): leave Hopper launcher discovery to the Hopper provider

parseConfig resolved an unset HOPPER_LAUNCHER_PATH by probing the
filesystem through application-owned discovery, so config imported
application (config -> application 2, application <-> config cycle) and
read process.platform ambiently.

AppConfig.hopperLauncherPath is now the caller's HOPPER_LAUNCHER_PATH
unchanged (string | undefined). src/hopperPaths/HopperLauncherDiscovery.ts
owns the selection (selectedHopperLauncherPath: the configured spelling,
else discovery from the caller environment's home on the provider's
platform); HopperProvider and the two real-Hopper verifiers read it.
Discovery tests move from config.test.ts to src/hopperPaths; a provider
test covers discovery from the provider's own platform and home.

Module layers: config -> application 2 -> 0; application <-> config removed.
Architecture guards: ambient platform reads in parseConfig.ts 2 -> 0.

* refactor(providers): move owned-process prerequisite availability out of application (#11294)

* refactor(providers): move the owned-process prerequisite availability mapping to src/providers

Pure move: git mv plus import specifier rewrites.

* test(architecture): lower the layer baseline after moving owned-process availability

android -> application 1 -> 0; apktool -> application 1 -> 0.

* refactor(process): move the regular-file read owner out of application (#11299)

* refactor(process): move the regular-file read owner from src/application to src/process

Pure move: git mv plus import specifier rewrites.

* test(architecture): lower the layer baseline after moving the regular-file read owner

desktop -> application 5 -> 4; dotnet -> application 2 -> 1.

The agentenv lane listed src/application/RegularFileRead.ts. At its new
path it is a src/process/ shared boundary: fast qualification selects the
code and runtime checks (and the single owning lane, web_source_map, via
src/process/**), and full qualification selects every lane, as for every
other src/process/ module. A second owner entry would only suppress the
web_source_map selection, so the agentenv entry is removed, not renamed.

* refactor(resources): give atomic text writes their own owner (#11302)

* refactor(resources): give atomic text writes their own owner in src/resources

src/application/JsonFiles.ts owned both JSON input reads and the atomic
text write (writeTextFile / writeTextParts and their staged-output
publication). The write side depends only on domain, filesystem and
resource owners, but il2cpp's Ghidra seed writer had to import
application to reach it (il2cpp -> application).

Move the write side verbatim to src/resources/TextFileWrite.ts
(TextWriteCancellation, writeTextFile, writeTextParts and their private
staging, publication and failure classification helpers). JsonFiles keeps
the JSON read owner and reads the shared errno-to-reason classifier
(fileAccessFailureReason) from the write owner instead of a copy.
Importers (il2cpp seed writer, evidence bundle files, desktop build
solves, analysis snapshot files and four boundary tests) read the new
path; no re-export is left in JsonFiles.

* test(architecture): lower the layer baseline after moving the text write owner

il2cpp -> application 1 -> 0.

* refactor(ports): move the desktop build host contract to src/ports (#11303)

* refactor(domain): move the setup cancellation check from src/application to src/domain

Pure move: git mv plus import specifier rewrites.

* refactor(ports): move the desktop build host contract to src/ports

The desktop provider implements doctor's desktop build facts reader and
setup's desktop build host, but the contract it implements lived in
application (DesktopBuildDoctor, SetupDesktopBuild, Doctor's
clientRegistrations signature, ClientRegistrationEnvironment's setting
types), so desktop imported application four times and the two units
were a recorded mutual pair.

src/ports/DesktopBuildHost.ts now holds that contract, moved verbatim:
DesktopBuildCommand, DesktopBuildFacts, DesktopBuildFactsInput,
DesktopBuildSetupFacts, DesktopBuildSetupHost, RecordedProviderSettings
and OwnedProviderSetting. Two names are new: DesktopBuildRegistration,
the registration facts the host reads (client, command and the
recorded-settings names; client registration status satisfies it), and
DesktopBuildRegistrationReader, which replaces
DoctorHost["clientRegistrations"] in the setup host. The facts input's
registration reader returns DesktopBuildRegistration instead of the full
application status; the setup facts' settings are spelled
Readonly<Record<string, string>> (SetupProviderEnvironment's definition).
Application imports the types from the port; no re-export is left.

* test(architecture): lower the layer baseline after the desktop build host port

desktop -> application 4 -> 0; the application <-> desktop mutual pair is gone.

* refactor(domain): define the resolved app bundle resource root beside its schema (#11304)

* refactor(domain): define the resolved app bundle resource root beside its provenance schema

ResolvedAppBundleResourceRoot (an app directory's resource-only identity)
is a pure type over BundleResourceRoot's layout, but it lived in
src/application/AppBundleExecutable.ts, so the native and artifact
providers that receive it imported application.

Move the interface verbatim to src/domain/apple/bundleResourceRoot.ts,
which owns BundleResourceRoot, and point its eight readers there (native
macOS provider and plist source, artifact provider, binary composition,
and the binary session, status, port and bundle-resource session). The
resolver that produces it stays in application.

* test(architecture): lower the layer baseline after moving the resource root type

native -> application 2 -> 0; artifacts -> application 2 -> 1 (the
artifact provider still constructs BundleResourceSession).

* refactor(config): move the pwntools input bound parser to src/config (#11306)

* refactor(config): move the pwntools input bound parser from src/native to src/config

Pure move: git mv plus import specifier rewrites, and the module path in docs/design/rea-limit-inventory.md (table realigned by oxfmt).

* test(architecture): lower the layer baseline after moving the pwntools input bound

config -> native 1 -> 0. The binary_layout and recorded_crash lanes, which
select src/native/pwntools/**, also select src/config/pwntoolsInputLimit*.ts;
ciChangeScope.test.ts pins both.

* refactor(filesystem): move REA cache directory helpers out of config (#11309)

* refactor(filesystem): move the REA cache directory and lexical directory helpers from src/config to src/filesystem

Pure move: git mv plus import specifier rewrites.

* test(architecture): drop the config and filesystem cycle from the layer baseline

config no longer imports filesystem; filesystem still reads the Windows
ChangeTime settle budget from config.

* refactor(windows): break the process and windows import cycle (#11317)

* refactor(domain): move the runtime-control and private-runtime-root refusals from src/process to src/domain

Pure move: git mv plus import specifier rewrites (including the dist path scripts/verify-windows-native.mjs loads).

* refactor(windows): type Job Object cleanup by what a Windows job reports

WindowsOwnedProcess.cleanup() returned process-ownership's
ProcessCleanupResult, so src/windows imported src/process for a type while
process imports windows to supervise Windows trees. A Job Object stop only
ever reports settled-and-signalled or a reason it did not settle; name that
subset WindowsJobCleanupResult in windows. It stays assignable to
ProcessCleanupResult, so the process supervisor reads it unchanged.

* test(architecture): drop the process and windows cycle from the layer baseline

* test(architecture): ratchet cross-provider imports and imports past a provider entry (#11386)

* test(architecture): ratchet cross-provider imports and imports past a provider entry

A provider folder may import the domain, contracts, foundation and ports layers, the shared provider core (src/providers) and its own files; an import of another provider folder is a recorded exception. Application, composition and the CLI/MCP adapters reach a provider only through src/<provider>/index.ts. verify:module-boundaries counts both kinds of import per unit pair in the layer baseline (crossProvider, providerEntry); like the upward counts they may only shrink, and a pair missing from the baseline fails.

* refactor(resources): move StableArtifactFailure and StableArtifactObservation into src/resources (#11387)

* refactor(resources): move StableArtifactFailure and StableArtifactObservation into src/resources

Providers project stable-read failures through StableArtifactFailure next to the other shared provider toolkit owners (ArtifactReader, ArtifactResourceScope, ArtifactFileOperation, AnalysisCleanupLease, readStableArtifact) that already live in src/resources. Under src/artifacts it made every provider that reads a stable artifact import the artifacts provider. Pure move: git mv plus import specifier and baseline updates; the layer baseline drops the provider-boundary counts the move removes.

* refactor(resources): reach the shared provider toolkit through src/resources/index.ts (#11390)

* refactor(resources): import the shared provider toolkit through src/resources/index.ts

Adds src/resources/index.ts, which exports the toolkit names that production code outside src/resources uses, and rewrites those importers (420 files) to import from it, merging each importer's toolkit imports into one declaration. Mechanical: import declarations only.

* test(architecture): reach src/resources only through its entry file

verify:module-boundaries now counts any production import of a src/resources file other than src/resources/index.ts, from any unit, with the imports past a provider entry. The count is renamed from providerEntry to entry ("import past the entry file"); it may only shrink, and src/resources starts at zero.

* test(architecture): cover provider boundary counts through the verifier command

* refactor(resources): move the safe output tree and artifact path owners into src/resources (#11398)

* refactor(resources): move the safe output tree and artifact path owners into src/resources

SafeOutputTree (with its admission, creation failure, readback, cleanup and identity files), StreamBytes, ArtifactPaths and readArtifactFileChunks depend only on domain, filesystem, platform and the toolkit, and browser, firmware, ghidra, javascript, android and apktool use them to publish outputs. Under src/artifacts every such provider imported the artifacts provider. Pure move: git mv, importers moved onto src/resources/index.ts (names added to the entry), the moved files import toolkit modules directly, path keys in the CI scopes and guard baseline follow the move, and the layer baseline drops the removed imports.

* test(architecture): give the shared provider core its own layer below the providers (#11401)

src/providers (deferred client owners and failure attribution) now imports only domain, ports, process, filesystem and the resources toolkit. Declaring it as the providerCore layer, between ports and providers, makes any import from it into a provider folder an upward import that verify:module-boundaries rejects, and lets every unit in the providers layer be a provider folder.

* test(architecture): declare each provider's entry files instead of a provider barrel (#11407)

* chore: ignore the source map parser move (#11348) in blame

* test(architecture): declare inspector's use of the browser CDP client as a provider dependency (#11420)
2026-11-16 03:56:10 +08:00

1494 lines
48 KiB
TypeScript

import type { ArtifactResourceScope } from "../resources/index.js";
import { HOST_PLATFORM } from "../platform/HostPlatform.js";
import { readClientPolicyBlock } from "./GeminiClientSettings.js";
import {
readClientConfigurationFiles,
inlineRegistrationEnvironment,
inlineRegistrationOrigins,
inlineRegistrationOverride,
clientConfigurationForWrite,
clientWriteDialect,
effectiveClientConfiguration,
readConfigurationText,
type ClientConfigurationSource,
type ClientConfigurationFileError,
} from "./ClientConfigurationFiles.js";
import { err, ok, type Result } from "../domain/result.js";
import { ConfigurationError } from "../domain/configurationErrors.js";
import {
clientConfigurationValuesEqual,
effectiveClientServer,
clientServerListedDisabled,
clientServerPath,
legacyClientServerPath,
shadowedClientServers,
OMP_DISABLED_SERVERS_KEY,
parseClientConfiguration,
parseZcodeFallbackConfiguration,
serializeClientConfiguration,
withClientServers,
type ClientConfigurationDocument,
type ClientInlineConfiguration,
type ClientRegistrationDialect,
} from "./ClientConfigurationDocument.js";
import { DISCOVERED_REGISTRATION_SETTINGS } from "./SetupRegistrationEnvironment.js";
import { snapshotEnvironment } from "../process/snapshotEnvironment.js";
import { dshDocument, DshCordisDocument } from "./DshCordisPatch.js";
import { mkdir } from "node:fs/promises";
import { dirname } from "node:path";
import {
PRIVATE_PROFILE_MODES,
privateProfileModesCurrent,
securePrivateDirectory,
} from "./ClientPrivateProfile.js";
import { RegularFileChangedError } from "../filesystem/RegularFile.js";
import { withClientConfigurationTransaction } from "./ClientConfigurationTransaction.js";
import { isClientConfigurationCleanupFailure } from "./ClientConfigurationCleanup.js";
import {
ClientConfigurationPublication,
ClientConfigurationWriteError,
} from "./ClientConfigurationPublication.js";
import {
clientRegistrationEnvironment,
clientRegistrationEnvironmentDetailsWithBudget,
type ProviderRequestBudgetResolver,
} from "./ClientRegistrationEnvironment.js";
import {
clientRegistrationOwnership,
clientRegistrationOwnershipRemediation,
refreshClientRegistration,
} from "./ClientRegistration.js";
import { PRODUCT_IDENTITY } from "../identity.js";
import { currentClientRegistrationCommand } from "./ClientRegistrationIdentity.js";
import { resolveClientConfigTransactionPath } from "./ClientConfigPath.js";
import { packageReadTargetChanged } from "./MsixPackageStorage.js";
import { RegularFileCleanupFailure } from "../filesystem/OwnedRegularFile.js";
import {
readRegularFileText,
readRegularFileTextSnapshot,
InvalidUtf8FileError,
} from "../process/RegularFileRead.js";
import {
preserveCurrentRecoveryBackup,
selectCurrentRecoveryBackup,
} from "./SetupRecoveryBackup.js";
import { preservePrivateRecoveryBackup } from "./ClientRegistrationBackup.js";
import type {
ClientConfigurationInspection,
ClientConfigurationResult,
SetupProviderEnvironment,
} from "./SetupTypes.js";
import {
registrationWriteBlocker,
type SetupClient,
} from "./SupportedClients.js";
export class ClientConfigurationCleanupRollbackFailure extends RegularFileCleanupFailure<string> {
constructor(
failure: RegularFileCleanupFailure<string>,
readonly configurationFailure: Extract<
ClientConfigurationResult,
{ readonly status: "failed" }
>,
) {
super({
...failure,
cleanupCause: new AggregateError(
[failure.cleanupCause, configurationFailure],
`Configuration readback cleanup and rollback failed: ${failure.path}`,
),
});
}
}
/** Configure one supported client's native stdio MCP registration shape. */
export const configureClientConfiguration = async (
client: SetupClient,
environment: SetupProviderEnvironment = {},
command: readonly string[] = currentClientRegistrationCommand(),
resolveProviderRequestBudget?: ProviderRequestBudgetResolver,
// Setup writes the running host's client files unless its host selects one.
platform: NodeJS.Platform = HOST_PLATFORM.platform,
): Promise<ClientConfigurationResult> => {
if (command.length === 0)
return {
status: "failed",
reason: "registration_ownership",
detail:
"The running REA entrypoint could not be identified; run setup from an installed REA command.",
};
if (client.configPathError !== undefined)
return { status: "failed", reason: "path" };
const transactionPath = await resolveClientConfigTransactionPath(
client.configPath,
);
if (transactionPath === undefined)
return { status: "failed", reason: "path" };
try {
return await withClientConfigurationTransaction(transactionPath, () =>
configureClientDocument(
{ client, transactionPath, platform },
environment,
command,
resolveProviderRequestBudget,
),
);
} catch (cause: unknown) {
if (cause instanceof ConfigurationError && !cause.cleanupIncomplete)
return { status: "failed", reason: "readback" };
throw cause;
}
};
/** An error that still owns an unreleased resource must reach the caller. */
const cleanupIncomplete = (cause: unknown): boolean =>
cause instanceof ConfigurationError && cause.cleanupIncomplete;
const configureClientDocument = async (
{
client,
transactionPath,
platform,
}: {
readonly client: SetupClient;
readonly transactionPath: string;
readonly platform: NodeJS.Platform;
},
environment: SetupProviderEnvironment,
command: readonly string[],
resolveProviderRequestBudget?: ProviderRequestBudgetResolver,
): Promise<ClientConfigurationResult> => {
const format = client.format;
if (format === undefined || format === "unsupported")
return { status: "failed", reason: "readback" };
const files = await readClientConfigurationFiles(
client,
undefined,
platform,
environment,
);
if (!files.ok) {
throwCleanupFailure(files.error);
return { status: "failed", reason: "readback" };
}
const existing = files.value.find(
({ sourcePath }) => sourcePath === client.configPath,
);
const editabilityError =
existing?.dialect === "dsh"
? dshDocument(existing.document).editabilityError
: undefined;
if (editabilityError !== undefined)
return { status: "failed", reason: "readback" };
// Policy admission belongs to the transaction snapshot below, not the
// earlier layered discovery document.
let snapshot:
| Awaited<ReturnType<typeof readRegularFileTextSnapshot>>
| undefined;
try {
snapshot = await readRegularFileTextSnapshot(transactionPath, {
symlinks: "reject",
});
} catch (cause: unknown) {
if (cause instanceof RegularFileCleanupFailure) throw cause;
if (!isMissing(cause)) return { status: "failed", reason: "readback" };
}
const original = snapshot?.text;
let parsed: ClientConfigurationDocument;
try {
parsed = parseClientConfiguration(
original ??
(format === "toml" || format === "grok" || format === "dsh"
? ""
: "{}"),
format,
);
parsed = clientConfigurationForWrite(parsed, files.value);
const ownershipBlocker = registrationOwnershipBlocker(
client,
parsed,
original ?? "",
files.value,
platform,
);
if (ownershipBlocker !== undefined)
return {
status: "failed",
reason: "registration_ownership",
detail: ownershipBlocker,
};
const policy = await readClientPolicyBlock(
client,
parsed,
await clientConfigurationDesired(
client,
environment,
command,
parsed,
files.value,
platform,
resolveProviderRequestBudget,
),
);
if (!policy.ok) {
throwCleanupFailure(policy.error);
return { status: "failed", reason: "readback" };
}
if (policy.value !== undefined)
return { status: "failed", reason: "readback" };
} catch (cause: unknown) {
if (cause instanceof RegularFileCleanupFailure) throw cause;
// Malformed existing configuration fails the readback gate.
void cause;
return { status: "failed", reason: "readback" };
}
const fallback = await readZcodeFallbackServers(client, platform, parsed);
if (!fallback.ok) {
if (fallback.error.kind !== "registration_ownership")
throwCleanupFailure(fallback.error);
return fallback.error.kind === "registration_ownership"
? {
status: "failed",
reason: "registration_ownership",
detail: fallback.error.detail,
}
: { status: "failed", reason: "readback" };
}
const desired = await clientConfigurationDesired(
client,
environment,
command,
{
...parsed,
servers: { ...fallback.value, ...parsed.servers },
},
files.value,
platform,
resolveProviderRequestBudget,
);
// The settings written now can differ from the ones inspection admitted,
// for example a Hopper path set by an installation earlier in this setup.
const override = inlineOverrideBlocker(
client,
files.value,
desired,
platform,
);
if (override !== undefined)
return { status: "failed", reason: "read_only_override", detail: override };
if (
registrationCurrent(parsed, desired) &&
(await privateProfileCurrent(client, original))
)
return { status: "unchanged" };
return persistClientConfiguration({
client,
transactionPath,
snapshot,
format,
original,
parsed,
desired,
fallbackServers: fallback.value,
platform,
});
};
interface ClientConfigurationUpdate {
readonly client: SetupClient;
readonly transactionPath: string;
readonly snapshot:
| Awaited<ReturnType<typeof readRegularFileTextSnapshot>>
| undefined;
readonly format: NonNullable<SetupClient["format"]>;
readonly original: string | undefined;
readonly parsed: ClientConfigurationDocument;
readonly desired: unknown;
readonly fallbackServers: Readonly<Record<string, unknown>>;
readonly platform: NodeJS.Platform;
}
const persistClientConfiguration = async ({
client,
transactionPath,
snapshot,
format,
original,
parsed,
desired,
fallbackServers,
platform,
}: ClientConfigurationUpdate): Promise<ClientConfigurationResult> => {
// The plan chose this file; an MSIX package may have switched to its
// private copy since, for example when it quit.
if (client.msixPackage !== undefined) {
const target = await packageReadTargetChanged(
client.msixPackage,
client.configPath,
);
if (!target.ok)
return {
status: "failed",
reason: "target_unavailable",
failure: {
kind: "inspect",
path: target.error.path,
detail: target.error.detail,
},
};
if (target.value) return { status: "failed", reason: "target_changed" };
}
// A native OpenCode V2 entry replaces REA's legacy V1 entry, which would
// otherwise conflict with it.
const legacyPath = legacyClientServerPath(
parsed,
PRODUCT_IDENTITY.mcpServerKey,
);
const registered = withClientServers(
parsed,
{
...fallbackServers,
...parsed.servers,
[PRODUCT_IDENTITY.mcpServerKey]: desired,
},
platform,
PRODUCT_IDENTITY.mcpServerKey,
);
// OMP's denylist would hide the registration; keep every other listed name.
const ompDisabled =
parsed.dialect === "omp"
? parsed.document[OMP_DISABLED_SERVERS_KEY]
: undefined;
const enableOmp =
Array.isArray(ompDisabled) &&
ompDisabled.includes(PRODUCT_IDENTITY.mcpServerKey);
const document =
enableOmp && Array.isArray(ompDisabled)
? {
...registered,
[OMP_DISABLED_SERVERS_KEY]: ompDisabled.filter(
(name: unknown) => name !== PRODUCT_IDENTITY.mcpServerKey,
),
}
: registered;
let serialized: ReturnType<typeof serializeClientConfiguration>;
try {
serialized = serializeClientConfiguration(
document,
format,
original,
[
...Object.keys(fallbackServers)
.filter((name) => name !== PRODUCT_IDENTITY.mcpServerKey)
.map((name) => clientServerPath(parsed, name)),
clientServerPath(parsed, PRODUCT_IDENTITY.mcpServerKey),
...(legacyPath === undefined ? [] : [legacyPath]),
...(enableOmp ? [[OMP_DISABLED_SERVERS_KEY]] : []),
],
// Ownership admission above covers every legacy member removed here.
{ removeShadowedMembersAt: legacyPath === undefined ? [] : [legacyPath] },
);
} catch (cause: unknown) {
// An unserializable edit is reported before any file is written.
return {
status: "failed",
reason: "write",
failure: new ClientConfigurationWriteError(
client.configPath,
"serialize",
cause,
).problem,
};
}
if (!serialized.ok)
return {
status: "failed",
reason: "shadowed_member",
path: serialized.error.path,
};
let recoveryBackupPath: string | undefined;
if (original !== undefined) {
// A private profile's backup stays owner-only even when it sits beside
// a requested link outside the secured target directory.
const preserved = await (
client.privateProfile === undefined
? preserveCurrentRecoveryBackup
: preservePrivateRecoveryBackup
)(`${client.configPath}.rea.backup`, transactionPath, original);
if (!preserved.ok) return { status: "failed", reason: "backup" };
recoveryBackupPath = preserved.value;
}
let publication: ClientConfigurationPublication;
try {
await mkdir(dirname(client.configPath), {
recursive: true,
...(client.privateProfile !== undefined
? { mode: PRIVATE_PROFILE_MODES.directory }
: {}),
});
// File modes are this host's, whatever platform the registration targets.
if (
client.privateProfile !== undefined &&
HOST_PLATFORM.platform !== "win32"
)
await securePrivateDirectory(
dirname(transactionPath),
client.privateProfile.home,
() => {},
undefined,
);
publication = await ClientConfigurationPublication.write(
transactionPath,
serialized.value,
original,
{
requestedPath: client.configPath,
state: snapshot?.state,
...(client.privateProfile !== undefined
? { requiredMode: PRIVATE_PROFILE_MODES.file }
: {}),
},
);
} catch (cause: unknown) {
if (isClientConfigurationCleanupFailure(cause) || cleanupIncomplete(cause))
throw cause;
if (isConfigurationConflict(cause))
return conflictFailure(recoveryBackupPath);
return {
status: "failed",
reason: "write",
failure: (cause instanceof ClientConfigurationWriteError
? cause
: new ClientConfigurationWriteError(client.configPath, "publish", cause)
).problem,
...(recoveryBackupPath === undefined
? {}
: { backupPath: recoveryBackupPath }),
};
}
return publication.verify(async () => {
try {
const text = await readRegularFileText(publication.path);
await publication.assertCurrent(text);
const readback = parseClientConfiguration(text, format);
if (
!registrationCurrent(readback, desired) ||
Object.entries(fallbackServers).some(
([name, entry]) =>
name !== PRODUCT_IDENTITY.mcpServerKey &&
!clientConfigurationValuesEqual(readback.servers[name], entry),
)
) {
return await rollbackOrReadbackFailure(
publication,
original,
recoveryBackupPath,
);
}
} catch (cause: unknown) {
if (isConfigurationConflict(cause) || isMissing(cause))
return conflictFailure(recoveryBackupPath);
if (cause instanceof RegularFileCleanupFailure) {
const rollback = await restoreConfig(publication, original);
if (!rollback.ok)
throw new ClientConfigurationCleanupRollbackFailure(
cause,
rollbackFailure(rollback.error, recoveryBackupPath),
);
throw cause;
}
// Readback failure restores the transaction before reporting.
void cause;
return rollbackOrReadbackFailure(
publication,
original,
recoveryBackupPath,
);
}
return {
status: "configured",
...(recoveryBackupPath === undefined
? {}
: { backupPath: recoveryBackupPath }),
};
});
};
/** What setup would write into a client's target file, from one read. */
interface ClientRefresh {
readonly original: string | undefined;
readonly parsed: ClientConfigurationDocument | undefined;
readonly desired: unknown;
/** The layers the registration was read from. */
readonly sources: readonly ClientConfigurationSource[];
/** The inline layer whose override is the refusal, when it is. */
readonly overrideOrigin?: ClientInlineConfiguration["origin"];
/** Why setup refuses this write: write-target ownership, a client policy or an overriding inline layer. */
readonly refusal: string | undefined;
}
/**
* Read a client's layers and compute the registration setup would write,
* with setup's own refusal checks. An unreadable or malformed layer is a typed
* failure that keeps its path and recovery.
*/
const readClientRefresh = async (
client: SetupClient,
providerEnvironment: SetupProviderEnvironment,
command: readonly string[],
{
platform,
resolveProviderRequestBudget,
resources,
currentCommandPath,
}: {
readonly platform: NodeJS.Platform;
readonly resolveProviderRequestBudget?: ProviderRequestBudgetResolver;
readonly resources?: ArtifactResourceScope;
/** The entry point whose registrations setup owns; update names the new one. */
readonly currentCommandPath?: string;
},
): Promise<Result<ClientRefresh, ClientConfigurationFileError>> => {
const files = await readClientConfigurationFiles(
client,
resources,
platform,
providerEnvironment,
);
if (!files.ok) {
throwCleanupFailure(files.error);
return files;
}
let original: string | undefined;
try {
original = await readRegularFileText(
client.configPath,
resources === undefined ? {} : { resources },
);
} catch (cause: unknown) {
if (!isMissing(cause)) throw cause;
}
const parsed =
original === undefined
? undefined
: clientConfigurationForWrite(
parseClientConfiguration(original, client.format),
files.value,
);
const desired = await clientConfigurationDesired(
client,
providerEnvironment,
command,
parsed,
files.value,
platform,
resolveProviderRequestBudget,
);
const target =
dshEditabilityBlocker(client, files.value) ??
writeTargetOwnershipBlocker(
client,
files.value,
parsed,
original,
platform,
currentCommandPath,
);
if (target !== undefined)
return ok({
original,
parsed,
desired,
sources: files.value,
refusal: target,
});
const overrideOrigin = inlineRegistrationOverride(
client,
files.value,
desired,
platform,
);
if (overrideOrigin !== undefined)
return ok({
original,
parsed,
desired,
sources: files.value,
overrideOrigin,
refusal: inlineOverrideRemediation(client, overrideOrigin),
});
const policy = await readClientPolicyBlock(
client,
parsed,
desired,
resources,
);
if (!policy.ok) {
throwCleanupFailure(policy.error);
return ok({
original,
parsed,
desired,
sources: files.value,
refusal: policy.error.detail,
});
}
return ok({
original,
parsed,
desired,
sources: files.value,
refusal: policy.value,
});
};
/** Determine whether an existing client configuration matches the desired registration. */
export const clientConfigurationAligned = async (
client: SetupClient,
providerEnvironment: SetupProviderEnvironment,
command: readonly string[],
resolveProviderRequestBudget?: ProviderRequestBudgetResolver,
// Setup reads the running host's client files unless its host selects one.
platform: NodeJS.Platform = HOST_PLATFORM.platform,
): Promise<boolean> => {
if (client.configPathError !== undefined) return false;
try {
const refresh = await readClientRefresh(
client,
providerEnvironment,
command,
resolveProviderRequestBudget === undefined
? { platform }
: { platform, resolveProviderRequestBudget },
);
return (
refresh.ok &&
refresh.value.original !== undefined &&
refresh.value.parsed !== undefined &&
refresh.value.refusal === undefined &&
registrationCurrent(refresh.value.parsed, refresh.value.desired) &&
(await privateProfileCurrent(client, refresh.value.original))
);
} catch (cause: unknown) {
if (cause instanceof RegularFileCleanupFailure) throw cause;
// Unreadable configuration is treated as not aligned so setup repairs it.
void cause;
return false;
}
};
/** Why maintenance leaves a client to setup, with whether alignment is known. */
export interface ClientRefreshRefusal {
readonly alignment: "refused" | "unknown";
readonly remediation: string;
}
/**
* Why update maintenance cannot refresh a client with `command`: setup's
* refusal (a client policy, an unreadable layer, or a read-only inline layer
* that would override the refreshed entry), or `unknown` alignment when the
* inline layer differs only in settings setup discovers from the installed
* providers. Maintenance has only the explicitly selected settings and does
* not run that discovery, so such a client needs `rea setup`. One refused
* client blocks the whole setup plan, so maintenance asks before selecting a
* client. Registration ownership is not checked here; the caller has already
* established it. A supplied scope retains the owner of a file whose cleanup
* failed.
*/
export const clientRefreshRefusal = async (
client: SetupClient,
providerEnvironment: SetupProviderEnvironment,
command: readonly string[],
{
platform,
currentCommandPath,
resources,
}: {
readonly platform: NodeJS.Platform;
/** The entry point the refreshing setup runs from. */
readonly currentCommandPath: string;
readonly resources?: ArtifactResourceScope;
},
): Promise<ClientRefreshRefusal | undefined> => {
const refused = (remediation: string): ClientRefreshRefusal => ({
alignment: "refused",
remediation,
});
if (client.configPathError !== undefined)
return refused(client.configPathError);
try {
const refresh = await readClientRefresh(
client,
providerEnvironment,
command,
{
platform,
currentCommandPath,
...(resources === undefined ? {} : { resources }),
},
);
// An unreadable or malformed layer is a refusal too: setup's preflight
// reports it the same way.
if (!refresh.ok) return refused(refresh.error.detail);
const discovered = await discoveredInlineSettings(
client,
providerEnvironment,
command,
refresh.value,
platform,
);
if (discovered !== undefined)
return {
alignment: "unknown",
remediation: `${discovered.origin} sets ${discovered.settings.join(", ")} in REA's ${PRODUCT_IDENTITY.mcpServerKey} registration for ${client.configPath}; setup discovers ${discovered.settings.length === 1 ? "that setting" : "those settings"} from the installed providers and update does not, so REA cannot tell whether this registration is current. Run ${PRODUCT_IDENTITY.cliBinary} setup to check and refresh it.`,
};
return refresh.value.refusal === undefined
? undefined
: refused(refresh.value.refusal);
} catch (cause: unknown) {
if (cause instanceof RegularFileCleanupFailure) throw cause;
if (cause instanceof ConfigurationError)
return refused(
`${cause.message}: ${cause.settings.map(({ setting, constraint }) => `${setting}: ${constraint}`).join("; ")}`,
);
return refused(
`The configuration could not be read. Check its permissions before rerunning setup. ${cause instanceof Error ? cause.message : String(cause)}`,
);
}
};
/**
* The read-only inline layer's settings that setup discovers and the caller
* did not select, when they decide this client's refresh: setup may write a
* different discovered value than the layer holds (the layer would then
* override it), so an entry that matches now is not known to stay current, and
* an override those values alone explain is not known to remain. Another
* refusal (ownership, policy, or an override other settings cause) does not
* depend on discovery.
*/
const discoveredInlineSettings = async (
client: SetupClient,
providerEnvironment: SetupProviderEnvironment,
command: readonly string[],
refresh: ClientRefresh,
platform: NodeJS.Platform,
): Promise<
| {
readonly origin: ClientInlineConfiguration["origin"];
readonly settings: readonly string[];
}
| undefined
> => {
const [origin] = inlineRegistrationOrigins(client);
if (origin === undefined) return undefined;
if (refresh.refusal !== undefined && refresh.overrideOrigin === undefined)
return undefined;
// Setting names are matched by the platform's environment identity, so a
// Windows layer's `Java_Home` is the discovered `JAVA_HOME`.
const declared = snapshotEnvironment(
inlineRegistrationEnvironment(refresh.sources),
platform,
);
const selected = snapshotEnvironment(providerEnvironment, platform);
const adopted = Object.fromEntries(
DISCOVERED_REGISTRATION_SETTINGS.flatMap((setting) => {
const value = declared[setting];
return Object.hasOwn(selected, setting) || value === undefined
? []
: [[setting, value]];
}),
);
const settings = Object.keys(adopted);
if (settings.length === 0) return undefined;
if (refresh.overrideOrigin === undefined) return { origin, settings };
const desired = await clientConfigurationDesired(
client,
{ ...providerEnvironment, ...adopted },
command,
refresh.parsed,
refresh.sources,
platform,
);
return inlineRegistrationOverride(
client,
refresh.sources,
desired,
platform,
) === undefined
? { origin, settings }
: undefined;
};
/** Preflight one client configuration before setup presents any mutations. */
export const inspectClientConfiguration = async (
client: SetupClient,
providerEnvironment: SetupProviderEnvironment,
command: readonly string[],
resolveProviderRequestBudget?: ProviderRequestBudgetResolver,
// Setup reads the running host's client files unless its host selects one.
platform: NodeJS.Platform = HOST_PLATFORM.platform,
): Promise<ClientConfigurationInspection> => {
let inspection: ClientConfigurationInspection;
try {
inspection = await inspectClientDocument(
client,
providerEnvironment,
command,
platform,
resolveProviderRequestBudget,
);
} catch (cause: unknown) {
if (!(cause instanceof ConfigurationError)) throw cause;
return {
status: "invalid",
remediation: `${cause.message}: ${cause.settings.map(({ setting, constraint }) => `${setting}: ${constraint}`).join("; ")}`,
};
}
if (inspection.status !== "create" && inspection.status !== "update")
return inspection;
// A change the running client would overwrite is not a persisted registration.
const blocker = registrationWriteBlocker(client, "setup");
return blocker === undefined
? inspection
: { status: "invalid", remediation: blocker };
};
const inspectClientDocument = async (
client: SetupClient,
providerEnvironment: SetupProviderEnvironment,
command: readonly string[],
platform: NodeJS.Platform,
resolveProviderRequestBudget?: ProviderRequestBudgetResolver,
): Promise<ClientConfigurationInspection> => {
if (client.configPathError !== undefined)
return { status: "invalid", remediation: client.configPathError };
if (client.format === "unsupported") return { status: "already_current" };
const files = await readClientConfigurationFiles(
client,
undefined,
platform,
providerEnvironment,
);
if (!files.ok) {
throwCleanupFailure(files.error);
return {
status: "invalid",
remediation: files.error.detail,
};
}
const editabilityError = dshEditabilityBlocker(client, files.value);
if (editabilityError !== undefined)
return { status: "invalid", remediation: editabilityError };
const transactionPath = await resolveClientConfigTransactionPath(
client.configPath,
);
if (transactionPath === undefined)
return {
status: "invalid",
remediation:
"The configuration path is unsafe or unresolved. Check ownership and symbolic links before rerunning setup.",
};
let original: string;
try {
original = await readRegularFileText(transactionPath);
} catch (cause: unknown) {
if (cause instanceof RegularFileCleanupFailure) throw cause;
if (isMissing(cause)) {
const ownershipBlocker = writeTargetOwnershipBlocker(
client,
files.value,
undefined,
undefined,
platform,
);
if (ownershipBlocker !== undefined)
return { status: "invalid", remediation: ownershipBlocker };
const desired = await clientConfigurationDesired(
client,
providerEnvironment,
command,
undefined,
files.value,
platform,
resolveProviderRequestBudget,
);
const override = inlineOverrideBlocker(
client,
files.value,
desired,
platform,
);
if (override !== undefined)
return { status: "invalid", remediation: override };
// This read establishes absence; do not reuse an earlier user-file policy.
const policy = await readClientPolicyBlock(client, undefined, desired);
if (!policy.ok) {
throwCleanupFailure(policy.error);
return {
status: "invalid",
remediation: policy.error.detail,
};
}
if (policy.value !== undefined)
return { status: "invalid", remediation: policy.value };
const fallback = await readZcodeFallbackServers(client, platform);
if (!fallback.ok) {
if (fallback.error.kind !== "registration_ownership")
throwCleanupFailure(fallback.error);
return { status: "invalid", remediation: fallback.error.detail };
}
return { status: "create" };
}
return {
status: "invalid",
remediation: `The configuration file could not be read. Check its permissions before rerunning setup. ${cause instanceof Error ? cause.message : String(cause)}`,
};
}
try {
const parsed = clientConfigurationForWrite(
parseClientConfiguration(original, client.format),
files.value,
);
const ownershipBlocker = writeTargetOwnershipBlocker(
client,
files.value,
parsed,
original,
platform,
);
if (ownershipBlocker !== undefined)
return { status: "invalid", remediation: ownershipBlocker };
const desired = await clientConfigurationDesired(
client,
providerEnvironment,
command,
parsed,
files.value,
platform,
resolveProviderRequestBudget,
);
const override = inlineOverrideBlocker(
client,
files.value,
desired,
platform,
);
if (override !== undefined)
return { status: "invalid", remediation: override };
const policy = await readClientPolicyBlock(client, parsed, desired);
if (!policy.ok) {
throwCleanupFailure(policy.error);
return {
status: "invalid",
remediation: policy.error.detail,
};
}
if (policy.value !== undefined)
return { status: "invalid", remediation: policy.value };
if (
registrationCurrent(parsed, desired) &&
(await privateProfileCurrent(client, original))
)
return { status: "already_current" };
const fallback = await readZcodeFallbackServers(client, platform, parsed);
if (!fallback.ok) {
if (fallback.error.kind !== "registration_ownership")
throwCleanupFailure(fallback.error);
return { status: "invalid", remediation: fallback.error.detail };
}
} catch (cause: unknown) {
if (
cause instanceof RegularFileCleanupFailure ||
cause instanceof ConfigurationError
)
throw cause;
// Malformed configuration is reported with the invalid remediation.
void cause;
return {
status: "invalid",
remediation:
"The existing configuration is malformed. Repair it before setup applies any other changes.",
};
}
const backupSelection = await selectCurrentRecoveryBackup(
`${client.configPath}.rea.backup`,
original,
);
if (!backupSelection.ok)
return {
status: "invalid",
remediation: backupSelection.error.detail,
};
return {
status: "update",
backupPath: backupSelection.value.backupPath,
};
};
const isMissing = (cause: unknown): boolean =>
cause instanceof Error && "code" in cause && cause.code === "ENOENT";
const throwCleanupFailure = (error: ClientConfigurationFileError): void => {
if (error.cleanupFailure !== undefined) throw error.cleanupFailure;
};
/** Setup cannot write around a read-only inline layer that overrides REA. */
const inlineOverrideBlocker = (
client: SetupClient,
sources: readonly ClientConfigurationSource[],
desired: unknown,
platform: NodeJS.Platform,
): string | undefined => {
const origin = inlineRegistrationOverride(client, sources, desired, platform);
return origin === undefined
? undefined
: inlineOverrideRemediation(client, origin);
};
const inlineOverrideRemediation = (
client: SetupClient,
origin: ClientInlineConfiguration["origin"],
): string =>
`${origin} overrides REA's ${PRODUCT_IDENTITY.mcpServerKey} registration in ${client.configPath}, and REA does not edit it. Remove the ${PRODUCT_IDENTITY.mcpServerKey} server from ${origin} or make it match, then rerun setup.`;
/** A Cordis document setup cannot edit. */
const dshEditabilityBlocker = (
client: SetupClient,
sources: readonly ClientConfigurationSource[],
): string | undefined => {
const existing = sources.find(
({ sourcePath }) => sourcePath === client.configPath,
);
return existing?.dialect === "dsh"
? dshDocument(existing.document).editabilityError?.message
: undefined;
};
/**
* Setup's ownership check of the row it would replace: the target file's own
* row, or, when the file is absent, the row the lower layers supply.
*/
const writeTargetOwnershipBlocker = (
client: SetupClient,
sources: readonly ClientConfigurationSource[],
parsed: ClientConfigurationDocument | undefined,
original: string | undefined,
platform: NodeJS.Platform,
currentCommandPath?: string,
): string | undefined => {
if (parsed !== undefined)
return registrationOwnershipBlocker(
client,
parsed,
original ?? "",
sources,
platform,
currentCommandPath,
);
const inherited = effectiveClientConfiguration(
sources,
{ client, document: undefined },
platform,
);
return inherited === undefined
? undefined
: registrationOwnershipBlocker(
client,
inherited,
"",
sources,
platform,
currentCommandPath,
);
};
/** Admit only absent or proven-owned rows that this setup would replace. */
const registrationOwnershipBlocker = (
client: SetupClient,
parsed: ClientConfigurationDocument,
original: string,
sources: readonly ClientConfigurationSource[],
platform: NodeJS.Platform,
currentCommandPath?: string,
): string | undefined => {
// Cordis owns registrations by stable entry ID, including malformed launchers.
if (parsed.dialect === "dsh") return undefined;
const name = PRODUCT_IDENTITY.mcpServerKey;
const entries: { value: unknown; paths: readonly string[] }[] = [];
const effective = effectiveClientConfiguration(
sources,
{ client, document: parsed },
platform,
);
if (effective !== undefined && Object.hasOwn(effective.servers, name))
entries.push({
value: effective.servers[name],
// An inline layer is named by its origin; it has no path.
paths: [
...(client.configPaths ?? [client.configPath]),
...inlineRegistrationOrigins(client),
],
});
const fragment = parsed.servers[name];
// A layered policy fragment inherits its launcher. Classify the effective
// launcher above, but also admit any explicit command this write replaces.
const inheritsLauncher =
effective !== undefined &&
effective !== parsed &&
typeof fragment === "object" &&
fragment !== null &&
!Array.isArray(fragment) &&
!Object.hasOwn(fragment, "command");
if (Object.hasOwn(parsed.servers, name) && !inheritsLauncher)
entries.push({ value: parsed.servers[name], paths: [client.configPath] });
if (legacyClientServerPath(parsed, name) !== undefined) {
entries.push({
value: parsed.legacyServers[name],
paths: [client.configPath],
});
entries.push(
...shadowedClientServers(original, parsed, name).legacyServers.map(
(value) => ({ value, paths: [client.configPath] }),
),
);
}
for (const entry of entries) {
const ownership =
currentCommandPath === undefined
? clientRegistrationOwnership(entry.value, client)
: clientRegistrationOwnership(entry.value, client, currentCommandPath);
if (ownership !== "owned")
return clientRegistrationOwnershipRemediation(ownership, entry.paths);
}
return undefined;
};
/** Admit the fallback only when the first native ZCode server would suppress it. */
const readZcodeFallbackServers = async (
client: SetupClient,
platform: NodeJS.Platform,
parsed?: ClientConfigurationDocument,
): Promise<
Result<
Readonly<Record<string, unknown>>,
| ClientConfigurationFileError
| {
readonly kind: "registration_ownership";
readonly path: string;
readonly detail: string;
}
>
> => {
if (
client.format !== "zcode" ||
(parsed !== undefined && Object.keys(parsed.servers).length > 0)
)
return ok({});
const path = client.zcodeFallbackPath;
const detail = `The ZCode fallback configuration ${path ?? "path"} is unresolved, malformed or unreadable. Repair it before rerunning setup: the first native server would suppress that fallback.`;
if (path === undefined)
return err({ kind: "unreadable", path: client.configPath, detail });
const transactionPath = await resolveClientConfigTransactionPath(path);
if (transactionPath === undefined)
return err({ kind: "unreadable", path, detail });
const source = await readConfigurationText(transactionPath);
if (!source.ok)
return err({ ...source.error, detail: `${detail} ${source.error.detail}` });
if (source.value === undefined) return ok({});
try {
const parsed = parseZcodeFallbackConfiguration(source.value);
const ownershipBlocker = registrationOwnershipBlocker(
{ ...client, configPath: path, format: "zcode_fallback" },
parsed,
source.value,
[],
platform,
);
if (ownershipBlocker !== undefined)
return err({
kind: "registration_ownership",
path,
detail: ownershipBlocker,
});
const environment = clientRegistrationEnvironment(parsed, client, platform);
if (!environment.ok)
return err({
kind: "malformed",
path,
detail: `${detail} ${environment.error.settings.map(({ setting, constraint }) => `${setting}: ${constraint}`).join("; ")}`,
});
return ok(parsed.servers);
} catch (cause: unknown) {
return err({
kind: "malformed",
path,
detail: `${detail} ${cause instanceof Error ? cause.message : String(cause)}`,
});
}
};
type ConfigurationRestoreFailure =
| { readonly kind: "conflict" }
| {
readonly kind: "restore";
readonly path: string;
readonly detail: string;
};
const restoreConfig = async (
publication: ClientConfigurationPublication,
original: string | undefined,
): Promise<Result<void, ConfigurationRestoreFailure>> => {
try {
await publication.restore(original);
return ok(undefined);
} catch (cause: unknown) {
if (isConfigurationConflict(cause) || isMissing(cause))
return err({ kind: "conflict" });
return err({
kind: "restore",
path: publication.path,
detail: errorDetail(cause),
});
}
};
const rollbackOrReadbackFailure = async (
publication: ClientConfigurationPublication,
original: string | undefined,
backupPath: string | undefined,
): Promise<ClientConfigurationResult> => {
const rollback = await restoreConfig(publication, original);
return rollback.ok
? {
status: "failed",
reason: "readback",
...(backupPath === undefined ? {} : { backupPath }),
}
: rollbackFailure(rollback.error, backupPath);
};
const rollbackFailure = (
failure: ConfigurationRestoreFailure,
backupPath?: string,
): Extract<ClientConfigurationResult, { readonly status: "failed" }> =>
failure.kind === "conflict"
? conflictFailure(backupPath)
: {
status: "failed",
reason: "rollback",
failure,
...(backupPath === undefined ? {} : { backupPath }),
};
const isConfigurationConflict = (cause: unknown): boolean =>
cause instanceof RegularFileChangedError ||
cause instanceof InvalidUtf8FileError;
const conflictFailure = (
backupPath?: string,
): Extract<ClientConfigurationResult, { readonly status: "failed" }> => ({
status: "failed",
reason: "conflict",
...(backupPath === undefined ? {} : { backupPath }),
});
const errorDetail = (cause: unknown): string =>
cause instanceof Error ? cause.message : String(cause);
/** Whether REA's entry matches, no legacy entry remains, and no client disable list suppresses it. */
const registrationCurrent = (
parsed: ClientConfigurationDocument,
desired: unknown,
): boolean =>
parsed.requiresRewrite !== true &&
(parsed.dialect !== "dsh" || dshDocument(parsed.document).ready) &&
clientConfigurationValuesEqual(
parsed.servers[PRODUCT_IDENTITY.mcpServerKey],
desired,
) &&
!Object.hasOwn(parsed.legacyServers, PRODUCT_IDENTITY.mcpServerKey) &&
!clientServerListedDisabled(parsed, PRODUCT_IDENTITY.mcpServerKey);
/**
* A private profile with the wrong modes needs publication even when its row
* is current. Modes belong to the host holding the file, not to the platform
* the registration is written for.
*/
const privateProfileCurrent = async (
client: SetupClient,
original: string | undefined,
): Promise<boolean> =>
client.privateProfile === undefined ||
(original !== undefined &&
(await privateProfileModesCurrent(
client.configPath,
HOST_PLATFORM.platform,
)));
const clientConfigurationDesired = async (
client: SetupClient,
providerEnvironment: SetupProviderEnvironment,
command: readonly string[],
parsed: ClientConfigurationDocument | undefined,
sources: readonly ClientConfigurationSource[],
platform: NodeJS.Platform,
resolveProviderRequestBudget?: ProviderRequestBudgetResolver,
): Promise<unknown> => {
const effective = effectiveClientConfiguration(
sources,
{ client, document: parsed },
platform,
);
const format = clientWriteDialect(
parsed?.dialect ?? client.format ?? "json",
sources,
);
const launcher =
command.length === 0 ? [PRODUCT_IDENTITY.cliBinary, "mcp"] : command;
if (format === "dsh") {
const validated = clientRegistrationEnvironment(
effective,
client,
platform,
providerEnvironment,
);
if (!validated.ok) throw validated.error;
const desired = (
parsed === undefined
? new DshCordisDocument("")
: dshDocument(parsed.document)
).desired(launcher, providerEnvironment, platform);
if (!desired.ok) throw desired.error;
return desired.value;
}
const validated = await clientRegistrationEnvironmentDetailsWithBudget(
effective,
client,
providerEnvironment,
"effective",
client.name === "codex" || client.name === "kimi"
? resolveProviderRequestBudget
: undefined,
platform,
);
if (!validated.ok) throw validated.error;
// Preserve explicitly configured server settings, never the ambient process
// environment. The effective layered view validates precedence and supplies
// timeout facts; the target file's fragment remains the value being written.
const environment = clientRegistrationEnvironment(
parsed,
client,
platform,
providerEnvironment,
"fragment",
);
if (!environment.ok) throw environment.error;
const registration = refreshClientRegistration(
client,
format,
launcher,
environment.value,
parsed === undefined
? undefined
: effectiveClientServer(parsed, PRODUCT_IDENTITY.mcpServerKey),
validated.value.timeoutInputs,
);
if (!registration.ok) throw registration.error;
return withInheritedGooseSettings(
registration.value,
format,
client,
parsed,
sources,
effective,
providerEnvironment,
platform,
);
};
/**
* Goose replaces `envs` as a whole map per layer, so a user map must carry the
* inherited one. When the user entry declares no environment and a lower layer
* does, setup writes no map unless a setting is requested, and then writes the
* inherited map with the requested settings applied last. Other settings only a
* lower layer declares are left to that layer.
*/
const GOOSE_INHERITABLE_SETTINGS: readonly string[] = [
"name",
"description",
"enabled",
"timeout",
];
const withInheritedGooseSettings = (
withoutInherited: Record<string, unknown>,
format: ClientRegistrationDialect,
client: SetupClient,
parsed: ClientConfigurationDocument | undefined,
sources: readonly ClientConfigurationSource[],
effective: ClientConfigurationDocument | undefined,
providerEnvironment: SetupProviderEnvironment,
platform: NodeJS.Platform,
): Record<string, unknown> => {
if (format !== "goose") return withoutInherited;
// The layers below the user file, which the user entry overlays field by field.
const lower = effectiveClientConfiguration(
sources,
{ client, document: undefined },
platform,
);
const declares = (
document: ClientConfigurationDocument | undefined,
keys: readonly string[],
) => {
const entry =
document === undefined
? undefined
: effectiveClientServer(document, PRODUCT_IDENTITY.mcpServerKey);
return (
typeof entry === "object" &&
entry !== null &&
keys.some((key) => Object.hasOwn(entry, key))
);
};
// Goose merges each field separately, so a user map must use the spelling a
// lower layer declares: `envs` beside an inherited `env` alias would leave
// both in force, which Goose's readers reject as ambiguous.
const spelled = (
registration: Record<string, unknown>,
): Record<string, unknown> => {
if (!declares(lower, ["env"]) || !Object.hasOwn(registration, "envs"))
return registration;
const { envs, ...rest } = registration;
return { ...rest, env: envs };
};
const userDeclares = (keys: readonly string[]) => declares(parsed, keys);
// A setting only a lower layer declares stays in effect: writing setup's
// default into the user entry would override that caller's choice.
const registration = Object.fromEntries(
Object.entries(withoutInherited).filter(
([key]) =>
!GOOSE_INHERITABLE_SETTINGS.includes(key) ||
userDeclares([key]) ||
!declares(lower, [key]),
),
);
const environmentKeys = ["envs", "env"];
if (userDeclares(environmentKeys) || !declares(lower, environmentKeys))
return spelled(registration);
const { envs: _generated, ...rest } = registration;
if (Object.keys(providerEnvironment).length === 0) return rest;
const inherited = clientRegistrationEnvironment(
effective,
client,
platform,
providerEnvironment,
"fragment",
);
if (!inherited.ok) throw inherited.error;
return spelled({ ...rest, envs: { ...inherited.value } });
};