Disable GCHeapCount for net6.0 (#1900)

Author: TheAngryByrd

release/package.json

@@ -551,16 +551,16 @@
         },
         "FSharp.fsac.gc.heapCount": {
           "default": 2,
-          "markdownDescription": "Limits the number of [heaps](https://learn.microsoft.com/en-us/dotnet/standard/garbage-collection/fundamentals#the-managed-heap) created by the garbage collector. Applies to server garbage collection only. See [Middle Ground between Server and Workstation GC](https://devblogs.microsoft.com/dotnet/middle-ground-between-server-and-workstation-gc/) for more details. This can allow FSAC to still benefit from Server garbage collection while still limiting the number of heaps. Requires restart.",
+          "markdownDescription": "Limits the number of [heaps](https://learn.microsoft.com/en-us/dotnet/standard/garbage-collection/fundamentals#the-managed-heap) created by the garbage collector. Applies to server garbage collection only. See [Middle Ground between Server and Workstation GC](https://devblogs.microsoft.com/dotnet/middle-ground-between-server-and-workstation-gc/) for more details. This can allow FSAC to still benefit from Server garbage collection while still limiting the number of heaps. [Only available on .NET 7 or higher](https://github.com/ionide/ionide-vscode-fsharp/issues/1899#issuecomment-1649009462). Requires restart.",
           "type": "integer",
           "required": [
             "FSharp.fsac.gc.server"
           ]
         },
-        "Fsharp.fsac.gc.noAffinitize": {
-          "default": true,
-          "type": "boolean",
-          "markdownDescription": "Specifies whether to [affinitize](https://learn.microsoft.com/en-us/dotnet/core/runtime-config/garbage-collector#affinitize) garbage collection threads with processors. To affinitize a GC thread means that it can only run on its specific CPU.. Applies to server garbage collection only. See [GCNoAffinitize](https://learn.microsoft.com/en-us/dotnet/framework/configure-apps/file-schema/runtime/gcnoaffinitize-element#remarks) for more details. Requires restart.",
+        "Fsharp.fsac.gc.noAffinitize" : {
+          "default" : true,
+          "type" : "boolean",
+          "markdownDescription": "Specifies whether to [affinitize](https://learn.microsoft.com/en-us/dotnet/core/runtime-config/garbage-collector#affinitize) garbage collection threads with processors. To affinitize a GC thread means that it can only run on its specific CPU.. Applies to server garbage collection only. See [GCNoAffinitize](https://learn.microsoft.com/en-us/dotnet/framework/configure-apps/file-schema/runtime/gcnoaffinitize-element#remarks) for more details. [Only available on .NET 7 or higher](https://github.com/ionide/ionide-vscode-fsharp/issues/1899#issuecomment-1649009462). Requires restart.",
           "required": [
             "FSharp.fsac.gc.server"
           ]
@@ -741,7 +741,7 @@
         },
         "FSharp.openTelemetry.enabled": {
           "default": false,
-          "description": "Enables OpenTelemetry exporter. See https://opentelemetry.io/docs/reference/specification/protocol/exporter/ for environment variables to configure for the exporter. Requires Restart.",
+          "markdownDescription": "Enables OpenTelemetry exporter. See [OpenTelemetry Protocol Exporter](https://opentelemetry.io/docs/reference/specification/protocol/exporter/) for environment variables to configure for the exporter. Requires Restart.",
           "type": "boolean"
         },
         "FSharp.pipelineHints.enabled": {
@@ -1748,4 +1748,4 @@
     "url": "https://github.com/ionide/ionide-vscode-fsharp.git"
   },
   "version": "7.8.4"
-}
+}

src/Core/LanguageService.fs

@@ -37,6 +37,10 @@ module Notifications =
     let testDetected = testDetectedEmitter.event
 
 module LanguageService =
+    open Fable.Import.LanguageServer.Client
+
+    let private logger =
+        ConsoleAndOutputChannelLogger(Some "LanguageService", Level.DEBUG, Some defaultOutputChannel, Some Level.DEBUG)
     module Types =
         open Fable.Import.VSCode.Vscode
         type PlainNotification = { content: string }
@@ -599,7 +603,37 @@ Consider:
         let clientOpts =
             let opts = createEmpty<Client.LanguageClientOptions>
 
+            let mutable initFails = 0
+
+            let initializationFailureHandler (error:  U3<ResponseError,Exception,obj option>) =
+                if initFails < 5 then
+                    logger.Error($"Initialization failed: %%", error)
+                    initFails <- initFails + 1
+                    true
+                else
+                    false
+
 
