change(state): Refactor format upgrades into trait #9263
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
arya2
added
C-cleanup
arya2
commented
Feb 18, 2025
| fn description(&self) -> &'static str; | ||
|
|
||
| /// Runs disk format upgrade. | ||
| fn run( |
There was a problem hiding this comment.
run_migration() may be a better name for this method.
There was a problem hiding this comment.
Both are fine I think.
arya2
commented
Feb 18, 2025
Comment on lines
+55
to
+58
| /// | ||
| /// # Panics | ||
| /// | ||
| /// If the state has not been upgraded to this format correctly. |
There was a problem hiding this comment.
Suggested change
| /// | |
| /// # Panics | |
| /// | |
| /// If the state has not been upgraded to this format correctly. |
There was a problem hiding this comment.
Also would be good to explain the return value, e.g.
The outer Result indicates whether the validation was cancelled (due to e.g. node shutdown). The inner Result indicates whether the validation itself failed or not.
199059a to
59c0b24
Compare
conradoplg
reviewed
Feb 24, 2025
zebra-state/src/service/finalized_state/disk_format/upgrade/no_migration.rs
Outdated
Show resolved
Hide resolved
5 tasks
…uct, `PruneTrees`, and moves the logic for tree deduplication to the trait impl
…des to use new trait
- Avoids duplicate validation of format upgrades at startup when db is already upgraded, - Minor refactors - Doc fixes and cleanups
arya2
force-pushed
the
db-format-upgrade-trait
branch
from
55b3602 to
deff106
Compare
conradoplg
approved these changes
Feb 28, 2025
Comment on lines
+89
to
+92
| /// | ||
| /// # Panics | ||
| /// | ||
| /// If a duplicate tree is found. |
There was a problem hiding this comment.
Suggested change
| /// | |
| /// # Panics | |
| /// | |
| /// If a duplicate tree is found. |
I don' think this panics? The caller does that
| fn description(&self) -> &'static str; | ||
|
|
||
| /// Runs disk format upgrade. | ||
| fn run( |
There was a problem hiding this comment.
Both are fine I think.
Comment on lines
+55
to
+58
| /// | ||
| /// # Panics | ||
| /// | ||
| /// If the state has not been upgraded to this format correctly. |
Comment on lines
+55
to
+58
| /// | ||
| /// # Panics | ||
| /// | ||
| /// If the state has not been upgraded to this format correctly. |
There was a problem hiding this comment.
Also would be good to explain the return value, e.g.
The outer Result indicates whether the validation was cancelled (due to e.g. node shutdown). The inner Result indicates whether the validation itself failed or not.
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
This PR organizes Zebra's disk format upgrades into trait implementations to make them more maintainable as more upgrades are gradually added.
Closes #7932
Solution
DiskFormatUpgradetraitTests
This change should be covered by existing tests for applying db format upgrades.
Follow-up Work
The bundle of db format changes needed to match zcashd's RPC outputs.
PR Author's Checklist
PR Reviewer's Checklist