Change logging to use Serilog (#666)

* Introduce serilog as logger backend

* Put netstandard first in csproj files

* Add serilog logic, begin internal builder for logger

* Add log builder, switch log use, add comments

* Add Serilog DLL to module output

* Update Third Party Notices

* Make file logging asynchronous

* Add static null logger

* Use cross-platform newlines

Author: rjmholt

PowerShellEditorServices.build.ps1

@@ -177,13 +177,13 @@ task TestServer -If { !$script:IsUnix } {
     exec { & $script:dotnetExe xunit -configuration $Configuration -framework net452 -verbose -nobuild }
 }
 
-task TestProtocol -If { !$script:IsUnix} {
+task TestProtocol -If { !$script:IsUnix } {
     Set-Location .\test\PowerShellEditorServices.Test.Protocol\
     exec { & $script:dotnetExe build -c $Configuration -f net452 }
     exec { & $script:dotnetExe xunit -configuration $Configuration -framework net452 -verbose -nobuild }
 }
 
-task TestHost -If { !$script:IsUnix} {
+task TestHost -If { !$script:IsUnix } {
     Set-Location .\test\PowerShellEditorServices.Test.Host\
     exec { & $script:dotnetExe build -c $Configuration -f net452 }
     exec { & $script:dotnetExe xunit -configuration $Configuration -framework net452 -verbose -nobuild }
@@ -204,10 +204,14 @@ task LayoutModule -After Build {
     New-Item -Force $PSScriptRoot\module\PowerShellEditorServices\bin\Desktop -Type Directory | Out-Null
     New-Item -Force $PSScriptRoot\module\PowerShellEditorServices\bin\Core -Type Directory | Out-Null
 
+    Copy-Item -Force -Path $PSScriptRoot\src\PowerShellEditorServices\bin\$Configuration\netstandard1.6\publish\Serilog*.dll -Destination $PSScriptRoot\module\PowerShellEditorServices\bin\Core\
+
     Copy-Item -Force -Path $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\netstandard1.6\* -Filter Microsoft.PowerShell.EditorServices*.dll -Destination $PSScriptRoot\module\PowerShellEditorServices\bin\Core\
     Copy-Item -Force -Path $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\netstandard1.6\UnixConsoleEcho.dll -Destination $PSScriptRoot\module\PowerShellEditorServices\bin\Core\
     Copy-Item -Force -Path $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\netstandard1.6\libdisablekeyecho.* -Destination $PSScriptRoot\module\PowerShellEditorServices\bin\Core\
     if (!$script:IsUnix) {
+        Copy-Item -Force -Path $PSScriptRoot\src\PowerShellEditorServices\bin\$Configuration\net451\Serilog*.dll -Destination $PSScriptRoot\module\PowerShellEditorServices\bin\Desktop
+
         Copy-Item -Force -Path $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\net451\* -Filter Microsoft.PowerShell.EditorServices*.dll -Destination $PSScriptRoot\module\PowerShellEditorServices\bin\Desktop\
         Copy-Item -Force -Path $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\net451\Newtonsoft.Json.dll -Destination $PSScriptRoot\module\PowerShellEditorServices\bin\Desktop\
         Copy-Item -Force -Path $PSScriptRoot\src\PowerShellEditorServices.Host\bin\$Configuration\net451\UnixConsoleEcho.dll -Destination $PSScriptRoot\module\PowerShellEditorServices\bin\Desktop\

Third Party Notices.txt

@@ -5,7 +5,7 @@ This file is based on or incorporates material from the projects listed below (T
 UnixConsoleEcho
 
 Copyright (c) 2017 Patrick Meinecke
- Provided for Informational Purposes Only
+Provided for Informational Purposes Only
 
 MIT License
 
@@ -14,3 +14,75 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+
+Serilog
+
+Copyright 2013-2015 Serilog Contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+---
+
+Serilog.Sinks.Async
+
+Copyright 2013-2015 Serilog Contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+---
+
+Serilog.Sinks.File
+
+Copyright 2013-2015 Serilog Contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+---
+
+Serilog.Sinks.Console
+
+Copyright 2013-2015 Serilog Contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

src/PowerShellEditorServices.Host/CodeLens/CodeLensFeature.cs

@@ -160,4 +160,4 @@ private class CodeLensData
             public string ProviderId {get; set; }
         }
     }
-}
+}

src/PowerShellEditorServices.Host/EditorServicesHost.cs

@@ -140,7 +140,10 @@ public EditorServicesHost(
         /// <param name="logLevel">The minimum level of log messages to be written.</param>
         public void StartLogging(string logFilePath, LogLevel logLevel)
         {
-            this.logger = new FileLogger(logFilePath, logLevel);
+            this.logger = Logging.CreateLogger()
+                            .LogLevel(logLevel)
+                            .AddLogFile(logFilePath)
+                            .Build();
 
 #if CoreCLR
             FileVersionInfo fileVersionInfo =

src/PowerShellEditorServices.Host/PowerShellEditorServices.Host.csproj

@@ -4,7 +4,7 @@
   <PropertyGroup>
     <AssemblyTitle>PowerShell Editor Services Host Process</AssemblyTitle>
     <Description>Provides a process for hosting the PowerShell Editor Services library exposed by a JSON message protocol.</Description>
-    <TargetFrameworks>net451;netstandard1.6</TargetFrameworks>
+    <TargetFrameworks>netstandard1.6;net451</TargetFrameworks>
     <AssemblyName>Microsoft.PowerShell.EditorServices.Host</AssemblyName>
   </PropertyGroup>
 

src/PowerShellEditorServices.Protocol/MessageProtocol/Channel/TcpSocketClientChannel.cs

@@ -61,4 +61,4 @@ public static async Task<TcpSocketClientChannel> Connect(
             return clientChannel;
         }
     }
-}
+}

src/PowerShellEditorServices.Protocol/MessageProtocol/Channel/TcpSocketServerChannel.cs

@@ -55,4 +55,4 @@ protected override void Shutdown()
             }
         }
     }
-}
+}

src/PowerShellEditorServices.Protocol/PowerShellEditorServices.Protocol.csproj

@@ -4,7 +4,7 @@
   <PropertyGroup>
     <AssemblyTitle>PowerShell Editor Services Host Protocol Library</AssemblyTitle>
     <Description>Provides message types and client/server APIs for the PowerShell Editor Services JSON protocol.</Description>
-    <TargetFrameworks>net451;netstandard1.6</TargetFrameworks>
+    <TargetFrameworks>netstandard1.6;net451;</TargetFrameworks>
     <AssemblyName>Microsoft.PowerShell.EditorServices.Protocol</AssemblyName>
   </PropertyGroup>
 

src/PowerShellEditorServices.Protocol/Server/DebugAdapter.cs

@@ -55,7 +55,7 @@ public DebugAdapter(
         }
 
         /// <summary>
-        /// Gets a boolean that indicates whether the current debug adapter is 
+        /// Gets a boolean that indicates whether the current debug adapter is
         /// using a temporary integrated console.
         /// </summary>
         public bool IsUsingTempIntegratedConsole { get; private set; }
@@ -506,7 +506,7 @@ protected async Task HandleSetBreakpointsRequest(
                 }
             }
             catch (Exception e) when (
-                e is FileNotFoundException || 
+                e is FileNotFoundException ||
                 e is DirectoryNotFoundException ||
                 e is IOException ||
                 e is NotSupportedException ||
@@ -653,7 +653,7 @@ protected async Task HandleSetExceptionBreakpointsRequest(
             RequestContext<object> requestContext)
         {
             // TODO: When support for exception breakpoints (unhandled and/or first chance)
-            //       are added to the PowerShell engine, wire up the VSCode exception 
+            //       are added to the PowerShell engine, wire up the VSCode exception
             //       breakpoints here using the pattern below to prevent bug regressions.
             //if (!this.noDebug)
             //{

src/PowerShellEditorServices.Protocol/Server/LanguageServer.cs

@@ -54,7 +54,7 @@ public IEditorOperations EditorOperations
         /// <param name="messageHandlers">An object that manages all of the message handlers</param>
         /// <param name="messageSender">The message sender</param>
         /// <param name="serverCompletedTask">A TaskCompletionSource<bool> that will be completed to stop the running process</param>
-        /// <param name="logger">The logger</param>
+        /// <param name="logger">The logger.</param>
         public LanguageServer(
             EditorSession editorSession,
             IMessageHandlers messageHandlers,

src/PowerShellEditorServices.Protocol/Server/LanguageServerSettings.cs

@@ -95,7 +95,7 @@ public void Update(
                     logger.Write(LogLevel.Verbose, $"Using Script Analyzer settings path - '{settingsPath ?? ""}'.");
                 }
                 catch (Exception ex) when (
-                    ex is NotSupportedException || 
+                    ex is NotSupportedException ||
                     ex is PathTooLongException ||
                     ex is SecurityException)
                 {

src/PowerShellEditorServices.VSCode/PowerShellEditorServices.VSCode.csproj

@@ -4,7 +4,7 @@
   <PropertyGroup>
     <AssemblyTitle>PowerShell Editor Services, Visual Studio Code Extensions</AssemblyTitle>
     <Description>Provides added functionality to PowerShell Editor Services for the Visual Studio Code editor.</Description>
-    <TargetFrameworks>net451;netstandard1.6</TargetFrameworks>
+    <TargetFrameworks>netstandard1.6;net451</TargetFrameworks>
     <AssemblyName>Microsoft.PowerShell.EditorServices.VSCode</AssemblyName>
   </PropertyGroup>
 

src/PowerShellEditorServices/Components/FeatureComponentBase.cs

@@ -34,9 +34,9 @@ public abstract class FeatureComponentBase<TProvider>
 
         /// <summary>
         /// Creates an instance of the FeatureComponentBase class with
-        /// the specified ILoggger.
+        /// the specified ILogger.
         /// </summary>
-        /// <param name="logger">The ILogger to use for this instance.</param>
+        /// <param name="logger">The ILogger implementation to use for this instance.</param>
         public FeatureComponentBase(ILogger logger)
         {
             this.Providers = new FeatureProviderCollection<TProvider>();

src/PowerShellEditorServices/Console/ChoicePromptHandler.cs

@@ -49,7 +49,7 @@ public abstract class ChoicePromptHandler : PromptHandler
         #endregion
 
         /// <summary>
-        /// 
+        ///
         /// </summary>
         /// <param name="logger">An ILogger implementation used for writing log messages.</param>
         public ChoicePromptHandler(ILogger logger) : base(logger)

src/PowerShellEditorServices/Console/InputPromptHandler.cs

@@ -33,7 +33,7 @@ public abstract class InputPromptHandler : PromptHandler
         #endregion
 
         /// <summary>
-        /// 
+        ///
         /// </summary>
         /// <param name="logger">An ILogger implementation used for writing log messages.</param>
         public InputPromptHandler(ILogger logger) : base(logger)

src/PowerShellEditorServices/Console/PromptHandler.cs

@@ -14,12 +14,12 @@ namespace Microsoft.PowerShell.EditorServices.Console
     public abstract class PromptHandler
     {
         /// <summary>
-        /// Gets the ILogger used for this instance.
+        /// Gets the ILogger implementation used for this instance.
         /// </summary>
         protected ILogger Logger { get; private set; }
 
         /// <summary>
-        /// 
+        ///
         /// </summary>
         /// <param name="logger">An ILogger implementation used for writing log messages.</param>
         public PromptHandler(ILogger logger)

src/PowerShellEditorServices/PowerShellEditorServices.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <AssemblyTitle>PowerShell Editor Services</AssemblyTitle>
     <Description>Provides common PowerShell editor capabilities as a .NET library.</Description>
-    <TargetFrameworks>net451;netstandard1.6</TargetFrameworks>
+    <TargetFrameworks>netstandard1.6;net451</TargetFrameworks>
     <AssemblyName>Microsoft.PowerShell.EditorServices</AssemblyName>
     <PackageTargetFallback Condition=" '$(TargetFramework)' == 'netstandard1.6' ">$(PackageTargetFallback);dnxcore50;portable-net45+win8</PackageTargetFallback>
   </PropertyGroup>
@@ -61,6 +61,10 @@
 
   <ItemGroup>
     <PackageReference Include="UnixConsoleEcho" Version="0.1.0" />
+    <PackageReference Include="Serilog" Version="2.7.1" />
+    <PackageReference Include="Serilog.Sinks.Console" Version="3.1.1" />
+    <PackageReference Include="Serilog.Sinks.File" Version="4.0.0" />
+    <PackageReference Include="Serilog.Sinks.Async" Version="1.2.0" />
   </ItemGroup>
 
   <PropertyGroup Condition=" '$(TargetFramework)' == 'netstandard1.6' ">

src/PowerShellEditorServices/Session/Capabilities/DscBreakpointCapability.cs

@@ -162,4 +162,4 @@ public static DscBreakpointCapability CheckForCapability(
             return capability;
         }
     }
-}
+}