Files
rea/tests/boundary/filesystem/clientConfigurationDialects.test.ts
T
morlutoandGitHub 6256b68666 feat(setup)!: expand agent integrations and verify updates (#577)
* feat(setup)!: expand agent integrations and simplify onboarding

Add native configuration formats for OpenCode, Antigravity, GitHub Copilot
CLI, VS Code, and Devin. Preserve JSONC comments and unrelated settings
while making setup and uninstall ownership-aware and idempotent.

Select agent targets before planning, separate discovery from intent, and
keep agent-only setup independent of optional provider prerequisites.
Cover configuration boundaries and interactive behavior in packaged checks.

BREAKING CHANGE: unscoped setup refreshes only existing REA-owned
registrations. Use --all-detected to configure every detected client.
Setup JSON contains a compact doctor summary; use rea doctor for full
diagnostics. Cancellation and successful dry runs now exit successfully.

* feat(cli)!: replace upgrade with verified updates

Resolve an exact release through npm's configured registry, update only the
identified installation, and verify its new executable before reporting success.
Return a read-only maintenance plan for existing enabled REA integrations.

BREAKING CHANGE: replace rea upgrade with rea update; no alias is retained.
Successful update JSON uses status "updated", reports the verified installed
version, and returns an unapplied maintenance plan instead of opening setup.
2026-10-05 23:06:19 +08:00

274 lines
9.4 KiB
TypeScript

import { mkdir, readFile, writeFile } from "node:fs/promises";
import { join } from "node:path";
import { describe, expect, it } from "vitest";
import { parse as parseJsonc, type ParseError } from "jsonc-parser";
import { readClientRegistrationStatuses } from "../../../src/application/ClientRegistrationStatus.js";
import { configureClientConfiguration } from "../../../src/application/SetupClientConfiguration.js";
import { systemUninstallHost } from "../../../src/application/Uninstall.js";
import { supportedClients } from "../../../src/application/SupportedClients.js";
import { PRODUCT_IDENTITY } from "../../../src/identity.js";
import { isOwnedClientRegistrationCommand } from "../../../src/application/ClientRegistrationIdentity.js";
import { createTestTempDirectory } from "../../fixtures/temporaryDirectory.js";
const command = [
"npx",
"-y",
PRODUCT_IDENTITY.registrationPackageSpecifier,
"mcp",
] as const;
const getClients = (home: string) =>
supportedClients(home).filter(({ name }) =>
["opencode", "antigravity", "copilot_cli", "vscode", "devin"].includes(
name,
),
);
describe("additional client configuration dialects", () => {
it.each([
"opencode",
"antigravity",
"copilot_cli",
"vscode",
"devin",
] as const)("registers, reads back, and uninstalls %s", async (name) => {
const home = await createTestTempDirectory("rea-client-dialect-");
const client = getClients(home).find(
(candidate) => candidate.name === name,
);
expect(client).toBeDefined();
if (client === undefined) throw new Error(`missing ${name} client`);
await mkdir(client.markerPath ?? home, { recursive: true });
const configured = await configureClientConfiguration(client, {}, command);
expect(configured.status).toBe("configured");
expect(await configureClientConfiguration(client, {}, command)).toEqual({
status: "unchanged",
});
const text = await readFile(client.configPath, "utf8");
const document = parseJsonc(text) as Record<string, unknown>;
const serversKey =
name === "opencode"
? "mcp"
: name === "vscode"
? "servers"
: "mcpServers";
const servers = document[serversKey] as Record<
string,
Record<string, unknown>
>;
const registration = servers[PRODUCT_IDENTITY.mcpServerKey];
expect(registration).toBeDefined();
if (name === "opencode")
expect(registration).toMatchObject({
type: "local",
command,
enabled: true,
});
if (name === "vscode")
expect(registration).toMatchObject({
type: "stdio",
command: "npx",
args: command.slice(1),
});
if (name === "copilot_cli")
expect(registration).toMatchObject({ type: "stdio", tools: ["*"] });
const statuses = await readClientRegistrationStatuses(home);
expect(statuses).toEqual(
expect.arrayContaining([
expect.objectContaining({ client: name, state: "aligned", command }),
]),
);
const removed = await systemUninstallHost(home).removeClient(client);
expect(removed.status).toBe("removed");
const afterRemoval = parseJsonc(
await readFile(client.configPath, "utf8"),
) as Record<string, unknown>;
expect(
(afterRemoval[serversKey] as Record<string, unknown>)[
PRODUCT_IDENTITY.mcpServerKey
],
).toBeUndefined();
});
it("preserves OpenCode JSONC comments and sibling registrations during update and removal", async () => {
const home = await createTestTempDirectory("rea-opencode-jsonc-");
const client = getClients(home).find(({ name }) => name === "opencode");
expect(client).toBeDefined();
if (client === undefined) throw new Error("missing OpenCode client");
await mkdir(client.markerPath ?? home, { recursive: true });
const original = `{
// Client-wide preferences stay intact.
"model": "provider/model",
"mcp": {
// An independently managed server.
"other": { "type": "local", "command": ["node", "other.js"] },
},
}\n`;
await writeFile(client.configPath, original);
expect(
await configureClientConfiguration(client, {}, command),
).toMatchObject({
status: "configured",
backupPath: `${client.configPath}.rea.backup`,
});
const updated = await readFile(client.configPath, "utf8");
const errors: ParseError[] = [];
const parsed = parseJsonc(updated, errors, {
allowTrailingComma: true,
}) as Record<string, unknown>;
expect(errors).toEqual([]);
expect(updated).toContain("// Client-wide preferences stay intact.");
expect(updated).toContain("// An independently managed server.");
expect(parsed.model).toBe("provider/model");
expect((parsed.mcp as Record<string, unknown>).other).toBeDefined();
expect(await readFile(`${client.configPath}.rea.backup`, "utf8")).toBe(
original,
);
expect((await systemUninstallHost(home).removeClient(client)).status).toBe(
"removed",
);
const removedText = await readFile(client.configPath, "utf8");
const removedErrors: ParseError[] = [];
const removed = parseJsonc(removedText, removedErrors, {
allowTrailingComma: true,
}) as Record<string, unknown>;
expect(removedErrors).toEqual([]);
expect(removedText).toContain("// Client-wide preferences stay intact.");
expect(removedText).toContain("// An independently managed server.");
expect((removed.mcp as Record<string, unknown>).rea).toBeUndefined();
expect((removed.mcp as Record<string, unknown>).other).toBeDefined();
});
it("rejects malformed OpenCode JSONC without creating a backup or changing bytes", async () => {
const home = await createTestTempDirectory("rea-opencode-invalid-");
const client = getClients(home).find(({ name }) => name === "opencode");
expect(client).toBeDefined();
if (client === undefined) throw new Error("missing OpenCode client");
await mkdir(client.markerPath ?? home, { recursive: true });
const invalid = '{ "mcp": { /* broken */ "rea": [ }';
await writeFile(client.configPath, invalid);
expect(await configureClientConfiguration(client, {}, command)).toEqual({
status: "failed",
reason: "readback",
});
expect(await readFile(client.configPath, "utf8")).toBe(invalid);
});
});
describe("platform-aware client config paths", () => {
it.each([
[
"darwin",
"/home/a",
{},
"/home/a/Library/Application Support/Code/User/mcp.json",
],
["linux", "/home/a", {}, "/home/a/.config/Code/User/mcp.json"],
[
"win32",
"C:/Users/a",
{},
"C:/Users/a/AppData/Roaming/Code/User/mcp.json",
],
[
"linux",
"/home/a",
{ XDG_CONFIG_HOME: "/config" },
"/config/Code/User/mcp.json",
],
] as const)(
"resolves VS Code user MCP path for %s",
(platform, home, env, expected) => {
expect(
supportedClients(home, platform, env).find(
({ name }) => name === "vscode",
)?.configPath,
).toBe(expected);
},
);
it("honors Copilot CLI and Devin platform configuration roots", () => {
expect(
supportedClients("/home/a", "linux", {
COPILOT_HOME: "/custom/copilot",
XDG_CONFIG_HOME: "/custom/config",
}).find(({ name }) => name === "copilot_cli")?.configPath,
).toBe("/custom/copilot/mcp-config.json");
expect(
supportedClients("C:/Users/a", "win32", {
APPDATA: "D:/Profile/Roaming",
}).find(({ name }) => name === "devin")?.configPath,
).toBe("D:/Profile/Roaming/devin/mcp_config.json");
});
it("prefers an existing OpenCode JSONC file and honors explicit harness roots", async () => {
const home = await createTestTempDirectory("rea-config-overrides-");
const opencodeDirectory = join(home, ".config/opencode");
await mkdir(opencodeDirectory, { recursive: true });
await writeFile(join(opencodeDirectory, "opencode.jsonc"), "{}\n");
const clients = supportedClients(home, "linux", {});
expect(clients.find(({ name }) => name === "opencode")?.configPath).toBe(
join(opencodeDirectory, "opencode.jsonc"),
);
expect(
supportedClients(home, "linux", {
OPENCODE_CONFIG: "/custom/open-code.jsonc",
CLAUDE_CONFIG_DIR: "/custom/claude",
CODEX_HOME: "/custom/codex",
}).filter(({ name }) =>
["opencode", "claude_code", "codex"].includes(name),
),
).toEqual(
expect.arrayContaining([
expect.objectContaining({
name: "opencode",
configPath: "/custom/open-code.jsonc",
}),
expect.objectContaining({
name: "claude_code",
configPath: "/custom/claude/.claude.json",
}),
expect.objectContaining({
name: "codex",
configPath: "/custom/codex/config.toml",
}),
]),
);
});
it("recognizes prior exact REA releases while rejecting foreign package commands", () => {
expect(
isOwnedClientRegistrationCommand([
"npx",
"-y",
`${PRODUCT_IDENTITY.packageName}@3.2.0`,
"mcp",
]),
).toBe(true);
expect(
isOwnedClientRegistrationCommand(["npx", "-y", "another-package", "mcp"]),
).toBe(false);
expect(
isOwnedClientRegistrationCommand(
[process.execPath, "/packaged/rea.mjs", "mcp"],
"/packaged/rea.mjs",
),
).toBe(true);
expect(
isOwnedClientRegistrationCommand(
["node", "/packaged/other-agent.mjs", "mcp"],
"/packaged/rea.mjs",
),
).toBe(false);
});
});