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

Send BlockCommit in BlocksMsg #2558

Conversation

greymistcube
Copy link
Contributor

@greymistcube greymistcube commented Nov 17, 2022

Closes #2551.

@greymistcube greymistcube force-pushed the feature/block-commit-in-blocks-msg branch from 226f913 to a2f5c3d Compare November 17, 2022 09:08
@greymistcube greymistcube marked this pull request as ready for review November 17, 2022 09:53
@greymistcube greymistcube self-assigned this Nov 17, 2022
@greymistcube greymistcube changed the title Feature/block commit in blocks msg Send BlockCommit in BlocksMsg Nov 17, 2022
Copy link
Contributor

@colibrishin colibrishin left a comment

Choose a reason for hiding this comment

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

await foreach (
(Block<T> block, BlockCommit commit, BoundPeer sourcePeer)
in completedBlocks.WithCancellation(cancellationToken))

// TODO : Block should be appended with commits.
workspace.Append(
deltaBlock,
null,
evaluateActions: false,
renderBlocks: renderBlocks,
renderActions: renderActions

Append() with BlockCommit in CompleteBlockAsync() is not implemented.

@greymistcube
Copy link
Contributor Author

greymistcube commented Nov 18, 2022

@colibrishin

Append() with BlockCommit in CompleteBlockAsync() is not implemented.

I thought it was added in in #2548? The interface has been already added, just without validation logic. The expected behavior of BlockSync() is to pass on BlockCommit to Append().

Nevermind, misread the comment. 😅

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.

byte[]-typed .ToByteArray() method and ImmutableArray<byte>-typed .ByteArray method looks confusing to me by its name. How about rename method that returning ImmutableArray to ImmutableByteArray or something?

@colibrishin
Copy link
Contributor

colibrishin commented Nov 18, 2022

I misused the word implemented. What I wanted to say was, the received BlockCommit should be passed to Append() in CompleteBlockAsync().

@greymistcube
Copy link
Contributor Author

@limebell
It's really not by my choice. We do have ImmutableArray<byte> ByteArray and byte[] ToByteArray() sprinkled here and there throughout the codebase, such as Address, HashDigest<T>, Nonce, etc.; I'm just trying to be consistent. 🙄

@limebell
Copy link
Member

@limebell It's really not by my choice. We do have ImmutableArray<byte> ByteArray and byte[] ToByteArray() sprinkled here and there throughout the codebase, such as Address, HashDigest<T>, Nonce, etc.; I'm just trying to be consistent. 🙄

Okay, we may discuss about that someday...

@greymistcube greymistcube force-pushed the feature/block-commit-in-blocks-msg branch from 5c6c9e5 to 4ac077b Compare November 18, 2022 04:49
@pull-request-quantifier-deprecated

This PR has 359 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       : +218 -141
Percentile : 75.9%

Total files changed: 23

Change summary by file extension:
.cs : +218 -141

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 self-requested a review November 18, 2022 08:20
@greymistcube greymistcube merged commit 5bdf24f into planetarium:pbft-validate-block-commit Nov 18, 2022
@greymistcube greymistcube deleted the feature/block-commit-in-blocks-msg branch December 5, 2022 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants