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.

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

Validate BlockCommit while in BlockChain<T>.Append() #2561

Conversation

colibrishin
Copy link
Contributor

@colibrishin colibrishin commented Nov 18, 2022

Resolves #2541
This PR adds validation of BlockCommit in BlockChain<T>.Append().

There are some cases we should consider:

  • PreloadAfterReorg is failing but there will be no reorganization in PBFT, so skipped the test (Reorganization code should be removed.)
  • When the validator set is dynamically changing, in my opinion, we should revisit this and think about how would block synchronization be done.

@colibrishin colibrishin added the pbft Related to PBFT consensus label Nov 18, 2022
@colibrishin colibrishin self-assigned this Nov 18, 2022
@colibrishin colibrishin changed the title Validate BlockCommit while in Block<T>.Append() Validate BlockCommit while in BlockChain<T>.Append() Nov 18, 2022
Copy link
Member

@limebell limebell left a comment

Choose a reason for hiding this comment

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

Can you please add one line in "Behavioral changes" section that BlockChain<T>.Append() became to throw an InvalidBlockCommitException? And also <exception cref> tag in the document of BlockChain<T>.Append() method?

@pull-request-quantifier-deprecated

This PR has 221 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Large
Size       : +186 -35
Percentile : 62.1%

Total files changed: 11

Change summary by file extension:
.md : +8 -0
.cs : +178 -35

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@colibrishin colibrishin merged commit aae8585 into planetarium:pbft-validate-block-commit Nov 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Large pbft Related to PBFT consensus
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants