-
-
Notifications
You must be signed in to change notification settings - Fork 493
Expand file tree
/
Copy pathopencodeRemoteLauncher.test.ts
More file actions
616 lines (540 loc) · 23.6 KB
/
Copy pathopencodeRemoteLauncher.test.ts
File metadata and controls
616 lines (540 loc) · 23.6 KB
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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
import { afterEach, describe, expect, it, vi } from 'vitest';
import { MessageQueue2 } from '@/utils/MessageQueue2';
import type { OpencodeMode, PermissionMode } from './types';
const harness = vi.hoisted(() => ({
setModelArgs: [] as Array<{ sessionId: string; modelId: string; flavor?: string }>,
setConfigOptionArgs: [] as Array<{ sessionId: string; configId: string; value: string }>,
promptCount: 0,
promptContents: [] as unknown[],
events: [] as string[],
setModelImpl: null as null | ((sessionId: string, modelId: string) => Promise<void>),
setConfigOptionImpl: null as null | ((sessionId: string, configId: string, value: string) => Promise<void>),
thoughtLevelOption: null as null | { id: string; currentValue?: string; options: Array<{ value: string; name?: string }> },
stderrHandler: null as null | ((error: { type: string; message: string; raw: string }) => void),
hangPrompt: false,
resolvePrompt: null as null | (() => void),
cancelPrompt: vi.fn(async () => {})
}));
vi.mock('./utils/opencodeBackend', () => ({
createOpencodeBackend: vi.fn(() => ({
initialize: vi.fn(async () => {}),
newSession: vi.fn(async () => 'acp-session-1'),
loadSession: vi.fn(async () => 'acp-session-1'),
setModel: vi.fn(async (sessionId: string, modelId: string, opts?: { flavor?: string }) => {
harness.events.push(`setModel:${modelId}`);
harness.setModelArgs.push({ sessionId, modelId, flavor: opts?.flavor });
if (harness.setModelImpl) {
await harness.setModelImpl(sessionId, modelId);
}
}),
setConfigOption: vi.fn(async (sessionId: string, configId: string, value: string) => {
harness.events.push(`setConfigOption:${value}`);
harness.setConfigOptionArgs.push({ sessionId, configId, value });
if (harness.setConfigOptionImpl) {
await harness.setConfigOptionImpl(sessionId, configId, value);
}
if (harness.thoughtLevelOption) {
harness.thoughtLevelOption = { ...harness.thoughtLevelOption, currentValue: value };
}
}),
prompt: vi.fn(async (_sessionId: string, content: unknown[]) => {
harness.promptContents.push(content);
harness.events.push('prompt:start');
harness.promptCount++;
if (harness.hangPrompt) {
await new Promise<void>((resolve) => {
harness.resolvePrompt = resolve;
});
} else {
await new Promise<void>((resolve) => setImmediate(resolve));
}
harness.events.push('prompt:end');
}),
cancelPrompt: harness.cancelPrompt,
respondToPermission: vi.fn(async () => {}),
onStderrError: vi.fn((handler: (error: { type: string; message: string; raw: string }) => void) => {
harness.stderrHandler = handler;
}),
onPermissionRequest: vi.fn(),
disconnect: vi.fn(async () => {}),
getSessionModelsMetadata: vi.fn(() => undefined),
getThoughtLevelConfigOption: vi.fn(() => harness.thoughtLevelOption ?? undefined)
}))
}));
vi.mock('@/codex/utils/buildHapiMcpBridge', () => ({
buildHapiMcpBridge: async () => ({
server: { stop: () => {} },
mcpServers: {}
})
}));
vi.mock('./utils/permissionHandler', () => ({
OpencodePermissionHandler: class {
async cancelAll(): Promise<void> {}
}
}));
vi.mock('@/ui/ink/OpencodeDisplay', () => ({
OpencodeDisplay: () => null
}));
vi.mock('@/ui/logger', () => ({
logger: {
debug: vi.fn(),
warn: vi.fn(),
info: vi.fn()
}
}));
import { opencodeRemoteLauncher } from './opencodeRemoteLauncher';
function createMode(model?: string): OpencodeMode {
return {
permissionMode: 'default' as PermissionMode,
model
};
}
function createPlanMode(model?: string): OpencodeMode {
return {
permissionMode: 'plan' as PermissionMode,
model
};
}
function createModeWithEffort(model: string | undefined, modelReasoningEffort: string | null): OpencodeMode {
return {
permissionMode: 'default' as PermissionMode,
model,
modelReasoningEffort
};
}
function createResetMode(): OpencodeMode {
return {
permissionMode: 'default' as PermissionMode,
model: null
};
}
function createSessionStub(items: Array<{ message: string; mode: OpencodeMode }>) {
const queue = new MessageQueue2<OpencodeMode>((mode) => JSON.stringify(mode));
items.forEach(({ message, mode }, index) => {
if (index === 0 && items.length > 1) {
queue.pushIsolateAndClear(message, mode);
} else {
queue.push(message, mode);
}
});
queue.close();
const sessionEvents: Array<{ type: string; [key: string]: unknown }> = [];
const rpcHandlers = new Map<string, (params: unknown) => unknown>();
const setModelReasoningEffort = vi.fn();
const pushKeepAlive = vi.fn();
const client = {
rpcHandlerManager: {
registerHandler(method: string, handler: (params: unknown) => unknown) {
rpcHandlers.set(method, handler);
}
},
sendAgentMessage(_message: unknown) {},
sendUserMessage(_text: string) {},
sendSessionEvent(event: { type: string; [key: string]: unknown }) {
sessionEvents.push(event);
}
};
const agentMessages: unknown[] = [];
const session = {
path: '/tmp/hapi-opencode-test',
logPath: '/tmp/hapi-opencode-test/test.log',
client,
queue,
sessionId: null as string | null,
thinking: false,
getPermissionMode() {
return 'default' as const;
},
setModel(_model: string | null) {},
setModelReasoningEffort,
pushKeepAlive,
onThinkingChange(thinking: boolean) {
session.thinking = thinking;
},
onSessionFound(id: string) {
session.sessionId = id;
},
sendAgentMessage(message: unknown) {
agentMessages.push(message);
},
sendSessionEvent(event: { type: string; [key: string]: unknown }) {
client.sendSessionEvent(event);
},
sendUserMessage(_text: string) {}
};
return { session, sessionEvents, rpcHandlers, setModelReasoningEffort, pushKeepAlive, agentMessages };
}
describe('opencodeRemoteLauncher inline model switch', () => {
afterEach(() => {
harness.setModelArgs = [];
harness.setConfigOptionArgs = [];
harness.promptCount = 0;
harness.promptContents = [];
harness.events = [];
harness.setModelImpl = null;
harness.setConfigOptionImpl = null;
harness.thoughtLevelOption = null;
harness.stderrHandler = null;
harness.hangPrompt = false;
harness.resolvePrompt = null;
harness.cancelPrompt.mockClear();
});
it('calls setModel with opencode flavor between turns when the queued model differs', async () => {
const { session } = createSessionStub([
{ message: 'first', mode: createMode('ollama/exaone:4.5-33b-q8') },
{ message: 'second', mode: createMode('mlx/qwen3:0.6b') }
]);
await opencodeRemoteLauncher(session as never);
expect(harness.setModelArgs).toEqual([
{ sessionId: 'acp-session-1', modelId: 'mlx/qwen3:0.6b', flavor: 'opencode' }
]);
expect(harness.promptCount).toBe(2);
});
it('does not call setModel when the model is unchanged across turns', async () => {
const { session } = createSessionStub([
{ message: 'first', mode: createMode('ollama/exaone:4.5-33b-q8') },
{ message: 'second', mode: createMode('ollama/exaone:4.5-33b-q8') }
]);
await opencodeRemoteLauncher(session as never);
expect(harness.setModelArgs).toEqual([]);
expect(harness.promptCount).toBe(2);
});
it('latches inline switching off after a method-not-found response and notifies the user once', async () => {
harness.setModelImpl = async () => {
throw new Error('Method not found: session/set_model');
};
const { session, sessionEvents } = createSessionStub([
{ message: 'first', mode: createMode('ollama/a') },
{ message: 'second', mode: createMode('ollama/b') },
{ message: 'third', mode: createMode('ollama/c') }
]);
await opencodeRemoteLauncher(session as never);
// Only one setModel attempt — latched off after the first method-not-found
expect(harness.setModelArgs).toEqual([
{ sessionId: 'acp-session-1', modelId: 'ollama/b', flavor: 'opencode' }
]);
const unsupportedMessages = sessionEvents.filter(
(event) =>
event.type === 'message' &&
typeof event.message === 'string' &&
event.message.includes('does not support inline model switching')
);
expect(unsupportedMessages.length).toBe(1);
expect(harness.promptCount).toBe(3);
});
it('reports a transient setModel error and continues with the previous model', async () => {
let attempts = 0;
harness.setModelImpl = async () => {
attempts++;
throw new Error('Transient backend failure');
};
const { session, sessionEvents } = createSessionStub([
{ message: 'first', mode: createMode('ollama/a') },
{ message: 'second', mode: createMode('ollama/b') }
]);
await opencodeRemoteLauncher(session as never);
expect(attempts).toBe(1);
const failureMessages = sessionEvents.filter(
(event) =>
event.type === 'message' &&
typeof event.message === 'string' &&
event.message.includes('Failed to switch model')
);
expect(failureMessages.length).toBe(1);
expect(failureMessages[0]?.message).toContain('ollama/b');
expect(harness.promptCount).toBe(2);
});
it('rejects unsupported reasoning effort values before calling setConfigOption', async () => {
harness.thoughtLevelOption = {
id: 'effort',
currentValue: 'low',
options: [
{ value: 'low', name: 'Low' },
{ value: 'medium', name: 'Medium' }
]
};
const { session, setModelReasoningEffort } = createSessionStub([
{ message: 'first', mode: createModeWithEffort(undefined, 'high') }
]);
await opencodeRemoteLauncher(session as never);
expect(harness.setConfigOptionArgs).toEqual([]);
expect(setModelReasoningEffort).toHaveBeenCalledWith('low');
expect(harness.promptCount).toBe(1);
});
it('syncs hub effort state after coercing an unsupported request to a different supported value', async () => {
harness.thoughtLevelOption = {
id: 'effort',
currentValue: 'high',
options: [
{ value: 'low', name: 'Low' },
{ value: 'medium', name: 'Medium' }
]
};
const { session, setModelReasoningEffort, pushKeepAlive } = createSessionStub([
{ message: 'first', mode: createModeWithEffort(undefined, 'max') }
]);
await opencodeRemoteLauncher(session as never);
expect(harness.setConfigOptionArgs).toEqual([
{ sessionId: 'acp-session-1', configId: 'effort', value: 'low' }
]);
expect(setModelReasoningEffort).toHaveBeenCalledWith('low');
expect(pushKeepAlive).toHaveBeenCalledTimes(1);
expect(harness.promptCount).toBe(1);
});
it('resets to the backend launch-time default model when the queued mode.model is null', async () => {
// Seed the backend with a launch-time default model so the launcher
// captures it as `defaultBackendModel`. Without that, `/model default`
// resolves to null and the launcher has nothing to switch back to.
const opencodeBackendModule = await import('./utils/opencodeBackend');
const factory = (opencodeBackendModule as unknown as { createOpencodeBackend: ReturnType<typeof vi.fn> }).createOpencodeBackend;
const originalImpl = factory.getMockImplementation();
factory.mockImplementationOnce(() => {
const backend = (originalImpl as () => Record<string, unknown>)();
backend.getSessionModelsMetadata = vi.fn(() => ({
currentModelId: 'ollama/launch-default',
availableModels: []
}));
return backend;
});
const { session } = createSessionStub([
{ message: 'first', mode: createMode('ollama/custom') },
{ message: 'second', mode: createResetMode() }
]);
await opencodeRemoteLauncher(session as never);
// Switch to custom on turn 1, then back to the launch-time default on turn 2.
expect(harness.setModelArgs).toEqual([
{ sessionId: 'acp-session-1', modelId: 'ollama/custom', flavor: 'opencode' },
{ sessionId: 'acp-session-1', modelId: 'ollama/launch-default', flavor: 'opencode' }
]);
expect(harness.promptCount).toBe(2);
});
it('calls setConfigOption for OpenCode reasoning effort changes', async () => {
harness.thoughtLevelOption = {
id: 'effort',
currentValue: 'low',
options: [
{ value: 'low', name: 'Low' },
{ value: 'high', name: 'High' }
]
};
const { session } = createSessionStub([
{ message: 'first', mode: createModeWithEffort(undefined, 'high') }
]);
await opencodeRemoteLauncher(session as never);
expect(harness.setConfigOptionArgs).toEqual([
{ sessionId: 'acp-session-1', configId: 'effort', value: 'high' }
]);
expect(harness.promptCount).toBe(1);
});
it('rolls back session reasoning effort when OpenCode rejects the switch', async () => {
harness.thoughtLevelOption = {
id: 'effort',
currentValue: 'low',
options: [
{ value: 'low', name: 'Low' },
{ value: 'high', name: 'High' }
]
};
harness.setConfigOptionImpl = async () => {
throw new Error('Transient backend failure');
};
const { session, sessionEvents, setModelReasoningEffort, pushKeepAlive } = createSessionStub([
{ message: 'first', mode: createModeWithEffort(undefined, 'high') }
]);
const rollbacks: Array<string | null> = [];
await opencodeRemoteLauncher(session as never, {
onReasoningEffortRollback: (effort) => rollbacks.push(effort)
});
expect(harness.setConfigOptionArgs).toEqual([
{ sessionId: 'acp-session-1', configId: 'effort', value: 'high' }
]);
expect(setModelReasoningEffort).toHaveBeenCalledWith('low');
expect(pushKeepAlive).toHaveBeenCalledTimes(1);
expect(rollbacks).toEqual(['low']);
expect(sessionEvents.some(
(event) => event.type === 'message'
&& typeof event.message === 'string'
&& event.message.includes('Failed to switch reasoning effort')
)).toBe(true);
expect(harness.promptCount).toBe(1);
});
it('injects plan-mode instructions into plan turns', async () => {
const { session } = createSessionStub([
{ message: 'design the fix', mode: createPlanMode() }
]);
await opencodeRemoteLauncher(session as never);
const content = harness.promptContents[0] as Array<{ type: string; text: string }>;
expect(content[0]?.text).toContain('You are in plan mode');
expect(content[0]?.text).toContain('Do not execute tools');
expect(content[0]?.text).toContain('design the fix');
});
it('registers a listOpencodeModels RPC handler that returns the backend cache', async () => {
// Override getSessionModelsMetadata for this run only.
const fixtureModels = [
{ modelId: 'ollama/exaone:4.5-33b-q8', name: 'Ollama EXAONE' },
{ modelId: 'mlx/qwen3:0.6b', name: 'MLX Qwen3' }
];
const opencodeBackendModule = await import('./utils/opencodeBackend');
const factory = (opencodeBackendModule as unknown as { createOpencodeBackend: ReturnType<typeof vi.fn> }).createOpencodeBackend;
factory.mockImplementationOnce(() => ({
initialize: vi.fn(async () => {}),
newSession: vi.fn(async () => 'acp-session-1'),
loadSession: vi.fn(async () => 'acp-session-1'),
setModel: vi.fn(async () => {}),
prompt: vi.fn(async () => {}),
cancelPrompt: vi.fn(async () => {}),
respondToPermission: vi.fn(async () => {}),
onStderrError: vi.fn(),
onPermissionRequest: vi.fn(),
disconnect: vi.fn(async () => {}),
getSessionModelsMetadata: vi.fn((sessionId: string) => {
if (sessionId === 'acp-session-1') {
return { availableModels: fixtureModels, currentModelId: 'ollama/exaone:4.5-33b-q8' };
}
return undefined;
})
}));
const { session, rpcHandlers } = createSessionStub([
{ message: 'first', mode: createMode('ollama/exaone:4.5-33b-q8') }
]);
await opencodeRemoteLauncher(session as never);
const handler = rpcHandlers.get('listOpencodeModels');
expect(handler).toBeDefined();
const result = await handler!(undefined) as Record<string, unknown>;
expect(result).toEqual({
success: true,
availableModels: fixtureModels,
currentModelId: 'ollama/exaone:4.5-33b-q8'
});
});
it('listOpencodeModels handler returns unavailable when backend has no metadata', async () => {
const { session, rpcHandlers } = createSessionStub([
{ message: 'first', mode: createMode() }
]);
await opencodeRemoteLauncher(session as never);
const handler = rpcHandlers.get('listOpencodeModels');
expect(handler).toBeDefined();
const result = await handler!(undefined) as Record<string, unknown>;
expect(result).toEqual({
success: false,
error: 'OpenCode model metadata is not available'
});
});
it('registers a listOpencodeReasoningEffortOptions RPC handler that returns ACP options', async () => {
harness.thoughtLevelOption = {
id: 'effort',
currentValue: 'low',
options: [
{ value: 'low', name: 'Low' },
{ value: 'medium', name: 'Medium' }
]
};
const { session, rpcHandlers } = createSessionStub([
{ message: 'first', mode: createMode() }
]);
await opencodeRemoteLauncher(session as never);
const handler = rpcHandlers.get('listOpencodeReasoningEffortOptions');
expect(handler).toBeDefined();
const result = await handler!(undefined) as Record<string, unknown>;
expect(result).toEqual({
success: true,
options: [
{ value: 'low', name: 'Low' },
{ value: 'medium', name: 'Medium' }
],
currentValue: 'low'
});
});
it('listOpencodeReasoningEffortOptions handler returns unavailable when backend has no thought level option', async () => {
const { session, rpcHandlers } = createSessionStub([
{ message: 'first', mode: createMode() }
]);
await opencodeRemoteLauncher(session as never);
const handler = rpcHandlers.get('listOpencodeReasoningEffortOptions');
expect(handler).toBeDefined();
const result = await handler!(undefined) as Record<string, unknown>;
expect(result).toEqual({
success: false,
error: 'OpenCode reasoning effort options are not available'
});
});
it('clears thinking and cancels prompt when a stall stderr error arrives during prompt', async () => {
harness.hangPrompt = true;
const { session, agentMessages } = createSessionStub([
{ message: 'first', mode: createMode() }
]);
const launchPromise = opencodeRemoteLauncher(session as never);
await vi.waitFor(() => expect(harness.events).toContain('prompt:start'));
expect(session.thinking).toBe(true);
expect(harness.stderrHandler).toBeTypeOf('function');
harness.stderrHandler!({
type: 'quota_exceeded',
message: 'API quota exceeded. Please check your billing or wait for quota reset.',
raw: 'quota exceeded for provider'
});
expect(session.thinking).toBe(false);
expect(harness.cancelPrompt).toHaveBeenCalledWith('acp-session-1');
expect(agentMessages).toContainEqual({
type: 'error',
message: 'API quota exceeded. Please check your billing or wait for quota reset.'
});
harness.resolvePrompt!();
await launchPromise;
});
it('routes HTTP/2 cancel stderr through the error agent message pipeline', async () => {
harness.hangPrompt = true;
const { session, agentMessages } = createSessionStub([
{ message: 'first', mode: createMode() }
]);
const launchPromise = opencodeRemoteLauncher(session as never);
await vi.waitFor(() => expect(harness.stderrHandler).toBeTypeOf('function'));
const message = 'Error: T: [canceled] http/2 stream closed with error code CANCEL (0x8)';
harness.stderrHandler!({
type: 'unknown',
message,
raw: message
});
expect(session.thinking).toBe(false);
expect(harness.cancelPrompt).toHaveBeenCalledWith('acp-session-1');
expect(agentMessages).toContainEqual({ type: 'error', message });
harness.resolvePrompt!();
await launchPromise;
});
it('surfaces non-stall stderr as error without clearing thinking or canceling prompt', async () => {
harness.hangPrompt = true;
const { session, agentMessages } = createSessionStub([
{ message: 'first', mode: createMode() }
]);
const launchPromise = opencodeRemoteLauncher(session as never);
await vi.waitFor(() => expect(harness.events).toContain('prompt:start'));
expect(session.thinking).toBe(true);
harness.stderrHandler!({
type: 'authentication',
message: 'Authentication failed. Please check your credentials.',
raw: 'status 401 unauthenticated'
});
expect(session.thinking).toBe(true);
expect(harness.cancelPrompt).not.toHaveBeenCalled();
expect(agentMessages).toContainEqual({
type: 'error',
message: 'Authentication failed. Please check your credentials.'
});
harness.resolvePrompt!();
await launchPromise;
});
it('serializes setModel after the previous prompt resolves', async () => {
const { session } = createSessionStub([
{ message: 'first', mode: createMode('ollama/a') },
{ message: 'second', mode: createMode('ollama/b') }
]);
await opencodeRemoteLauncher(session as never);
// Order must be: prompt(1) start/end → setModel → prompt(2) start/end
expect(harness.events).toEqual([
'prompt:start',
'prompt:end',
'setModel:ollama/b',
'prompt:start',
'prompt:end'
]);
});
});