Skip to content

Fix IOBasePayload reading entire files into memory instead of chunking #11139

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

Merged
merged 2 commits into from
Jun 4, 2025

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Jun 4, 2025

What do these changes do?

This PR fixes a memory consumption issue where IOBasePayload and TextIOPayload would read entire files into memory when streaming large files. The bug was introduced in #10915 and caused the payload classes to read remaining_content_length bytes at once instead of chunking the reads.

The fix ensures that both payload classes never read more than READ_SIZE (64KB) at a time, regardless of the file size or content length. This prevents out-of-memory errors when uploading large files using file-like objects with the aiohttp client.

Are there changes in behavior for the user?

No behavioral changes for users. The fix is transparent and only affects memory usage during file streaming. Files are still uploaded correctly, but now they're read in 64KB chunks instead of potentially reading gigabytes into memory at once.

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

No, this is a minimal fix that restores the original intended behavior. The changes are:

  • Adding READ_SIZE as the first parameter to min() in _read_and_available_len() for both IOBasePayload and TextIOPayload
  • Ensuring the _read() method is called with appropriate chunk sizes
  • Comprehensive test coverage to prevent regression

The fix is straightforward and maintains backward compatibility while fixing a critical memory issue.

Related issue number

Fixes #11138

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES/ folder
    • name it <issue_or_pr_num>.<type>.rst (e.g. 588.bugfix.rst)

    • if you don't have an issue number, change it to the pull request
      number after creating the PR

      • .bugfix: A bug fix for something the maintainers deemed an
        improper undesired behavior that got corrected to match
        pre-agreed expectations.
      • .feature: A new behavior, public APIs. That sort of stuff.
      • .deprecation: A declaration of future API removals and breaking
        changes in behavior.
      • .breaking: When something public is removed in a breaking way.
        Could be deprecated in an earlier release.
      • .doc: Notable updates to the documentation structure or build
        process.
      • .packaging: Notes for downstreams about unobvious side effects
        and tooling. Changes in the test invocation considerations and
        runtime assumptions.
      • .contrib: Stuff that affects the contributor experience. e.g.
        Running tests, building the docs, setting up the development
        environment.
      • .misc: Changes that are hard to assign to any of the above
        categories.
    • Make sure to use full sentences with correct case and punctuation,
      for example:

      Fixed issue with non-ascii contents in doctest text files
      -- by :user:`contributor-gh-handle`.

      Use the past tense or the present tense a non-imperative mood,
      referring to what's changed compared to the last released version
      of this project.

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Jun 4, 2025
@bdraco bdraco changed the title Fix IOBasePayload memory usage Fix IOBasePayload reading entire files into memory instead of chunking Jun 4, 2025
@bdraco bdraco added backport-3.12 Trigger automatic backporting to the 3.12 release branch by Patchback robot backport-3.13 Trigger automatic backporting to the 3.13 release branch by Patchback robot labels Jun 4, 2025
Copy link

codecov bot commented Jun 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.85%. Comparing base (47bc2a4) to head (c341495).
Report is 2822 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #11139      +/-   ##
==========================================
+ Coverage   98.28%   98.85%   +0.57%     
==========================================
  Files         132      131       -1     
  Lines       42908    42712     -196     
  Branches     2357     2307      -50     
==========================================
+ Hits        42173    42225      +52     
+ Misses        560      337     -223     
+ Partials      175      150      -25     
Flag Coverage Δ
CI-GHA 98.74% <100.00%> (+0.56%) ⬆️
OS-Linux 98.47% <100.00%> (+0.55%) ⬆️
OS-Windows 96.78% <100.00%> (+1.18%) ⬆️
OS-macOS 97.69% <100.00%> (+0.53%) ⬆️
Py-3.10.11 97.46% <100.00%> (+0.54%) ⬆️
Py-3.10.17 97.95% <100.00%> (+0.52%) ⬆️
Py-3.11.12 98.12% <100.00%> (+0.51%) ⬆️
Py-3.11.9 97.62% <100.00%> (+0.52%) ⬆️
Py-3.12.10 98.49% <100.00%> (+0.55%) ⬆️
Py-3.13.3 98.48% <100.00%> (+0.55%) ⬆️
Py-3.9.13 97.35% <100.00%> (+0.52%) ⬆️
Py-3.9.22 97.83% <100.00%> (+0.51%) ⬆️
Py-pypy7.3.16 97.42% <100.00%> (+7.21%) ⬆️
VM-macos 97.69% <100.00%> (+0.53%) ⬆️
VM-ubuntu 98.47% <100.00%> (+0.55%) ⬆️
VM-windows 96.78% <100.00%> (+1.18%) ⬆️

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.

Copy link

codspeed-hq bot commented Jun 4, 2025

CodSpeed Performance Report

Merging #11139 will not alter performance

Comparing 11138_io_mem (c341495) with master (c0449bb)

Summary

✅ 59 untouched benchmarks

@bdraco bdraco marked this pull request as ready for review June 4, 2025 14:34
@bdraco bdraco requested review from webknjaz and asvetlov as code owners June 4, 2025 14:34
@bdraco bdraco enabled auto-merge (squash) June 4, 2025 14:52
@bdraco bdraco merged commit 3dafd4c into master Jun 4, 2025
66 of 69 checks passed
@bdraco bdraco deleted the 11138_io_mem branch June 4, 2025 14:55
Copy link
Contributor

patchback bot commented Jun 4, 2025

Backport to 3.12: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.12/3dafd4c7882b0e82a9f0d5aa82e2130966765d55/pr-11139

Backported as #11141

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Jun 4, 2025
Copy link
Contributor

patchback bot commented Jun 4, 2025

Backport to 3.13: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.13/3dafd4c7882b0e82a9f0d5aa82e2130966765d55/pr-11139

Backported as #11142

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-3.12 Trigger automatic backporting to the 3.12 release branch by Patchback robot backport-3.13 Trigger automatic backporting to the 3.13 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.

IOBasePayload reads remaining_content_length bytes at once instead of chunking
1 participant