{{ message }}
Repository navigation
Expand file tree
/
Copy pathtest_rpc_session_state_e2e.py
More file actions
912 lines (794 loc) · 36 KB
/
Copy pathtest_rpc_session_state_e2e.py
File metadata and controls
912 lines (794 loc) · 36 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
"""
E2E coverage for session-scoped state RPCs.
Mirrors ``dotnet/test/RpcSessionStateTests.cs`` (snapshot category
``rpc_session_state``).
"""
from __future__ import annotations
import asyncio
import contextlib
import os
import time
import uuid
from pathlib import Path
import pytest
from copilot.generated.rpc import (
AuthInfoType,
CopilotUserResponse,
CopilotUserResponseEndpoints,
HistoryTruncateRequest,
HostType,
LspInitializeRequest,
MCPOauthLoginRequest,
MetadataContextInfoRequest,
MetadataRecomputeContextTokensRequest,
MetadataRecordContextChangeRequest,
MetadataSetWorkingDirectoryRequest,
ModelSetReasoningEffortRequest,
ModelSwitchToRequest,
ModeSetRequest,
NameSetAutoRequest,
NameSetRequest,
PermissionsSetApproveAllRequest,
PlanUpdateRequest,
SessionMode,
SessionSetCredentialsParams,
SessionsForkRequest,
SessionUpdateOptionsParams,
SessionWorkingDirectoryContext,
ShutdownRequest,
ShutdownType,
TelemetrySetFeatureOverridesRequest,
UserAuthInfo,
WorkspacesCreateFileRequest,
WorkspacesReadFileRequest,
)
from copilot.generated.session_events import (
AssistantMessageData,
SessionContextChangedData,
SessionShutdownData,
SessionTitleChangedData,
UserMessageData,
)
from copilot.session import PermissionHandler
from .testharness import E2ETestContext
pytestmark = pytest.mark.asyncio(loop_scope="module")
def _conversation_messages(events) -> list[tuple[str, str]]:
out: list[tuple[str, str]] = []
for evt in events:
match evt.data:
case UserMessageData() as data:
out.append(("user", data.content or ""))
case AssistantMessageData() as data:
out.append(("assistant", data.content or ""))
return out
def _path_equals(expected: str, actual: str | None) -> bool:
if actual is None:
return False
return os.path.normcase(os.path.abspath(expected)) == os.path.normcase(os.path.abspath(actual))
def _create_unique_directory(ctx: E2ETestContext, prefix: str) -> str:
path = Path(ctx.work_dir) / f"{prefix}-{uuid.uuid4().hex}"
path.mkdir(parents=True, exist_ok=True)
return str(path)
async def _wait_for(condition, *, timeout: float = 15.0, message: str):
deadline = time.monotonic() + timeout
while time.monotonic() < deadline:
if await condition():
return
await asyncio.sleep(0.2)
pytest.fail(message)
async def _assert_implemented_failure(awaitable, method: str) -> None:
with pytest.raises(Exception) as excinfo:
_ = await awaitable
assert f"Unhandled method {method}".lower() not in str(excinfo.value).lower()
class TestRpcSessionState:
async def test_should_call_session_rpc_model_get_current(self, ctx: E2ETestContext):
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
model="claude-sonnet-4.5",
)
try:
result = await session.rpc.model.get_current()
assert result.model_id
finally:
await session.disconnect()
async def test_should_call_session_rpc_model_switch_to(self, ctx: E2ETestContext):
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
model="claude-sonnet-4.5",
)
try:
before = await session.rpc.model.get_current()
assert before.model_id
result = await session.rpc.model.switch_to(
ModelSwitchToRequest(model_id="gpt-4.1", reasoning_effort="high")
)
after = await session.rpc.model.get_current()
assert result.model_id == "gpt-4.1"
# Python's current RPC surface resolves the requested override but does
# not mutate the live session model selection.
assert after.model_id == before.model_id
finally:
await session.disconnect()
async def test_should_get_and_set_session_mode(self, ctx: E2ETestContext):
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
initial = await session.rpc.mode.get()
assert initial == SessionMode.INTERACTIVE
await session.rpc.mode.set(ModeSetRequest(mode=SessionMode.PLAN))
assert await session.rpc.mode.get() == SessionMode.PLAN
await session.rpc.mode.set(ModeSetRequest(mode=SessionMode.INTERACTIVE))
assert await session.rpc.mode.get() == SessionMode.INTERACTIVE
finally:
await session.disconnect()
async def test_should_shutdown_session_with_routine_type(self, ctx: E2ETestContext):
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
shutdown_future: asyncio.Future = asyncio.get_event_loop().create_future()
def on_event(event):
if (
isinstance(event.data, SessionShutdownData)
and event.data.shutdown_type == ShutdownType.ROUTINE
and not shutdown_future.done()
):
shutdown_future.set_result(event)
unsubscribe = session.on(on_event)
try:
await session.rpc.shutdown(
ShutdownRequest(
type=ShutdownType.ROUTINE,
reason="SDK E2E shutdown coverage",
)
)
shutdown = await asyncio.wait_for(shutdown_future, timeout=15.0)
assert shutdown.data.shutdown_type == ShutdownType.ROUTINE
finally:
unsubscribe()
with contextlib.suppress(Exception):
await session.disconnect()
async def test_should_read_update_and_delete_plan(self, ctx: E2ETestContext):
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
initial = await session.rpc.plan.read()
assert initial.exists is False
assert initial.content is None
plan_content = "# Test Plan\n\n- Step 1\n- Step 2"
await session.rpc.plan.update(PlanUpdateRequest(content=plan_content))
after_update = await session.rpc.plan.read()
assert after_update.exists is True
assert after_update.content == plan_content
await session.rpc.plan.delete()
after_delete = await session.rpc.plan.read()
assert after_delete.exists is False
assert after_delete.content is None
finally:
await session.disconnect()
async def test_should_call_workspace_file_rpc_methods(self, ctx: E2ETestContext):
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
initial = await session.rpc.workspaces.list_files()
assert initial.files is not None
await session.rpc.workspaces.create_file(
WorkspacesCreateFileRequest(path="test.txt", content="Hello, workspace!")
)
after_create = await session.rpc.workspaces.list_files()
assert "test.txt" in after_create.files
file = await session.rpc.workspaces.read_file(
WorkspacesReadFileRequest(path="test.txt")
)
assert file.content == "Hello, workspace!"
workspace = await session.rpc.workspaces.get_workspace()
assert workspace.workspace is not None
assert workspace.workspace.id is not None
finally:
await session.disconnect()
async def test_should_get_and_set_session_metadata(self, ctx: E2ETestContext):
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
await session.rpc.name.set(NameSetRequest(name="SDK test session"))
name = await session.rpc.name.get()
assert name.name == "SDK test session"
sources = await session.rpc.instructions.get_sources()
assert sources.sources is not None
finally:
await session.disconnect()
async def test_should_call_metadata_snapshot_set_working_directory_and_record_context_change(
self, ctx: E2ETestContext
):
first_dir = _create_unique_directory(ctx, "metadata-first")
second_dir = _create_unique_directory(ctx, "metadata-second")
context_dir = _create_unique_directory(ctx, "metadata-context")
branch = f"rpc-context-{uuid.uuid4().hex}"
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
model="claude-sonnet-4.5",
working_directory=first_dir,
)
try:
snapshot = await session.rpc.metadata.snapshot()
assert snapshot.session_id == session.session_id
assert snapshot.selected_model == "claude-sonnet-4.5"
assert snapshot.is_remote is False
assert snapshot.already_in_use is False
assert _path_equals(first_dir, snapshot.working_directory)
assert snapshot.workspace is not None
assert snapshot.workspace.id == session.session_id
assert snapshot.workspace_path
set_result = await session.rpc.metadata.set_working_directory(
MetadataSetWorkingDirectoryRequest(working_directory=second_dir)
)
assert _path_equals(second_dir, set_result.working_directory)
async def snapshot_updated() -> bool:
current = await session.rpc.metadata.snapshot()
return _path_equals(second_dir, current.working_directory)
await _wait_for(
snapshot_updated,
message="Timed out waiting for metadata snapshot cwd update.",
)
context_future: asyncio.Future = asyncio.get_event_loop().create_future()
def on_event(event):
if (
isinstance(event.data, SessionContextChangedData)
and event.data.branch == branch
and not context_future.done()
):
context_future.set_result(event)
unsubscribe = session.on(on_event)
try:
result = await session.rpc.metadata.record_context_change(
MetadataRecordContextChangeRequest(
context=SessionWorkingDirectoryContext(
cwd=context_dir,
git_root=first_dir,
branch=branch,
repository="github/copilot-sdk-e2e",
repository_host="github.com",
host_type=HostType.GITHUB,
base_commit="0" * 40,
head_commit="1" * 40,
)
)
)
assert result is not None
event = await asyncio.wait_for(context_future, timeout=15.0)
assert _path_equals(context_dir, event.data.cwd)
assert _path_equals(first_dir, event.data.git_root)
assert event.data.branch == branch
assert event.data.repository == "github/copilot-sdk-e2e"
assert event.data.repository_host == "github.com"
assert event.data.host_type.value == "github"
assert event.data.base_commit == "0" * 40
assert event.data.head_commit == "1" * 40
finally:
unsubscribe()
finally:
await session.disconnect()
async def test_should_update_options_initialize_services_and_set_feature_overrides(
self, ctx: E2ETestContext
):
initial_dir = _create_unique_directory(ctx, "options-initial")
options_dir = _create_unique_directory(ctx, "options-updated")
feature_name = f"rpc-session-state-{uuid.uuid4().hex}"
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
working_directory=initial_dir,
)
try:
update = await session.rpc.options.update(
SessionUpdateOptionsParams(
client_name="python-sdk-rpc-session-state-e2e",
lsp_client_name="python-sdk-rpc-session-state-lsp",
integration_id=f"python-sdk-{uuid.uuid4().hex}",
feature_flags={feature_name: True},
working_directory=options_dir,
coauthor_enabled=False,
enable_streaming=False,
ask_user_disabled=True,
)
)
assert update.success is True
async def snapshot_updated() -> bool:
snapshot = await session.rpc.metadata.snapshot()
return _path_equals(options_dir, snapshot.working_directory)
await _wait_for(
snapshot_updated,
message="Timed out waiting for options.update cwd to reach metadata snapshot.",
)
await session.rpc.lsp.initialize(
LspInitializeRequest(
working_directory=options_dir,
git_root=initial_dir,
force=True,
)
)
await session.rpc.telemetry.set_feature_overrides(
TelemetrySetFeatureOverridesRequest(
features={
"rpc_session_state_feature": feature_name,
"rpc_session_state_value": "enabled",
}
)
)
tools = await session.rpc.tools.initialize_and_validate()
assert tools is not None
finally:
await session.disconnect()
async def test_should_set_reasoning_effort_and_auto_name(self, ctx: E2ETestContext):
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
model="claude-sonnet-4.5",
)
try:
reasoning = await session.rpc.model.set_reasoning_effort(
ModelSetReasoningEffortRequest(reasoning_effort="high")
)
assert reasoning.reasoning_effort == "high"
current = await session.rpc.model.get_current()
assert current.model_id == "claude-sonnet-4.5"
assert current.reasoning_effort == "high"
auto_name = f"Auto Session {uuid.uuid4().hex}"
title_future: asyncio.Future = asyncio.get_event_loop().create_future()
def on_event(event):
if (
isinstance(event.data, SessionTitleChangedData)
and event.data.title == auto_name
and not title_future.done()
):
title_future.set_result(event)
unsubscribe = session.on(on_event)
try:
auto = await session.rpc.name.set_auto(
NameSetAutoRequest(summary=f" {auto_name} ")
)
assert auto.applied is True
await asyncio.wait_for(title_future, timeout=15.0)
finally:
unsubscribe()
assert (await session.rpc.name.get()).name == auto_name
explicit_name = f"Explicit Session {uuid.uuid4().hex}"
await session.rpc.name.set(NameSetRequest(name=explicit_name))
ignored = await session.rpc.name.set_auto(
NameSetAutoRequest(summary=f"Ignored {uuid.uuid4().hex}")
)
assert ignored.applied is False
assert (await session.rpc.name.get()).name == explicit_name
finally:
await session.disconnect()
async def test_should_set_auth_credentials(self, ctx: E2ETestContext):
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
login = f"sdk-rpc-{uuid.uuid4().hex}"
result = await session.rpc.auth.set_credentials(
SessionSetCredentialsParams(
credentials=UserAuthInfo(
host="https://github.com",
login=login,
copilot_user=CopilotUserResponse(
analytics_tracking_id="rpc-session-state-tracking-id",
chat_enabled=True,
copilot_plan="individual_pro",
endpoints=CopilotUserResponseEndpoints(
api=ctx.proxy_url,
telemetry="https://localhost:1/telemetry",
),
login=login,
),
)
)
)
assert result.success is True
status = await session.rpc.auth.get_status()
assert status.is_authenticated is True
assert status.auth_type == AuthInfoType.USER
assert status.host == "https://github.com"
assert status.login == login
finally:
await session.disconnect()
async def test_should_fork_session_with_persisted_messages(self, ctx: E2ETestContext):
source_prompt = "Say FORK_SOURCE_ALPHA exactly."
fork_prompt = "Now say FORK_CHILD_BETA exactly."
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
initial_answer = await session.send_and_wait(source_prompt, timeout=60.0)
assert initial_answer is not None
assert "FORK_SOURCE_ALPHA" in (initial_answer.data.content or "")
source_messages = await session.get_events()
source_conversation = _conversation_messages(source_messages)
assert any(
role == "user" and content == source_prompt for role, content in source_conversation
)
assert any(
role == "assistant" and "FORK_SOURCE_ALPHA" in content
for role, content in source_conversation
)
fork = await ctx.client.rpc.sessions.fork(
SessionsForkRequest(session_id=session.session_id)
)
assert (fork.session_id or "").strip()
assert fork.session_id != session.session_id
forked_session = await ctx.client.resume_session(
fork.session_id,
on_permission_request=PermissionHandler.approve_all,
)
try:
forked_messages = await forked_session.get_events()
forked_conversation = _conversation_messages(forked_messages)
assert forked_conversation[: len(source_conversation)] == source_conversation
fork_answer = await forked_session.send_and_wait(fork_prompt, timeout=60.0)
assert fork_answer is not None
assert "FORK_CHILD_BETA" in (fork_answer.data.content or "")
source_after_fork = _conversation_messages(await session.get_events())
assert all(content != fork_prompt for _, content in source_after_fork)
fork_after_prompt = _conversation_messages(await forked_session.get_events())
assert any(
role == "user" and content == fork_prompt for role, content in fork_after_prompt
)
assert any(
role == "assistant" and "FORK_CHILD_BETA" in content
for role, content in fork_after_prompt
)
finally:
await forked_session.disconnect()
finally:
await session.disconnect()
async def test_should_handle_forking_session_without_persisted_events(
self, ctx: E2ETestContext
):
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
try:
fork = await ctx.client.rpc.sessions.fork(
SessionsForkRequest(session_id=session.session_id)
)
except Exception as exc:
text = str(exc).lower()
assert "not found or has no persisted events" in text
assert "unhandled method sessions.fork" not in text
return
assert fork.session_id.strip()
assert fork.session_id != session.session_id
forked_session = await ctx.client.resume_session(
fork.session_id,
on_permission_request=PermissionHandler.approve_all,
)
try:
assert _conversation_messages(await forked_session.get_events()) == []
finally:
await forked_session.disconnect()
finally:
await session.disconnect()
async def test_should_call_session_usage_and_permission_rpcs(self, ctx: E2ETestContext):
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
metrics = await session.rpc.usage.get_metrics()
assert metrics.session_start_time is not None
if metrics.total_nano_aiu is not None:
assert metrics.total_nano_aiu >= 0
if metrics.token_details is not None:
for detail in metrics.token_details.values():
assert detail.token_count >= 0
for model_metric in metrics.model_metrics.values():
if model_metric.total_nano_aiu is not None:
assert model_metric.total_nano_aiu >= 0
if model_metric.token_details is not None:
for detail in model_metric.token_details.values():
assert detail.token_count >= 0
handoff = await session.rpc.history.summarize_for_handoff()
assert isinstance(handoff.summary, str)
cancel_background = await session.rpc.history.cancel_background_compaction()
assert cancel_background.cancelled is False
abort_manual = await session.rpc.history.abort_manual_compaction()
assert abort_manual.aborted is False
try:
approve_all = await session.rpc.permissions.set_approve_all(
PermissionsSetApproveAllRequest(enabled=True)
)
assert approve_all.success
reset = await session.rpc.permissions.reset_session_approvals()
assert reset.success
finally:
await session.rpc.permissions.set_approve_all(
PermissionsSetApproveAllRequest(enabled=False)
)
finally:
await session.disconnect()
async def test_should_report_implemented_errors_for_unsupported_session_rpc_paths(
self, ctx: E2ETestContext
):
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
await _assert_implemented_failure(
session.rpc.history.truncate(HistoryTruncateRequest(event_id="missing-event")),
"session.history.truncate",
)
await _assert_implemented_failure(
session.rpc.mcp.oauth.login(MCPOauthLoginRequest(server_name="missing-server")),
"session.mcp.oauth.login",
)
finally:
await session.disconnect()
async def test_should_compact_session_history_after_messages(self, ctx: E2ETestContext):
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
assert (await session.rpc.metadata.is_processing()).processing is False
await session.send_and_wait("What is 2+2?", timeout=60.0)
assert (await session.rpc.metadata.is_processing()).processing is False
context_info = await session.rpc.metadata.context_info(
MetadataContextInfoRequest(
prompt_token_limit=128_000,
output_token_limit=4_096,
selected_model="claude-sonnet-4.5",
)
)
if context_info.context_info is not None:
context = context_info.context_info
assert context.model_name == "claude-sonnet-4.5"
assert context.prompt_token_limit == 128_000
assert context.limit >= context.prompt_token_limit
assert context.total_tokens > 0
assert context.system_tokens > 0
assert context.conversation_tokens > 0
assert context.tool_definitions_tokens >= 0
assert (
context.system_tokens
+ context.conversation_tokens
+ context.tool_definitions_tokens
== context.total_tokens
)
recomputed = await session.rpc.metadata.recompute_context_tokens(
MetadataRecomputeContextTokensRequest(model_id="claude-sonnet-4.5")
)
assert recomputed.system_token_count > 0
assert recomputed.messages_token_count > 0
assert recomputed.total_tokens == (
recomputed.system_token_count + recomputed.messages_token_count
)
result = await session.rpc.history.compact()
assert result is not None
assert result.success, "Expected History.compact() to report success=True"
assert result.messages_removed >= 0, "messages_removed must be non-negative"
if result.context_window is not None:
assert result.context_window.messages_length >= 0
assert result.context_window.current_tokens >= 0
# Session must still be usable after compaction
name = await session.rpc.name.get()
assert name is not None
finally:
await session.disconnect()
async def test_should_set_and_get_each_session_mode_value(self, ctx: E2ETestContext):
for mode in [SessionMode.INTERACTIVE, SessionMode.PLAN, SessionMode.AUTOPILOT]:
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
await session.rpc.mode.set(ModeSetRequest(mode=mode))
result = await session.rpc.mode.get()
assert result == mode, f"Expected mode {mode} but got {result}"
finally:
await session.disconnect()
async def test_should_reject_workspace_file_path_traversal(self, ctx: E2ETestContext):
for traversal_path in [
"../escaped.txt",
"../../escaped.txt",
"nested/../../../escaped.txt",
]:
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
with pytest.raises(Exception) as excinfo:
await session.rpc.workspaces.create_file(
WorkspacesCreateFileRequest(
path=traversal_path,
content="should not land outside workspace",
)
)
assert "workspace files directory" in str(excinfo.value).lower()
with pytest.raises(Exception) as excinfo2:
await session.rpc.workspaces.read_file(
WorkspacesReadFileRequest(path=traversal_path)
)
assert "workspace files directory" in str(excinfo2.value).lower()
finally:
await session.disconnect()
async def test_should_create_workspace_file_with_nested_path_auto_creating_dirs(
self, ctx: E2ETestContext
):
import uuid
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
nested_path = f"nested-{uuid.uuid4().hex}/subdir/file.txt"
await session.rpc.workspaces.create_file(
WorkspacesCreateFileRequest(path=nested_path, content="nested content")
)
read = await session.rpc.workspaces.read_file(
WorkspacesReadFileRequest(path=nested_path)
)
assert read.content == "nested content"
listed = await session.rpc.workspaces.list_files()
assert any(f.endswith("file.txt") for f in listed.files)
finally:
await session.disconnect()
async def test_should_report_error_reading_nonexistent_workspace_file(
self, ctx: E2ETestContext
):
import uuid
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
with pytest.raises(Exception):
await session.rpc.workspaces.read_file(
WorkspacesReadFileRequest(path=f"never-exists-{uuid.uuid4().hex}.txt")
)
finally:
await session.disconnect()
async def test_should_update_existing_workspace_file_with_update_operation(
self, ctx: E2ETestContext
):
import asyncio
import uuid
from copilot.generated.session_events import (
SessionWorkspaceFileChangedData,
WorkspaceFileChangedOperation,
)
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
path = f"reused-{uuid.uuid4().hex}.txt"
await session.rpc.workspaces.create_file(
WorkspacesCreateFileRequest(path=path, content="v1")
)
update_future: asyncio.Future = asyncio.get_event_loop().create_future()
def on_event(event):
if (
isinstance(event.data, SessionWorkspaceFileChangedData)
and event.data.path == path
and event.data.operation == WorkspaceFileChangedOperation.UPDATE
and not update_future.done()
):
update_future.set_result(event)
unsubscribe = session.on(on_event)
try:
await session.rpc.workspaces.create_file(
WorkspacesCreateFileRequest(path=path, content="v2")
)
evt = await asyncio.wait_for(update_future, timeout=15.0)
assert evt.data.operation == WorkspaceFileChangedOperation.UPDATE
read = await session.rpc.workspaces.read_file(WorkspacesReadFileRequest(path=path))
assert read.content == "v2"
finally:
unsubscribe()
finally:
await session.disconnect()
async def test_should_reject_empty_or_whitespace_session_name(self, ctx: E2ETestContext):
for empty_name in ["", " ", "\t\n \r"]:
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
with pytest.raises(Exception) as excinfo:
await session.rpc.name.set(NameSetRequest(name=empty_name))
assert "empty" in str(excinfo.value).lower()
finally:
await session.disconnect()
async def test_should_emit_title_changed_event_each_time_name_set_is_called(
self, ctx: E2ETestContext
):
import asyncio
import uuid
from copilot.generated.session_events import SessionTitleChangedData
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
title_a = f"Title-A-{uuid.uuid4().hex}"
title_b = f"Title-B-{uuid.uuid4().hex}"
first_task: asyncio.Future = asyncio.get_event_loop().create_future()
second_task: asyncio.Future = asyncio.get_event_loop().create_future()
def on_event(event):
if isinstance(event.data, SessionTitleChangedData):
if event.data.title == title_a and not first_task.done():
first_task.set_result(event)
elif event.data.title == title_b and not second_task.done():
second_task.set_result(event)
unsubscribe = session.on(on_event)
try:
await session.rpc.name.set(NameSetRequest(name=title_a))
await asyncio.wait_for(first_task, timeout=15.0)
await session.rpc.name.set(NameSetRequest(name=title_b))
second_evt = await asyncio.wait_for(second_task, timeout=15.0)
assert second_evt.data.title == title_b
finally:
unsubscribe()
finally:
await session.disconnect()
async def test_should_fork_session_to_event_id_excluding_boundary_event(
self, ctx: E2ETestContext
):
first_prompt = "Say FORK_BOUNDARY_FIRST exactly."
second_prompt = "Say FORK_BOUNDARY_SECOND exactly."
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
await session.send_and_wait(first_prompt, timeout=60.0)
await session.send_and_wait(second_prompt, timeout=60.0)
source_events = await session.get_events()
second_user_event = next(
(
e
for e in source_events
if isinstance(e.data, UserMessageData) and e.data.content == second_prompt
),
None,
)
assert second_user_event is not None, (
"Expected the second user.message in persisted history"
)
boundary_event_id = str(second_user_event.id)
fork = await ctx.client.rpc.sessions.fork(
SessionsForkRequest(session_id=session.session_id, to_event_id=boundary_event_id)
)
assert (fork.session_id or "").strip()
assert fork.session_id != session.session_id
forked_session = await ctx.client.resume_session(
fork.session_id,
on_permission_request=PermissionHandler.approve_all,
)
try:
forked_events = await forked_session.get_events()
forked_ids = {str(e.id) for e in forked_events}
assert boundary_event_id not in forked_ids, (
"toEventId is exclusive — boundary event must not be in forked session"
)
forked_conv = _conversation_messages(forked_events)
assert any(r == "user" and c == first_prompt for r, c in forked_conv)
assert not any(r == "user" and c == second_prompt for r, c in forked_conv)
finally:
await forked_session.disconnect()
finally:
await session.disconnect()
async def test_should_report_error_when_forking_session_to_unknown_event_id(
self, ctx: E2ETestContext
):
import uuid
source_prompt = "Say FORK_UNKNOWN_EVENT_OK exactly."
session = await ctx.client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
try:
await session.send_and_wait(source_prompt, timeout=60.0)
bogus_event_id = str(uuid.uuid4())
with pytest.raises(Exception) as excinfo:
await ctx.client.rpc.sessions.fork(
SessionsForkRequest(session_id=session.session_id, to_event_id=bogus_event_id)
)
text = str(excinfo.value)
assert f"Event {bogus_event_id} not found".lower() in text.lower()
assert "Unhandled method sessions.fork".lower() not in text.lower()
finally:
await session.disconnect()
You can’t perform that action at this time.