Fixed schedulers for replay subjects

david-driscoll · david-driscoll · commit 3ddfa0fca7b8 · 2021-04-16T00:08:10.000-04:00
diff --git a/src/Client/LanguageClientRegistrationManager.cs b/src/Client/LanguageClientRegistrationManager.cs
@@ -2,6 +2,7 @@
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Linq;
+using System.Reactive.Concurrency;
 using System.Reactive.Linq;
 using System.Reactive.Subjects;
 using System.Threading;
@@ -26,7 +27,7 @@ internal class LanguageClientRegistrationManager : IRegisterCapabilityHandler, I
         private readonly ILspHandlerTypeDescriptorProvider _handlerTypeDescriptorProvider;
         private readonly ILogger<LanguageClientRegistrationManager> _logger;
         private readonly ConcurrentDictionary<string, Registration> _registrations;
-        private readonly ReplaySubject<IEnumerable<Registration>> _registrationSubject = new ReplaySubject<IEnumerable<Registration>>(1);
+        private readonly ReplaySubject<IEnumerable<Registration>> _registrationSubject = new ReplaySubject<IEnumerable<Registration>>(1, Scheduler.Immediate);
 
         public LanguageClientRegistrationManager(
             ISerializer serializer,
diff --git a/src/Client/LanguageClientWorkspaceFoldersManager.cs b/src/Client/LanguageClientWorkspaceFoldersManager.cs
@@ -2,6 +2,7 @@
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Linq;
+using System.Reactive.Concurrency;
 using System.Reactive.Linq;
 using System.Reactive.Subjects;
 using System.Threading;
@@ -25,7 +26,7 @@ public LanguageClientWorkspaceFoldersManager(IWorkspaceLanguageClient client, IE
         {
             _client = client;
             _workspaceFolders = new ConcurrentDictionary<DocumentUri, WorkspaceFolder>(DocumentUri.Comparer);
-            _workspaceFoldersSubject = new ReplaySubject<IEnumerable<WorkspaceFolder>>(1);
+            _workspaceFoldersSubject = new ReplaySubject<IEnumerable<WorkspaceFolder>>(1, Scheduler.Immediate);
 
             foreach (var folder in workspaceFolders)
             {
diff --git a/src/Dap.Client/ProgressObservable.cs b/src/Dap.Client/ProgressObservable.cs
@@ -1,4 +1,5 @@
 ﻿using System;
+using System.Reactive.Concurrency;
 using System.Reactive.Disposables;
 using System.Reactive.Subjects;
 using OmniSharp.Extensions.DebugAdapter.Protocol;
@@ -14,7 +15,7 @@ internal class ProgressObservable : IProgressObservable, IObserver<ProgressEvent
 
         public ProgressObservable(ProgressToken token)
         {
-            _dataSubject = new ReplaySubject<ProgressEvent>(1);
+            _dataSubject = new ReplaySubject<ProgressEvent>(1, Scheduler.Immediate);
             _disposable = new CompositeDisposable { Disposable.Create(_dataSubject.OnCompleted) };
 
             ProgressToken = token;
diff --git a/src/JsonRpc/OutputHandler.cs b/src/JsonRpc/OutputHandler.cs
@@ -39,7 +39,7 @@ ILogger<OutputHandler> logger
             _outputFilters = outputFilters.ToArray();
             _logger = logger;
             _queue = new Subject<object>();
-            _delayedQueue = new ReplaySubject<object>();
+            _delayedQueue = new ReplaySubject<object>(Scheduler.Immediate);
             _outputIsFinished = new TaskCompletionSource<object?>();
 
             _disposable = new CompositeDisposable {
diff --git a/src/JsonRpc/ProcessScheduler.cs b/src/JsonRpc/ProcessScheduler.cs
@@ -34,7 +34,7 @@ IScheduler scheduler
 
                     var observableQueue =
                         new BehaviorSubject<(RequestProcessType type, ReplaySubject<IObservable<Unit>> observer, Subject<Unit>? contentModifiedSource)>(
-                            ( RequestProcessType.Serial, new ReplaySubject<IObservable<Unit>>(int.MaxValue), supportContentModified ? new Subject<Unit>() : null )
+                            ( RequestProcessType.Serial, new ReplaySubject<IObservable<Unit>>(int.MaxValue, Scheduler.Immediate), supportContentModified ? new Subject<Unit>() : null )
                         );
 
                     cd.Add(
@@ -52,7 +52,7 @@ IScheduler scheduler
 
                                     logger.LogDebug("Completing existing request process type {Type}", observableQueue.Value.type);
                                     observableQueue.Value.observer.OnCompleted();
-                                    observableQueue.OnNext(( item.type, new ReplaySubject<IObservable<Unit>>(int.MaxValue), supportContentModified ? new Subject<Unit>() : null ));
+                                    observableQueue.OnNext(( item.type, new ReplaySubject<IObservable<Unit>>(int.MaxValue, Scheduler.Immediate), supportContentModified ? new Subject<Unit>() : null ));
                                 }
 
                                 logger.LogDebug("Queueing {Type}:{Name} request for processing", item.type, item.name);
diff --git a/src/Protocol/Progress/PartialItemsRequestProgressObservable.cs b/src/Protocol/Progress/PartialItemsRequestProgressObservable.cs
@@ -36,7 +36,7 @@ Action onCompleteAction
         )
         {
             _serializer = serializer;
-            _dataSubject = new ReplaySubject<IEnumerable<TItem>>(int.MaxValue);
+            _dataSubject = new ReplaySubject<IEnumerable<TItem>>(int.MaxValue, Scheduler.Immediate);
             _disposable = new CompositeDisposable() { _dataSubject };
 
             _task = Observable.Create<TResult>(
diff --git a/src/Protocol/Progress/ProgressObservable.cs b/src/Protocol/Progress/ProgressObservable.cs
@@ -1,4 +1,5 @@
 ﻿using System;
+using System.Reactive.Concurrency;
 using System.Reactive.Disposables;
 using System.Reactive.Linq;
 using System.Reactive.Subjects;
@@ -16,7 +17,7 @@ internal class ProgressObservable<T> : IProgressObservable<T>, IObserver<JToken>
         public ProgressObservable(ProgressToken token, Func<JToken, T> factory, Action disposal)
         {
             _factory = factory;
-            _dataSubject = new ReplaySubject<JToken>(1);
+            _dataSubject = new ReplaySubject<JToken>(1, Scheduler.Immediate);
             _disposable = new CompositeDisposable { Disposable.Create(_dataSubject.OnCompleted), Disposable.Create(disposal) };
 
             ProgressToken = token;
diff --git a/src/Server/LanguageServerWorkspaceFolderManager.cs b/src/Server/LanguageServerWorkspaceFolderManager.cs
@@ -2,6 +2,7 @@
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Linq;
+using System.Reactive.Concurrency;
 using System.Reactive.Linq;
 using System.Reactive.Subjects;
 using System.Threading;
@@ -27,7 +28,7 @@ public LanguageServerWorkspaceFolderManager(IWorkspaceLanguageServer server)
         {
             _server = server;
             _workspaceFolders = new ConcurrentDictionary<DocumentUri, WorkspaceFolder>(DocumentUri.Comparer);
-            _workspaceFoldersSubject = new ReplaySubject<IEnumerable<WorkspaceFolder>>(1);
+            _workspaceFoldersSubject = new ReplaySubject<IEnumerable<WorkspaceFolder>>(1, Scheduler.Immediate);
             _workspaceFoldersChangedSubject = new Subject<WorkspaceFolderChange>();
         }
 
diff --git a/test/Lsp.Tests/Integration/DynamicRegistrationTests.cs b/test/Lsp.Tests/Integration/DynamicRegistrationTests.cs
@@ -119,6 +119,8 @@ await TestHelper.DelayUntil(
                     registrations => registrations.Any(registration => SelectorMatches(registration, x => x.HasLanguage && x.Language == "vb")),
                     CancellationToken
                 );
+
+                await Task.Delay(200);
                 disposable.Dispose();
 
 
@@ -127,6 +129,7 @@ await TestHelper.DelayUntil(
                     registrations => !registrations.Any(registration => SelectorMatches(registration, x => x.HasLanguage && x.Language == "vb")),
                     CancellationToken
                 );
+                await Task.Delay(200);
 
                 client.RegistrationManager.CurrentRegistrations.Should().NotContain(
                     x =>
diff --git a/test/Lsp.Tests/Integration/LanguageServerConfigurationTests.cs b/test/Lsp.Tests/Integration/LanguageServerConfigurationTests.cs
@@ -254,15 +254,15 @@ public async Task Should_Support_Options_Monitor()
             // IOptionsMonitor<> is registered as a singleton, so this will update
             options.CurrentValue.Host.Should().Be("localhost");
             options.CurrentValue.Port.Should().Be(443);
-            sub.Received(1).Invoke(Arg.Any<BinderSourceUrl>());
+            sub.Received(Quantity.AtLeastOne()).Invoke(Arg.Any<BinderSourceUrl>());
 
             configuration.Update("mysection", new Dictionary<string, string> { ["host"] = "127.0.0.1", ["port"] = "80" });
             await options.WaitForChange(CancellationToken);
             await SettleNext();
 
             options.CurrentValue.Host.Should().Be("127.0.0.1");
             options.CurrentValue.Port.Should().Be(80);
-            sub.Received(2).Invoke(Arg.Any<BinderSourceUrl>());
+            sub.Received(Quantity.Within(2, int.MaxValue)).Invoke(Arg.Any<BinderSourceUrl>());
         }
 
         class BinderSourceUrl
diff --git a/test/Lsp.Tests/Integration/PartialItemTests.cs b/test/Lsp.Tests/Integration/PartialItemTests.cs
@@ -24,7 +24,7 @@ public Delegates(ITestOutputHelper testOutputHelper, LanguageProtocolFixture<Def
             {
             }
 
-            [Fact]
+            [RetryFact]
             public async Task Should_Behave_Like_A_Task()
             {
                 var result = await Client.TextDocument.RequestSemanticTokens(
@@ -34,7 +34,7 @@ public async Task Should_Behave_Like_A_Task()
                 result!.Data.Should().HaveCount(3);
             }
 
-            [Fact]
+            [RetryFact]
             public async Task Should_Behave_Like_An_Observable()
             {
                 var items = await Client.TextDocument
@@ -53,7 +53,7 @@ public async Task Should_Behave_Like_An_Observable()
                 items.Select(z => z.Data.Length).Should().ContainInOrder(1, 2, 3);
             }
 
-            [Fact]
+            [RetryFact]
             public async Task Should_Behave_Like_An_Observable_Without_Progress_Support()
             {
                 var response = await Client.SendRequest(new SemanticTokensParams { TextDocument = new TextDocumentIdentifier(@"c:\test.cs") }, CancellationToken);
diff --git a/test/Lsp.Tests/Integration/PartialItemsTests.cs b/test/Lsp.Tests/Integration/PartialItemsTests.cs
@@ -29,7 +29,7 @@ public Delegates(ITestOutputHelper testOutputHelper, LanguageProtocolFixture<Def
             {
             }
 
-            [Fact]
+            [RetryFact]
             public async Task Should_Behave_Like_A_Task()
             {
                 var result = await Client.TextDocument.RequestCodeLens(
@@ -42,7 +42,7 @@ public async Task Should_Behave_Like_A_Task()
                 result.Select(z => z.Command!.Name).Should().ContainInOrder("CodeLens 1", "CodeLens 2", "CodeLens 3");
             }
 
-            [Fact]
+            [RetryFact]
             public async Task Should_Behave_Like_An_Observable()
             {
                 var items = await Client.TextDocument
@@ -63,7 +63,7 @@ public async Task Should_Behave_Like_An_Observable()
                 items.Select(z => z.Command!.Name).Should().ContainInOrder("CodeLens 1", "CodeLens 2", "CodeLens 3");
             }
 
-            [Fact]
+            [RetryFact]
             public async Task Should_Behave_Like_An_Observable_Without_Progress_Support()
             {
                 var response = await Client.SendRequest(
@@ -120,7 +120,7 @@ public Handlers(ITestOutputHelper testOutputHelper, LanguageProtocolFixture<Defa
             {
             }
 
-            [Fact]
+            [RetryFact]
             public async Task Should_Behave_Like_An_Observable_With_WorkDone()
             {
                 var items = new List<CodeLens>();
diff --git a/test/TestingUtils/AutoNSubstitute/TestExtensions.cs b/test/TestingUtils/AutoNSubstitute/TestExtensions.cs
@@ -1,5 +1,4 @@
-﻿using System.Reactive.Concurrency;
-using System.Threading;
+﻿using System.Threading;
 using OmniSharp.Extensions.JsonRpc.Testing;
 using Serilog.Events;
 using Xunit.Abstractions;
diff --git a/test/TestingUtils/RetryFactAttribute.cs b/test/TestingUtils/RetryFactAttribute.cs
@@ -0,0 +1,53 @@
+// See https://github.com/JoshKeegan/xRetry
+
+using System;
+using System.Linq;
+using Xunit;
+using Xunit.Sdk;
+
+namespace TestingUtils
+{
+    /// <summary>
+    /// Attribute that is applied to a method to indicate that it is a fact that should be run
+    /// by the test runner up to MaxRetries times, until it succeeds.
+    /// </summary>
+    [XunitTestCaseDiscoverer("TestingUtils.RetryFactDiscoverer", "TestingUtils")]
+    [AttributeUsage(AttributeTargets.Method)]
+    public class RetryFactAttribute : FactAttribute
+    {
+        public readonly int MaxRetries;
+        public readonly int DelayBetweenRetriesMs;
+        public readonly SkipOnPlatform[] PlatformsToSkip;
+        private string? _skip;
+
+        /// <summary>
+        /// Ctor
+        /// </summary>
+        /// <param name="maxRetries">The number of times to run a test for until it succeeds</param>
+        /// <param name="delayBetweenRetriesMs">The amount of time (in ms) to wait between each test run attempt</param>
+        /// <param name="skipOn">platforms to skip testing on</param>
+        public RetryFactAttribute(int maxRetries = 5, int delayBetweenRetriesMs = 0, params SkipOnPlatform[] skipOn)
+        {
+            if (maxRetries < 1)
+            {
+                throw new ArgumentOutOfRangeException(nameof(maxRetries) + " must be >= 1");
+            }
+            if (delayBetweenRetriesMs < 0)
+            {
+                throw new ArgumentOutOfRangeException(nameof(delayBetweenRetriesMs) + " must be >= 0");
+            }
+
+            MaxRetries = !UnitTestDetector.IsCI() ? 1 : maxRetries;
+            DelayBetweenRetriesMs = delayBetweenRetriesMs;
+            PlatformsToSkip = skipOn;
+        }
+
+        public override string? Skip
+        {
+            get => UnitTestDetector.IsCI() && PlatformsToSkip.Any(UnitTestDetector.PlatformToSkipPredicate)
+                ? "Skipped on platform" + ( string.IsNullOrWhiteSpace(_skip) ? "" : " because " + _skip )
+                : null;
+            set => _skip = value;
+        }
+    }
+}
diff --git a/test/TestingUtils/RetryFactDiscoverer.cs b/test/TestingUtils/RetryFactDiscoverer.cs
@@ -0,0 +1,46 @@
+using System.Collections.Generic;
+using System.Linq;
+using Xunit.Abstractions;
+using Xunit.Sdk;
+
+namespace TestingUtils
+{
+    public class RetryFactDiscoverer : IXunitTestCaseDiscoverer
+    {
+        private readonly IMessageSink _messageSink;
+
+        public RetryFactDiscoverer(IMessageSink messageSink)
+        {
+            _messageSink = messageSink;
+        }
+
+        public IEnumerable<IXunitTestCase> Discover(ITestFrameworkDiscoveryOptions discoveryOptions, ITestMethod testMethod,
+            IAttributeInfo factAttribute)
+        {
+            IXunitTestCase testCase;
+
+            if (testMethod.Method.GetParameters().Any())
+            {
+                testCase = new ExecutionErrorTestCase(_messageSink, discoveryOptions.MethodDisplayOrDefault(),
+                    discoveryOptions.MethodDisplayOptionsOrDefault(), testMethod,
+                    "[RetryFact] methods are not allowed to have parameters. Did you mean to use [RetryTheory]?");
+            }
+            else if (testMethod.Method.IsGenericMethodDefinition)
+            {
+                testCase = new ExecutionErrorTestCase(_messageSink, discoveryOptions.MethodDisplayOrDefault(),
+                    discoveryOptions.MethodDisplayOptionsOrDefault(), testMethod,
+                    "[RetryFact] methods are not allowed to be generic.");
+            }
+            else
+            {
+                var maxRetries = factAttribute.GetNamedArgument<int>(nameof(RetryFactAttribute.MaxRetries));
+                var delayBetweenRetriesMs =
+                    factAttribute.GetNamedArgument<int>(nameof(RetryFactAttribute.DelayBetweenRetriesMs));
+                testCase = new RetryTestCase(_messageSink, discoveryOptions.MethodDisplayOrDefault(),
+                    discoveryOptions.MethodDisplayOptionsOrDefault(), testMethod, maxRetries, delayBetweenRetriesMs);
+            }
+
+            return new[] { testCase };
+        }
+    }
+}
diff --git a/test/TestingUtils/RetryTestCase.cs b/test/TestingUtils/RetryTestCase.cs
@@ -0,0 +1,60 @@
+using System;
+using System.ComponentModel;
+using System.Threading;
+using System.Threading.Tasks;
+using Xunit.Abstractions;
+using Xunit.Sdk;
+
+namespace TestingUtils
+{
+    [Serializable]
+    public class RetryTestCase : XunitTestCase, IRetryableTestCase
+    {
+        public int MaxRetries { get; private set; }
+        public int DelayBetweenRetriesMs { get; private set; }
+
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        [Obsolete(
+            "Called by the de-serializer; should only be called by deriving classes for de-serialization purposes", true)]
+        public RetryTestCase() { }
+
+        public RetryTestCase(
+            IMessageSink diagnosticMessageSink,
+            TestMethodDisplay defaultMethodDisplay,
+            TestMethodDisplayOptions defaultMethodDisplayOptions,
+            ITestMethod testMethod,
+            int maxRetries,
+            int delayBetweenRetriesMs,
+            object[]? testMethodArguments = null)
+            : base(diagnosticMessageSink, defaultMethodDisplay, defaultMethodDisplayOptions, testMethod,
+                testMethodArguments)
+        {
+            MaxRetries = maxRetries;
+            DelayBetweenRetriesMs = delayBetweenRetriesMs;
+        }
+
+        public override Task<RunSummary> RunAsync(IMessageSink diagnosticMessageSink, IMessageBus messageBus,
+            object[] constructorArguments, ExceptionAggregator aggregator,
+            CancellationTokenSource cancellationTokenSource) =>
+            RetryTestCaseRunner.RunAsync(this, diagnosticMessageSink, messageBus, cancellationTokenSource,
+                blockingMessageBus => new XunitTestCaseRunner(this, DisplayName, SkipReason, constructorArguments,
+                        TestMethodArguments, blockingMessageBus, aggregator, cancellationTokenSource)
+                    .RunAsync());
+
+        public override void Serialize(IXunitSerializationInfo data)
+        {
+            base.Serialize(data);
+
+            data.AddValue("MaxRetries", MaxRetries);
+            data.AddValue("DelayBetweenRetriesMs", DelayBetweenRetriesMs);
+        }
+
+        public override void Deserialize(IXunitSerializationInfo data)
+        {
+            base.Deserialize(data);
+
+            MaxRetries = data.GetValue<int>("MaxRetries");
+            DelayBetweenRetriesMs = data.GetValue<int>("DelayBetweenRetriesMs");
+        }
+    }
+}
diff --git a/test/TestingUtils/RetryTestCaseRunner.cs b/test/TestingUtils/RetryTestCaseRunner.cs
diff --git a/test/TestingUtils/RetryTheoryAttribute.cs b/test/TestingUtils/RetryTheoryAttribute.cs
diff --git a/test/TestingUtils/RetryTheoryDiscoverer.cs b/test/TestingUtils/RetryTheoryDiscoverer.cs
diff --git a/test/TestingUtils/RetryTheoryDiscoveryAtRuntimeCase.cs b/test/TestingUtils/RetryTheoryDiscoveryAtRuntimeCase.cs

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ Action onCompleteAction`
`36`	`36`	`)`
`37`	`37`	`{`
`38`	`38`	`_serializer = serializer;`
`39`		`- _dataSubject = new ReplaySubject<IEnumerable<TItem>>(int.MaxValue);`
	`39`	`+ _dataSubject = new ReplaySubject<IEnumerable<TItem>>(int.MaxValue, Scheduler.Immediate);`
`40`	`40`	`_disposable = new CompositeDisposable() { _dataSubject };`
`41`	`41`
`42`	`42`	`_task = Observable.Create<TResult>(`