Main to nightly (#1284)

* Shift multiline paren contents less aggressively (#1242) * Shift multiline paren contents less aggressively * Make it actually work * Disambiguate AsSpan overload * Add some code fixes for type mismatch. (#1250) * Migrate FAKE to Fun.Build (#1256) * Migrate FAKE to Fun.Build * Add default Build pipeline. * Purge it with fire (#1255) * Bump analyzers and Fantomas (#1257) * Add empty, disabled tests for go-to-def on C# symbol scenario * fix unicode characters in F# compiler diagnostic messages (#1265) * fix unicode chars in F# compiler diagnostic messages * fix typo in ShadowedTimeouts focused tests * fixup! fix unicode chars in F# compiler diagnostic messages * remove focused tests... * remove debug prints Co-authored-by: Jimmy Byrd <jimmybyrd@gmail.com> --------- Co-authored-by: Jimmy Byrd <jimmybyrd@gmail.com> * - remove an ignored call to protocolRangeToRange (#1266) - remove an ignored instance of StreamJsonRpcTracingStrategy * Place XML doc lines before any attribute lists (#1267) * Don't generate params for explicit getters/setters as they are flagged invalid by the compiler (#1268) * bump ProjInfo to the next version to get support for loading broken projects and loading traversal projects (#1270) * only allow one GetProjectOptionsFromScript at a time (#1275) ionide/ionide-vscode-fsharp#2005 * changelog for v0.72.0 * changelog for v0.72.1 * Use actualRootPath instead of p.RootPath when peeking workspaces. (#1278) This fix the issue where rootUri was ignored when using AutomaticWorkspaceInit. * changelog for v0.72.2 * Add support for Cancel a Work Done Progress (#1274) * Add support for Cancel WorkDoneProgress * Fix up saving cancellation * package the tool for .NET 8 as well (#1281) * update changelogs * Adds basic OTel Metric support to fsautocomplete (#1283) --------- Co-authored-by: Brian Rourke Boll <brianrourkeboll@users.noreply.github.com> Co-authored-by: Florian Verdonck <florian.verdonck@outlook.com> Co-authored-by: Krzysztof Cieślak <krzysztof_cieslak@windowslive.com> Co-authored-by: MrLuje <ogmniluje@gmail.com> Co-authored-by: dawe <dawedawe@posteo.de> Co-authored-by: Chet Husk <baronfel@users.noreply.github.com> Co-authored-by: oupson <31827294+oupson@users.noreply.github.com> Co-authored-by: Chet Husk <chusk3@gmail.com>
ionide · May 6, 2024 · 08b8711 · 08b8711
1 parent 8422032
commit 08b8711
Show file tree

Hide file tree

Showing 16 changed files with 254 additions and 82 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -16,6 +16,7 @@ jobs:
         uses: actions/setup-dotnet@v2
         with:
           dotnet-version: |
+           8.0.x
            7.0.x
            6.0.x
           include-prerelease: true
@@ -29,7 +30,7 @@ jobs:
       - name: Run Build
         run: dotnet pack -c Release -o ./bin
         env:
-          BuildNet7: true
+          BuildNet8: true
 
       - name: Get Changelog Entry
         id: changelog_reader

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
 # Changelog
 
+## [0.72.3] - 2024-05-05
+
+### Added
+
+* [FSAC publishes a net8.0 TFM version of the tool as well, to prevent issues when running across TargetFrameworks](https://github.com/ionide/FsAutoComplete/pull/1281)
+* [Long-running actions like typechecking specific files can now be cancelled by users](https://github.com/ionide/FsAutoComplete/pull/1274) (thanks @TheAngryByrd)
+
+### Fixed
+
+* [Fix restoring multiple script file NuGet dependencies in parallel](https://github.com/ionide/FsAutoComplete/pull/1275) (thanks @TheAngryByrd)
+
 ## [0.72.2] - 2024-04-30
 
 ### Fixed

diff --git a/Directory.Build.props b/Directory.Build.props
@@ -10,7 +10,7 @@
     <NoWarn>$(NoWarn);57</NoWarn> <!-- Enable experimental compiler features -->
     <WarnOn Condition="'$(Configuration)' != 'Debug'">$(WarnOn);1182</WarnOn> <!-- Unused
     variables,https://learn.microsoft.com/en-us/dotnet/fsharp/language-reference/compiler-options#opt-in-warnings -->
-
+    <NoWarn>$(NoWarn);FS0044</NoWarn>       <!-- Ignore deprecations -->
     <WarnOn>$(WarnOn);3390</WarnOn><!-- Malformed XML doc comments -->
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <ChangelogFile>$(MSBuildThisFileDirectory)CHANGELOG.md</ChangelogFile>

diff --git a/paket.dependencies b/paket.dependencies
@@ -52,10 +52,11 @@ nuget Expecto.Diff
 nuget YoloDev.Expecto.TestSdk
 nuget AltCover
 nuget GitHubActionsTestLogger
-nuget Ionide.LanguageServerProtocol >= 0.4.20
+nuget Ionide.LanguageServerProtocol >= 0.4.23
 nuget Microsoft.Extensions.Caching.Memory
 nuget OpenTelemetry.Api >= 1.3.2
 nuget OpenTelemetry.Exporter.OpenTelemetryProtocol >= 1.3.2 # 1.4 bumps to 7.0 versions of System.Diagnostics libs, so can't use it
+nuget OpenTelemetry.Instrumentation.Runtime
 nuget LinkDotNet.StringBuilder 1.18.0
 nuget CommunityToolkit.HighPerformance
 nuget System.Security.Cryptography.Pkcs 6.0.4

diff --git a/paket.lock b/paket.lock
@@ -119,7 +119,7 @@ NUGET
       System.Reflection.Metadata (>= 5.0)
     Ionide.Analyzers (0.10)
     Ionide.KeepAChangelog.Tasks (0.1.8) - copy_local: true
-    Ionide.LanguageServerProtocol (0.4.20)
+    Ionide.LanguageServerProtocol (0.4.23)
       FSharp.Core (>= 6.0)
       Newtonsoft.Json (>= 13.0.1)
       StreamJsonRpc (>= 2.16.36)
@@ -357,6 +357,8 @@ NUGET
       Grpc (>= 2.44 < 3.0) - restriction: || (&& (== net6.0) (>= net462)) (&& (== net6.0) (< netstandard2.1)) (&& (== net7.0) (>= net462)) (&& (== net7.0) (< netstandard2.1)) (&& (== net8.0) (>= net462)) (&& (== net8.0) (< netstandard2.1)) (== netstandard2.0) (&& (== netstandard2.1) (>= net462))
       Grpc.Net.Client (>= 2.43 < 3.0) - restriction: || (== net6.0) (== net7.0) (== net8.0) (&& (== netstandard2.0) (>= netstandard2.1)) (== netstandard2.1)
       OpenTelemetry (>= 1.3.2)
+    OpenTelemetry.Instrumentation.Runtime (1.0)
+      OpenTelemetry.Api (>= 1.3 < 2.0)
     Perfolizer (0.2.1)
       System.Memory (>= 4.5.3)
     runtime.debian.8-x64.runtime.native.System.Security.Cryptography.OpenSsl (4.3.2)

diff --git a/src/FsAutoComplete.Core/CompilerServiceInterface.fs b/src/FsAutoComplete.Core/CompilerServiceInterface.fs
@@ -416,7 +416,6 @@ type FSharpCompilerServiceChecker(hasAnalyzers, typecheckCacheSize, parallelRefe
     }
 
 
-
   member __.ScriptTypecheckRequirementsChanged =
     scriptTypecheckRequirementsChanged.Publish
 

diff --git a/src/FsAutoComplete/LspServers/AdaptiveFSharpLspServer.fs b/src/FsAutoComplete/LspServers/AdaptiveFSharpLspServer.fs
@@ -578,8 +578,8 @@ type AdaptiveFSharpLspServer
                   // Otherwise we'll fail here and our retry logic will come into place
                   do!
                     match p.Context with
-                    | Some({ triggerKind = CompletionTriggerKind.TriggerCharacter } as context) ->
-                      volatileFile.Source.TryGetChar pos = context.triggerCharacter
+                    | Some({ TriggerKind = CompletionTriggerKind.TriggerCharacter } as context) ->
+                      volatileFile.Source.TryGetChar pos = context.TriggerCharacter
                     | _ -> true
                     |> Result.requireTrue $"TextDocumentCompletion was sent before TextDocumentDidChange"
 
@@ -2979,25 +2979,27 @@ type AdaptiveFSharpLspServer
 
     override x.Dispose() = disposables.Dispose()
 
-    member this.WorkDoneProgressCancel(token: ProgressToken) : Async<unit> =
+    member this.WorkDoneProgressCancel(param: WorkDoneProgressCancelParams) : Async<unit> =
       async {
 
-        let tags = [ "ProgressToken", box token ]
+        let tags = [ "WorkDoneProgressCancelParams", box param ]
         use trace = fsacActivitySource.StartActivityForType(thisType, tags = tags)
 
         try
           logger.info (
             Log.setMessage "WorkDoneProgressCancel Request: {params}"
-            >> Log.addContextDestructured "params" token
+            >> Log.addContextDestructured "params" param.token
           )
 
+          state.CancelServerProgress param.token
+
         with e ->
           trace |> Tracing.recordException e
 
           logException
             e
             (Log.setMessage "WorkDoneProgressCancel Request Errored {p}"
-             >> Log.addContextDestructured "token" token)
+             >> Log.addContextDestructured "token" param.token)
 
         return ()
       }

diff --git a/src/FsAutoComplete/LspServers/AdaptiveServerState.fs b/src/FsAutoComplete/LspServers/AdaptiveServerState.fs
@@ -3,6 +3,7 @@ namespace FsAutoComplete.Lsp
 open System
 open System.IO
 open System.Threading
+open System.Collections.Generic
 open FsAutoComplete
 open FsAutoComplete.CodeFix
 open FsAutoComplete.Logging
@@ -39,6 +40,68 @@ open FSharp.Compiler.Syntax
 open FsAutoComplete.ProjectWorkspace
 
 
+/// <summary>Handle tracking in-flight ServerProgressReport and allow cancellation of actions if a client decides to.</summary>
+type ServerProgressLookup() =
+  // This is a dictionary of all the progress reports that are currently active
+  // Use a WeakReference to avoid memory leaks
+  let progressTable = Dictionary<ProgressToken, WeakReference<ServerProgressReport>>()
+
+  // Although it's small data, we don't want to keep it around forever
+  let timer =
+    new Timers.Timer((TimeSpan.FromMinutes 1.).TotalMilliseconds, AutoReset = true)
+
+  let timerSub =
+    timer.Elapsed.Subscribe(fun _ ->
+      lock progressTable (fun () ->
+        let derefs =
+          progressTable
+          |> Seq.filter (fun (KeyValue(_, reporters)) ->
+            match reporters.TryGetTarget() with
+            | (true, _) -> false
+            | _ -> true)
+          |> Seq.toList
+
+        for (KeyValue(tokens, _)) in derefs do
+          progressTable.Remove(tokens) |> ignore<bool>))
+
+
+  /// <summary>Creates a ServerProgressReport and keeps track of it.</summary>
+  /// <param name="lspClient">The FSharpLspClient to communicate to the client with.</param>
+  /// <param name="token">Optional token. It will be generated otherwise.</param>
+  /// <param name="cancellable">Informs that the ServerProgressReport is cancellable to the client.</param>
+  /// <returns></returns>
+  member x.CreateProgressReport(lspClient: FSharpLspClient, ?token: ProgressToken, ?cancellable: bool) =
+    let progress =
+      new ServerProgressReport(lspClient, ?token = token, ?cancellableDefault = cancellable)
+
+    lock progressTable (fun () ->
+      progressTable.Add(progress.ProgressToken, new WeakReference<ServerProgressReport>(progress)))
+
+    progress
+
+
+  /// <summary>Signal a ServerProgressReport to Cancel it's CancellationTokenSource.</summary>
+  /// <param name="token">The ProgressToken used to identify the ServerProgressReport</param>
+  ///
+  /// <remarks>
+  /// See <see href="https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#window_workDoneProgress_cancel">LSP Spec on WorkDoneProgress Cancel</see> for more information.
+  /// </remarks>
+  member x.Cancel(token: ProgressToken) =
+    lock progressTable (fun () ->
+      match progressTable.TryGetValue(token) with
+      | true, weakRef ->
+        match weakRef.TryGetTarget() with
+        | true, progress ->
+          progress.Cancel()
+          progressTable.Remove(token) |> ignore<bool>
+        | _ -> ()
+      | _ -> ())
+
+  interface IDisposable with
+    member x.Dispose() =
+      timerSub.Dispose()
+      timer.Dispose()
+
 [<RequireQualifiedAccess>]
 type WorkspaceChosen =
   | Projs of HashSet<string<LocalPath>>
@@ -101,6 +164,8 @@ type AdaptiveState
   let logger = LogProvider.getLoggerFor<AdaptiveState> ()
   let thisType = typeof<AdaptiveState>
   let disposables = new Disposables.CompositeDisposable()
+  let progressLookup = new ServerProgressLookup()
+  do disposables.Add progressLookup
 
 
   let projectSelector = cval<IFindProject> (FindFirstProject())
@@ -324,10 +389,12 @@ type AdaptiveState
     let checkUnusedOpens =
       asyncEx {
         try
-          use progress = new ServerProgressReport(lspClient)
+          use progress = progressLookup.CreateProgressReport(lspClient, cancellable = true)
           do! progress.Begin($"Checking unused opens {fileName}...", message = filePathUntag)
 
-          let! unused = UnusedOpens.getUnusedOpens (tyRes.GetCheckResults, getSourceLine)
+          let! unused =
+            UnusedOpens.getUnusedOpens (tyRes.GetCheckResults, getSourceLine)
+            |> Async.withCancellation progress.CancellationToken
 
           let! ct = Async.CancellationToken
           notifications.Trigger(NotificationEvent.UnusedOpens(filePath, (unused |> List.toArray), file.Version), ct)
@@ -338,11 +405,15 @@ type AdaptiveState
     let checkUnusedDeclarations =
       asyncEx {
         try
-          use progress = new ServerProgressReport(lspClient)
+          use progress = progressLookup.CreateProgressReport(lspClient, cancellable = true)
           do! progress.Begin($"Checking unused declarations {fileName}...", message = filePathUntag)
 
           let isScript = Utils.isAScript (filePathUntag)
-          let! unused = UnusedDeclarations.getUnusedDeclarations (tyRes.GetCheckResults, isScript)
+
+          let! unused =
+            UnusedDeclarations.getUnusedDeclarations (tyRes.GetCheckResults, isScript)
+            |> Async.withCancellation progress.CancellationToken
+
           let unused = unused |> Seq.toArray
 
           let! ct = Async.CancellationToken
@@ -354,10 +425,13 @@ type AdaptiveState
     let checkSimplifiedNames =
       asyncEx {
         try
-          use progress = new ServerProgressReport(lspClient)
+          use progress = progressLookup.CreateProgressReport(lspClient, cancellable = true)
           do! progress.Begin($"Checking simplifying of names {fileName}...", message = filePathUntag)
 
-          let! simplified = SimplifyNames.getSimplifiableNames (tyRes.GetCheckResults, getSourceLine)
+          let! simplified =
+            SimplifyNames.getSimplifiableNames (tyRes.GetCheckResults, getSourceLine)
+            |> Async.withCancellation progress.CancellationToken
+
           let simplified = Array.ofSeq simplified
           let! ct = Async.CancellationToken
           notifications.Trigger(NotificationEvent.SimplifyNames(filePath, simplified, file.Version), ct)
@@ -368,7 +442,7 @@ type AdaptiveState
     let checkUnnecessaryParentheses =
       asyncEx {
         try
-          use progress = new ServerProgressReport(lspClient)
+          use progress = progressLookup.CreateProgressReport(lspClient)
           do! progress.Begin($"Checking for unnecessary parentheses {fileName}...", message = filePathUntag)
 
           let unnecessaryParentheses =
@@ -1520,9 +1594,9 @@ type AdaptiveState
         >> Log.addContextDestructured "date" (file.LastTouched)
       )
 
-      let! ct = Async.CancellationToken
 
-      use progressReport = new ServerProgressReport(lspClient)
+      use progressReport =
+        progressLookup.CreateProgressReport(lspClient, cancellable = true)
 
       let simpleName = Path.GetFileName(UMX.untag file.Source.FileName)
       do! progressReport.Begin($"Typechecking {simpleName}", message = $"{file.Source.FileName}")
@@ -1542,6 +1616,8 @@ type AdaptiveState
           )
 
 
+      let! ct = Async.CancellationToken
+
       notifications.Trigger(NotificationEvent.FileParsed(file.Source.FileName), ct)
 
       match result with
@@ -2219,8 +2295,6 @@ type AdaptiveState
 
       let! projs = getProjectOptionsForFile sourceFilePath |> AsyncAVal.forceAsync
 
-      let rootToken = sourceFilePath |> getOpenFileTokenOrDefault
-
       let projs =
         projs
         |> Result.toOption
@@ -2236,7 +2310,8 @@ type AdaptiveState
 
       let mutable checksCompleted = 0
 
-      use progressReporter = new ServerProgressReport(lspClient)
+      use progressReporter =
+        progressLookup.CreateProgressReport(lspClient, cancellable = true)
 
       let percentage numerator denominator =
         if denominator = 0 then
@@ -2254,6 +2329,7 @@ type AdaptiveState
             && file.Contains "AssemblyAttributes.fs" |> not)
 
         let checksToPerformLength = innerChecks.Length
+        let rootToken = sourceFilePath |> getOpenFileTokenOrDefault
 
         innerChecks
         |> Array.map (fun (snap, file) ->
@@ -2262,14 +2338,17 @@ type AdaptiveState
             use joinedToken =
               if file = sourceFilePath then
                 // dont reset the token for the incoming file as it would cancel the whole operation
-                CancellationTokenSource.CreateLinkedTokenSource(rootToken)
+                CancellationTokenSource.CreateLinkedTokenSource(rootToken, progressReporter.CancellationToken)
               else
                 // only cancel other files
                 // If we have multiple saves from separate root files we want only one to be running
-                let token = resetCancellationToken file None // Dont dispose, we're a renter not an owner
+                let fileToken = resetCancellationToken file None
                 // and join with the root token as well since we want to cancel the whole operation if the root files changes
-                CancellationTokenSource.CreateLinkedTokenSource(rootToken, token)
-            // CancellationTokenSource.CreateLinkedTokenSource(rootToken)
+                CancellationTokenSource.CreateLinkedTokenSource(
+                  rootToken,
+                  fileToken,
+                  progressReporter.CancellationToken
+                )
 
             try
               let! _ =
@@ -2440,6 +2519,9 @@ type AdaptiveState
 
   member x.GlyphToSymbolKind = glyphToSymbolKind |> AVal.force
 
+  member x.CancelServerProgress(progressToken: ProgressToken) = progressLookup.Cancel progressToken
+
+
   interface IDisposable with
     member this.Dispose() =
 

diff --git a/src/FsAutoComplete/LspServers/AdaptiveServerState.fsi b/src/FsAutoComplete/LspServers/AdaptiveServerState.fsi
@@ -119,4 +119,12 @@ type AdaptiveState =
   member GetDeclarations: filename: string<LocalPath> -> Async<Result<NavigationTopLevelDeclaration array, string>>
   member GetAllDeclarations: unit -> Async<(string<LocalPath> * NavigationTopLevelDeclaration array) array>
   member GlyphToSymbolKind: (FSharpGlyph -> SymbolKind option)
+  /// <summary>
+  /// Signals the server to cancel an operation that is associated with the given progress token.
+  /// </summary>
+  ///
+  /// <remarks>
+  /// See <see href="https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#window_workDoneProgress_cancel">LSP Spec on WorkDoneProgress Cancel</see> for more information.
+  /// </remarks>
+  member CancelServerProgress: progressToken: ProgressToken -> unit
   interface IDisposable
diff --git a/src/FsAutoComplete/LspServers/Common.fs b/src/FsAutoComplete/LspServers/Common.fs
@@ -159,7 +159,7 @@ module Async =
       let! ct2 = Async.CancellationToken
       use cts = CancellationTokenSource.CreateLinkedTokenSource(ct, ct2)
       let tcs = new TaskCompletionSource<'a>()
-      use _reg = cts.Token.Register(fun () -> tcs.TrySetCanceled() |> ignore)
+      use _reg = cts.Token.Register(fun () -> tcs.TrySetCanceled(cts.Token) |> ignore)
 
       let a =
         async {