Merge pull request #202 from gfanton/dev/uds-support

Add Unix Domain Socket support to Shell client

Author: Stebalien

.travis.yml

@@ -4,7 +4,7 @@ os:
 language: go
 
 go:
-  - 1.11.x
+  - 1.13.x
 
 services:
   - docker

go.mod

@@ -1,3 +1,5 @@
+go 1.13
+
 module github.com/ipfs/go-ipfs-api
 
 require (

shell.go

@@ -9,6 +9,7 @@ import (
 	"fmt"
 	"io"
 	"io/ioutil"
+	"net"
 	gohttp "net/http"
 	"os"
 	"path"
@@ -72,20 +73,51 @@ func NewShell(url string) *Shell {
 	return NewShellWithClient(url, c)
 }
 
-func NewShellWithClient(url string, c *gohttp.Client) *Shell {
-	if a, err := ma.NewMultiaddr(url); err == nil {
-		_, host, err := manet.DialArgs(a)
-		if err == nil {
-			url = host
-		}
-	}
+func NewShellWithClient(url string, client *gohttp.Client) *Shell {
 	var sh Shell
+
 	sh.url = url
-	sh.httpcli = *c
+	sh.httpcli = *client
 	// We don't support redirects.
 	sh.httpcli.CheckRedirect = func(_ *gohttp.Request, _ []*gohttp.Request) error {
 		return fmt.Errorf("unexpected redirect")
 	}
+
+	maddr, err := ma.NewMultiaddr(url)
+	if err != nil {
+		return &sh
+	}
+
+	network, host, err := manet.DialArgs(maddr)
+	if err != nil {
+		return &sh
+	}
+
+	if network == "unix" {
+		sh.url = network
+
+		var tptCopy *gohttp.Transport
+		if tpt, ok := sh.httpcli.Transport.(*gohttp.Transport); ok && tpt.DialContext == nil {
+			tptCopy = tpt.Clone()
+		} else if sh.httpcli.Transport == nil {
+			tptCopy = &gohttp.Transport{
+				Proxy:             gohttp.ProxyFromEnvironment,
+				DisableKeepAlives: true,
+			}
+		} else {
+			// custom Transport or custom Dialer, we are done here
+			return &sh
+		}
+
+		tptCopy.DialContext = func(_ context.Context, _, _ string) (net.Conn, error) {
+			return net.Dial("unix", host)
+		}
+
+		sh.httpcli.Transport = tptCopy
+	} else {
+		sh.url = host
+	}
+
 	return &sh
 }
 

shell_test.go

@@ -1,12 +1,18 @@
 package shell
 
 import (
+	"bufio"
 	"bytes"
 	"context"
 	"crypto/md5"
 	"fmt"
 	"io"
+	"io/ioutil"
 	"math/rand"
+	"net"
+	"net/http"
+	"os"
+	"path/filepath"
 	"sort"
 	"strings"
 	"testing"
@@ -361,6 +367,45 @@ func TestSwarmPeers(t *testing.T) {
 	is.Nil(err)
 }
 
+// TestNewShellWithUnixSocket only check that http client is well configured to
+// perform http request on unix socket address
+func TestNewShellWithUnixSocket(t *testing.T) {
+	is := is.New(t)
+
+	// setup uds temporary dir
+	path, err := ioutil.TempDir("", "uds-test")
+	is.Nil(err)
+
+	defer os.RemoveAll(path)
+
+	// listen on sock path
+	sockpath := filepath.Join(path, "sock")
+	lsock, err := net.Listen("unix", sockpath)
+	is.Nil(err)
+
+	defer lsock.Close()
+
+	// handle simple `hello` route
+	mux := http.NewServeMux()
+	mux.HandleFunc("/api/v0/hello", func(w http.ResponseWriter, _ *http.Request) {
+		fmt.Fprint(w, "Hello World\n")
+	})
+
+	go http.Serve(lsock, mux)
+
+	// create shell with "/unix/<sockpath>" multiaddr
+	shell := NewShell("/unix/" + sockpath)
+	res, err := shell.Request("hello").Send(context.Background())
+	is.Nil(err)
+
+	defer res.Output.Close()
+
+	// read hello world from body
+	str, err := bufio.NewReader(res.Output).ReadString('\n')
+	is.Nil(err)
+	is.Equal(str, "Hello World\n")
+}
+
 const letterBytes = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
 const (
 	letterIdxBits = 6                    // 6 bits to represent a letter index