Skip to content

Commit 3703605

Browse files
Update middleware/tripperware accordling to logger signature (#3)
1 parent 218e3f2 commit 3703605

File tree

8 files changed

+303
-259
lines changed

8 files changed

+303
-259
lines changed

go.mod

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ go 1.13
44

55
require (
66
github.com/gol4ng/httpware/v2 v2.1.1
7-
github.com/gol4ng/logger v0.3.0
7+
github.com/gol4ng/logger v0.5.3
8+
github.com/golang/mock v1.4.0
89
github.com/stretchr/testify v1.4.0
910
)

go.sum

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2
1313
github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE=
1414
github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=
1515
github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ=
16-
github.com/gol4ng/httpware/v2 v2.1.0 h1:eKtzvaoW/dw8YIAYTfhAvPDVmj0zDw8BkQSlLhjunUI=
17-
github.com/gol4ng/httpware/v2 v2.1.0/go.mod h1:SIOrsksHg+ydQWikEj5KUVANB4lmwB8c5/NIBtdVzFM=
1816
github.com/gol4ng/httpware/v2 v2.1.1 h1:8xd4iN+6e/xjBSy8jjF2Vm8/PvxswJznu8GdaNu+vs8=
1917
github.com/gol4ng/httpware/v2 v2.1.1/go.mod h1:SIOrsksHg+ydQWikEj5KUVANB4lmwB8c5/NIBtdVzFM=
20-
github.com/gol4ng/logger v0.3.0 h1:06RSztlRiQziN2uAcjAPfGhSisbcVcoDUpwg55QFq7I=
21-
github.com/gol4ng/logger v0.3.0/go.mod h1:br5HY3VkhGzF83IhjDNE+PHkg2rV2Zy2uGPIfVfWZWg=
18+
github.com/gol4ng/logger v0.5.3 h1:gX9fX5Ke1c9ldyIkbHBVux3EJ73FsPsmzWnXT8LEsTo=
19+
github.com/gol4ng/logger v0.5.3/go.mod h1:RU2axpKm//DmUGqQNIhXmUBHKeLdtWarxu8bSV+5b4Y=
20+
github.com/golang/mock v1.4.0 h1:Rd1kQnQu0Hq3qvJppYSG0HtP+f5LPPUiDswTLiEegLg=
21+
github.com/golang/mock v1.4.0/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw=
2222
github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
2323
github.com/golang/protobuf v1.3.1 h1:YF8+flBXS5eO826T4nzqPrxfhQThhXl0YzfuUPu4SBg=
2424
github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
@@ -28,6 +28,11 @@ github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCV
2828
github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w=
2929
github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
3030
github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc=
31+
github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
32+
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
33+
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
34+
github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
35+
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
3136
github.com/matttproud/golang_protobuf_extensions v1.0.1 h1:4hp9jkHxhMHkqkrB3Ix0jegS5sx/RkqARlsWZ6pIwiU=
3237
github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0=
3338
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
@@ -59,17 +64,28 @@ github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UV
5964
github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
6065
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
6166
golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
67+
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
6268
golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
69+
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
6370
golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
6471
golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
72+
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
6573
golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
6674
golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5 h1:mzjBh+S5frKOsOBobWIMAbXavqjmgO17k/2puhcFR94=
6775
golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
76+
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
77+
golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
78+
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
79+
golang.org/x/tools v0.0.0-20190425150028-36563e24a262/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q=
6880
gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw=
6981
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
7082
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
83+
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
84+
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
7185
gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
7286
gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
7387
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
7488
gotest.tools v2.2.0+incompatible h1:VsBPFP1AI068pPrMxtb/S8Zkgf9xEmTLJjfM+P5UIEo=
7589
gotest.tools v2.2.0+incompatible/go.mod h1:DsYFclhRJ6vuDpmuTbkuFWG+y2sxOXAzmJt81HFBacw=
90+
rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=
91+
rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=

middleware/correlation_id_test.go

Lines changed: 40 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import (
1616
"github.com/gol4ng/logger"
1717
"github.com/gol4ng/logger/formatter"
1818
"github.com/gol4ng/logger/handler"
19+
testing_logger "github.com/gol4ng/logger/testing"
1920
"github.com/stretchr/testify/assert"
2021

2122
http_middleware "github.com/gol4ng/logger-http/middleware"
@@ -26,10 +27,7 @@ func TestCorrelationId(t *testing.T) {
2627
rand.New(correlation_id.NewLockedSource(rand.NewSource(1))),
2728
)
2829

29-
loggerOutput := &Output{}
30-
myLogger := logger.NewLogger(
31-
handler.Stream(loggerOutput, formatter.NewDefaultFormatter()),
32-
)
30+
myLogger, store := testing_logger.NewLogger()
3331

3432
request := httptest.NewRequest(http.MethodGet, "http://fake-addr", nil)
3533
request = request.WithContext(logger.InjectInContext(request.Context(), myLogger))
@@ -41,35 +39,45 @@ func TestCorrelationId(t *testing.T) {
4139
assert.NotEqual(t, request, innerRequest)
4240
assert.Equal(t, "p1LGIehp1s", innerRequest.Header.Get(correlation_id.HeaderName))
4341
handlerRequest = innerRequest
44-
logger.FromContext(innerRequest.Context(), nil).Info("handler info log", nil)
42+
logger.FromContext(innerRequest.Context(), nil).Info("handler info log")
4543
})
4644

47-
myLogger.Info("info log before request", logger.NewContext().Add("ctxvalue", "before"))
45+
myLogger.Info("info log before request", logger.String("ctxvalue", "before"))
4846
http_middleware.CorrelationId()(h).ServeHTTP(responseWriter, request)
49-
myLogger.Info("info log after request", logger.NewContext().Add("ctxvalue", "after"))
47+
myLogger.Info("info log after request", logger.String("ctxvalue", "after"))
5048

5149
respHeaderValue := responseWriter.Header().Get(correlation_id.HeaderName)
5250
reqContextValue := handlerRequest.Context().Value(correlation_id.HeaderName).(string)
5351
assert.Equal(t, "p1LGIehp1s", request.Header.Get(correlation_id.HeaderName))
5452
assert.True(t, len(respHeaderValue) == 10)
5553
assert.True(t, len(reqContextValue) == 10)
5654
assert.True(t, respHeaderValue == reqContextValue)
57-
loggerOutput.Constains(t, []string{
58-
`<info> info log before request {"ctxvalue":"before"}`,
59-
`<info> handler info log {"Correlation-Id":"p1LGIehp1s"}`,
60-
`<info> info log after request {"ctxvalue":"after"}`,
61-
})
55+
56+
entries := store.GetEntries()
57+
assert.Len(t, entries, 3)
58+
59+
entry1 := entries[0]
60+
assert.Equal(t, logger.InfoLevel, entry1.Level)
61+
assert.Equal(t, "info log before request", entry1.Message)
62+
assert.Equal(t, "before", (*entry1.Context)["ctxvalue"].Value)
63+
64+
entry2 := entries[1]
65+
assert.Equal(t, logger.InfoLevel, entry2.Level)
66+
assert.Equal(t, "handler info log", entry2.Message)
67+
assert.Equal(t, "p1LGIehp1s", (*entry2.Context)["Correlation-Id"].Value)
68+
69+
entry3 := entries[2]
70+
assert.Equal(t, logger.InfoLevel, entry3.Level)
71+
assert.Equal(t, "info log after request", entry3.Message)
72+
assert.Equal(t, "after", (*entry3.Context)["ctxvalue"].Value)
6273
}
6374

6475
func TestCorrelationId_WithoutWrappableLogger(t *testing.T) {
6576
correlation_id.DefaultIdGenerator = correlation_id.NewRandomIdGenerator(
6677
rand.New(correlation_id.NewLockedSource(rand.NewSource(1))),
6778
)
6879

69-
loggerOutput := &Output{}
70-
myLogger := logger.NewLogger(
71-
handler.Stream(loggerOutput, formatter.NewDefaultFormatter()),
72-
)
80+
myLogger, store := testing_logger.NewLogger()
7381

7482
request := httptest.NewRequest(http.MethodGet, "http://fake-addr", nil)
7583
// WE DO NOT INJECT LOGGER IN REQUEST CONTEXT
@@ -85,11 +93,11 @@ func TestCorrelationId_WithoutWrappableLogger(t *testing.T) {
8593
assert.Nil(t, logger.FromContext(innerRequest.Context(), nil))
8694
})
8795

88-
myLogger.Info("info log before request", logger.NewContext().Add("ctxvalue", "before"))
96+
myLogger.Info("info log before request", logger.String("ctxvalue", "before"))
8997
output := getStdout(func() {
9098
http_middleware.CorrelationId()(h).ServeHTTP(responseRecorder, request)
9199
})
92-
myLogger.Info("info log after request", logger.NewContext().Add("ctxvalue", "after"))
100+
myLogger.Info("info log after request", logger.String("ctxvalue", "after"))
93101

