Update PsesLogLevel to match MEL levels

Author: JustinGrote

README.md

@@ -87,7 +87,7 @@ $command = @(
         "-HostName 'My Client'",
         "-HostProfileId 'myclient'",
         "-HostVersion 1.0.0",
-        "-LogLevel Diagnostic"
+        "-LogLevel Trace"
 ) -join " "
 
 $pwsh_arguments = "-NoLogo -NoProfile -Command $command"

src/PowerShellEditorServices.Hosting/Commands/StartEditorServicesCommand.cs

@@ -138,7 +138,7 @@ public StartEditorServicesCommand()
         /// The minimum log level that should be emitted.
         /// </summary>
         [Parameter]
-        public PsesLogLevel LogLevel { get; set; } = PsesLogLevel.Warning;
+        public string LogLevel { get; set; } = PsesLogLevel.Warning.ToString();
 
         /// <summary>
         /// Paths to additional PowerShell modules to be imported at startup.
@@ -195,6 +195,11 @@ public StartEditorServicesCommand()
         [Parameter]
         public string StartupBanner { get; set; }
 
+        /// <summary>
+        /// Compatibility to store the currently supported PSESLogLevel Enum Value
+        /// </summary>
+        private PsesLogLevel _psesLogLevel = PsesLogLevel.Warning;
+
 #pragma warning disable IDE0022
         protected override void BeginProcessing()
         {
@@ -257,7 +262,25 @@ protected override void EndProcessing()
 
         private void StartLogging()
         {
-            _logger = new HostLogger(LogLevel);
+            bool isLegacyPsesLogLevel = false;
+            if (!Enum.TryParse(LogLevel, true, out _psesLogLevel))
+            {
+                // PSES used to have log levels that didn't match MEL levels, this is an adapter for those types and may eventually be removed once people migrate their settings.
+                isLegacyPsesLogLevel = true;
+                _psesLogLevel = LogLevel switch
+                {
+                    "Diagnostic" => PsesLogLevel.Trace,
+                    "Verbose" => PsesLogLevel.Debug,
+                    "Normal" => PsesLogLevel.Information,
+                    _ => PsesLogLevel.Trace
+                };
+            }
+
+            _logger = new HostLogger(_psesLogLevel);
+            if (isLegacyPsesLogLevel)
+            {
+                _logger.Log(PsesLogLevel.Warning, $"The log level '{LogLevel}' is deprecated and will be removed in a future release. Please update your settings or command line options to use one of the following options: 'Trace', 'Debug', 'Information', 'Warning', 'Error', 'Critical'.");
+            }
 
             // We need to not write log messages to Stdio
             // if it's being used as a protocol transport
@@ -349,7 +372,7 @@ private EditorServicesConfig CreateConfigObject()
                 LogPath)
             {
                 FeatureFlags = FeatureFlags,
-                LogLevel = LogLevel,
+                LogLevel = _psesLogLevel,
                 ConsoleRepl = GetReplKind(),
                 UseNullPSHostUI = Stdio, // If Stdio is used we can't write anything else out
                 AdditionalModules = AdditionalModules,

src/PowerShellEditorServices.Hosting/EditorServicesLoader.cs

@@ -212,10 +212,10 @@ public Task LoadAndRunEditorServicesAsync()
             ValidateConfiguration();
 
             // Method with no implementation that forces the PSES assembly to load, triggering an AssemblyResolve event
-            _logger.Log(PsesLogLevel.Debug, "Loading PowerShell Editor Services");
+            _logger.Log(PsesLogLevel.Information, "Loading PowerShell Editor Services");
             LoadEditorServices();
 
-            _logger.Log(PsesLogLevel.Debug, "Starting EditorServices");
+            _logger.Log(PsesLogLevel.Information, "Starting EditorServices");
 
             _editorServicesRunner = new EditorServicesRunner(_logger, _hostConfig, _sessionFileWriter, _loggersToUnsubscribe);
 

src/PowerShellEditorServices.Hosting/Internal/EditorServicesRunner.cs

@@ -64,7 +64,7 @@ public Task RunUntilShutdown()
             _sessionFileWriter.WriteSessionStarted(_config.LanguageServiceTransport, _config.DebugServiceTransport);
 
             // Finally, wait for Editor Services to shut down
-            _logger.Log(PsesLogLevel.Trace, "Waiting on PSES run/shutdown");
+            _logger.Log(PsesLogLevel.Debug, "Waiting on PSES run/shutdown");
             return runAndAwaitShutdown;
         }
 
@@ -124,7 +124,7 @@ private async Task CreateEditorServicesAndRunUntilShutdown()
         {
             try
             {
-                _logger.Log(PsesLogLevel.Trace, "Creating/running editor services");
+                _logger.Log(PsesLogLevel.Debug, "Creating/running editor services");
 
                 bool creatingLanguageServer = _config.LanguageServiceTransport != null;
                 bool creatingDebugServer = _config.DebugServiceTransport != null;
@@ -140,6 +140,9 @@ private async Task CreateEditorServicesAndRunUntilShutdown()
                     return;
                 }
 
+                _logger.Log(PsesLogLevel.Information, "PSES Startup Completed. Starting Language Server.");
+                _logger.Log(PsesLogLevel.Information, "Please check the LSP log file in your client for further messages. In VSCode, this is the 'PowerShell' output pane");
+
                 // We want LSP and maybe debugging
                 // To do that we:
                 //  - Create the LSP server
@@ -149,7 +152,6 @@ private async Task CreateEditorServicesAndRunUntilShutdown()
                 //  - Wait for the LSP server to finish
 
                 // Unsubscribe the host logger here so that the Extension Terminal is not polluted with input after the first prompt
-                _logger.Log(PsesLogLevel.Debug, "Starting server, deregistering host logger and registering shutdown listener");
                 if (_loggersToUnsubscribe != null)
                 {
                     foreach (IDisposable loggerToUnsubscribe in _loggersToUnsubscribe)
@@ -193,7 +195,7 @@ private async Task CreateEditorServicesAndRunUntilShutdown()
 
         private async Task RunTempDebugSessionAsync(HostStartupInfo hostDetails)
         {
-            _logger.Log(PsesLogLevel.Trace, "Running temp debug session");
+            _logger.Log(PsesLogLevel.Information, "Starting temporary debug session");
             PsesDebugServer debugServer = await CreateDebugServerForTempSessionAsync(hostDetails).ConfigureAwait(false);
             _logger.Log(PsesLogLevel.Debug, "Debug server created");
             await debugServer.StartAsync().ConfigureAwait(false);
@@ -222,35 +224,35 @@ private async Task StartDebugServer(Task<PsesDebugServer> debugServerCreation)
 
         private Task RestartDebugServerAsync(PsesDebugServer debugServer)
         {
-            _logger.Log(PsesLogLevel.Trace, "Restarting debug server");
+            _logger.Log(PsesLogLevel.Debug, "Restarting debug server");
             Task<PsesDebugServer> debugServerCreation = RecreateDebugServerAsync(debugServer);
             return StartDebugServer(debugServerCreation);
         }
 
         private async Task<PsesLanguageServer> CreateLanguageServerAsync(HostStartupInfo hostDetails)
         {
-            _logger.Log(PsesLogLevel.Debug, $"Creating LSP transport with endpoint {_config.LanguageServiceTransport.EndpointDetails}");
+            _logger.Log(PsesLogLevel.Trace, $"Creating LSP transport with endpoint {_config.LanguageServiceTransport.EndpointDetails}");
             (Stream inStream, Stream outStream) = await _config.LanguageServiceTransport.ConnectStreamsAsync().ConfigureAwait(false);
 
-            _logger.Log(PsesLogLevel.Trace, "Creating language server");
+            _logger.Log(PsesLogLevel.Debug, "Creating language server");
             return _serverFactory.CreateLanguageServer(inStream, outStream, hostDetails);
         }
 
         private async Task<PsesDebugServer> CreateDebugServerWithLanguageServerAsync(PsesLanguageServer languageServer)
         {
-            _logger.Log(PsesLogLevel.Debug, $"Creating debug adapter transport with endpoint {_config.DebugServiceTransport.EndpointDetails}");
+            _logger.Log(PsesLogLevel.Trace, $"Creating debug adapter transport with endpoint {_config.DebugServiceTransport.EndpointDetails}");
             (Stream inStream, Stream outStream) = await _config.DebugServiceTransport.ConnectStreamsAsync().ConfigureAwait(false);
 
-            _logger.Log(PsesLogLevel.Trace, "Creating debug adapter");
+            _logger.Log(PsesLogLevel.Debug, "Creating debug adapter");
             return _serverFactory.CreateDebugServerWithLanguageServer(inStream, outStream, languageServer);
         }
 
         private async Task<PsesDebugServer> RecreateDebugServerAsync(PsesDebugServer debugServer)
         {
-            _logger.Log(PsesLogLevel.Trace, "Recreating debug adapter transport");
+            _logger.Log(PsesLogLevel.Debug, "Recreating debug adapter transport");
             (Stream inStream, Stream outStream) = await _config.DebugServiceTransport.ConnectStreamsAsync().ConfigureAwait(false);
 
-            _logger.Log(PsesLogLevel.Trace, "Recreating debug adapter");
+            _logger.Log(PsesLogLevel.Debug, "Recreating debug adapter");
             return _serverFactory.RecreateDebugServer(inStream, outStream, debugServer);
         }
 
@@ -263,7 +265,7 @@ private async Task<PsesDebugServer> CreateDebugServerForTempSessionAsync(HostSta
 
         private HostStartupInfo CreateHostStartupInfo()
         {
-            _logger.Log(PsesLogLevel.Trace, "Creating startup info object");
+            _logger.Log(PsesLogLevel.Debug, "Creating startup info object");
 
             ProfilePathInfo profilePaths = null;
             if (_config.ProfilePaths.AllUsersAllHosts != null