Middleware as structs

Signed-off-by: Vishal Rana <vr@labstack.com>

handler/static.go

@@ -11,9 +11,9 @@ import (
 
 type (
 	Static struct {
-		Root   string
+		Root   string `json:"root"`
-		Index  string
+		Index  string `json:"index"`
-		Browse bool
+		Browse bool   `json:"browse"`
 	}
 )
 

middleware/auth.go

@@ -8,44 +8,60 @@ import (
 )
 
 type (
-	BasicValidateFunc func(string, string) bool
+	// BasicAuth defines an HTTP basic authentication middleware.
+	BasicAuth struct {
+		function BasicAuthFunc
+		priority int
+	}
+
+	BasicAuthFunc func(string, string) bool
 )
 
 const (
 	basic = "Basic"
 )
 
-// BasicAuth returns an HTTP basic authentication middleware.
+func NewBasicAuth(fn BasicAuthFunc) *BasicAuth {
+	return &BasicAuth{function: fn}
+}
+
+func (ba *BasicAuth) SetPriority(p int) {
+	ba.priority = p
+}
+
+func (ba *BasicAuth) Priority() int {
+	return ba.priority
+}
+
+// Handle validates credentials using `AuthFunc`
 //
 // For valid credentials it calls the next handler.
 // For invalid credentials, it sends "401 - Unauthorized" response.
-func BasicAuth(fn BasicValidateFunc) echo.MiddlewareFunc {
+func (ba *BasicAuth) Handle(h echo.Handler) echo.Handler {
-	return func(h echo.Handler) echo.Handler {
+	return echo.HandlerFunc(func(c echo.Context) error {
-		return echo.HandlerFunc(func(c echo.Context) error {
+		// Skip WebSocket
-			// Skip WebSocket
+		if (c.Request().Header().Get(echo.Upgrade)) == echo.WebSocket {
-			if (c.Request().Header().Get(echo.Upgrade)) == echo.WebSocket {
+			return nil
-				return nil
+		}
-			}
 
-			auth := c.Request().Header().Get(echo.Authorization)
+		auth := c.Request().Header().Get(echo.Authorization)
-			l := len(basic)
+		l := len(basic)
 
-			if len(auth) > l+1 && auth[:l] == basic {
+		if len(auth) > l+1 && auth[:l] == basic {
-				b, err := base64.StdEncoding.DecodeString(auth[l+1:])
+			b, err := base64.StdEncoding.DecodeString(auth[l+1:])
-				if err == nil {
+			if err == nil {
-					cred := string(b)
+				cred := string(b)
-					for i := 0; i < len(cred); i++ {
+				for i := 0; i < len(cred); i++ {
-						if cred[i] == ':' {
+					if cred[i] == ':' {
-							// Verify credentials
+						// Verify credentials
-							if fn(cred[:i], cred[i+1:]) {
+						if ba.function(cred[:i], cred[i+1:]) {
-								return nil
+							return nil
-							}
 						}
 					}
 				}
 			}
-			c.Response().Header().Set(echo.WWWAuthenticate, basic+" realm=Restricted")
+		}
-			return echo.NewHTTPError(http.StatusUnauthorized)
+		c.Response().Header().Set(echo.WWWAuthenticate, basic+" realm=Restricted")
-		})
+		return echo.NewHTTPError(http.StatusUnauthorized)
-	}
+	})
 }

middleware/auth_test.go

@@ -21,7 +21,7 @@ func TestBasicAuth(t *testing.T) {
 		}
 		return false
 	}
-	h := BasicAuth(fn)(echo.HandlerFunc(func(c echo.Context) error {
+	h := NewBasicAuth(fn).Handle(echo.HandlerFunc(func(c echo.Context) error {
 		return c.String(http.StatusOK, "test")
 	}))
 

middleware/compress.go

@@ -15,12 +15,57 @@ import (
 )
 
 type (
+	Gzip struct {
+		level    int
+		priority int
+	}
+
 	gzipWriter struct {
 		io.Writer
 		engine.Response
 	}
 )
 
+func NewGzip() *Gzip {
+	return &Gzip{}
+}
+
+func (g *Gzip) SetLevel(l int) {
+	g.level = l
+}
+
+func (g *Gzip) SetPriority(p int) {
+	g.priority = p
+}
+
+func (g *Gzip) Priority() int {
+	return g.priority
+}
+
+// Gzip returns a middleware which compresses HTTP response using gzip compression
+// scheme.
+func (*Gzip) Handle(h echo.Handler) echo.Handler {
+	scheme := "gzip"
+	return echo.HandlerFunc(func(c echo.Context) error {
+		c.Response().Header().Add(echo.Vary, echo.AcceptEncoding)
+		if strings.Contains(c.Request().Header().Get(echo.AcceptEncoding), scheme) {
+			w := writerPool.Get().(*gzip.Writer)
+			w.Reset(c.Response().Writer())
+			defer func() {
+				w.Close()
+				writerPool.Put(w)
+			}()
+			gw := gzipWriter{Writer: w, Response: c.Response()}
+			c.Response().Header().Set(echo.ContentEncoding, scheme)
+			c.Response().SetWriter(gw)
+		}
+		if err := h.Handle(c); err != nil {
+			c.Error(err)
+		}
+		return nil
+	})
+}
+
 func (w gzipWriter) Write(b []byte) (int, error) {
 	if w.Header().Get(echo.ContentType) == "" {
 		w.Header().Set(echo.ContentType, http.DetectContentType(b))
@@ -45,29 +90,3 @@ var writerPool = sync.Pool{
 		return gzip.NewWriter(ioutil.Discard)
 	},
 }
-
-// Gzip returns a middleware which compresses HTTP response using gzip compression
-// scheme.
-func Gzip() echo.MiddlewareFunc {
-	return func(h echo.Handler) echo.Handler {
-		scheme := "gzip"
-		return echo.HandlerFunc(func(c echo.Context) error {
-			c.Response().Header().Add(echo.Vary, echo.AcceptEncoding)
-			if strings.Contains(c.Request().Header().Get(echo.AcceptEncoding), scheme) {
-				w := writerPool.Get().(*gzip.Writer)
-				w.Reset(c.Response().Writer())
-				defer func() {
-					w.Close()
-					writerPool.Put(w)
-				}()
-				gw := gzipWriter{Writer: w, Response: c.Response()}
-				c.Response().Header().Set(echo.ContentEncoding, scheme)
-				c.Response().SetWriter(gw)
-			}
-			if err := h.Handle(c); err != nil {
-				c.Error(err)
-			}
-			return nil
-		})
-	}
-}

middleware/compress_test.go

@@ -36,12 +36,11 @@ func TestGzip(t *testing.T) {
 	rec := test.NewResponseRecorder()
 	c := echo.NewContext(req, rec, e)
 	// Skip if no Accept-Encoding header
-	h := Gzip()(echo.HandlerFunc(func(c echo.Context) error {
+	h := NewGzip().Handle(echo.HandlerFunc(func(c echo.Context) error {
 		c.Response().Write([]byte("test")) // For Content-Type sniffing
 		return nil
 	}))
 	h.Handle(c)
-	// assert.Equal(t, http.StatusOK, rec.Status())
 	assert.Equal(t, "test", rec.Body.String())
 
 	req = test.NewRequest(echo.GET, "/", nil)

middleware/log.go

@@ -8,47 +8,63 @@ import (
 	"github.com/labstack/gommon/color"
 )
 
-func Log() echo.MiddlewareFunc {
+type (
-	return func(h echo.Handler) echo.Handler {
+	Log struct {
-		return echo.HandlerFunc(func(c echo.Context) error {
+		priority int
-			req := c.Request()
-			res := c.Response()
-			logger := c.Logger()
-
-			remoteAddr := req.RemoteAddress()
-			if ip := req.Header().Get(echo.XRealIP); ip != "" {
-				remoteAddr = ip
-			} else if ip = req.Header().Get(echo.XForwardedFor); ip != "" {
-				remoteAddr = ip
-			} else {
-				remoteAddr, _, _ = net.SplitHostPort(remoteAddr)
-			}
-
-			start := time.Now()
-			if err := h.Handle(c); err != nil {
-				c.Error(err)
-			}
-			stop := time.Now()
-			method := req.Method()
-			path := req.URL().Path()
-			if path == "" {
-				path = "/"
-			}
-			size := res.Size()
-
-			n := res.Status()
-			code := color.Green(n)
-			switch {
-			case n >= 500:
-				code = color.Red(n)
-			case n >= 400:
-				code = color.Yellow(n)
-			case n >= 300:
-				code = color.Cyan(n)
-			}
-
-			logger.Infof("%s %s %s %s %s %d", remoteAddr, method, path, code, stop.Sub(start), size)
-			return nil
-		})
 	}
+)
+
+func NewLog() *Log {
+	return &Log{}
+}
+
+func (l *Log) SetPriority(p int) {
+	l.priority = p
+}
+
+func (l *Log) Priority() int {
+	return l.priority
+}
+
+func (*Log) Handle(h echo.Handler) echo.Handler {
+	return echo.HandlerFunc(func(c echo.Context) error {
+		req := c.Request()
+		res := c.Response()
+		logger := c.Logger()
+
+		remoteAddr := req.RemoteAddress()
+		if ip := req.Header().Get(echo.XRealIP); ip != "" {
+			remoteAddr = ip
+		} else if ip = req.Header().Get(echo.XForwardedFor); ip != "" {
+			remoteAddr = ip
+		} else {
+			remoteAddr, _, _ = net.SplitHostPort(remoteAddr)
+		}
+
+		start := time.Now()
+		if err := h.Handle(c); err != nil {
+			c.Error(err)
+		}
+		stop := time.Now()
+		method := req.Method()
+		path := req.URL().Path()
+		if path == "" {
+			path = "/"
+		}
+		size := res.Size()
+
+		n := res.Status()
+		code := color.Green(n)
+		switch {
+		case n >= 500:
+			code = color.Red(n)
+		case n >= 400:
+			code = color.Yellow(n)
+		case n >= 300:
+			code = color.Cyan(n)
+		}
+
+		logger.Infof("%s %s %s %s %s %d", remoteAddr, method, path, code, stop.Sub(start), size)
+		return nil
+	})
 }

middleware/log_test.go

@@ -18,7 +18,8 @@ func TestLog(t *testing.T) {
 	req := test.NewRequest(echo.GET, "/", nil)
 	rec := test.NewResponseRecorder()
 	c := echo.NewContext(req, rec, e)
-	h := Log()(echo.HandlerFunc(func(c echo.Context) error {
+	l := NewLog()
+	h := l.Handle(echo.HandlerFunc(func(c echo.Context) error {
 		return c.String(http.StatusOK, "test")
 	}))
 
@@ -28,7 +29,7 @@ func TestLog(t *testing.T) {
 	// Status 3xx
 	rec = test.NewResponseRecorder()
 	c = echo.NewContext(req, rec, e)
-	h = Log()(echo.HandlerFunc(func(c echo.Context) error {
+	h = l.Handle(echo.HandlerFunc(func(c echo.Context) error {
 		return c.String(http.StatusTemporaryRedirect, "test")
 	}))
 	h.Handle(c)
@@ -36,7 +37,7 @@ func TestLog(t *testing.T) {
 	// Status 4xx
 	rec = test.NewResponseRecorder()
 	c = echo.NewContext(req, rec, e)
-	h = Log()(echo.HandlerFunc(func(c echo.Context) error {
+	h = l.Handle(echo.HandlerFunc(func(c echo.Context) error {
 		return c.String(http.StatusNotFound, "test")
 	}))
 	h.Handle(c)
@@ -45,7 +46,7 @@ func TestLog(t *testing.T) {
 	req = test.NewRequest(echo.GET, "", nil)
 	rec = test.NewResponseRecorder()
 	c = echo.NewContext(req, rec, e)
-	h = Log()(echo.HandlerFunc(func(c echo.Context) error {
+	h = l.Handle(echo.HandlerFunc(func(c echo.Context) error {
 		return errors.New("error")
 	}))
 	h.Handle(c)
@@ -59,7 +60,7 @@ func TestLogIPAddress(t *testing.T) {
 	buf := new(bytes.Buffer)
 	e.Logger().(*log.Logger).SetOutput(buf)
 	ip := "127.0.0.1"
-	h := Log()(echo.HandlerFunc(func(c echo.Context) error {
+	h := NewLog().Handle(echo.HandlerFunc(func(c echo.Context) error {
 		return c.String(http.StatusOK, "test")
 	}))
 

middleware/recover.go

@@ -8,21 +8,37 @@ import (
 	"github.com/labstack/echo"
 )
 
+type (
+	Recover struct {
+		priority int
+	}
+)
+
+func NewRecover() *Recover {
+	return &Recover{}
+}
+
+func (r *Recover) SetPriority(p int) {
+	r.priority = p
+}
+
+func (r *Recover) Priority() int {
+	return r.priority
+}
+
 // Recover returns a middleware which recovers from panics anywhere in the chain
 // and handles the control to the centralized HTTPErrorHandler.
-func Recover() echo.MiddlewareFunc {
+func (*Recover) Handle(h echo.Handler) echo.Handler {
-	return func(h echo.Handler) echo.Handler {
+	// TODO: Provide better stack trace `https://github.com/go-errors/errors` `https://github.com/docker/libcontainer/tree/master/stacktrace`
-		// TODO: Provide better stack trace `https://github.com/go-errors/errors` `https://github.com/docker/libcontainer/tree/master/stacktrace`
+	return echo.HandlerFunc(func(c echo.Context) error {
-		return echo.HandlerFunc(func(c echo.Context) error {
+		defer func() {
-			defer func() {
+			if err := recover(); err != nil {
-				if err := recover(); err != nil {
+				trace := make([]byte, 1<<16)
-					trace := make([]byte, 1<<16)
+				n := runtime.Stack(trace, true)
-					n := runtime.Stack(trace, true)
+				c.Error(fmt.Errorf("panic recover\n %v\n stack trace %d bytes\n %s",
-					c.Error(fmt.Errorf("panic recover\n %v\n stack trace %d bytes\n %s",
+					err, n, trace[:n]))
-						err, n, trace[:n]))
+			}
-				}
+		}()
-			}()
+		return h.Handle(c)
-			return h.Handle(c)
+	})
-		})
-	}
 }

middleware/recover_test.go

@@ -15,7 +15,7 @@ func TestRecover(t *testing.T) {
 	req := test.NewRequest(echo.GET, "/", nil)
 	rec := test.NewResponseRecorder()
 	c := echo.NewContext(req, rec, e)
-	h := Recover()(echo.HandlerFunc(func(c echo.Context) error {
+	h := NewRecover().Handle(echo.HandlerFunc(func(c echo.Context) error {
 		panic("test")
 	}))
 	h.Handle(c)