-
Notifications
You must be signed in to change notification settings - Fork 720
Expand file tree
/
Copy pathTaskSerializationTests.cs
More file actions
517 lines (438 loc) · 20.8 KB
/
Copy pathTaskSerializationTests.cs
File metadata and controls
517 lines (438 loc) · 20.8 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
using ModelContextProtocol.Protocol;
using System.Text.Json;
using System.Text.Json.Nodes;
namespace ModelContextProtocol.Tests.Protocol;
/// <summary>
/// Serialization and deserialization tests for SEP-2663 task protocol types.
/// </summary>
public static class TaskSerializationTests
{
#region CreateTaskResult
[Fact]
public static void CreateTaskResult_SerializationRoundTrip_PreservesAllProperties()
{
var original = new CreateTaskResult
{
TaskId = "task-123",
Status = McpTaskStatus.Working,
StatusMessage = "Processing...",
CreatedAt = new DateTimeOffset(2025, 6, 1, 12, 0, 0, TimeSpan.Zero),
LastUpdatedAt = new DateTimeOffset(2025, 6, 1, 12, 5, 0, TimeSpan.Zero),
TimeToLive = TimeSpan.FromHours(1),
PollIntervalMs = 5000,
ResultType = "task",
Meta = new JsonObject { ["key"] = "value" }
};
string json = JsonSerializer.Serialize(original, McpJsonUtilities.DefaultOptions);
var deserialized = JsonSerializer.Deserialize<CreateTaskResult>(json, McpJsonUtilities.DefaultOptions);
Assert.NotNull(deserialized);
Assert.Equal("task-123", deserialized.TaskId);
Assert.Equal(McpTaskStatus.Working, deserialized.Status);
Assert.Equal("Processing...", deserialized.StatusMessage);
Assert.Equal(original.CreatedAt, deserialized.CreatedAt);
Assert.Equal(original.LastUpdatedAt, deserialized.LastUpdatedAt);
Assert.Equal(TimeSpan.FromHours(1), deserialized.TimeToLive);
Assert.Equal(5000, deserialized.PollIntervalMs);
Assert.Equal("task", deserialized.ResultType);
Assert.NotNull(deserialized.Meta);
Assert.Equal("value", (string)deserialized.Meta["key"]!);
}
[Fact]
public static void CreateTaskResult_UsesCorrectWireFieldNames()
{
var result = new CreateTaskResult
{
TaskId = "t1",
Status = McpTaskStatus.Working,
CreatedAt = DateTimeOffset.UtcNow,
LastUpdatedAt = DateTimeOffset.UtcNow,
TimeToLive = TimeSpan.FromMinutes(1),
PollIntervalMs = 1000,
ResultType = "task",
};
string json = JsonSerializer.Serialize(result, McpJsonUtilities.DefaultOptions);
// Must use camelCase wire names
Assert.Contains("\"ttlMs\":", json);
Assert.Contains("\"pollIntervalMs\":", json);
Assert.Contains("\"taskId\":", json);
Assert.Contains("\"resultType\":\"task\"", json);
// Must NOT contain legacy field names
Assert.DoesNotContain("\"ttl\":", json);
Assert.DoesNotContain("\"pollInterval\":", json);
}
[Fact]
public static void CreateTaskResult_ResultType_SerializesAsTask()
{
var result = new CreateTaskResult
{
TaskId = "t1",
Status = McpTaskStatus.Working,
CreatedAt = DateTimeOffset.UtcNow,
LastUpdatedAt = DateTimeOffset.UtcNow,
ResultType = "task",
};
string json = JsonSerializer.Serialize(result, McpJsonUtilities.DefaultOptions);
var node = JsonNode.Parse(json)!;
Assert.Equal("task", (string)node["resultType"]!);
}
#endregion
#region GetTaskResult Subtypes
[Fact]
public static void GetTaskResult_Working_RoundTrip()
{
var original = new WorkingTaskResult
{
TaskId = "w1",
CreatedAt = new DateTimeOffset(2025, 1, 1, 0, 0, 0, TimeSpan.Zero),
LastUpdatedAt = new DateTimeOffset(2025, 1, 1, 0, 1, 0, TimeSpan.Zero),
StatusMessage = "In progress",
PollIntervalMs = 2000,
};
string json = JsonSerializer.Serialize<GetTaskResult>(original, McpJsonUtilities.DefaultOptions);
var deserialized = JsonSerializer.Deserialize<GetTaskResult>(json, McpJsonUtilities.DefaultOptions);
var working = Assert.IsType<WorkingTaskResult>(deserialized);
Assert.Equal("w1", working.TaskId);
Assert.Equal(McpTaskStatus.Working, working.Status);
Assert.Equal("In progress", working.StatusMessage);
Assert.Equal(2000, working.PollIntervalMs);
}
[Fact]
public static void GetTaskResult_Completed_RoundTrip_IncludesResult()
{
var resultPayload = JsonElement.Parse("""{"content":[{"type":"text","text":"done"}]}""");
var original = new CompletedTaskResult
{
TaskId = "c1",
CreatedAt = DateTimeOffset.UtcNow,
LastUpdatedAt = DateTimeOffset.UtcNow,
Result = resultPayload,
};
string json = JsonSerializer.Serialize<GetTaskResult>(original, McpJsonUtilities.DefaultOptions);
var deserialized = JsonSerializer.Deserialize<GetTaskResult>(json, McpJsonUtilities.DefaultOptions);
var completed = Assert.IsType<CompletedTaskResult>(deserialized);
Assert.Equal("c1", completed.TaskId);
Assert.Equal(McpTaskStatus.Completed, completed.Status);
Assert.Equal(JsonValueKind.Object, completed.Result.ValueKind);
}
[Fact]
public static void GetTaskResult_Failed_RoundTrip_IncludesError()
{
var errorPayload = JsonElement.Parse("""{"code":-32000,"message":"internal error"}""");
var original = new FailedTaskResult
{
TaskId = "f1",
CreatedAt = DateTimeOffset.UtcNow,
LastUpdatedAt = DateTimeOffset.UtcNow,
Error = errorPayload,
};
string json = JsonSerializer.Serialize<GetTaskResult>(original, McpJsonUtilities.DefaultOptions);
var deserialized = JsonSerializer.Deserialize<GetTaskResult>(json, McpJsonUtilities.DefaultOptions);
var failed = Assert.IsType<FailedTaskResult>(deserialized);
Assert.Equal("f1", failed.TaskId);
Assert.Equal(McpTaskStatus.Failed, failed.Status);
Assert.Equal(-32000, failed.Error.GetProperty("code").GetInt32());
}
[Fact]
public static void GetTaskResult_Cancelled_RoundTrip()
{
var original = new CancelledTaskResult
{
TaskId = "x1",
CreatedAt = DateTimeOffset.UtcNow,
LastUpdatedAt = DateTimeOffset.UtcNow,
StatusMessage = "User cancelled",
};
string json = JsonSerializer.Serialize<GetTaskResult>(original, McpJsonUtilities.DefaultOptions);
var deserialized = JsonSerializer.Deserialize<GetTaskResult>(json, McpJsonUtilities.DefaultOptions);
var cancelled = Assert.IsType<CancelledTaskResult>(deserialized);
Assert.Equal("x1", cancelled.TaskId);
Assert.Equal(McpTaskStatus.Cancelled, cancelled.Status);
Assert.Equal("User cancelled", cancelled.StatusMessage);
}
[Fact]
public static void GetTaskResult_InputRequired_RoundTrip_IncludesInputRequests()
{
var inputRequests = new Dictionary<string, InputRequest>
{
["req-1"] = new InputRequest
{
Method = "elicitation/create",
Params = JsonElement.Parse("""{"message":"Confirm?"}"""),
}
};
var original = new InputRequiredTaskResult
{
TaskId = "i1",
CreatedAt = DateTimeOffset.UtcNow,
LastUpdatedAt = DateTimeOffset.UtcNow,
InputRequests = inputRequests,
};
string json = JsonSerializer.Serialize<GetTaskResult>(original, McpJsonUtilities.DefaultOptions);
var deserialized = JsonSerializer.Deserialize<GetTaskResult>(json, McpJsonUtilities.DefaultOptions);
var inputRequired = Assert.IsType<InputRequiredTaskResult>(deserialized);
Assert.Equal("i1", inputRequired.TaskId);
Assert.Equal(McpTaskStatus.InputRequired, inputRequired.Status);
Assert.NotNull(inputRequired.InputRequests);
Assert.Single(inputRequired.InputRequests);
Assert.True(inputRequired.InputRequests.ContainsKey("req-1"));
}
[Fact]
public static void GetTaskResult_Converter_DispatchesToCorrectSubtypeByStatus()
{
var statuses = new (string status, Type expectedType)[]
{
("working", typeof(WorkingTaskResult)),
("completed", typeof(CompletedTaskResult)),
("failed", typeof(FailedTaskResult)),
("cancelled", typeof(CancelledTaskResult)),
("input_required", typeof(InputRequiredTaskResult)),
};
foreach (var (status, expectedType) in statuses)
{
var json = status switch
{
"completed" => """{"taskId":"t","status":"completed","createdAt":"2025-01-01T00:00:00Z","lastUpdatedAt":"2025-01-01T00:00:00Z","result":{}}""",
"failed" => """{"taskId":"t","status":"failed","createdAt":"2025-01-01T00:00:00Z","lastUpdatedAt":"2025-01-01T00:00:00Z","error":{}}""",
"input_required" => """{"taskId":"t","status":"input_required","createdAt":"2025-01-01T00:00:00Z","lastUpdatedAt":"2025-01-01T00:00:00Z","inputRequests":{}}""",
_ => $$$"""{"taskId":"t","status":"{{{status}}}","createdAt":"2025-01-01T00:00:00Z","lastUpdatedAt":"2025-01-01T00:00:00Z"}""",
};
var result = JsonSerializer.Deserialize<GetTaskResult>(json, McpJsonUtilities.DefaultOptions);
Assert.NotNull(result);
Assert.IsType(expectedType, result);
}
}
[Fact]
public static void GetTaskResult_MissingTaskId_ThrowsJsonException()
{
var json = """{"status":"working","createdAt":"2025-01-01T00:00:00Z","lastUpdatedAt":"2025-01-01T00:00:00Z"}""";
Assert.Throws<JsonException>(() => JsonSerializer.Deserialize<GetTaskResult>(json, McpJsonUtilities.DefaultOptions));
}
[Fact]
public static void GetTaskResult_MissingStatus_ThrowsJsonException()
{
var json = """{"taskId":"t","createdAt":"2025-01-01T00:00:00Z","lastUpdatedAt":"2025-01-01T00:00:00Z"}""";
Assert.Throws<JsonException>(() => JsonSerializer.Deserialize<GetTaskResult>(json, McpJsonUtilities.DefaultOptions));
}
[Fact]
public static void GetTaskResult_UnknownStatus_ThrowsJsonException()
{
var json = """{"taskId":"t","status":"exploded","createdAt":"2025-01-01T00:00:00Z","lastUpdatedAt":"2025-01-01T00:00:00Z"}""";
Assert.Throws<JsonException>(() => JsonSerializer.Deserialize<GetTaskResult>(json, McpJsonUtilities.DefaultOptions));
}
[Fact]
public static void GetTaskResult_CompletedMissingResult_ThrowsJsonException()
{
var json = """{"taskId":"t","status":"completed","createdAt":"2025-01-01T00:00:00Z","lastUpdatedAt":"2025-01-01T00:00:00Z"}""";
Assert.Throws<JsonException>(() => JsonSerializer.Deserialize<GetTaskResult>(json, McpJsonUtilities.DefaultOptions));
}
[Fact]
public static void GetTaskResult_FailedMissingError_ThrowsJsonException()
{
var json = """{"taskId":"t","status":"failed","createdAt":"2025-01-01T00:00:00Z","lastUpdatedAt":"2025-01-01T00:00:00Z"}""";
Assert.Throws<JsonException>(() => JsonSerializer.Deserialize<GetTaskResult>(json, McpJsonUtilities.DefaultOptions));
}
[Fact]
public static void GetTaskResult_InputRequiredMissingInputRequests_ThrowsJsonException()
{
var json = """{"taskId":"t","status":"input_required","createdAt":"2025-01-01T00:00:00Z","lastUpdatedAt":"2025-01-01T00:00:00Z"}""";
Assert.Throws<JsonException>(() => JsonSerializer.Deserialize<GetTaskResult>(json, McpJsonUtilities.DefaultOptions));
}
[Theory]
[InlineData(typeof(WorkingTaskResult))]
[InlineData(typeof(CompletedTaskResult))]
[InlineData(typeof(FailedTaskResult))]
[InlineData(typeof(CancelledTaskResult))]
[InlineData(typeof(InputRequiredTaskResult))]
public static void GetTaskResult_WireResultType_IsComplete_WhenSet(Type subType)
{
// SEP-2663: standard task responses (tasks/get, tasks/update, tasks/cancel) use resultType="complete".
var created = new DateTimeOffset(2025, 1, 1, 0, 0, 0, TimeSpan.Zero);
GetTaskResult value = subType switch
{
Type t when t == typeof(WorkingTaskResult) => new WorkingTaskResult { TaskId = "t", CreatedAt = created, LastUpdatedAt = created, ResultType = "complete" },
Type t when t == typeof(CompletedTaskResult) => new CompletedTaskResult { TaskId = "t", CreatedAt = created, LastUpdatedAt = created, Result = JsonElement.Parse("""{"ok":true}"""), ResultType = "complete" },
Type t when t == typeof(FailedTaskResult) => new FailedTaskResult { TaskId = "t", CreatedAt = created, LastUpdatedAt = created, Error = JsonElement.Parse("""{"code":-32603,"message":"boom"}"""), ResultType = "complete" },
Type t when t == typeof(CancelledTaskResult) => new CancelledTaskResult { TaskId = "t", CreatedAt = created, LastUpdatedAt = created, ResultType = "complete" },
Type t when t == typeof(InputRequiredTaskResult) => new InputRequiredTaskResult
{
TaskId = "t",
CreatedAt = created,
LastUpdatedAt = created,
ResultType = "complete",
InputRequests = new Dictionary<string, InputRequest>
{
["k"] = new InputRequest
{
Method = "test/method",
Params = JsonSerializer.SerializeToElement("ask", McpJsonUtilities.DefaultOptions),
},
},
},
_ => throw new InvalidOperationException()
};
string json = JsonSerializer.Serialize(value, McpJsonUtilities.DefaultOptions);
var node = JsonNode.Parse(json)!;
Assert.Equal("complete", (string?)node["resultType"]);
}
#endregion
#region McpTaskStatus Enum
[Theory]
[InlineData(McpTaskStatus.Working, "working")]
[InlineData(McpTaskStatus.InputRequired, "input_required")]
[InlineData(McpTaskStatus.Completed, "completed")]
[InlineData(McpTaskStatus.Cancelled, "cancelled")]
[InlineData(McpTaskStatus.Failed, "failed")]
public static void McpTaskStatus_SerializesAsSnakeCase(McpTaskStatus status, string expectedWireValue)
{
string json = JsonSerializer.Serialize(status, McpJsonUtilities.DefaultOptions);
Assert.Equal($"\"{expectedWireValue}\"", json);
var deserialized = JsonSerializer.Deserialize<McpTaskStatus>(json, McpJsonUtilities.DefaultOptions);
Assert.Equal(status, deserialized);
}
#endregion
#region TaskStatusNotificationParams
[Fact]
public static void TaskStatusNotificationParams_Working_RoundTrip()
{
var original = new WorkingTaskNotificationParams
{
TaskId = "n1",
CreatedAt = DateTimeOffset.UtcNow,
LastUpdatedAt = DateTimeOffset.UtcNow,
StatusMessage = "Working on it",
};
string json = JsonSerializer.Serialize<TaskStatusNotificationParams>(original, McpJsonUtilities.DefaultOptions);
var deserialized = JsonSerializer.Deserialize<TaskStatusNotificationParams>(json, McpJsonUtilities.DefaultOptions);
var working = Assert.IsType<WorkingTaskNotificationParams>(deserialized);
Assert.Equal("n1", working.TaskId);
Assert.Equal("Working on it", working.StatusMessage);
}
[Fact]
public static void TaskStatusNotificationParams_Completed_RoundTrip()
{
var resultPayload = JsonElement.Parse("""{"text":"done"}""");
var original = new CompletedTaskNotificationParams
{
TaskId = "n2",
CreatedAt = DateTimeOffset.UtcNow,
LastUpdatedAt = DateTimeOffset.UtcNow,
Result = resultPayload,
};
string json = JsonSerializer.Serialize<TaskStatusNotificationParams>(original, McpJsonUtilities.DefaultOptions);
var deserialized = JsonSerializer.Deserialize<TaskStatusNotificationParams>(json, McpJsonUtilities.DefaultOptions);
var completed = Assert.IsType<CompletedTaskNotificationParams>(deserialized);
Assert.Equal("n2", completed.TaskId);
Assert.Equal("done", completed.Result.GetProperty("text").GetString());
}
[Fact]
public static void TaskStatusNotificationParams_Failed_RoundTrip()
{
var errorPayload = JsonElement.Parse("""{"code":-1,"message":"boom"}""");
var original = new FailedTaskNotificationParams
{
TaskId = "n3",
CreatedAt = DateTimeOffset.UtcNow,
LastUpdatedAt = DateTimeOffset.UtcNow,
Error = errorPayload,
};
string json = JsonSerializer.Serialize<TaskStatusNotificationParams>(original, McpJsonUtilities.DefaultOptions);
var deserialized = JsonSerializer.Deserialize<TaskStatusNotificationParams>(json, McpJsonUtilities.DefaultOptions);
var failed = Assert.IsType<FailedTaskNotificationParams>(deserialized);
Assert.Equal("n3", failed.TaskId);
Assert.Equal("boom", failed.Error.GetProperty("message").GetString());
}
[Fact]
public static void TaskStatusNotificationParams_Cancelled_RoundTrip()
{
var original = new CancelledTaskNotificationParams
{
TaskId = "n4",
CreatedAt = DateTimeOffset.UtcNow,
LastUpdatedAt = DateTimeOffset.UtcNow,
};
string json = JsonSerializer.Serialize<TaskStatusNotificationParams>(original, McpJsonUtilities.DefaultOptions);
var deserialized = JsonSerializer.Deserialize<TaskStatusNotificationParams>(json, McpJsonUtilities.DefaultOptions);
Assert.IsType<CancelledTaskNotificationParams>(deserialized);
}
[Fact]
public static void TaskStatusNotificationParams_InputRequired_RoundTrip()
{
var inputRequests = new Dictionary<string, InputRequest>
{
["r1"] = new InputRequest { Method = "sampling/createMessage" }
};
var original = new InputRequiredTaskNotificationParams
{
TaskId = "n5",
CreatedAt = DateTimeOffset.UtcNow,
LastUpdatedAt = DateTimeOffset.UtcNow,
InputRequests = inputRequests,
};
string json = JsonSerializer.Serialize<TaskStatusNotificationParams>(original, McpJsonUtilities.DefaultOptions);
var deserialized = JsonSerializer.Deserialize<TaskStatusNotificationParams>(json, McpJsonUtilities.DefaultOptions);
var inputRequired = Assert.IsType<InputRequiredTaskNotificationParams>(deserialized);
Assert.NotNull(inputRequired.InputRequests);
Assert.Single(inputRequired.InputRequests);
}
#endregion
#region ResultOrCreatedTask
[Fact]
public static void ResultOrCreatedTask_ImplicitConversion_FromResult()
{
CallToolResult callResult = new() { Content = [new TextContentBlock { Text = "hi" }] };
ResultOrCreatedTask<CallToolResult> augmented = callResult;
Assert.False(augmented.IsTask);
Assert.Same(callResult, augmented.Result);
Assert.Null(augmented.TaskCreated);
}
[Fact]
public static void ResultOrCreatedTask_ImplicitConversion_FromCreateTaskResult()
{
CreateTaskResult taskCreated = new()
{
TaskId = "t1",
Status = McpTaskStatus.Working,
CreatedAt = DateTimeOffset.UtcNow,
LastUpdatedAt = DateTimeOffset.UtcNow,
};
ResultOrCreatedTask<CallToolResult> augmented = taskCreated;
Assert.True(augmented.IsTask);
Assert.Same(taskCreated, augmented.TaskCreated);
Assert.Null(augmented.Result);
}
[Fact]
public static void ResultOrCreatedTask_IsTask_FalseForResult_TrueForTask()
{
var result = new ResultOrCreatedTask<CallToolResult>(new CallToolResult());
var task = new ResultOrCreatedTask<CallToolResult>(new CreateTaskResult
{
TaskId = "t",
Status = McpTaskStatus.Working,
CreatedAt = DateTimeOffset.UtcNow,
LastUpdatedAt = DateTimeOffset.UtcNow,
});
Assert.False(result.IsTask);
Assert.True(task.IsTask);
}
#endregion
#region UpdateTaskResult / CancelTaskResult Wire Format
[Fact]
public static void UpdateTaskResult_WireResultType_IsComplete_WhenSet()
{
// SEP-2663: tasks/update responses use resultType="complete".
var result = new UpdateTaskResult { ResultType = "complete" };
string json = JsonSerializer.Serialize(result, McpJsonUtilities.DefaultOptions);
var node = JsonNode.Parse(json)!;
Assert.Equal("complete", (string?)node["resultType"]);
}
[Fact]
public static void CancelTaskResult_WireResultType_IsComplete_WhenSet()
{
// SEP-2663: tasks/cancel responses use resultType="complete".
var result = new CancelTaskResult { ResultType = "complete" };
string json = JsonSerializer.Serialize(result, McpJsonUtilities.DefaultOptions);
var node = JsonNode.Parse(json)!;
Assert.Equal("complete", (string?)node["resultType"]);
}
#endregion
}