{{ message }}
Repository navigation
Expand file tree
/
Copy pathtest_event_forward_compatibility.py
More file actions
495 lines (448 loc) · 19.5 KB
/
Copy pathtest_event_forward_compatibility.py
File metadata and controls
495 lines (448 loc) · 19.5 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
"""
Test that unknown event types are handled gracefully for forward compatibility.
This test verifies that:
1. The session.usage_info event type is recognized
2. Unknown future event types map to UNKNOWN enum value
3. Real parsing errors (malformed data) are NOT suppressed and surface for visibility
"""
from datetime import datetime
from uuid import uuid4
import pytest
from copilot.session_events import (
AttachmentGitHubReferenceType,
AutoTier,
AutoTierSwitchFailureReason,
Data,
ElicitationCompletedAction,
ElicitationRequestedMode,
ElicitationRequestedSchema,
ManagedSettingsResolvedSource,
PermissionPromptRequestMemory,
PermissionRequestMemory,
PermissionRequestMemoryAction,
SessionAutoTierSwitchFailedData,
SessionEventType,
SessionManagedSettingsResolvedData,
SessionResumeData,
SessionStartData,
SessionTaskCompleteData,
UserMessageAgentMode,
session_event_from_dict,
session_event_to_dict,
)
class TestEventForwardCompatibility:
"""Test forward compatibility for unknown event types."""
@pytest.mark.parametrize(
("event_type", "data"), [("session.idle", {}), ("user.message", {"content": "hello"})]
)
def test_object_event_preserves_complete_envelope(self, event_type, data):
wire = {
"id": "11111111-1111-1111-1111-111111111111",
"timestamp": "2026-09-18T22:00:00+00:00",
"parentId": "22222222-2222-2222-2222-222222222222",
"type": event_type,
"data": data,
}
assert session_event_to_dict(session_event_from_dict(wire)) == wire
@pytest.mark.parametrize(
("event_type", "kind", "fields"),
[
("session.indexed_search", "status", {"state": "ready"}),
(
"session.indexed_search",
"startup",
{
"outcome": "started",
"startupDurationMs": 1.5,
"forcedByEnv": False,
"warmStart": False,
"fileCount": 0,
"eligible": False,
"errorMessage": "diagnostic",
},
),
(
"session.indexed_search",
"server_error",
{"errorType": "unexpected_exit", "exitCode": 0, "errorMessage": "diagnostic"},
),
(
"session.indexed_search",
"incremental",
{
"phase": "updated",
"changedFileCount": 0,
"addedFileCount": 1,
"deletedFileCount": 0,
"totalChangeCount": 1,
"walkDurationMs": 0.5,
"updateDurationMs": 1.25,
"totalDurationMs": 1.75,
},
),
(
"sandbox.decision",
"policy_resolved",
{
"backend": "seatbelt",
"policySource": "default_policy",
"readwritePathsCount": 0,
"readonlyPathsCount": 1,
"deniedPathsCount": 0,
"addCurrentWorkingDirectory": False,
"allowOutbound": False,
"allowLocalNetwork": False,
"proxyMode": "none",
"allowBypass": False,
"gitAuth": False,
"ghAuth": False,
"keychainAccess": False,
},
),
("sandbox.decision", "spawn_completed", {"backend": "seatbelt", "durationMs": 1.5}),
(
"sandbox.decision",
"enforcement_state",
{"backend": "seatbelt", "command": "echo test", "attestation": "spawn_succeeded"},
),
(
"sandbox.decision",
"access_denied",
{
"denialClass": "filesystem_read",
"attestation": "builtin_policy_checked",
"deniedResource": "/example",
"command": "cat example",
},
),
(
"sandbox.decision",
"access_recorded",
{
"denialClass": "filesystem_write",
"permissiveSource": "policy",
"deniedResource": "/example",
},
),
(
"sandbox.decision",
"bypass_decided",
{"source": "user_prompted", "deniedResource": "/example"},
),
(
"sandbox.decision",
"permissive_retry_decided",
{"source": "model_requested", "command": "echo test"},
),
(
"sandbox.decision",
"permissive_retry_completed",
{"processName": "example", "command": "echo test"},
),
],
)
def test_union_event_preserves_complete_envelope(self, event_type, kind, fields):
data = {"kind": kind, **fields}
if event_type == "sandbox.decision":
data.update(
control="process",
outcome="resolved",
platform="macos",
enforcementPoint="shell",
toolCallId="tool-1",
)
wire = {
"id": "11111111-1111-1111-1111-111111111111",
"timestamp": "2026-09-18T22:00:00+00:00",
"parentId": "22222222-2222-2222-2222-222222222222",
"ephemeral": True,
"agentId": "agent-1",
"type": event_type,
"data": data,
}
event = session_event_from_dict(wire)
assert event.type.value == event_type
assert session_event_to_dict(event) == wire
@pytest.mark.parametrize("event_type", ["session.start", "session.resume"])
@pytest.mark.parametrize("tier", ["efficiency", "balance", "intelligence", "fast", None])
def test_auto_tier_lifecycle_events_round_trip(self, event_type, tier):
timestamp = "2026-08-28T00:00:00Z"
data = (
{
"copilotVersion": "1.0.82-1",
"producer": "copilot-agent",
"sessionId": str(uuid4()),
"startTime": timestamp,
"version": 1,
}
if event_type == "session.start"
else {"eventCount": 1, "resumeTime": timestamp}
)
if tier is not None:
data["autoTier"] = tier
event = session_event_from_dict(
{
"id": str(uuid4()),
"timestamp": timestamp,
"parentId": None,
"type": event_type,
"data": data,
}
)
assert isinstance(event.data, (SessionStartData, SessionResumeData))
assert event.data.auto_tier == (AutoTier(tier) if tier is not None else None)
serialized = session_event_to_dict(event)["data"]
if tier is None:
assert "autoTier" not in serialized
else:
assert serialized["autoTier"] == tier
@pytest.mark.parametrize(
"reason",
["policy_rejected", "request_failed", "setup_failed", "unsupported"],
)
def test_auto_tier_switch_failed_event_decodes_every_reason(self, reason):
timestamp = "2026-08-28T00:00:00Z"
event = session_event_from_dict(
{
"id": str(uuid4()),
"timestamp": timestamp,
"parentId": None,
"type": "session.auto_tier_switch_failed",
"data": {
"effectiveAutoTier": "balance",
"requestedAutoTier": "fast",
"reason": reason,
},
}
)
assert isinstance(event.data, SessionAutoTierSwitchFailedData)
assert event.data.reason == AutoTierSwitchFailureReason(reason)
assert event.data.effective_auto_tier == AutoTier.BALANCE
assert event.data.requested_auto_tier == AutoTier.FAST
def test_auto_tier_switch_failed_event_allows_null_requested_tier(self):
# A null requested tier means the attempt to return to provider-default
# Auto routing is what failed.
timestamp = "2026-08-28T00:00:00Z"
event = session_event_from_dict(
{
"id": str(uuid4()),
"timestamp": timestamp,
"parentId": None,
"type": "session.auto_tier_switch_failed",
"data": {
"effectiveAutoTier": "efficiency",
"requestedAutoTier": None,
"reason": "unsupported",
},
}
)
assert isinstance(event.data, SessionAutoTierSwitchFailedData)
assert event.data.requested_auto_tier is None
assert event.data.effective_auto_tier == AutoTier.EFFICIENCY
serialized = session_event_to_dict(event)["data"]
assert serialized["requestedAutoTier"] is None
def test_session_usage_info_is_recognized(self):
"""The session.usage_info event type should be in the enum."""
assert SessionEventType.SESSION_USAGE_INFO.value == "session.usage_info"
def test_unknown_event_type_maps_to_unknown(self):
"""Unknown event types should map to UNKNOWN enum value for forward compatibility."""
unknown_event = {
"id": str(uuid4()),
"timestamp": datetime.now().isoformat(),
"parentId": None,
"type": "session.future_feature_from_server",
"data": {},
}
event = session_event_from_dict(unknown_event)
assert event.type == SessionEventType.UNKNOWN, f"Expected UNKNOWN, got {event.type}"
def test_internal_event_type_maps_to_unknown(self):
"""Internal events should use the forward-compatible raw event path."""
internal_event = {
"id": str(uuid4()),
"timestamp": datetime.now().isoformat(),
"parentId": None,
"type": "session.memory_changed",
"data": {},
}
event = session_event_from_dict(internal_event)
assert event.type == SessionEventType.UNKNOWN
assert session_event_to_dict(event)["type"] == "session.memory_changed"
def test_known_event_preserves_top_level_agent_id(self):
"""Known events should preserve the top-level sub-agent envelope ID."""
known_event = {
"id": str(uuid4()),
"timestamp": datetime.now().isoformat(),
"parentId": None,
"agentId": "agent-1",
"type": "user.message",
"data": {"content": "Hello"},
}
event = session_event_from_dict(known_event)
assert event.agent_id == "agent-1"
assert session_event_to_dict(event)["agentId"] == "agent-1"
def test_unknown_event_preserves_top_level_agent_id(self):
"""Unknown events should preserve the top-level sub-agent envelope ID."""
unknown_event = {
"id": str(uuid4()),
"timestamp": datetime.now().isoformat(),
"parentId": None,
"agentId": "future-agent",
"type": "session.future_feature_from_server",
"data": {"key": "value"},
}
event = session_event_from_dict(unknown_event)
assert event.type == SessionEventType.UNKNOWN
assert event.agent_id == "future-agent"
serialized = session_event_to_dict(event)
assert serialized["agentId"] == "future-agent"
assert serialized["type"] == "session.future_feature_from_server"
def test_malformed_uuid_raises_error(self):
"""Malformed UUIDs should raise ValueError for visibility, not be suppressed."""
malformed_event = {
"id": "not-a-valid-uuid",
"timestamp": datetime.now().isoformat(),
"parentId": None,
"type": "session.start",
"data": {},
}
# This should raise an error and NOT be silently suppressed
with pytest.raises(ValueError):
session_event_from_dict(malformed_event)
def test_malformed_timestamp_raises_error(self):
"""Malformed timestamps should raise an error for visibility."""
malformed_event = {
"id": str(uuid4()),
"timestamp": "not-a-valid-timestamp",
"parentId": None,
"type": "session.start",
"data": {},
}
# This should raise an error and NOT be silently suppressed
with pytest.raises((ValueError, TypeError)):
session_event_from_dict(malformed_event)
def test_explicit_generated_symbols_remain_available(self):
"""Explicit generated helper symbols should remain importable."""
assert ElicitationCompletedAction.ACCEPT.value == "accept"
assert UserMessageAgentMode.INTERACTIVE.value == "interactive"
assert ElicitationRequestedMode.FORM.value == "form"
assert AttachmentGitHubReferenceType.PR.value == "pr"
schema = ElicitationRequestedSchema(
properties={"answer": {"type": "string"}}, type="object"
)
assert schema.to_dict()["type"] == "object"
def test_managed_settings_client_provenance_round_trips(self):
"""Managed settings events should preserve truthful client provenance."""
assert [source.value for source in ManagedSettingsResolvedSource] == [
"server",
"device",
"client",
"policyHelper",
"mixed",
"none",
]
client = SessionManagedSettingsResolvedData(
bypass_permissions_disabled=True,
client_managed=True,
device_managed=False,
fail_closed=False,
managed_keys=["permissions"],
server_managed=False,
source=ManagedSettingsResolvedSource.CLIENT,
)
serialized = client.to_dict()
assert serialized["source"] == "client"
assert serialized["clientManaged"] is True
assert SessionManagedSettingsResolvedData.from_dict(serialized) == client
mixed = SessionManagedSettingsResolvedData(
bypass_permissions_disabled=True,
device_managed=True,
fail_closed=False,
managed_keys=["permissions"],
server_managed=True,
source=ManagedSettingsResolvedSource.MIXED,
)
serialized = mixed.to_dict()
assert serialized["source"] == "mixed"
assert "clientManaged" not in serialized
def test_data_shim_preserves_raw_mapping_values(self):
"""Compatibility Data should keep arbitrary nested mappings as plain dicts."""
parsed = Data.from_dict(
{
"arguments": {"toolCallId": "call-1"},
"input": {"step_name": "build"},
}
)
assert parsed.arguments == {"toolCallId": "call-1"}
assert isinstance(parsed.arguments, dict)
assert parsed.input == {"step_name": "build"}
assert isinstance(parsed.input, dict)
constructed = Data(arguments={"tool_call_id": "call-1"})
assert constructed.to_dict() == {"arguments": {"tool_call_id": "call-1"}}
def test_data_shim_preserves_abbreviation_json_keys_on_round_trip(self):
"""Data.from_dict(x).to_dict() should preserve JSON keys with abbreviations.
Regression test for github/copilot-sdk#1138: keys like userURL, sessionID,
and OAuthToken were rewritten on round-trip because _compat_to_json_key could
not reconstruct the original camelCase abbreviation casing.
"""
for key in ["userURL", "sessionID", "XMLPayload", "serverIP", "OAuthToken"]:
incoming = {key: 42}
assert Data.from_dict(incoming).to_dict() == incoming
def test_data_shim_preserves_colliding_json_keys_on_round_trip(self):
"""Data.from_dict(x).to_dict() should preserve keys with the same Python name."""
colliding_keys = {"userURL": 42, "userUrl": 43}
assert Data.from_dict(colliding_keys).to_dict() == colliding_keys
def test_missing_optional_fields_remain_none_after_parsing(self):
"""Generated event models should leave missing optional fields as None.
Regression test for github/copilot-sdk issues #1139, #1140, and #1141:
the Python codegen previously baked JSON Schema `default` values into
``obj.get(key, default)`` for optional fields, so ``from_dict()`` returned
the schema default instead of ``None`` and broke ``from_dict(to_dict(x))``
round-trips for instances where the field was ``None``.
"""
from copilot.generated.session_events import (
_load_PermissionPromptRequest,
_load_PermissionRequest,
)
# #1141: PermissionRequest.action defaults to None when missing.
request = _load_PermissionRequest({"kind": "memory", "fact": "remember this"})
assert isinstance(request, PermissionRequestMemory)
assert request.action is None
assert PermissionRequestMemoryAction.STORE.value == "store" # sanity
# #1140: PermissionPromptRequest.action defaults to None when missing.
prompt_request = _load_PermissionPromptRequest({"kind": "memory", "fact": "remember this"})
assert isinstance(prompt_request, PermissionPromptRequestMemory)
assert prompt_request.action is None
# #1139: SessionTaskCompleteData.summary defaults to None when missing.
task_complete = SessionTaskCompleteData.from_dict({"success": True})
assert task_complete.summary is None
# Explicit JSON null should also map to None.
task_complete_null = SessionTaskCompleteData.from_dict({"success": True, "summary": None})
assert task_complete_null.summary is None
def test_optional_fields_round_trip_none(self):
"""``from_dict(to_dict(x))`` should equal ``x`` when optional fields are None.
Regression test for github/copilot-sdk issues #1139, #1140, and #1141.
"""
# #1139: SessionTaskCompleteData round-trip with summary=None.
task = SessionTaskCompleteData(success=None, summary=None)
assert SessionTaskCompleteData.from_dict(task.to_dict()) == task
# #1140: PermissionPromptRequestMemory round-trip with action=None.
prompt = PermissionPromptRequestMemory(fact="test-fact")
assert prompt.action is None
assert "action" not in prompt.to_dict()
assert PermissionPromptRequestMemory.from_dict(prompt.to_dict()) == prompt
# #1141: PermissionRequestMemory round-trip with action=None.
permission = PermissionRequestMemory(fact="test-fact")
assert permission.action is None
assert "action" not in permission.to_dict()
assert PermissionRequestMemory.from_dict(permission.to_dict()) == permission
# PermissionRequest is now a discriminated union; the dispatch loader
# should round-trip via the correct variant class.
from copilot.generated.session_events import _load_PermissionRequest
round_tripped = _load_PermissionRequest(permission.to_dict())
assert isinstance(round_tripped, PermissionRequestMemory)
assert round_tripped == permission
# PermissionPromptRequest likewise.
from copilot.generated.session_events import _load_PermissionPromptRequest
round_tripped_prompt = _load_PermissionPromptRequest(prompt.to_dict())
assert isinstance(round_tripped_prompt, PermissionPromptRequestMemory)
assert round_tripped_prompt == prompt
You can’t perform that action at this time.