Merge pull request #151 from basecamp/request-start-format

Use `t=<ms>` format for `X-Request-Start` header

Author: kevinmcconnell

internal/server/request_start_middleware.go

@@ -1,8 +1,8 @@
 package server
 
 import (
+	"fmt"
 	"net/http"
-	"strconv"
 	"time"
 )
 
@@ -22,7 +22,7 @@ func WithRequestStartMiddleware(next http.Handler) http.Handler {
 
 func (h *RequestStartMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	if r.Header.Get(requestStartHeader) == "" {
-		r.Header.Set(requestStartHeader, strconv.FormatInt(time.Now().UnixMilli(), 10))
+		r.Header.Set(requestStartHeader, fmt.Sprintf("t=%d", time.Now().UnixMilli()))
 	}
 	h.next.ServeHTTP(w, r)
 }

internal/server/request_start_middleware_test.go

@@ -12,9 +12,12 @@ import (
 
 func TestRequestStartMiddleware_AddsUnixMilliWhenNotPresent(t *testing.T) {
 	handler := WithRequestStartMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		requestStartMilli, _ := strconv.ParseInt(r.Header.Get("X-Request-Start"), 10, 64)
-		requestStart := time.UnixMilli(requestStartMilli)
+		headerValue := r.Header.Get("X-Request-Start")
+
+		assert.Regexp(t, `^t=\d+$`, headerValue, "Value should be formatted as `t=<timestamp>`")
 
+		requestStartMilli, _ := strconv.ParseInt(headerValue[2:], 10, 64)
+		requestStart := time.UnixMilli(requestStartMilli)
 		assert.WithinDuration(t, time.Now(), requestStart, time.Second)
 	}))
 
@@ -27,11 +30,11 @@ func TestRequestStartMiddleware_AddsUnixMilliWhenNotPresent(t *testing.T) {
 
 func TestRequestStartMiddleware_PreservesExistingHeaderWhenPresent(t *testing.T) {
 	handler := WithRequestStartMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		assert.Equal(t, "1234", r.Header.Get("X-Request-Start"))
+		assert.Equal(t, "t=1234", r.Header.Get("X-Request-Start"))
 	}))
 
 	r := httptest.NewRequest("GET", "/", nil)
-	r.Header.Set(requestStartHeader, "1234")
+	r.Header.Set(requestStartHeader, "t=1234")
 
 	w := httptest.NewRecorder()
 	handler.ServeHTTP(w, r)