From d202b52e00aeb8f472571acb2337971ebee057e7 Mon Sep 17 00:00:00 2001 From: Tyler Cosgrove Date: Thu, 19 Aug 2021 11:58:48 -0400 Subject: [PATCH 1/3] use RemoteAddr if it's not empty & then try to remove port from it --- hlog/hlog.go | 8 +++++++- hlog/hlog_test.go | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+), 1 deletion(-) diff --git a/hlog/hlog.go b/hlog/hlog.go index d9a60959..bcf8ce23 100644 --- a/hlog/hlog.go +++ b/hlog/hlog.go @@ -79,10 +79,16 @@ func RequestHandler(fieldKey string) func(next http.Handler) http.Handler { func RemoteAddrHandler(fieldKey string) func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + addr := r.RemoteAddr + if host, _, err := net.SplitHostPort(r.RemoteAddr); err == nil { + addr = host + } + + if addr != "" { log := zerolog.Ctx(r.Context()) log.UpdateContext(func(c zerolog.Context) zerolog.Context { - return c.Str(fieldKey, host) + return c.Str(fieldKey, addr) }) } next.ServeHTTP(w, r) diff --git a/hlog/hlog_test.go b/hlog/hlog_test.go index b1c24fe0..81c66833 100644 --- a/hlog/hlog_test.go +++ b/hlog/hlog_test.go @@ -121,6 +121,38 @@ func TestRemoteAddrHandlerIPv6(t *testing.T) { } } +func TestRemoteAddrHandlerNoPort(t *testing.T) { + out := &bytes.Buffer{} + r := &http.Request{ + RemoteAddr: "1.2.3.4", + } + h := RemoteAddrHandler("ip")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + l := FromRequest(r) + l.Log().Msg("") + })) + h = NewHandler(zerolog.New(out))(h) + h.ServeHTTP(nil, r) + if want, got := `{"ip":"1.2.3.4"}`+"\n", decodeIfBinary(out); want != got { + t.Errorf("Invalid log output, got: %s, want: %s", got, want) + } +} + +func TestRemoteAddrHandlerIPv6NoPort(t *testing.T) { + out := &bytes.Buffer{} + r := &http.Request{ + RemoteAddr: "2001:db8:a0b:12f0::1", + } + h := RemoteAddrHandler("ip")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + l := FromRequest(r) + l.Log().Msg("") + })) + h = NewHandler(zerolog.New(out))(h) + h.ServeHTTP(nil, r) + if want, got := `{"ip":"2001:db8:a0b:12f0::1"}`+"\n", decodeIfBinary(out); want != got { + t.Errorf("Invalid log output, got: %s, want: %s", got, want) + } +} + func TestUserAgentHandler(t *testing.T) { out := &bytes.Buffer{} r := &http.Request{ From 088dfd6ebfac62af91e320abe3435c88717a5847 Mon Sep 17 00:00:00 2001 From: Tyler Cosgrove Date: Thu, 19 Aug 2021 14:24:10 -0400 Subject: [PATCH 2/3] change behavior to use r.RemoteAddr if set --- hlog/hlog.go | 11 ++--------- hlog/hlog_test.go | 4 ++-- 2 files changed, 4 insertions(+), 11 deletions(-) diff --git a/hlog/hlog.go b/hlog/hlog.go index bcf8ce23..4f19a08a 100644 --- a/hlog/hlog.go +++ b/hlog/hlog.go @@ -3,7 +3,6 @@ package hlog import ( "context" - "net" "net/http" "time" @@ -79,16 +78,10 @@ func RequestHandler(fieldKey string) func(next http.Handler) http.Handler { func RemoteAddrHandler(fieldKey string) func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - addr := r.RemoteAddr - - if host, _, err := net.SplitHostPort(r.RemoteAddr); err == nil { - addr = host - } - - if addr != "" { + if r.RemoteAddr != "" { log := zerolog.Ctx(r.Context()) log.UpdateContext(func(c zerolog.Context) zerolog.Context { - return c.Str(fieldKey, addr) + return c.Str(fieldKey, r.RemoteAddr) }) } next.ServeHTTP(w, r) diff --git a/hlog/hlog_test.go b/hlog/hlog_test.go index 81c66833..ab939e68 100644 --- a/hlog/hlog_test.go +++ b/hlog/hlog_test.go @@ -100,7 +100,7 @@ func TestRemoteAddrHandler(t *testing.T) { })) h = NewHandler(zerolog.New(out))(h) h.ServeHTTP(nil, r) - if want, got := `{"ip":"1.2.3.4"}`+"\n", decodeIfBinary(out); want != got { + if want, got := `{"ip":"1.2.3.4:1234"}`+"\n", decodeIfBinary(out); want != got { t.Errorf("Invalid log output, got: %s, want: %s", got, want) } } @@ -116,7 +116,7 @@ func TestRemoteAddrHandlerIPv6(t *testing.T) { })) h = NewHandler(zerolog.New(out))(h) h.ServeHTTP(nil, r) - if want, got := `{"ip":"2001:db8:a0b:12f0::1"}`+"\n", decodeIfBinary(out); want != got { + if want, got := `{"ip":"[2001:db8:a0b:12f0::1]:1234"}`+"\n", decodeIfBinary(out); want != got { t.Errorf("Invalid log output, got: %s, want: %s", got, want) } } From 542a7934d62d2150926ccab5aaa81d7c4b170ec7 Mon Sep 17 00:00:00 2001 From: Tyler Cosgrove Date: Thu, 19 Aug 2021 14:33:01 -0400 Subject: [PATCH 3/3] remove no-longer needed tests --- hlog/hlog_test.go | 32 -------------------------------- 1 file changed, 32 deletions(-) diff --git a/hlog/hlog_test.go b/hlog/hlog_test.go index ab939e68..481525bf 100644 --- a/hlog/hlog_test.go +++ b/hlog/hlog_test.go @@ -121,38 +121,6 @@ func TestRemoteAddrHandlerIPv6(t *testing.T) { } } -func TestRemoteAddrHandlerNoPort(t *testing.T) { - out := &bytes.Buffer{} - r := &http.Request{ - RemoteAddr: "1.2.3.4", - } - h := RemoteAddrHandler("ip")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - l := FromRequest(r) - l.Log().Msg("") - })) - h = NewHandler(zerolog.New(out))(h) - h.ServeHTTP(nil, r) - if want, got := `{"ip":"1.2.3.4"}`+"\n", decodeIfBinary(out); want != got { - t.Errorf("Invalid log output, got: %s, want: %s", got, want) - } -} - -func TestRemoteAddrHandlerIPv6NoPort(t *testing.T) { - out := &bytes.Buffer{} - r := &http.Request{ - RemoteAddr: "2001:db8:a0b:12f0::1", - } - h := RemoteAddrHandler("ip")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - l := FromRequest(r) - l.Log().Msg("") - })) - h = NewHandler(zerolog.New(out))(h) - h.ServeHTTP(nil, r) - if want, got := `{"ip":"2001:db8:a0b:12f0::1"}`+"\n", decodeIfBinary(out); want != got { - t.Errorf("Invalid log output, got: %s, want: %s", got, want) - } -} - func TestUserAgentHandler(t *testing.T) { out := &bytes.Buffer{} r := &http.Request{