libplanet icon indicating copy to clipboard operation
libplanet copied to clipboard

Refactor `IceServer.CreateTurnClient()`

Open greymistcube opened this issue 3 years ago • 1 comments

Related to #2218.

Two points:

  • Not sure if ProbeConnectableLength is appropriate.
  • Still wondering if there is a more elegant way of calling async from sync. 🙄

P.S. I know forcefully calling async from sync is bad practice, but IMO this is still better than async code spreading uncontrollably without proper design support. 😐

greymistcube avatar Aug 16 '22 18:08 greymistcube

This PR has 110 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       : +61 -49
Percentile : 42%

Total files changed: 7

Change summary by file extension:
.md : +9 -1
.cs : +52 -48

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? :thumbsup:  :ok_hand:  :thumbsdown: (Email) Customize PullRequestQuantifier for this repository.

Completely different PR now. 🙄

  • Keeps async for TurnClient "initialization".
  • IceServer.CreateTrunClient() moved to TurnClient.Create().
  • Added IIceServer as a contract for Libplanet.Net to use TurnClient.Create().

greymistcube avatar Aug 18 '22 04:08 greymistcube

As a side-note, decided to have IIceServer in Libplanet.Stun instead of moving IceServer to Libplanet.Stun from Libplanet.Net in order to avoid lib9c directly depending on Libplanet.Stun when parsing ICE server string. 😶

greymistcube avatar Aug 18 '22 05:08 greymistcube