-
Notifications
You must be signed in to change notification settings - Fork 368
/
KernelSchedulerTests.cs
731 lines (583 loc) · 20.5 KB
/
KernelSchedulerTests.cs
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
// Copyright (c) .NET Foundation and contributors. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using FluentAssertions;
using FluentAssertions.Execution;
using Microsoft.DotNet.Interactive.Tests.Utility;
using Microsoft.DotNet.Interactive.Utility;
using Pocket;
using Xunit;
using Xunit.Abstractions;
using static Pocket.Logger<Microsoft.DotNet.Interactive.Tests.KernelSchedulerTests>;
#pragma warning disable CS1998
#pragma warning disable CS0162
namespace Microsoft.DotNet.Interactive.Tests;
public class KernelSchedulerTests : IDisposable
{
private readonly CompositeDisposable _disposables = new();
public KernelSchedulerTests(ITestOutputHelper output)
{
DisposeAfterTest(output.SubscribeToPocketLogger());
}
public void Dispose()
{
try
{
_disposables?.Dispose();
}
catch (Exception ex)
{
Log.Error(exception: ex);
}
}
private void DisposeAfterTest(IDisposable disposable)
{
_disposables.Add(disposable);
}
[Fact]
public async Task top_level_scheduled_work_is_completed_in_order()
{
using var scheduler = new KernelScheduler<int, int>();
var executionList = new List<int>();
await scheduler.RunAsync(1, PerformWork);
await scheduler.RunAsync(2, PerformWork);
await scheduler.RunAsync(3, PerformWork);
executionList.Should().BeEquivalentSequenceTo(1, 2, 3);
Task<int> PerformWork(int v)
{
executionList.Add(v);
return Task.FromResult(v);
}
}
[Fact]
public async Task top_level_scheduled_work_does_not_execute_in_parallel()
{
using var scheduler = new KernelScheduler<int, int>();
var concurrencyCounter = 0;
var maxObservedParallelism = 0;
var tasks = Enumerable.Range(1, 3).Select(i =>
{
return scheduler.RunAsync(i, async v =>
{
Interlocked.Increment(ref concurrencyCounter);
await Task.Delay(100);
maxObservedParallelism = Math.Max(concurrencyCounter, maxObservedParallelism);
Interlocked.Decrement(ref concurrencyCounter);
return v;
});
});
await Task.WhenAll(tasks);
maxObservedParallelism.Should().Be(1);
}
public class TestKernelScheduler<T> : KernelScheduler<T, T>
{
private readonly Func<T, T, bool> _isChildOperation;
public TestKernelScheduler(Func<T, T, bool> isChildOperation)
{
_isChildOperation = isChildOperation;
}
protected override bool IsChildOperation(T current, T incoming) => _isChildOperation(current, incoming);
}
[Fact]
public async Task deferred_work_is_executed_before_new_work()
{
var executionList = new List<int>();
Task<int> PerformWork(int v)
{
executionList.Add(v);
return Task.FromResult(v);
}
using var scheduler = new KernelScheduler<int, int>();
scheduler.RegisterDeferredOperationSource(
(v, _) => Enumerable.Repeat(v * 10, v).ToList(), PerformWork);
for (var i = 1; i <= 3; i++)
{
await scheduler.RunAsync(i, PerformWork);
}
executionList.Should().BeEquivalentSequenceTo(10, 1, 20, 20, 2, 30, 30, 30, 3);
}
[Fact]
public async Task Deferred_work_in_progress_is_allowed_to_complete_when_the_work_that_triggered_it_is_cancelled()
{
using var scheduler = new KernelScheduler<int, int>();
var cts = new CancellationTokenSource();
var deferredOperations = new[] { 1, 2, 3 };
var completedDeferredOperations = new List<int>();
var deferredOperationsTaskCompletionSource = new TaskCompletionSource<bool>();
scheduler.RegisterDeferredOperationSource(
(_, _) => deferredOperations,
async i =>
{
if (!cts.IsCancellationRequested)
{
cts.Cancel();
}
await Task.Delay(50);
completedDeferredOperations.Add(i);
if (completedDeferredOperations.Count == deferredOperations.Length)
{
deferredOperationsTaskCompletionSource.SetResult(true);
}
return i;
});
var run = () => scheduler.RunAsync(4, Task.FromResult, cancellationToken: cts.Token);
await run.Invoking(async r => await r())
.Should()
.ThrowAsync<OperationCanceledException>();
await Task.WhenAny(
deferredOperationsTaskCompletionSource.Task,
Task.Delay(TimeSpan.FromSeconds(5)));
completedDeferredOperations
.Should()
.BeEquivalentTo(deferredOperations);
}
[Fact]
public void disposing_scheduler_prevents_later_scheduled_work_from_executing()
{
using var scheduler = new KernelScheduler<int, int>();
var barrier = new Barrier(2);
var laterWorkWasExecuted = false;
var t1 = scheduler.RunAsync(1, async v =>
{
barrier.SignalAndWait();
await Task.Delay(3000);
return v;
});
var t2 = scheduler.RunAsync(2, v =>
{
laterWorkWasExecuted = true;
return Task.FromResult(v);
});
barrier.SignalAndWait();
scheduler.Dispose();
t2.Status.Should().Be(TaskStatus.WaitingForActivation);
laterWorkWasExecuted.Should().BeFalse();
}
#if NETFRAMEWORK
[FactSkipNetFramework]
#else
[FactSkipLinux]
#endif
public void cancelling_work_in_progress_prevents_subsequent_work_scheduled_before_cancellation_from_executing()
{
using var scheduler = new KernelScheduler<int, int>();
var cts = new CancellationTokenSource();
var barrier = new Barrier(2);
var laterWorkWasExecuted = false;
// schedule work to be cancelled
var _ = scheduler.RunAsync(1, async v =>
{
barrier.SignalAndWait();
await Task.Delay(5000);
return v;
}, cancellationToken: cts.Token);
// schedule more work prior to cancellation
var laterWork = scheduler.RunAsync(2, v =>
{
laterWorkWasExecuted = true;
return Task.FromResult(v);
});
barrier.SignalAndWait();
cts.Cancel();
laterWork.Status.Should().Be(TaskStatus.WaitingForActivation);
laterWorkWasExecuted.Should().BeFalse();
}
[Fact]
public void work_in_progress_can_be_cancelled_without_holding_reference_to_the_CancellationToken_used_to_schedule_it()
{
using var scheduler = new KernelScheduler<int, int>();
var barrier = new Barrier(2);
var cts = new CancellationTokenSource();
var task = scheduler.RunAsync(1, async v =>
{
barrier.SignalAndWait(5000);
await Task.Delay(1000);
return v;
}, cancellationToken: cts.Token);
barrier.SignalAndWait(5000);
scheduler.CancelCurrentOperation();
task.IsCanceled.Should().BeTrue();
}
[Fact]
public void cancelling_work_in_progress_throws_exception()
{
using var scheduler = new KernelScheduler<int, int>();
var cts = new CancellationTokenSource();
var barrier = new Barrier(2);
var work = scheduler.RunAsync(1, async v =>
{
barrier.SignalAndWait();
await Task.Delay(3000);
return v;
}, cancellationToken: cts.Token);
barrier.SignalAndWait();
cts.Cancel();
work.Invoking(async w => await w)
.Should()
.ThrowAsync<OperationCanceledException>();
}
[Fact(Skip = "requires System.Runtime.ControlledExecution")]
public void Infinite_loops_can_be_cancelled()
{
using var scheduler = new KernelScheduler<int, int>();
var cts = new CancellationTokenSource();
var barrier = new Barrier(2);
var work = scheduler.RunAsync(1, async v =>
{
barrier.SignalAndWait();
while (true)
{
}
return v;
}, cancellationToken: cts.Token);
barrier.SignalAndWait();
cts.Cancel();
work.Invoking(async w => await w)
.Should()
.ThrowAsync<OperationCanceledException>();
}
[Fact(Skip = "requires System.Runtime.ControlledExecution")]
public async Task After_an_infinite_loop_is_cancelled_the_scheduler_can_still_be_used()
{
using var scheduler = new KernelScheduler<int, int>();
var cts = new CancellationTokenSource();
var barrier = new Barrier(2);
var _ = scheduler.RunAsync(1, async v =>
{
barrier.SignalAndWait();
while (true)
{
}
return v;
}, cancellationToken: cts.Token);
barrier.SignalAndWait();
cts.Cancel();
var nextResult = await scheduler.RunAsync(2, PerformWork);
nextResult.Should().Be(2);
Task<int> PerformWork(int v)
{
return Task.FromResult(v);
}
}
[Fact]
public void disposing_scheduler_throws_exception()
{
using var scheduler = new KernelScheduler<int, int>();
var barrier = new Barrier(2);
var work = scheduler.RunAsync(1, async v =>
{
barrier.SignalAndWait();
await Task.Delay(3000);
return v;
});
barrier.SignalAndWait();
scheduler.Dispose();
work.Invoking(async w => await w)
.Should()
.ThrowAsync<OperationCanceledException>();
}
[Fact]
public async Task exception_in_scheduled_work_does_not_prevent_execution_of_work_already_queued()
{
using var scheduler = new KernelScheduler<int, int>();
var barrier = new Barrier(2);
var laterWorkWasExecuted = false;
var t1 = scheduler.RunAsync(1, _ =>
{
barrier.SignalAndWait();
throw new DataMisalignedException();
});
var t2 = scheduler.RunAsync(2, v =>
{
laterWorkWasExecuted = true;
return Task.FromResult(v);
});
barrier.SignalAndWait();
await t2;
laterWorkWasExecuted.Should().BeTrue();
}
[Fact]
public async Task after_an_exception_in_scheduled_work_more_work_can_be_scheduled()
{
using var scheduler = new KernelScheduler<int, int>();
try
{
await scheduler.RunAsync(1, _ => throw new DataMisalignedException());
}
catch (DataMisalignedException)
{
}
var next = await scheduler.RunAsync(2, _ => Task.FromResult(2));
next.Should().Be(2);
}
[Fact]
public void exception_in_scheduled_work_is_propagated()
{
using var scheduler = new KernelScheduler<int, int>();
var barrier = new Barrier(2);
Task<int> Throw(int v)
{
barrier.SignalAndWait();
throw new DataMisalignedException();
}
var work = scheduler.RunAsync(1, Throw);
barrier.SignalAndWait();
work.Invoking(async w => await w)
.Should()
.ThrowAsync<DataMisalignedException>();
}
[Fact]
public async Task awaiting_for_work_to_complete_does_not_wait_for_subsequent_work()
{
var executionList = new List<int>();
using var scheduler = new KernelScheduler<int, int>();
async Task<int> PerformWorkAsync(int v)
{
await Task.Delay(200);
executionList.Add(v);
return v;
}
var one = scheduler.RunAsync(1, PerformWorkAsync);
var two = scheduler.RunAsync(2, PerformWorkAsync);
var three = scheduler.RunAsync(3, PerformWorkAsync);
await two;
executionList.Should().BeEquivalentSequenceTo(1, 2);
}
[Fact]
public async Task deferred_work_is_done_based_on_the_scope_of_scheduled_work()
{
var executionList = new List<int>();
Task<int> PerformWork(int v)
{
executionList.Add(v);
return Task.FromResult(v);
}
using var scheduler = new KernelScheduler<int, int>();
scheduler.RegisterDeferredOperationSource(
(v, scope) => scope == "scope2" ? Enumerable.Repeat(v * 10, v).ToList() : Enumerable.Empty<int>().ToList(), PerformWork);
for (var i = 1; i <= 3; i++)
{
await scheduler.RunAsync(i, PerformWork, $"scope{i}");
}
executionList.Should().BeEquivalentSequenceTo(1, 20, 20, 2, 3);
}
[Fact]
public async Task work_can_be_scheduled_from_within_scheduled_work()
{
var executionList = new List<string>();
using var scheduler = new TestKernelScheduler<string>((o, i) => o == "outer" && i == "inner");
await scheduler.RunAsync("outer", async _ =>
{
executionList.Add("outer 1");
await scheduler.RunAsync("inner", async _ =>
{
executionList.Add("inner 1");
await Task.Yield();
executionList.Add("inner 2");
return default;
});
executionList.Add("outer 2");
return default;
});
executionList.Should()
.BeEquivalentSequenceTo(
"outer 1",
"inner 1",
"inner 2",
"outer 2");
}
[Fact]
public async Task CurrentValue_reflects_the_work_that_is_in_progress()
{
using var scheduler = new KernelScheduler<int, int>();
var work = 1000;
await scheduler.RunAsync(work, async _ =>
{
scheduler.CurrentValue.Should().Be(work);
return 2000;
});
}
[Fact]
public async Task CurrentValue_reflects_the_child_operation_when_called_from_within_a_child_operation()
{
using var scheduler = new TestKernelScheduler<string>((o, i) => o == "outer" && i == "inner");
await scheduler.RunAsync("outer", async _ =>
{
await scheduler.RunAsync("inner", async _ =>
{
scheduler.CurrentValue.Should().Be("inner");
return default;
});
return default;
});
}
[Fact]
public async Task CurrentValue_reflects_the_parent_operation_when_called_from_within_a_parent_operation()
{
using var scheduler = new TestKernelScheduler<string>((o, i) => o == "outer" && i == "inner");
await scheduler.RunAsync("outer", async _ =>
{
await scheduler.RunAsync("inner", async _ =>
{
return default;
});
scheduler.CurrentValue.Should().Be("outer");
return default;
});
}
[Fact]
public async Task CurrentValue_is_null_once_all_work_is_complete()
{
using var scheduler = new TestKernelScheduler<string>((o, i) => o == "outer" && i == "inner");
await scheduler.RunAsync("outer", async _ =>
{
await scheduler.RunAsync("inner", async _ =>
{
return default;
});
return default;
});
scheduler.CurrentValue.Should().BeNull();
}
[Fact(Skip = "Disabled pending https://github.com/dotnet/interactive/issues/3236")]
public async Task CurrentValue_reflects_correct_value_within_parent_child_as_well_as_grand_child_operations()
{
using var scheduler =
new TestKernelScheduler<string>(
(o, i) => o == "parent" && i == "child" || o == "child" && i == "grandchild" || o == "parent" && i == "grandchild");
using var _ = new AssertionScope();
scheduler.CurrentValue.Should().BeNull();
await scheduler.RunAsync("parent", async _ =>
{
scheduler.CurrentValue.Should().Be("parent");
await scheduler.RunAsync("child", async _ =>
{
scheduler.CurrentValue.Should().Be("child");
await scheduler.RunAsync("grandchild", async _ =>
{
scheduler.CurrentValue.Should().Be("grandchild");
return default;
});
// See https://github.com/dotnet/interactive/issues/3236
scheduler.CurrentValue.Should().Be("child");
return default;
});
scheduler.CurrentValue.Should().Be("parent");
return default;
});
scheduler.CurrentValue.Should().BeNull();
}
[Fact]
public async Task concurrent_schedulers_do_not_interfere_with_one_another()
{
var participantCount = 5;
var barrier = new Barrier(participantCount);
var schedulers = Enumerable.Range(0, participantCount)
.Select(_ => new KernelScheduler<int, int>());
var tasks = schedulers.Select((s, i) => s.RunAsync(i, async value =>
{
await Task.Yield();
barrier.SignalAndWait();
return value;
}
));
var xs = await Task.WhenAll(tasks);
xs.Should().BeEquivalentTo(new[] { 0, 1, 2, 3, 4 });
}
[Fact]
public async Task AsyncContext_is_maintained_across_async_operations_within_scheduled_work()
{
using var scheduler = new KernelScheduler<int, int>();
int asyncId1 = default;
int asyncId2 = default;
await scheduler.RunAsync(0, async value =>
{
AsyncContext.TryEstablish(out asyncId1);
await Task.Yield();
AsyncContext.TryEstablish(out asyncId2);
return value;
});
asyncId2.Should().Be(asyncId1);
}
[Fact]
public async Task AsyncContext_is_maintained_across_from_outside_context_to_scheduled_work()
{
using var scheduler = new KernelScheduler<int, int>();
int asyncId1 = default;
int asyncId2 = default;
AsyncContext.TryEstablish(out asyncId1);
await scheduler.RunAsync(0, async value =>
{
await Task.Yield();
AsyncContext.TryEstablish(out asyncId2);
return value;
});
asyncId2.Should().Be(asyncId1);
}
[Fact]
public async Task AsyncContext_does_not_leak_from_inner_context()
{
using var scheduler = new KernelScheduler<int, int>();
int asyncId = default;
await scheduler.RunAsync(0, async value =>
{
await Task.Yield();
AsyncContext.TryEstablish(out asyncId);
return value;
});
AsyncContext.Id.Should().NotBe(asyncId);
}
[Fact]
public async Task AsyncContext_does_not_leak_between_scheduled_work()
{
using var scheduler = new KernelScheduler<int, int>();
int asyncId1 = default;
int asyncId2 = default;
await scheduler.RunAsync(1, async value =>
{
AsyncContext.TryEstablish(out asyncId1);
await Task.Yield();
return value;
});
await scheduler.RunAsync(2, async value =>
{
AsyncContext.TryEstablish(out asyncId2);
await Task.Yield();
return value;
});
asyncId2.Should().NotBe(asyncId1);
}
[Fact]
public async Task AsyncContext_flows_from_scheduled_work_to_deferred_work()
{
using var scheduler = new KernelScheduler<int, int>();
int asyncIdForScheduledWork = default;
var asyncIdsForDeferredWork = new ConcurrentBag<int>();
AsyncContext.TryEstablish(out var _);
scheduler.RegisterDeferredOperationSource((execute, name) =>
{
return new[] { 0, 1, 2 };
}, async value =>
{
AsyncContext.TryEstablish(out var asyncId);
asyncIdsForDeferredWork.Add(asyncId);
await Task.Yield();
return value;
});
await scheduler.RunAsync(3, async value =>
{
AsyncContext.TryEstablish(out asyncIdForScheduledWork);
await Task.Yield();
return value;
});
asyncIdsForDeferredWork.Should()
.HaveCount(3)
.And
.AllBeEquivalentTo(asyncIdForScheduledWork);
}
}