-
Notifications
You must be signed in to change notification settings - Fork 42
Expand file tree
/
Copy pathcoderApi.test.ts
More file actions
954 lines (798 loc) · 27.2 KB
/
coderApi.test.ts
File metadata and controls
954 lines (798 loc) · 27.2 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
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
import axios, {
AxiosError,
AxiosHeaders,
type CreateAxiosDefaults,
type InternalAxiosRequestConfig,
} from "axios";
import { type ProvisionerJobLog } from "coder/site/src/api/typesGenerated";
import { EventSource } from "eventsource";
import { ProxyAgent } from "proxy-agent";
import {
afterEach,
beforeEach,
describe,
expect,
it,
type Mock,
vi,
} from "vitest";
import Ws from "ws";
import {
getRefreshCommand,
refreshCertificates,
} from "@/api/certificateRefresh";
import { CoderApi } from "@/api/coderApi";
import { createHttpAgent } from "@/api/utils";
import { ClientCertificateError } from "@/error/clientCertificateError";
import { ServerCertificateError } from "@/error/serverCertificateError";
import { getHeaders } from "@/headers";
import { type RequestConfigWithMeta } from "@/logging/types";
import { ReconnectingWebSocket } from "@/websocket/reconnectingWebSocket";
import {
createMockLogger,
MockConfigurationProvider,
} from "../../mocks/testHelpers";
const CODER_URL = "https://coder.example.com";
const AXIOS_TOKEN = "passed-token";
const BUILD_ID = "build-123";
const AGENT_ID = "agent-123";
vi.mock("ws");
vi.mock("eventsource");
vi.mock("proxy-agent");
vi.mock("axios", async () => {
const actual = await vi.importActual<typeof import("axios")>("axios");
const mockAdapter = vi.fn(mockAdapterImpl);
const mockDefault = {
...actual.default,
create: vi.fn((config: CreateAxiosDefaults) => {
const instance = actual.default.create({
...config,
adapter: mockAdapter,
});
return instance;
}),
__mockAdapter: mockAdapter,
};
return {
...actual,
default: mockDefault,
};
});
vi.mock("@/headers", () => ({
getHeaders: vi.fn().mockResolvedValue({}),
getHeaderCommand: vi.fn(),
}));
vi.mock("@/api/utils", () => ({
createHttpAgent: vi.fn(),
}));
vi.mock("@/api/certificateRefresh", () => ({
getRefreshCommand: vi.fn(),
refreshCertificates: vi.fn(),
}));
vi.mock("@/api/streamingFetchAdapter", () => ({
createStreamingFetchAdapter: vi.fn(() => fetch),
}));
describe("CoderApi", () => {
let mockLogger: ReturnType<typeof createMockLogger>;
let mockConfig: MockConfigurationProvider;
let mockAdapter: Mock<
(config: InternalAxiosRequestConfig) => Promise<unknown>
>;
let api: CoderApi;
const createApi = (url = CODER_URL, token = AXIOS_TOKEN) => {
return CoderApi.create(url, token, mockLogger);
};
beforeEach(() => {
vi.resetAllMocks();
const axiosMock = axios as typeof axios & {
__mockAdapter: Mock<
(config: InternalAxiosRequestConfig) => Promise<unknown>
>;
};
mockAdapter = axiosMock.__mockAdapter;
mockAdapter.mockImplementation(mockAdapterImpl);
vi.mocked(getHeaders).mockResolvedValue({});
mockLogger = createMockLogger();
mockConfig = new MockConfigurationProvider();
mockConfig.set("coder.httpClientLogLevel", "BASIC");
});
afterEach(() => {
// Dispose any api created during the test to clean up config watchers
api?.dispose();
});
describe("HTTP Interceptors", () => {
it("adds custom headers and HTTP agent to requests", async () => {
const mockAgent = new ProxyAgent();
vi.mocked(createHttpAgent).mockResolvedValue(mockAgent);
vi.mocked(getHeaders).mockResolvedValue({
"X-Custom-Header": "custom-value",
"X-Another-Header": "another-value",
});
const api = createApi();
const response = await api.getAxiosInstance().get("/api/v2/users/me");
expect(response.config.headers["X-Custom-Header"]).toBe("custom-value");
expect(response.config.headers["X-Another-Header"]).toBe("another-value");
expect(response.config.httpsAgent).toBe(mockAgent);
expect(response.config.httpAgent).toBe(mockAgent);
expect(response.config.proxy).toBe(false);
});
it("wraps certificate errors in response interceptor", async () => {
const api = createApi();
const certError = new AxiosError(
"self signed certificate",
"DEPTH_ZERO_SELF_SIGNED_CERT",
);
mockAdapter.mockRejectedValueOnce(certError);
const thrownError = await api
.getAxiosInstance()
.get("/api/v2/users/me")
.catch((e) => e);
expect(thrownError).toBeInstanceOf(ServerCertificateError);
const castError = thrownError as ServerCertificateError;
expect(castError.message).toContain("Secure connection");
expect(castError.x509Err).toBeDefined();
});
it("applies headers in correct precedence order (command overrides config overrides axios default)", async () => {
const api = createApi(CODER_URL, AXIOS_TOKEN);
// Test 1: Headers from config, default token from API creation
const response = await api.getAxiosInstance().get("/api/v2/users/me", {
headers: new AxiosHeaders({
"X-Custom-Header": "from-config",
"X-Extra": "extra-value",
}),
});
expect(response.config.headers["X-Custom-Header"]).toBe("from-config");
expect(response.config.headers["X-Extra"]).toBe("extra-value");
expect(response.config.headers["Coder-Session-Token"]).toBe(AXIOS_TOKEN);
// Test 2: Token from request options overrides default
const responseWithToken = await api
.getAxiosInstance()
.get("/api/v2/users/me", {
headers: new AxiosHeaders({
"Coder-Session-Token": "from-options",
}),
});
expect(responseWithToken.config.headers["Coder-Session-Token"]).toBe(
"from-options",
);
// Test 3: Header command overrides everything
vi.mocked(getHeaders).mockResolvedValue({
"Coder-Session-Token": "from-header-command",
});
const responseWithHeaderCommand = await api
.getAxiosInstance()
.get("/api/v2/users/me", {
headers: new AxiosHeaders({
"Coder-Session-Token": "from-options",
}),
});
expect(
responseWithHeaderCommand.config.headers["Coder-Session-Token"],
).toBe("from-header-command");
});
it("logs requests and responses", async () => {
const api = createApi();
await api.getWorkspaces({});
expect(mockLogger.trace).toHaveBeenCalledWith(
expect.stringContaining("/api/v2/workspaces"),
);
});
it("calculates request and response sizes in transforms", async () => {
const api = createApi();
const response = await api
.getAxiosInstance()
.post("/api/v2/workspaces", { name: "test" });
expect((response.config as RequestConfigWithMeta).rawRequestSize).toBe(
15,
);
// We return the same data we sent in the mock adapter
expect((response.config as RequestConfigWithMeta).rawResponseSize).toBe(
15,
);
});
describe("certificate refresh and retry", () => {
const rejectWithCertError = (
config: InternalAxiosRequestConfig,
alertType: string,
) => {
const error = new AxiosError(
`ssl alert ${alertType}`,
"ERR_TLS_CERT_ALTNAME_INVALID",
config,
{},
undefined,
);
error.config = config;
return Promise.reject(error);
};
const resolveWithData = (
config: InternalAxiosRequestConfig,
data: unknown,
) => {
return Promise.resolve({
data,
status: 200,
statusText: "OK",
headers: {},
config,
});
};
it("succeeds after certificate refresh", async () => {
let certState: "expired" | "valid" = "expired";
vi.mocked(getRefreshCommand).mockReturnValue("refresh-command");
vi.mocked(refreshCertificates).mockImplementation(() => {
certState = "valid";
return Promise.resolve(true);
});
mockAdapter.mockImplementation((config) => {
if (certState === "expired") {
return rejectWithCertError(config, "certificate_expired");
}
return resolveWithData(config, { user: "test" });
});
const api = createApi();
const response = await api.getAxiosInstance().get("/api/v2/users/me");
expect(response.data).toEqual({ user: "test" });
});
it("fails with ClientCertificateError when refresh fails", async () => {
vi.mocked(getRefreshCommand).mockReturnValue("refresh-command");
vi.mocked(refreshCertificates).mockResolvedValue(false);
mockAdapter.mockImplementation((config) =>
rejectWithCertError(config, "certificate_expired"),
);
const api = createApi();
const error = await api
.getAxiosInstance()
.get("/api/v2/users/me")
.catch((e) => e);
expect(error).toBeInstanceOf(ClientCertificateError);
});
it("fails with ClientCertificateError when no refresh command configured", async () => {
vi.mocked(getRefreshCommand).mockReturnValue(undefined);
mockAdapter.mockImplementation((config) =>
rejectWithCertError(config, "certificate_expired"),
);
const api = createApi();
const error = await api
.getAxiosInstance()
.get("/api/v2/users/me")
.catch((e) => e);
expect(error).toBeInstanceOf(ClientCertificateError);
});
it.each(["unknown_ca", "unsupported_certificate", "access_denied"])(
"fails with ClientCertificateError for non-refreshable error: %s",
async (alertType) => {
vi.mocked(getRefreshCommand).mockReturnValue("refresh-command");
vi.mocked(refreshCertificates).mockResolvedValue(true);
mockAdapter.mockImplementation((config) =>
rejectWithCertError(config, alertType),
);
const api = createApi();
const error = await api
.getAxiosInstance()
.get("/api/v2/users/me")
.catch((e) => e);
expect(error).toBeInstanceOf(ClientCertificateError);
expect(refreshCertificates).not.toHaveBeenCalled();
},
);
it("fails after single retry when certificate keeps expiring", async () => {
vi.mocked(getRefreshCommand).mockReturnValue("refresh-command");
vi.mocked(refreshCertificates).mockResolvedValue(true);
mockAdapter.mockImplementation((config) =>
rejectWithCertError(config, "certificate_expired"),
);
const api = createApi();
const error = await api
.getAxiosInstance()
.get("/api/v2/users/me")
.catch((e) => e);
expect(error).toBeInstanceOf(ClientCertificateError);
});
});
});
describe("WebSocket Creation", () => {
const wsUrl = `wss://${CODER_URL.replace("https://", "")}/api/v2/workspacebuilds/${BUILD_ID}/logs?follow=true`;
beforeEach(() => {
api = createApi(CODER_URL, AXIOS_TOKEN);
// createOneWayWebSocket waits for open, so we need to fire it
const mockWs = createMockWebSocket(wsUrl, {
on: vi.fn((event, handler) => {
if (event === "open") {
setImmediate(() => handler());
}
return mockWs as Ws;
}),
});
setupWebSocketMock(mockWs);
});
it("creates WebSocket with proper headers and configuration", async () => {
const mockAgent = new ProxyAgent();
vi.mocked(getHeaders).mockResolvedValue({
"X-Custom-Header": "custom-value",
});
vi.mocked(createHttpAgent).mockResolvedValue(mockAgent);
await api.watchBuildLogsByBuildId(BUILD_ID, []);
expect(Ws).toHaveBeenCalledWith(wsUrl, undefined, {
agent: mockAgent,
followRedirects: true,
headers: {
"X-Custom-Header": "custom-value",
"Coder-Session-Token": AXIOS_TOKEN,
},
});
});
it("applies headers in correct precedence order (command overrides config overrides axios default)", async () => {
// Test 1: Default token from API creation
await api.watchBuildLogsByBuildId(BUILD_ID, []);
expect(Ws).toHaveBeenCalledWith(wsUrl, undefined, {
agent: undefined,
followRedirects: true,
headers: {
"Coder-Session-Token": AXIOS_TOKEN,
},
});
// Test 2: Token from config options overrides default
await api.watchBuildLogsByBuildId(BUILD_ID, [], {
headers: {
"X-Config-Header": "config-value",
"Coder-Session-Token": "from-config",
},
});
expect(Ws).toHaveBeenCalledWith(wsUrl, undefined, {
agent: undefined,
followRedirects: true,
headers: {
"Coder-Session-Token": "from-config",
"X-Config-Header": "config-value",
},
});
// Test 3: Header command overrides everything
vi.mocked(getHeaders).mockResolvedValue({
"Coder-Session-Token": "from-header-command",
});
await api.watchBuildLogsByBuildId(BUILD_ID, [], {
headers: {
"Coder-Session-Token": "from-config",
},
});
expect(Ws).toHaveBeenCalledWith(wsUrl, undefined, {
agent: undefined,
followRedirects: true,
headers: {
"Coder-Session-Token": "from-header-command",
},
});
});
it("logs WebSocket connections", async () => {
await api.watchBuildLogsByBuildId(BUILD_ID, []);
expect(mockLogger.trace).toHaveBeenCalledWith(
expect.stringContaining(BUILD_ID),
);
});
it("'watchBuildLogsByBuildId' includes after parameter for existing logs", async () => {
const jobLog: ProvisionerJobLog = {
created_at: new Date().toISOString(),
id: 1,
output: "log1",
log_source: "provisioner",
log_level: "info",
stage: "stage1",
};
const existingLogs = [
jobLog,
{ ...jobLog, id: 20 },
{ ...jobLog, id: 5 },
];
await api.watchBuildLogsByBuildId(BUILD_ID, existingLogs);
expect(Ws).toHaveBeenCalledWith(
expect.stringContaining("after=5"),
undefined,
expect.any(Object),
);
});
});
describe("SSE Fallback", () => {
beforeEach(() => {
api = createApi();
const mockEventSource = createMockEventSource(
`${CODER_URL}/api/v2/workspaces/123/watch`,
);
setupEventSourceMock(mockEventSource);
});
it("uses WebSocket when no errors occur", async () => {
const mockWs = createMockWebSocket(
`wss://${CODER_URL.replace("https://", "")}/api/v2/workspaceagents/${AGENT_ID}/watch-metadata`,
{
on: vi.fn((event, handler) => {
if (event === "open") {
setImmediate(() => handler());
}
return mockWs as Ws;
}),
},
);
setupWebSocketMock(mockWs);
const connection = await api.watchAgentMetadata(AGENT_ID);
expect(connection).toBeInstanceOf(ReconnectingWebSocket);
expect(EventSource).not.toHaveBeenCalled();
});
it("falls back to SSE when WebSocket creation fails with 404", async () => {
// Only 404 errors trigger SSE fallback - other errors are thrown
vi.mocked(Ws).mockImplementation(function () {
throw new Error("Unexpected server response: 404");
});
const connection = await api.watchAgentMetadata(AGENT_ID);
// Returns ReconnectingWebSocket (which wraps SSE internally)
expect(connection).toBeInstanceOf(ReconnectingWebSocket);
expect(EventSource).toHaveBeenCalled();
});
it("falls back to SSE on 404 error from WebSocket open", async () => {
const mockWs = createMockWebSocket(
`wss://${CODER_URL.replace("https://", "")}/api/v2/test`,
{
on: vi.fn((event: string, handler: (e: unknown) => void) => {
if (event === "error") {
setImmediate(() => {
handler({
error: new Error("404 Not Found"),
message: "404 Not Found",
});
});
}
return mockWs as Ws;
}),
},
);
setupWebSocketMock(mockWs);
const connection = await api.watchAgentMetadata(AGENT_ID);
// Returns ReconnectingWebSocket (which wraps SSE internally after WS 404)
expect(connection).toBeInstanceOf(ReconnectingWebSocket);
expect(EventSource).toHaveBeenCalled();
});
it("handles non-404 errors without SSE fallback", async () => {
vi.mocked(Ws).mockImplementation(function () {
throw new Error("Network error");
});
// Non-404 errors are handled by ReconnectingWebSocket internally
// (schedules reconnect with backoff) instead of being thrown
const connection = await api.watchAgentMetadata(AGENT_ID);
expect(connection).toBeInstanceOf(ReconnectingWebSocket);
expect(EventSource).not.toHaveBeenCalled();
connection.close();
});
describe("reconnection after fallback", () => {
beforeEach(() => vi.useFakeTimers({ shouldAdvanceTime: true }));
afterEach(() => vi.useRealTimers());
it("reconnects after SSE fallback and retries WS on each reconnect", async () => {
let wsAttempts = 0;
const mockEventSources: MockEventSource[] = [];
vi.mocked(Ws).mockImplementation(function () {
wsAttempts++;
const mockWs = createMockWebSocket("wss://test", {
on: vi.fn((event: string, handler: (e: unknown) => void) => {
if (event === "error") {
setImmediate(() =>
handler({ error: new Error("Something 404") }),
);
}
return mockWs as Ws;
}),
});
return mockWs as Ws;
});
vi.mocked(EventSource).mockImplementation(function () {
const es = createMockEventSource(`${CODER_URL}/api/v2/test`);
mockEventSources.push(es);
return es as unknown as EventSource;
});
const connection = await api.watchAgentMetadata(AGENT_ID);
expect(wsAttempts).toBe(1);
expect(EventSource).toHaveBeenCalledTimes(1);
mockEventSources[0].fireError();
await vi.advanceTimersByTimeAsync(300);
expect(wsAttempts).toBe(2);
expect(EventSource).toHaveBeenCalledTimes(2);
connection.close();
});
});
});
const setupAutoOpeningWebSocket = () => {
const sockets: Array<Partial<Ws>> = [];
const handlers: Record<string, (...args: unknown[]) => void> = {};
vi.mocked(Ws).mockImplementation(function (url: string | URL) {
const mockWs = createMockWebSocket(String(url), {
on: vi.fn((event: string, handler: (...args: unknown[]) => void) => {
handlers[event] = handler;
if (event === "open") {
setImmediate(() => handler());
}
return mockWs as Ws;
}),
});
sockets.push(mockWs);
return mockWs as Ws;
});
return { sockets, handlers };
};
describe("Reconnection on Host/Token Changes", () => {
it("triggers reconnection when session token changes", async () => {
const { sockets } = setupAutoOpeningWebSocket();
api = createApi(CODER_URL, AXIOS_TOKEN);
await api.watchAgentMetadata(AGENT_ID);
api.setSessionToken("new-token");
await new Promise((resolve) => setImmediate(resolve));
expect(sockets[0].close).toHaveBeenCalledWith(
1000,
"Replacing connection",
);
expect(sockets).toHaveLength(2);
});
it("triggers reconnection when host changes", async () => {
const { sockets } = setupAutoOpeningWebSocket();
api = createApi(CODER_URL, AXIOS_TOKEN);
const wsWrap = await api.watchAgentMetadata(AGENT_ID);
expect(wsWrap.url).toContain(CODER_URL.replace("http", "ws"));
api.setHost("https://new-coder.example.com");
// Wait for the async reconnect to complete (factory is async)
await new Promise((resolve) => setImmediate(resolve));
expect(sockets[0].close).toHaveBeenCalledWith(
1000,
"Replacing connection",
);
expect(sockets).toHaveLength(2);
// Verify the new socket was created with the correct URL
expect(sockets[1].url).toContain("wss://new-coder.example.com");
});
it("does not reconnect when token or host are unchanged", async () => {
const { sockets } = setupAutoOpeningWebSocket();
api = createApi(CODER_URL, AXIOS_TOKEN);
await api.watchAgentMetadata(AGENT_ID);
// Same values as before
api.setSessionToken(AXIOS_TOKEN);
api.setHost(CODER_URL);
expect(sockets[0].close).not.toHaveBeenCalled();
expect(sockets).toHaveLength(1);
});
it("suspends sockets when host is set to empty string (logout)", async () => {
const { sockets } = setupAutoOpeningWebSocket();
api = createApi(CODER_URL, AXIOS_TOKEN);
await api.watchAgentMetadata(AGENT_ID);
// Setting host to empty string (logout) should suspend (not permanently close)
api.setHost("");
await new Promise((resolve) => setImmediate(resolve));
expect(sockets[0].close).toHaveBeenCalledWith(1000, "Host cleared");
expect(sockets).toHaveLength(1);
});
it("does not reconnect when setting token after clearing host", async () => {
const { sockets } = setupAutoOpeningWebSocket();
api = createApi(CODER_URL, AXIOS_TOKEN);
await api.watchAgentMetadata(AGENT_ID);
api.setHost("");
api.setSessionToken("new-token");
await new Promise((resolve) => setImmediate(resolve));
// Should only have the initial socket - no reconnection after token change
expect(sockets).toHaveLength(1);
expect(sockets[0].close).toHaveBeenCalledWith(1000, "Host cleared");
});
it("setCredentials sets both host and token together", async () => {
const { sockets } = setupAutoOpeningWebSocket();
api = createApi(CODER_URL, AXIOS_TOKEN);
await api.watchAgentMetadata(AGENT_ID);
api.setCredentials("https://new-coder.example.com", "new-token");
await new Promise((resolve) => setImmediate(resolve));
// Should reconnect only once despite both values changing
expect(sockets).toHaveLength(2);
expect(sockets[1].url).toContain("wss://new-coder.example.com");
});
it("setCredentials suspends when host is cleared", async () => {
const { sockets } = setupAutoOpeningWebSocket();
api = createApi(CODER_URL, AXIOS_TOKEN);
await api.watchAgentMetadata(AGENT_ID);
api.setCredentials(undefined, undefined);
await new Promise((resolve) => setImmediate(resolve));
expect(sockets).toHaveLength(1);
expect(sockets[0].close).toHaveBeenCalledWith(1000, "Host cleared");
});
});
describe("Error Handling", () => {
it("throws error when no base URL is set", async () => {
const api = createApi();
api.getAxiosInstance().defaults.baseURL = undefined;
await expect(api.watchBuildLogsByBuildId(BUILD_ID, [])).rejects.toThrow(
"No base URL set on REST client",
);
});
interface WebSocketErrorConversionTestCase {
description: string;
eventMessage: string;
expectedMessage: string;
}
it.each<WebSocketErrorConversionTestCase>([
{
description: "event.message when available",
eventMessage: "Custom error message",
expectedMessage: "Custom error message",
},
{
description: "fallback when event.message is empty",
eventMessage: "",
expectedMessage: "WebSocket connection error",
},
])(
"uses $desc for WebSocket error",
async ({ eventMessage, expectedMessage }) => {
api = createApi();
const mockWs = createMockWebSocket("wss://test", {
on: vi.fn((event: string, handler: (e: unknown) => void) => {
if (event === "error") {
setImmediate(() =>
handler({ error: undefined, message: eventMessage }),
);
}
return mockWs as Ws;
}),
});
setupWebSocketMock(mockWs);
await expect(api.watchBuildLogsByBuildId(BUILD_ID, [])).rejects.toThrow(
expectedMessage,
);
},
);
});
describe("getHost/getSessionToken", () => {
it("returns current host and token", () => {
const api = createApi(CODER_URL, AXIOS_TOKEN);
expect(api.getHost()).toBe(CODER_URL);
expect(api.getSessionToken()).toBe(AXIOS_TOKEN);
});
});
describe("dispose", () => {
it("disposes all tracked reconnecting sockets", async () => {
const sockets: Array<Partial<Ws>> = [];
vi.mocked(Ws).mockImplementation(function (url: string | URL) {
const mockWs = createMockWebSocket(String(url), {
on: vi.fn((event, handler) => {
if (event === "open") {
setImmediate(() => handler());
}
return mockWs as Ws;
}),
});
sockets.push(mockWs);
return mockWs as Ws;
});
api = createApi(CODER_URL, AXIOS_TOKEN);
await api.watchAgentMetadata(AGENT_ID);
expect(sockets).toHaveLength(1);
api.dispose();
// Socket should be closed
expect(sockets[0].close).toHaveBeenCalled();
});
});
describe("Configuration Change Reconnection", () => {
const tick = () => new Promise((resolve) => setImmediate(resolve));
it("does not reconnect connected sockets when config value changes", async () => {
mockConfig.set("coder.insecure", false);
const { sockets } = setupAutoOpeningWebSocket();
api = createApi(CODER_URL, AXIOS_TOKEN);
await api.watchAgentMetadata(AGENT_ID);
await tick(); // Wait for open event to fire (socket becomes CONNECTED)
mockConfig.set("coder.insecure", true);
await tick();
expect(sockets[0].close).not.toHaveBeenCalled();
expect(sockets).toHaveLength(1);
});
it.each([
["unchanged value", "coder.insecure", false],
["unrelated setting", "unrelated.setting", "new-value"],
])("does not reconnect for %s", async (_desc, key, value) => {
mockConfig.set("coder.insecure", false);
const { sockets } = setupAutoOpeningWebSocket();
api = createApi(CODER_URL, AXIOS_TOKEN);
await api.watchAgentMetadata(AGENT_ID);
await tick(); // Wait for open event to fire (socket becomes CONNECTED)
mockConfig.set(key, value);
await tick();
expect(sockets[0].close).not.toHaveBeenCalled();
expect(sockets).toHaveLength(1);
});
it("stops watching after dispose", async () => {
mockConfig.set("coder.insecure", false);
const { sockets } = setupAutoOpeningWebSocket();
api = createApi(CODER_URL, AXIOS_TOKEN);
await api.watchAgentMetadata(AGENT_ID);
await tick(); // Wait for open event to fire (socket becomes CONNECTED)
api.dispose();
mockConfig.set("coder.insecure", true);
await tick();
expect(sockets).toHaveLength(1);
});
it("does not reconnect sockets in AWAITING_RETRY state when config changes", async () => {
mockConfig.set("coder.insecure", false);
const { sockets, handlers } = setupAutoOpeningWebSocket();
api = createApi(CODER_URL, AXIOS_TOKEN);
await api.watchAgentMetadata(AGENT_ID);
// Trigger close with abnormal code to put socket in AWAITING_RETRY
handlers["close"]?.({ code: 1006, reason: "Abnormal closure" });
await tick();
mockConfig.set("coder.insecure", true);
await tick();
// AWAITING_RETRY will naturally retry, so no config-triggered reconnect needed
expect(sockets).toHaveLength(1);
});
it("reconnects sockets in DISCONNECTED state when config changes", async () => {
mockConfig.set("coder.insecure", false);
const { sockets, handlers } = setupAutoOpeningWebSocket();
api = createApi(CODER_URL, AXIOS_TOKEN);
await api.watchAgentMetadata(AGENT_ID);
await tick();
// Trigger close with unrecoverable code to put socket in DISCONNECTED
handlers["close"]?.({ code: 1002, reason: "Protocol error" });
await tick();
mockConfig.set("coder.insecure", true);
await tick();
// Only DISCONNECTED sockets get reconnected by config changes
expect(sockets).toHaveLength(2);
});
});
});
const mockAdapterImpl = vi.hoisted(
() => (config: InternalAxiosRequestConfig) => {
return Promise.resolve({
data: config.data || "{}",
status: 200,
statusText: "OK",
headers: {},
config,
});
},
);
function createMockWebSocket(
url: string,
overrides?: Partial<Ws>,
): Partial<Ws> {
return {
url,
on: vi.fn(),
off: vi.fn(),
close: vi.fn(),
...overrides,
};
}
type MockEventSource = Partial<EventSource> & {
readyState: number;
fireOpen: () => void;
fireError: () => void;
};
function createMockEventSource(url: string): MockEventSource {
const handlers: Record<string, ((e: Event) => void) | undefined> = {};
const mock: MockEventSource = {
url,
readyState: EventSource.CONNECTING,
addEventListener: vi.fn((event: string, handler: (e: Event) => void) => {
handlers[event] = handler;
if (event === "open") {
setImmediate(() => handler(new Event("open")));
}
}),
removeEventListener: vi.fn(),
close: vi.fn(),
fireOpen: () => handlers.open?.(new Event("open")),
fireError: () => {
mock.readyState = EventSource.CLOSED;
handlers.error?.(new Event("error"));
},
};
return mock;
}
function setupWebSocketMock(ws: Partial<Ws>): void {
vi.mocked(Ws).mockImplementation(function () {
return ws as Ws;
});
}
function setupEventSourceMock(es: Partial<EventSource>): void {
vi.mocked(EventSource).mockImplementation(function () {
return es as EventSource;
});
}