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

Periodic MessageId handling in Gossip #3152

Merged
merged 5 commits into from May 17, 2023

Conversation

limebell
Copy link
Member

@limebell limebell commented May 11, 2023

This PR delays reply of HaveMessage, to remove total amount of message in the network.

You may concern that this patch may delay the network, but gossip broadcasts messages via Publish() method at first, and than gossips through HaveMessage if any peer fails to receive published message. If a peer failed to receive published message, it means the message is already delayed, so this PR does not significantly affect delay.

@limebell limebell self-assigned this May 11, 2023
@limebell limebell added network Related to networking (Libplanet.Net) pbft Related to PBFT consensus labels May 11, 2023
@limebell limebell marked this pull request as ready for review May 11, 2023 10:31
@limebell limebell force-pushed the feature/periodic-want branch 2 times, most recently from a6487eb to 928b456 Compare May 15, 2023 07:05
@riemannulus riemannulus self-requested a review May 17, 2023 05:47
Copy link
Member

@riemannulus riemannulus left a comment

Choose a reason for hiding this comment

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

IMO we add these changes on Behavioral changes

@limebell limebell requested a review from riemannulus May 17, 2023 06:00
@pull-request-quantifier-deprecated

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


Quantification details

Label      : Medium
Size       : +95 -18
Percentile : 42.6%

Total files changed: 3

Change summary by file extension:
.md : +5 -0
.cs : +90 -18

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.

@codecov
Copy link

codecov bot commented May 17, 2023

Codecov Report

Merging #3152 (9a0806c) into main (3d5cba6) will increase coverage by 0.08%.
The diff coverage is 87.09%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3152      +/-   ##
==========================================
+ Coverage   81.13%   81.22%   +0.08%     
==========================================
  Files         329      329              
  Lines       11345    11371      +26     
==========================================
+ Hits         9205     9236      +31     
+ Misses       2140     2135       -5     
Impacted Files Coverage Δ
Libplanet.Net/Consensus/Gossip.cs 89.24% <87.09%> (-0.92%) ⬇️

... and 5 files with indirect coverage changes

@limebell limebell merged commit ec7b14e into planetarium:main May 17, 2023
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Medium network Related to networking (Libplanet.Net) pbft Related to PBFT consensus
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants