Skip to content

Fix WebSocket reader with fragmented masked messages #10764

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

Merged
merged 9 commits into from
Apr 21, 2025

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Apr 21, 2025

Fix WebSocket reader with fragmented masked messages

We didn't have proper coverage for these cases. Add mask and large payload coverage for the reported cases since they would come through as 0 instead of the correct size.

fixes #10763
regressed in #10747

related issue #10763

This is passing locally. Going to see if I can get the CI to fail
Copy link

codecov bot commented Apr 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.72%. Comparing base (d884799) to head (23beaa1).
Report is 1 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #10764   +/-   ##
=======================================
  Coverage   98.72%   98.72%           
=======================================
  Files         125      125           
  Lines       37798    37832   +34     
  Branches     2086     2090    +4     
=======================================
+ Hits        37315    37349   +34     
  Misses        335      335           
  Partials      148      148           
Flag Coverage Δ
CI-GHA 98.60% <100.00%> (+<0.01%) ⬆️
OS-Linux 98.27% <100.00%> (+<0.01%) ⬆️
OS-Windows 96.24% <97.50%> (+<0.01%) ⬆️
OS-macOS 97.39% <97.50%> (+<0.01%) ⬆️
Py-3.10.11 97.31% <97.50%> (+<0.01%) ⬆️
Py-3.10.17 97.84% <100.00%> (+<0.01%) ⬆️
Py-3.11.12 97.88% <100.00%> (-0.05%) ⬇️
Py-3.11.9 97.40% <97.50%> (+0.01%) ⬆️
Py-3.12.10 98.03% <100.00%> (-0.01%) ⬇️
Py-3.12.9 97.51% <97.50%> (-0.01%) ⬇️
Py-3.13.2 97.49% <97.50%> (+<0.01%) ⬆️
Py-3.13.3 98.03% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.18% <97.50%> (+<0.01%) ⬆️
Py-3.9.22 97.71% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 81.82% <17.50%> (-15.49%) ⬇️
VM-macos 97.39% <97.50%> (+<0.01%) ⬆️
VM-ubuntu 98.27% <100.00%> (+<0.01%) ⬆️
VM-windows 96.24% <97.50%> (+<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.

Copy link

codspeed-hq bot commented Apr 21, 2025

CodSpeed Performance Report

Merging #10764 will not alter performance

Comparing test_very_large_message (23beaa1) with master (d884799)

Summary

✅ 58 untouched benchmarks

@bdraco bdraco changed the title Add test for very large WebSocket messages Fix WebSocket reader with fragmented masked messages Apr 21, 2025
@bdraco bdraco added backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot backport-3.12 Trigger automatic backporting to the 3.12 release branch by Patchback robot labels Apr 21, 2025
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Apr 21, 2025
@bdraco bdraco marked this pull request as ready for review April 21, 2025 06:28
@bdraco bdraco merged commit e0cc020 into master Apr 21, 2025
40 checks passed
@bdraco bdraco deleted the test_very_large_message branch April 21, 2025 06:55
Copy link
Contributor

patchback bot commented Apr 21, 2025

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

❌ Failed to cleanly apply e0cc020 on top of patchback/backports/3.11/e0cc020d59de9267146c55dbf082805213737653/pr-10764

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

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

❌ Failed to cleanly apply e0cc020 on top of patchback/backports/3.12/e0cc020d59de9267146c55dbf082805213737653/pr-10764

Backporting merged PR #10764 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.12/e0cc020d59de9267146c55dbf082805213737653/pr-10764 upstream/3.12
  4. Now, cherry-pick PR Fix WebSocket reader with fragmented masked messages #10764 contents into that branch:
    $ git cherry-pick -x e0cc020d59de9267146c55dbf082805213737653
    If it'll yell at you with something like fatal: Commit e0cc020d59de9267146c55dbf082805213737653 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x e0cc020d59de9267146c55dbf082805213737653
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Fix WebSocket reader with fragmented masked messages #10764 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.12/e0cc020d59de9267146c55dbf082805213737653/pr-10764
  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 Apr 21, 2025
bdraco added a commit that referenced this pull request Apr 21, 2025
bdraco added a commit that referenced this pull request Apr 21, 2025
bdraco added a commit that referenced this pull request Apr 21, 2025
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 backport-3.12 Trigger automatic backporting to the 3.12 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.

When the client sends a relatively large bytes data packet to the server, the server will receive zero length message.
1 participant