Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

change(doc): Document state format upgrade implementation and testing #7799

Merged
merged 10 commits into from
Oct 25, 2023
Merged

change(doc): Document state format upgrade implementation and testing #7799

merged 10 commits into from
Oct 25, 2023

Conversation

teor2345
Copy link
Contributor

@teor2345 teor2345 commented Oct 22, 2023 •
edited
Loading

Motivation

We want to document what we've learned from the last 3 in-place state upgrades.

Close #7737

Solution

Document:

  • how the state works
  • block verification modes
  • why state upgrades are needed
  • why they are tricky and need special care
  • how to implement them more reliably (see also the checklist link below)
  • what testing is needed

Also update some outdated format docs, and add some headings.

There are also ticket templates coming in #7738, here is a draft implementation checklist for state upgrades:
#7738 (comment)

Review

We should get two reviews on this one.

Reviewer Checklist

  • Are the PR labels correct?
  • Does the code do what the ticket and PR says?
    • Does it change concurrent code, unsafe code, or consensus rules?
  • How do you know it works? Does it have tests?

Follow Up Work

Reference these docs from a state upgrade ticket template.

@teor2345 teor2345 added A-docs Area: Documentation C-enhancement Category: This is an improvement P-Medium ⚡ A-state Area: State / database changes C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG extra-reviews This PR needs at least 2 reviews to merge labels Oct 22, 2023
@teor2345 teor2345 self-assigned this Oct 22, 2023
@teor2345 teor2345 requested a review from a team as a code owner October 22, 2023 22:40
@teor2345 teor2345 requested review from arya2 and removed request for a team October 22, 2023 22:40
arya2
arya2 previously approved these changes Oct 25, 2023
View reviewed changes
Copy link
Contributor

@arya2 arya2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

book/src/dev/state-db-upgrades.md Outdated Show resolved Hide resolved
book/src/dev/state-db-upgrades.md Outdated Show resolved Hide resolved
book/src/dev/state-db-upgrades.md Outdated Show resolved Hide resolved
book/src/dev/state-db-upgrades.md Outdated Show resolved Hide resolved
book/src/dev/state-db-upgrades.md Outdated Show resolved Hide resolved
@mpguerra mpguerra requested a review from upbqdn October 25, 2023 07:13
upbqdn
upbqdn previously approved these changes Oct 25, 2023
View reviewed changes
book/src/dev/state-db-upgrades.md Outdated Show resolved Hide resolved
@teor2345 teor2345 removed the extra-reviews This PR needs at least 2 reviews to merge label Oct 25, 2023
@teor2345
Copy link
Contributor Author

This has had two full reviews now.

mergify bot added a commit that referenced this pull request Oct 25, 2023
@mergify
Merge of #7799
f339700
@mergify mergify bot mentioned this pull request Oct 25, 2023
Closed
@mergify mergify bot merged commit a126acb into main Oct 25, 2023
68 checks passed
@mergify mergify bot deleted the state-up-doc branch October 25, 2023 22:18
@teor2345 teor2345 mentioned this pull request Nov 5, 2023
Merged
41 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@upbqdn upbqdn upbqdn approved these changes

@arya2 arya2 arya2 left review comments

Assignees

@teor2345 teor2345

Labels
A-docs Area: Documentation A-state Area: State / database changes C-enhancement Category: This is an improvement C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

doc: Document how to implement state format upgrades
3 participants
@teor2345 @arya2 @upbqdn