Add tests, fix bugs

Author: Rob Holt

src/PowerShellEditorServices.Engine/Hosting/EditorServicesHost.cs

@@ -14,6 +14,7 @@
 using System.Threading.Tasks;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
+using OmniSharp.Extensions.LanguageServer.Protocol.Models;
 using Serilog;
 
 namespace Microsoft.PowerShell.EditorServices.Engine
@@ -225,6 +226,7 @@ public void StartLanguageService(
 
             _logger.LogInformation($"LSP NamedPipe: {config.InOutPipeName}\nLSP OutPipe: {config.OutPipeName}");
 
+            _serviceCollection.AddSingleton<TextDocumentChangeRegistrationOptions>();
             _serviceCollection.AddSingleton<WorkspaceService>();
             _serviceCollection.AddSingleton<SymbolsService>();
             _serviceCollection.AddSingleton<ConfigurationService>();

src/PowerShellEditorServices.Engine/LanguageServer/OmnisharpLanguageServer.cs

@@ -8,6 +8,7 @@
 using System.Security.AccessControl;
 using OmniSharp.Extensions.LanguageServer.Server;
 using PowerShellEditorServices.Engine.Services.Handlers;
+using Microsoft.PowerShell.EditorServices.TextDocument;
 
 namespace Microsoft.PowerShell.EditorServices.Engine
 {
@@ -56,18 +57,26 @@ public async Task StartAsync()
                     _configuration.OutNamedPipeName,
                     out NamedPipeServerStream outNamedPipe);
 
+                ILogger logger = options.LoggerFactory.CreateLogger("OptionsStartup");
+
+                logger.LogInformation("Waiting for connection");
                 namedPipe.WaitForConnection();
                 if (outNamedPipe != null)
                 {
                     outNamedPipe.WaitForConnection();
                 }
 
+                logger.LogInformation("Connected");
+
                 options.Input = namedPipe;
                 options.Output = outNamedPipe ?? namedPipe;
 
                 options.LoggerFactory = _configuration.LoggerFactory;
                 options.MinimumLogLevel = _configuration.MinimumLogLevel;
                 options.Services = _configuration.Services;
+
+                logger.LogInformation("Adding handlers");
+
                 options
                     .WithHandler<WorkspaceSymbolsHandler>()
                     .WithHandler<TextDocumentHandler>()
@@ -77,7 +86,10 @@ public async Task StartAsync()
                     .WithHandler<DocumentFormattingHandler>()
                     .WithHandler<DocumentRangeFormattingHandler>()
                     .WithHandler<ReferencesHandler>()
-                    .WithHandler<DocumentSymbolHandler>();
+                    .WithHandler<DocumentSymbolHandler>()
+                    .WithHandler<DocumentHighlightHandler>();
+
+                logger.LogInformation("Handlers added");
             });
 
             _serverStart.SetResult(true);

src/PowerShellEditorServices.Engine/Services/TextDocument/Handlers/DocumentHighlightHandler.cs

@@ -5,6 +5,7 @@
 
 using Microsoft.Extensions.Logging;
 using Microsoft.PowerShell.EditorServices.Symbols;
+using OmniSharp.Extensions.LanguageServer.Protocol.Client.Capabilities;
 using OmniSharp.Extensions.LanguageServer.Protocol.Models;
 using OmniSharp.Extensions.LanguageServer.Protocol.Server;
 using PowerShellEditorServices.Engine.Utility;
@@ -14,7 +15,7 @@
 
 namespace Microsoft.PowerShell.EditorServices.TextDocument
 {
-    public class PsesDocumentHighlightHandler : DocumentHighlightHandler
+    public class DocumentHighlightHandler : IDocumentHighlightHandler
     {
         private static readonly DocumentHighlightContainer s_emptyHighlightContainer = new DocumentHighlightContainer();
 
@@ -24,28 +25,40 @@ public class PsesDocumentHighlightHandler : DocumentHighlightHandler
 
         private readonly SymbolsService _symbolsService;
 
-        public PsesDocumentHighlightHandler(
+        private readonly TextDocumentRegistrationOptions _registrationOptions;
+
+        private DocumentHighlightCapability _capability;
+
+        public DocumentHighlightHandler(
             ILoggerFactory loggerFactory,
             WorkspaceService workspaceService,
-            SymbolsService symbolService,
-            TextDocumentRegistrationOptions registrationOptions)
-            : base(registrationOptions)
+            SymbolsService symbolService)
         {
-            _logger = loggerFactory.CreateLogger<DocumentHighlightHandler>();
+            _logger = loggerFactory.CreateLogger<OmniSharp.Extensions.LanguageServer.Protocol.Server.DocumentHighlightHandler>();
             _workspaceService = workspaceService;
             _symbolsService = symbolService;
+            _registrationOptions = new TextDocumentRegistrationOptions()
+            {
+                DocumentSelector = new DocumentSelector(new DocumentFilter() { Pattern = "**/*.ps*1" } )
+            };
+            _logger.LogInformation("highlight handler loaded");
         }
 
-        public override Task<DocumentHighlightContainer> Handle(
+        public TextDocumentRegistrationOptions GetRegistrationOptions()
+        {
+            return _registrationOptions;
+        }
+
+        public Task<DocumentHighlightContainer> Handle(
             DocumentHighlightParams request,
             CancellationToken cancellationToken)
         {
             ScriptFile scriptFile = _workspaceService.GetFile(PathUtils.FromUri(request.TextDocument.Uri));
 
             IReadOnlyList<SymbolReference> symbolOccurrences = _symbolsService.FindOccurrencesInFile(
                 scriptFile,
-                (int)(request.Position.Line + 1),
-                (int)(request.Position.Character + 1));
+                (int)request.Position.Line,
+                (int)request.Position.Character);
 
             if (symbolOccurrences == null)
             {
@@ -64,5 +77,10 @@ public override Task<DocumentHighlightContainer> Handle(
 
             return Task.FromResult(new DocumentHighlightContainer(highlights));
         }
+
+        public void SetCapability(DocumentHighlightCapability capability)
+        {
+            _capability = capability;
+        }
     }
 }

test/Pester/EditorServices.Integration.Tests.ps1

@@ -299,6 +299,34 @@ Get-Bar
         $response.Result[1].range.end.character | Should -BeExactly 7
     }
 
+    It "Can handle a textDocument/documentHighlight request" {
+        $filePath = New-TestFile -Script @'
+Write-Host 'Hello!'
+
+Write-Host 'Goodbye'
+'@
+
+        $documentHighlightParams = @{
+            Client = $client
+            Uri = ([uri]::new($filePath).AbsoluteUri)
+            LineNumber = 3
+            CharacterNumber = 1
+        }
+        $request = Send-LspDocumentHighlightRequest @documentHighlightParams
+
+        $response = Get-LspResponse -Client $client -Id $request.Id
+
+        $response.Result.Count | Should -BeExactly 2
+        $response.Result[0].Range.Start.Line | Should -BeExactly 0
+        $response.Result[0].Range.Start.Character | Should -BeExactly 0
+        $response.Result[0].Range.End.Line | Should -BeExactly 0
+        $response.Result[0].Range.End.Character | Should -BeExactly 10
+        $response.Result[1].Range.Start.Line | Should -BeExactly 2
+        $response.Result[1].Range.Start.Character | Should -BeExactly 0
+        $response.Result[1].Range.End.Line | Should -BeExactly 2
+        $response.Result[1].Range.End.Character | Should -BeExactly 10
+    }
+
     # This test MUST be last
     It "Shuts down the process properly" {
         $request = Send-LspShutdownRequest -Client $client

tools/PsesPsClient/PsesPsClient.psd1

@@ -79,6 +79,7 @@ FunctionsToExport = @(
     'Send-LspFormattingRequest',
     'Send-LspRangeFormattingRequest',
     'Send-LspDocumentSymbolRequest',
+    'Send-LspDocumentHighlightRequest',
     'Send-LspReferencesRequest',
     'Send-LspShutdownRequest',
     'Get-LspNotification',

tools/PsesPsClient/PsesPsClient.psm1

@@ -453,6 +453,40 @@ function Send-LspReferencesRequest
     return Send-LspRequest -Client $Client -Method 'textDocument/references' -Parameters $params
 }
 
+function Send-LspDocumentHighlightRequest
+{
+    [OutputType([PsesPsClient.LspRequest])]
+    param(
+        [Parameter(Position = 0, Mandatory)]
+        [PsesPsClient.PsesLspClient]
+        $Client,
+
+        [Parameter(Position = 1, Mandatory)]
+        [string]
+        $Uri,
+
+        [Parameter(Mandatory)]
+        [int]
+        $LineNumber,
+
+        [Parameter(Mandatory)]
+        [int]
+        $CharacterNumber
+    )
+
+    $documentHighlightParams = [Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.TextDocumentPositionParams]@{
+        TextDocument = [Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.TextDocumentIdentifier]@{
+            Uri = $Uri
+        }
+        Position = [Microsoft.PowerShell.EditorServices.Protocol.LanguageServer.Position]@{
+            Line = $LineNumber
+            Character = $CharacterNumber
+        }
+    }
+
+    return Send-LspRequest -Client $Client -Method 'textDocument/documentHighlight' -Parameters $documentHighlightParams
+}
+
 function Send-LspShutdownRequest
 {
     [OutputType([PsesPsClient.LspRequest])]