Skip to content

Improve when SimplifyNames analyzer is triggered #15084

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 14, 2023
Merged

Improve when SimplifyNames analyzer is triggered #15084

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c5343ce
Changing concurrency strategy for name simplification
T-Gro Apr 13, 2023
acdc11c
Using DefaultTuning.PerDocumentSavedDataSlidingWindow as default timeout
T-Gro Apr 13, 2023
d1b5440
Automated command ran: fantomas
github-actions[bot] Apr 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 63 additions & 60 deletions vsintegration/src/FSharp.Editor/Diagnostics/SimplifyNameDiagnosticAnalyzer.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,75 +25,78 @@ type internal SimplifyNameDiagnosticAnalyzer [<ImportingConstructor>] () =

static let userOpName = "SimplifyNameDiagnosticAnalyzer"
static let cache = new MemoryCache("FSharp.Editor." + userOpName)
// Make sure only one document is being analyzed at a time, to be nice
static let guard = new SemaphoreSlim(1)
// Make sure only a few documents are being analyzed at a time, to be nice
static let guard = new SemaphoreSlim(3)

static member LongIdentPropertyKey = "FullName"

interface IFSharpSimplifyNameDiagnosticAnalyzer with

member _.AnalyzeSemanticsAsync(descriptor, document: Document, cancellationToken: CancellationToken) =
if document.Project.IsFSharpMiscellaneousOrMetadata && not document.IsFSharpScript then
Tasks.Task.FromResult(ImmutableArray.Empty)
else

asyncMaybe {
do! Option.guard document.Project.IsFSharpCodeFixesSimplifyNameEnabled
do Trace.TraceInformation("{0:n3} (start) SimplifyName", DateTime.Now.TimeOfDay.TotalSeconds)
let! textVersion = document.GetTextVersionAsync(cancellationToken)
let textVersionHash = textVersion.GetHashCode()
let! _ = guard.WaitAsync(cancellationToken) |> Async.AwaitTask |> liftAsync

try
let key = document.Id.ToString()

match cache.Get(key) with
| :? PerDocumentSavedData as data when data.Hash = textVersionHash -> return data.Diagnostics
| _ ->
let! sourceText = document.GetTextAsync()

let! _, checkResults =
document.GetFSharpParseAndCheckResultsAsync(nameof (SimplifyNameDiagnosticAnalyzer))
|> liftAsync

let! result =
SimplifyNames.getSimplifiableNames (
checkResults,
fun lineNumber -> sourceText.Lines.[Line.toZ lineNumber].ToString()
)
|> liftAsync

let mutable diag = ResizeArray()

for r in result do
diag.Add(
Diagnostic.Create(
descriptor,
RoslynHelpers.RangeToLocation(r.Range, sourceText, document.FilePath),
properties =
(dict [ SimplifyNameDiagnosticAnalyzer.LongIdentPropertyKey, r.RelativeName ])
.ToImmutableDictionary()
)

asyncMaybe {
do! Option.guard document.Project.IsFSharpCodeFixesSimplifyNameEnabled
do Trace.TraceInformation("{0:n3} (start) SimplifyName", DateTime.Now.TimeOfDay.TotalSeconds)
let! textVersion = document.GetTextVersionAsync(cancellationToken)
let textVersionHash = textVersion.GetHashCode()

let! lockObtained =
guard.WaitAsync(DefaultTuning.PerDocumentSavedDataSlidingWindow, cancellationToken)
|> Async.AwaitTask
|> liftAsync

do! Option.guard lockObtained

try
let key = document.Id.ToString()

match cache.Get(key) with
| :? PerDocumentSavedData as data when data.Hash = textVersionHash -> return data.Diagnostics
| _ ->
let! sourceText = document.GetTextAsync()

let! _, checkResults =
document.GetFSharpParseAndCheckResultsAsync(nameof (SimplifyNameDiagnosticAnalyzer))
|> liftAsync

let! result =
SimplifyNames.getSimplifiableNames (
checkResults,
fun lineNumber -> sourceText.Lines.[Line.toZ lineNumber].ToString()
)
|> liftAsync

let mutable diag = ResizeArray()

for r in result do
diag.Add(
Diagnostic.Create(
descriptor,
RoslynHelpers.RangeToLocation(r.Range, sourceText, document.FilePath),
properties =
(dict [ SimplifyNameDiagnosticAnalyzer.LongIdentPropertyKey, r.RelativeName ])
.ToImmutableDictionary()
)
)

let diagnostics = diag.ToImmutableArray()
cache.Remove(key) |> ignore
let diagnostics = diag.ToImmutableArray()
cache.Remove(key) |> ignore

let data =
{
Hash = textVersionHash
Diagnostics = diagnostics
}
let data =
{
Hash = textVersionHash
Diagnostics = diagnostics
}

let cacheItem = CacheItem(key, data)
let cacheItem = CacheItem(key, data)

let policy =
CacheItemPolicy(SlidingExpiration = DefaultTuning.PerDocumentSavedDataSlidingWindow)
let policy =
CacheItemPolicy(SlidingExpiration = DefaultTuning.PerDocumentSavedDataSlidingWindow)

cache.Set(cacheItem, policy)
return diagnostics
finally
guard.Release() |> ignore
}
|> Async.map (Option.defaultValue ImmutableArray.Empty)
|> RoslynHelpers.StartAsyncAsTask cancellationToken
cache.Set(cacheItem, policy)
return diagnostics
finally
guard.Release() |> ignore
}
|> Async.map (Option.defaultValue ImmutableArray.Empty)
|> RoslynHelpers.StartAsyncAsTask cancellationToken