Fix: map get data requests by status #189
Merged
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
gluax
requested review from
Thomasvdam,
FranklinWaller,
mariocao,
hacheigriega and
DeshErBojhaa
gluax
commented
Jul 8, 2024
| let total_items = self.len.load(store)?; | ||
|
|
||
| // Shouldn't be reachable | ||
| if total_items == 0 { | ||
| unreachable!("No items in the map, so key should not exist"); | ||
| } | ||
|
|
||
| let status_len_item = self.get_status_len_item(&req_status); | ||
| let req_status_index = status_len_item.load(store)? - 1; |
There was a problem hiding this comment.
Ooopa, I wrote this comment over the weekend but never posted it. I realized this line was wrong.
There was a problem hiding this comment.
No longer relevant, but thought I posted it 😅
FranklinWaller
approved these changes
Jul 11, 2024
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.
Motivation
We need this to work properly, or sadness will happen.
Explanation of Changes
New
I pulled out the Status stuff to an
EnumerableSettype. Based on https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/structs/EnumerableSet.sol.Then use that in the
DataRequestStatusMap.Also, remove index tracking of DataRequests, as it was legacy and unused.
This simplified a lot of code.
Old
I made the update easier by leveraging
swap_remove. I added an insert method that took a status and is for internal use only.I added checks on tests to ensure that each status was of the correct length.
Explanation of problem and fix:
The problem was that because it was using the global index, the indexes per status were not 0-based. i.e., in the new test(before I changed it), the commits started at index 15 instead of 0, at least with the update being changed to use swap remove.
Which makes sense:
You removed index 0 and committed to revealing it as it met the replication factor. So it gets shuffled to the last index. Since the status map also used this index, the problem was created.
A more straightforward fix would have been not to use bounds and use iterator
.skipand.takemethods. However, this would mean we load all dr's in that status every time.So, to resolve this, I added an index per status. This way each status is always 0 indexed as well with proper removes.
Testing
All tests still pass.
Related PRs and Issues
Closes #188.