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

Fix improperly closed WebSocket connections generating a backtrace #9883

Merged
merged 13 commits into from
Nov 14, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Nov 14, 2024

We should only be generating a backtrace if loop.get_debug() is enabled when these get cleaned up by __del__ in ClientResponse. Because the is_eof method wasn't present on WebSocketDataQueue it would check protocol.should_close via Connection.release() which wasn't there and generate a backtrace.

This is likely happening in #9880 as a result of cancellation.

The test harness was a bit too helpful in this case as it automatically cleanups unclosed WebSocket connections which meant the missing is_eof method went unnoticed.

fixes #9880

We should only be generating a backtrace if loop.debug() is true
when these get cleaned up by `__del__` in `ClientResponse`
@bdraco bdraco added the backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot label Nov 14, 2024
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Nov 14, 2024
CHANGES/9883.bugfix.rst Outdated Show resolved Hide resolved
Copy link

codspeed-hq bot commented Nov 14, 2024

CodSpeed Performance Report

Merging #9883 will not alter performance

Comparing conn_del_ws (99f5095) with master (9e3a328)

Summary

✅ 24 untouched benchmarks

Copy link

codecov bot commented Nov 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.71%. Comparing base (9e3a328) to head (99f5095).
Report is 1 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #9883   +/-   ##
=======================================
  Coverage   98.71%   98.71%           
=======================================
  Files         118      118           
  Lines       36309    36347   +38     
  Branches     4316     4317    +1     
=======================================
+ Hits        35841    35879   +38     
  Misses        315      315           
  Partials      153      153           
Flag Coverage Δ
CI-GHA 98.60% <100.00%> (+<0.01%) ⬆️
OS-Linux 98.28% <100.00%> (+<0.01%) ⬆️
OS-Windows 96.09% <97.43%> (+<0.01%) ⬆️
OS-macOS 97.37% <97.43%> (-0.01%) ⬇️
Py-3.10.11 97.21% <97.43%> (-0.02%) ⬇️
Py-3.10.15 97.77% <100.00%> (-0.05%) ⬇️
Py-3.11.10 97.82% <100.00%> (+0.01%) ⬆️
Py-3.11.9 97.27% <97.43%> (-0.01%) ⬇️
Py-3.12.7 98.35% <100.00%> (+<0.01%) ⬆️
Py-3.13.0 98.33% <100.00%> (-0.01%) ⬇️
Py-3.9.13 97.14% <97.43%> (+<0.01%) ⬆️
Py-3.9.20 97.73% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 97.29% <100.00%> (+<0.01%) ⬆️
VM-macos 97.37% <97.43%> (-0.01%) ⬇️
VM-ubuntu 98.28% <100.00%> (+<0.01%) ⬆️
VM-windows 96.09% <97.43%> (+<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
Copy link
Member Author

bdraco commented Nov 14, 2024

The test harness is a bit too helpful as it tracks all the websocket connections and cleanups up the improperly closed ones

tests/test_client_ws_functional.py Dismissed Show dismissed Hide dismissed
@bdraco bdraco marked this pull request as ready for review November 14, 2024 20:29
@bdraco bdraco merged commit a118114 into master Nov 14, 2024
40 of 41 checks passed
@bdraco bdraco deleted the conn_del_ws branch November 14, 2024 20:34
Copy link
Contributor

patchback bot commented Nov 14, 2024

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

❌ Failed to cleanly apply a118114 on top of patchback/backports/3.11/a11811471ded1a4df59302316d12fc90a3cfc819/pr-9883

Backporting merged PR #9883 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/a11811471ded1a4df59302316d12fc90a3cfc819/pr-9883 upstream/3.11
  4. Now, cherry-pick PR Fix improperly closed WebSocket connections generating a backtrace #9883 contents into that branch:
    $ git cherry-pick -x a11811471ded1a4df59302316d12fc90a3cfc819
    If it'll yell at you with something like fatal: Commit a11811471ded1a4df59302316d12fc90a3cfc819 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x a11811471ded1a4df59302316d12fc90a3cfc819
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Fix improperly closed WebSocket connections generating a backtrace #9883 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.11/a11811471ded1a4df59302316d12fc90a3cfc819/pr-9883
  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 14, 2024
bdraco added a commit that referenced this pull request Nov 14, 2024
@bdraco bdraco added the backport-3.12 Trigger automatic backporting to the 3.12 release branch by Patchback robot label Nov 14, 2024
Copy link
Contributor

patchback bot commented Nov 14, 2024

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

❌ Failed to cleanly apply a118114 on top of patchback/backports/3.12/a11811471ded1a4df59302316d12fc90a3cfc819/pr-9883

Backporting merged PR #9883 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/a11811471ded1a4df59302316d12fc90a3cfc819/pr-9883 upstream/3.12
  4. Now, cherry-pick PR Fix improperly closed WebSocket connections generating a backtrace #9883 contents into that branch:
    $ git cherry-pick -x a11811471ded1a4df59302316d12fc90a3cfc819
    If it'll yell at you with something like fatal: Commit a11811471ded1a4df59302316d12fc90a3cfc819 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x a11811471ded1a4df59302316d12fc90a3cfc819
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Fix improperly closed WebSocket connections generating a backtrace #9883 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.12/a11811471ded1a4df59302316d12fc90a3cfc819/pr-9883
  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 14, 2024
bdraco added a commit that referenced this pull request Nov 14, 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 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
1 participant