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

Reduce code indent in ResponseHandler.data_received #8699

Merged
merged 9 commits into from
Nov 27, 2024
Merged

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Aug 15, 2024

What do these changes do?

Code cleanup only, no functional change

There were some else after returns that could be converted to guards to reduce code indent.

While looking at the full WebSockets path for #8258 I noticed this could be improved a bit

Additionally, some missing test coverage is added and unreachable code is removed.

Are there changes in behavior for the user?

no

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

no

@bdraco bdraco added bot:chronographer:skip This PR does not need to include a change note 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 15, 2024
aiohttp/client_proto.py Dismissed Show dismissed Hide dismissed
Copy link

codecov bot commented Aug 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.75%. Comparing base (2e369db) to head (b0338a3).
Report is 1 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #8699      +/-   ##
==========================================
+ Coverage   98.73%   98.75%   +0.01%     
==========================================
  Files         121      121              
  Lines       36750    36789      +39     
  Branches     4391     4395       +4     
==========================================
+ Hits        36286    36330      +44     
+ Misses        314      312       -2     
+ Partials      150      147       -3     
Flag Coverage Δ
CI-GHA 98.64% <100.00%> (+0.01%) ⬆️
OS-Linux 98.33% <100.00%> (+0.01%) ⬆️
OS-Windows 96.16% <97.05%> (+0.01%) ⬆️
OS-macOS 97.43% <100.00%> (+0.02%) ⬆️
Py-3.10.11 97.27% <100.00%> (+0.01%) ⬆️
Py-3.10.15 97.87% <100.00%> (+0.01%) ⬆️
Py-3.11.10 97.86% <100.00%> (+0.01%) ⬆️
Py-3.11.9 97.33% <100.00%> (+0.02%) ⬆️
Py-3.12.7 98.39% <100.00%> (+<0.01%) ⬆️
Py-3.13.0 98.38% <100.00%> (+0.02%) ⬆️
Py-3.9.13 97.19% <100.00%> (+0.01%) ⬆️
Py-3.9.20 97.73% <100.00%> (+0.01%) ⬆️
Py-pypy7.3.16 97.35% <100.00%> (+0.02%) ⬆️
VM-macos 97.43% <100.00%> (+0.02%) ⬆️
VM-ubuntu 98.33% <100.00%> (+0.01%) ⬆️
VM-windows 96.16% <97.05%> (+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 Aug 15, 2024

Looks like we are missing coverage for tail

@Dreamsorcerer
Copy link
Member

I feel like that relates to #8597 (comment) or one of my other parser changes. I'm not really sure if it's still possible to reach that code at all...

@bdraco
Copy link
Member Author

bdraco commented Aug 16, 2024

I'll dig through the code paths this weekend if flights cooperate.

@bdraco
Copy link
Member Author

bdraco commented Aug 16, 2024

Looks like websocket will never have a tail unless there is an exception

@bdraco
Copy link
Member Author

bdraco commented Aug 16, 2024

I spent a few hours digging at it, and I can't find a case or make a case where tail exists and upgraded is False

@Dreamsorcerer
Copy link
Member

Dreamsorcerer commented Aug 16, 2024

Then I reckon remove it, but also skip the 3.10 backport as a precaution.

@bdraco bdraco removed the backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot label Aug 16, 2024
aiohttp/client_proto.py Outdated Show resolved Hide resolved
@bdraco
Copy link
Member Author

bdraco commented Oct 1, 2024

Still having trouble getting comfortable with removing that code, need to spend a few more hours tracing

@bdraco
Copy link
Member Author

bdraco commented Nov 5, 2024

I wonder if it is possible and we don't have coverage for it.

We didn't have test coverage for split WebSocket payloads until #9649

Copy link

codspeed-hq bot commented Nov 5, 2024

CodSpeed Performance Report

Merging #8699 will not alter performance

Comparing else_after_return (b0338a3) with master (2e369db)

Summary

✅ 44 untouched benchmarks

@bdraco bdraco added the backport-3.12 Trigger automatic backporting to the 3.12 release branch by Patchback robot label Nov 17, 2024
@bdraco
Copy link
Member Author

bdraco commented Nov 27, 2024

Then I reckon remove it, but also skip the 3.10 backport as a precaution.

After discovering feed_data always return b"" if its not upgraded, I'm confident its truely unreachable so I removed it

return messages, False, b""

@bdraco bdraco marked this pull request as ready for review November 27, 2024 03:47
@bdraco bdraco merged commit 11f0e7f into master Nov 27, 2024
40 checks passed
@bdraco bdraco deleted the else_after_return branch November 27, 2024 03:57
Copy link
Contributor

patchback bot commented Nov 27, 2024

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

❌ Failed to cleanly apply 11f0e7f on top of patchback/backports/3.11/11f0e7f0a9be7ab27036a49ff13e318ed03b769a/pr-8699

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

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

❌ Failed to cleanly apply 11f0e7f on top of patchback/backports/3.12/11f0e7f0a9be7ab27036a49ff13e318ed03b769a/pr-8699

Backporting merged PR #8699 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/11f0e7f0a9be7ab27036a49ff13e318ed03b769a/pr-8699 upstream/3.12
  4. Now, cherry-pick PR Reduce code indent in ResponseHandler.data_received #8699 contents into that branch:
    $ git cherry-pick -x 11f0e7f0a9be7ab27036a49ff13e318ed03b769a
    If it'll yell at you with something like fatal: Commit 11f0e7f0a9be7ab27036a49ff13e318ed03b769a is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 11f0e7f0a9be7ab27036a49ff13e318ed03b769a
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Reduce code indent in ResponseHandler.data_received #8699 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.12/11f0e7f0a9be7ab27036a49ff13e318ed03b769a/pr-8699
  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 27, 2024
bdraco added a commit that referenced this pull request Nov 27, 2024
bdraco added a commit that referenced this pull request Nov 27, 2024
bdraco added a commit that referenced this pull request Nov 27, 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:skip This PR does not need to include a change note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants