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

avoid refcycles in tracebacks from happy eyeballs exceptions #809

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 10 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 pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ test = [
and platform_system != 'Windows' \
and python_version < '3.14'\
"""
graingert marked this conversation as resolved.
Show resolved Hide resolved
"ephemeral-port-reserve >= 1.1.4",
]
doc = [
"packaging",
Expand Down
31 changes: 17 additions & 14 deletions src/anyio/_core/_sockets.py
Original file line number Diff line number Diff line change
Expand Up @@ -224,20 +224,23 @@ async def try_connect(remote_host: str, event: Event) -> None:
target_addrs.append((af, sa[0]))

oserrors: list[OSError] = []
async with create_task_group() as tg:
for i, (af, addr) in enumerate(target_addrs):
event = Event()
tg.start_soon(try_connect, addr, event)
with move_on_after(happy_eyeballs_delay):
await event.wait()

if connected_stream is None:
cause = (
oserrors[0]
if len(oserrors) == 1
else ExceptionGroup("multiple connection attempts failed", oserrors)
)
raise OSError("All connection attempts failed") from cause
try:
async with create_task_group() as tg:
for i, (af, addr) in enumerate(target_addrs):
event = Event()
tg.start_soon(try_connect, addr, event)
with move_on_after(happy_eyeballs_delay):
await event.wait()

if connected_stream is None:
cause = (
oserrors[0]
if len(oserrors) == 1
else ExceptionGroup("multiple connection attempts failed", oserrors)
)
raise OSError("All connection attempts failed") from cause
finally:
oserrors = []

if tls or tls_hostname or ssl_context:
try:
Expand Down
51 changes: 51 additions & 0 deletions tests/test_sockets.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
from threading import Thread
from typing import TYPE_CHECKING, Any, Literal, NoReturn, TypeVar, cast

import ephemeral_port_reserve
import psutil
import pytest
from _pytest.fixtures import SubRequest
Expand All @@ -43,6 +44,7 @@
create_unix_datagram_socket,
create_unix_listener,
fail_after,
get_current_task,
getaddrinfo,
getnameinfo,
move_on_after,
Expand All @@ -58,6 +60,7 @@
SocketAttribute,
SocketListener,
SocketStream,
TaskStatus,
)
from anyio.lowlevel import checkpoint
from anyio.streams.stapled import MultiListener
Expand Down Expand Up @@ -133,6 +136,31 @@ def check_asyncio_bug(anyio_backend_name: str, family: AnyIPAddressFamily) -> No
pytest.skip("Does not work due to a known bug (39148)")


if sys.version_info >= (3, 14):

async def no_other_refs() -> list[object]:
Copy link
Owner

Choose a reason for hiding this comment

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

We don't really need to duplicate this from test_taskgroups.py, do we? Why not just move it to a utility module in the test suite, or something?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I could put it in conftest.py ? happy to have a utils.py

Copy link
Owner

Choose a reason for hiding this comment

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

I've usually gone with a utils.py in the test suite. So long as it's structured as a package (which it is in anyio's case), it works fine.

frame = sys._getframe(1)
coro = get_current_task().coro

async def get_coro_for_frame(*, task_status: TaskStatus[object]) -> None:
my_coro = coro
while my_coro.cr_frame is not frame:
my_coro = my_coro.cr_await
task_status.started(my_coro)

async with create_task_group() as tg:
return [await tg.start(get_coro_for_frame)]

elif sys.version_info >= (3, 11):

async def no_other_refs() -> list[object]:
return []
else:

async def no_other_refs() -> list[object]:
return [sys._getframe(1)]


_T = TypeVar("_T")


Expand Down Expand Up @@ -315,6 +343,29 @@ def serve() -> None:
server_sock.close()
assert client_addr[0] == expected_client_addr

@pytest.mark.skipif(
sys.implementation.name == "pypy",
reason=(
"gc.get_referrers is broken on PyPy see "
"https://github.com/pypy/pypy/issues/5075"
),
)
async def test_happy_eyeballs_refcycles(self) -> None:
"""
Test derived from https://github.com/python/cpython/pull/124859
"""
ip = "127.0.0.1"
port = ephemeral_port_reserve.reserve(ip=ip)
Copy link
Owner

Choose a reason for hiding this comment

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

We have plenty of tests that need ephemeral ports. Why do we have to add a new test dependency for this specific test? (I'd be happy to add such a fixture to anyio's pytest plugin though!)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oh is there already a tool for this? I'll have a look

Copy link
Owner

Choose a reason for hiding this comment

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

I didn't say there was a tool yet (that's what my suggestion in parentheses was about). Rather, we currently do this in a rather manual fashion.

exc = None
try:
async with await connect_tcp(ip, port):
pass
except OSError as e:
exc = e.__cause__

assert isinstance(exc, OSError)
assert gc.get_referrers(exc) == await no_other_refs()

@pytest.mark.parametrize(
"target, exception_class",
[
Expand Down
Loading