Remove aiohttp cancel on disconnect workaround (#104175)

This commit is contained in:
J. Nick Koston 2023-11-29 11:20:36 -07:00 committed by GitHub
parent 50f2c41145
commit 1522118453
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 1 additions and 83 deletions

View File

@ -520,7 +520,7 @@ class HomeAssistantHTTP:
# pylint: disable-next=protected-access
self.app._router.freeze = lambda: None # type: ignore[method-assign]
self.runner = web.AppRunner(self.app)
self.runner = web.AppRunner(self.app, handler_cancellation=True)
await self.runner.setup()
self.site = HomeAssistantTCPSite(

View File

@ -80,7 +80,6 @@ from .exceptions import (
ServiceNotFound,
Unauthorized,
)
from .helpers.aiohttp_compat import restore_original_aiohttp_cancel_behavior
from .helpers.json import json_dumps
from .util import dt as dt_util, location
from .util.async_ import (
@ -113,7 +112,6 @@ STAGE_2_SHUTDOWN_TIMEOUT = 60
STAGE_3_SHUTDOWN_TIMEOUT = 30
block_async_io.enable()
restore_original_aiohttp_cancel_behavior()
_T = TypeVar("_T")
_R = TypeVar("_R")

View File

@ -1,25 +0,0 @@
"""Helper to restore old aiohttp behavior."""
from __future__ import annotations
from aiohttp import web_protocol, web_server
class CancelOnDisconnectRequestHandler(web_protocol.RequestHandler):
"""Request handler that cancels tasks on disconnect."""
def connection_lost(self, exc: BaseException | None) -> None:
"""Handle connection lost."""
task_handler = self._task_handler
super().connection_lost(exc)
if task_handler is not None:
task_handler.cancel("aiohttp connection lost")
def restore_original_aiohttp_cancel_behavior() -> None:
"""Patch aiohttp to restore cancel behavior.
Remove this once aiohttp 3.9 is released as we can use
https://github.com/aio-libs/aiohttp/pull/7128
"""
web_protocol.RequestHandler = CancelOnDisconnectRequestHandler # type: ignore[misc]
web_server.RequestHandler = CancelOnDisconnectRequestHandler # type: ignore[misc]

View File

@ -1,55 +0,0 @@
"""Test the aiohttp compatibility shim."""
import asyncio
from contextlib import suppress
from aiohttp import client, web, web_protocol, web_server
import pytest
from homeassistant.helpers.aiohttp_compat import CancelOnDisconnectRequestHandler
@pytest.mark.allow_hosts(["127.0.0.1"])
async def test_handler_cancellation(socket_enabled, unused_tcp_port_factory) -> None:
"""Test that handler cancels the request on disconnect.
From aiohttp tests/test_web_server.py
"""
assert web_protocol.RequestHandler is CancelOnDisconnectRequestHandler
assert web_server.RequestHandler is CancelOnDisconnectRequestHandler
event = asyncio.Event()
port = unused_tcp_port_factory()
async def on_request(_: web.Request) -> web.Response:
nonlocal event
try:
await asyncio.sleep(10)
except asyncio.CancelledError:
event.set()
raise
else:
raise web.HTTPInternalServerError()
app = web.Application()
app.router.add_route("GET", "/", on_request)
runner = web.AppRunner(app)
await runner.setup()
site = web.TCPSite(runner, host="127.0.0.1", port=port)
await site.start()
try:
async with client.ClientSession(
timeout=client.ClientTimeout(total=0.1)
) as sess:
with pytest.raises(asyncio.TimeoutError):
await sess.get(f"http://127.0.0.1:{port}/")
with suppress(asyncio.TimeoutError):
await asyncio.wait_for(event.wait(), timeout=1)
assert event.is_set(), "Request handler hasn't been cancelled"
finally:
await asyncio.gather(runner.shutdown(), site.stop())