Support http over unix domain sockets #392
Conversation
src/unix_socket.rs
Outdated
|
|
||
| pub fn execute(&self, request: Request) -> Result<Response> { | ||
| self.rt.block_on(async { | ||
| // TODO: Support named pipes by replacing tokio::net::UnixStream::connect(..) with: |
There was a problem hiding this comment.
Besides Docker for Window, I couldn't find any other examples of HTTP over named pipes, so I'm not sure if it's worth supporting at this time.
src/main.rs
Outdated
| #[cfg(target_family = "unix")] | ||
| if let Some(unix_socket) = args.unix_socket { |
There was a problem hiding this comment.
There is a fork of hyperlocal that adds support for windows but it might be better to wait until it is merged upstream
src/unix_socket.rs
Outdated
| } | ||
| }); | ||
|
|
||
| // TODO: don't ignore value from --timeout option |
There was a problem hiding this comment.
Regardless of how this is handled, I need to ensure the correct exit code is used for timeout errors
There was a problem hiding this comment.
Note to self: refer to impl<B> hyper::body::Body for TotalTimeoutBody<B> for how to implement timeout for body.
Also, we should consider moving to a combination of connect_timeout and read_timeout which is closer to how it is handled in python requests/HTTPie. See https://requests.readthedocs.io/en/stable/user/advanced/#timeouts
There was a problem hiding this comment.
Hmm, it seems read_timeout is not yet implemented for reqwest::blocking::Client
src/cli.rs
Outdated
| @@ -347,6 +347,12 @@ Example: --print=Hb" | |||
| #[clap(short = '6', long)] | |||
| pub ipv6: bool, | |||
|
|
|||
| /// Connect using a Unix domain socket. | |||
| /// | |||
| /// Example: --unix_socket=/var/run/temp.sock | |||
There was a problem hiding this comment.
With this API you still have to make up a hostname for the URL, like curl, and unlike got and the HTTPie plugin.
AFAICT the typical use cases are for local services and not for proxies, meaning that the hostname is superfluous. But it also doesn't look like we're going to get a URL-based convention for this any time soon. And splitting it off into an option prevents redirect attacks. (Not sure how it should interact with sessions though... we need to look carefully at other areas of interference.)
A full command with the : shorthand might help users, e.g.
xh :/index.html --unix-socket=/var/run/temp.sock
There was a problem hiding this comment.
There is a good chance that unix domain sockets will be treated as a proxy in reqwest. This has the advantage that anything relying on hostname like cookies and Host header will keep working. Also, see denoland/deno#8821 (comment)
However, I still think we can support xh http://unix:/var/run/docker.sock:/containers/json by treating it as a syntactic sugar for xh :/containers/json --unix-socket=/var/run/docker.sock.
There was a problem hiding this comment.
We can always add syntactic sugar later. Right now there doesn't seem to be any consensus about the URL format.
If it ever gets to the point where browsers start supporting UDS URLs (as a non-experimental feature) then we should follow suit.
src/unix_socket.rs
Outdated
| let starting_time = Instant::now(); | ||
| let mut response = self.execute(request)?; | ||
| response.extensions_mut().insert(ResponseMeta { | ||
| request_duration: starting_time.elapsed(), | ||
| content_download_duration: None, | ||
| }); |
There was a problem hiding this comment.
Don't we skip any subsequent middleware this way? I don't understand this yet but it might be the wrong layer to do it.
There was a problem hiding this comment.
It is the last layer, but returning early and short-circuiting middlewares in this way might be confusing, not to mention the duplicated logic. Let me see if I can switch between UnixSocket and reqwest client inside ClientWithMiddleware.
the former is not yet supported in blocking client
Adds a
--unix-socketoption similar to cURL for binding to a Unix domain socket. When used, all requests, including redirects, will go through the specified Unix socket.Resources used:
Resolves #230