Skip to content

Add warning about consuming the payload in middleware#10970

Merged
bdraco merged 6 commits intomasterfrom
middleware_stream_docs
May 23, 2025
Merged

Add warning about consuming the payload in middleware#10970
bdraco merged 6 commits intomasterfrom
middleware_stream_docs

Conversation

@bdraco
Copy link
Copy Markdown
Member

@bdraco bdraco commented May 23, 2025

closes #2914

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label May 23, 2025
@bdraco bdraco added documentation Improvements or additions to documentation backport-3.11 labels May 23, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented May 23, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.76%. Comparing base (48f5324) to head (3ca99fa).
⚠️ Report is 479 commits behind head on master.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #10970      +/-   ##
==========================================
+ Coverage   98.74%   98.76%   +0.02%     
==========================================
  Files         129      129              
  Lines       39556    39556              
  Branches     2186     2186              
==========================================
+ Hits        39060    39069       +9     
+ Misses        345      339       -6     
+ Partials      151      148       -3     
Flag Coverage Δ
CI-GHA 98.65% <ø> (+0.01%) ⬆️
OS-Linux 98.35% <ø> (+0.02%) ⬆️
OS-Windows 96.53% <ø> (+<0.01%) ⬆️
OS-macOS 97.50% <ø> (ø)
Py-3.10.11 97.40% <ø> (+1.26%) ⬆️
Py-3.10.17 97.93% <ø> (+0.17%) ⬆️
Py-3.11.12 97.97% <ø> (+0.13%) ⬆️
Py-3.11.9 97.48% <ø> (+0.29%) ⬆️
Py-3.12.10 98.41% <ø> (+0.63%) ⬆️
Py-3.13.3 98.40% <ø> (+0.82%) ⬆️
Py-3.9.13 97.27% <ø> (-0.01%) ⬇️
Py-3.9.22 97.81% <ø> (+0.21%) ⬆️
Py-pypy7.3.16 97.37% <ø> (?)
VM-macos 97.50% <ø> (ø)
VM-ubuntu 98.35% <ø> (+0.02%) ⬆️
VM-windows 96.53% <ø> (+<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.

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented May 23, 2025

CodSpeed Performance Report

Merging #10970 will not alter performance

Comparing middleware_stream_docs (3ca99fa) with master (48f5324)

Summary

✅ 59 untouched benchmarks

@bdraco bdraco marked this pull request as ready for review May 23, 2025 18:38
@bdraco bdraco requested review from asvetlov and webknjaz as code owners May 23, 2025 18:38
@bdraco bdraco merged commit bb5fc59 into master May 23, 2025
40 checks passed
@bdraco bdraco deleted the middleware_stream_docs branch May 23, 2025 18:59
@patchback
Copy link
Copy Markdown
Contributor

patchback bot commented May 23, 2025

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

❌ Failed to cleanly apply bb5fc59 on top of patchback/backports/3.11/bb5fc59f13edf4aadc803a8de42b7ece3d05c0f3/pr-10970

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

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

❌ Failed to cleanly apply bb5fc59 on top of patchback/backports/3.12/bb5fc59f13edf4aadc803a8de42b7ece3d05c0f3/pr-10970

Backporting merged PR #10970 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/bb5fc59f13edf4aadc803a8de42b7ece3d05c0f3/pr-10970 upstream/3.12
  4. Now, cherry-pick PR Add warning about consuming the payload in middleware #10970 contents into that branch:
    $ git cherry-pick -x bb5fc59f13edf4aadc803a8de42b7ece3d05c0f3
    If it'll yell at you with something like fatal: Commit bb5fc59f13edf4aadc803a8de42b7ece3d05c0f3 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x bb5fc59f13edf4aadc803a8de42b7ece3d05c0f3
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Add warning about consuming the payload in middleware #10970 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.12/bb5fc59f13edf4aadc803a8de42b7ece3d05c0f3/pr-10970
  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 May 23, 2025
bdraco added a commit that referenced this pull request May 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bot:chronographer:provided There is a change note present in this PR documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Behaviour post/json request content vs. method read()

2 participants