Fix panic on closing nil db #3175
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
When account.FillDBWithParticipationKeys fails and returns an error, e.g. if the key already exists, newPart will be invalid and should not be closed. When Close is called, it will panic.
FillDBWithParticipationKeys will return empty PersistedParticipation when lastValid is less than firstValid. When this happens, newPart will not have partdb in newPart.Store, instead, will have an empty object. Calling Close on the empty object will call close on nil Accessor pointer and panic. This change avoids using the returned object with non-nil error, and properly closes the db with the valid object. Added test to varify the proper handling of the different errors returned from FillDBWithParticipationKeys and handled by GenParticipationKeysTo.
tsachiherman
suggested changes
Nov 2, 2021
Codecov Report
@@ Coverage Diff @@
## master #3175 +/- ##
==========================================
- Coverage 43.81% 43.77% -0.05%
==========================================
Files 392 392
Lines 86885 86885
==========================================
- Hits 38073 38033 -40
- Misses 42782 42812 +30
- Partials 6030 6040 +10
Continue to review full report at Codecov.
|
tsachiherman
approved these changes
Nov 3, 2021
Merged
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.
Summary
FillDBWithParticipationKeys will return empty PersistedParticipation when lastValid is less than firstValid.
When this happens, newPart will not have partdb in newPart.Store, instead, will have an empty object.
Calling Close on the empty object will call close on nil Accessor pointer and panic.
This change avoids using the returned object with non-nil error, and properly closes the db with the valid object.
Test Plan
Added test to verify the proper handling of the different errors returned from FillDBWithParticipationKeys and handled by GenParticipationKeysTo.