-
Notifications
You must be signed in to change notification settings - Fork 1.1k
PYTHON-5212 - Do not hold Topology lock while resetting pool #2301
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
Changes from all commits
216407e
4f0c8e4
b7232db
f5166be
1b34973
c612c58
6a0457f
c5bf1ab
10406de
37be166
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,6 +14,7 @@ | |
|
||
from __future__ import annotations | ||
|
||
import asyncio | ||
import collections | ||
import contextlib | ||
import logging | ||
|
@@ -860,8 +861,14 @@ async def _reset( | |
# PoolClosedEvent but that reset() SHOULD close sockets *after* | ||
# publishing the PoolClearedEvent. | ||
if close: | ||
for conn in sockets: | ||
await conn.close_conn(ConnectionClosedReason.POOL_CLOSED) | ||
if not _IS_SYNC: | ||
await asyncio.gather( | ||
*[conn.close_conn(ConnectionClosedReason.POOL_CLOSED) for conn in sockets], | ||
return_exceptions=True, | ||
) | ||
else: | ||
for conn in sockets: | ||
await conn.close_conn(ConnectionClosedReason.POOL_CLOSED) | ||
if self.enabled_for_cmap: | ||
assert listeners is not None | ||
listeners.publish_pool_closed(self.address) | ||
|
@@ -891,8 +898,14 @@ async def _reset( | |
serverPort=self.address[1], | ||
serviceId=service_id, | ||
) | ||
for conn in sockets: | ||
await conn.close_conn(ConnectionClosedReason.STALE) | ||
if not _IS_SYNC: | ||
await asyncio.gather( | ||
*[conn.close_conn(ConnectionClosedReason.STALE) for conn in sockets], | ||
return_exceptions=True, | ||
) | ||
else: | ||
for conn in sockets: | ||
await conn.close_conn(ConnectionClosedReason.STALE) | ||
|
||
async def update_is_writable(self, is_writable: Optional[bool]) -> None: | ||
"""Updates the is_writable attribute on all sockets currently in the | ||
|
@@ -938,8 +951,14 @@ async def remove_stale_sockets(self, reference_generation: int) -> None: | |
and self.conns[-1].idle_time_seconds() > self.opts.max_idle_time_seconds | ||
): | ||
close_conns.append(self.conns.pop()) | ||
for conn in close_conns: | ||
await conn.close_conn(ConnectionClosedReason.IDLE) | ||
if not _IS_SYNC: | ||
await asyncio.gather( | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same here. |
||
*[conn.close_conn(ConnectionClosedReason.IDLE) for conn in close_conns], | ||
return_exceptions=True, | ||
) | ||
else: | ||
for conn in close_conns: | ||
await conn.close_conn(ConnectionClosedReason.IDLE) | ||
|
||
while True: | ||
async with self.size_cond: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -529,12 +529,6 @@ async def _process_change( | |
if not _IS_SYNC: | ||
self._monitor_tasks.append(self._srv_monitor) | ||
|
||
# Clear the pool from a failed heartbeat. | ||
if reset_pool: | ||
server = self._servers.get(server_description.address) | ||
if server: | ||
await server.pool.reset(interrupt_connections=interrupt_connections) | ||
|
||
# Wake anything waiting in select_servers(). | ||
self._condition.notify_all() | ||
|
||
|
@@ -557,6 +551,11 @@ async def on_change( | |
# that didn't include this server. | ||
if self._opened and self._description.has_server(server_description.address): | ||
await self._process_change(server_description, reset_pool, interrupt_connections) | ||
# Clear the pool from a failed heartbeat, done outside the lock to avoid blocking on connection close. | ||
if reset_pool: | ||
server = self._servers.get(server_description.address) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The has_server -> _servers.get pattern is not safe to do here (https://en.wikipedia.org/wiki/Time-of-check_to_time-of-use) We also don't need to check for closed/opened because pool.reset is safe to call even after close(). Instead we can do: if reset_pool:
server = self._servers.get(server_description.address)
if server:
await server.pool.reset(interrupt_connections=interrupt_connections) |
||
if server: | ||
await server.pool.reset(interrupt_connections=interrupt_connections) | ||
|
||
async def _process_srv_update(self, seedlist: list[tuple[str, Any]]) -> None: | ||
"""Process a new seedlist on an opened topology. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,10 +20,15 @@ | |
import socketserver | ||
import sys | ||
import threading | ||
import time | ||
from asyncio import StreamReader, StreamWriter | ||
from pathlib import Path | ||
from test.asynchronous.helpers import ConcurrentRunner | ||
|
||
from pymongo.asynchronous.pool import AsyncConnection | ||
from pymongo.operations import _Op | ||
from pymongo.server_selectors import writable_server_selector | ||
|
||
sys.path[0:0] = [""] | ||
|
||
from test.asynchronous import ( | ||
|
@@ -370,6 +375,74 @@ async def test_pool_unpause(self): | |
await listener.async_wait_for_event(monitoring.ServerHeartbeatSucceededEvent, 1) | ||
await listener.async_wait_for_event(monitoring.PoolReadyEvent, 1) | ||
|
||
@async_client_context.require_failCommand_appName | ||
@async_client_context.require_test_commands | ||
@async_client_context.require_async | ||
async def test_connection_close_does_not_block_other_operations(self): | ||
listener = CMAPHeartbeatListener() | ||
client = await self.async_single_client( | ||
appName="SDAMConnectionCloseTest", | ||
event_listeners=[listener], | ||
heartbeatFrequencyMS=500, | ||
minPoolSize=10, | ||
) | ||
server = await (await client._get_topology()).select_server( | ||
writable_server_selector, _Op.TEST | ||
) | ||
await async_wait_until( | ||
lambda: len(server._pool.conns) == 10, | ||
"pool initialized with 10 connections", | ||
) | ||
|
||
await client.db.test.insert_one({"x": 1}) | ||
close_delay = 0.1 | ||
latencies = [] | ||
should_exit = [] | ||
|
||
async def run_task(): | ||
while True: | ||
start_time = time.monotonic() | ||
await client.db.test.find_one({}) | ||
elapsed = time.monotonic() - start_time | ||
latencies.append(elapsed) | ||
if should_exit: | ||
break | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If Could we replace this with an exit condition like this?: latencies = []
should_exit = []
async def run_task():
...
if should_exit:
break
...
# Wait until all idle connections are closed to simulate real-world conditions
await listener.async_wait_for_event(monitoring.ConnectionClosedEvent, 10)
should_exit.append(True)
await task.join() There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The classic list-as-mutable-state technique! |
||
await asyncio.sleep(0.001) | ||
|
||
task = ConcurrentRunner(target=run_task) | ||
await task.start() | ||
original_close = AsyncConnection.close_conn | ||
try: | ||
# Artificially delay the close operation to simulate a slow close | ||
async def mock_close(self, reason): | ||
await asyncio.sleep(close_delay) | ||
await original_close(self, reason) | ||
|
||
AsyncConnection.close_conn = mock_close | ||
|
||
fail_hello = { | ||
"mode": {"times": 4}, | ||
"data": { | ||
"failCommands": [HelloCompat.LEGACY_CMD, "hello"], | ||
"errorCode": 91, | ||
"appName": "SDAMConnectionCloseTest", | ||
}, | ||
} | ||
async with self.fail_point(fail_hello): | ||
# Wait for server heartbeat to fail | ||
await listener.async_wait_for_event(monitoring.ServerHeartbeatFailedEvent, 1) | ||
# Wait until all idle connections are closed to simulate real-world conditions | ||
await listener.async_wait_for_event(monitoring.ConnectionClosedEvent, 10) | ||
# Wait for one more find to complete after the pool has been reset, then shutdown the task | ||
n = len(latencies) | ||
await async_wait_until(lambda: len(latencies) >= n + 1, "run one more find") | ||
should_exit.append(True) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The test should join the task here after # Wait until all idle connections are closed to simulate real-world conditions
await listener.async_wait_for_event(monitoring.ConnectionClosedEvent, 10)
# Wait for one more find to complete, then shutdown the task.
n = len(latencies)
await async_wait_until(lambda: len(latencies) >= n + 1, "run one more find")
should_exit.append(True)
await task.join()
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I see, that way we ensure that the operations are still working after the pool reset completes. |
||
await task.join() | ||
# No operation latency should not significantly exceed close_delay | ||
self.assertLessEqual(max(latencies), close_delay * 5.0) | ||
finally: | ||
AsyncConnection.close_conn = original_close | ||
|
||
|
||
class TestServerMonitoringMode(AsyncIntegrationTest): | ||
@async_client_context.require_no_serverless | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We probably want to use return_exceptions=True here to ensure all tasks complete.