address rob's feedback

Author: TylerLeonhardt

src/PowerShellEditorServices/Hosting/EditorServicesHost.cs

@@ -284,16 +284,16 @@ public void StartLanguageService(
         /// </summary>
         /// <param name="config">The config that contains information on the communication protocol that will be used.</param>
         /// <param name="profilePaths">The profiles that will be loaded in the session.</param>
-        /// <param name="useExistingSession">Determines if we will reuse the session that we have.</param>
+        /// <param name="useTempSession">Determines if we will make a new session typically used for temporary console debugging.</param>
         public void StartDebugService(
             EditorServiceTransportConfig config,
             ProfilePaths profilePaths,
-            bool useExistingSession)
+            bool useTempSession)
         {
             _logger.LogInformation($"Debug NamedPipe: {config.InOutPipeName}\nDebug OutPipe: {config.OutPipeName}");
 
             IServiceProvider serviceProvider = null;
-            if (!useExistingSession)
+            if (useTempSession)
             {
                 serviceProvider = new ServiceCollection()
                     .AddLogging(builder => builder
@@ -331,7 +331,7 @@ public void StartDebugService(
                         .ContinueWith(async task =>
                         {
                             _logger.LogInformation("Starting debug server");
-                            await _debugServer.StartAsync(serviceProvider ?? _languageServer.LanguageServer.Services, useExistingSession);
+                            await _debugServer.StartAsync(serviceProvider ?? _languageServer.LanguageServer.Services, useTempSession);
                             _logger.LogInformation(
                                 $"Debug service started, type = {config.TransportType}, endpoint = {config.Endpoint}");
                         });
@@ -348,7 +348,7 @@ public void StartDebugService(
                     Task.Run(async () =>
                     {
 
-                        await _debugServer.StartAsync(serviceProvider ?? _languageServer.LanguageServer.Services, useExistingSession);
+                        await _debugServer.StartAsync(serviceProvider ?? _languageServer.LanguageServer.Services, useTempSession);
                         _logger.LogInformation(
                             $"Debug service started, type = {config.TransportType}, endpoint = {config.Endpoint}");
                     });
@@ -363,14 +363,14 @@ public void StartDebugService(
             // This design decision was done since this "debug-only PSES" is used in the "Temporary Integrated Console debugging"
             // feature which does not want PSES to be restarted so that the user can see the output of the last debug
             // session.
-            if(!alreadySubscribedDebug && useExistingSession)
+            if(!alreadySubscribedDebug && !useTempSession)
             {
                 alreadySubscribedDebug = true;
                 _debugServer.SessionEnded += (sender, eventArgs) =>
                 {
                     _debugServer.Dispose();
                     alreadySubscribedDebug = false;
-                    StartDebugService(config, profilePaths, useExistingSession);
+                    StartDebugService(config, profilePaths, useTempSession);
                 };
             }
         }
@@ -388,12 +388,19 @@ public void StopServices()
         /// </summary>
         public void WaitForCompletion()
         {
-            // TODO: We need a way to know when to complete this task!
+            // If _languageServer is not null, then we are either using:
+            // Stdio - that only uses a LanguageServer so we return when that has shutdown.
+            // NamedPipes - that uses both LanguageServer and DebugServer, but LanguageServer
+            //              is the core of PowerShell Editor Services and if that shuts down,
+            //              we want the whole process to shutdown.
             if (_languageServer != null)
             {
                 _languageServer.WaitForShutdown().Wait();
                 return;
             }
+
+            // If there is no LanguageServer, then we must be running with the DebugServiceOnly switch
+            // (used in Temporary console debugging) and we need to wait for the DebugServer to shutdown.
             _debugServer.WaitForShutdown().Wait();
         }
 

src/PowerShellEditorServices/Server/PsesDebugServer.cs

@@ -26,7 +26,7 @@ public class PsesDebugServer : IDisposable
 
         private PowerShellContextService _powerShellContextService;
 
-        private readonly TaskCompletionSource<bool> _serverStart;
+        private readonly TaskCompletionSource<bool> _serverRunning;
 
         public PsesDebugServer(
             ILoggerFactory factory,
@@ -36,10 +36,10 @@ public PsesDebugServer(
             _loggerFactory = factory;
             _inputStream = inputStream;
             _outputStream = outputStream;
-            _serverStart = new TaskCompletionSource<bool>();
+            _serverRunning = new TaskCompletionSource<bool>();
         }
 
-        public async Task StartAsync(IServiceProvider languageServerServiceProvider, bool useExistingSession)
+        public async Task StartAsync(IServiceProvider languageServerServiceProvider, bool useTempSession)
         {
             _jsonRpcServer = await JsonRpcServer.From(options =>
             {
@@ -59,7 +59,7 @@ public async Task StartAsync(IServiceProvider languageServerServiceProvider, boo
                     .Wait();
 
                 options.Services = new ServiceCollection()
-                    .AddPsesDebugServices(languageServerServiceProvider, this, useExistingSession);
+                    .AddPsesDebugServices(languageServerServiceProvider, this, useTempSession);
 
                 options
                     .WithInput(_inputStream)
@@ -97,12 +97,12 @@ public void Dispose()
         {
             _powerShellContextService.IsDebugServerActive = false;
             _jsonRpcServer.Dispose();
-            _serverStart.SetResult(true);
+            _serverRunning.SetResult(true);
         }
 
         public async Task WaitForShutdown()
         {
-            await _serverStart.Task;
+            await _serverRunning.Task;
         }
 
         #region Events

src/PowerShellEditorServices/Server/PsesServiceCollection.cs renamed to src/PowerShellEditorServices/Server/PsesServiceCollectionExtensions.cs

@@ -1,4 +1,4 @@
-//
+//
 // Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
@@ -13,7 +13,7 @@
 
 namespace Microsoft.PowerShell.EditorServices.Server
 {
-    internal static class PsesServiceCollection
+    internal static class PsesServiceCollectionExtensions
     {
         public static IServiceCollection AddPsesLanguageServices (
             this IServiceCollection collection,
@@ -67,7 +67,7 @@ public static IServiceCollection AddPsesDebugServices (
             this IServiceCollection collection,
             IServiceProvider languageServiceProvider,
             PsesDebugServer psesDebugServer,
-            bool useExistingSession
+            bool useTempSession
         )
         {
             return collection.AddSingleton(languageServiceProvider.GetService<PowerShellContextService>())
@@ -77,7 +77,7 @@ bool useExistingSession
                 .AddSingleton<DebugService>()
                 .AddSingleton<DebugStateService>(new DebugStateService
                 {
-                     OwnsEditorSession = !useExistingSession
+                     OwnsEditorSession = useTempSession
                 })
                 .AddSingleton<DebugEventHandlerService>();
         }