File size: 17,895 Bytes
f0634fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 | import { mkdtemp, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import { afterEach, describe, expect, it } from 'vitest';
import { AcpSession } from '../src/session';
import { createTestClient, type TestClient } from './_helpers/acpClient';
import { FAKE_MODEL_ALT_ID, writeFakeModelConfig } from './_helpers/fakeModelConfig';
interface ConfigOption {
readonly id: string;
readonly currentValue: string;
readonly options?: ReadonlyArray<{ readonly value: string; readonly name?: string }>;
}
interface ModesState {
readonly currentModeId: string;
readonly availableModes: ReadonlyArray<{ readonly id: string }>;
}
interface NewSessionResult {
readonly sessionId: string;
readonly configOptions: readonly ConfigOption[];
readonly modes?: ModesState;
}
describe('acp-server config surface', () => {
let homeDir: string | undefined;
let client: TestClient | undefined;
afterEach(async () => {
if (client !== undefined) {
await client.close();
client = undefined;
}
if (homeDir !== undefined) {
await rm(homeDir, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 });
homeDir = undefined;
}
});
async function boot(opts?: {
fakeModel?: boolean;
thinking?: boolean;
supportEfforts?: readonly string[];
defaultEffort?: string;
altThinking?: boolean;
altSupportEfforts?: readonly string[];
altDefaultEffort?: string;
}): Promise<TestClient> {
homeDir = await mkdtemp(join(tmpdir(), 'acp-config-'));
if (opts?.fakeModel === true) {
await writeFakeModelConfig(homeDir, {
thinking: opts?.thinking === true,
supportEfforts: opts?.supportEfforts,
defaultEffort: opts?.defaultEffort,
altThinking: opts?.altThinking === true,
altSupportEfforts: opts?.altSupportEfforts,
altDefaultEffort: opts?.altDefaultEffort,
});
}
client = await createTestClient({ homeDir });
await client.send('initialize', { protocolVersion: 1, clientCapabilities: {} });
return client;
}
async function newSession(): Promise<NewSessionResult> {
return (await client!.send('session/new', {
cwd: homeDir,
mcpServers: [],
})) as NewSessionResult;
}
it(
'session/new advertises mode + model pickers (no thinking without a model)',
async () => {
await boot();
const { configOptions } = await newSession();
const ids = configOptions.map((o) => o.id);
expect(ids).toContain('mode');
expect(ids).toContain('model');
expect(ids).not.toContain('thinking');
const mode = configOptions.find((o) => o.id === 'mode')!;
expect(mode.currentValue).toBe('default');
},
30_000,
);
it(
'session/new advertises the first-class modes state',
async () => {
await boot();
const { modes } = await newSession();
expect(modes?.currentModeId).toBe('default');
expect(modes?.availableModes.map((m) => m.id)).toEqual([
'default',
'plan',
'auto',
'yolo',
]);
},
30_000,
);
it(
'session/set_mode pushes current_mode_update alongside config_option_update',
async () => {
await boot();
const { sessionId } = await newSession();
const modeUpdatePromise = client!.waitForSessionUpdate('current_mode_update');
const configUpdatePromise = client!.waitForSessionUpdate('config_option_update');
await client!.send('session/set_mode', { sessionId, modeId: 'yolo' });
const modeNotification = await modeUpdatePromise;
const modeUpdate = (modeNotification.params as { update?: { currentModeId?: string } })
.update;
expect(modeUpdate?.currentModeId).toBe('yolo');
// The configOptions arm still refreshes for config-option clients.
const configNotification = await configUpdatePromise;
const configUpdate = (
configNotification.params as { update?: { configOptions?: readonly ConfigOption[] } }
).update;
expect(configUpdate?.configOptions?.find((o) => o.id === 'mode')?.currentValue).toBe('yolo');
},
30_000,
);
it(
'session/set_mode propagates plan errors without reporting a new mode',
async () => {
const session = Object.create(AcpSession.prototype) as AcpSession;
const updates: unknown[] = [];
const agent = {
enterPlan: async () => {
throw new Error('plan toggle failed');
},
setPermission: async () => {},
};
Object.assign(session as unknown as Record<string, unknown>, {
agent,
conn: { sessionUpdate: async (update: unknown) => updates.push(update) },
sessionId: 'session-test',
currentModeId: 'default',
});
await expect(session.setMode('plan')).rejects.toThrow('plan toggle failed');
expect((session as unknown as { currentModeId: string }).currentModeId).toBe('default');
expect(updates).toEqual([]);
},
30_000,
);
it(
'session/set_config_option mode also pushes current_mode_update',
async () => {
await boot();
const { sessionId } = await newSession();
const modeUpdatePromise = client!.waitForSessionUpdate('current_mode_update');
await client!.send('session/set_config_option', {
sessionId,
configId: 'mode',
value: 'plan',
});
const modeNotification = await modeUpdatePromise;
const modeUpdate = (modeNotification.params as { update?: { currentModeId?: string } })
.update;
expect(modeUpdate?.currentModeId).toBe('plan');
},
30_000,
);
it(
'session/set_config_option mode updates the returned snapshot',
async () => {
await boot();
const { sessionId } = await newSession();
const result = (await client!.send('session/set_config_option', {
sessionId,
configId: 'mode',
value: 'yolo',
})) as { configOptions: readonly ConfigOption[] };
const mode = result.configOptions.find((o) => o.id === 'mode')!;
expect(mode.currentValue).toBe('yolo');
},
30_000,
);
it(
'session/set_config_option rejects an unknown modeId',
async () => {
await boot();
const { sessionId } = await newSession();
await expect(
client!.send('session/set_config_option', {
sessionId,
configId: 'mode',
value: 'bogus',
}),
).rejects.toThrow();
},
30_000,
);
it(
'session/set_config_option rejects an unknown configId',
async () => {
await boot();
const { sessionId } = await newSession();
await expect(
client!.send('session/set_config_option', {
sessionId,
configId: 'nope',
value: 'x',
}),
).rejects.toThrow();
},
30_000,
);
it(
'session/set_model switches the model and pushes config_option_update',
async () => {
await boot({ fakeModel: true });
const { sessionId } = await newSession();
// `session/set_model` was dropped from the SDK's legacy Agent interface
// in 1.x; the server keeps it as an extMethod special-case.
const updatePromise = client!.waitForSessionUpdate('config_option_update');
const result = await client!.send('session/set_model', {
sessionId,
modelId: FAKE_MODEL_ALT_ID,
});
expect(result).toEqual({});
// The switch reached the engine, not just the ACP surface.
await expect(
client!.server.klient.session(sessionId).agent('main').getModel(),
).resolves.toBe(FAKE_MODEL_ALT_ID);
const notification = await updatePromise;
const update = (
notification.params as { update?: { configOptions?: readonly ConfigOption[] } }
).update;
const model = update?.configOptions?.find((o) => o.id === 'model');
expect(model?.currentValue).toBe(FAKE_MODEL_ALT_ID);
},
30_000,
);
it(
'session/set_model rejects malformed params',
async () => {
await boot({ fakeModel: true });
const { sessionId } = await newSession();
await expect(
client!.send('session/set_model', { sessionId, modelId: 42 }),
).rejects.toThrow();
await expect(
client!.send('session/set_model', { sessionId: 'nope', modelId: FAKE_MODEL_ALT_ID }),
).rejects.toThrow();
},
30_000,
);
it(
'the merged "<id>,thinking" form sets the bare model and flips thinking on at its default effort',
async () => {
await boot({
fakeModel: true,
altThinking: true,
altSupportEfforts: ['low', 'high'],
altDefaultEffort: 'high',
});
const { sessionId } = await newSession();
const agent = client!.server.klient.session(sessionId).agent('main');
const result = await client!.send('session/set_model', {
sessionId,
modelId: `${FAKE_MODEL_ALT_ID},thinking`,
});
expect(result).toEqual({});
// The bare id reached the engine; thinking flipped on at the NEW
// model's declared default effort.
await expect(agent.getModel()).resolves.toBe(FAKE_MODEL_ALT_ID);
await expect(agent.getThinking()).resolves.toBe('high');
// The picker snapshot never carries the `,thinking` suffix.
const listed = (await client!.send('session/set_config_option', {
sessionId,
configId: 'model',
value: `${FAKE_MODEL_ALT_ID},thinking`,
})) as { configOptions: readonly ConfigOption[] };
expect(listed.configOptions.find((o) => o.id === 'model')?.currentValue).toBe(
FAKE_MODEL_ALT_ID,
);
await expect(agent.getModel()).resolves.toBe(FAKE_MODEL_ALT_ID);
await expect(agent.getThinking()).resolves.toBe('high');
},
30_000,
);
it(
'a bare set_model id does not turn thinking off',
async () => {
await boot({ fakeModel: true, thinking: true, altThinking: true });
const { sessionId } = await newSession();
const agent = client!.server.klient.session(sessionId).agent('main');
// The default model is thinking-capable → thinking starts on.
await expect(agent.getThinking()).resolves.not.toBe('off');
await client!.send('session/set_model', { sessionId, modelId: FAKE_MODEL_ALT_ID });
await expect(agent.getModel()).resolves.toBe(FAKE_MODEL_ALT_ID);
// Model and thinking stay orthogonal: the requested level survives the
// switch (the engine re-resolves it against the new thinking-capable
// model — it must not land on 'off').
await expect(agent.getThinking()).resolves.not.toBe('off');
},
30_000,
);
it(
'session/new advertises the thinking toggle for a thinking-capable model',
async () => {
await boot({ fakeModel: true, thinking: true });
const { configOptions } = await newSession();
const thinking = configOptions.find((o) => o.id === 'thinking');
// A thinking-capable model defaults to thinking on (the engine resolves
// the model's default effort when nothing is configured).
expect(thinking?.currentValue).toBe('on');
},
30_000,
);
it(
'session/new omits the thinking toggle for a non-thinking model',
async () => {
await boot({ fakeModel: true });
const { configOptions } = await newSession();
expect(configOptions.map((o) => o.id)).not.toContain('thinking');
},
30_000,
);
it(
'session/set_config_option thinking takes effect and pushes config_option_update',
async () => {
await boot({ fakeModel: true, thinking: true });
const { sessionId } = await newSession();
const updatePromise = client!.waitForSessionUpdate('config_option_update');
const result = (await client!.send('session/set_config_option', {
sessionId,
configId: 'thinking',
value: 'off',
})) as { configOptions: readonly ConfigOption[] };
expect(result.configOptions.find((o) => o.id === 'thinking')?.currentValue).toBe('off');
// The toggle reached the engine, not just the ACP surface.
await expect(
client!.server.klient.session(sessionId).agent('main').getThinking(),
).resolves.toBe('off');
const notification = await updatePromise;
const update = (
notification.params as { update?: { configOptions?: readonly ConfigOption[] } }
).update;
expect(update?.configOptions?.find((o) => o.id === 'thinking')?.currentValue).toBe('off');
},
30_000,
);
it(
'session/set_config_option rejects an unknown thinking value',
async () => {
await boot({ fakeModel: true, thinking: true });
const { sessionId } = await newSession();
await expect(
client!.send('session/set_config_option', {
sessionId,
configId: 'thinking',
value: 'bogus',
}),
).rejects.toThrow();
},
30_000,
);
it(
'an effort-capable model advertises off + every declared effort',
async () => {
await boot({
fakeModel: true,
thinking: true,
supportEfforts: ['low', 'high'],
defaultEffort: 'high',
});
const { configOptions } = await newSession();
const thinking = configOptions.find((o) => o.id === 'thinking');
expect(thinking?.options?.map((o) => o.value)).toEqual(['off', 'low', 'high']);
// Nothing configured → the engine resolves the model's default effort.
expect(thinking?.currentValue).toBe('high');
},
30_000,
);
it(
'setting a declared effort level takes effect and pushes config_option_update',
async () => {
await boot({
fakeModel: true,
thinking: true,
supportEfforts: ['low', 'high'],
defaultEffort: 'high',
});
const { sessionId } = await newSession();
const updatePromise = client!.waitForSessionUpdate('config_option_update');
const result = (await client!.send('session/set_config_option', {
sessionId,
configId: 'thinking',
value: 'low',
})) as { configOptions: readonly ConfigOption[] };
expect(result.configOptions.find((o) => o.id === 'thinking')?.currentValue).toBe('low');
// The level reached the engine, not just the ACP surface.
await expect(
client!.server.klient.session(sessionId).agent('main').getThinking(),
).resolves.toBe('low');
const notification = await updatePromise;
const update = (
notification.params as { update?: { configOptions?: readonly ConfigOption[] } }
).update;
expect(update?.configOptions?.find((o) => o.id === 'thinking')?.currentValue).toBe('low');
},
30_000,
);
it(
"an effort-capable model maps the legacy 'on' to its default effort",
async () => {
await boot({
fakeModel: true,
thinking: true,
supportEfforts: ['low', 'high'],
defaultEffort: 'high',
});
const { sessionId } = await newSession();
const result = (await client!.send('session/set_config_option', {
sessionId,
configId: 'thinking',
value: 'on',
})) as { configOptions: readonly ConfigOption[] };
expect(result.configOptions.find((o) => o.id === 'thinking')?.currentValue).toBe('high');
await expect(
client!.server.klient.session(sessionId).agent('main').getThinking(),
).resolves.toBe('high');
},
30_000,
);
it(
'an effort-capable model rejects an undeclared effort with invalid_params',
async () => {
await boot({
fakeModel: true,
thinking: true,
supportEfforts: ['low', 'high'],
defaultEffort: 'high',
});
const { sessionId } = await newSession();
await expect(
client!.send('session/set_config_option', {
sessionId,
configId: 'thinking',
value: 'banana',
}),
).rejects.toThrow(/-32602/);
},
30_000,
);
it(
'a Claude model on an Anthropic-typed provider advertises the thinking toggle via engine-derived capabilities',
async () => {
homeDir = await mkdtemp(join(tmpdir(), 'acp-config-'));
// No declared capabilities: the engine's catalog (`effectiveModelConfig`
// with the provider type) infers the Anthropic thinking profile for the
// Claude wire name, so the wire `capabilities`/`support_efforts` the ACP
// host reads already carry the derivation.
await writeFile(
join(homeDir, 'config.toml'),
`defaultModel = "claude"
[providers.anthro]
type = "anthropic"
baseUrl = "http://localhost"
apiKey = "test-token"
[models.claude]
provider = "anthro"
name = "claude-sonnet-4-5"
maxContextSize = 200000
`,
'utf8',
);
client = await createTestClient({ homeDir });
await client.send('initialize', { protocolVersion: 1, clientCapabilities: {} });
const { configOptions } = await newSession();
const thinking = configOptions.find((o) => o.id === 'thinking');
expect(thinking).toBeDefined();
// The inferred profile is effort-granular, not a bare off/on toggle.
expect(thinking?.options?.length).toBeGreaterThan(2);
expect(thinking?.options?.some((o) => o.value === 'off')).toBe(true);
},
30_000,
);
it(
'a $/cancel_request notification is accepted without error',
async () => {
await boot();
await newSession();
// The SDK handles the JSON-RPC-level cancel notification internally; a
// stray one (unknown id) must be a no-op, not a connection error.
client!.notify('$/cancel_request', { id: 999_999 });
const list = (await client!.send('session/list', {})) as { sessions: unknown[] };
expect(list.sessions.length).toBeGreaterThan(0);
},
30_000,
);
});
|