Implement with transport cloning option

rosylilly · rosylilly · commit f19f0004a82d · 2021-09-15T18:08:27.000+09:00
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ isucandar は [ISUCON](http://isucon.net/) などの負荷試験で使える機
 // NewAgent の引数には可変長で func(*Agent) error な関数を渡せます。
 // その中で Agent の初期設定を完了させてください。
 // 簡易につかえるように、いくつかの AgentOption を返す関数が用意されています。
-agent, err := NewAgent(WithBaseURL("http://isucon.net"))
+agent, err := NewAgent(WithBaseURL("http://isucon.net"), WithDefaultTransport())
 
 // 通常の http.NewRequest のように呼び出せます。
 req, err := agent.NewRequest(http.MethodGet, "/", nil)
@@ -52,10 +52,18 @@ resources, err := agent.ProcessHTML(context.TODO(), req, req.Body)
 // Agent は CacheStore を持ち、それを利用してブラウザに似せた Conditinal GET や、
 // キャッシュを利用して、メモリからレスポンスを復元したりします。
 // もし Cache が必要ないようであれば、 WithNoCache() を NewAgent の引数へ渡してください。
-agent, _ := NewAgent(WithNoCache())
+agent, _ := NewAgent(WithNoCache(), WithDefaultTransport())
 
 // また、なんらかの理由でキャッシュをクリアしたくなった場合は agent.CacheStore.Clear() で削除できます。
 agent.CacheStore.Clear()
+
+//// Transport
+// Agent は HTTPClient とその Transport を持ちます。
+// TCP 接続単位で共有を拒否したい場合は WithCloneTransport(DefaultTransport) などを利用し、
+// 接続が共有されても構わない場合は WithDefatultTransport() を利用してください。
+agent, _ := NewAgent(WithDefaultTransport())
+// or
+agent, _ := NewAgent(WithCloneTransport(DefaultTransport));
 ```
 
 #### 補足
diff --git a/agent/agent.go b/agent/agent.go
@@ -3,6 +3,7 @@ package agent
 import (
 	"context"
 	"crypto/tls"
+	"errors"
 	"io"
 	"net"
 	"net/http"
@@ -26,6 +27,10 @@ var (
 	DefaultTransport *http.Transport
 )
 
+var (
+	ErrTransportInvalid = errors.New("Specify transport option(WithCloneTransport or WithDefaultTransport)")
+)
+
 func init() {
 	DefaultDialer = &net.Dialer{
 		Timeout:   0,
@@ -70,7 +75,7 @@ func NewAgent(opts ...AgentOption) (*Agent, error) {
 		CacheStore:    NewCacheStore(),
 		HttpClient: &http.Client{
 			CheckRedirect: useLastResponse,
-			Transport:     DefaultTransport,
+			Transport:     nil,
 			Jar:           jar,
 			Timeout:       DefaultRequestTimeout,
 		},
@@ -82,6 +87,10 @@ func NewAgent(opts ...AgentOption) (*Agent, error) {
 		}
 	}
 
+	if agent.HttpClient.Transport == nil {
+		return nil, ErrTransportInvalid
+	}
+
 	return agent, nil
 }
 
diff --git a/agent/agent_test.go b/agent/agent_test.go
@@ -58,13 +58,13 @@ func TestAgent(t *testing.T) {
 }
 
 func TestAgentClearCookie(t *testing.T) {
-	agent, err := NewAgent(WithBaseURL("http://example.com/"))
+	agent, err := NewAgent(WithBaseURL("http://example.com/"), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
 
 	agent.HttpClient.Jar.SetCookies(agent.BaseURL, []*http.Cookie{
-		&http.Cookie{},
+		{},
 	})
 	if len(agent.HttpClient.Jar.Cookies(agent.BaseURL)) != 1 {
 		t.Fatal("Set cookie failed")
@@ -76,7 +76,7 @@ func TestAgentClearCookie(t *testing.T) {
 }
 
 func TestAgentNewRequest(t *testing.T) {
-	agent, err := NewAgent()
+	agent, err := NewAgent(WithDefaultTransport())
 	if err != nil {
 		t.Fatalf("%+v", err)
 	}
@@ -96,7 +96,7 @@ func TestAgentRequest(t *testing.T) {
 	srv := newHTTPServer()
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatalf("%+v", err)
 	}
@@ -120,7 +120,7 @@ func TestAgentRequest(t *testing.T) {
 }
 
 func TestAgentMethods(t *testing.T) {
-	agent, err := NewAgent()
+	agent, err := NewAgent(WithDefaultTransport())
 	if err != nil {
 		t.Fatalf("%+v", err)
 	}
diff --git a/agent/cache_test.go b/agent/cache_test.go
@@ -42,7 +42,7 @@ func TestCacheCondition(t *testing.T) {
 	}))
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -96,7 +96,7 @@ func TestCacheWithLastModified(t *testing.T) {
 	}))
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -165,7 +165,7 @@ func TestCacheWithETag(t *testing.T) {
 	}))
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -239,7 +239,7 @@ func TestCacheWithMaxAge(t *testing.T) {
 	}))
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -285,7 +285,7 @@ func TestCacheWithExpires(t *testing.T) {
 	}))
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -331,7 +331,7 @@ func TestCacheWithVary(t *testing.T) {
 	}))
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -369,7 +369,7 @@ func TestCacheWithClear(t *testing.T) {
 	}))
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -393,7 +393,7 @@ func BenchmarkCacheWithMaxAge(b *testing.B) {
 	}))
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		b.Fatal(err)
 	}
diff --git a/agent/decompress_test.go b/agent/decompress_test.go
@@ -91,7 +91,7 @@ func TestBrotliResponse(t *testing.T) {
 	srv := newCompressHTTPServer()
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatalf("%+v", err)
 	}
@@ -134,7 +134,7 @@ func TestGzipResponse(t *testing.T) {
 	srv := newCompressHTTPServer()
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatalf("%+v", err)
 	}
@@ -178,7 +178,7 @@ func TestDeflateResponse(t *testing.T) {
 	srv := newCompressHTTPServer()
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatalf("%+v", err)
 	}
@@ -228,7 +228,7 @@ func TestWithEcho(t *testing.T) {
 	srv := httptest.NewServer(e)
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatalf("%+v", err)
 	}
diff --git a/agent/html_test.go b/agent/html_test.go
@@ -49,7 +49,7 @@ func TestHTMLParse(t *testing.T) {
 	}))
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -65,7 +65,7 @@ func TestHTMLParse(t *testing.T) {
 	}
 
 	if len(resources) != 12 {
-		for k, _ := range resources {
+		for k := range resources {
 			t.Log(k)
 		}
 		t.Fatalf("resouces count missmatch: %d", len(resources))
@@ -101,7 +101,7 @@ func BenchmarkHTMLParse(b *testing.B) {
 	}))
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		b.Fatal(err)
 	}
@@ -118,7 +118,7 @@ func BenchmarkHTMLParse(b *testing.B) {
 		}
 
 		if len(resources) != 12 {
-			for k, _ := range resources {
+			for k := range resources {
 				b.Log(k)
 			}
 			b.Fatalf("resouces count missmatch: %d", len(resources))
@@ -163,7 +163,7 @@ func TestFavicon(t *testing.T) {
 	}))
 	defer srv.Close()
 
-	agent, err := NewAgent(WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
diff --git a/agent/option.go b/agent/option.go
@@ -1,6 +1,7 @@
 package agent
 
 import (
+	"net/http"
 	"net/url"
 	"time"
 )
@@ -40,3 +41,19 @@ func WithTimeout(d time.Duration) AgentOption {
 		return nil
 	}
 }
+
+func WithDefaultTransport() AgentOption {
+	return func(a *Agent) error {
+		a.HttpClient.Transport = DefaultTransport
+
+		return nil
+	}
+}
+
+func WithCloneTransport(trs *http.Transport) AgentOption {
+	return func(a *Agent) error {
+		a.HttpClient.Transport = trs.Clone()
+
+		return nil
+	}
+}
diff --git a/agent/option_test.go b/agent/option_test.go
@@ -9,10 +9,11 @@ import (
 	"time"
 
 	"github.com/isucon/isucandar/failure"
+	"github.com/stretchr/testify/assert"
 )
 
 func TestNoCookie(t *testing.T) {
-	agent, err := NewAgent(WithNoCookie())
+	agent, err := NewAgent(WithNoCookie(), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -23,7 +24,7 @@ func TestNoCookie(t *testing.T) {
 }
 
 func TestNoCache(t *testing.T) {
-	agent, err := NewAgent(WithNoCache())
+	agent, err := NewAgent(WithNoCache(), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -34,7 +35,7 @@ func TestNoCache(t *testing.T) {
 }
 
 func TestUserAgent(t *testing.T) {
-	agent, err := NewAgent(WithUserAgent("Hello"))
+	agent, err := NewAgent(WithUserAgent("Hello"), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -45,7 +46,7 @@ func TestUserAgent(t *testing.T) {
 }
 
 func TestBaseURL(t *testing.T) {
-	agent, err := NewAgent(WithBaseURL("http://base.example.com"))
+	agent, err := NewAgent(WithBaseURL("http://base.example.com"), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -67,7 +68,7 @@ func TestTimeout(t *testing.T) {
 		go srv.Close()
 	}()
 
-	agent, err := NewAgent(WithTimeout(1*time.Microsecond), WithBaseURL(srv.URL))
+	agent, err := NewAgent(WithTimeout(1*time.Microsecond), WithBaseURL(srv.URL), WithDefaultTransport())
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -78,3 +79,39 @@ func TestTimeout(t *testing.T) {
 		t.Fatalf("expected timeout error: %+v", err)
 	}
 }
+
+func TestWithoutTransport(t *testing.T) {
+	_, err := NewAgent()
+	assert.NotNil(t, err)
+	if err != nil {
+		assert.Same(t, ErrTransportInvalid, err)
+	}
+}
+
+func TestDefaultTransport(t *testing.T) {
+	agent1, err := NewAgent(WithDefaultTransport())
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	agent2, err := NewAgent(WithDefaultTransport())
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	assert.Same(t, agent1.HttpClient.Transport, agent2.HttpClient.Transport)
+}
+
+func TestCloneTransport(t *testing.T) {
+	agent1, err := NewAgent(WithCloneTransport(DefaultTransport))
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	agent2, err := NewAgent(WithCloneTransport(DefaultTransport))
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	assert.NotSame(t, agent1.HttpClient.Transport, agent2.HttpClient.Transport)
+}
diff --git a/demo/agent/main.go b/demo/agent/main.go
@@ -11,7 +11,7 @@ func main() {
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
 
-	agent, err := agent.NewAgent(agent.WithBaseURL("https://github.com/"))
+	agent, err := agent.NewAgent(agent.WithDefaultTransport(), agent.WithBaseURL("https://github.com/"))
 	if err != nil {
 		panic(err)
 	}
diff --git a/go.mod b/go.mod
@@ -10,6 +10,7 @@ require (
 	github.com/labstack/echo v3.3.10+incompatible
 	github.com/labstack/gommon v0.3.0 // indirect
 	github.com/pquerna/cachecontrol v0.0.0-20200819021114-67c6ae64274f
+	github.com/stretchr/testify v1.7.0
 	golang.org/x/net v0.0.0-20200904194848-62affa334b73
 	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1
 )
diff --git a/go.sum b/go.sum

Original file line number	Diff line number	Diff line change
`@@ -58,13 +58,13 @@ func TestAgent(t *testing.T) {`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`func TestAgentClearCookie(t *testing.T) {`
`61`		`- agent, err := NewAgent(WithBaseURL("http://example.com/"))`
	`61`	`+ agent, err := NewAgent(WithBaseURL("http://example.com/"), WithDefaultTransport())`
`62`	`62`	`if err != nil {`
`63`	`63`	`t.Fatal(err)`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`agent.HttpClient.Jar.SetCookies(agent.BaseURL, []*http.Cookie{`
`67`		`- &http.Cookie{},`
	`67`	`+ {},`
`68`	`68`	`})`
`69`	`69`	`if len(agent.HttpClient.Jar.Cookies(agent.BaseURL)) != 1 {`
`70`	`70`	`t.Fatal("Set cookie failed")`
`@@ -76,7 +76,7 @@ func TestAgentClearCookie(t *testing.T) {`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`func TestAgentNewRequest(t *testing.T) {`
`79`		`- agent, err := NewAgent()`
	`79`	`+ agent, err := NewAgent(WithDefaultTransport())`
`80`	`80`	`if err != nil {`
`81`	`81`	`t.Fatalf("%+v", err)`
`82`	`82`	`}`
`@@ -96,7 +96,7 @@ func TestAgentRequest(t *testing.T) {`
`96`	`96`	`srv := newHTTPServer()`
`97`	`97`	`defer srv.Close()`
`98`	`98`
`99`		`- agent, err := NewAgent(WithBaseURL(srv.URL))`
	`99`	`+ agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())`
`100`	`100`	`if err != nil {`
`101`	`101`	`t.Fatalf("%+v", err)`
`102`	`102`	`}`
`@@ -120,7 +120,7 @@ func TestAgentRequest(t *testing.T) {`
`120`	`120`	`}`
`121`	`121`
`122`	`122`	`func TestAgentMethods(t *testing.T) {`
`123`		`- agent, err := NewAgent()`
	`123`	`+ agent, err := NewAgent(WithDefaultTransport())`
`124`	`124`	`if err != nil {`
`125`	`125`	`t.Fatalf("%+v", err)`
`126`	`126`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ func TestHTMLParse(t *testing.T) {`
`49`	`49`	`}))`
`50`	`50`	`defer srv.Close()`
`51`	`51`
`52`		`- agent, err := NewAgent(WithBaseURL(srv.URL))`
	`52`	`+ agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())`
`53`	`53`	`if err != nil {`
`54`	`54`	`t.Fatal(err)`
`55`	`55`	`}`
`@@ -65,7 +65,7 @@ func TestHTMLParse(t *testing.T) {`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`if len(resources) != 12 {`
`68`		`- for k, _ := range resources {`
	`68`	`+ for k := range resources {`
`69`	`69`	`t.Log(k)`
`70`	`70`	`}`
`71`	`71`	`t.Fatalf("resouces count missmatch: %d", len(resources))`
`@@ -101,7 +101,7 @@ func BenchmarkHTMLParse(b *testing.B) {`
`101`	`101`	`}))`
`102`	`102`	`defer srv.Close()`
`103`	`103`
`104`		`- agent, err := NewAgent(WithBaseURL(srv.URL))`
	`104`	`+ agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())`
`105`	`105`	`if err != nil {`
`106`	`106`	`b.Fatal(err)`
`107`	`107`	`}`
`@@ -118,7 +118,7 @@ func BenchmarkHTMLParse(b *testing.B) {`
`118`	`118`	`}`
`119`	`119`
`120`	`120`	`if len(resources) != 12 {`
`121`		`- for k, _ := range resources {`
	`121`	`+ for k := range resources {`
`122`	`122`	`b.Log(k)`
`123`	`123`	`}`
`124`	`124`	`b.Fatalf("resouces count missmatch: %d", len(resources))`
`@@ -163,7 +163,7 @@ func TestFavicon(t *testing.T) {`
`163`	`163`	`}))`
`164`	`164`	`defer srv.Close()`
`165`	`165`
`166`		`- agent, err := NewAgent(WithBaseURL(srv.URL))`
	`166`	`+ agent, err := NewAgent(WithBaseURL(srv.URL), WithDefaultTransport())`
`167`	`167`	`if err != nil {`
`168`	`168`	`t.Fatal(err)`
`169`	`169`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ func main() {`
`11`	`11`	`ctx, cancel := context.WithCancel(context.Background())`
`12`	`12`	`defer cancel()`
`13`	`13`
`14`		`- agent, err := agent.NewAgent(agent.WithBaseURL("https://github.com/"))`
	`14`	`+ agent, err := agent.NewAgent(agent.WithDefaultTransport(), agent.WithBaseURL("https://github.com/"))`
`15`	`15`	`if err != nil {`
`16`	`16`	`panic(err)`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ require (`
`10`	`10`	`github.com/labstack/echo v3.3.10+incompatible`
`11`	`11`	`github.com/labstack/gommon v0.3.0 // indirect`
`12`	`12`	`github.com/pquerna/cachecontrol v0.0.0-20200819021114-67c6ae64274f`
	`13`	`+ github.com/stretchr/testify v1.7.0`
`13`	`14`	`golang.org/x/net v0.0.0-20200904194848-62affa334b73`
`14`	`15`	`golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1`
`15`	`16`	`)`