CosmosDiagnostics: Fixes a race condition causing InvalidOperationException #2516
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
j82w
requested review from
ealsur,
FabianMeiswinkel,
khdang,
kirankumarkolli,
kirillg,
neildsh and
sboshra
as code owners
ealsur
previously approved these changes
Jun 2, 2021
Microsoft.Azure.Cosmos/src/Tracing/TraceData/ClientSideRequestStatisticsTraceDatum.cs
Outdated
Show resolved
Hide resolved
Microsoft.Azure.Cosmos/src/Tracing/TraceWriter.TraceJsonWriter.cs
Outdated
Show resolved
Hide resolved
neildsh
previously approved these changes
Jun 2, 2021
Microsoft.Azure.Cosmos/src/Tracing/TraceData/ClientSideRequestStatisticsTraceDatum.cs
Outdated
Show resolved
Hide resolved
FabianMeiswinkel
requested changes
Jun 2, 2021
added 2 commits
June 2, 2021 18:13
…://github.com/Azure/azure-cosmos-dotnet-v3 into users/jawilley/iTrace/clientsideRaceCondition
Microsoft.Azure.Cosmos/src/Tracing/TraceData/ClientSideRequestStatisticsTraceDatum.cs
Outdated
Show resolved
Hide resolved
Microsoft.Azure.Cosmos/src/Tracing/TraceData/ClientSideRequestStatisticsTraceDatum.cs
Outdated
Show resolved
Hide resolved
Microsoft.Azure.Cosmos/src/Tracing/TraceData/ClientSideRequestStatisticsTraceDatum.cs
Outdated
Show resolved
Hide resolved
FabianMeiswinkel
previously approved these changes
Jun 3, 2021
added 2 commits
June 3, 2021 05:06
…://github.com/Azure/azure-cosmos-dotnet-v3 into users/jawilley/iTrace/clientsideRaceCondition
ealsur
previously approved these changes
Jun 3, 2021
neildsh
previously approved these changes
Jun 3, 2021
added 2 commits
June 3, 2021 13:10
…://github.com/Azure/azure-cosmos-dotnet-v3 into users/jawilley/iTrace/clientsideRaceCondition
FabianMeiswinkel
approved these changes
Jun 3, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Template
Description
Introduced in 3.17.0 PR #2097
This is a regression caused by making the ClientSideRequestStatisticsTraceDatum private fields to public. Previously these lists were protected by locks and when they were made public the locks were removed. This PR is adding the locks back and adding tests to ensure that if a background thread does update it while the list is being enumerated that it will not throw a InvalidOperationCancelledException.
Having a lock in the IEnumerable adds the possibility of deadlocks if the enumerator is not properly disposed of. To avoid this possibility a shallow copy of the list is lazily created. Once it is generated it will reuse the same shallow copy until the list is modified again.
Type of change
Please delete options that are not relevant.
Closing issues
To automatically close an issue: closes #IssueNumber