Breaking change: changed HandleNotification to return a task instead of void. This allows operations that handle notifiactions to wait

Author: david-driscoll

src/JsonRpc/IRequestRouter.cs

@@ -1,12 +1,12 @@
-using System;
+using System;
 using System.Threading.Tasks;
 using OmniSharp.Extensions.JsonRpc.Server;
 
 namespace OmniSharp.Extensions.JsonRpc
 {
     public interface IRequestRouter
     {
-        void RouteNotification(Notification notification);
+        Task RouteNotification(Notification notification);
         Task<ErrorResponse> RouteRequest(Request request);
     }
 }

src/JsonRpc/InputHandler.cs

@@ -190,10 +190,10 @@ private void HandleRequest(string request)
                     _scheduler.Add(
                         type,
                         item.Notification.Method,
-                        () => {
+                        async () => {
                             try
                             {
-                                _requestRouter.RouteNotification(item.Notification);
+                                await _requestRouter.RouteNotification(item.Notification);
                             }
                             catch (Exception e)
                             {
@@ -202,7 +202,6 @@ private void HandleRequest(string request)
                                 // If an exception happens... the whole system could be in a bad state, hence this throwing currently.
                                 throw;
                             }
-                            return Task.CompletedTask;
                         }
                     );
                 }

src/JsonRpc/RequestRouter.cs

@@ -22,7 +22,7 @@ public IDisposable Add(IJsonRpcHandler handler)
             return _collection.Add(handler);
         }
 
-        public async void RouteNotification(Notification notification)
+        public async Task RouteNotification(Notification notification)
         {
             var handler = _collection.FirstOrDefault(x => x.Method == notification.Method);
 

src/Lsp/LspRequestRouter.cs

@@ -125,7 +125,7 @@ private ILspHandlerDescriptor GetHandler(string method, TextDocumentAttributes a
             return null;
         }
 
-        public async void RouteNotification(Notification notification)
+        public async Task RouteNotification(Notification notification)
         {
             var handler = FindDescriptor(notification.Method, notification.Params);
             if (handler is null) { return; }

test/JsonRpc.Tests/InputHandlerTests.cs

@@ -206,7 +206,7 @@ public void ShouldHandleError()
         }
 
         [Fact]
-        public void ShouldHandleNotification()
+        public async Task ShouldHandleNotification()
         {
             var inputStream = new MemoryStream(Encoding.ASCII.GetBytes("Content-Length: 2\r\n\r\n{}"));
             var outputHandler = Substitute.For<IOutputHandler>();
@@ -234,7 +234,7 @@ public void ShouldHandleNotification()
                         });
                 }))
             {
-                incomingRequestRouter.Received().RouteNotification(notification);
+               await incomingRequestRouter.Received().RouteNotification(notification);
             }
         }
 

test/JsonRpc.Tests/MediatorTestsNotificationHandler.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Reflection;
 using System.Threading.Tasks;
 using NSubstitute;
@@ -23,10 +23,10 @@ public async Task ExecutesHandler()
 
             var notification = new Notification("exit", null);
 
-            mediator.RouteNotification(notification);
+            await mediator.RouteNotification(notification);
 
             await exitHandler.Received(1).Handle();
         }
 
     }
-}
+}

test/JsonRpc.Tests/MediatorTestsNotificationHandlerOfT.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Reflection;
 using System.Threading.Tasks;
 using Newtonsoft.Json;
@@ -33,10 +33,10 @@ public async Task ExecutesHandler()
             var @params = new CancelParams() { Id = Guid.NewGuid() };
             var notification = new Notification("$/cancelRequest", JObject.Parse(JsonConvert.SerializeObject(@params)));
 
-            mediator.RouteNotification(notification);
+            await mediator.RouteNotification(notification);
 
             await cancelRequestHandler.Received(1).Handle(Arg.Any<CancelParams>());
         }
 
     }
-}
+}

test/Lsp.Tests/LspRequestRouterTests.cs

@@ -30,7 +30,7 @@ public LspRequestRouterTests(ITestOutputHelper testOutputHelper)
         }
 
         [Fact]
-        public void ShouldRouteToCorrect_Notification()
+        public async Task ShouldRouteToCorrect_Notification()
         {
             var textDocumentSyncHandler = TextDocumentSyncHandlerExtensions.With(DocumentSelector.ForPattern("**/*.cs"));
             textDocumentSyncHandler.Handle(Arg.Any<DidSaveTextDocumentParams>()).Returns(Task.CompletedTask);
@@ -44,13 +44,13 @@ public void ShouldRouteToCorrect_Notification()
 
             var request = new Notification("textDocument/didSave", JObject.Parse(JsonConvert.SerializeObject(@params)));
 
-            mediator.RouteNotification(request);
+            await mediator.RouteNotification(request);
 
-            textDocumentSyncHandler.Received(1).Handle(Arg.Any<DidSaveTextDocumentParams>());
+            await textDocumentSyncHandler.Received(1).Handle(Arg.Any<DidSaveTextDocumentParams>());
         }
 
         [Fact]
-        public void ShouldRouteToCorrect_Notification_WithManyHandlers()
+        public async Task ShouldRouteToCorrect_Notification_WithManyHandlers()
         {
             var textDocumentSyncHandler = TextDocumentSyncHandlerExtensions.With(DocumentSelector.ForPattern("**/*.cs"));
             var textDocumentSyncHandler2 = TextDocumentSyncHandlerExtensions.With(DocumentSelector.ForPattern("**/*.cake"));
@@ -66,10 +66,10 @@ public void ShouldRouteToCorrect_Notification_WithManyHandlers()
 
             var request = new Notification("textDocument/didSave", JObject.Parse(JsonConvert.SerializeObject(@params)));
 
-            mediator.RouteNotification(request);
+            await mediator.RouteNotification(request);
 
-            textDocumentSyncHandler.Received(0).Handle(Arg.Any<DidSaveTextDocumentParams>());
-            textDocumentSyncHandler2.Received(1).Handle(Arg.Any<DidSaveTextDocumentParams>());
+            await textDocumentSyncHandler.Received(0).Handle(Arg.Any<DidSaveTextDocumentParams>());
+            await textDocumentSyncHandler2.Received(1).Handle(Arg.Any<DidSaveTextDocumentParams>());
         }
 
         [Fact]