Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Transport: logger LogRoundTrip (check request and response is not nill) #208

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Transport: logger LogRoundTrip (check request and response is not nill) #208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2777847
LogRoundTrip request nil pointer defreference
tty2 Dec 11, 2020
b88b45a
reqURL to var
tty2 Dec 14, 2020
5d38c97
tests for LogRoundTrip
tty2 Dec 14, 2020
7388256
move req check closer to useage
tty2 Dec 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 45 additions & 8 deletions estransport/logger.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"bufio"
"bytes"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
Expand All @@ -18,7 +19,12 @@ import (
"time"
)

var debugLogger DebuggingLogger
var (
debugLogger DebuggingLogger
errRequestEmpty = errors.New("request is empty")
errRequestURLEmpty = errors.New("request URL is empty")
errResponseEmpty = errors.New("response is empty")
)

// Logger defines an interface for logging request and response.
//
Expand Down Expand Up @@ -80,14 +86,20 @@ type debuggingLogger struct {
// LogRoundTrip prints the information about request and response.
//
func (l *TextLogger) LogRoundTrip(req *http.Request, res *http.Response, err error, start time.Time, dur time.Duration) error {
if req == nil {
return errRequestEmpty
}
if req.URL == nil {
return errRequestURLEmpty
}
fmt.Fprintf(l.Output, "%s %s %s [status:%d request:%s]\n",
start.Format(time.RFC3339),
req.Method,
req.URL.String(),
resStatusCode(res),
dur.Truncate(time.Millisecond),
)
if l.RequestBodyEnabled() && req != nil && req.Body != nil && req.Body != http.NoBody {
if l.RequestBodyEnabled() && req.Body != nil && req.Body != http.NoBody {
var buf bytes.Buffer
if req.GetBody != nil {
b, _ := req.GetBody()
Expand Down Expand Up @@ -118,6 +130,12 @@ func (l *TextLogger) ResponseBodyEnabled() bool { return l.EnableResponseBody }
// LogRoundTrip prints the information about request and response.
//
func (l *ColorLogger) LogRoundTrip(req *http.Request, res *http.Response, err error, start time.Time, dur time.Duration) error {
if req == nil {
return errRequestEmpty
}
if req.URL == nil {
return errRequestURLEmpty
}
query, _ := url.QueryUnescape(req.URL.RawQuery)
if query != "" {
query = "?" + query
Expand All @@ -128,6 +146,9 @@ func (l *ColorLogger) LogRoundTrip(req *http.Request, res *http.Response, err er
color string
)

if res == nil {
return errResponseEmpty
}
status = res.Status
switch {
case res.StatusCode > 0 && res.StatusCode < 300:
Expand All @@ -152,7 +173,7 @@ func (l *ColorLogger) LogRoundTrip(req *http.Request, res *http.Response, err er
dur.Truncate(time.Millisecond),
)

if l.RequestBodyEnabled() && req != nil && req.Body != nil && req.Body != http.NoBody {
if l.RequestBodyEnabled() && req.Body != nil && req.Body != http.NoBody {
var buf bytes.Buffer
if req.GetBody != nil {
b, _ := req.GetBody()
Expand All @@ -165,7 +186,7 @@ func (l *ColorLogger) LogRoundTrip(req *http.Request, res *http.Response, err er
fmt.Fprint(l.Output, "\x1b[0m")
}

if l.ResponseBodyEnabled() && res != nil && res.Body != nil && res.Body != http.NoBody {
if l.ResponseBodyEnabled() && res.Body != nil && res.Body != http.NoBody {
defer res.Body.Close()
var buf bytes.Buffer
buf.ReadFrom(res.Body)
Expand Down Expand Up @@ -193,11 +214,19 @@ func (l *ColorLogger) ResponseBodyEnabled() bool { return l.EnableResponseBody }
// LogRoundTrip prints the information about request and response.
//
func (l *CurlLogger) LogRoundTrip(req *http.Request, res *http.Response, err error, start time.Time, dur time.Duration) error {
if req == nil {
return errRequestEmpty
}
if req.URL == nil {
return errRequestURLEmpty
}
reqURL := req.URL

var b bytes.Buffer

var query string
qvalues := url.Values{}
for k, v := range req.URL.Query() {
for k, v := range reqURL.Query() {
if k == "pretty" {
continue
}
Expand Down Expand Up @@ -227,7 +256,7 @@ func (l *CurlLogger) LogRoundTrip(req *http.Request, res *http.Response, err err
}

b.WriteString(" 'http://localhost:9200")
b.WriteString(req.URL.Path)
b.WriteString(reqURL.Path)
b.WriteString("?pretty")
if query != "" {
fmt.Fprintf(&b, "&%s", query)
Expand All @@ -252,7 +281,9 @@ func (l *CurlLogger) LogRoundTrip(req *http.Request, res *http.Response, err err
b.WriteRune('\n')

var status string
status = res.Status
if res != nil {
status = res.Status
}

fmt.Fprintf(&b, "# => %s [%s] %s\n", start.UTC().Format(time.RFC3339), status, dur.Truncate(time.Millisecond))
if l.ResponseBodyEnabled() && res != nil && res.Body != nil && res.Body != http.NoBody {
Expand Down Expand Up @@ -309,6 +340,12 @@ func (l *JSONLogger) LogRoundTrip(req *http.Request, res *http.Response, err err
b.Write(v)
}

if req == nil {
return errRequestEmpty
}
if req.URL == nil {
return errRequestURLEmpty
}
port := req.URL.Port()

b.WriteRune('{')
Expand Down Expand Up @@ -342,7 +379,7 @@ func (l *JSONLogger) LogRoundTrip(req *http.Request, res *http.Response, err err
b.WriteString(`{"request":{`)
b.WriteString(`"method":`)
appendQuote(req.Method)
if l.RequestBodyEnabled() && req != nil && req.Body != nil && req.Body != http.NoBody {
if l.RequestBodyEnabled() && req.Body != nil && req.Body != http.NoBody {
var buf bytes.Buffer
if req.GetBody != nil {
b, _ := req.GetBody()
Expand Down
98 changes: 98 additions & 0 deletions estransport/logger_internal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
package estransport

import (
"bytes"
"encoding/json"
"errors"
"fmt"
Expand Down Expand Up @@ -430,6 +431,103 @@ func TestTransportLogger(t *testing.T) {
})
}

func TestLoggers(t *testing.T) {
start := time.Now()
dur := time.Second
t.Run("TextLogger req == nil", func(t *testing.T) {
var buff bytes.Buffer
logger := TextLogger{Output: &buff}
err := logger.LogRoundTrip(nil, nil, nil, start, dur)
if !errors.Is(err, errRequestEmpty) {
t.Errorf("Expected error `%s`, got `%v`", errRequestEmpty, err)
}
})
t.Run("TextLogger req.URL == nil", func(t *testing.T) {
var buff bytes.Buffer
logger := TextLogger{Output: &buff}
req := http.Request{
Method: http.MethodGet,
}

err := logger.LogRoundTrip(&req, nil, nil, start, dur)
if !errors.Is(err, errRequestURLEmpty) {
t.Errorf("Expected error `%s`, got `%v`", errRequestURLEmpty, err)
}
})
t.Run("ColorLogger req == nil", func(t *testing.T) {
var buff bytes.Buffer
logger := ColorLogger{Output: &buff}
err := logger.LogRoundTrip(nil, nil, nil, start, dur)
if !errors.Is(err, errRequestEmpty) {
t.Errorf("Expected error `%s`, got `%v`", errRequestEmpty, err)
}
})
t.Run("ColorLogger req.URL == nil", func(t *testing.T) {
var buff bytes.Buffer
logger := ColorLogger{Output: &buff}
req := http.Request{
Method: http.MethodGet,
}

err := logger.LogRoundTrip(&req, nil, nil, start, dur)
if !errors.Is(err, errRequestURLEmpty) {
t.Errorf("Expected error `%s`, got `%v`", errRequestURLEmpty, err)
}
})
t.Run("ColorLogger res == nil", func(t *testing.T) {
var buff bytes.Buffer
logger := ColorLogger{Output: &buff}
req, err := http.NewRequest(http.MethodGet, "http:example.com", nil)
if err != nil {
t.Errorf("Unexpected error: %s", err)
}
err = logger.LogRoundTrip(req, nil, nil, start, dur)
if !errors.Is(err, errResponseEmpty) {
t.Errorf("Expected error `%s`, got `%v`", errResponseEmpty, err)
}
})
t.Run("CurlLogger req == nil", func(t *testing.T) {
var buff bytes.Buffer
logger := CurlLogger{Output: &buff}
err := logger.LogRoundTrip(nil, nil, nil, start, dur)
if !errors.Is(err, errRequestEmpty) {
t.Errorf("Expected error `%s`, got `%v`", errRequestEmpty, err)
}
})
t.Run("CurlLogger req.URL == nil", func(t *testing.T) {
var buff bytes.Buffer
logger := CurlLogger{Output: &buff}
req := http.Request{
Method: http.MethodGet,
}

err := logger.LogRoundTrip(&req, nil, nil, start, dur)
if !errors.Is(err, errRequestURLEmpty) {
t.Errorf("Expected error `%s`, got `%v`", errRequestURLEmpty, err)
}
})
t.Run("JSONLogger req == nil", func(t *testing.T) {
var buff bytes.Buffer
logger := JSONLogger{Output: &buff}
err := logger.LogRoundTrip(nil, nil, nil, start, dur)
if !errors.Is(err, errRequestEmpty) {
t.Errorf("Expected error `%s`, got `%v`", errRequestEmpty, err)
}
})
t.Run("JSONLogger req.URL == nil", func(t *testing.T) {
var buff bytes.Buffer
logger := JSONLogger{Output: &buff}
req := http.Request{
Method: http.MethodGet,
}

err := logger.LogRoundTrip(&req, nil, nil, start, dur)
if !errors.Is(err, errRequestURLEmpty) {
t.Errorf("Expected error `%s`, got `%v`", errRequestURLEmpty, err)
}
})
}

func TestDebuggingLogger(t *testing.T) {
logger := &debuggingLogger{Output: ioutil.Discard}

Expand Down