Skip to content

[PR #11139/3dafd4c7 backport][3.12] Fix IOBasePayload reading entire files into memory instead of chunking #11141

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

Conversation

patchback[bot]
Copy link
Contributor

@patchback patchback bot commented Jun 4, 2025

This is a backport of PR #11139 as merged into master (3dafd4c).

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.

@bdraco bdraco enabled auto-merge (squash) June 4, 2025 14:57
Copy link

codspeed-hq bot commented Jun 4, 2025

CodSpeed Performance Report

Merging #11141 will not alter performance

Comparing patchback/backports/3.12/3dafd4c7882b0e82a9f0d5aa82e2130966765d55/pr-11139 (32e54c3) with 3.12 (278fc1e)

Summary

✅ 59 untouched benchmarks

Copy link

codecov bot commented Jun 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.29%. Comparing base (47bc2a4) to head (32e54c3).
Report is 1 commits behind head on 3.12.

Additional details and impacted files
@@            Coverage Diff             @@
##             3.12   #11141      +/-   ##
==========================================
+ Coverage   98.28%   98.29%   +0.01%     
==========================================
  Files         132      132              
  Lines       42908    42990      +82     
  Branches     2357     2367      +10     
==========================================
+ Hits        42173    42258      +85     
+ Misses        560      557       -3     
  Partials      175      175              
Flag Coverage Δ
CI-GHA 98.18% <100.00%> (+0.01%) ⬆️
OS-Linux 97.93% <100.00%> (+0.01%) ⬆️
OS-Windows 95.59% <100.00%> (-0.01%) ⬇️
OS-macOS 97.16% <100.00%> (+<0.01%) ⬆️
Py-3.10.11 96.93% <100.00%> (+<0.01%) ⬆️
Py-3.10.17 97.40% <100.00%> (-0.03%) ⬇️
Py-3.11.12 97.61% <100.00%> (+<0.01%) ⬆️
Py-3.11.9 97.10% <100.00%> (+<0.01%) ⬆️
Py-3.12.10 97.95% <100.00%> (+0.01%) ⬆️
Py-3.13.3 97.95% <100.00%> (+0.02%) ⬆️
Py-3.9.13 96.82% <100.00%> (-0.01%) ⬇️
Py-3.9.22 97.32% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 90.10% <100.00%> (-0.11%) ⬇️
VM-macos 97.16% <100.00%> (+<0.01%) ⬆️
VM-ubuntu 97.93% <100.00%> (+0.01%) ⬆️
VM-windows 95.59% <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 bdraco merged commit 7ccc94d into 3.12 Jun 4, 2025
36 checks passed
@bdraco bdraco deleted the patchback/backports/3.12/3dafd4c7882b0e82a9f0d5aa82e2130966765d55/pr-11139 branch June 4, 2025 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant