api server: readTimeout and writeTimeout added to config (#54)

Author: zukiy

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [3.2.0]- 2019-06-06
+### add:
+- api config with timeouts
+
 ## [3.1.3]- 2019-03-05
 ### fix:
 - added auto-create exchange

api/api.go

@@ -15,6 +15,11 @@ import (
 	"github.com/gorilla/mux"
 )
 
+const (
+	cDefaultReadTimeout  = 10 * time.Second
+	cDefaultWriteTimeout = 10 * time.Second
+)
+
 // ErrorWithCode contains a message and code, which will be used as a http response code.
 type ErrorWithCode struct {
 	code     int
@@ -60,9 +65,10 @@ type PathInfo struct {
 
 // Config used to pass settings and handlers to the server.
 type Config struct {
-	Addr     string
-	Prefix   string
-	Handlers []PathInfo
+	Addr                      string
+	Prefix                    string
+	Handlers                  []PathInfo
+	ReadTimeout, WriteTimeout time.Duration
 }
 
 // Server is a REST api server.
@@ -82,11 +88,24 @@ func NewServer(cfg *Config) *Server {
 		router.Handle(s.Path, srv).Methods(s.Method)
 	}
 	s.m.Lock()
+
+	// override timeouts
+	readTimeout := cDefaultReadTimeout
+	writeTimeout := cDefaultWriteTimeout
+
+	if cfg.ReadTimeout > 0 {
+		readTimeout = cfg.ReadTimeout
+	}
+
+	if cfg.WriteTimeout > 0 {
+		writeTimeout = cfg.WriteTimeout
+	}
+
 	s.server = &http.Server{
 		Addr:           s.cfg.Addr,
 		Handler:        r,
-		ReadTimeout:    10 * time.Second,
-		WriteTimeout:   10 * time.Second,
+		ReadTimeout:    readTimeout,
+		WriteTimeout:   writeTimeout,
 		MaxHeaderBytes: 1 << 20,
 	}
 	s.m.Unlock()

api/api_test.go

@@ -114,3 +114,33 @@ func TestNewErrorWithCode(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, []byte("null"), res)
 }
+
+func TestTimeouts(t *testing.T) {
+	a := assert.New(t)
+
+	testCases := []struct {
+		config             Config
+		expectReadTimeout  time.Duration
+		expectWriteTimeout time.Duration
+	}{
+		{
+			Config{},
+			10 * time.Second,
+			10 * time.Second,
+		},
+		{
+			Config{
+				ReadTimeout:  100500 * time.Second,
+				WriteTimeout: 500100 * time.Second,
+			},
+			100500 * time.Second,
+			500100 * time.Second,
+		},
+	}
+
+	for _, tc := range testCases {
+		server := NewServer(&tc.config)
+		a.Equal(tc.expectReadTimeout, server.server.ReadTimeout)
+		a.Equal(tc.expectWriteTimeout, server.server.WriteTimeout)
+	}
+}