Change multi-threading behavior of caches (AbstractTypeDicts). #549
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
Fix #548. This is a breaking change, although I doubt that a lot of people have been relying on this behavior up to this point. Previously, `AbstractTypeDict` subtypes such as `StateCache`, `DynamicsResultCache`, and `SegmentedVectorCache` would use the thread ID for the thread in which the value (e.g. `MechanismState`) was created as part of the key. This was not needed for thread-safety (a misunderstanding on my part), and led to some unexpected behavior (#548) as it wasn't documented properly. I also now consider it to be a poor separation of concerns: `AbstractTypeDict` should just be `Dict`-like, and `Dict` doesn't do anything special in the presence of multiple threads. See the following comments for more info on the past behavior and the change: * #548 (comment) * #548 (comment)
Codecov Report
@@ Coverage Diff @@
## master #549 +/- ##
=======================================
Coverage 92.96% 92.96%
=======================================
Files 50 50
Lines 3013 3013
=======================================
Hits 2801 2801
Misses 212 212
Continue to review full report at Codecov.
|
Closed
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.
Fix #548.
This is a breaking change, although I doubt that a lot of people have
been relying on this behavior up to this point.
Previously,
AbstractTypeDictsubtypes such asStateCache,DynamicsResultCache, andSegmentedVectorCachewould use the threadID for the thread in which the value (e.g.
MechanismState) was created as partof the key. This was not needed for thread-safety (a misunderstanding on
my part), and led to some unexpected behavior (#548) as it wasn't
documented properly. I also now consider it to be a poor separation of
concerns:
AbstractTypeDictshould just beDict-like, andDictdoesn't do anything special in the presence of multiple threads.
See the following comments for more info on the past behavior and the
change: