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.
Purpose
This PR fixes an issue in
StateMap::get_mut
which allowed users to get inconsistent views of the data. There is an example below.When using
StateMap::get_mut
a value is loaded from the persistent storage into memory. The in-memory value can then be mutated and it will be written to the persistent storage once the value is dropped (via theDrop
implementation onStateRefMut
).If you are able to look up multiple mutable values from the state at once, you can get inconsistent views of the data.
Here is an example:
token_count
has the in-memory valuex + 2
andtoken_count
has the valuex
as it is freshly loaded from persistence.For this reason, we use lifetimes to ensure that you cannot have multiple mutable references to the state at the same time.
Or, at least that was what we meant to do!
We accidentally gave an immutable reference of
self
which exactly allows the example above to run instead of being caught by the borrow-checker.Changes
mut
(and a space)testbuild
to ensure that it won't occur againChecklist
hard-to-understand areas.