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 FlowControlDataQueue to improve performances #9659

Merged
merged 11 commits into from
Nov 4, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Nov 3, 2024

The DataQueue base class tracks size but it never uses it. Move all the size tracking into the FlowControlDataQueue

@bdraco bdraco added bot:chronographer:skip This PR does not need to include a change note backport-3.10 backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot labels Nov 3, 2024
aiohttp/streams.py Fixed Show fixed Hide fixed
Copy link

codspeed-hq bot commented Nov 3, 2024

CodSpeed Performance Report

Merging #9659 will improve performances by 12.01%

Comparing flow_control_data_queue (771961e) with master (6c932dd)

Summary

⚡ 3 improvements
✅ 10 untouched benchmarks

Benchmarks breakdown

Benchmark master flow_control_data_queue Change
test_one_thousand_round_trip_websocket_binary_messages[pyloop] 20.4 ms 18.2 ms +12.01%
test_one_thousand_round_trip_websocket_text_messages[pyloop] 20.8 ms 18.6 ms +11.64%
test_read_one_hundred_websocket_text_messages[pyloop] 350.4 µs 320.6 µs +9.3%

@bdraco
Copy link
Member Author

bdraco commented Nov 4, 2024

why is that super call so expensive.....

Copy link

codecov bot commented Nov 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.65%. Comparing base (6c932dd) to head (771961e).
Report is 1 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #9659   +/-   ##
=======================================
  Coverage   98.64%   98.65%           
=======================================
  Files         116      116           
  Lines       35475    35482    +7     
  Branches     4208     4211    +3     
=======================================
+ Hits        34996    35003    +7     
  Misses        321      321           
  Partials      158      158           
Flag Coverage Δ
CI-GHA 98.53% <100.00%> (+<0.01%) ⬆️
OS-Linux 98.21% <100.00%> (+<0.01%) ⬆️
OS-Windows 96.09% <100.00%> (+<0.01%) ⬆️
OS-macOS 97.40% <100.00%> (+<0.01%) ⬆️
Py-3.10.11 97.26% <100.00%> (-0.01%) ⬇️
Py-3.10.15 97.69% <100.00%> (+<0.01%) ⬆️
Py-3.11.10 97.75% <100.00%> (-0.01%) ⬇️
Py-3.11.9 97.33% <100.00%> (+<0.01%) ⬆️
Py-3.12.7 98.24% <100.00%> (+<0.01%) ⬆️
Py-3.13.0 98.22% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.17% <100.00%> (+<0.01%) ⬆️
Py-3.9.20 97.60% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 97.22% <100.00%> (+<0.01%) ⬆️
VM-macos 97.40% <100.00%> (+<0.01%) ⬆️
VM-ubuntu 98.21% <100.00%> (+<0.01%) ⬆️
VM-windows 96.09% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

The finally block is not needed because `self._limit` is never
decreased if read raises
@bdraco bdraco force-pushed the flow_control_data_queue branch from 8d76764 to e14531b Compare November 4, 2024 00:15
aiohttp/streams.py Fixed Show fixed Hide fixed
@bdraco bdraco changed the title DNM: Refactor FlowControlDataQueue.read to reduce overhead Refactor FlowControlDataQueue.read to improve performances Nov 4, 2024
@bdraco bdraco changed the title Refactor FlowControlDataQueue.read to improve performances Refactor FlowControlDataQueue to improve performances Nov 4, 2024
@bdraco bdraco marked this pull request as ready for review November 4, 2024 02:48
@bdraco bdraco merged commit 1bb146a into master Nov 4, 2024
40 of 41 checks passed
@bdraco bdraco deleted the flow_control_data_queue branch November 4, 2024 02:49
Copy link
Contributor

patchback bot commented Nov 4, 2024

Backport to 3.11: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 1bb146a on top of patchback/backports/3.11/1bb146ad36b1660548d23166be2e7b37579a1001/pr-9659

Backporting merged PR #9659 into master

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/aio-libs/aiohttp.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/3.11/1bb146ad36b1660548d23166be2e7b37579a1001/pr-9659 upstream/3.11
  4. Now, cherry-pick PR Refactor FlowControlDataQueue to improve performances #9659 contents into that branch:
    $ git cherry-pick -x 1bb146ad36b1660548d23166be2e7b37579a1001
    If it'll yell at you with something like fatal: Commit 1bb146ad36b1660548d23166be2e7b37579a1001 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 1bb146ad36b1660548d23166be2e7b37579a1001
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Refactor FlowControlDataQueue to improve performances #9659 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.11/1bb146ad36b1660548d23166be2e7b37579a1001/pr-9659
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

bdraco added a commit that referenced this pull request Nov 4, 2024
bdraco added a commit that referenced this pull request Nov 4, 2024
Copy link
Member

Choose a reason for hiding this comment

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

As DataQueue doesn't have _size anymore, the Generic should not require Sized anymore. Also, probably want to have WSMessage queues move to that, as they don't need the _size calculations.

Copy link
Member Author

Choose a reason for hiding this comment

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

_SizedT is in this case WSMessage .... I think could be changed to _T

FlowControlDataQueue is only used by the WebSocket? Does the WebSocket not need to pause the protocol when the limit is hit?

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

Oh yeah. That logic can simply be removed then. I thought I remembered it being used in the parser or something with bytes, where it tracked the size of the data stream..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot bot:chronographer:skip This PR does not need to include a change note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants