Add support for socket options #668

karpetrosyan · 2023-04-12T10:31:11Z

Closes #662

karpetrosyan · 2023-04-12T10:39:53Z

httpcore/backends/sync.py

+]
+
+
+def create_connection(


This function is very similar to the built-in create_connection function, but it can also accept socket options.
We can't set socket options after a connection has been made because some options affect the connection itself, so we must set them before the connection was made.

Okay, I'd suggest we add a comment noting that.

Perhaps rephrased to "This function is equivalent to Python's socket.create_connection() function, but also accepts socket options." and linking to the source on GitHub?

karpetrosyan · 2023-04-12T10:58:37Z

If we want to support socket options for async interfaces, we need to change a lot of things. Currently, the 'get_asynclib' function is used to get a specific backend interface provided by anyio, then the "connect_tcp" and "connect_unix" asynchronous functions of that module are used to create a connection; how can we override these methods while keeping it as simple as possible?

karpetrosyan · 2023-04-12T11:22:00Z

As a simple solution, we can associate each library with its function and then call that function.

Old

async def connect_unix(path: Union[str, "PathLike[str]"]) -> UNIXSocketStream:
    path = str(Path(path))
    return await get_asynclib().connect_unix(path)

New

async def connect_unix(path: Union[str, "PathLike[str]"]) -> UNIXSocketStream:
    path = str(Path(path))
    library = sniffio.current_async_library()
    map = {
        "trio": trio_connect_tcp,
        "asyncio": asyncio_connect_tcp,
    }
    return map[library](path)

tomchristie · 2023-04-18T10:48:48Z

If we want to support socket options for async interfaces, we need to change a lot of things. Currently, the 'get_asynclib' function is used to get a specific backend interface provided by anyio, then the "connect_tcp" and "connect_unix" asynchronous functions of that module are used to create a connection

It took me a little while to track down what you're referring to here.

how can we override these methods while keeping it as simple as possible?

We'd need to work this through on a case-by-case basis.

The three cases to cover are sync, trio, and asyncio via anyio.

We'd want the PR to start by adapting each of...

httpcore/backends/sync.py
httpcore/backends/trio.py
httpcore/backends/asyncio.py

...and then work through from there.

Let's link to each of these here so it's easier to review how we'd handle this...

httpcore/httpcore/backends/sync.py

Lines 94 to 96 in 82466e1

    
           sock = socket.create_connection( 
        
               address, timeout, source_address=source_address 
        
           )

httpcore/httpcore/backends/trio.py

Lines 127 to 129 in 82466e1

    
           stream: trio.abc.Stream = await trio.open_tcp_stream( 
        
               host=host, port=port, local_address=local_address 
        
           )

httpcore/httpcore/backends/asyncio.py

Lines 111 to 115 in 82466e1

    
           stream: anyio.abc.ByteStream = await anyio.connect_tcp( 
        
               remote_host=host, 
        
               remote_port=port, 
        
               local_host=local_address, 
        
           )

You've already demonstrated how we'd adapt the sync case.

The trio case would require less duplication to resolve if python-trio/trio#281 was addressed, but otherwise needs their connect_tcp() function to be duplicated.

I think you're pointing out that the asyncio-via-anyio case is actually really awkward to resolve. And yes, that looks correct to me. It does look like duplicating the anyio connect_tcp implementation would be a bit awkward.

🤔

tomchristie · 2023-04-18T10:57:02Z

Related, and possibly helpful here - it might be worthwhile taking a look at what aiohttp use for their connect_tcp implementation.

karpetrosyan · 2023-04-18T12:34:43Z

There is an elegant solution, which is to ignore the socket option, which affects the connect method itself.

Our issue is that the socket bind and connect methods behave differently depending on socket options, such as socket.SO_REUSEADDR can help us in connecting to a socket that was previously force closed and is now waiting 1-2 minutes for the socket to be released.

That is very fun, but trio does not support local address binding...

There is also REUSEPORT, which allows you to listen to an IP port pair with multiple sockets, but it is far from httpcore because httpcore is a client library and does not support REUSEPORT at all.

I looked for options that affect bind and connect methods and that httpcore or httpx users can use in their applications, but I couldn't find anything.

I believe it is better to ignore such options and set options after the backend library has been created a connection.
This solution avoids code duplication while keeping code as simple as possible.

This is how the updated function could look.

class Backend(AsyncNetworkBackend):
    async def connect_tcp(
         ...,
         socket_options
    ):
        ...
        stream = await backend.connect_tcp(
                    remote_host=host,
                    remote_port=port,
                    local_host=local_address,
                )
        for option in socket_options:
             stream._socket.setsockopt(*option)
        return AsyncIOStream(stream)

@tomchristie what are you think about this solution?

karpetrosyan · 2023-04-18T12:40:33Z

Also, because we don't need options affecting bind or connect, we can use socket.create_connection instead of our newly created one to avoid code duplication

tomchristie · 2023-04-18T12:44:55Z

Okay, setting socket options after the connect is probably(?) okay for our use-case.

For the async case I'd suggest we push the implementation into httpcore/backends/trio.py and
httpcore/backends/asyncio.py, with httpcore/backends/auto.py calling through to them.

…icated one

tomchristie

Looking good.

Let's also...

Add this to the CHANGELOG.
Include an update in the connection pool config docs

tomchristie · 2023-05-19T13:30:32Z

We should also take a call on if we really do want this, or if what we actually need is just a better default for the sync backed so that it includes TCP_NODELAY.

See #651 (comment)

karpetrosyan · 2023-05-20T05:58:36Z

We should also take a call on if we really do want this, or if what we actually need is just a better default for the sync backed so that it includes TCP_NODELAY.

See #651 (comment)

I think we should make TCP_NODELAY the default, but also make socket options configurable; there are many options in unix sockets that developers can use, and this can be a powerful feature for developers who know what they're doing.

Additionally, fixing encode/httpx#2635 requires these configurable sockets. which initially inspired me to open this PR :D

tomchristie · 2023-05-22T10:10:50Z

httpcore/_sync/connection_pool.py

@@ -109,6 +110,7 @@ def __init__(
        self._network_backend = (
            SyncBackend() if network_backend is None else network_backend
        )
+        self._socket_options = () if socket_options is None else socket_options


Suggested change

self._socket_options = () if socket_options is None else socket_options

self._socket_options = socket_options

it looks to me like we should leave self._socket_options as optional throughout.

Should we always make sure to check if socket_options is not None before using it?

It would make sense for us to do the if socket_options is None dance at the last possible point, in the network backends.

tomchristie · 2023-05-22T10:11:31Z

httpcore/_sync/connection.py

@@ -54,6 +55,7 @@ def __init__(
        self._connection: Optional[ConnectionInterface] = None
        self._connect_failed: bool = False
        self._request_lock = Lock()
+        self._socket_options = () if socket_options is None else socket_options


Suggested change

self._socket_options = () if socket_options is None else socket_options

self._socket_options = socket_options

let's keep this optional just now.

tomchristie · 2023-05-22T10:53:17Z

tests/_sync/test_connection_pool.py

@@ -187,7 +187,7 @@ def test_debug_request(caplog):
        (
            "httpcore.connection",
            logging.DEBUG,
-            "connect_tcp.started host='example.com' port=80 local_address=None timeout=None socket_options=()",
+            "connect_tcp.started host='example.com' port=80 local_address=None timeout=None socket_options=None",


👍 yes, this is better.

…docstring

tomchristie · 2023-05-22T11:44:18Z

docs/connection-pools.md

@@ -79,6 +79,7 @@ The connection pool instance is also the main point of configuration. Let's take
                   a particular address family. Using `local_address="0.0.0.0"` will
                   connect using an `AF_INET` address (IPv4), while using `local_address="::"`
                   will connect using an `AF_INET6` address (IPv6).
+* `socket_options`: Socket options that have to be included in the TCP socket when the connection was established.


let's be consistent with our placement of socket_options in the list, so that the docs match the code.

tomchristie

Looks good, yeah.

I've included some possible comments here. (?)

httpcore/backends/asyncio.py

httpcore/backends/sync.py

httpcore/backends/trio.py

Co-authored-by: Tom Christie <tom@tomchristie.com>

Add support for socket options

889c99e

karpetrosyan commented Apr 12, 2023

View reviewed changes

Merge branch 'master' into master

3dc8bda

karpetrosyan added 5 commits April 18, 2023 17:18

Use the built-in socket.create_connection method rather than the dupl…

2b91aef

…icated one

Add socket options support for async backend

52572b3

Add socket options support for connect_unix_socket function

9052db4

Add socket options for ConnectionPool and HTTProxy classes

ba607f2

Merge branch 'master' of github.com:encode/httpcore

6528f56

tomchristie reviewed May 19, 2023

View reviewed changes

tomchristie added the enhancement New feature or request label May 19, 2023

tomchristie mentioned this pull request May 19, 2023

Enable TCP_NODELAY for all synchronous sockets. #651

Merged

karpetrosyan added 2 commits May 22, 2023 12:03

Merge branch 'master' of https://github.com/encode/httpcore

71bfdb2

Add socket_options to CHANGELOG.md and connection-pools.md

149a17c

tomchristie reviewed May 22, 2023

View reviewed changes

Make socket_options optional for HTTPConnection and ConnectionPool

29072a8

tomchristie reviewed May 22, 2023

View reviewed changes

karpetrosyan added 3 commits May 22, 2023 14:34

Add socket_options to ConnectionPool and \'AsyncConnectionPool\' …

e40b7dd

…docstring

Typo

143ec83

Fix linting

3694ee3

tomchristie reviewed May 22, 2023

View reviewed changes

karpetrosyan and others added 5 commits May 22, 2023 15:26

Fix options order

8518eb0

Merge branch 'master' into master

1cb9803

Typo

866a08e

Merge branch 'master' of github.com:karosis88/httpcore

0b334f0

Merge branch 'master' into master

c60f303

tomchristie approved these changes May 23, 2023

View reviewed changes

httpcore/backends/asyncio.py Show resolved Hide resolved

httpcore/backends/sync.py Show resolved Hide resolved

httpcore/backends/trio.py Show resolved Hide resolved

karpetrosyan and others added 3 commits May 23, 2023 12:13

Update httpcore/backends/trio.py

dda9578

Co-authored-by: Tom Christie <tom@tomchristie.com>

Update httpcore/backends/sync.py

9337eee

Co-authored-by: Tom Christie <tom@tomchristie.com>

Update httpcore/backends/asyncio.py

8cf32b7

Co-authored-by: Tom Christie <tom@tomchristie.com>

karpetrosyan merged commit 93d7804 into encode:master May 23, 2023

tomchristie mentioned this pull request May 23, 2023

Version 0.17.2 #697

Merged

Bibo-Joshi mentioned this pull request Sep 25, 2023

[FEATURE] Set SocketOpts python-telegram-bot/python-telegram-bot#2965

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for socket options #668

Add support for socket options #668

karpetrosyan commented Apr 12, 2023 •

edited by tomchristie

Loading

karpetrosyan Apr 12, 2023 •

edited

Loading

tomchristie Apr 18, 2023

karpetrosyan commented Apr 12, 2023 •

edited

Loading

karpetrosyan commented Apr 12, 2023

tomchristie commented Apr 18, 2023 •

edited

Loading

tomchristie commented Apr 18, 2023

karpetrosyan commented Apr 18, 2023 •

edited

Loading

karpetrosyan commented Apr 18, 2023

tomchristie commented Apr 18, 2023

tomchristie left a comment

tomchristie commented May 19, 2023

karpetrosyan commented May 20, 2023

tomchristie May 22, 2023

karpetrosyan May 22, 2023

tomchristie May 22, 2023

tomchristie May 22, 2023

tomchristie May 22, 2023

tomchristie May 22, 2023

tomchristie left a comment

	self._socket_options = () if socket_options is None else socket_options
	self._socket_options = socket_options

Add support for socket options #668

Add support for socket options #668

Conversation

karpetrosyan commented Apr 12, 2023 • edited by tomchristie Loading

karpetrosyan Apr 12, 2023 • edited Loading

Choose a reason for hiding this comment

tomchristie Apr 18, 2023

Choose a reason for hiding this comment

karpetrosyan commented Apr 12, 2023 • edited Loading

karpetrosyan commented Apr 12, 2023

tomchristie commented Apr 18, 2023 • edited Loading

tomchristie commented Apr 18, 2023

karpetrosyan commented Apr 18, 2023 • edited Loading

karpetrosyan commented Apr 18, 2023

tomchristie commented Apr 18, 2023

tomchristie left a comment

Choose a reason for hiding this comment

tomchristie commented May 19, 2023

karpetrosyan commented May 20, 2023

tomchristie May 22, 2023

Choose a reason for hiding this comment

karpetrosyan May 22, 2023

Choose a reason for hiding this comment

tomchristie May 22, 2023

Choose a reason for hiding this comment

tomchristie May 22, 2023

Choose a reason for hiding this comment

tomchristie May 22, 2023

Choose a reason for hiding this comment

tomchristie May 22, 2023

Choose a reason for hiding this comment

tomchristie left a comment

Choose a reason for hiding this comment

karpetrosyan commented Apr 12, 2023 •

edited by tomchristie

Loading

karpetrosyan Apr 12, 2023 •

edited

Loading

karpetrosyan commented Apr 12, 2023 •

edited

Loading

tomchristie commented Apr 18, 2023 •

edited

Loading

karpetrosyan commented Apr 18, 2023 •

edited

Loading