Added lsp configuration tests (#280)

david-driscoll · web-flow · commit 0a0d9b1b6a86 · 2020-08-09T12:13:09.000-04:00
* Added lsp configuration tests
* Updated test to just cover the entire call in case cancellation happens during init
diff --git a/src/JsonRpc.Testing/JsonRpcTestBase.cs b/src/JsonRpc.Testing/JsonRpcTestBase.cs
@@ -32,7 +32,7 @@ public JsonRpcTestBase(JsonRpcTestOptions testOptions)
         protected ISettler ServerEvents { get; }
         protected ISettler Events { get; }
         protected JsonRpcTestOptions TestOptions { get; }
-        protected CancellationToken CancellationToken => _cancellationTokenSource.Token;
+        protected internal CancellationToken CancellationToken => _cancellationTokenSource.Token;
         protected Task SettleNext() => Events.SettleNext();
         protected IObservable<Unit> Settle() => Events.Settle();
 
diff --git a/src/JsonRpc/DryIoc/DryIocAdapter.cs b/src/JsonRpc/DryIoc/DryIocAdapter.cs
@@ -150,7 +150,7 @@ public static void RegisterDescriptor(this IContainer container, ServiceDescript
                 container.RegisterMany(
                     new [] {descriptor.ImplementationType},
                     reuse: reuse,
-                    serviceTypeCondition: type => type == descriptor.ServiceType || typeof(IEventingHandler).IsAssignableFrom(type));
+                    serviceTypeCondition: type => type == descriptor.ImplementationType || type == descriptor.ServiceType || typeof(IEventingHandler).IsAssignableFrom(type) || typeof(IJsonRpcHandler).IsAssignableFrom(type));
             }
             else if (descriptor.ImplementationFactory != null)
             {
@@ -165,8 +165,9 @@ public static void RegisterDescriptor(this IContainer container, ServiceDescript
             else
             {
                 // ensure eventing handlers are pulled in automagically.
-                if (descriptor.ImplementationInstance is IEventingHandler)
+                if (!(descriptor.ImplementationInstance is IEnumerable<object>) && (descriptor.ImplementationInstance is IEventingHandler || descriptor.ImplementationInstance is IJsonRpcHandler))
                 {
+
                     container.RegisterInstanceMany(descriptor.ImplementationInstance);
                 }
                 else
diff --git a/src/Server/Configuration/BaseWorkspaceConfigurationProvider.cs b/src/Server/Configuration/BaseWorkspaceConfigurationProvider.cs
@@ -17,6 +17,8 @@ protected void ParseClientConfiguration(JToken settings, string prefix = null)
             // The null request (appears) to always come second
             // this handler is set to use the SerialAttribute
 
+            Data.Clear();
+
             // TODO: Figure out the best way to plugin to handle additional configurations (toml, yaml?)
             try
             {
diff --git a/src/Server/Configuration/DidChangeConfigurationProvider.cs b/src/Server/Configuration/DidChangeConfigurationProvider.cs
@@ -72,8 +72,12 @@ public async Task<Unit> Handle(DidChangeConfigurationParams request, Cancellatio
         private async Task GetWorkspaceConfiguration()
         {
             var configurationItems = _configurationItems.ToArray();
-            if (configurationItems.Length == 0) return;
-            if (_capability == null) return;
+            if (_capability == null || configurationItems.Length == 0)
+            {
+                _logger.LogWarning("No ConfigurationItems have been defined, configuration won't surface any configuration from the client!");
+                OnReload();
+                return;
+            }
 
             {
                 var configurations = (await _workspaceLanguageServer.RequestConfiguration(new ConfigurationParams() {
diff --git a/src/Server/LanguageServerOptionsExtensions.cs b/src/Server/LanguageServerOptionsExtensions.cs
@@ -72,5 +72,17 @@ public static LanguageServerOptions ConfigureConfiguration(this LanguageServerOp
             options.ConfigurationBuilderAction = builderAction;
             return options;
         }
+
+        public static LanguageServerOptions WithConfigurationSection(this LanguageServerOptions options, string sectionName)
+        {
+            options.Services.AddSingleton(new ConfigurationItem() {Section = sectionName});
+            return options;
+        }
+
+        public static LanguageServerOptions WithConfigurationItem(this LanguageServerOptions options, ConfigurationItem configurationItem)
+        {
+            options.Services.AddSingleton(configurationItem);
+            return options;
+        }
     }
 }
diff --git a/src/Testing/ConfigurationHelpers.cs b/src/Testing/ConfigurationHelpers.cs
@@ -0,0 +1,55 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Reactive;
+using System.Reactive.Linq;
+using System.Reactive.Threading.Tasks;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
+using OmniSharp.Extensions.LanguageServer.Client;
+using OmniSharp.Extensions.LanguageServer.Protocol.Client;
+using OmniSharp.Extensions.LanguageServer.Protocol.Server;
+using OmniSharp.Extensions.LanguageServer.Protocol.Workspace;
+using OmniSharp.Extensions.LanguageServer.Server;
+
+namespace OmniSharp.Extensions.LanguageProtocol.Testing
+{
+    public static class ConfigurationHelpers
+    {
+        public static IConfiguration ToConfiguration(this IEnumerable<KeyValuePair<string, string>> configurationData)
+        {
+            var cb = new ConfigurationBuilder();
+            if (configurationData != null) cb.AddInMemoryCollection(configurationData);
+            return cb.Build();
+        }
+
+        public static Task WaitForChange(this IConfiguration configuration, CancellationToken cancellationToken)
+        {
+            if (configuration == null) throw new ArgumentNullException(nameof(configuration));
+            return Observable.Create<Unit>(observer =>
+            {
+                var reloadToken = configuration.GetReloadToken();
+                return reloadToken.RegisterChangeCallback(_ =>
+                {
+                    observer.OnNext(Unit.Default);
+                    observer.OnCompleted();
+                }, Unit.Default);
+            }).ToTask(cancellationToken);
+        }
+
+        public static Task WaitForChange<T>(this IOptionsMonitor<T> options, CancellationToken cancellationToken)
+        {
+            if (options == null) throw new ArgumentNullException(nameof(options));
+            return Observable.Create<Unit>(observer =>
+            {
+                return options.OnChange(_ =>
+                {
+                    observer.OnNext(Unit.Default);
+                    observer.OnCompleted();
+                });
+            }).ToTask(cancellationToken);
+        }
+    }
+}
diff --git a/src/Testing/LanguageProtocolTestBase.cs b/src/Testing/LanguageProtocolTestBase.cs
@@ -10,6 +10,7 @@
 using OmniSharp.Extensions.JsonRpc.Testing;
 using OmniSharp.Extensions.LanguageServer.Client;
 using OmniSharp.Extensions.LanguageServer.Protocol.Client;
+using OmniSharp.Extensions.LanguageServer.Protocol.Client.Capabilities;
 using OmniSharp.Extensions.LanguageServer.Protocol.Server;
 using OmniSharp.Extensions.LanguageServer.Server;
 using RealLanguageServer = OmniSharp.Extensions.LanguageServer.Server.LanguageServer;
@@ -38,7 +39,7 @@ protected virtual void ConfigureServerInputOutput(PipeReader clientOutput, PipeW
             options.WithInput(clientOutput).WithOutput(serverInput);
         }
 
-        protected virtual async Task<(ILanguageClient client, ILanguageServer server)> Initialize(
+        protected internal virtual (ILanguageClient client, ILanguageServer server) Create(
             Action<LanguageClientOptions> clientOptionsAction,
             Action<LanguageServerOptions> serverOptionsAction)
         {
@@ -70,11 +71,37 @@ protected virtual void ConfigureServerInputOutput(PipeReader clientOutput, PipeW
             Disposable.Add(_client);
             Disposable.Add(_server);
 
+            return (_client, _server);
+        }
+
+        protected internal virtual async Task<(ILanguageClient client, ILanguageServer server)> Initialize(
+            Action<LanguageClientOptions> clientOptionsAction,
+            Action<LanguageServerOptions> serverOptionsAction)
+        {
+            (_client, _server) = Create(clientOptionsAction, serverOptionsAction);
+
             return await ObservableEx.ForkJoin(
                 Observable.FromAsync(_client.Initialize),
                 Observable.FromAsync(_server.Initialize),
                 (a, b) => (_client, _server)
             ).ToTask(CancellationToken);
         }
+
+        protected virtual async Task<(ILanguageClient client, ILanguageServer server, TestConfigurationProvider configurationProvider)> InitializeWithConfiguration(
+            Action<LanguageClientOptions> clientOptionsAction,
+            Action<LanguageServerOptions> serverOptionsAction
+        ) {
+            var (client, server) = Create(options => {
+                clientOptionsAction?.Invoke(options);
+                options.WithCapability(new DidChangeConfigurationCapability());
+                options.Services.AddSingleton<TestConfigurationProvider>();
+            }, serverOptionsAction);
+
+            return await ObservableEx.ForkJoin(
+                Observable.FromAsync(client.Initialize),
+                Observable.FromAsync(server.Initialize),
+                (a, b) => (client, server, client.GetRequiredService<TestConfigurationProvider>())
+            ).ToTask(CancellationToken);
+        }
     }
 }
diff --git a/src/Testing/LanguageServerTestBase.cs b/src/Testing/LanguageServerTestBase.cs
@@ -10,6 +10,7 @@
 using OmniSharp.Extensions.JsonRpc.Testing;
 using OmniSharp.Extensions.LanguageServer.Client;
 using OmniSharp.Extensions.LanguageServer.Protocol.Client;
+using OmniSharp.Extensions.LanguageServer.Protocol.Client.Capabilities;
 using OmniSharp.Extensions.LanguageServer.Protocol.Server;
 using OmniSharp.Extensions.LanguageServer.Server;
 
@@ -28,7 +29,7 @@ public LanguageServerTestBase(JsonRpcTestOptions jsonRpcTestOptions) : base(json
 
         protected abstract (Stream clientOutput, Stream serverInput) SetupServer();
 
-        protected virtual async Task<ILanguageClient> InitializeClient(Action<LanguageClientOptions> clientOptionsAction = null)
+        protected virtual ILanguageClient CreateClient(Action<LanguageClientOptions> clientOptionsAction = null)
         {
             _client = LanguageClient.PreInit(options => {
                 var (reader, writer) = SetupServer();
@@ -45,9 +46,29 @@ protected virtual async Task<ILanguageClient> InitializeClient(Action<LanguageCl
 
             Disposable.Add(_client);
 
+            return _client;
+        }
+
+        protected virtual async Task<ILanguageClient> InitializeClient(Action<LanguageClientOptions> clientOptionsAction = null)
+        {
+            _client = CreateClient(clientOptionsAction);
             await _client.Initialize(CancellationToken);
 
             return _client;
         }
+
+        protected virtual async Task<(ILanguageClient client, TestConfigurationProvider configurationProvider)> InitializeClientWithConfiguration(
+            Action<LanguageClientOptions> clientOptionsAction = null
+        ) {
+            var client = CreateClient(options => {
+                clientOptionsAction?.Invoke(options);
+                options.WithCapability(new DidChangeConfigurationCapability());
+                options.AddHandler<TestConfigurationProvider>();
+            });
+
+            await client.Initialize(CancellationToken);
+
+            return (client, client.GetRequiredService<TestConfigurationProvider>());
+        }
     }
 }
diff --git a/src/Testing/TestConfigurationProvider.cs b/src/Testing/TestConfigurationProvider.cs
diff --git a/test/Lsp.Tests/Integration/LanguageServerConfigurationTests.cs b/test/Lsp.Tests/Integration/LanguageServerConfigurationTests.cs
diff --git a/test/Lsp.Tests/Integration/RequestCancellationTests.cs b/test/Lsp.Tests/Integration/RequestCancellationTests.cs

Original file line number	Diff line number	Diff line change
`@@ -150,7 +150,7 @@ public static void RegisterDescriptor(this IContainer container, ServiceDescript`
`150`	`150`	`container.RegisterMany(`
`151`	`151`	`new [] {descriptor.ImplementationType},`
`152`	`152`	`reuse: reuse,`
`153`		`- serviceTypeCondition: type => type == descriptor.ServiceType \|\| typeof(IEventingHandler).IsAssignableFrom(type));`
	`153`	`+ serviceTypeCondition: type => type == descriptor.ImplementationType \|\| type == descriptor.ServiceType \|\| typeof(IEventingHandler).IsAssignableFrom(type) \|\| typeof(IJsonRpcHandler).IsAssignableFrom(type));`
`154`	`154`	`}`
`155`	`155`	`else if (descriptor.ImplementationFactory != null)`
`156`	`156`	`{`
`@@ -165,8 +165,9 @@ public static void RegisterDescriptor(this IContainer container, ServiceDescript`
`165`	`165`	`else`
`166`	`166`	`{`
`167`	`167`	`// ensure eventing handlers are pulled in automagically.`
`168`		`- if (descriptor.ImplementationInstance is IEventingHandler)`
	`168`	`+ if (!(descriptor.ImplementationInstance is IEnumerable<object>) && (descriptor.ImplementationInstance is IEventingHandler \|\| descriptor.ImplementationInstance is IJsonRpcHandler))`
`169`	`169`	`{`
	`170`	`+`
`170`	`171`	`container.RegisterInstanceMany(descriptor.ImplementationInstance);`
`171`	`172`	`}`
`172`	`173`	`else`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@ protected void ParseClientConfiguration(JToken settings, string prefix = null)`
`17`	`17`	`// The null request (appears) to always come second`
`18`	`18`	`// this handler is set to use the SerialAttribute`
`19`	`19`
	`20`	`+ Data.Clear();`
	`21`	`+`
`20`	`22`	`// TODO: Figure out the best way to plugin to handle additional configurations (toml, yaml?)`
`21`	`23`	`try`
`22`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -72,8 +72,12 @@ public async Task<Unit> Handle(DidChangeConfigurationParams request, Cancellatio`
`72`	`72`	`private async Task GetWorkspaceConfiguration()`
`73`	`73`	`{`
`74`	`74`	`var configurationItems = _configurationItems.ToArray();`
`75`		`- if (configurationItems.Length == 0) return;`
`76`		`- if (_capability == null) return;`
	`75`	`+ if (_capability == null \|\| configurationItems.Length == 0)`
	`76`	`+ {`
	`77`	`+ _logger.LogWarning("No ConfigurationItems have been defined, configuration won't surface any configuration from the client!");`
	`78`	`+ OnReload();`
	`79`	`+ return;`
	`80`	`+ }`
`77`	`81`
`78`	`82`	`{`
`79`	`83`	`var configurations = (await _workspaceLanguageServer.RequestConfiguration(new ConfigurationParams() {`
Original file line number	Diff line number	Diff line change
`@@ -72,5 +72,17 @@ public static LanguageServerOptions ConfigureConfiguration(this LanguageServerOp`
`72`	`72`	`options.ConfigurationBuilderAction = builderAction;`
`73`	`73`	`return options;`
`74`	`74`	`}`
	`75`	`+`
	`76`	`+ public static LanguageServerOptions WithConfigurationSection(this LanguageServerOptions options, string sectionName)`
	`77`	`+ {`
	`78`	`+ options.Services.AddSingleton(new ConfigurationItem() {Section = sectionName});`
	`79`	`+ return options;`
	`80`	`+ }`
	`81`	`+`
	`82`	`+ public static LanguageServerOptions WithConfigurationItem(this LanguageServerOptions options, ConfigurationItem configurationItem)`
	`83`	`+ {`
	`84`	`+ options.Services.AddSingleton(configurationItem);`
	`85`	`+ return options;`
	`86`	`+ }`
`75`	`87`	`}`
`76`	`88`	`}`