feat(pkg): add logging on each request and response from internal http client

Author: henrybarreto

pkg/api/internalclient/client.go

@@ -8,7 +8,7 @@ import (
 
 	resty "github.com/go-resty/resty/v2"
 	"github.com/shellhub-io/shellhub/pkg/worker"
-	"github.com/sirupsen/logrus"
+	log "github.com/sirupsen/logrus"
 )
 
 type Client interface {
@@ -35,7 +35,7 @@ type Config struct {
 
 type client struct {
 	http   *resty.Client
-	logger *logrus.Logger
+	logger *log.Logger
 	worker worker.Client
 
 	Config *Config
@@ -88,6 +88,32 @@ func NewClient(opts ...clientOption) (Client, error) {
 		return r.StatusCode() >= http.StatusInternalServerError && r.StatusCode() != http.StatusNotImplemented
 	})
 
+	httpClient.OnBeforeRequest(func(c *resty.Client, r *resty.Request) error {
+		// NOTE: Add a unique request ID to each request for better traceability.
+		r.Header.Set("X-Request-Id", randomString(32))
+
+		log.WithFields(log.Fields{
+			"id":      r.Header.Get("X-Request-Id"),
+			"attempt": r.Attempt,
+			"method":  r.Method,
+			"url":     r.URL,
+		}).Info("internal client request send")
+
+		return nil
+	})
+
+	httpClient.OnAfterResponse(func(c *resty.Client, r *resty.Response) error {
+		log.WithFields(log.Fields{
+			"id":      r.Header().Get("X-Request-Id"),
+			"attempt": r.Request.Attempt,
+			"method":  r.Request.Method,
+			"url":     r.Request.URL,
+			"status":  r.StatusCode(),
+		}).Info("internal client response received")
+
+		return nil
+	})
+
 	return c, nil
 }
 

pkg/api/internalclient/util.go

@@ -0,0 +1,54 @@
+package internalclient
+
+// NOTE: Code adapted from github.com/labstack/echo/[email protected]/middleware/util.go.
+
+import (
+	"bufio"
+	"crypto/rand"
+	"io"
+	"sync"
+)
+
+// https://tip.golang.org/doc/go1.19#:~:text=Read%20no%20longer%20buffers%20random%20data%20obtained%20from%20the%20operating%20system%20between%20calls
+var randomReaderPool = sync.Pool{New: func() interface{} {
+	return bufio.NewReader(rand.Reader)
+}}
+
+const (
+	randomStringCharset    = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
+	randomStringCharsetLen = 52 // len(randomStringCharset)
+	randomStringMaxByte    = 255 - (256 % randomStringCharsetLen)
+)
+
+func randomString(length uint8) string {
+	reader := randomReaderPool.Get().(*bufio.Reader)
+	defer randomReaderPool.Put(reader)
+
+	b := make([]byte, length)
+	r := make([]byte, length+(length/4)) // perf: avoid read from rand.Reader many times
+	var i uint8 = 0
+
+	// security note:
+	// we can't just simply do b[i]=randomStringCharset[rb%len(randomStringCharset)],
+	// len(len(randomStringCharset)) is 52, and rb is [0, 255], 256 = 52 * 4 + 48.
+	// make the first 48 characters more possibly to be generated then others.
+	// So we have to skip bytes when rb > randomStringMaxByte
+
+	for {
+		_, err := io.ReadFull(reader, r)
+		if err != nil {
+			panic("unexpected error happened when reading from bufio.NewReader(crypto/rand.Re der)")
+		}
+		for _, rb := range r {
+			if rb > randomStringMaxByte {
+				// Skip this number to avoid bias.
+				continue
+			}
+			b[i] = randomStringCharset[rb%randomStringCharsetLen]
+			i++
+			if i == length {
+				return string(b)
+			}
+		}
+	}
+}