Added key to IJsonRpcHandler to support hashing better; +semver: minor

Author: david-driscoll

sample/SampleServer/Program.cs

@@ -39,7 +39,8 @@ class TextDocumentHandler : ITextDocumentSyncHandler
         private readonly ILanguageServer _router;
 
         private readonly DocumentSelector _documentSelector = new DocumentSelector(
-            new DocumentFilter() {
+            new DocumentFilter()
+            {
                 Pattern = "**/*.csproj",
                 Language = "xml"
             }
@@ -52,19 +53,24 @@ public TextDocumentHandler(ILanguageServer router)
             _router = router;
         }
 
-        public TextDocumentSyncOptions Options { get; } = new TextDocumentSyncOptions() {
+        public TextDocumentSyncOptions Options { get; } = new TextDocumentSyncOptions()
+        {
             WillSaveWaitUntil = false,
             WillSave = true,
             Change = TextDocumentSyncKind.Full,
-            Save = new SaveOptions() {
+            Save = new SaveOptions()
+            {
                 IncludeText = true
             },
             OpenClose = true
         };
 
+        public string Key => (string)_documentSelector;
+
         public Task Handle(DidChangeTextDocumentParams notification)
         {
-            _router.LogMessage(new LogMessageParams() {
+            _router.LogMessage(new LogMessageParams()
+            {
                 Type = MessageType.Log,
                 Message = "Hello World!!!!"
             });
@@ -73,7 +79,8 @@ public Task Handle(DidChangeTextDocumentParams notification)
 
         TextDocumentChangeRegistrationOptions IRegistration<TextDocumentChangeRegistrationOptions>.GetRegistrationOptions()
         {
-            return new TextDocumentChangeRegistrationOptions() {
+            return new TextDocumentChangeRegistrationOptions()
+            {
                 DocumentSelector = _documentSelector,
                 SyncKind = Options.Change
             };
@@ -86,15 +93,17 @@ public void SetCapability(SynchronizationCapability capability)
 
         public async Task Handle(DidOpenTextDocumentParams notification)
         {
-            _router.LogMessage(new LogMessageParams() {
+            _router.LogMessage(new LogMessageParams()
+            {
                 Type = MessageType.Log,
                 Message = "Hello World!!!!"
             });
         }
 
         TextDocumentRegistrationOptions IRegistration<TextDocumentRegistrationOptions>.GetRegistrationOptions()
         {
-            return new TextDocumentRegistrationOptions() {
+            return new TextDocumentRegistrationOptions()
+            {
                 DocumentSelector = _documentSelector,
             };
         }
@@ -111,7 +120,8 @@ public Task Handle(DidSaveTextDocumentParams notification)
 
         TextDocumentSaveRegistrationOptions IRegistration<TextDocumentSaveRegistrationOptions>.GetRegistrationOptions()
         {
-            return new TextDocumentSaveRegistrationOptions() {
+            return new TextDocumentSaveRegistrationOptions()
+            {
                 DocumentSelector = _documentSelector,
                 IncludeText = Options.Save.IncludeText
             };

src/JsonRpc/IJsonRpcHandler.cs

@@ -3,5 +3,5 @@
     /// <summary>
     /// A simple marker interface to use for storing handlings (which will be cast out later)
     /// </summary>
-    public interface IJsonRpcHandler { }
-}
+    public interface IJsonRpcHandler { string Key { get; } }
+}

src/Lsp/Handlers/CancelRequestHandler.cs

@@ -13,6 +13,8 @@ internal CancelRequestHandler(LspRequestRouter requestRouter)
             _requestRouter = requestRouter;
         }
 
+        public string Key => nameof(ICancelRequestHandler);
+
         public Task Handle(CancelParams notification)
         {
             _requestRouter.CancelRequest(notification.Id);

src/Lsp/Handlers/ExitHandler.cs

@@ -12,6 +12,8 @@ public ExitHandler(ShutdownHandler shutdownHandler)
             _shutdownHandler = shutdownHandler;
         }
 
+        public string Key => nameof(IExitHandler);
+
         public Task Handle()
         {
             Exit?.Invoke(_shutdownHandler.ShutdownRequested ? 0 : 1);

src/Lsp/Handlers/ShutdownHandler.cs

@@ -6,6 +6,8 @@ namespace OmniSharp.Extensions.LanguageServer.Handlers
 {
     public class ShutdownHandler : IShutdownHandler, IAwaitableTermination
     {
+        public string Key => nameof(IShutdownHandler);
+
         public Task Handle()
         {
             ShutdownRequested = true;

src/Lsp/LanguageServer.cs

@@ -63,6 +63,8 @@ IRequestProcessIdentifier requestProcessIdentifier
         public InitializeParams Client { get; private set; }
         public InitializeResult Server { get; private set; }
 
+        public string Key => nameof(ILanguageServer);
+
         public IDisposable AddHandler(IJsonRpcHandler handler)
         {
             var handlerDisposable = _collection.Add(handler);

src/Lsp/Models/DocumentFilter.cs

@@ -1,4 +1,6 @@
-using Minimatch;
+using System.Collections.Generic;
+using System.Text;
+using Minimatch;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Serialization;
 using OmniSharp.Extensions.LanguageServer.Protocol.Document;
@@ -39,7 +41,8 @@ public class DocumentFilter
         public string Pattern
         {
             get => _pattern;
-            set {
+            set
+            {
                 _pattern = value;
                 _minimatcher = new Minimatcher(value, new Options() { MatchBase = true });
             }
@@ -54,6 +57,21 @@ public string Pattern
         private string _pattern;
         private Minimatcher _minimatcher;
 
+        public static explicit operator string(DocumentFilter documentFilter)
+        {
+            var items = new List<string>();
+            if (documentFilter.HasLanguage) {
+                items.Add(documentFilter.Language);
+            }
+            if (documentFilter.HasScheme) {
+                items.Add(documentFilter.Scheme);
+            }
+            if (documentFilter.HasPattern) {
+                items.Add(documentFilter.Pattern);
+            }
+            return $"[{string.Join(", ", items)}]";
+        }
+
         public bool IsMatch(TextDocumentAttributes attributes)
         {
             if (HasLanguage && HasPattern && HasScheme)
@@ -88,4 +106,4 @@ public bool IsMatch(TextDocumentAttributes attributes)
             return false;
         }
     }
-}
+}

src/Lsp/Models/DocumentSelector.cs

@@ -38,9 +38,14 @@ public static implicit operator DocumentSelector(List<DocumentFilter> items)
             return new DocumentSelector(items);
         }
 
+        public static explicit operator string(DocumentSelector documentSelector)
+        {
+            return string.Join(", ", documentSelector.Select(x => (string)x));
+        }
+
         public bool IsMatch(TextDocumentAttributes attributes)
         {
             return this.Any(z => z.IsMatch(attributes));
         }
     }
-}
+}