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 close race that prevented the close code from reaching the client #8680

Merged
merged 14 commits into from
Aug 12, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Aug 11, 2024

Fix close race that prevented the close code from reaching the client

fixes #3448

Copy link
Member

@Dreamsorcerer Dreamsorcerer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like that works.

@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 labels Aug 11, 2024
@bdraco
Copy link
Member Author

bdraco commented Aug 11, 2024

need to do regression testing with Home Assistant and make sure everything is still covered

Copy link

codecov bot commented Aug 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.96%. Comparing base (bbe7197) to head (0de2c10).
Report is 820 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #8680      +/-   ##
==========================================
- Coverage   97.98%   97.96%   -0.03%     
==========================================
  Files         107      107              
  Lines       33825    33860      +35     
  Branches     3969     3970       +1     
==========================================
+ Hits        33143    33170      +27     
- Misses        505      513       +8     
  Partials      177      177              
Flag Coverage Δ
CI-GHA 97.86% <100.00%> (-0.03%) ⬇️
OS-Linux 97.52% <100.00%> (-0.03%) ⬇️
OS-Windows 95.90% <100.00%> (-0.02%) ⬇️
OS-macOS 97.19% <100.00%> (-0.03%) ⬇️
Py-3.10.11 97.33% <100.00%> (-0.03%) ⬇️
Py-3.10.14 97.26% <100.00%> (-0.03%) ⬇️
Py-3.11.9 97.39% <100.00%> (-0.13%) ⬇️
Py-3.12.4 97.61% <100.00%> (-0.03%) ⬇️
Py-3.8.10 95.54% <100.00%> (-0.02%) ⬇️
Py-3.8.18 97.05% <100.00%> (-0.03%) ⬇️
Py-3.9.13 97.20% <97.82%> (-0.03%) ⬇️
Py-3.9.19 97.14% <97.82%> (-0.03%) ⬇️
Py-pypy7.3.16 96.73% <100.00%> (-0.03%) ⬇️
VM-macos 97.19% <100.00%> (-0.03%) ⬇️
VM-ubuntu 97.52% <100.00%> (-0.03%) ⬇️
VM-windows 95.90% <100.00%> (-0.02%) ⬇️

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.

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Aug 11, 2024
aiohttp/web_ws.py Outdated Show resolved Hide resolved
@bdraco
Copy link
Member Author

bdraco commented Aug 11, 2024

manual testing looks good

@bdraco bdraco marked this pull request as ready for review August 11, 2024 14:42
@bdraco bdraco merged commit 4f41d05 into master Aug 12, 2024
37 of 38 checks passed
@bdraco bdraco deleted the close_race branch August 12, 2024 13:53
Copy link
Contributor

patchback bot commented Aug 12, 2024

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

❌ Failed to cleanly apply 4f41d05 on top of patchback/backports/3.10/4f41d05e1a1340303a92e77a166646af370291e8/pr-8680

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

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

❌ Failed to cleanly apply 4f41d05 on top of patchback/backports/3.11/4f41d05e1a1340303a92e77a166646af370291e8/pr-8680

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

Successfully merging this pull request may close these issues.

WebSocketResponse.close code/message don't reach the client
2 participants