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

[PR #5380/11b46df4 backport][3.8] Fix sending zero byte files after sendfile changes #6145

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES/5380.bugfix
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Ensure sending a zero byte file does not throw an exception (round 2)
3 changes: 2 additions & 1 deletion aiohttp/web_fileresponse.py
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,8 @@ async def prepare(self, request: "BaseRequest") -> Optional[AbstractStreamWriter
real_start, real_start + count - 1, file_size
)

if request.method == hdrs.METH_HEAD or self.status in [204, 304]:
# If we are sending 0 bytes calling sendfile() will throw a ValueError
if count == 0 or request.method == hdrs.METH_HEAD or self.status in [204, 304]:
return await super().prepare(request)

fobj = await loop.run_in_executor(None, filepath.open, "rb")
Expand Down
56 changes: 49 additions & 7 deletions tests/test_web_sendfile_functional.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,17 @@ def sendfile(*args, **kwargs):
return loop


@pytest.fixture
def loop_with_mocked_native_sendfile(loop: Any):
def sendfile(transport, fobj, offset, count):
if count == 0:
raise ValueError("count must be a positive integer (got 0)")
raise NotImplementedError

loop.sendfile = sendfile
return loop


@pytest.fixture(params=["sendfile", "no_sendfile"], ids=["sendfile", "no_sendfile"])
def sender(request, loop_without_sendfile):
def maker(*args, **kwargs):
Expand Down Expand Up @@ -74,13 +85,44 @@ async def handler(request):
app.router.add_get("/", handler)
client = await aiohttp_client(app)

resp = await client.get("/")
assert resp.status == 200
txt = await resp.text()
assert "" == txt.rstrip()
assert "application/octet-stream" == resp.headers["Content-Type"]
assert resp.headers.get("Content-Encoding") is None
await resp.release()
# Run the request multiple times to ensure
# that an untrapped exception is not hidden
# because there is no read of the zero bytes
for i in range(2):
resp = await client.get("/")
assert resp.status == 200
txt = await resp.text()
assert "" == txt.rstrip()
assert "application/octet-stream" == resp.headers["Content-Type"]
assert resp.headers.get("Content-Encoding") is None
await resp.release()


async def test_zero_bytes_file_mocked_native_sendfile(
aiohttp_client: Any, loop_with_mocked_native_sendfile: Any
) -> None:
filepath = pathlib.Path(__file__).parent / "data.zero_bytes"

async def handler(request):
asyncio.set_event_loop(loop_with_mocked_native_sendfile)
return web.FileResponse(filepath)

app = web.Application()
app.router.add_get("/", handler)
client = await aiohttp_client(app)

# Run the request multiple times to ensure
# that an untrapped exception is not hidden
# because there is no read of the zero bytes
for i in range(2):
resp = await client.get("/")
assert resp.status == 200
txt = await resp.text()
assert "" == txt.rstrip()
assert "application/octet-stream" == resp.headers["Content-Type"]
assert resp.headers.get("Content-Encoding") is None
assert resp.headers.get("Content-Length") == "0"
await resp.release()


async def test_static_file_ok_string_path(
Expand Down