Skip to content

Commit

Permalink
Use background CancellableTask in VS instead of async & asyncMaybe (#…
Browse files Browse the repository at this point in the history 
…15187)

* wip

* iteration

* iteration: quickinfo, help context

* fantomas

* todo

* moved tasks to editor project, fixed comment colouring bug

* fantomas

* Fantomas + PR feedback

* Update vsintegration/src/FSharp.Editor/Hints/HintService.fs

Co-authored-by: Andrii Chebukin <[email protected]>

* Revert "Update vsintegration/src/FSharp.Editor/Hints/HintService.fs"

This reverts commit bf51b31.

---------

Co-authored-by: Andrii Chebukin <[email protected]>
  • Loading branch information
@vzarytovskii @xperiandri
vzarytovskii and xperiandri authored May 25, 2023
1 parent 3cdf2d2 commit 271790c
Show file tree
Hide file tree
Showing 55 changed files with 2,028 additions and 527 deletions.
2 changes: 1 addition & 1 deletion .fantomasignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ artifacts/
# For some reason, it tries to format files from remotes (Processing .\.git\refs\remotes\<remote>\FSComp.fsi)
.git/


# Explicitly unformatted implementation
src/Compiler/Checking/AccessibilityLogic.fs
src/Compiler/Checking/AttributeChecking.fs
Expand Down Expand Up @@ -98,6 +97,7 @@ src/Compiler/Service/IncrementalBuild.fs
src/Compiler/Service/ServiceAssemblyContent.fs
src/Compiler/Service/ServiceDeclarationLists.fs
src/Compiler/Service/ServiceErrorResolutionHints.fs
vsintegration/src/FSharp.Editor/Common/CancellableTasks.fs

# Fantomas limitations on signature files (to investigate)

Expand Down
1 change: 0 additions & 1 deletion vsintegration/src/FSharp.Editor/Classification/ClassificationDefinitions.fs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ open Microsoft.VisualStudio.Text.Classification
open Microsoft.VisualStudio.Utilities
open Microsoft.CodeAnalysis.Classification

open FSharp.Compiler.CodeAnalysis
open FSharp.Compiler.EditorServices

[<RequireQualifiedAccess>]
Expand Down
81 changes: 23 additions & 58 deletions vsintegration/src/FSharp.Editor/Classification/ClassificationService.fs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,17 @@ open System
open System.Composition
open System.Collections.Generic
open System.Collections.Immutable
open System.Diagnostics
open System.Threading
open System.Runtime.Caching

open Microsoft.CodeAnalysis
open Microsoft.CodeAnalysis.Classification
open Microsoft.CodeAnalysis.Editor
open Microsoft.CodeAnalysis.Host.Mef
open Microsoft.CodeAnalysis.Text
open Microsoft.CodeAnalysis.ExternalAccess.FSharp.Classification

open FSharp.Compiler.CodeAnalysis
open FSharp.Compiler.EditorServices
open FSharp.Compiler.Tokenization
open CancellableTasks
open Microsoft.VisualStudio.FSharp.Editor.Telemetry

// IEditorClassificationService is marked as Obsolete, but is still supported. The replacement (IClassificationService)
Expand All @@ -32,49 +29,11 @@ open Microsoft.VisualStudio.FSharp.Editor.Telemetry
type SemanticClassificationData = SemanticClassificationView
type SemanticClassificationLookup = IReadOnlyDictionary<int, ResizeArray<SemanticClassificationItem>>

[<Sealed>]
type DocumentCache<'Value when 'Value: not struct>() =
/// Anything under two seconds, the caching stops working, meaning it won't actually cache the item.
/// Two seconds is just enough to keep the data around long enough to handle a flood of a requests asking for the same data
/// in a short period of time.
[<Literal>]
let slidingExpirationSeconds = 2.

let cache = new MemoryCache("fsharp-cache")

let policy =
CacheItemPolicy(SlidingExpiration = TimeSpan.FromSeconds slidingExpirationSeconds)

member _.TryGetValueAsync(doc: Document) =
async {
let! ct = Async.CancellationToken
let! currentVersion = doc.GetTextVersionAsync ct |> Async.AwaitTask

match cache.Get(doc.Id.ToString()) with
| null -> return ValueNone
| :? (VersionStamp * 'Value) as value ->
if fst value = currentVersion then
return ValueSome(snd value)
else
return ValueNone
| _ -> return ValueNone
}

member _.SetAsync(doc: Document, value: 'Value) =
async {
let! ct = Async.CancellationToken
let! currentVersion = doc.GetTextVersionAsync ct |> Async.AwaitTask
cache.Set(doc.Id.ToString(), (currentVersion, value), policy)
}

interface IDisposable with

member _.Dispose() = cache.Dispose()

[<Export(typeof<IFSharpClassificationService>)>]
type internal FSharpClassificationService [<ImportingConstructor>] () =

static let getLexicalClassifications (filePath: string, defines, text: SourceText, textSpan: TextSpan, ct) =
static let getLexicalClassifications (filePath: string, defines, text: SourceText, textSpan: TextSpan, ct: CancellationToken) =

let text = text.GetSubText(textSpan)
let result = ImmutableArray.CreateBuilder()

Expand Down Expand Up @@ -144,8 +103,7 @@ type internal FSharpClassificationService [<ImportingConstructor>] () =
| _ -> ()

static let toSemanticClassificationLookup (d: SemanticClassificationData) =
let lookup =
System.Collections.Generic.Dictionary<int, ResizeArray<SemanticClassificationItem>>()
let lookup = Dictionary<int, ResizeArray<SemanticClassificationItem>>()

let f (dataItem: SemanticClassificationItem) =
let items =
Expand All @@ -160,9 +118,10 @@ type internal FSharpClassificationService [<ImportingConstructor>] () =

d.ForEach(f)

System.Collections.ObjectModel.ReadOnlyDictionary lookup :> IReadOnlyDictionary<_, _>
Collections.ObjectModel.ReadOnlyDictionary lookup :> IReadOnlyDictionary<_, _>

let semanticClassificationCache = new DocumentCache<SemanticClassificationLookup>()
let semanticClassificationCache =
new DocumentCache<SemanticClassificationLookup>("fsharp-semantic-classification-cache")

interface IFSharpClassificationService with
// Do not perform classification if we don't have project options (#defines matter)
Expand All @@ -175,11 +134,13 @@ type internal FSharpClassificationService [<ImportingConstructor>] () =
result: List<ClassifiedSpan>,
cancellationToken: CancellationToken
) =
async {
cancellableTask {
use _logBlock = Logger.LogBlock(LogEditorFunctionId.Classification_Syntactic)

let! cancellationToken = CancellableTask.getCurrentCancellationToken ()

let defines, langVersion = document.GetFSharpQuickDefinesAndLangVersion()
let! sourceText = document.GetTextAsync(cancellationToken) |> Async.AwaitTask
let! sourceText = document.GetTextAsync(cancellationToken)

// For closed documents, only get classification for the text within the span.
// This may be inaccurate for multi-line tokens such as string literals, but this is ok for now
Expand All @@ -198,7 +159,10 @@ type internal FSharpClassificationService [<ImportingConstructor>] () =
TelemetryReporter.ReportSingleEventWithDuration(TelemetryEvents.AddSyntacticCalssifications, eventProps)

if not isOpenDocument then
result.AddRange(getLexicalClassifications (document.FilePath, defines, sourceText, textSpan, cancellationToken))
let classifiedSpans =
getLexicalClassifications (document.FilePath, defines, sourceText, textSpan, cancellationToken)

result.AddRange(classifiedSpans)
else
result.AddRange(
Tokenizer.getClassifiedSpans (
Expand All @@ -212,7 +176,7 @@ type internal FSharpClassificationService [<ImportingConstructor>] () =
)
)
}
|> RoslynHelpers.StartAsyncUnitAsTask cancellationToken
|> CancellableTask.startAsTask cancellationToken

member _.AddSemanticClassificationsAsync
(
Expand All @@ -221,10 +185,10 @@ type internal FSharpClassificationService [<ImportingConstructor>] () =
result: List<ClassifiedSpan>,
cancellationToken: CancellationToken
) =
async {
cancellableTask {
use _logBlock = Logger.LogBlock(LogEditorFunctionId.Classification_Semantic)

let! sourceText = document.GetTextAsync(cancellationToken) |> Async.AwaitTask
let! sourceText = document.GetTextAsync(cancellationToken)

// If we are trying to get semantic classification for a document that is not open, get the results from the background and cache it.
// We do this for find all references when it is populating results.
Expand All @@ -248,9 +212,11 @@ type internal FSharpClassificationService [<ImportingConstructor>] () =

addSemanticClassificationByLookup sourceText textSpan classificationDataLookup result
| _ ->
let eventProps =
let eventProps: (string * obj) array =
[|
"isOpenDocument", isOpenDocument :> obj
"context.document.project.id", document.Project.Id.Id.ToString()
"context.document.id", document.Id.Id.ToString()
"isOpenDocument", isOpenDocument
"textSpanLength", textSpan.Length
"cacheHit", false
|]
Expand Down Expand Up @@ -283,8 +249,7 @@ type internal FSharpClassificationService [<ImportingConstructor>] () =
let classificationData = checkResults.GetSemanticClassification(Some targetRange)
addSemanticClassification sourceText textSpan classificationData result
}
|> Async.Ignore
|> RoslynHelpers.StartAsyncUnitAsTask cancellationToken
|> CancellableTask.startAsTask cancellationToken

// Do not perform classification if we don't have project options (#defines matter)
member _.AdjustStaleClassification(_: SourceText, classifiedSpan: ClassifiedSpan) : ClassifiedSpan = classifiedSpan
39 changes: 22 additions & 17 deletions vsintegration/src/FSharp.Editor/Commands/HelpContextService.fs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ open FSharp.Compiler.EditorServices
open FSharp.Compiler.Syntax
open FSharp.Compiler.Text
open Microsoft.CodeAnalysis
open CancellableTasks

[<Shared>]
[<ExportLanguageService(typeof<IHelpContextService>, FSharpConstants.FSharpLanguageName)>]
type internal FSharpHelpContextService [<ImportingConstructor>] () =

static member GetHelpTerm(document: Document, span: TextSpan, tokens: List<ClassifiedSpan>) : Async<string option> =
asyncMaybe {
let! _, check =
document.GetFSharpParseAndCheckResultsAsync(nameof (FSharpHelpContextService))
|> liftAsync
static member GetHelpTerm(document: Document, span: TextSpan, tokens: List<ClassifiedSpan>) : CancellableTask<string> =
cancellableTask {
let! cancellationToken = CancellableTask.getCurrentCancellationToken ()
let! _, check = document.GetFSharpParseAndCheckResultsAsync(nameof (FSharpHelpContextService))

let! sourceText = document.GetTextAsync() |> liftTaskAsync
let! sourceText = document.GetTextAsync(cancellationToken)
let textLines = sourceText.Lines
let lineInfo = textLines.GetLineFromPosition(span.Start)
let line = lineInfo.LineNumber
Expand Down Expand Up @@ -76,7 +76,7 @@ type internal FSharpHelpContextService [<ImportingConstructor>] () =
| otherwise -> otherwise, col

match tokenInformation with
| None -> return! None
| None -> return ""
| Some token ->
match token.ClassificationType with
| ClassificationTypeNames.Keyword
Expand All @@ -85,25 +85,31 @@ type internal FSharpHelpContextService [<ImportingConstructor>] () =
| ClassificationTypeNames.Comment -> return "comment_FS"
| ClassificationTypeNames.Identifier ->
try
let! (s, colAtEndOfNames, _) = QuickParse.GetCompleteIdentifierIsland false lineText col
let island = QuickParse.GetCompleteIdentifierIsland false lineText col

if check.HasFullTypeCheckInfo then
match island with
| Some (s, colAtEndOfNames, _) when check.HasFullTypeCheckInfo ->
let qualId = PrettyNaming.GetLongNameFromString s
return! check.GetF1Keyword(Line.fromZ line, colAtEndOfNames, lineText, qualId)
else
return! None

let f1Keyword =
check.GetF1Keyword(Line.fromZ line, colAtEndOfNames, lineText, qualId)

return Option.defaultValue "" f1Keyword

| _ -> return ""
with e ->
Assert.Exception e
return! None
| _ -> return! None
return ""
| _ -> return ""
}

interface IHelpContextService with
member this.Language = FSharpConstants.FSharpLanguageLongName
member this.Product = FSharpConstants.FSharpLanguageLongName

member this.GetHelpTermAsync(document, textSpan, cancellationToken) =
asyncMaybe {
cancellableTask {
let! cancellationToken = CancellableTask.getCurrentCancellationToken ()
let! sourceText = document.GetTextAsync(cancellationToken)
let defines, langVersion = document.GetFSharpQuickDefinesAndLangVersion()
let textLine = sourceText.Lines.GetLineFromPosition(textSpan.Start)
Expand All @@ -121,7 +127,6 @@ type internal FSharpHelpContextService [<ImportingConstructor>] () =

return! FSharpHelpContextService.GetHelpTerm(document, textSpan, classifiedSpans)
}
|> Async.map (Option.defaultValue "")
|> RoslynHelpers.StartAsyncAsTask cancellationToken
|> CancellableTask.start cancellationToken

member this.FormatSymbol(_symbol) = Unchecked.defaultof<_>
Loading

0 comments on commit 271790c

Please sign in to comment.