ADD Request ID middleware.

glide.yaml

@@ -12,6 +12,7 @@ import:
   - color
   - log
   - random
+- package: github.com/satori/go.uuid
 - package: github.com/tylerb/graceful
 - package: github.com/valyala/fasttemplate
 - package: golang.org/x/crypto

middleware/logger.go

@@ -26,7 +26,7 @@ type (
 		// - time_unix_nano
 		// - time_rfc3339
 		// - time_rfc3339_nano
-		// - id (Request ID - Not implemented)
+		// - id (Request ID)
 		// - remote_ip
 		// - uri
 		// - host
@@ -62,7 +62,7 @@ var (
 	// DefaultLoggerConfig is the default Logger middleware config.
 	DefaultLoggerConfig = LoggerConfig{
 		Skipper: DefaultSkipper,
-		Format: `{"time":"${time_rfc3339_nano}","remote_ip":"${remote_ip}","host":"${host}",` +
+		Format: `{"time":"${time_rfc3339_nano}","id":"${request_id}","remote_ip":"${remote_ip}","host":"${host}",` +
 			`"method":"${method}","uri":"${uri}","status":${status}, "latency":${latency},` +
 			`"latency_human":"${latency_human}","bytes_in":${bytes_in},` +
 			`"bytes_out":${bytes_out}}` + "\n",
@@ -169,6 +169,12 @@ func LoggerWithConfig(config LoggerConfig) echo.MiddlewareFunc {
 					return buf.WriteString(cl)
 				case "bytes_out":
 					return buf.WriteString(strconv.FormatInt(res.Size, 10))
+				case "request_id":
+					ri := req.Header.Get("X-Request-ID")
+					if ri == "" {
+						ri = res.Header().Get("X-Request-ID")
+					}
+					return w.Write([]byte(ri))
 				default:
 					switch {
 					case strings.HasPrefix(tag, "header:"):

middleware/logger_test.go

@@ -86,7 +86,7 @@ func TestLoggerTemplate(t *testing.T) {
 
 	e := echo.New()
 	e.Use(LoggerWithConfig(LoggerConfig{
-		Format: `{"time":"${time_rfc3339_nano}","remote_ip":"${remote_ip}","host":"${host}","user_agent":"${user_agent}",` +
+		Format: `{"time":"${time_rfc3339_nano}","id":"${request_id}","remote_ip":"${remote_ip}","host":"${host}","user_agent":"${user_agent}",` +
 			`"method":"${method}","uri":"${uri}","status":${status}, "latency":${latency},` +
 			`"latency_human":"${latency_human}","bytes_in":${bytes_in}, "path":"${path}", "referer":"${referer}",` +
 			`"bytes_out":${bytes_out},"ch":"${header:X-Custom-Header}",` +
@@ -104,6 +104,7 @@ func TestLoggerTemplate(t *testing.T) {
 	req.Header.Add("Referer", "google.com")
 	req.Header.Add("User-Agent", "echo-tests-agent")
 	req.Header.Add("X-Custom-Header", "AAA-CUSTOM-VALUE")
+	req.Header.Add("X-Request-ID", "6ba7b810-9dad-11d1-80b4-00c04fd430c8")
 	req.Form = url.Values{
 		"username": []string{"apagano-form"},
 		"password": []string{"secret-form"},
@@ -113,20 +114,21 @@ func TestLoggerTemplate(t *testing.T) {
 	e.ServeHTTP(rec, req)
 
 	cases := map[string]bool{
-		"apagano-param":    true,
-		"apagano-form":     true,
-		"AAA-CUSTOM-VALUE": true,
-		"BBB-CUSTOM-VALUE": false,
-		"secret-form":      false,
-		"hexvalue":         false,
-		"GET":              true,
-		"127.0.0.1":        true,
-		"\"path\":\"/\"":   true,
-		"\"uri\":\"/\"":    true,
-		"\"status\":200":   true,
-		"\"bytes_in\":0":   true,
-		"google.com":       true,
-		"echo-tests-agent": true,
+		"apagano-param":                        true,
+		"apagano-form":                         true,
+		"AAA-CUSTOM-VALUE":                     true,
+		"BBB-CUSTOM-VALUE":                     false,
+		"secret-form":                          false,
+		"hexvalue":                             false,
+		"GET":                                  true,
+		"127.0.0.1":                            true,
+		"\"path\":\"/\"":                       true,
+		"\"uri\":\"/\"":                        true,
+		"\"status\":200":                       true,
+		"\"bytes_in\":0":                       true,
+		"google.com":                           true,
+		"echo-tests-agent":                     true,
+		"6ba7b810-9dad-11d1-80b4-00c04fd430c8": true,
 	}
 
 	for token, present := range cases {

middleware/request_id.go

@@ -0,0 +1,51 @@
+package middleware
+
+import (
+	"github.com/labstack/echo"
+	uuid "github.com/satori/go.uuid"
+)
+
+type (
+	// RequestIDConfig defines the config for RequestID middleware.
+	RequestIDConfig struct {
+		// Skipper defines a function to skip middleware.
+		Skipper Skipper
+	}
+)
+
+var (
+	// DefaultRequestIDConfig is the default RequestID middleware config.
+	DefaultRequestIDConfig = RequestIDConfig{
+		Skipper: DefaultSkipper,
+	}
+)
+
+// RequestID returns a X-Request-ID middleware.
+func RequestID() echo.MiddlewareFunc {
+	return RequestIDWithConfig(DefaultRequestIDConfig)
+}
+
+// RequestIDWithConfig returns a X-Request-ID middleware with config.
+func RequestIDWithConfig(config RequestIDConfig) echo.MiddlewareFunc {
+	if config.Skipper == nil {
+		config.Skipper = DefaultRequestIDConfig.Skipper
+	}
+
+	return func(next echo.HandlerFunc) echo.HandlerFunc {
+		return func(c echo.Context) error {
+			if config.Skipper(c) {
+				return next(c)
+			}
+
+			req := c.Request()
+			res := c.Response()
+			rid := req.Header.Get("X-Request-ID")
+			if rid == "" {
+				rid = uuid.NewV4().String()
+			}
+			res.Header().Set("X-Request-ID", rid)
+
+			return next(c)
+		}
+	}
+}

middleware/request_id_test.go

@@ -0,0 +1,30 @@
+package middleware
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/labstack/echo"
+	uuid "github.com/satori/go.uuid"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRequestID(t *testing.T) {
+	e := echo.New()
+	req, _ := http.NewRequest(echo.GET, "/", nil)
+	rec := httptest.NewRecorder()
+	c := e.NewContext(req, rec)
+	rid := RequestIDWithConfig(RequestIDConfig{})
+	h := rid(func(c echo.Context) error {
+		return c.String(http.StatusOK, "test")
+	})
+
+	h(c)
+	if assert.NotEmpty(t, rec.Header().Get("X-Request-ID")) {
+		u, err := uuid.FromString(rec.Header().Get("X-Request-ID"))
+		assert.NoError(t, err)
+		assert.Equal(t, uint(4), u.Version())
+		assert.Equal(t, uint(uuid.VariantRFC4122), u.Variant())
+	}
+}