Repository navigation
Expand file tree
/
Copy pathprepared_session_test.rs
More file actions
1242 lines (1092 loc) · 42.6 KB
/
Copy pathprepared_session_test.rs
File metadata and controls
1242 lines (1092 loc) · 42.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
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
//! Early event subscription via `Client::prepare_session` /
//! `Client::prepare_resume_session`.
//!
//! Every test drives the SDK over an in-memory duplex transport and a
//! hand-rolled JSON-RPC peer, so event ordering is deterministic. Timeouts
//! are failure backstops only — no test sleeps to "let things settle".
#![allow(clippy::unwrap_used)]
use std::marker::PhantomData;
use std::sync::Arc;
use std::time::Duration;
use async_trait::async_trait;
use github_copilot_sdk::handler::{McpAuthHandler, McpAuthRequest, McpAuthResult};
use github_copilot_sdk::session::PreparedSession;
use github_copilot_sdk::subscription::{EventSubscription, RecvErrorKind};
use github_copilot_sdk::types::{
CloudSessionOptions, CloudSessionRepository, RequestId, ResumeSessionConfig, SessionConfig,
SessionId,
};
use github_copilot_sdk::{Client, ErrorKind, SessionErrorKind};
use serde_json::{Value, json};
use tokio::io::{AsyncRead, AsyncWrite, AsyncWriteExt, duplex};
use tokio::time::timeout;
/// Failure backstop for operations that must complete promptly.
const TIMEOUT: Duration = Duration::from_secs(5);
/// Backstop for asserting that something does *not* happen.
const QUIET: Duration = Duration::from_millis(150);
/// Size of the pre-response event burst. Mirrors the copilot-host startup
/// burst that motivated the API.
const BURST: usize = 600;
// ---------------------------------------------------------------------------
// Transport harness
// ---------------------------------------------------------------------------
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 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()
}
struct FakeServer {
read: tokio::io::DuplexStream,
write: tokio::io::DuplexStream,
}
impl FakeServer {
async fn read_request(&mut self) -> Value {
timeout(TIMEOUT, read_framed(&mut self.read)).await.unwrap()
}
async fn expect_quiet(&mut self) {
assert!(
timeout(QUIET, read_framed(&mut self.read)).await.is_err(),
"expected no wire traffic"
);
}
async fn respond(&mut self, request: &Value, result: Value) {
let id = request["id"].as_u64().unwrap();
let response = json!({ "jsonrpc": "2.0", "id": id, "result": result });
write_framed(&mut self.write, &serde_json::to_vec(&response).unwrap()).await;
}
async fn respond_error(&mut self, request: &Value, code: i64, message: &str) {
let id = request["id"].as_u64().unwrap();
let response = json!({
"jsonrpc": "2.0",
"id": id,
"error": { "code": code, "message": message },
});
write_framed(&mut self.write, &serde_json::to_vec(&response).unwrap()).await;
}
async fn send_event(&mut self, session_id: &str, id: &str, event_type: &str, ephemeral: bool) {
let notification = json!({
"jsonrpc": "2.0",
"method": "session.event",
"params": {
"sessionId": session_id,
"event": {
"id": id,
"timestamp": "2025-01-01T00:00:00Z",
"ephemeral": ephemeral,
"type": event_type,
"data": {},
},
},
});
write_framed(&mut self.write, &serde_json::to_vec(¬ification).unwrap()).await;
}
/// Emit the startup burst the host cares about: `BURST` ordered events
/// followed by an ephemeral `session.idle` that `getMessages` could
/// never recover.
async fn send_startup_burst(&mut self, session_id: &str) {
for i in 0..BURST {
self.send_event(
session_id,
&format!("evt-{i}"),
"assistant.message_delta",
false,
)
.await;
}
self.send_event(session_id, "evt-idle", "session.idle", true)
.await;
}
/// Answer the best-effort `session.skills.reload` that follows a resume.
async fn answer_skills_reload(&mut self) {
let request = self.read_request().await;
assert_eq!(request["method"], "session.skills.reload");
self.respond(&request, json!({})).await;
}
}
/// Minimal MCP-auth handler: its presence is what makes the SDK register
/// `mcp.oauth_required` interest after create/resume, which is the branch
/// under test. It is never invoked by these tests.
struct CancelMcpAuthHandler;
#[async_trait]
impl McpAuthHandler for CancelMcpAuthHandler {
async fn handle(
&self,
_session_id: SessionId,
_request_id: RequestId,
_request: McpAuthRequest,
) -> McpAuthResult {
McpAuthResult::Cancelled
}
}
fn make_client() -> (Client, FakeServer) {
let (client_write, server_read) = duplex(1 << 20);
let (server_write, client_read) = duplex(1 << 20);
let client = Client::from_streams(client_read, client_write, std::env::temp_dir()).unwrap();
(
client,
FakeServer {
read: server_read,
write: server_write,
},
)
}
fn cloud_options() -> CloudSessionOptions {
CloudSessionOptions::with_repository(CloudSessionRepository::new("octocat", "hello-world"))
}
fn create_result(session_id: &str) -> Value {
json!({ "sessionId": session_id, "workspacePath": "/tmp/workspace" })
}
/// Collect the startup burst, asserting each event arrives exactly once and
/// in emission order.
async fn expect_startup_burst(events: &mut EventSubscription) {
for i in 0..BURST {
let event = timeout(TIMEOUT, events.recv())
.await
.unwrap_or_else(|_| panic!("timed out waiting for event {i}"))
.unwrap_or_else(|error| panic!("event {i} not delivered: {error}"));
assert_eq!(event.id.as_str(), format!("evt-{i}"), "out-of-order event");
}
let idle = timeout(TIMEOUT, events.recv()).await.unwrap().unwrap();
assert_eq!(idle.id.as_str(), "evt-idle");
assert_eq!(idle.event_type, "session.idle");
assert_eq!(idle.ephemeral, Some(true));
}
/// Unwrap the error arm of a result whose `Ok` type is not `Debug`.
fn expect_error<T>(result: Result<T, github_copilot_sdk::Error>) -> github_copilot_sdk::Error {
match result {
Ok(_) => panic!("expected an error"),
Err(error) => error,
}
}
/// Assert the router holds exactly one registration, and that it is
/// `session_id`.
///
/// The failure message is a fixed string: session IDs are never written to
/// test output.
fn assert_only_registration(client: &Client, session_id: &SessionId, context: &str) {
let registered = client.registered_session_ids_for_test();
let matches_expected = registered.len() == 1 && registered[0] == *session_id;
assert!(matches_expected, "{context}");
}
/// Poll (bounded) until the client's router has no registered sessions.
///
/// Diagnostics report how many registrations are outstanding rather than
/// which ones: session IDs are not written to test output.
async fn await_no_registrations(client: &Client) {
let deadline = tokio::time::Instant::now() + TIMEOUT;
loop {
let outstanding = client.registered_session_count_for_test();
if outstanding == 0 {
return;
}
assert!(
tokio::time::Instant::now() < deadline,
"{outstanding} session registration(s) were never cleaned up"
);
tokio::task::yield_now().await;
}
}
/// Assert the subscription is closed (producer gone), tolerating any events
/// buffered before the close.
async fn expect_closed(events: &mut EventSubscription) {
loop {
match timeout(TIMEOUT, events.recv()).await.unwrap() {
Ok(_) => continue,
Err(error) => {
assert!(
matches!(error.kind(), RecvErrorKind::Closed),
"expected Closed, got {:?}",
error.kind()
);
return;
}
}
}
}
// ---------------------------------------------------------------------------
// 1 + 4. Loss-free startup events on create
// ---------------------------------------------------------------------------
/// Subscription installed before `start()` is polled, drained concurrently:
/// the full pre-response burst plus the ephemeral `session.idle` arrives.
#[tokio::test]
async fn prepared_create_delivers_pre_response_burst_to_concurrent_drain() {
let (client, mut server) = make_client();
let session_id = SessionId::new("prepared-create-concurrent");
let prepared = client
.prepare_session(
SessionConfig::default()
.with_session_id(session_id.clone())
.with_event_buffer_capacity(2048),
)
.unwrap();
let mut events = prepared.subscribe();
let drain = tokio::spawn(async move {
expect_startup_burst(&mut events).await;
});
let start = tokio::spawn(prepared.start());
let create_req = server.read_request().await;
assert_eq!(create_req["method"], "session.create");
server.send_startup_burst(session_id.as_str()).await;
server
.respond(&create_req, create_result(session_id.as_str()))
.await;
let session = timeout(TIMEOUT, start).await.unwrap().unwrap().unwrap();
timeout(TIMEOUT, drain).await.unwrap().unwrap();
drop(session);
}
/// A large configured buffer retains the whole burst even when the consumer
/// does not read anything until `start()` has returned.
#[tokio::test]
async fn prepared_create_retains_burst_for_deferred_consumer() {
let (client, mut server) = make_client();
let session_id = SessionId::new("prepared-create-deferred");
let prepared = client
.prepare_session(
SessionConfig::default()
.with_session_id(session_id.clone())
.with_event_buffer_capacity(2048),
)
.unwrap();
let mut events = prepared.subscribe();
let start = tokio::spawn(prepared.start());
let create_req = server.read_request().await;
server.send_startup_burst(session_id.as_str()).await;
server
.respond(&create_req, create_result(session_id.as_str()))
.await;
let session = timeout(TIMEOUT, start).await.unwrap().unwrap().unwrap();
// Only now does the consumer start reading.
expect_startup_burst(&mut events).await;
drop(session);
}
// ---------------------------------------------------------------------------
// 2. Loss-free startup events on resume
// ---------------------------------------------------------------------------
#[tokio::test]
async fn prepared_resume_delivers_pre_response_burst() {
let (client, mut server) = make_client();
let session_id = SessionId::new("prepared-resume");
let prepared = client
.prepare_resume_session(
ResumeSessionConfig::new(session_id.clone())
.with_continue_pending_work(true)
.with_event_buffer_capacity(2048),
)
.unwrap();
let mut events = prepared.subscribe();
let start = tokio::spawn(prepared.start());
let resume_req = server.read_request().await;
assert_eq!(resume_req["method"], "session.resume");
assert_eq!(resume_req["params"]["continuePendingWork"], true);
server.send_startup_burst(session_id.as_str()).await;
server
.respond(&resume_req, json!({ "sessionId": session_id.as_str() }))
.await;
server.answer_skills_reload().await;
let session = timeout(TIMEOUT, start).await.unwrap().unwrap().unwrap();
expect_startup_burst(&mut events).await;
drop(session);
}
// ---------------------------------------------------------------------------
// 3. Lag is observable, never silent
// ---------------------------------------------------------------------------
/// An undersized buffer with a consumer that does not drain surfaces
/// `Lagged` rather than silently losing events, and the live tail stays
/// consumable afterwards.
#[tokio::test]
async fn undersized_buffer_reports_lag_and_keeps_live_tail() {
let (client, mut server) = make_client();
let session_id = SessionId::new("prepared-lag");
let prepared = client
.prepare_session(
SessionConfig::default()
.with_session_id(session_id.clone())
.with_event_buffer_capacity(8),
)
.unwrap();
let mut events = prepared.subscribe();
let start = tokio::spawn(prepared.start());
let create_req = server.read_request().await;
server.send_startup_burst(session_id.as_str()).await;
server
.respond(&create_req, create_result(session_id.as_str()))
.await;
let session = timeout(TIMEOUT, start).await.unwrap().unwrap().unwrap();
// Drain until lag is reported. Every delivered event is still in order,
// and the loss is explicit rather than silent.
let mut lagged = None;
let mut last_index: Option<usize> = None;
while lagged.is_none() {
match timeout(TIMEOUT, events.recv()).await.unwrap() {
Ok(event) => {
if let Some(index) = event.id.as_str().strip_prefix("evt-")
&& let Ok(index) = index.parse::<usize>()
{
if let Some(previous) = last_index {
assert!(index > previous, "delivered events must stay ordered");
}
last_index = Some(index);
}
}
Err(error) => match error.kind() {
RecvErrorKind::Lagged(lag) => lagged = Some(lag.skipped()),
other => panic!("expected lag, got {other:?}"),
},
}
}
assert!(lagged.unwrap() > 0, "lag must report the skipped count");
// The live tail is still consumable after a lag.
server
.send_event(session_id.as_str(), "evt-live", "assistant.message", false)
.await;
let live = loop {
match timeout(TIMEOUT, events.recv()).await.unwrap() {
Ok(event) if event.id.as_str() == "evt-live" => break event,
Ok(_) => continue,
Err(error) => match error.kind() {
RecvErrorKind::Lagged(_) => continue,
other => panic!("subscription ended before the live tail: {other:?}"),
},
}
};
assert_eq!(live.event_type, "assistant.message");
drop(session);
}
// ---------------------------------------------------------------------------
// 5 + 6. Inertness before start, and drop of an unstarted handle
// ---------------------------------------------------------------------------
#[tokio::test]
async fn prepare_is_inert_until_start_is_polled() {
let (client, mut server) = make_client();
let session_id = SessionId::new("prepared-inert");
let tasks_before = tokio::runtime::Handle::current()
.metrics()
.num_alive_tasks();
let prepared = client
.prepare_session(SessionConfig::default().with_session_id(session_id.clone()))
.unwrap();
let _events = prepared.subscribe();
// No wire traffic, no router registration, no spawned task.
server.expect_quiet().await;
assert!(client.registered_session_ids_for_test().is_empty());
assert_eq!(
tokio::runtime::Handle::current()
.metrics()
.num_alive_tasks(),
tasks_before,
"prepare must not spawn a task"
);
// Constructing the future is still inert; only polling it does work.
let start = prepared.start();
server.expect_quiet().await;
assert!(client.registered_session_ids_for_test().is_empty());
let start = tokio::spawn(start);
let create_req = server.read_request().await;
assert_eq!(create_req["method"], "session.create");
server
.respond(&create_req, create_result(session_id.as_str()))
.await;
let session = timeout(TIMEOUT, start).await.unwrap().unwrap().unwrap();
drop(session);
}
#[tokio::test]
async fn dropping_unstarted_prepared_session_leaves_no_state() {
let (client, mut server) = make_client();
let session_id = SessionId::new("prepared-dropped");
let prepared = client
.prepare_session(SessionConfig::default().with_session_id(session_id.clone()))
.unwrap();
let mut events = prepared.subscribe();
drop(prepared);
assert!(matches!(
timeout(TIMEOUT, events.recv())
.await
.unwrap()
.unwrap_err()
.kind(),
RecvErrorKind::Closed
));
assert!(client.registered_session_ids_for_test().is_empty());
server.expect_quiet().await;
}
// ---------------------------------------------------------------------------
// 7. Cancelling a polled startup
// ---------------------------------------------------------------------------
#[tokio::test]
async fn cancelled_prepared_create_cleans_up_and_allows_retry() {
let (client, mut server) = make_client();
let session_id = SessionId::new("prepared-create-cancel");
let prepared = client
.prepare_session(SessionConfig::default().with_session_id(session_id.clone()))
.unwrap();
let mut events = prepared.subscribe();
let start = tokio::spawn(prepared.start());
// The request is on the wire; cancel before responding.
let create_req = server.read_request().await;
assert_eq!(create_req["method"], "session.create");
start.abort();
let _ = start.await;
await_no_registrations(&client).await;
expect_closed(&mut events).await;
// A retry with the same session ID succeeds.
let retry = tokio::spawn(
client
.prepare_session(SessionConfig::default().with_session_id(session_id.clone()))
.unwrap()
.start(),
);
let retry_req = server.read_request().await;
assert_eq!(retry_req["method"], "session.create");
server
.respond(&retry_req, create_result(session_id.as_str()))
.await;
let session = timeout(TIMEOUT, retry).await.unwrap().unwrap().unwrap();
assert_eq!(session.id(), &session_id);
drop(session);
}
#[tokio::test]
async fn cancelled_prepared_resume_cleans_up_and_allows_retry() {
let (client, mut server) = make_client();
let session_id = SessionId::new("prepared-resume-cancel");
let prepared = client
.prepare_resume_session(ResumeSessionConfig::new(session_id.clone()))
.unwrap();
let mut events = prepared.subscribe();
let start = tokio::spawn(prepared.start());
let resume_req = server.read_request().await;
assert_eq!(resume_req["method"], "session.resume");
start.abort();
let _ = start.await;
await_no_registrations(&client).await;
expect_closed(&mut events).await;
let retry = tokio::spawn(
client
.prepare_resume_session(ResumeSessionConfig::new(session_id.clone()))
.unwrap()
.start(),
);
let retry_req = server.read_request().await;
assert_eq!(retry_req["method"], "session.resume");
server
.respond(&retry_req, json!({ "sessionId": session_id.as_str() }))
.await;
server.answer_skills_reload().await;
let session = timeout(TIMEOUT, retry).await.unwrap().unwrap().unwrap();
assert_eq!(session.id(), &session_id);
drop(session);
}
// ---------------------------------------------------------------------------
// 8. Startup failures preserve error kinds and clean up
// ---------------------------------------------------------------------------
#[tokio::test]
async fn create_rpc_error_preserves_kind_and_cleans_up() {
let (client, mut server) = make_client();
let session_id = SessionId::new("prepared-create-rpc-error");
let prepared = client
.prepare_session(SessionConfig::default().with_session_id(session_id.clone()))
.unwrap();
let mut events = prepared.subscribe();
let start = tokio::spawn(prepared.start());
let create_req = server.read_request().await;
server
.respond_error(&create_req, -32000, "session create failed")
.await;
let error = expect_error(timeout(TIMEOUT, start).await.unwrap().unwrap());
assert!(
matches!(error.kind(), ErrorKind::Rpc { code: -32000 }),
"unexpected error kind: {:?}",
error.kind()
);
await_no_registrations(&client).await;
expect_closed(&mut events).await;
}
#[tokio::test]
async fn create_session_id_mismatch_preserves_kind_and_cleans_up() {
let (client, mut server) = make_client();
let session_id = SessionId::new("prepared-mismatch");
let prepared = client
.prepare_session(SessionConfig::default().with_session_id(session_id.clone()))
.unwrap();
let mut events = prepared.subscribe();
let start = tokio::spawn(prepared.start());
let create_req = server.read_request().await;
server
.respond(&create_req, create_result("some-other-id"))
.await;
let error = expect_error(timeout(TIMEOUT, start).await.unwrap().unwrap());
let ErrorKind::Session(SessionErrorKind::SessionIdMismatch {
requested,
returned,
}) = error.kind()
else {
panic!("unexpected error kind: {:?}", error.kind());
};
assert_eq!(requested, &session_id);
assert_eq!(returned.as_str(), "some-other-id");
await_no_registrations(&client).await;
expect_closed(&mut events).await;
}
#[tokio::test]
async fn resume_session_id_mismatch_preserves_kind_and_cleans_up() {
let (client, mut server) = make_client();
let session_id = SessionId::new("prepared-resume-mismatch");
let prepared = client
.prepare_resume_session(ResumeSessionConfig::new(session_id.clone()))
.unwrap();
let mut events = prepared.subscribe();
let start = tokio::spawn(prepared.start());
let resume_req = server.read_request().await;
server
.respond(&resume_req, json!({ "sessionId": "another-session" }))
.await;
let error = expect_error(timeout(TIMEOUT, start).await.unwrap().unwrap());
assert!(
matches!(
error.kind(),
ErrorKind::Session(SessionErrorKind::SessionIdMismatch { .. })
),
"unexpected error kind: {:?}",
error.kind()
);
await_no_registrations(&client).await;
expect_closed(&mut events).await;
}
/// The MCP-auth interest registration that follows a successful
/// `session.create` is the last fallible step before the session handle is
/// handed out. When it fails, the startup must unwind exactly like any
/// other create failure: original error kind preserved, router
/// registration removed, and subscriptions taken before `start()` closed.
#[tokio::test]
async fn create_mcp_auth_interest_error_preserves_kind_and_cleans_up() {
let (client, mut server) = make_client();
let session_id = SessionId::new("prepared-create-interest-error");
let prepared = client
.prepare_session(
SessionConfig::default()
.with_session_id(session_id.clone())
.with_mcp_auth_handler(Arc::new(CancelMcpAuthHandler)),
)
.unwrap();
let mut events = prepared.subscribe();
let start = tokio::spawn(prepared.start());
let create_req = server.read_request().await;
assert_eq!(create_req["method"], "session.create");
server
.respond(&create_req, create_result(session_id.as_str()))
.await;
let interest_req = server.read_request().await;
assert_eq!(interest_req["method"], "session.eventLog.registerInterest");
assert_eq!(interest_req["params"]["eventType"], "mcp.oauth_required");
server
.respond_error(&interest_req, -32003, "interest registration failed")
.await;
let error = expect_error(timeout(TIMEOUT, start).await.unwrap().unwrap());
assert!(
matches!(error.kind(), ErrorKind::Rpc { code: -32003 }),
"unexpected error kind: {:?}",
error.kind()
);
expect_closed(&mut events).await;
await_no_registrations(&client).await;
}
/// The resume counterpart. Interest registration runs before the
/// best-effort `session.skills.reload`, so a failure must abort the
/// startup without issuing the reload.
#[tokio::test]
async fn resume_mcp_auth_interest_error_preserves_kind_and_cleans_up() {
let (client, mut server) = make_client();
let session_id = SessionId::new("prepared-resume-interest-error");
let prepared = client
.prepare_resume_session(
ResumeSessionConfig::new(session_id.clone())
.with_mcp_auth_handler(Arc::new(CancelMcpAuthHandler)),
)
.unwrap();
let mut events = prepared.subscribe();
let start = tokio::spawn(prepared.start());
let resume_req = server.read_request().await;
assert_eq!(resume_req["method"], "session.resume");
server
.respond(&resume_req, json!({ "sessionId": session_id.as_str() }))
.await;
let interest_req = server.read_request().await;
assert_eq!(interest_req["method"], "session.eventLog.registerInterest");
server
.respond_error(&interest_req, -32004, "interest registration failed")
.await;
let error = expect_error(timeout(TIMEOUT, start).await.unwrap().unwrap());
assert!(
matches!(error.kind(), ErrorKind::Rpc { code: -32004 }),
"unexpected error kind: {:?}",
error.kind()
);
server.expect_quiet().await;
expect_closed(&mut events).await;
await_no_registrations(&client).await;
}
#[tokio::test]
async fn zero_event_buffer_capacity_is_invalid_config() {
let (client, _server) = make_client();
let error = expect_error(
client.prepare_session(SessionConfig::default().with_event_buffer_capacity(0)),
);
assert!(matches!(error.kind(), ErrorKind::InvalidConfig));
let error = expect_error(client.prepare_resume_session(
ResumeSessionConfig::new(SessionId::new("zero")).with_event_buffer_capacity(0),
));
assert!(matches!(error.kind(), ErrorKind::InvalidConfig));
// The compatibility wrappers surface the same error.
let error = expect_error(
client
.create_session(SessionConfig::default().with_event_buffer_capacity(0))
.await,
);
assert!(matches!(error.kind(), ErrorKind::InvalidConfig));
}
// ---------------------------------------------------------------------------
// 9. Early and late subscribers share one event loop
// ---------------------------------------------------------------------------
#[tokio::test]
async fn early_and_late_subscribers_share_one_event_loop() {
let (client, mut server) = make_client();
let session_id = SessionId::new("prepared-two-subscribers");
let prepared = client
.prepare_session(
SessionConfig::default()
.with_session_id(session_id.clone())
.with_event_buffer_capacity(2048),
)
.unwrap();
let mut early = prepared.subscribe();
let start = tokio::spawn(prepared.start());
let create_req = server.read_request().await;
server
.send_event(session_id.as_str(), "evt-early", "assistant.message", false)
.await;
server
.respond(&create_req, create_result(session_id.as_str()))
.await;
let session = timeout(TIMEOUT, start).await.unwrap().unwrap().unwrap();
let mut late = session.subscribe();
server
.send_event(session_id.as_str(), "evt-late", "assistant.message", false)
.await;
// The early subscriber sees both events, once each.
assert_eq!(
timeout(TIMEOUT, early.recv())
.await
.unwrap()
.unwrap()
.id
.as_str(),
"evt-early"
);
assert_eq!(
timeout(TIMEOUT, early.recv())
.await
.unwrap()
.unwrap()
.id
.as_str(),
"evt-late"
);
// The late subscriber only sees what was emitted after it subscribed —
// exactly once, which would be twice if a second event loop existed.
assert_eq!(
timeout(TIMEOUT, late.recv())
.await
.unwrap()
.unwrap()
.id
.as_str(),
"evt-late"
);
assert!(
timeout(QUIET, late.recv()).await.is_err(),
"duplicate delivery implies more than one event loop"
);
assert!(
timeout(QUIET, early.recv()).await.is_err(),
"duplicate delivery implies more than one event loop"
);
drop(session);
}
// ---------------------------------------------------------------------------
// 10. Compatibility wrappers
// ---------------------------------------------------------------------------
#[tokio::test]
async fn create_session_wrapper_keeps_rpc_sequence() {
let (client, mut server) = make_client();
let start = tokio::spawn({
let client = client.clone();
async move { client.create_session(SessionConfig::default()).await }
});
let create_req = server.read_request().await;
assert_eq!(create_req["method"], "session.create");
let session_id = create_req["params"]["sessionId"]
.as_str()
.unwrap()
.to_string();
server
.respond(&create_req, create_result(&session_id))
.await;
let session = timeout(TIMEOUT, start).await.unwrap().unwrap().unwrap();
assert_eq!(session.id().as_str(), session_id);
server.expect_quiet().await;
drop(session);
}
#[tokio::test]
async fn resume_session_wrapper_keeps_rpc_sequence() {
let (client, mut server) = make_client();
let session_id = SessionId::new("wrapper-resume");
let start = tokio::spawn({
let client = client.clone();
let session_id = session_id.clone();
async move {
client
.resume_session(ResumeSessionConfig::new(session_id))
.await
}
});
let resume_req = server.read_request().await;
assert_eq!(resume_req["method"], "session.resume");
assert_eq!(resume_req["params"]["sessionId"], session_id.as_str());
server
.respond(&resume_req, json!({ "sessionId": session_id.as_str() }))
.await;
server.answer_skills_reload().await;
let session = timeout(TIMEOUT, start).await.unwrap().unwrap().unwrap();
assert_eq!(session.id(), &session_id);
server.expect_quiet().await;
drop(session);
}
// ---------------------------------------------------------------------------
// 11. Type-level guarantees
// ---------------------------------------------------------------------------
/// Detects `Clone` without requiring it: the inherent method wins whenever
/// `T: Clone`, otherwise the blanket trait method is selected.
struct CloneProbe<T>(PhantomData<T>);
impl<T: Clone> CloneProbe<T> {
fn is_clone(&self) -> bool {
true
}
}
trait MaybeClone {
fn is_clone(&self) -> bool {
false
}
}
impl<T> MaybeClone for CloneProbe<T> {}
#[test]
fn prepared_session_is_send_static_and_not_clone() {
fn assert_send_static<T: Send + 'static>() {}
assert_send_static::<PreparedSession>();
// Sanity-check the probe against a type that is `Clone` ...
assert!(CloneProbe::<String>(PhantomData).is_clone());
// ... then assert `PreparedSession` deliberately is not, so a prepared
// session can never be started twice.
assert!(!CloneProbe::<PreparedSession>(PhantomData).is_clone());
}
// ---------------------------------------------------------------------------
// Registration ownership: a stale startup guard must never unregister a
// newer registration that reused the same session ID.
// ---------------------------------------------------------------------------
/// Drive a startup future until it parks awaiting its RPC response.
///
/// The duration is a bound, not a correctness sleep: whether the future
/// actually reached the wire is asserted afterwards by reading the request,
/// which fails loudly on its own timeout if it did not.
const DRIVE: Duration = Duration::from_millis(50);
#[tokio::test]
async fn stale_create_guard_does_not_unregister_same_id_retry() {
let (client, mut server) = make_client();
let session_id = SessionId::new("stale-create-guard");
// First attempt: registers, sends `session.create`, then parks.
let mut first = Box::pin(
client
.prepare_session(SessionConfig::default().with_session_id(session_id.clone()))
.unwrap()
.start(),
);
let _ = timeout(DRIVE, &mut first).await;
let first_req = server.read_request().await;
assert_eq!(first_req["method"], "session.create");
// Second attempt with the same pinned ID, started before the first is
// dropped, so it replaces the first attempt's router registration.
let prepared = client
.prepare_session(
SessionConfig::default()
.with_session_id(session_id.clone())
.with_event_buffer_capacity(64),
)
.unwrap();
let mut events = prepared.subscribe();
let mut second = Box::pin(prepared.start());
let _ = timeout(DRIVE, &mut second).await;
let second_req = server.read_request().await;
assert_eq!(second_req["method"], "session.create");
// The stale guard runs now. It must not touch the live registration.
drop(first);
assert_only_registration(
&client,
&session_id,
"a stale startup guard unregistered the live retry",
);
server
.respond(&second_req, create_result(session_id.as_str()))
.await;
let session = timeout(TIMEOUT, &mut second).await.unwrap().unwrap();
// Events must still route to the surviving registration.
server
.send_event(
session_id.as_str(),
"evt-after-stale",
"assistant.message",
false,
)
.await;
let event = timeout(TIMEOUT, events.recv()).await.unwrap().unwrap();
assert_eq!(event.id.as_str(), "evt-after-stale");
drop(session);
}