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

Refactor/extract transport #2743

Merged
merged 3 commits into from Jan 27, 2023

Conversation

greymistcube
Copy link
Contributor

@greymistcube greymistcube commented Jan 20, 2023

Several points:

  • The ownership of AppProtocolVersionOptions shouldn't be ITransport.
  • This further exposes the mangling of various options that should be for different layers. For instance, SwarmOptions.MessageTimestampBuffer should either be moved to a separate option explicitly for ITransport, or this should be moved together with AppProtocolVersionOptions to Swarm<T>. Also there are certain TimeoutOptions properties that should only be ITransport's concern.
  • At the moment, Swarm<T> should probably check ITransport's PublicKey to make sure they both have the same PrivateKey. I'm not sure about whether they should actually be the same.

@codecov
Copy link

codecov bot commented Jan 20, 2023

Codecov Report

Merging #2743 (c39da2a) into main (a993bb7) will decrease coverage by 0.06%.
The diff coverage is 25.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2743      +/-   ##
==========================================
- Coverage   80.47%   80.42%   -0.06%     
==========================================
  Files         307      307              
  Lines       10576    10579       +3     
==========================================
- Hits         8511     8508       -3     
- Misses       2065     2071       +6     
Impacted Files Coverage Δ
Libplanet.Net/Transports/NetMQTransport.cs 85.56% <0.00%> (-0.90%) ⬇️
Libplanet.Node/NodeConfig.cs 0.00% <0.00%> (ø)
Libplanet.Net/Swarm.cs 86.14% <50.00%> (-0.04%) ⬇️
Libplanet.Net/BlockDemandTable.cs 90.00% <0.00%> (-3.34%) ⬇️
Libplanet.Net/Swarm.BlockCandidate.cs 80.30% <0.00%> (-0.76%) ⬇️
Libplanet.RocksDBStore/RocksDBStore.cs 75.64% <0.00%> (-0.18%) ⬇️
Libplanet/Store/DefaultStore.cs 92.08% <0.00%> (+0.35%) ⬆️

@greymistcube greymistcube self-assigned this Jan 20, 2023
@greymistcube greymistcube marked this pull request as ready for review January 20, 2023 10:43
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.

LGTM but CHANGES.md is deprecated. I'll fix that problem and approve and merge now. cc. @longfin

@pull-request-quantifier-deprecated

This PR has 101 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       : +70 -31
Percentile : 40.2%

Total files changed: 10

Change summary by file extension:
.md : +8 -0
.cs : +62 -31

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.

@riemannulus riemannulus merged commit e03a39d into planetarium:main Jan 27, 2023
@greymistcube greymistcube deleted the refactor/extract-transport branch January 30, 2023 01:38
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.

None yet

4 participants