Skip to content

Fix thread safety issue in XmlDocumentation Provider by replacing Dictionary with ConcurrentDictionary #18798

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 4 commits into from
Aug 14, 2025
Merged

Fix thread safety issue in XmlDocumentation Provider by replacing Dictionary with ConcurrentDictionary #18798

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2a5ffb5
Initial plan
Copilot Jul 30, 2025
b0c66f7
Fix thread safety issue: Replace Dictionary with ConcurrentDictionary…
Copilot Jul 30, 2025
3d4a39e
Apply patch from /run fantomas
actions-user Jul 31, 2025
7624b54
Merge branch 'main' into copilot/fix-27d8c2e4-8e4c-4d31-88fd-22265b5a…
T-Gro Aug 4, 2025
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
32 changes: 16 additions & 16 deletions vsintegration/src/FSharp.Editor/DocComments/XMLDocumentation.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace Microsoft.VisualStudio.FSharp.Editor

open System
open System.Collections.Concurrent
open System.Collections.Immutable
open System.Runtime.CompilerServices
open System.Text.RegularExpressions
Expand Down Expand Up @@ -288,27 +289,26 @@ module internal XmlDocumentation =
/// Provide Xml Documentation
type Provider(xmlIndexService: IVsXMLMemberIndexService) =
/// Index of assembly name to xml member index.
let cache = Dictionary<string, IVsXMLMemberIndex>()
let cache = ConcurrentDictionary<string, IVsXMLMemberIndex>()

do Events.SolutionEvents.OnAfterCloseSolution.Add(fun _ -> cache.Clear())

/// Retrieve the preexisting xml index or None
let GetMemberIndexOfAssembly (assemblyName) =
match cache.TryGetValue(assemblyName) with
| true, memberIndex -> Some(memberIndex)
| false, _ ->
let ok, memberIndex = xmlIndexService.CreateXMLMemberIndex(assemblyName)

if Com.Succeeded(ok) then
let ok = memberIndex.BuildMemberIndex()

if Com.Succeeded(ok) then
cache.Add(assemblyName, memberIndex)
Some(memberIndex)
else
None
else
None
let memberIndex =
cache.GetOrAdd(
assemblyName,
fun name ->
let ok, memberIndex = xmlIndexService.CreateXMLMemberIndex(name)

if Com.Succeeded(ok) then
let ok = memberIndex.BuildMemberIndex()
if Com.Succeeded(ok) then memberIndex else null
else
null
)

if memberIndex <> null then Some(memberIndex) else None

let AppendMemberData
(
Expand Down
Loading