Return copies in ShadowLog#getLogs and ShadowLog#getLogsForTag #3007
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
Previously, ShadowLog#getLogs and ShadowLog#getLogsForTag would return the raw underlying data structure used to store the logs. This could cause ConcurrentModificationExceptions if a test iterated over these structures while another thread added more data to the logs. Instead, return a copy of the logs each time ShadowLog#getLogs and ShadowLog#getLogsForTag is called. This prevents tests from accidentally interfering with the data and causing problems. Also, update the data structures to be concurrent. Store logs in a concurrent queue, and use synchronized structures for maps. This eliminates the need to use class synchronization.
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.
Previously, ShadowLog#getLogs and ShadowLog#getLogsForTag would return
the raw underlying data structure used to store the logs. This could
cause ConcurrentModificationExceptions if a test iterated over these
structures while another thread added more data to the logs.
Instead, return a copy of the logs each time ShadowLog#getLogs and
ShadowLog#getLogsForTag is called. This prevents tests from accidentally
interfering with the data and causing problems.
Also, update the data structures to be concurrent. Store logs in a
concurrent queue, and use synchronized structures for maps. This
eliminates the need to use class synchronization.