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

Return early in WebSocket receive if there is no processing to do #9679

Merged
merged 3 commits into from
Nov 5, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Nov 5, 2024

receive is a hot path for many downstream applications. In most we can avoid the linear search of message types to see if they need additional processing

extracted from #9666

Screenshot 2024-11-03 at 9 10 03 PM

19% speed up to receive for common message types. closing/closing/ping/pong will be a tiny bit slower since it has to do the PySequence_Contains but for any WebSocket connection that has any sort of volume, TEXT or BINARY is going to significant exceed these message types.

receive is a hot path for many downstream applications. In most
we can avoid the linear search of message types to see
if they need additional processing

extracted from #9666
@bdraco bdraco added bot:chronographer:skip This PR does not need to include a change note backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot labels Nov 5, 2024
@bdraco bdraco changed the title Return early in WebSocket receive if there is no processing to do Return early in WebSocket receive if there is no processing to do Nov 5, 2024
@bdraco
Copy link
Member Author

bdraco commented Nov 5, 2024

Its ~19% improvement in of the performance of receive.. but we don't have a direct benchmark

@bdraco bdraco added bot:chronographer:provided There is a change note present in this PR and removed bot:chronographer:skip This PR does not need to include a change note labels Nov 5, 2024
Copy link

codspeed-hq bot commented Nov 5, 2024

CodSpeed Performance Report

Merging #9679 will not alter performance

Comparing return_early_in_receive (c549cfd) with master (75ae623)

Summary

✅ 13 untouched benchmarks

@bdraco bdraco marked this pull request as ready for review November 5, 2024 18:51
@bdraco bdraco enabled auto-merge (squash) November 5, 2024 18:51
Copy link

codecov bot commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.67%. Comparing base (75ae623) to head (c549cfd).
Report is 583 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #9679   +/-   ##
=======================================
  Coverage   98.66%   98.67%           
=======================================
  Files         116      116           
  Lines       35638    35643    +5     
  Branches     4225     4227    +2     
=======================================
+ Hits        35164    35169    +5     
  Misses        319      319           
  Partials      155      155           
Flag Coverage Δ
CI-GHA 98.55% <100.00%> (+<0.01%) ⬆️
OS-Linux 98.23% <100.00%> (+<0.01%) ⬆️
OS-Windows 96.11% <100.00%> (+<0.01%) ⬆️
OS-macOS 97.42% <100.00%> (-0.01%) ⬇️
Py-3.10.11 97.28% <100.00%> (+1.60%) ⬆️
Py-3.10.15 97.71% <100.00%> (+<0.01%) ⬆️
Py-3.11.10 97.77% <100.00%> (+<0.01%) ⬆️
Py-3.11.9 95.74% <100.00%> (-1.63%) ⬇️
Py-3.12.7 98.23% <100.00%> (-0.03%) ⬇️
Py-3.13.0 98.23% <100.00%> (-0.01%) ⬇️
Py-3.9.13 97.20% <100.00%> (+<0.01%) ⬆️
Py-3.9.20 97.62% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 97.24% <100.00%> (-0.01%) ⬇️
VM-macos 97.42% <100.00%> (-0.01%) ⬇️
VM-ubuntu 98.23% <100.00%> (+<0.01%) ⬆️
VM-windows 96.11% <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.

@bdraco bdraco merged commit 3f2f4a7 into master Nov 5, 2024
37 of 38 checks passed
@bdraco bdraco deleted the return_early_in_receive branch November 5, 2024 19:16
Copy link
Contributor

patchback bot commented Nov 5, 2024

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

❌ Failed to cleanly apply 3f2f4a7 on top of patchback/backports/3.11/3f2f4a705f588d79a8649bfb17018cb30431df89/pr-9679

Backporting merged PR #9679 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/3f2f4a705f588d79a8649bfb17018cb30431df89/pr-9679 upstream/3.11
  4. Now, cherry-pick PR Return early in WebSocket receive if there is no processing to do #9679 contents into that branch:
    $ git cherry-pick -x 3f2f4a705f588d79a8649bfb17018cb30431df89
    If it'll yell at you with something like fatal: Commit 3f2f4a705f588d79a8649bfb17018cb30431df89 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 3f2f4a705f588d79a8649bfb17018cb30431df89
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Return early in WebSocket receive if there is no processing to do #9679 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.11/3f2f4a705f588d79a8649bfb17018cb30431df89/pr-9679
  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 5, 2024
bdraco added a commit that referenced this pull request Nov 5, 2024
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:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant