Skip to content

Fix WebSocket ping tasks being prematurely garbage collected#8641

Merged
bdraco merged 20 commits intomasterfrom
fix_fire_forget_tasks_ws
Aug 8, 2024
Merged

Fix WebSocket ping tasks being prematurely garbage collected#8641
bdraco merged 20 commits intomasterfrom
fix_fire_forget_tasks_ws

Conversation

@bdraco
Copy link
Copy Markdown
Member

@bdraco bdraco commented Aug 8, 2024

What do these changes do?

The event loop only keeps weak references to tasks, we need to hold a strong reference to ensure that the ping task is not prematurely garbage collected.
https://docs.python.org/3/library/asyncio-task.html#asyncio.create_task

In almost all cases the ping can be done synchronously if the task is created eagerly which avoids scheduling the ping task on the event loop.

Are there changes in behavior for the user?

no

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

no

Related issue number

fixes #8614

@bdraco
Fix WebSocket ping tasks being prematurely garbage collected
62a99de 
The event loop only keeps weak references to tasks, we need to
hold a strong reference to ensure that the ping task is not
prematurely garbage collected.
https://docs.python.org/3/library/asyncio-task.html#asyncio.create_task

In almost all cases the ping can be done synchronously if
the task is created eagerly which avoids scheduling the ping
task on the event loop.

fixes #8614
@bdraco bdraco added this to the 3.10.2 milestone Aug 8, 2024
bdraco
bdraco commented Aug 8, 2024
View reviewed changes
Comment thread aiohttp/helpers.py Outdated
bdraco
bdraco commented Aug 8, 2024
View reviewed changes
Comment thread aiohttp/helpers.py Outdated
bdraco
bdraco commented Aug 8, 2024
View reviewed changes
Comment thread aiohttp/helpers.py Outdated
@psf-chronographer psf-chronographer Bot added the bot:chronographer:provided There is a change note present in this PR label Aug 8, 2024
bdraco
bdraco commented Aug 8, 2024
View reviewed changes
Comment thread CHANGES/8641.bugfix.rst Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented Aug 8, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.93%. Comparing base (c4acabc) to head (ce73fd6).
Report is 853 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #8641   +/-   ##
=======================================
  Coverage   97.93%   97.93%           
=======================================
  Files         107      107           
  Lines       33669    33721   +52     
  Branches     3952     3959    +7     
=======================================
+ Hits        32974    33026   +52     
  Misses        515      515           
  Partials      180      180
Flag Coverage Δ
CI-GHA 97.84% <94.44%> (-0.01%) ⬇️
OS-Linux 97.50% <94.44%> (-0.01%) ⬇️
OS-Windows 95.87% <100.00%> (+<0.01%) ⬆️
OS-macOS 97.17% <94.44%> (-0.02%) ⬇️
Py-3.10.11 97.31% <88.88%> (-0.02%) ⬇️
Py-3.10.14 97.25% <88.88%> (-0.02%) ⬇️
Py-3.11.9 97.47% <88.88%> (-0.02%) ⬇️
Py-3.12.4 97.59% <79.62%> (-0.03%) ⬇️
Py-3.8.10 95.64% <100.00%> (+<0.01%) ⬆️
Py-3.8.18 97.15% <88.88%> (-0.02%) ⬇️
Py-3.9.13 97.30% <88.88%> (-0.03%) ⬇️
Py-3.9.19 97.24% <88.88%> (-0.02%) ⬇️
Py-pypy7.3.16 96.83% <88.88%> (-0.02%) ⬇️
VM-macos 97.17% <94.44%> (-0.02%) ⬇️
VM-ubuntu 97.50% <94.44%> (-0.01%) ⬇️
VM-windows 95.87% <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 commented Aug 8, 2024
View reviewed changes
Comment thread aiohttp/client_ws.py Outdated
@bdraco bdraco marked this pull request as ready for review August 8, 2024 01:20
@bdraco bdraco requested a review from webknjaz as a code owner August 8, 2024 01:20
@bdraco bdraco requested a review from asvetlov as a code owner August 8, 2024 01:20
Dreamsorcerer
Dreamsorcerer reviewed Aug 8, 2024
View reviewed changes
Comment thread aiohttp/helpers.py Outdated
@bdraco bdraco merged commit 0a88bab into master Aug 8, 2024
@bdraco bdraco deleted the fix_fire_forget_tasks_ws branch August 8, 2024 14:31
@patchback
Copy link
Copy Markdown
Contributor

patchback Bot commented Aug 8, 2024 •
edited
Loading

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

❌ Failed to cleanly apply 0a88bab on top of patchback/backports/3.10/0a88bab39f922e5a1775a4f557a1475d42a5a504/pr-8641

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

@patchback
Copy link
Copy Markdown
Contributor

patchback Bot commented Aug 8, 2024 •
edited
Loading

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

❌ Failed to cleanly apply 0a88bab on top of patchback/backports/3.11/0a88bab39f922e5a1775a4f557a1475d42a5a504/pr-8641

Backporting merged PR #8641 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/0a88bab39f922e5a1775a4f557a1475d42a5a504/pr-8641 upstream/3.11
  4. Now, cherry-pick PR Fix WebSocket ping tasks being prematurely garbage collected #8641 contents into that branch: 
    $ git cherry-pick -x 0a88bab39f922e5a1775a4f557a1475d42a5a504
    If it'll yell at you with something like fatal: Commit 0a88bab39f922e5a1775a4f557a1475d42a5a504 is a merge but no -m option was given., add -m 1 as follows instead: 
    $ git cherry-pick -m1 -x 0a88bab39f922e5a1775a4f557a1475d42a5a504
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Fix WebSocket ping tasks being prematurely garbage collected #8641 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub: 
    $ git push origin patchback/backports/3.11/0a88bab39f922e5a1775a4f557a1475d42a5a504/pr-8641
  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 Aug 8, 2024
@bdraco
Fix WebSocket ping tasks being prematurely garbage collected (#8641)
ba50518 
(cherry picked from commit 0a88bab)
bdraco added a commit that referenced this pull request Aug 8, 2024
@bdraco
Fix WebSocket ping tasks being prematurely garbage collected (#8641)
f6dfe76 
(cherry picked from commit 0a88bab)
bdraco added a commit that referenced this pull request Aug 8, 2024
@bdraco
[PR #8641/0a88bab backport][3.10] Fix WebSocket ping tasks being prem…
2ef14a6 
…aturely garbage collected (#8646)
bdraco added a commit that referenced this pull request Aug 8, 2024
@bdraco
[PR #8641/0a88bab backport][3.11] Fix WebSocket ping tasks being prem…
80969d2 
…aturely garbage collected (#8647)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Dreamsorcerer Dreamsorcerer Dreamsorcerer approved these changes

@webknjaz webknjaz Awaiting requested review from webknjaz webknjaz is a code owner

@asvetlov asvetlov Awaiting requested review from asvetlov asvetlov is a code owner

Assignees

No one assigned

Labels

bot:chronographer:provided There is a change note present in this PR

Projects

None yet

Milestone

3.10.2

Development

Successfully merging this pull request may close these issues.

Risk of websocket ping tasks being garbage collected before they finish

2 participants

@bdraco @Dreamsorcerer