JuliaWeb/HTTP.jl

Support for domain sockets

Closed

#607 opened on Oct 27, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Julia (182 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (679 stars)
PR merge metrics
 (Avg merge 2d 5h) (40 merged PRs in 30d)

Description

I was trying to communicate with a local domain socket that accepts HTTP, which I'm currently doing like so:

docker = connect("/var/run/docker.sock")
write(docker, """
    GET /info HTTP/1.1
    Host: localhost
    Accept: application/json


    """)
@show read(docker, String)
close(docker)

That doesn't really work with HTTP.jl right now, the connection layer doesn't support these sockets, and there isn't a way to separate the path to the socket from the path to request. One interesting approach by https://github.com/msabramo/requests-unixsocket is using the following URI format: http+unix://%2Fvar%2Frun%2Fdocker.sock/info.

Contributor guide

Research direction
Review the issue discussion and the current HTTP.jl connection layer (likely in src/connection.jl or similar). Investigate the URI format proposal 'http+unix://%2Fvar%2Frun%2Fdocker.sock/info' and how similar libraries implement support for domain sockets. Check the linked PRs or comments for any prior attempts. After understanding the architecture, propose a design for extending the connection layer to handle unix sockets and implementing the custom URI scheme.
Tech stack
None
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Understanding of HTTP protocolKnowledge of Unix domain socketsFamiliarity with Julia's HTTP.jl library
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40