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 client connection header not reflecting connector force_close value #10003

Merged
merged 13 commits into from
Nov 20, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Nov 20, 2024

The Connection header should be set based on the force_close value in the connector.

It appears that the code to set the connection header had no effect because it calls keep_alive which checks the existing connection header and uses the result to set the headers in a block that only ever called when the connection header is not set.

AFIACT its not worked as expected since 8e6723a where the test_http10_keep_alive_default test was marked as xfail and HTTP/1.0 connections never set the keep-alive header but still expected to reuse the connection. Additionally if force_close was set on the connector we never told the remote we were going to close the connection by setting the connection header to close for the HTTP/1.1 case.

The code was only being exercised because the test was mocking out keep_alive to impossible values that disagreed with the block in send that was only entered when the connection header was not set.

def keep_alive(self) -> bool:

It's likely not many people are using force_close or setting the http version to 1.0 so the impact is minimal. On the plus side it makes sending requests 8% faster since it's not having to do all the useless checks now

It appears this actually does nothing because it
checks the existing headers to set the headers
It appears this actually does nothing because it
checks the existing headers to set the headers
Copy link

codspeed-hq bot commented Nov 20, 2024

CodSpeed Performance Report

Merging #10003 will improve performances by 8.52%

Comparing connection_headers (4636c01) with master (af33a82)

Summary

⚡ 1 improvements
✅ 42 untouched benchmarks

Benchmarks breakdown

Benchmark master connection_headers Change
test_send_client_request_one_hundred[pyloop] 3.2 ms 2.9 ms +8.52%

Copy link

codecov bot commented Nov 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.73%. Comparing base (af33a82) to head (4636c01).
Report is 2 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #10003      +/-   ##
==========================================
- Coverage   98.73%   98.73%   -0.01%     
==========================================
  Files         121      121              
  Lines       36738    36726      -12     
  Branches     4384     4383       -1     
==========================================
- Hits        36272    36260      -12     
  Misses        314      314              
  Partials      152      152              
Flag Coverage Δ
CI-GHA 98.61% <100.00%> (-0.01%) ⬇️
OS-Linux 98.30% <100.00%> (-0.01%) ⬇️
OS-Windows 96.13% <100.00%> (+<0.01%) ⬆️
OS-macOS 96.88% <100.00%> (-0.53%) ⬇️
Py-3.10.11 95.70% <100.00%> (-1.55%) ⬇️
Py-3.10.15 97.84% <100.00%> (-0.01%) ⬇️
Py-3.11.10 97.84% <100.00%> (-0.01%) ⬇️
Py-3.11.9 95.74% <100.00%> (-1.57%) ⬇️
Py-3.12.7 98.34% <100.00%> (-0.03%) ⬇️
Py-3.13.0 98.28% <100.00%> (-0.08%) ⬇️
Py-3.9.13 97.17% <100.00%> (+<0.01%) ⬆️
Py-3.9.20 97.76% <100.00%> (-0.01%) ⬇️
Py-pypy7.3.16 97.32% <100.00%> (+<0.01%) ⬆️
VM-macos 96.88% <100.00%> (-0.53%) ⬇️
VM-ubuntu 98.30% <100.00%> (-0.01%) ⬇️
VM-windows 96.13% <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
Copy link
Member Author

bdraco commented Nov 20, 2024

Slept on it. Still think it can go. Need to do some git archeology to see why this was added and how we got here in case I'm missing something

@bdraco
Copy link
Member Author

bdraco commented Nov 20, 2024

8e6723a

@bdraco
Copy link
Member Author

bdraco commented Nov 20, 2024

I think this was actually supposed to set the keep-alive header on http/1.0

@bdraco bdraco changed the title DNM: Remove connection header setter in ClientRequest Fix connection header to reflect connector force_close value Nov 20, 2024
@bdraco bdraco changed the title Fix connection header to reflect connector force_close value Fix client connection header to reflect connector force_close value Nov 20, 2024
@bdraco bdraco changed the title Fix client connection header to reflect connector force_close value Fix client connection header to reflect connector force_close value Nov 20, 2024
@bdraco bdraco added backport-3.10 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 Nov 20, 2024
@bdraco bdraco changed the title Fix client connection header to reflect connector force_close value Fix client connection header not reflecting connector force_close value Nov 20, 2024
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Nov 20, 2024
@bdraco bdraco marked this pull request as ready for review November 20, 2024 16:39
@bdraco bdraco merged commit 78d1be5 into master Nov 20, 2024
41 of 42 checks passed
@bdraco bdraco deleted the connection_headers branch November 20, 2024 21:22
Copy link
Contributor

patchback bot commented Nov 20, 2024

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

❌ Failed to cleanly apply 78d1be5 on top of patchback/backports/3.10/78d1be5d79f67597313354646eec200ff603fd9d/pr-10003

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

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

❌ Failed to cleanly apply 78d1be5 on top of patchback/backports/3.11/78d1be5d79f67597313354646eec200ff603fd9d/pr-10003

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

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

❌ Failed to cleanly apply 78d1be5 on top of patchback/backports/3.12/78d1be5d79f67597313354646eec200ff603fd9d/pr-10003

Backporting merged PR #10003 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/78d1be5d79f67597313354646eec200ff603fd9d/pr-10003 upstream/3.12
  4. Now, cherry-pick PR Fix client connection header not reflecting connector force_close value #10003 contents into that branch:
    $ git cherry-pick -x 78d1be5d79f67597313354646eec200ff603fd9d
    If it'll yell at you with something like fatal: Commit 78d1be5d79f67597313354646eec200ff603fd9d is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 78d1be5d79f67597313354646eec200ff603fd9d
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Fix client connection header not reflecting connector force_close value #10003 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.12/78d1be5d79f67597313354646eec200ff603fd9d/pr-10003
  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 20, 2024
bdraco added a commit that referenced this pull request Nov 20, 2024
bdraco added a commit that referenced this pull request Nov 20, 2024
bdraco added a commit that referenced this pull request Nov 20, 2024
bdraco added a commit that referenced this pull request Nov 20, 2024
bdraco added a commit that referenced this pull request Nov 20, 2024
@bdraco bdraco mentioned this pull request Nov 21, 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
Development

Successfully merging this pull request may close these issues.

1 participant