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

Set tipChanged subject's buffer size to 1 #2245

Merged
merged 3 commits into from
Sep 18, 2023

Conversation

moreal
Copy link
Contributor

@moreal moreal commented Sep 14, 2023

This pull request updates the buffer size of subscription.tipChanged API's subject to 1. Without the limitation, the ReplaySubject uses int.MaxValue as its buffer size. It is very useless to provide tipChanged subscription feature. It just causes too many subscription responses and uses too much memory.

When I tested with launcher, it works well.

@auto-assign auto-assign bot requested review from area363 and ipdae September 14, 2023 11:30
@moreal moreal added the bug Something isn't working label Sep 14, 2023
@area363
Copy link
Member

area363 commented Sep 14, 2023

@moreal Tests don't seem to finish 😲

@moreal
Copy link
Contributor Author

moreal commented Sep 14, 2023

@moreal Tests don't seem to finish 😲

@area363 oops.. I guess tipChanged query test may be broken. I'll fix it 🙆‍♂️

@area363
Copy link
Member

area363 commented Sep 15, 2023

@moreal moreal force-pushed the bugfix/buffer-size-1 branch from b4c7d48 to 92011e8 Compare September 15, 2023 06:22
@moreal
Copy link
Contributor Author

moreal commented Sep 15, 2023

@moreal Could you take a look at this lint error? (planetarium/NineChronicles.Headless/actions/runs/6193775290/job/16815783641?pr=2245#step:4:34)

I fixed it!

@moreal moreal force-pushed the bugfix/buffer-size-1 branch from 92011e8 to 24c9424 Compare September 15, 2023 07:57
@area363
Copy link
Member

area363 commented Sep 15, 2023

@moreal https://github.com/planetarium/NineChronicles.Headless/actions/runs/6195442164/job/16821210098?pr=2245#step:5:5294 Not sure why this keeps failing 😅

@moreal moreal force-pushed the bugfix/buffer-size-1 branch from 1d4821b to d692252 Compare September 18, 2023 00:50
@pull-request-quantifier-deprecated

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


Quantification details

Label      : Extra Small
Size       : +5 -4
Percentile : 3.6%

Total files changed: 2

Change summary by file extension:
.cs : +5 -4

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.

@moreal
Copy link
Contributor Author

moreal commented Sep 18, 2023

@moreal planetarium/NineChronicles.Headless/actions/runs/6195442164/job/16821210098?pr=2245#step:5:5294 Not sure why this keeps failing 😅

@area363 Thanks for letting me know that 🙏🏻 I think it is a timing issue between the subscription timing and the reactive processor's timing (System.Reactive). I just added a delay function to pass that issue simply at this time. Could you review it again?

Copy link
Member

@area363 area363 left a comment

Choose a reason for hiding this comment

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

🚀

@moreal moreal merged commit 8ce4e36 into planetarium:development Sep 18, 2023
8 checks passed
@moreal moreal deleted the bugfix/buffer-size-1 branch September 18, 2023 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working Extra Small
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants