-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Expand file tree
/
Copy pathsession_test.rs
More file actions
4162 lines (3680 loc) · 136 KB
/
session_test.rs
File metadata and controls
4162 lines (3680 loc) · 136 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
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#![allow(clippy::unwrap_used)]
use std::path::Path;
use std::sync::Arc;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::time::Duration;
use async_trait::async_trait;
use github_copilot_sdk::canvas::{CanvasDeclaration, CanvasHandler, CanvasResult};
use github_copilot_sdk::generated::api_types::{
CanvasInstanceAvailability, CanvasProviderInvokeActionRequest, CanvasProviderOpenRequest,
CanvasProviderOpenResult, OpenCanvasInstance,
};
use github_copilot_sdk::generated::session_events::ReasoningSummary;
use github_copilot_sdk::handler::{
ApproveAllHandler, AutoModeSwitchHandler, AutoModeSwitchResponse, ElicitationHandler,
ExitPlanModeHandler, ExitPlanModeResult, UserInputHandler, UserInputResponse,
};
use github_copilot_sdk::types::{
CommandContext, CommandDefinition, CommandHandler, DeliveryMode, ElicitationRequest,
ElicitationResult, ExitPlanModeData, ExtensionInfo, MessageOptions, RequestId, SessionConfig,
SessionId, SetModelOptions, Tool, ToolInvocation, ToolResult,
};
use github_copilot_sdk::{Client, tool};
use serde_json::Value;
use tokio::io::{AsyncWrite, AsyncWriteExt, duplex};
use tokio::time::timeout;
const TIMEOUT: Duration = Duration::from_secs(2);
struct TestCanvasHandler;
#[async_trait]
impl CanvasHandler for TestCanvasHandler {
async fn on_open(
&self,
ctx: CanvasProviderOpenRequest,
) -> CanvasResult<CanvasProviderOpenResult> {
Ok(CanvasProviderOpenResult {
url: Some(format!("https://example.test/{}", ctx.canvas_id)),
title: Some("Test Canvas".to_string()),
status: Some("ready".to_string()),
})
}
async fn on_action(&self, ctx: CanvasProviderInvokeActionRequest) -> CanvasResult<Value> {
Ok(serde_json::json!({
"actionName": ctx.action_name,
"input": ctx.input,
}))
}
}
fn test_canvas(id: &str) -> CanvasDeclaration {
CanvasDeclaration::new(id, "Test Canvas", "Test canvas description")
}
fn test_canvas_handler() -> Arc<dyn CanvasHandler> {
Arc::new(TestCanvasHandler)
}
async fn write_framed(writer: &mut (impl AsyncWrite + Unpin), body: &[u8]) {
let header = format!("Content-Length: {}\r\n\r\n", body.len());
writer.write_all(header.as_bytes()).await.unwrap();
writer.write_all(body).await.unwrap();
writer.flush().await.unwrap();
}
async fn read_framed(reader: &mut (impl tokio::io::AsyncRead + Unpin)) -> Value {
let mut header = String::new();
loop {
let mut byte = [0u8; 1];
tokio::io::AsyncReadExt::read_exact(reader, &mut byte)
.await
.unwrap();
header.push(byte[0] as char);
if header.ends_with("\r\n\r\n") {
break;
}
}
let length: usize = header
.trim()
.strip_prefix("Content-Length: ")
.unwrap()
.parse()
.unwrap();
let mut buf = vec![0u8; length];
tokio::io::AsyncReadExt::read_exact(reader, &mut buf)
.await
.unwrap();
serde_json::from_slice(&buf).unwrap()
}
fn make_client() -> (Client, tokio::io::DuplexStream, tokio::io::DuplexStream) {
let (client_write, server_read) = duplex(8192);
let (server_write, client_read) = duplex(8192);
let client = Client::from_streams(client_read, client_write, std::env::temp_dir()).unwrap();
(client, server_read, server_write)
}
struct FakeServer {
read: tokio::io::DuplexStream,
write: tokio::io::DuplexStream,
session_id: String,
}
impl FakeServer {
async fn read_request(&mut self) -> Value {
read_framed(&mut self.read).await
}
async fn respond(&mut self, request: &Value, result: Value) {
let id = request["id"].as_u64().unwrap();
let response = serde_json::json!({ "jsonrpc": "2.0", "id": id, "result": result });
write_framed(&mut self.write, &serde_json::to_vec(&response).unwrap()).await;
}
async fn send_notification(&mut self, method: &str, params: Value) {
let notification = serde_json::json!({
"jsonrpc": "2.0",
"method": method,
"params": params,
});
write_framed(&mut self.write, &serde_json::to_vec(¬ification).unwrap()).await;
}
async fn send_event(&mut self, event_type: &str, data: Value) {
self.send_notification(
"session.event",
serde_json::json!({
"sessionId": self.session_id,
"event": {
"id": format!("evt-{}", rand_id()),
"timestamp": "2025-01-01T00:00:00Z",
"type": event_type,
"data": data,
},
}),
)
.await;
}
async fn send_request(&mut self, id: u64, method: &str, params: Value) {
let request = serde_json::json!({
"jsonrpc": "2.0",
"id": id,
"method": method,
"params": params,
});
write_framed(&mut self.write, &serde_json::to_vec(&request).unwrap()).await;
}
async fn read_response(&mut self) -> Value {
read_framed(&mut self.read).await
}
}
async fn create_session_pair() -> (github_copilot_sdk::session::Session, FakeServer) {
create_session_pair_with_config(|cfg| cfg).await
}
async fn create_session_pair_with_capabilities(
capabilities: Value,
) -> (github_copilot_sdk::session::Session, FakeServer) {
create_session_pair_inner(|cfg| cfg, capabilities).await
}
async fn create_session_pair_with_config<F>(
configure: F,
) -> (github_copilot_sdk::session::Session, FakeServer)
where
F: FnOnce(SessionConfig) -> SessionConfig + Send + 'static,
{
create_session_pair_inner(configure, serde_json::json!(null)).await
}
async fn create_session_pair_inner<F>(
configure: F,
capabilities: Value,
) -> (github_copilot_sdk::session::Session, FakeServer)
where
F: FnOnce(SessionConfig) -> SessionConfig + Send + 'static,
{
let (client, server_read, server_write) = make_client();
let mut server = FakeServer {
read: server_read,
write: server_write,
session_id: String::new(),
};
let create_handle = tokio::spawn({
let client = client.clone();
async move {
client
.create_session(configure(SessionConfig::default()))
.await
.unwrap()
}
});
let create_req = server.read_request().await;
assert_eq!(create_req["method"], "session.create");
server.session_id = requested_session_id(&create_req).to_string();
let mut result = serde_json::json!({
"sessionId": server.session_id.clone(),
"workspacePath": "/tmp/workspace"
});
if !capabilities.is_null() {
result["capabilities"] = capabilities;
}
server.respond(&create_req, result).await;
let session = timeout(TIMEOUT, create_handle).await.unwrap().unwrap();
(session, server)
}
fn rand_id() -> u64 {
static COUNTER: AtomicUsize = AtomicUsize::new(0);
COUNTER.fetch_add(1, Ordering::Relaxed) as u64
}
fn requested_session_id(request: &Value) -> &str {
request["params"]["sessionId"]
.as_str()
.expect("session request should include sessionId")
}
#[tokio::test]
async fn session_subscribe_yields_events_observe_only() {
let (session, mut server) = create_session_pair().await;
let mut events = session.subscribe();
let count = Arc::new(AtomicUsize::new(0));
let last_type = Arc::new(parking_lot::Mutex::new(String::new()));
let count_clone = count.clone();
let last_type_clone = last_type.clone();
let consumer = tokio::spawn(async move {
while let Ok(event) = events.recv().await {
count_clone.fetch_add(1, Ordering::Relaxed);
*last_type_clone.lock() = event.event_type.clone();
}
});
server.send_event("noop.event", serde_json::json!({})).await;
server
.send_event("another.event", serde_json::json!({"k": "v"}))
.await;
for _ in 0..50 {
if count.load(Ordering::Relaxed) >= 2 {
break;
}
tokio::time::sleep(Duration::from_millis(20)).await;
}
assert_eq!(count.load(Ordering::Relaxed), 2);
assert_eq!(last_type.lock().as_str(), "another.event");
consumer.abort();
}
#[tokio::test]
async fn session_subscribe_drop_stops_delivery() {
let (session, mut server) = create_session_pair().await;
let mut events = session.subscribe();
let count = Arc::new(AtomicUsize::new(0));
let count_clone = count.clone();
let consumer = tokio::spawn(async move {
while let Ok(_event) = events.recv().await {
count_clone.fetch_add(1, Ordering::Relaxed);
}
});
server.send_event("first", serde_json::json!({})).await;
for _ in 0..50 {
if count.load(Ordering::Relaxed) >= 1 {
break;
}
tokio::time::sleep(Duration::from_millis(20)).await;
}
assert_eq!(count.load(Ordering::Relaxed), 1);
// Aborting the consumer drops its receiver; further events have no
// effect on the (now-zero) subscriber count.
consumer.abort();
tokio::time::sleep(Duration::from_millis(20)).await;
server.send_event("second", serde_json::json!({})).await;
tokio::time::sleep(Duration::from_millis(100)).await;
assert_eq!(count.load(Ordering::Relaxed), 1);
}
#[tokio::test]
async fn create_session_sends_correct_rpc() {
let (client, mut server_read, mut server_write) = make_client();
let create_handle = tokio::spawn({
let client = client.clone();
async move {
client
.create_session({
let mut cfg = SessionConfig::default();
cfg.model = Some("gpt-4".to_string());
cfg
})
.await
.unwrap()
}
});
let request = read_framed(&mut server_read).await;
assert_eq!(request["method"], "session.create");
assert_eq!(request["params"]["model"], "gpt-4");
let id = request["id"].as_u64().unwrap();
let session_id = requested_session_id(&request).to_string();
let response = serde_json::json!({
"jsonrpc": "2.0",
"id": id,
"result": { "sessionId": session_id.clone(), "workspacePath": "/ws" },
});
write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await;
let session = timeout(TIMEOUT, create_handle).await.unwrap().unwrap();
assert_eq!(session.id(), session_id.as_str());
assert_eq!(session.workspace_path(), Some(Path::new("/ws")));
}
#[tokio::test]
async fn create_session_sends_canvas_wire_fields() {
let (client, mut server_read, mut server_write) = make_client();
let create_handle = tokio::spawn({
let client = client.clone();
async move {
client
.create_session(
SessionConfig::default()
.with_canvases([test_canvas("counter")])
.with_request_canvas_renderer(true)
.with_request_extensions(true)
.with_extension_info(ExtensionInfo::new("github-app", "counter-provider")),
)
.await
.unwrap()
}
});
let request = read_framed(&mut server_read).await;
assert_eq!(request["method"], "session.create");
assert_eq!(request["params"]["canvases"][0]["id"], "counter");
assert_eq!(
request["params"]["canvases"][0]["displayName"],
"Test Canvas"
);
assert_eq!(request["params"]["requestCanvasRenderer"], true);
assert_eq!(request["params"]["requestExtensions"], true);
assert_eq!(request["params"]["extensionInfo"]["source"], "github-app");
assert_eq!(
request["params"]["extensionInfo"]["name"],
"counter-provider"
);
let id = request["id"].as_u64().unwrap();
let session_id = requested_session_id(&request).to_string();
let response = serde_json::json!({
"jsonrpc": "2.0",
"id": id,
"result": { "sessionId": session_id },
});
write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await;
timeout(TIMEOUT, create_handle).await.unwrap().unwrap();
}
#[tokio::test]
async fn provider_canvas_dispatch_routes_direct_canvas_action_requests() {
let (session, mut server) = create_session_pair_with_config(|cfg| {
cfg.with_canvases([test_canvas("counter")])
.with_canvas_handler(test_canvas_handler())
})
.await;
server
.send_request(
42,
"canvas.action.invoke",
serde_json::json!({
"sessionId": session.id(),
"extensionId": "project:counter",
"canvasId": "counter",
"instanceId": "counter-1",
"actionName": "increment",
"input": { "amount": 1 }
}),
)
.await;
let response = timeout(TIMEOUT, server.read_response()).await.unwrap();
assert_eq!(response["id"], 42);
assert_eq!(response["result"]["actionName"], "increment");
assert_eq!(response["result"]["input"]["amount"], 1);
}
#[tokio::test]
async fn send_injects_session_id() {
let (session, mut server) = create_session_pair().await;
let session = Arc::new(session);
let handle = tokio::spawn({
let session = session.clone();
async move {
session
.send(MessageOptions::new("hello").with_mode(DeliveryMode::Immediate))
.await
}
});
let request = server.read_request().await;
assert_eq!(request["method"], "session.send");
assert_eq!(request["params"]["sessionId"], server.session_id);
assert_eq!(request["params"]["prompt"], "hello");
assert_eq!(request["params"]["mode"], "immediate");
server.respond(&request, serde_json::json!({})).await;
timeout(TIMEOUT, handle).await.unwrap().unwrap().unwrap();
}
#[tokio::test]
async fn send_serializes_request_headers() {
use std::collections::HashMap;
let (session, mut server) = create_session_pair().await;
let session = Arc::new(session);
let handle = tokio::spawn({
let session = session.clone();
async move {
let mut headers = HashMap::new();
headers.insert("X-Custom-Tag".to_string(), "value-1".to_string());
headers.insert("Authorization".to_string(), "Bearer abc".to_string());
session
.send(MessageOptions::new("hi").with_request_headers(headers))
.await
}
});
let request = server.read_request().await;
assert_eq!(request["method"], "session.send");
assert_eq!(request["params"]["prompt"], "hi");
let headers = request["params"]["requestHeaders"]
.as_object()
.expect("requestHeaders should be an object");
assert_eq!(headers["X-Custom-Tag"], "value-1");
assert_eq!(headers["Authorization"], "Bearer abc");
assert_eq!(headers.len(), 2);
server.respond(&request, serde_json::json!({})).await;
timeout(TIMEOUT, handle).await.unwrap().unwrap().unwrap();
}
#[tokio::test]
async fn send_omits_request_headers_when_unset_or_empty() {
use std::collections::HashMap;
let (session, mut server) = create_session_pair().await;
let session = Arc::new(session);
let handle = tokio::spawn({
let session = session.clone();
async move { session.send(MessageOptions::new("plain")).await }
});
let request = server.read_request().await;
assert!(
request["params"].get("requestHeaders").is_none(),
"requestHeaders should be omitted when unset, got: {}",
request["params"]
);
server.respond(&request, serde_json::json!({})).await;
timeout(TIMEOUT, handle).await.unwrap().unwrap().unwrap();
let handle = tokio::spawn({
let session = session.clone();
async move {
session
.send(MessageOptions::new("plain").with_request_headers(HashMap::new()))
.await
}
});
let request = server.read_request().await;
assert!(
request["params"].get("requestHeaders").is_none(),
"requestHeaders should be omitted for empty map, got: {}",
request["params"]
);
server.respond(&request, serde_json::json!({})).await;
timeout(TIMEOUT, handle).await.unwrap().unwrap().unwrap();
}
#[tokio::test]
async fn send_serializes_display_prompt() {
let (session, mut server) = create_session_pair().await;
let session = Arc::new(session);
let handle = tokio::spawn({
let session = session.clone();
async move {
session
.send(MessageOptions::new("hi").with_display_prompt("Show this to user"))
.await
}
});
let request = server.read_request().await;
assert_eq!(request["method"], "session.send");
assert_eq!(request["params"]["prompt"], "hi");
assert_eq!(request["params"]["displayPrompt"], "Show this to user");
server.respond(&request, serde_json::json!({})).await;
timeout(TIMEOUT, handle).await.unwrap().unwrap().unwrap();
}
#[tokio::test]
async fn send_omits_display_prompt_when_unset() {
let (session, mut server) = create_session_pair().await;
let session = Arc::new(session);
let handle = tokio::spawn({
let session = session.clone();
async move { session.send(MessageOptions::new("plain")).await }
});
let request = server.read_request().await;
assert!(
request["params"].get("displayPrompt").is_none(),
"displayPrompt should be omitted when unset, got: {}",
request["params"]
);
server.respond(&request, serde_json::json!({})).await;
timeout(TIMEOUT, handle).await.unwrap().unwrap().unwrap();
}
#[tokio::test]
async fn session_rpc_methods_send_correct_method_names() {
let (session, mut server) = create_session_pair().await;
let session = Arc::new(session);
let cases: Vec<(&str, Option<&str>)> = vec![
("session.abort", None),
("session.log", Some("message")),
("session.destroy", None),
];
for (expected_method, extra_param_key) in cases {
let s = session.clone();
let handle = tokio::spawn(async move {
match expected_method {
"session.abort" => s.abort().await.map(|_| ()),
"session.log" => s.log("test msg", None).await,
"session.destroy" => s.disconnect().await,
_ => unreachable!(),
}
});
let request = server.read_request().await;
assert_eq!(
request["method"], expected_method,
"wrong method for {expected_method}"
);
assert_eq!(request["params"]["sessionId"], server.session_id);
if let Some(key) = extra_param_key {
assert!(!request["params"][key].is_null(), "missing param {key}");
}
let response = match expected_method {
"session.log" => {
serde_json::json!({ "eventId": "00000000-0000-0000-0000-000000000000" })
}
_ => serde_json::json!({}),
};
server.respond(&request, response).await;
timeout(TIMEOUT, handle).await.unwrap().unwrap().unwrap();
}
}
#[tokio::test]
async fn client_rpc_methods_send_correct_method_names() {
let (client, mut server_read, mut server_write) = make_client();
// Wire method names per the CLI runtime registration in @github/copilot
// app.js — verified against Node/Go/Python/.NET SDK call sites which all
// use these exact strings. The schema doesn't currently define these as
// typed RPCs (top-level methods, not under any namespace), so call site
// strings are the source of truth.
for expected_method in ["status.get", "auth.getStatus"] {
let c = client.clone();
let handle = tokio::spawn(async move {
match expected_method {
"status.get" => c.get_status().await.map(|_| ()),
"auth.getStatus" => c.get_auth_status().await.map(|_| ()),
_ => unreachable!(),
}
});
let request = read_framed(&mut server_read).await;
assert_eq!(request["method"], expected_method);
// Regression-prevention: must not have reverted to the
// hand-authored `getStatus` / `getAuthStatus` names that don't
// exist on the wire.
assert_ne!(request["method"], "getStatus");
assert_ne!(request["method"], "getAuthStatus");
let id = request["id"].as_u64().unwrap();
let result = match expected_method {
"status.get" => serde_json::json!({ "version": "1.0.0", "protocolVersion": 1 }),
"auth.getStatus" => serde_json::json!({ "isAuthenticated": true }),
_ => unreachable!(),
};
let resp = serde_json::json!({ "jsonrpc": "2.0", "id": id, "result": result });
write_framed(&mut server_write, &serde_json::to_vec(&resp).unwrap()).await;
timeout(TIMEOUT, handle).await.unwrap().unwrap().unwrap();
}
}
#[tokio::test]
async fn list_sessions_returns_typed_metadata() {
let (client, mut server_read, mut server_write) = make_client();
let handle = tokio::spawn({
let client = client.clone();
async move { client.list_sessions(None).await.unwrap() }
});
let request = read_framed(&mut server_read).await;
assert_eq!(request["method"], "session.list");
let id = request["id"].as_u64().unwrap();
let response = serde_json::json!({
"jsonrpc": "2.0",
"id": id,
"result": {
"sessions": [{
"sessionId": "s1",
"startTime": "2025-01-01T00:00:00Z",
"modifiedTime": "2025-01-01T01:00:00Z",
"summary": "test session",
"isRemote": false,
}]
},
});
write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await;
let sessions = timeout(TIMEOUT, handle).await.unwrap().unwrap();
assert_eq!(sessions.len(), 1);
assert_eq!(sessions[0].session_id, "s1");
assert_eq!(sessions[0].summary, Some("test session".to_string()));
}
#[tokio::test]
async fn list_sessions_serializes_typed_filter() {
use github_copilot_sdk::SessionListFilter;
let (client, mut server_read, mut server_write) = make_client();
let filter = SessionListFilter {
repository: Some("octocat/hello".to_string()),
branch: Some("main".to_string()),
..Default::default()
};
let handle = tokio::spawn({
let client = client.clone();
async move { client.list_sessions(Some(filter)).await.unwrap() }
});
let request = read_framed(&mut server_read).await;
assert_eq!(request["method"], "session.list");
assert_eq!(request["params"]["filter"]["repository"], "octocat/hello");
assert_eq!(request["params"]["filter"]["branch"], "main");
// cwd / gitRoot are None and must be omitted from the filter object.
assert!(request["params"]["filter"].get("cwd").is_none());
assert!(request["params"]["filter"].get("gitRoot").is_none());
// Regression check: filter must be wrapped under `params.filter`, not
// flattened onto `params` directly. All other SDKs (Node/Python/Go/.NET)
// wrap; flattening is silently ignored by the runtime.
assert!(
request["params"].get("repository").is_none(),
"wire shape is `params.filter.*`, not `params.*` — see Node/Go/Python/.NET"
);
let id = request["id"].as_u64().unwrap();
let response = serde_json::json!({
"jsonrpc": "2.0",
"id": id,
"result": { "sessions": [] },
});
write_framed(&mut server_write, &serde_json::to_vec(&response).unwrap()).await;
timeout(TIMEOUT, handle).await.unwrap().unwrap();
}
#[test]
fn mcp_server_config_roundtrips_through_tagged_enum() {
use std::collections::HashMap;
use github_copilot_sdk::{McpServerConfig, McpStdioServerConfig};
let stdio = McpServerConfig::Stdio(McpStdioServerConfig {
command: "node".to_string(),
args: vec!["server.js".to_string()],
env: HashMap::new(),
working_directory: None,
tools: Some(vec!["*".to_string()]),
timeout: None,
});
let json = serde_json::to_value(&stdio).unwrap();
assert_eq!(json["type"], "stdio");
assert_eq!(json["command"], "node");
// CLI may emit the legacy "local" alias; we accept it on the wire.
let local: McpServerConfig = serde_json::from_value(serde_json::json!({
"type": "local",
"command": "node",
}))
.unwrap();
assert!(matches!(local, McpServerConfig::Stdio(_)));
// SessionConfig.mcp_servers round-trips a typed map.
let mut servers = HashMap::new();
servers.insert("github".to_string(), stdio.clone());
let cfg_json = serde_json::to_value(&servers).unwrap();
assert_eq!(cfg_json["github"]["type"], "stdio");
}
#[test]
fn mcp_stdio_tools_tri_state_serializes_correctly() {
use github_copilot_sdk::McpStdioServerConfig;
// None → field omitted (= "expose all tools")
let cfg = McpStdioServerConfig {
command: "echo".into(),
tools: None,
..Default::default()
};
let json = serde_json::to_value(&cfg).unwrap();
assert!(
json.get("tools").is_none(),
"tools=None must be omitted on the wire; got {json}"
);
// Some(empty) → field present as []
let cfg = McpStdioServerConfig {
command: "echo".into(),
tools: Some(vec![]),
..Default::default()
};
let json = serde_json::to_value(&cfg).unwrap();
assert_eq!(json["tools"], serde_json::json!([]));
// Some(non-empty) → field present as the explicit list
let cfg = McpStdioServerConfig {
command: "echo".into(),
tools: Some(vec!["a".into(), "b".into()]),
..Default::default()
};
let json = serde_json::to_value(&cfg).unwrap();
assert_eq!(json["tools"], serde_json::json!(["a", "b"]));
}
#[test]
fn mcp_stdio_tools_tri_state_deserializes_correctly() {
use github_copilot_sdk::McpStdioServerConfig;
// Missing field → None
let cfg: McpStdioServerConfig =
serde_json::from_value(serde_json::json!({ "command": "echo" })).unwrap();
assert_eq!(cfg.tools, None);
// Empty list → Some(empty)
let cfg: McpStdioServerConfig =
serde_json::from_value(serde_json::json!({ "command": "echo", "tools": [] })).unwrap();
assert_eq!(cfg.tools, Some(vec![]));
// Non-empty list → Some(list)
let cfg: McpStdioServerConfig =
serde_json::from_value(serde_json::json!({ "command": "echo", "tools": ["x"] })).unwrap();
assert_eq!(cfg.tools, Some(vec!["x".to_string()]));
}
#[test]
fn mcp_http_tools_tri_state_serializes_correctly() {
use github_copilot_sdk::McpHttpServerConfig;
let cfg = McpHttpServerConfig {
url: "https://example.com".into(),
tools: None,
..Default::default()
};
assert!(
serde_json::to_value(&cfg).unwrap().get("tools").is_none(),
"tools=None must be omitted on the wire"
);
let cfg = McpHttpServerConfig {
url: "https://example.com".into(),
tools: Some(vec![]),
..Default::default()
};
assert_eq!(
serde_json::to_value(&cfg).unwrap()["tools"],
serde_json::json!([])
);
let cfg = McpHttpServerConfig {
url: "https://example.com".into(),
tools: Some(vec!["a".into()]),
..Default::default()
};
assert_eq!(
serde_json::to_value(&cfg).unwrap()["tools"],
serde_json::json!(["a"])
);
}
#[test]
fn mcp_http_tools_tri_state_deserializes_correctly() {
use github_copilot_sdk::McpHttpServerConfig;
let cfg: McpHttpServerConfig =
serde_json::from_value(serde_json::json!({ "url": "https://e.com" })).unwrap();
assert_eq!(cfg.tools, None);
let cfg: McpHttpServerConfig =
serde_json::from_value(serde_json::json!({ "url": "https://e.com", "tools": [] })).unwrap();
assert_eq!(cfg.tools, Some(vec![]));
}
#[test]
fn permission_request_data_extracts_typed_kind() {
use github_copilot_sdk::{PermissionRequestData, PermissionRequestKind};
let data: PermissionRequestData = serde_json::from_value(serde_json::json!({
"kind": "shell",
"toolCallId": "t1",
"command": "ls",
}))
.unwrap();
assert_eq!(data.kind, Some(PermissionRequestKind::Shell));
assert_eq!(data.tool_call_id, Some("t1".to_string()));
assert_eq!(data.extra["command"], "ls");
let custom: PermissionRequestData = serde_json::from_value(serde_json::json!({
"kind": "custom-tool",
"toolName": "open_canvas",
"args": {
"extensionId": "github-app:counter-provider",
"canvasId": "counter",
"instanceId": "counter-1"
}
}))
.unwrap();
assert_eq!(custom.kind, Some(PermissionRequestKind::CustomTool));
assert_eq!(custom.extra["toolName"], "open_canvas");
assert_eq!(
custom.extra["args"]["extensionId"],
"github-app:counter-provider"
);
// Unknown kinds fall through to the catch-all variant rather than failing.
let unknown: PermissionRequestData = serde_json::from_value(serde_json::json!({
"kind": "future-permission-type",
}))
.unwrap();
assert_eq!(unknown.kind, Some(PermissionRequestKind::Unknown));
}
#[tokio::test]
async fn force_stop_is_idempotent_with_no_child() {
// Stream-based clients have no child process. force_stop should be a
// no-op and safe to call multiple times.
let (client, _server_read, _server_write) = make_client();
client.force_stop();
client.force_stop();
assert!(client.pid().is_none());
}
#[tokio::test]
async fn stop_is_safe_to_call() {
let (client, _server_read, _server_write) = make_client();
client.stop().await.expect("stop should succeed");
}
#[tokio::test]
async fn lifecycle_subscribe_yields_events_with_filter() {
use github_copilot_sdk::{SessionLifecycleEventMetadata, SessionLifecycleEventType as Type};
let (client, _server_read, mut server_write) = make_client();
let mut all_events = client.subscribe_lifecycle();
let mut foreground_events = client.subscribe_lifecycle();
let wildcard_count = Arc::new(AtomicUsize::new(0));
let foreground_count = Arc::new(AtomicUsize::new(0));
let last_session = Arc::new(parking_lot::Mutex::new(None));
let w_count = wildcard_count.clone();
let w_last = last_session.clone();
let w_consumer = tokio::spawn(async move {
while let Ok(event) = all_events.recv().await {
w_count.fetch_add(1, Ordering::Relaxed);
*w_last.lock() = Some(event.session_id.clone());
}
});
let f_count = foreground_count.clone();
let f_consumer = tokio::spawn(async move {
while let Ok(event) = foreground_events.recv().await {
if event.event_type == Type::Foreground {
f_count.fetch_add(1, Ordering::Relaxed);
}
}
});
let body1 = serde_json::to_vec(&serde_json::json!({
"jsonrpc": "2.0",
"method": "session.lifecycle",
"params": { "type": "session.created", "sessionId": "s1" },
}))
.unwrap();
let body2 = serde_json::to_vec(&serde_json::json!({
"jsonrpc": "2.0",
"method": "session.lifecycle",
"params": {
"type": "session.foreground",
"sessionId": "s2",
"metadata": {
"startTime": "2025-01-01T00:00:00Z",
"modifiedTime": "2025-01-02T00:00:00Z",
"summary": "hello",
},
},
}))
.unwrap();
let body3 = serde_json::to_vec(&serde_json::json!({
"jsonrpc": "2.0",
"method": "session.event",
"params": { "sessionId": "ignored", "event": {
"id": "x", "timestamp": "t", "type": "noop", "data": {}
}},
}))
.unwrap();
write_framed(&mut server_write, &body1).await;
write_framed(&mut server_write, &body2).await;
write_framed(&mut server_write, &body3).await;
for _ in 0..50 {
if wildcard_count.load(Ordering::Relaxed) >= 2 {
break;
}
tokio::time::sleep(Duration::from_millis(20)).await;
}
assert_eq!(wildcard_count.load(Ordering::Relaxed), 2);
assert_eq!(foreground_count.load(Ordering::Relaxed), 1);
assert_eq!(last_session.lock().as_deref(), Some("s2"));
w_consumer.abort();
f_consumer.abort();
let meta = SessionLifecycleEventMetadata {
start_time: "t1".into(),
modified_time: "t2".into(),
summary: Some("s".into()),
};
assert_eq!(meta.summary.as_deref(), Some("s"));
}
#[tokio::test]
async fn lifecycle_subscribe_drop_stops_delivery() {
let (client, _server_read, mut server_write) = make_client();
let mut events = client.subscribe_lifecycle();
let count = Arc::new(AtomicUsize::new(0));
let count_clone = count.clone();
let consumer = tokio::spawn(async move {
while let Ok(_event) = events.recv().await {
count_clone.fetch_add(1, Ordering::Relaxed);
}
});
let lifecycle_body = serde_json::to_vec(&serde_json::json!({
"jsonrpc": "2.0",
"method": "session.lifecycle",
"params": { "type": "session.created", "sessionId": "x" },
}))
.unwrap();
write_framed(&mut server_write, &lifecycle_body).await;
for _ in 0..50 {
if count.load(Ordering::Relaxed) >= 1 {
break;
}
tokio::time::sleep(Duration::from_millis(20)).await;
}
assert_eq!(count.load(Ordering::Relaxed), 1);
consumer.abort();