94102
respHeaderValue := responseRecorder.Header().Get(correlation_id.HeaderName)
95103
reqContextValue := handlerRequest.Context().Value(correlation_id.HeaderName).(string)
@@ -100,10 +108,18 @@ func TestCorrelationId_WithoutWrappableLogger(t *testing.T) {
100108
assert.Contains(t, output, "correlationId need a wrappable logger /")
101109
assert.Contains(t, output, "/src/github.com/gol4ng/logger-http/middleware/correlation_id_test.go:")
102110

103-
loggerOutput.Constains(t, []string{
104-
`<info> info log before request {"ctxvalue":"before"}`,
105-
`<info> info log after request {"ctxvalue":"after"}`,
106-
})
111+
entries := store.GetEntries()
112+
assert.Len(t, entries, 2)
113+
114+
entry1 := entries[0]
115+
assert.Equal(t, logger.InfoLevel, entry1.Level)
116+
assert.Equal(t, "info log before request", entry1.Message)
117+
assert.Equal(t, "before", (*entry1.Context)["ctxvalue"].Value)
118+
119+
entry2 := entries[1]
120+
assert.Equal(t, logger.InfoLevel, entry2.Level)
121+
assert.Equal(t, "info log after request", entry2.Message)
122+
assert.Equal(t, "after", (*entry2.Context)["ctxvalue"].Value)
107123
}
108124

109125
// Use to get os.Stdout
@@ -147,7 +163,7 @@ func ExampleCorrelationId() {
147163
port := ":5001"
148164

149165
myLogger := logger.NewLogger(
150-
handler.Stream(os.Stdout, formatter.NewDefaultFormatter()),
166+
handler.Stream(os.Stdout, formatter.NewDefaultFormatter(formatter.WithContext(true))),
151167
)
152168

153169
// we recommend to use MiddlewareStack to simplify managing all wanted middlewares
@@ -164,7 +180,7 @@ func ExampleCorrelationId() {
164180

165181
h := http.HandlerFunc(func(writer http.ResponseWriter, innerRequest *http.Request) {
166182
l := logger.FromContext(innerRequest.Context(), myLogger)
167-
l.Info("handler log info", nil)
183+
l.Info("handler log info")
168184
})
169185

170186
go func() {

middleware/logger.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,25 @@ func Logger(log logger.LoggerInterface, opts ...logger_http.Option) httpware.Mid
3030

3131
if err := recover(); err != nil {
3232
currentLoggerContext.Add("http_panic", err)
33-
_ = currentLogger.Critical(fmt.Sprintf("http server panic %s %s [duration:%s]", req.Method, req.URL, duration), currentLoggerContext)
33+
currentLogger.Critical(fmt.Sprintf("http server panic %s %s [duration:%s]", req.Method, req.URL, duration), *currentLoggerContext.Slice()...)
3434
panic(err)
3535
}
3636

3737
currentLoggerContext.Add("http_status", http.StatusText(writerInterceptor.StatusCode)).
3838
Add("http_status_code", writerInterceptor.StatusCode).
3939
Add("http_response_length", len(writerInterceptor.Body))
4040

41-
_ = currentLogger.Log(
41+
currentLogger.Log(
4242
fmt.Sprintf(
4343
"http server %s %s [status_code:%d, duration:%s, content_length:%d]",
4444
req.Method, req.URL, writerInterceptor.StatusCode, duration, len(writerInterceptor.Body),
4545
),
4646
o.LevelFunc(writerInterceptor.StatusCode),
47-
currentLoggerContext,
47+
*currentLoggerContext.Slice()...,
4848
)
4949
}()
5050

51-
_ = currentLogger.Debug(fmt.Sprintf("http server received %s %s", req.Method, req.URL), currentLoggerContext)
51+
currentLogger.Debug(fmt.Sprintf("http server received %s %s", req.Method, req.URL), *currentLoggerContext.Slice()...)
5252
next.ServeHTTP(writerInterceptor, req)
5353
})
5454
}

0 commit comments

Comments
 (0)