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

Fix FileResponse sending empty chunked body on 304 #2144

Closed
wants to merge 2 commits into from

Conversation

es1024
Copy link
Contributor

@es1024 es1024 commented Jul 28, 2017

What do these changes do?

Fixes a bug where FileResponse/add_static will include a non-empty body and use Transfer-Encoding: chunked for 304 responses.

Are there changes in behavior for the user?

FileResponse/add_static now won't give malformed 304 responses with bodies.

Related issue number

This fixes #2143.

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • [n/a] 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_id>.<type> for example (588.bug)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

Copy link
Contributor

@cecton cecton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some improvements

assert 304 == resp.status
assert b'' == body
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @es1024 ,

According to what I read on the RFC:

The Content-Length header should not even be there. Can you add an assert to enforce it?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thx!

This habit of so many dev to always use .get() 😕 This is so much more readable (and slightly more correct):

assert "Content-Length" not in resp.headers

(Don't bother though, not important)

@@ -362,7 +362,8 @@ def _start(self, request,
del headers[CONTENT_LENGTH]
elif self._length_check:
writer.length = self.content_length
if writer.length is None and version >= HttpVersion11:
if (writer.length is None and version >= HttpVersion11 and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think fix should be applied to web_fileresponse.py instead of base StreamResponse class.

@codecov-io
Copy link

codecov-io commented Jul 30, 2017

Codecov Report

Merging #2144 into 2.2 will increase coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##              2.2    #2144      +/-   ##
==========================================
+ Coverage   97.03%   97.03%   +<.01%     
==========================================
  Files          38       38              
  Lines        7684     7685       +1     
  Branches     1341     1341              
==========================================
+ Hits         7456     7457       +1     
  Misses        104      104              
  Partials      124      124
Impacted Files Coverage Δ
aiohttp/web_fileresponse.py 90.54% <100%> (+0.06%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f6896b5...7ac8a31. Read the comment docs.

@asvetlov
Copy link
Member

pretty sure BIN aiohttp/.web_response.py.swo was not intentionally added.

@@ -179,6 +179,7 @@ def prepare(self, request):
modsince = request.if_modified_since
if modsince is not None and st.st_mtime <= modsince.timestamp():
self.set_status(HTTPNotModified.status_code)
self._length_check = False
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line looks hacky but I could live with it.
Looks like StreamResponse is too coupled with Response class, let's left it for other PR

@cecton
Copy link
Contributor

cecton commented Jul 30, 2017

@asvetlov can I do the merge? (I will drop the bin don't worry)

@asvetlov
Copy link
Member

@cecton please do

cecton pushed a commit that referenced this pull request Jul 30, 2017
@cecton
Copy link
Contributor

cecton commented Jul 30, 2017

Fixed by cc614ca

@cecton cecton closed this Jul 30, 2017
@lock
Copy link

lock bot commented Oct 28, 2019

This thread has been automatically locked since there has not been
any recent activity after it was closed. Please open a new issue for
related bugs.

If you feel like there's important points made in this discussion,
please include those exceprts into that new issue.

@lock lock bot added the outdated label Oct 28, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Oct 28, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants