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

Add and use ClientConnectionResetError #9137

Merged
merged 18 commits into from
Sep 18, 2024
Merged

Add and use ClientConnectionResetError #9137

merged 18 commits into from
Sep 18, 2024

Conversation

Dreamsorcerer
Copy link
Member

Not sure if we should do it like this, or we should catch the exception in the client code and reraise this exception in order to be sure that a client exception doesn't get raised in the web side. Reraising would require updating a fair few places though in client_ws.py and client_reqrep.py and may make the code less readable with all the extra try/excepts.

Fixes #8505.

@Dreamsorcerer Dreamsorcerer 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 Sep 13, 2024
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Sep 13, 2024
Copy link

codecov bot commented Sep 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.31%. Comparing base (0da00a1) to head (3826194).
Report is 20 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #9137      +/-   ##
==========================================
+ Coverage   98.30%   98.31%   +0.01%     
==========================================
  Files         107      107              
  Lines       34433    34498      +65     
  Branches     4085     4096      +11     
==========================================
+ Hits        33850    33918      +68     
+ Misses        411      410       -1     
+ Partials      172      170       -2     
Flag Coverage Δ
CI-GHA 98.21% <100.00%> (+0.01%) ⬆️
OS-Linux 97.87% <100.00%> (+0.01%) ⬆️
OS-Windows 96.29% <100.00%> (+0.01%) ⬆️
OS-macOS 97.55% <100.00%> (+0.01%) ⬆️
Py-3.10.11 97.65% <100.00%> (+0.01%) ⬆️
Py-3.10.14 ?
Py-3.10.15 97.58% <100.00%> (?)
Py-3.11.10 97.38% <100.00%> (?)
Py-3.11.9 97.81% <100.00%> (+0.01%) ⬆️
Py-3.12.5 97.59% <100.00%> (-0.33%) ⬇️
Py-3.12.6 97.65% <100.00%> (+0.33%) ⬆️
Py-3.9.13 97.54% <100.00%> (+0.01%) ⬆️
Py-3.9.19 97.39% <100.00%> (-0.08%) ⬇️
Py-3.9.20 97.29% <100.00%> (?)
Py-pypy7.3.16 97.09% <100.00%> (+0.01%) ⬆️
VM-macos 97.55% <100.00%> (+0.01%) ⬆️
VM-ubuntu 97.87% <100.00%> (+0.01%) ⬆️
VM-windows 96.29% <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.

CHANGES/9137.bugfix.rst Outdated Show resolved Hide resolved
@webknjaz
Copy link
Member

If this is being reused on server and client sides, it's probably going to be confusing UX-wise.

@Dreamsorcerer
Copy link
Member Author

If this is being reused on server and client sides, it's probably going to be confusing UX-wise.

The thing is that I'm fairly confident this doesn't reach the user server-side. Any such exception is caught somewhere and handled.

@webknjaz
Copy link
Member

In that case, why would it need to derive from client exceptions?

@Dreamsorcerer
Copy link
Member Author

In that case, why would it need to derive from client exceptions?

Because it propagates client-side and the user needs to catch it..

@webknjaz
Copy link
Member

Ah, I think I parsed your previous message wrong ;)

Copy link
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

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

This approach makes sense to me.

Would be good to add some coverage in these places that both exception types work

tests/test_base_protocol.py:    with pytest.raises(ConnectionResetError):
tests/test_client_ws.py:                with pytest.raises(ConnectionResetError):
tests/test_client_ws_functional.py:        resp._conn.transport, "write", side_effect=ConnectionResetError
tests/test_http_writer.py:    with pytest.raises(ConnectionResetError):
tests/test_http_writer.py:    """Test that writing to a closed transport raises ConnectionResetError.
tests/test_http_writer.py:    writing to the transport. If it is None, it raises ConnectionResetError.
tests/test_http_writer.py:    with pytest.raises(ConnectionResetError, match="Cannot write to closing transport"):

@Dreamsorcerer Dreamsorcerer merged commit f95bcaf into master Sep 18, 2024
34 of 35 checks passed
@Dreamsorcerer Dreamsorcerer deleted the connerr branch September 18, 2024 16:47
Copy link
Contributor

patchback bot commented Sep 18, 2024

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

❌ Failed to cleanly apply f95bcaf on top of patchback/backports/3.10/f95bcaf4e0b2344d09df8dbb565150dcb4e73c0f/pr-9137

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

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

❌ Failed to cleanly apply f95bcaf on top of patchback/backports/3.11/f95bcaf4e0b2344d09df8dbb565150dcb4e73c0f/pr-9137

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

Dreamsorcerer added a commit that referenced this pull request Sep 18, 2024
Dreamsorcerer added a commit that referenced this pull request Sep 18, 2024
Dreamsorcerer added a commit that referenced this pull request Sep 18, 2024
Dreamsorcerer added a commit that referenced this pull request Sep 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:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc Add ConnectionResetError exception to ClientWebSocketResponse documentation
3 participants