-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathopencode-client-manager.test.ts
More file actions
723 lines (595 loc) · 20.8 KB
/
Copy pathopencode-client-manager.test.ts
File metadata and controls
723 lines (595 loc) · 20.8 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
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
import {
OpencodeClientManager,
createClientManager,
createClientManagerFromSettings,
} from "./opencode-client-manager.js";
import type { OpencodeClient } from "./types.js";
// Mock the @opencode-ai/sdk/v2 module
vi.mock("@opencode-ai/sdk/v2", () => ({
createOpencodeClient: vi.fn().mockResolvedValue({
session: {
create: vi.fn(),
prompt: vi.fn(),
abort: vi.fn(),
},
event: {
subscribe: vi.fn(),
},
}),
createOpencodeServer: vi.fn().mockResolvedValue({
url: "http://127.0.0.1:4096",
close: vi.fn(),
}),
}));
// Mock fetch for health checks
const mockFetch = vi.fn();
global.fetch = mockFetch;
describe("opencode-client-manager", () => {
beforeEach(() => {
// Reset singleton before each test
OpencodeClientManager.resetInstance();
vi.clearAllMocks();
// Default: server not running (health check fails)
mockFetch.mockRejectedValue(new Error("Connection refused"));
});
afterEach(() => {
OpencodeClientManager.resetInstance();
});
describe("getInstance", () => {
it("should return singleton instance", () => {
const instance1 = OpencodeClientManager.getInstance();
const instance2 = OpencodeClientManager.getInstance();
expect(instance1).toBe(instance2);
});
it("should accept options on first call", () => {
const instance = OpencodeClientManager.getInstance({
hostname: "localhost",
port: 5000,
});
expect(instance).toBeDefined();
});
it("should not update options after client initialized", async () => {
const warn = vi.fn();
const instance = OpencodeClientManager.getInstance({
port: 4096,
logger: {
warn,
error: vi.fn(),
},
});
await instance.getClient();
// Try to update options after initialization
OpencodeClientManager.getInstance({ port: 5000 });
// Should still use original port
expect(instance.getServerUrl()).toContain("4096");
expect(warn).toHaveBeenCalledWith(
expect.stringContaining("already initialized"),
);
expect(warn).toHaveBeenCalledWith(
expect.stringContaining("options from createOpencode() were ignored"),
);
});
it("should warn explicitly when a different preconfigured client is provided after initialization", async () => {
const warn = vi.fn();
const initialClient = {
session: {
create: vi.fn(),
prompt: vi.fn(),
abort: vi.fn(),
},
event: {
subscribe: vi.fn(),
},
};
const nextClient = {
session: {
create: vi.fn(),
prompt: vi.fn(),
abort: vi.fn(),
},
event: {
subscribe: vi.fn(),
},
};
const instance = OpencodeClientManager.getInstance({
client: initialClient as Awaited<
ReturnType<typeof import("@opencode-ai/sdk/v2").createOpencodeClient>
>,
logger: {
warn,
error: vi.fn(),
},
});
await instance.getClient();
OpencodeClientManager.getInstance({
client: nextClient as Awaited<
ReturnType<typeof import("@opencode-ai/sdk/v2").createOpencodeClient>
>,
});
expect(warn).toHaveBeenCalledWith(
expect.stringContaining("provided preconfigured client was ignored"),
);
});
});
describe("resetInstance", () => {
it("should reset singleton instance", async () => {
const instance1 = OpencodeClientManager.getInstance();
await instance1.getClient();
OpencodeClientManager.resetInstance();
const instance2 = OpencodeClientManager.getInstance();
expect(instance1).not.toBe(instance2);
});
});
describe("getClient", () => {
it("should create client when server starts successfully", async () => {
const instance = OpencodeClientManager.getInstance({
autoStartServer: true,
});
const client = await instance.getClient();
expect(client).toBeDefined();
expect(client.session).toBeDefined();
});
it("should return same client on subsequent calls", async () => {
const instance = OpencodeClientManager.getInstance();
const client1 = await instance.getClient();
const client2 = await instance.getClient();
expect(client1).toBe(client2);
});
it("should throw when disposed", async () => {
const instance = OpencodeClientManager.getInstance();
await instance.dispose();
await expect(instance.getClient()).rejects.toThrow("disposed");
});
it("should connect to existing server if running", async () => {
// Simulate server running
mockFetch.mockResolvedValueOnce({ ok: true });
const instance = OpencodeClientManager.getInstance({
autoStartServer: false,
});
const client = await instance.getClient();
expect(client).toBeDefined();
});
it("should try config endpoint if health fails", async () => {
// Health fails, config succeeds
mockFetch
.mockRejectedValueOnce(new Error("Health failed"))
.mockResolvedValueOnce({ ok: true });
const instance = OpencodeClientManager.getInstance({
autoStartServer: false,
});
const client = await instance.getClient();
expect(client).toBeDefined();
});
it("should throw when server not running and autoStart disabled", async () => {
const instance = OpencodeClientManager.getInstance({
autoStartServer: false,
});
await expect(instance.getClient()).rejects.toThrow(
"No OpenCode server running",
);
});
it("should use baseUrl if provided", async () => {
const instance = OpencodeClientManager.getInstance({
baseUrl: "http://custom-server:8080",
});
await instance.getClient();
const { createOpencodeClient } = await import("@opencode-ai/sdk/v2");
expect(createOpencodeClient).toHaveBeenCalledWith(
expect.objectContaining({
baseUrl: "http://custom-server:8080",
}),
);
});
it("should forward clientOptions when baseUrl is provided", async () => {
const instance = OpencodeClientManager.getInstance({
baseUrl: "http://custom-server:8080",
clientOptions: {
headers: {
"x-api-key": "test-key",
},
throwOnError: true,
credentials: "include",
},
});
await instance.getClient();
const { createOpencodeClient } = await import("@opencode-ai/sdk/v2");
expect(createOpencodeClient).toHaveBeenCalledWith(
expect.objectContaining({
baseUrl: "http://custom-server:8080",
headers: {
"x-api-key": "test-key",
},
throwOnError: true,
credentials: "include",
}),
);
});
it("should forward clientOptions when connecting to existing server", async () => {
mockFetch.mockResolvedValueOnce({ ok: true });
const instance = OpencodeClientManager.getInstance({
autoStartServer: false,
clientOptions: {
headers: {
Authorization: "Bearer test-token",
},
credentials: "omit",
},
});
await instance.getClient();
const { createOpencodeClient, createOpencodeServer } =
await import("@opencode-ai/sdk/v2");
expect(createOpencodeClient).toHaveBeenCalledWith(
expect.objectContaining({
baseUrl: "http://127.0.0.1:4096",
headers: {
Authorization: "Bearer test-token",
},
credentials: "omit",
}),
);
expect(createOpencodeServer).not.toHaveBeenCalled();
});
it("should forward clientOptions when starting managed server", async () => {
const instance = OpencodeClientManager.getInstance({
autoStartServer: true,
clientOptions: {
headers: {
"x-trace-id": "trace-123",
},
keepalive: true,
},
});
await instance.getClient();
const { createOpencodeClient } = await import("@opencode-ai/sdk/v2");
expect(createOpencodeClient).toHaveBeenCalledWith(
expect.objectContaining({
baseUrl: "http://127.0.0.1:4096",
headers: {
"x-trace-id": "trace-123",
},
keepalive: true,
}),
);
});
it("should ignore clientOptions.baseUrl and clientOptions.directory", async () => {
const warn = vi.fn();
const instance = OpencodeClientManager.getInstance({
baseUrl: "http://custom-server:8080",
clientOptions: {
baseUrl: "http://ignored:9999",
directory: "/tmp/ignored",
headers: { "x-test": "value" },
} as unknown as NonNullable<
Parameters<
typeof import("@opencode-ai/sdk/v2").createOpencodeClient
>[0]
>,
logger: {
warn,
error: vi.fn(),
},
});
await instance.getClient();
const { createOpencodeClient } = await import("@opencode-ai/sdk/v2");
expect(createOpencodeClient).toHaveBeenCalledWith(
expect.objectContaining({
baseUrl: "http://custom-server:8080",
headers: { "x-test": "value" },
}),
);
expect(warn).toHaveBeenCalledWith(
expect.stringContaining("Ignoring clientOptions.baseUrl"),
);
expect(warn).toHaveBeenCalledWith(
expect.stringContaining("Ignoring clientOptions.directory"),
);
});
it('should force fields responseStyle and warn when clientOptions requests "data"', async () => {
const warn = vi.fn();
const instance = OpencodeClientManager.getInstance({
baseUrl: "http://custom-server:8080",
clientOptions: {
responseStyle: "data",
},
logger: {
warn,
error: vi.fn(),
},
});
await instance.getClient();
const { createOpencodeClient } = await import("@opencode-ai/sdk/v2");
expect(createOpencodeClient).toHaveBeenCalledWith(
expect.objectContaining({
responseStyle: "fields",
}),
);
expect(warn).toHaveBeenCalledWith(
expect.stringContaining("Ignoring clientOptions.responseStyle"),
);
});
it("should not warn for undefined reserved keys in clientOptions", async () => {
const warn = vi.fn();
const instance = OpencodeClientManager.getInstance({
baseUrl: "http://custom-server:8080",
clientOptions: {
baseUrl: undefined,
directory: undefined,
headers: { "x-test": "value" },
} as unknown as NonNullable<
Parameters<
typeof import("@opencode-ai/sdk/v2").createOpencodeClient
>[0]
>,
logger: {
warn,
error: vi.fn(),
},
});
await instance.getClient();
expect(warn).not.toHaveBeenCalledWith(
expect.stringContaining("Ignoring clientOptions.baseUrl"),
);
expect(warn).not.toHaveBeenCalledWith(
expect.stringContaining("Ignoring clientOptions.directory"),
);
});
it("should use preconfigured client when provided", async () => {
const warn = vi.fn();
const preconfiguredClient = {
session: {
create: vi.fn(),
prompt: vi.fn(),
abort: vi.fn(),
},
event: {
subscribe: vi.fn(),
},
};
const instance = OpencodeClientManager.getInstance({
client: preconfiguredClient as Awaited<
ReturnType<typeof import("@opencode-ai/sdk/v2").createOpencodeClient>
>,
clientOptions: {
headers: { "x-ignored": "value" },
},
logger: {
warn,
error: vi.fn(),
},
});
const client = await instance.getClient();
const { createOpencodeClient, createOpencodeServer } =
await import("@opencode-ai/sdk/v2");
expect(client).toBe(preconfiguredClient);
expect(createOpencodeClient).not.toHaveBeenCalled();
expect(createOpencodeServer).not.toHaveBeenCalled();
expect(mockFetch).not.toHaveBeenCalled();
expect(warn).toHaveBeenCalledWith(
expect.stringContaining("clientOptions will be ignored"),
);
});
it("should handle concurrent getClient calls", async () => {
const instance = OpencodeClientManager.getInstance();
const [client1, client2] = await Promise.all([
instance.getClient(),
instance.getClient(),
]);
expect(client1).toBe(client2);
});
});
describe("getServerUrl", () => {
it("should return URL from managed server", async () => {
const instance = OpencodeClientManager.getInstance();
await instance.getClient();
expect(instance.getServerUrl()).toBe("http://127.0.0.1:4096");
});
it("should return baseUrl if provided", () => {
const instance = OpencodeClientManager.getInstance({
baseUrl: "http://custom:8080",
});
expect(instance.getServerUrl()).toBe("http://custom:8080");
});
it("should return constructed URL from hostname and port", () => {
const instance = OpencodeClientManager.getInstance({
hostname: "localhost",
port: 5000,
});
expect(instance.getServerUrl()).toBe("http://localhost:5000");
});
});
describe("isServerManaged", () => {
it("should return false before client created", () => {
const instance = OpencodeClientManager.getInstance();
expect(instance.isServerManaged()).toBe(false);
});
it("should return true when server is started by manager", async () => {
const instance = OpencodeClientManager.getInstance({
autoStartServer: true,
});
await instance.getClient();
expect(instance.isServerManaged()).toBe(true);
});
it("should return false when connecting to external server", async () => {
// Server already running
mockFetch.mockResolvedValueOnce({ ok: true });
const instance = OpencodeClientManager.getInstance({
autoStartServer: false,
});
await instance.getClient();
expect(instance.isServerManaged()).toBe(false);
});
});
describe("dispose", () => {
it("should close managed server", async () => {
const instance = OpencodeClientManager.getInstance();
await instance.getClient();
await instance.dispose();
const { createOpencodeServer } = await import("@opencode-ai/sdk/v2");
const server = await (createOpencodeServer as ReturnType<typeof vi.fn>)
.mock.results[0].value;
expect(server.close).toHaveBeenCalled();
});
it("should be idempotent", async () => {
const instance = OpencodeClientManager.getInstance();
await instance.getClient();
await instance.dispose();
await instance.dispose();
// Should not throw
});
it("should abort registered event subscription controllers", async () => {
const instance = OpencodeClientManager.getInstance();
const tracked = new AbortController();
instance.registerEventSubscription(tracked);
const unregistered = new AbortController();
const unregister = instance.registerEventSubscription(unregistered);
unregister();
await instance.dispose();
expect(tracked.signal.aborted).toBe(true);
expect(unregistered.signal.aborted).toBe(false);
});
it("should clear client reference", async () => {
const instance = OpencodeClientManager.getInstance();
await instance.getClient();
await instance.dispose();
// Attempting to get client should throw
await expect(instance.getClient()).rejects.toThrow("disposed");
});
it("should allow a fresh singleton to be created after dispose", async () => {
const clientA = {
session: { create: vi.fn(), prompt: vi.fn(), abort: vi.fn() },
event: { subscribe: vi.fn() },
} as unknown as OpencodeClient;
const clientB = {
session: { create: vi.fn(), prompt: vi.fn(), abort: vi.fn() },
event: { subscribe: vi.fn() },
} as unknown as OpencodeClient;
const first = OpencodeClientManager.getInstance({ client: clientA });
expect(await first.getClient()).toBe(clientA);
await first.dispose();
const second = OpencodeClientManager.getInstance({ client: clientB });
expect(second).not.toBe(first);
expect(await second.getClient()).toBe(clientB);
});
});
describe("createClientManager", () => {
it("should return singleton instance", () => {
const manager1 = createClientManager();
const manager2 = createClientManager();
expect(manager1).toBe(manager2);
});
it("should accept options", () => {
const manager = createClientManager({ port: 5000 });
expect(manager).toBeDefined();
});
});
describe("createClientManagerFromSettings", () => {
it("should create manager from provider settings", () => {
const manager = createClientManagerFromSettings({
hostname: "localhost",
port: 5000,
autoStartServer: false,
serverTimeout: 15000,
defaultSettings: {
cwd: "/home/user/project",
},
});
expect(manager).toBeDefined();
expect(manager.getServerUrl()).toBe("http://localhost:5000");
});
it("should use baseUrl if provided", () => {
const manager = createClientManagerFromSettings({
baseUrl: "http://custom:8080",
});
expect(manager.getServerUrl()).toBe("http://custom:8080");
});
it("should accept defaultSettings.directory", () => {
const manager = createClientManagerFromSettings({
defaultSettings: {
directory: "/tmp/project",
},
});
expect(manager).toBeDefined();
});
it("should forward clientOptions from provider settings", async () => {
const manager = createClientManagerFromSettings({
baseUrl: "http://custom:8080",
clientOptions: {
headers: {
"x-provider": "settings",
},
throwOnError: true,
},
});
await manager.getClient();
const { createOpencodeClient } = await import("@opencode-ai/sdk/v2");
expect(createOpencodeClient).toHaveBeenCalledWith(
expect.objectContaining({
baseUrl: "http://custom:8080",
headers: {
"x-provider": "settings",
},
throwOnError: true,
}),
);
});
it("should use preconfigured client from provider settings", async () => {
const preconfiguredClient = {
session: {
create: vi.fn(),
prompt: vi.fn(),
abort: vi.fn(),
},
event: {
subscribe: vi.fn(),
},
};
const manager = createClientManagerFromSettings({
client: preconfiguredClient as Awaited<
ReturnType<typeof import("@opencode-ai/sdk/v2").createOpencodeClient>
>,
});
const client = await manager.getClient();
expect(client).toBe(preconfiguredClient);
});
});
describe("createInstance", () => {
it("should return a new instance each time (not the singleton)", () => {
const a = OpencodeClientManager.createInstance({});
const b = OpencodeClientManager.createInstance({});
const singleton = OpencodeClientManager.getInstance();
expect(a).not.toBe(b);
expect(a).not.toBe(singleton);
expect(b).not.toBe(singleton);
});
it("should use its own client independently of the singleton", async () => {
const clientA = {
session: { create: vi.fn(), prompt: vi.fn(), abort: vi.fn() },
event: { subscribe: vi.fn() },
} as unknown as OpencodeClient;
const clientB = {
session: { create: vi.fn(), prompt: vi.fn(), abort: vi.fn() },
event: { subscribe: vi.fn() },
} as unknown as OpencodeClient;
const a = OpencodeClientManager.createInstance({ client: clientA });
const b = OpencodeClientManager.createInstance({ client: clientB });
expect(await a.getClient()).toBe(clientA);
expect(await b.getClient()).toBe(clientB);
});
it("should not affect each other when disposed", async () => {
const clientA = {
session: { create: vi.fn(), prompt: vi.fn(), abort: vi.fn() },
event: { subscribe: vi.fn() },
} as unknown as OpencodeClient;
const clientB = {
session: { create: vi.fn(), prompt: vi.fn(), abort: vi.fn() },
event: { subscribe: vi.fn() },
} as unknown as OpencodeClient;
const a = OpencodeClientManager.createInstance({ client: clientA });
const b = OpencodeClientManager.createInstance({ client: clientB });
await a.dispose();
await expect(a.getClient()).rejects.toThrow("disposed");
expect(await b.getClient()).toBe(clientB);
});
});
});