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.

Sign up for GitHub

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

Jump to bottom

fix: include carriage return in multipartform.decode() #10270

Merged
merged 1 commit into from
Dec 27, 2024
Merged

fix: include carriage return in multipartform.decode() #10270

merged 1 commit into from
Dec 27, 2024

Conversation

imnotjames
Copy link
Contributor

@imnotjames imnotjames commented Dec 27, 2024 •
edited
Loading

What do these changes do?

The MultipartForm.decode() function has a bare newline follow the
initial boundary. However, in RFC1341 7.2.1
a boundary is defined to be followed by a CRLF.

The boundary must be followed immediately either by another CRLF
and the header fields for the next part, or by two CRLFs

This updates the decode function to utilize a CRLF instead for the initial boundary.

Are there changes in behavior for the user?

No.

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

No.

Related issue number

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.

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Dec 27, 2024 •
edited
Loading

CodSpeed Performance Report

Merging #10270 will not alter performance

Comparing imnotjames:patch-1 (fec70ec) with master (701ad1e)

Summary

✅ 47 untouched benchmarks

@codecov Codecov
Copy link

codecov bot commented Dec 27, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.77%. Comparing base (701ad1e) to head (fec70ec).
Report is 2 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master   #10270   +/-   ##
=======================================
  Coverage   98.77%   98.77%           
=======================================
  Files         122      122           
  Lines       37029    37029           
  Branches     2041     2041           
=======================================
  Hits        36577    36577           
  Misses        313      313           
  Partials      139      139
Flag Coverage Δ
CI-GHA 98.66% <ø> (ø)
OS-Linux 98.35% <ø> (ø)
OS-Windows 96.21% <ø> (ø)
OS-macOS 97.47% <ø> (+<0.01%) ⬆️
Py-3.10.11 97.34% <ø> (+<0.01%) ⬆️
Py-3.10.15 97.92% <ø> (ø)
Py-3.11.11 98.01% <ø> (ø)
Py-3.11.9 97.43% <ø> (ø)
Py-3.12.8 98.43% <ø> (ø)
Py-3.13.1 98.42% <ø> (ø)
Py-3.9.13 97.23% <ø> (-0.01%) ⬇️
Py-3.9.20 97.81% <ø> (ø)
Py-pypy7.3.16 97.38% <ø> (-0.01%) ⬇️
VM-macos 97.47% <ø> (+<0.01%) ⬆️
VM-ubuntu 98.35% <ø> (ø)
VM-windows 96.21% <ø> (ø)

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.

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Dec 27, 2024
@imnotjames
fix: include carriage return in multipartform.decode()
fec70ec 
the `MultipartForm.decode()` function has a bare newline follow the initial boundary.  in RFC1341 7.2.1, a boundary is defined to be followed by a `CRLF`

this updates the function to utilize a `CRLF` instead
@imnotjames imnotjames marked this pull request as ready for review December 27, 2024 04:14
@Dreamsorcerer
Copy link
Member

Looks like my mistake. Thanks.

@Dreamsorcerer Dreamsorcerer added 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 Dec 27, 2024
@Dreamsorcerer Dreamsorcerer merged commit 2a55afe into aio-libs:master Dec 27, 2024
41 of 42 checks passed
@patchback Patchback
Copy link
Contributor

patchback bot commented Dec 27, 2024 •
edited
Loading

Backport to 3.11: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.11/2a55afeed7e769877d9f6f1eb7aab7ff595e1313/pr-10270

Backported as #10274

🤖 @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 Dec 27, 2024
@imnotjames @patchback
fix: include carriage return in multipartform.decode() (#10270)
975f424 
(cherry picked from commit 2a55afe)
@patchback Patchback
Copy link
Contributor

patchback bot commented Dec 27, 2024 •
edited
Loading

Backport to 3.12: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.12/2a55afeed7e769877d9f6f1eb7aab7ff595e1313/pr-10270

Backported as #10275

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

@patchback patchback bot mentioned this pull request Dec 27, 2024
Merged
5 tasks
patchback bot pushed a commit that referenced this pull request Dec 27, 2024
@imnotjames @patchback
fix: include carriage return in multipartform.decode() (#10270)
cfe0c73 
(cherry picked from commit 2a55afe)
@patchback patchback bot mentioned this pull request Dec 27, 2024
Merged
5 tasks
@imnotjames
Copy link
Contributor Author

Looks like my mistake. Thanks.

Super easy one to make! I only happened to catch it because I was running a stricter web server that got grumpy :)

Dreamsorcerer pushed a commit that referenced this pull request Dec 27, 2024
@patchback @imnotjames
[PR #10270/2a55afee backport][3.11] fix: include carriage return in m…
1b9fada 
…ultipartform.decode() (#10274)

**This is a backport of PR #10270 as merged into master
(2a55afe).**

Co-authored-by: James Ward <james@notjam.es>
Dreamsorcerer pushed a commit that referenced this pull request Dec 27, 2024
@patchback @imnotjames
[PR #10270/2a55afee backport][3.12] fix: include carriage return in m…
b222fb9 
…ultipartform.decode() (#10275)

**This is a backport of PR #10270 as merged into master
(2a55afe).**

Co-authored-by: James Ward <james@notjam.es>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@webknjaz webknjaz Awaiting requested review from webknjaz webknjaz is a code owner

@asvetlov asvetlov Awaiting requested review from asvetlov asvetlov is a code owner

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@imnotjames @Dreamsorcerer