Use Microsoft.Extensions.Logging instead of FsLogLib.fs (#254)

Author: razzmatazz

Directory.Packages.props

@@ -29,13 +29,12 @@
     <PackageVersion Include="Microsoft.CodeAnalysis.Workspaces.Common" Version="$(RoslynPackageVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.Workspaces.MSBuild" Version="$(RoslynPackageVersion)" />
     <PackageVersion Include="Microsoft.Extensions.Caching.Memory" Version="9.0.8" />
+    <PackageVersion Include="Microsoft.Extensions.Logging" Version="9.0.8" />
+    <PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="9.0.8" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
     <PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageVersion Include="NUnit" Version="3.14.0" />
     <PackageVersion Include="NUnit3TestAdapter" Version="4.6.0" />
     <PackageVersion Include="System.Collections.Immutable" Version="9.0.0" />
-    <PackageVersion Include="Serilog" Version="3.1.1" />
-    <PackageVersion Include="Serilog.Sinks.Console" Version="5.0.1" />
-    <PackageVersion Include="Serilog.Sinks.Async" Version="1.5.0" />
   </ItemGroup>
 </Project>

src/CSharpLanguageServer/CSharpLanguageServer.fsproj

@@ -83,6 +83,8 @@
     <PackageReference Include="ICSharpCode.Decompiler" />
     <PackageReference Include="Ionide.LanguageServerProtocol" />
     <PackageReference Include="Microsoft.Extensions.Caching.Memory" />
+    <PackageReference Include="Microsoft.Extensions.Logging" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Console" />
     <PackageReference Include="Newtonsoft.Json" />
     <PackageReference Include="Microsoft.Build.Locator" />
     <PackageReference Include="Microsoft.Build" ExcludeAssets="runtime" />
@@ -99,8 +101,5 @@
     <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" />
     <PackageReference Include="Microsoft.CodeAnalysis.Features" />
     <PackageReference Include="Microsoft.CodeAnalysis.Workspaces.MSBuild" />
-    <PackageReference Include="Serilog" />
-    <PackageReference Include="Serilog.Sinks.Console" />
-    <PackageReference Include="Serilog.Sinks.Async" />
   </ItemGroup>
 </Project>

src/CSharpLanguageServer/Handlers/CodeAction.fs

@@ -15,19 +15,23 @@ open Microsoft.CodeAnalysis.Text
 open Ionide.LanguageServerProtocol.Server
 open Ionide.LanguageServerProtocol.Types
 open Ionide.LanguageServerProtocol.JsonRpc
+open Microsoft.Extensions.Logging
 
 open CSharpLanguageServer.Logging
 open CSharpLanguageServer.Conversions
 open CSharpLanguageServer.Types
 open CSharpLanguageServer.State
+open CSharpLanguageServer.Util
+
 
 type CSharpCodeActionResolutionData =
     { TextDocumentUri: string
       Range: Range }
 
+
 [<RequireQualifiedAccess>]
 module CodeAction =
-    let private logger = LogProvider.getLoggerByName "CodeAction"
+    let private logger = Logging.getLoggerByName "CodeAction"
 
     let private instantiateRoslynProviders<'ProviderType> (isValidProvider: Type -> bool) =
         let assemblies =
@@ -81,11 +85,10 @@ module CodeAction =
             try
                 do! refactoringProvider.ComputeRefactoringsAsync(codeActionContext) |> Async.AwaitTask
             with ex ->
-                logger.error (
-                    Log.setMessage "cannot compute refactorings for {provider}"
-                    >> Log.addContext "provider" (string refactoringProvider)
-                    >> Log.addException ex
-                )
+                logger.LogError(
+                    ex,
+                    "cannot compute refactorings for {provider}",
+                    refactoringProvider)
 
         // register code fixes
         let! semanticModel = doc.GetSemanticModelAsync(ct) |> Async.AwaitTask
@@ -127,10 +130,7 @@ module CodeAction =
                     try
                         do! codeFixProvider.RegisterCodeFixesAsync(codeFixContext) |> Async.AwaitTask
                     with ex ->
-                        logger.error (
-                            Log.setMessage "error in RegisterCodeFixesAsync()"
-                            >> Log.addException ex
-                        )
+                        logger.LogError(ex, "error in RegisterCodeFixesAsync()")
 
         let unwrapRoslynCodeAction (ca: Microsoft.CodeAnalysis.CodeActions.CodeAction) =
             let nestedCAProp =
@@ -156,10 +156,7 @@ module CodeAction =
             let! value = op ()
             return Some value
         with ex ->
-            logger.warn (
-                Log.setMessage "Error in asyncMaybeOnException"
-                >> Log.addException ex
-            )
+            logger.LogWarning(ex, "Error in asyncMaybeOnException")
             return None
     }
 
@@ -427,10 +424,7 @@ module CodeAction =
                     let! resolvedCA = toResolvedLspCodeAction ca
 
                     if resolvedCA.IsNone then
-                        logger.error (
-                            Log.setMessage "handleCodeActionResolve: could not resolve {action} - null"
-                            >> Log.addContext "action" (string ca)
-                        )
+                        logger.LogError("handleCodeActionResolve: could not resolve {action} - null", ca)
 
                     return resolvedCA.Value
                   }

src/CSharpLanguageServer/Handlers/Completion.fs

@@ -16,7 +16,7 @@ open CSharpLanguageServer.Logging
 
 [<RequireQualifiedAccess>]
 module Completion =
-    let private _logger = LogProvider.getLoggerByName "Completion"
+    let private _logger = Logging.getLoggerByName "Completion"
 
     let private completionItemMemoryCache = new MemoryCache(new MemoryCacheOptions())
 

src/CSharpLanguageServer/Handlers/Initialization.fs

@@ -9,6 +9,7 @@ open Ionide.LanguageServerProtocol
 open Ionide.LanguageServerProtocol.Types
 open Ionide.LanguageServerProtocol.Server
 open Ionide.LanguageServerProtocol.JsonRpc
+open Microsoft.Extensions.Logging
 
 open CSharpLanguageServer.State
 open CSharpLanguageServer.State.ServerState
@@ -17,7 +18,7 @@ open CSharpLanguageServer.Logging
 
 [<RequireQualifiedAccess>]
 module Initialization =
-    let private logger = LogProvider.getLoggerByName "Initialization"
+    let private logger = Logging.getLoggerByName "Initialization"
 
     let handleInitialize (lspClient: ILspClient)
                          (setupTimer: unit -> unit)
@@ -32,19 +33,14 @@ module Initialization =
 
         let serverName = "csharp-ls"
         let serverVersion = Assembly.GetExecutingAssembly().GetName().Version |> string
-        logger.info (
-            Log.setMessage "initializing, {name} version {version}"
-            >> Log.addContext "name" serverName
-            >> Log.addContext "version" serverVersion
-        )
+        logger.LogInformation("initializing, {name} version {version}", serverName, serverVersion)
 
         do! windowShowMessage(
             sprintf "csharp-ls: initializing, version %s" serverVersion)
 
-        logger.info (
-            Log.setMessage "{name} is released under MIT license and is not affiliated with Microsoft Corp.; see https://github.com/razzmatazz/csharp-language-server"
-            >> Log.addContext "name" serverName
-        )
+        logger.LogInformation(
+            "{serverName} is released under MIT license and is not affiliated with Microsoft Corp.; see https://github.com/razzmatazz/csharp-language-server",
+            serverName)
 
         do! windowShowMessage(
             sprintf "csharp-ls: %s is released under MIT license and is not affiliated with Microsoft Corp.; see https://github.com/razzmatazz/csharp-language-server" serverName)
@@ -65,19 +61,15 @@ module Initialization =
 
         let vsInstance = vsInstanceList |> Seq.head
 
-        logger.info(
-            Log.setMessage "MSBuildLocator: will register \"{vsInstanceName}\", Version={vsInstanceVersion} as default instance"
-            >> Log.addContext "vsInstanceName" vsInstance.Name
-            >> Log.addContext "vsInstanceVersion" (string vsInstance.Version)
-        )
+        logger.LogInformation(
+            "MSBuildLocator: will register \"{vsInstanceName}\", Version={vsInstanceVersion} as default instance",
+            vsInstance.Name,
+            (string vsInstance.Version))
 
         MSBuildLocator.RegisterInstance(vsInstance)
 
 (*
-        logger.trace (
-            Log.setMessage "handleInitialize: p.Capabilities={caps}"
-            >> Log.addContext "caps" (serialize p.Capabilities)
-        )
+        logger.LogTrace("handleInitialize: p.Capabilities={caps}", serialize p.Capabilities))
 *)
         context.Emit(ClientCapabilityChange p.Capabilities)
 
@@ -111,9 +103,7 @@ module Initialization =
                           (_p: unit)
             : Async<LspResult<unit>> =
         async {
-            logger.trace (
-                Log.setMessage "handleInitialized: \"initialized\" notification received from client"
-            )
+            logger.LogTrace("handleInitialized: \"initialized\" notification received from client")
 
             let registrationParams = { Registrations = getRegistrations context.ClientCapabilities |> List.toArray }
 
@@ -122,16 +112,10 @@ module Initialization =
                 match! lspClient.ClientRegisterCapability registrationParams with
                 | Ok _ -> ()
                 | Error error ->
-                    logger.warn(
-                        Log.setMessage "handleInitialized: didChangeWatchedFiles registration has failed with {error}"
-                        >> Log.addContext "error" (string error)
-                    )
+                    logger.LogWarning("handleInitialized: didChangeWatchedFiles registration has failed with {error}", error)
             with
             | ex ->
-                logger.warn(
-                    Log.setMessage "handleInitialized: didChangeWatchedFiles registration has failed with {error}"
-                    >> Log.addContext "error" (string ex)
-                )
+                logger.LogWarning("handleInitialized: didChangeWatchedFiles registration has failed with {error}", string ex)
 
             //
             // retrieve csharp settings
@@ -169,18 +153,17 @@ module Initialization =
                 | _ -> ()
             with
             | ex ->
-                logger.warn(
-                    Log.setMessage "handleInitialized: could not retrieve `csharp` workspace configuration section: {error}"
-                    >> Log.addContext "error" (ex |> string)
+                logger.LogWarning(
+                    "handleInitialized: could not retrieve `csharp` workspace configuration section: {error}",
+                    ex |> string
                 )
 
             //
             // start loading the solution
             //
             stateActor.Post(SolutionReloadRequest (TimeSpan.FromMilliseconds(100)))
 
-            logger.trace(
-                Log.setMessage "handleInitialized: OK")
+            logger.LogTrace("handleInitialized: OK")
 
             return Ok()
         }

src/CSharpLanguageServer/Handlers/Rename.fs

@@ -10,6 +10,7 @@ open Microsoft.CodeAnalysis.Rename
 open Ionide.LanguageServerProtocol.Server
 open Ionide.LanguageServerProtocol.Types
 open Ionide.LanguageServerProtocol.JsonRpc
+open Microsoft.Extensions.Logging
 
 open CSharpLanguageServer.State
 open CSharpLanguageServer.Logging
@@ -19,7 +20,7 @@ open CSharpLanguageServer.Util
 
 [<RequireQualifiedAccess>]
 module Rename =
-    let private logger = LogProvider.getLoggerByName "Rename"
+    let private logger = Logging.getLoggerByName "Rename"
 
     let private lspDocChangesFromSolutionDiff
         (ct: CancellationToken)
@@ -139,9 +140,9 @@ module Rename =
                 | :? ForEachStatementSyntax as forEachSyn              -> forEachSyn.Identifier.Span     |> Some
                 | :? LocalFunctionStatementSyntax as localFunStSyn     -> localFunStSyn.Identifier.Span  |> Some
                 | node ->
-                    logger.debug (
-                        Log.setMessage "textDocument/prepareRename: unhandled Type={type}"
-                        >> Log.addContext "type" (node.GetType().Name)
+                    logger.LogDebug(
+                        "textDocument/prepareRename: unhandled Type={type}",
+                        (node.GetType().Name)
                     )
                     None
 

src/CSharpLanguageServer/Handlers/TextDocumentSync.fs

@@ -17,7 +17,7 @@ open CSharpLanguageServer.Logging
 
 [<RequireQualifiedAccess>]
 module TextDocumentSync =
-    let private logger = LogProvider.getLoggerByName "TextDocumentSync"
+    let private logger = Logging.getLoggerByName "TextDocumentSync"
 
     let private applyLspContentChangesOnRoslynSourceText
             (changes: TextDocumentContentChangeEvent[])

src/CSharpLanguageServer/Handlers/Workspace.fs

@@ -17,7 +17,7 @@ open CSharpLanguageServer.Types
 
 [<RequireQualifiedAccess>]
 module Workspace =
-    let private logger = LogProvider.getLoggerByName "Workspace"
+    let private logger = Logging.getLoggerByName "Workspace"
 
     let dynamicRegistration (clientCapabilities: ClientCapabilities) =
         clientCapabilities.Workspace