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

Keep-alive timeouts. #627

Merged
merged 7 commits into from
Dec 12, 2019
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
4 changes: 4 additions & 0 deletions httpx/concurrency/asyncio.py
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,10 @@ async def open_uds_stream(

return SocketStream(stream_reader=stream_reader, stream_writer=stream_writer)

def time(self) -> float:
loop = asyncio.get_event_loop()
return loop.time()

async def run_in_threadpool(
self, func: typing.Callable, *args: typing.Any, **kwargs: typing.Any
) -> typing.Any:
Expand Down
3 changes: 3 additions & 0 deletions httpx/concurrency/auto.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ async def open_uds_stream(
) -> BaseSocketStream:
return await self.backend.open_uds_stream(path, hostname, ssl_context, timeout)

def time(self) -> float:
return self.backend.time()

def get_semaphore(self, max_value: int) -> BasePoolSemaphore:
return self.backend.get_semaphore(max_value)

Expand Down
3 changes: 3 additions & 0 deletions httpx/concurrency/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,9 @@ async def open_uds_stream(
) -> BaseSocketStream:
raise NotImplementedError() # pragma: no cover

def time(self) -> float:
raise NotImplementedError() # pragma: no cover

def get_semaphore(self, max_value: int) -> BasePoolSemaphore:
raise NotImplementedError() # pragma: no cover

Expand Down
3 changes: 3 additions & 0 deletions httpx/concurrency/trio.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,9 @@ def run(
functools.partial(coroutine, **kwargs) if kwargs else coroutine, *args
)

def time(self) -> float:
return trio.current_time()

def get_semaphore(self, max_value: int) -> BasePoolSemaphore:
return PoolSemaphore(max_value)

Expand Down
1 change: 1 addition & 0 deletions httpx/dispatch/connection.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ def __init__(
self.release_func = release_func
self.uds = uds
self.open_connection: typing.Optional[OpenConnection] = None
self.expires_at: typing.Optional[float] = None

async def send(
self,
Expand Down
21 changes: 21 additions & 0 deletions httpx/dispatch/connection_pool.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ def __len__(self) -> int:


class ConnectionPool(Dispatcher):
KEEP_ALIVE_EXPIRY = 5.0

def __init__(
self,
*,
Expand All @@ -101,6 +103,7 @@ def __init__(
self.active_connections = ConnectionStore()

self.backend = lookup_backend(backend)
self.next_keepalive_check = 0.0

@property
def max_connections(self) -> BasePoolSemaphore:
Expand All @@ -118,13 +121,29 @@ def max_connections(self) -> BasePoolSemaphore:
def num_connections(self) -> int:
return len(self.keepalive_connections) + len(self.active_connections)

async def check_keepalive_expiry(self) -> None:
now = self.backend.time()
if now < self.next_keepalive_check:
return
self.next_keepalive_check = now + 1.0

# Iterate through all the keep alive connections.
# We create a list here to avoid any 'changed during iteration' errors.
keepalives = list(self.keepalive_connections.all.keys())
florimondmanca marked this conversation as resolved.
Show resolved Hide resolved
for connection in keepalives:
if connection.expires_at is not None and now > connection.expires_at:
self.keepalive_connections.remove(connection)
self.max_connections.release()
await connection.close()

async def send(
self,
request: Request,
verify: VerifyTypes = None,
cert: CertTypes = None,
timeout: Timeout = None,
) -> Response:
await self.check_keepalive_expiry()
connection = await self.acquire_connection(
origin=request.url.origin, timeout=timeout
)
Expand Down Expand Up @@ -180,6 +199,8 @@ async def release_connection(self, connection: HTTPConnection) -> None:
self.max_connections.release()
await connection.close()
else:
now = self.backend.time()
connection.expires_at = now + self.KEEP_ALIVE_EXPIRY
self.active_connections.remove(connection)
self.keepalive_connections.add(connection)

Expand Down
31 changes: 31 additions & 0 deletions tests/dispatch/test_connection_pools.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,37 @@ async def test_keepalive_connections(server, backend):
assert len(http.keepalive_connections) == 1


async def test_keepalive_timeout(server, backend):
"""
Keep-alive connections should timeout.
"""
async with ConnectionPool() as http:
response = await http.request("GET", server.url)
await response.read()
assert len(http.active_connections) == 0
assert len(http.keepalive_connections) == 1

http.next_keepalive_check = 0.0
await http.check_keepalive_expiry()

assert len(http.active_connections) == 0
assert len(http.keepalive_connections) == 1

async with ConnectionPool() as http:
http.KEEP_ALIVE_EXPIRY = 0.0

response = await http.request("GET", server.url)
await response.read()
assert len(http.active_connections) == 0
assert len(http.keepalive_connections) == 1

http.next_keepalive_check = 0.0
await http.check_keepalive_expiry()

assert len(http.active_connections) == 0
assert len(http.keepalive_connections) == 0


async def test_differing_connection_keys(server, backend):
"""
Connections to differing connection keys should result in multiple connections.
Expand Down