+            let restarts = new ResizeArray<_>()
+            let errorHandling = {
+
+                new ErrorHandler with
+                    member this.closed(): CloseAction =
+                        restarts.Add(1)
+                        if restarts |> Seq.length < 5 then
+                            CloseAction.Restart
+                        else
+
+                            logger.Error("Server closed")
+                            CloseAction.DoNotRestart
+                    member this.error(error: Exception, message: Message, count: float): ErrorAction =
+                        logger.Error($"Error from server: {error} {message} {count}")
+                        if count < 3.0 then
+                            ErrorAction.Continue
+                        else
+                            ErrorAction.Shutdown
+
+            }
 
             let initOpts = createObj [ "AutomaticWorkspaceInit" ==> false ]
 
@@ -611,7 +645,12 @@ Consider:
             // that's why we need to coerce it here.
             opts.documentSelector <- Some selector
             opts.synchronize <- Some synch
+            opts.errorHandler <- Some errorHandling
             opts.revealOutputChannelOn <- Some Client.RevealOutputChannelOn.Never
+            // Worth keeping around for debug purposes
+            // opts.traceOutputChannel <- Some defaultOutputChannel
+            // opts.outputChannel <- Some defaultOutputChannel
+            opts.initializationFailedHandler <- Some (!! initializationFailureHandler)
 
             opts.initializationOptions <- Some !^(Some initOpts)
             opts?markdown <- createObj [ "isTrusted" ==> true; "supportHtml" ==> true ]
@@ -810,7 +849,7 @@ Consider:
                               | pres when Seq.length pres > 0 -> "DOTNET_ROLL_FORWARD_TO_PRERELEASE", box 1
                               | _ -> () ]
 
-                        return args, envVariables, fsacPath
+                        return args, envVariables, fsacPath, sdkVersion
                 }
 
             /// Converts true to 1 and false to 0
@@ -819,18 +858,26 @@ Consider:
 
             let spawnNetCore dotnet : JS.Promise<Executable> =
                 promise {
-                    let! (fsacDotnetArgs, fsacEnvVars, fsacPath) = discoverDotnetArgs ()
-
+                    let! (fsacDotnetArgs, fsacEnvVars, fsacPath, sdkVersion) = discoverDotnetArgs ()
+                    // Only set DOTNET_GCHeapCount if we're on .NET 7 or higher
+                    // .NET 6 has some issues with this env var on linux
+                    // https://github.com/ionide/ionide-vscode-fsharp/issues/1899
+                    let versionSupportingEnvVars = (semver.parse (Some (U2.Case1 "7.0.0"))).Value
+                    let isNet7orHigher = semver.cmp(U2.Case2 sdkVersion, Operator.GTE, U2.Case2 versionSupportingEnvVars)
                     let fsacEnvVars =
                         [ yield! fsacEnvVars
-                          yield "DOTNET_GCHeapCount", box (gcHeapCount.ToString("X")) // Requires hexadecimal value https://learn.microsoft.com/en-us/dotnet/core/runtime-config/garbage-collector#heap-count
+                          if isNet7orHigher then
+                            // it doesn't really make sense to set GCNoAffinitize without setting GCHeapCount
+                            yield "DOTNET_GCNoAffinitize", box (boolToInt gcNoAffinitize) // https://learn.microsoft.com/en-us/dotnet/core/runtime-config/garbage-collector#affinitize
+                            yield "DOTNET_GCHeapCount", box (gcHeapCount.ToString("X")) // Requires hexadecimal value https://learn.microsoft.com/en-us/dotnet/core/runtime-config/garbage-collector#heap-count
+
                           yield "DOTNET_GCConserveMemory", box gcConserveMemory //https://learn.microsoft.com/en-us/dotnet/core/runtime-config/garbage-collector#conserve-memory
                           yield "DOTNET_GCServer", box (boolToInt gcServer) // https://learn.microsoft.com/en-us/dotnet/core/runtime-config/garbage-collector#workstation-vs-server
-                          yield "DOTNET_GCNoAffinitize", box (boolToInt gcNoAffinitize) // https://learn.microsoft.com/en-us/dotnet/core/runtime-config/garbage-collector#affinitize
+
                           if parallelReferenceResolution then
                               yield "FCS_ParallelReferenceResolution", box "true" ]
 
-                    printfn $"""FSAC (NETCORE): '%s{fsacPath}'"""
+                    logger.Debug $"""FSAC (NETCORE): '%s{fsacPath}'"""
 
                     let exeOpts = createEmpty<ExecutableOptions>
 
@@ -929,12 +976,17 @@ Consider:
 
     let start (c: ExtensionContext) =
         promise {
-            let! startOpts = getOptions c
-            let cl = createClient startOpts
-            registerCustomNotifications cl
-            let started = cl.start ()
-            c.subscriptions.Add(started |> box |> unbox)
-            return ()
+            try
+                let! startOpts = getOptions c
+                logger.Debug ("F# language server options: %%",startOpts)
+                let cl = createClient startOpts
+                registerCustomNotifications cl
+                let started = cl.start ()
+                c.subscriptions.Add(started |> box |> unbox)
+                return ()
+            with e ->
+                logger.Error("Error starting F# language server: %%", e)
+                return raise e
         }
 
     let stop () =

src/Core/Logging.fs

@@ -64,15 +64,15 @@ module Logging =
         let formattedMessage = Util.format (template, args)
 
         let formattedLogLine =
-            String.Format("[{0:HH:mm:ss} {1,-5}] {2}", DateTime.Now, string level, formattedMessage)
+            String.Format("[{0:HH:mm:ss} {1,-5}] [{2}] {3}", DateTime.Now, string level, source, formattedMessage)
 
         out.appendLine (formattedLogLine)
 
-    let private writeToFile level template args =
+    let private writeToFile level source template  args =
         let formattedMessage = Util.format (template, args)
 
         let formattedLogLine =
-            String.Format("[{0:HH:mm:ss} {1,-5}] {2}\n", DateTime.Now, string level, formattedMessage)
+            String.Format("[{0:HH:mm:ss} {1,-5}] [{2}] {3}\n", DateTime.Now, string level, source, formattedMessage)
         // Only store the 200 last logs
         if ionideLogsMemory.Length >= 200 then
             ionideLogsMemory <- ionideLogsMemory.Tail @ [ formattedLogLine ]
@@ -94,7 +94,7 @@ module Logging =
         if source = Some "IONIDE-FSAC" then
             try
                 if string args.[0] <> "parse" then
-                    writeToFile level template args
+                    writeToFile level source template  args
             with _ ->
                 () // Do nothing
 
@@ -165,3 +165,6 @@ module Logging =
         /// https://nodejs.org/api/util.html#util_util_format_format
         member this.ErrorOnFailed text (p: JS.Promise<_>) =
             p |> Promise.catchEnd (fun err -> this.Error(text + ": %O", err))
+
+
+    let defaultOutputChannel = window.createOutputChannel "Ionide"

src/fsharp.fs

@@ -10,6 +10,9 @@ open Ionide.VSCode.Helpers
 open Ionide.VSCode.FSharp
 open Node.ChildProcess
 
+let private logger =
+    ConsoleAndOutputChannelLogger(Some "Main", Level.DEBUG, Some defaultOutputChannel, Some Level.DEBUG)
+
 type Api =
     { ProjectLoadedEvent: Event<DTO.Project>
       BuildProject: DTO.Project -> JS.Promise<string>
@@ -27,15 +30,15 @@ let activate (context: ExtensionContext) : JS.Promise<Api> =
             try
                 activationFn ctx
             with ex ->
-                printfn $"Error while activating feature '{label}': {ex}"
+                logger.Error $"Error while activating feature '{label}': {ex}"
                 Unchecked.defaultof<_>
 
     LanguageService.start context
-    |> Promise.catch (fun e -> printfn $"Error activating FSAC: %A{e}") // prevent unhandled rejected promises
+    |> Promise.catch (fun e -> logger.Error $"Error activating FSAC: %A{e}") // prevent unhandled rejected promises
     |> Promise.onSuccess (fun _ ->
         let progressOpts = createEmpty<ProgressOptions>
         progressOpts.location <- U2.Case1 ProgressLocation.Window
-
+        logger.Debug "Activating features"
         window.withProgress (
             progressOpts,
             (fun p ctok ->
@@ -46,7 +49,7 @@ let activate (context: ExtensionContext) : JS.Promise<Api> =
                 p.report pm
 
                 Project.activate context
-                |> Promise.catch (fun e -> printfn $"Error loading projects: %A{e}")
+                |> Promise.catch (fun e -> logger.Error $"Error loading projects: %A{e}")
                 |> Promise.onSuccess (fun _ -> tryActivate "quickinfoproject" QuickInfoProject.activate context)
                 |> Promise.bind (fun _ ->
                     if showExplorer then
@@ -56,7 +59,7 @@ let activate (context: ExtensionContext) : JS.Promise<Api> =
                         Promise.lift None)
                 |> Promise.bind (fun _ -> tryActivate "analyzers" LanguageService.loadAnalyzers ())
                 |> Promise.catch (fun e ->
-                    printfn $"Error loading all projects: %A{e}"
+                    logger.Error $"Error loading all projects: %A{e}"
 
                     let pm =
                         {| message = Some "Error loading projects"
@@ -119,7 +122,7 @@ let activate (context: ExtensionContext) : JS.Promise<Api> =
           GetProjectLauncher = Project.getLauncher
           DebugProject = Debugger.debugProject })
     |> Promise.catch (fun e ->
-        printfn $"Error activating features: %A{e}"
+        logger.Error $"Error activating features: %A{e}"
         Unchecked.defaultof<_>)