|
| 1 | +/*--------------------------------------------------------------------------------------------- |
| 2 | + * Copyright (c) Microsoft Corporation. All rights reserved. |
| 3 | + *--------------------------------------------------------------------------------------------*/ |
| 4 | + |
| 5 | +using Xunit; |
| 6 | + |
| 7 | +namespace GitHub.Copilot.SDK.Test; |
| 8 | + |
| 9 | +/// <summary> |
| 10 | +/// Tests for forward-compatible handling of unknown session event types. |
| 11 | +/// Verifies that the SDK gracefully handles event types introduced by newer CLI versions. |
| 12 | +/// </summary> |
| 13 | +public class ForwardCompatibilityTests |
| 14 | +{ |
| 15 | + [Fact] |
| 16 | + public void FromJson_KnownEventType_DeserializesNormally() |
| 17 | + { |
| 18 | + var json = """ |
| 19 | + { |
| 20 | + "id": "00000000-0000-0000-0000-000000000001", |
| 21 | + "timestamp": "2026-01-01T00:00:00Z", |
| 22 | + "parentId": null, |
| 23 | + "type": "user.message", |
| 24 | + "data": { |
| 25 | + "content": "Hello" |
| 26 | + } |
| 27 | + } |
| 28 | + """; |
| 29 | + |
| 30 | + var result = SessionEvent.FromJson(json); |
| 31 | + |
| 32 | + Assert.IsType<UserMessageEvent>(result); |
| 33 | + Assert.Equal("user.message", result.Type); |
| 34 | + } |
| 35 | + |
| 36 | + [Fact] |
| 37 | + public void FromJson_UnknownEventType_ReturnsBaseSessionEvent() |
| 38 | + { |
| 39 | + var json = """ |
| 40 | + { |
| 41 | + "id": "12345678-1234-1234-1234-123456789abc", |
| 42 | + "timestamp": "2026-06-15T10:30:00Z", |
| 43 | + "parentId": "abcdefab-abcd-abcd-abcd-abcdefabcdef", |
| 44 | + "type": "future.feature_from_server", |
| 45 | + "data": { "key": "value" } |
| 46 | + } |
| 47 | + """; |
| 48 | + |
| 49 | + var result = SessionEvent.FromJson(json); |
| 50 | + |
| 51 | + Assert.IsType<SessionEvent>(result); |
| 52 | + Assert.Equal("unknown", result.Type); |
| 53 | + } |
| 54 | + |
| 55 | + [Fact] |
| 56 | + public void FromJson_UnknownEventType_PreservesBaseMetadata() |
| 57 | + { |
| 58 | + var json = """ |
| 59 | + { |
| 60 | + "id": "12345678-1234-1234-1234-123456789abc", |
| 61 | + "timestamp": "2026-06-15T10:30:00Z", |
| 62 | + "parentId": "abcdefab-abcd-abcd-abcd-abcdefabcdef", |
| 63 | + "type": "future.feature_from_server", |
| 64 | + "data": {} |
| 65 | + } |
| 66 | + """; |
| 67 | + |
| 68 | + var result = SessionEvent.FromJson(json); |
| 69 | + |
| 70 | + Assert.Equal(Guid.Parse("12345678-1234-1234-1234-123456789abc"), result.Id); |
| 71 | + Assert.Equal(DateTimeOffset.Parse("2026-06-15T10:30:00Z"), result.Timestamp); |
| 72 | + Assert.Equal(Guid.Parse("abcdefab-abcd-abcd-abcd-abcdefabcdef"), result.ParentId); |
| 73 | + } |
| 74 | + |
| 75 | + [Fact] |
| 76 | + public void FromJson_MultipleEvents_MixedKnownAndUnknown() |
| 77 | + { |
| 78 | + var events = new[] |
| 79 | + { |
| 80 | + """{"id":"00000000-0000-0000-0000-000000000001","timestamp":"2026-01-01T00:00:00Z","parentId":null,"type":"user.message","data":{"content":"Hi"}}""", |
| 81 | + """{"id":"00000000-0000-0000-0000-000000000002","timestamp":"2026-01-01T00:00:00Z","parentId":null,"type":"future.unknown_type","data":{}}""", |
| 82 | + """{"id":"00000000-0000-0000-0000-000000000003","timestamp":"2026-01-01T00:00:00Z","parentId":null,"type":"user.message","data":{"content":"Bye"}}""", |
| 83 | + }; |
| 84 | + |
| 85 | + var results = events.Select(SessionEvent.FromJson).ToList(); |
| 86 | + |
| 87 | + Assert.Equal(3, results.Count); |
| 88 | + Assert.IsType<UserMessageEvent>(results[0]); |
| 89 | + Assert.IsType<SessionEvent>(results[1]); |
| 90 | + Assert.IsType<UserMessageEvent>(results[2]); |
| 91 | + } |
| 92 | + |
| 93 | + [Fact] |
| 94 | + public void SessionEvent_Type_DefaultsToUnknown() |
| 95 | + { |
| 96 | + var evt = new SessionEvent(); |
| 97 | + |
| 98 | + Assert.Equal("unknown", evt.Type); |
| 99 | + } |
| 100 | +} |
0 commit comments