1
0
mirror of synced 2024-11-22 04:56:06 +03:00

Add logger to client (#75)

This commit is contained in:
tishmaria90 2021-11-22 16:16:01 +03:00 committed by GitHub
parent 1306d648f6
commit 97bec2e80f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 70 additions and 4 deletions

View File

@ -6,6 +6,7 @@ import (
"errors" "errors"
"fmt" "fmt"
"io" "io"
"log"
"net/http" "net/http"
"net/url" "net/url"
"strconv" "strconv"
@ -28,6 +29,22 @@ func NewWithClient(url string, token string, client *http.Client) *MgClient {
} }
} }
// WithLogger sets the provided logger instance into the Client
func (c *MgClient) WithLogger(logger BasicLogger) *MgClient {
c.logger = logger
return c
}
// writeLog writes to the log.
func (c *MgClient) writeLog(format string, v ...interface{}) {
if c.logger != nil {
c.logger.Printf(format, v...)
return
}
log.Printf(format, v...)
}
// TransportTemplates returns templates list // TransportTemplates returns templates list
// //
// Example: // Example:

25
v1/log.go Normal file
View File

@ -0,0 +1,25 @@
package v1
// BasicLogger provides basic functionality for logging.
type BasicLogger interface {
Printf(string, ...interface{})
}
// DebugLogger can be used to easily wrap any logger with Debugf method into the BasicLogger instance.
type DebugLogger interface {
Debugf(string, ...interface{})
}
type debugLoggerAdapter struct {
logger DebugLogger
}
// DebugLoggerAdapter returns BasicLogger that calls underlying DebugLogger.Debugf.
func DebugLoggerAdapter(logger DebugLogger) BasicLogger {
return &debugLoggerAdapter{logger: logger}
}
// Printf data in the log using DebugLogger.Debugf.
func (l *debugLoggerAdapter) Printf(format string, v ...interface{}) {
l.logger.Debugf(format, v...)
}

24
v1/log_test.go Normal file
View File

@ -0,0 +1,24 @@
package v1
import (
"fmt"
"testing"
"github.com/stretchr/testify/assert"
)
type wrappedLogger struct {
lastMessage string
}
func (w *wrappedLogger) Debugf(msg string, v ...interface{}) {
w.lastMessage = fmt.Sprintf(msg, v...)
}
func TestDebugLoggerAdapter_Printf(t *testing.T) {
wrapped := &wrappedLogger{}
logger := DebugLoggerAdapter(wrapped)
logger.Printf("Test message #%d", 1)
assert.Equal(t, "Test message #1", wrapped.lastMessage)
}

View File

@ -5,7 +5,6 @@ import (
"fmt" "fmt"
"io" "io"
"io/ioutil" "io/ioutil"
"log"
"net/http" "net/http"
"strings" "strings"
) )
@ -64,9 +63,9 @@ func makeRequest(reqType, url string, buf io.Reader, c *MgClient) ([]byte, int,
if c.Debug { if c.Debug {
if strings.Contains(url, "/files/upload") { if strings.Contains(url, "/files/upload") {
log.Printf("MG TRANSPORT API Request: %s %s %s [file data]", reqType, url, c.Token) c.writeLog("MG TRANSPORT API Request: %s %s %s [file data]", reqType, url, c.Token)
} else { } else {
log.Printf("MG TRANSPORT API Request: %s %s %s %v", reqType, url, c.Token, buf) c.writeLog("MG TRANSPORT API Request: %s %s %s %v", reqType, url, c.Token, buf)
} }
} }
@ -86,7 +85,7 @@ func makeRequest(reqType, url string, buf io.Reader, c *MgClient) ([]byte, int,
} }
if c.Debug { if c.Debug {
log.Printf("MG TRANSPORT API Response: %s", res) c.writeLog("MG TRANSPORT API Response: %s", res)
} }
return res, resp.StatusCode, err return res, resp.StatusCode, err

View File

@ -82,6 +82,7 @@ type MgClient struct {
Token string `json:"token"` Token string `json:"token"`
Debug bool `json:"debug"` Debug bool `json:"debug"`
httpClient *http.Client `json:"-"` httpClient *http.Client `json:"-"`
logger BasicLogger `json:"-"`
} }
// Channel type. // Channel type.