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

Improve performance of WebSocketReader #9498

Merged
merged 2 commits into from
Oct 18, 2024
Merged

Improve performance of WebSocketReader #9498

merged 2 commits into from
Oct 18, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Oct 18, 2024

What do these changes do?

Improve performance of WebSocketReader by reducing the overhead to create the WSMessage objects.

Reuses the same idea as aio-libs/yarl#1316 and aio-libs/yarl#1322

Calling tuple.__new__ is much faster because it avoids the extra runtime lambda having to be run and arguments unpacked for every message
https://github.com/python/cpython/blob/d83fcf8371f2f33c7797bc8f5423a8bca8c46e5c/Lib/collections/__init__.py#L441

I limited the change to the http_websocket.py module since this is the only place where they are created at volume. This only works if the object being created is a NamedTuple so this speed up is only recommended internally and should not be used outside of aiohttp since we do not guarantee that WSMessage will remain a NamedTuple in the future.

Are there changes in behavior for the user?

no

Is it a substantial burden for the maintainers to support this?

no

@bdraco bdraco added backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot 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 labels Oct 18, 2024
Copy link

codecov bot commented Oct 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.59%. Comparing base (da0099d) to head (d862d53).
Report is 2 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #9498   +/-   ##
=======================================
  Coverage   98.59%   98.59%           
=======================================
  Files         105      105           
  Lines       35093    35097    +4     
  Branches     4179     4179           
=======================================
+ Hits        34600    34604    +4     
  Misses        329      329           
  Partials      164      164           
Flag Coverage Δ
CI-GHA 98.47% <100.00%> (+<0.01%) ⬆️
OS-Linux 98.14% <100.00%> (+<0.01%) ⬆️
OS-Windows 96.53% <100.00%> (+<0.01%) ⬆️
OS-macOS 97.83% <100.00%> (+<0.01%) ⬆️
Py-3.10.11 97.70% <100.00%> (+<0.01%) ⬆️
Py-3.10.15 97.63% <100.00%> (+<0.01%) ⬆️
Py-3.11.10 97.70% <100.00%> (+<0.01%) ⬆️
Py-3.11.9 97.78% <100.00%> (-0.01%) ⬇️
Py-3.12.7 98.19% <100.00%> (+<0.01%) ⬆️
Py-3.13.0 98.18% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.60% <100.00%> (+<0.01%) ⬆️
Py-3.9.20 97.53% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 97.16% <100.00%> (+<0.01%) ⬆️
VM-macos 97.83% <100.00%> (+<0.01%) ⬆️
VM-ubuntu 98.14% <100.00%> (+<0.01%) ⬆️
VM-windows 96.53% <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 marked this pull request as ready for review October 18, 2024 01:38
@bdraco bdraco requested a review from asvetlov as a code owner October 18, 2024 01:38
@bdraco bdraco enabled auto-merge (squash) October 18, 2024 01:39
@bdraco bdraco merged commit 13dc020 into master Oct 18, 2024
36 of 37 checks passed
@bdraco bdraco deleted the ws_msg_objects branch October 18, 2024 01:54
Copy link
Contributor

patchback bot commented Oct 18, 2024

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

❌ Failed to cleanly apply 13dc020 on top of patchback/backports/3.10/13dc0200d855bdfec1d4c4f3e1c9a1c66f88f1eb/pr-9498

Backporting merged PR #9498 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.10/13dc0200d855bdfec1d4c4f3e1c9a1c66f88f1eb/pr-9498 upstream/3.10
  4. Now, cherry-pick PR Improve performance of WebSocketReader #9498 contents into that branch:
    $ git cherry-pick -x 13dc0200d855bdfec1d4c4f3e1c9a1c66f88f1eb
    If it'll yell at you with something like fatal: Commit 13dc0200d855bdfec1d4c4f3e1c9a1c66f88f1eb is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 13dc0200d855bdfec1d4c4f3e1c9a1c66f88f1eb
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Improve performance of WebSocketReader #9498 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.10/13dc0200d855bdfec1d4c4f3e1c9a1c66f88f1eb/pr-9498
  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.

Copy link
Contributor

patchback bot commented Oct 18, 2024

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

❌ Failed to cleanly apply 13dc020 on top of patchback/backports/3.11/13dc0200d855bdfec1d4c4f3e1c9a1c66f88f1eb/pr-9498

Backporting merged PR #9498 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/13dc0200d855bdfec1d4c4f3e1c9a1c66f88f1eb/pr-9498 upstream/3.11
  4. Now, cherry-pick PR Improve performance of WebSocketReader #9498 contents into that branch:
    $ git cherry-pick -x 13dc0200d855bdfec1d4c4f3e1c9a1c66f88f1eb
    If it'll yell at you with something like fatal: Commit 13dc0200d855bdfec1d4c4f3e1c9a1c66f88f1eb is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 13dc0200d855bdfec1d4c4f3e1c9a1c66f88f1eb
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Improve performance of WebSocketReader #9498 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.11/13dc0200d855bdfec1d4c4f3e1c9a1c66f88f1eb/pr-9498
  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 Oct 18, 2024
bdraco added a commit that referenced this pull request Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot 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.

1 participant