Fix breakpoint removal; add "close" request

The first change fixes breakpoint removal.  Previously, breakpoints were
being tracked per-file based on the script's file path.  It was discovered
that file paths were being sent through the protocol with inconsistent
casing, so path normalization was needed to ensure that breakpoints were
being indexed with the correct path casing.

The second change adds the "close" request for closing opened files.  This
request was not being used by VS Code previously but was suddenly getting
sent in newer builds of that editor.

Author: daviwil

src/PowerShellEditorServices.Transport.Stdio/PowerShellEditorServices.Transport.Stdio.csproj

@@ -89,6 +89,7 @@
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="Request\AttachRequest.cs" />
     <Compile Include="Request\ChangeFileRequest.cs" />
+    <Compile Include="Request\CloseFileRequest.cs" />
     <Compile Include="Request\CompletionDetailsRequest.cs" />
     <Compile Include="Request\CompletionsRequest.cs" />
     <Compile Include="Request\ContinueRequest.cs" />

src/PowerShellEditorServices.Transport.Stdio/Request/CloseFileRequest.cs

@@ -0,0 +1,42 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using Microsoft.PowerShell.EditorServices.Session;
+using Microsoft.PowerShell.EditorServices.Transport.Stdio.Message;
+using Nito.AsyncEx;
+using System.Threading.Tasks;
+
+namespace Microsoft.PowerShell.EditorServices.Transport.Stdio.Request
+{
+    [MessageTypeName("close")]
+    public class CloseFileRequest : RequestBase<FileRequestArguments>
+    {
+        public static CloseFileRequest Create(string filePath)
+        {
+            return new CloseFileRequest
+            {
+                Arguments = new FileRequestArguments
+                {
+                    File = filePath
+                }
+            };
+        }
+
+        public override Task ProcessMessage(
+            EditorSession editorSession,
+            MessageWriter messageWriter)
+        {
+            // Find and close the file in the current session
+            var fileToClose = editorSession.Workspace.GetFile(this.Arguments.File);
+
+            if (fileToClose != null)
+            {
+                editorSession.Workspace.CloseFile(fileToClose);
+            }
+
+            return TaskConstants.Completed;
+        }
+    }
+}

src/PowerShellEditorServices.Transport.Stdio/Request/SetBreakpointsRequest.cs

@@ -19,7 +19,6 @@ public override async Task ProcessMessage(
             EditorSession editorSession, 
             MessageWriter messageWriter)
         {
-            // TODO: Catch FileNotFoundException
             ScriptFile scriptFile =
                 editorSession.Workspace.GetFile(
                     this.Arguments.Source.Path);

src/PowerShellEditorServices/Console/PowerShellSession.cs

@@ -192,13 +192,16 @@ public async Task<IEnumerable<TResult>> ExecuteCommand<TResult>(
             if (Thread.CurrentThread.ManagedThreadId != this.pipelineThreadId &&
                 this.pipelineExecutionTask != null)
             {
+                PipelineExecutionRequest<TResult> executionRequest =
+                    new PipelineExecutionRequest<TResult>(
+                        this, psCommand, sendOutputToHost);
+
                 // Send the pipeline execution request to the pipeline thread
                 this.pipelineResultTask = new TaskCompletionSource<IPipelineExecutionRequest>();
-                this.pipelineExecutionTask.SetResult(
-                    new PipelineExecutionRequest<TResult>(
-                        this, psCommand, sendOutputToHost));
+                this.pipelineExecutionTask.SetResult(executionRequest);
 
                 await this.pipelineResultTask.Task;
+                return executionRequest.Results;
             }
             else
             {

src/PowerShellEditorServices/DebugService.cs

@@ -203,7 +203,7 @@ private async Task ClearBreakpointsInFile(ScriptFile scriptFile)
             List<Breakpoint> breakpoints = null;
 
             // Get the list of breakpoints for this file
-            if (this.breakpointsPerFile.TryGetValue(scriptFile.FilePath, out breakpoints))
+            if (this.breakpointsPerFile.TryGetValue(scriptFile.Id, out breakpoints))
             {
                 if (breakpoints.Count > 0)
                 {
@@ -212,6 +212,9 @@ private async Task ClearBreakpointsInFile(ScriptFile scriptFile)
                     psCommand.AddParameter("Breakpoint", breakpoints.ToArray());
 
                     await this.powerShellSession.ExecuteCommand<object>(psCommand);
+
+                    // Clear the existing breakpoints list for the file
+                    breakpoints.Clear();
                 }
             }
         }
@@ -275,12 +278,15 @@ private void OnBreakpointUpdated(object sender, BreakpointUpdatedEventArgs e)
         {
             List<Breakpoint> breakpoints = null;
 
+            // Normalize the script filename for proper indexing
+            string normalizedScriptName = e.Breakpoint.Script.ToLower();
+
             // Get the list of breakpoints for this file
-            if (!this.breakpointsPerFile.TryGetValue(e.Breakpoint.Script, out breakpoints))
+            if (!this.breakpointsPerFile.TryGetValue(normalizedScriptName, out breakpoints))
             {
                 breakpoints = new List<Breakpoint>();
                 this.breakpointsPerFile.Add(
-                    e.Breakpoint.Script,
+                    normalizedScriptName,
                     breakpoints);
             }
 

src/PowerShellEditorServices/Language/LanguageService.cs

@@ -102,7 +102,7 @@ public async Task<CompletionResults> GetCompletionsInFile(
 
             // save state of most recent completion
             mostRecentCompletions = completionResults;
-            mostRecentRequestFile = scriptFile.FilePath;
+            mostRecentRequestFile = scriptFile.Id;
             mostRecentRequestLine = lineNumber;
             mostRecentRequestOffest = columnNumber;
 
@@ -124,7 +124,7 @@ public CompletionDetails GetCompletionDetailsInFile(
             string entryName)
         {
             // Makes sure the most recent completions request was the same line and column as this request
-            if (file.FilePath.Equals(mostRecentRequestFile) &&
+            if (file.Id.Equals(mostRecentRequestFile) &&
                 lineNumber == mostRecentRequestLine &&
                 columnNumber == mostRecentRequestOffest)
             {

src/PowerShellEditorServices/Session/ScriptFile.cs

@@ -28,7 +28,17 @@ public class ScriptFile
         #region Properties
 
         /// <summary>
-        /// Gets the  path at which this file resides.
+        /// Gets a unique string that identifies this file.  At this time,
+        /// this property returns a normalized version of the value stored
+        /// in the FilePath property.
+        /// </summary>
+        public string Id
+        {
+            get { return this.FilePath.ToLower(); }
+        }
+
+        /// <summary>
+        /// Gets the path at which this file resides.
         /// </summary>
         public string FilePath { get; private set; }
 

src/PowerShellEditorServices/Session/Workspace.cs

@@ -73,7 +73,7 @@ public void CloseFile(ScriptFile scriptFile)
         {
             Validate.IsNotNull("scriptFile", scriptFile);
 
-            this.workspaceFiles.Remove(scriptFile.FilePath);
+            this.workspaceFiles.Remove(scriptFile.Id);
         }
 
         /// <summary>
@@ -89,12 +89,12 @@ public ScriptFile[] ExpandScriptReferences(ScriptFile scriptFile)
             List<ScriptFile> expandedReferences = new List<ScriptFile>();
 
             // add original file so it's not searched for, then find all file references
-            referencedScriptFiles.Add(scriptFile.FilePath, scriptFile); 
+            referencedScriptFiles.Add(scriptFile.Id, scriptFile); 
             RecursivelyFindReferences(scriptFile, referencedScriptFiles);
 
             // remove original file from referened file and add it as the first element of the
             // expanded referenced list to maintain order so the original file is always first in the list
-            referencedScriptFiles.Remove(scriptFile.FilePath);
+            referencedScriptFiles.Remove(scriptFile.Id);
             expandedReferences.Add(scriptFile);
 
             if (referencedScriptFiles.Count > 0)
@@ -132,6 +132,10 @@ private void RecursivelyFindReferences(
                 {
                     // Get the referenced file if it's not already in referencedScriptFiles
                     referencedFile = this.GetFile(resolvedScriptPath);
+
+                    // Normalize the resolved script path and add it to the
+                    // referenced files list if it isn't there already
+                    resolvedScriptPath = resolvedScriptPath.ToLower();
                     if (!referencedScriptFiles.ContainsKey(resolvedScriptPath))
                     {
                         referencedScriptFiles.Add(resolvedScriptPath, referencedFile);