Initial commit

Author: aaronvb

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Aaron Van Bokhoven
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,14 @@
+# aaronvb/logrequest
+Package `aaronvb/logrequest` is a Go middleware log output inspired by the Ruby on Rails log out for requests. Example output:
+
+```sh
+Started GET "/" 127.0.0.1:12345 HTTP/1.1
+Completed 200 in 3.7455ms
+```
+
+The output can directly sent to `log.Logger` or to a map[string]string with the key `started` and `completed`.
+
+## Install
+```sh
+go get -u github.com/aaronvb/logrequest
+```

go.mod

@@ -0,0 +1,3 @@
+module github.com/aaronvb/logrequest
+
+go 1.14

logrequest.go

@@ -0,0 +1,63 @@
+package logrequest
+
+import (
+	"fmt"
+	"log"
+	"net/http"
+	"time"
+)
+
+// LogRequest struct
+// Pass values from middleware to this struct
+type LogRequest struct {
+	Writer  http.ResponseWriter
+	Request *http.Request
+	Handler http.Handler
+}
+
+type statusWriter struct {
+	http.ResponseWriter
+	statusCode int
+}
+
+// ToLogger will print the Started and Completed request info to the passed logger
+func (lr LogRequest) ToLogger(logger *log.Logger) {
+	sw, completedDuration := lr.parseRequest()
+	logger.Printf(`Started %s "%s" %s %s`, lr.Request.Method, lr.Request.URL.RequestURI(), lr.Request.RemoteAddr, lr.Request.Proto)
+	logger.Printf("Completed %d in %s", sw.statusCode, completedDuration)
+}
+
+// ToString will return a map with the key 'started' and 'completed' that contain
+// a string output for eacch
+func (lr LogRequest) ToString() map[string]string {
+	sw, completedDuration := lr.parseRequest()
+	ts := make(map[string]string)
+	ts["started"] = fmt.Sprintf(`Started %s "%s" %s %s`, lr.Request.Method, lr.Request.URL.RequestURI(), lr.Request.RemoteAddr, lr.Request.Proto)
+	ts["completed"] = fmt.Sprintf("Completed %d in %s", sw.statusCode, completedDuration)
+
+	return ts
+}
+
+// parseRequest will time the request and retrieve the status from the
+// ResponseWriter. Returns the statusWriter struct and the duration
+// of the request.
+func (lr LogRequest) parseRequest() (statusWriter, time.Duration) {
+	startTime := time.Now()
+	sw := statusWriter{ResponseWriter: lr.Writer}
+	lr.Handler.ServeHTTP(&sw, lr.Request)
+	return sw, time.Now().Sub(startTime)
+}
+
+func (w *statusWriter) WriteHeader(statusCode int) {
+	w.statusCode = statusCode
+	w.ResponseWriter.WriteHeader(statusCode)
+}
+
+func (w *statusWriter) Write(b []byte) (int, error) {
+	if w.statusCode == 0 {
+		w.statusCode = 200
+	}
+
+	n, err := w.ResponseWriter.Write(b)
+	return n, err
+}

logrequest_test.go

@@ -0,0 +1,124 @@
+package logrequest
+
+import (
+	"bytes"
+	"fmt"
+	"log"
+	"net/http"
+	"net/http/httptest"
+	"strings"
+	"testing"
+)
+
+func TestToLogger(t *testing.T) {
+	tables := []struct {
+		statusCode               int
+		method                   string
+		path                     string
+		expectedStartedResults   string
+		expectedCompletedResults string
+	}{
+		{http.StatusOK, http.MethodGet, "/foo", fmt.Sprintf(`Started %s "%s"`, http.MethodGet, "/foo"), fmt.Sprintf("Completed %d in", http.StatusOK)},
+		{http.StatusUnauthorized, http.MethodPost, "/bar/create", fmt.Sprintf(`Started %s "%s"`, http.MethodPost, "/bar/create"), fmt.Sprintf("Completed %d in", http.StatusUnauthorized)},
+		{http.StatusNotFound, http.MethodGet, "/hello/world", fmt.Sprintf(`Started %s "%s"`, http.MethodGet, "/hello/world"), fmt.Sprintf("Completed %d in", http.StatusNotFound)},
+		{http.StatusInternalServerError, http.MethodGet, "/", fmt.Sprintf(`Started %s "%s"`, http.MethodGet, "/"), fmt.Sprintf("Completed %d in", http.StatusInternalServerError)},
+		{http.StatusServiceUnavailable, http.MethodPut, "/foo/update", fmt.Sprintf(`Started %s "%s"`, http.MethodPut, "/foo/update"), fmt.Sprintf("Completed %d in", http.StatusServiceUnavailable)},
+	}
+
+	for _, table := range tables {
+		var str bytes.Buffer
+		var logger = log.Logger{}
+		logger.SetOutput(&str)
+
+		app := &application{
+			infoLog: &logger,
+		}
+		req, err := http.NewRequest(table.method, table.path, nil)
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		testHandler := http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
+			rw.WriteHeader(table.statusCode)
+		})
+
+		rr := httptest.NewRecorder()
+		handler := app.logRequestToLogger(testHandler)
+		handler.ServeHTTP(rr, req)
+
+		if strings.Contains(str.String(), table.expectedStartedResults) == false {
+			t.Errorf("Expected output was incorrect, %s does not contain %s", str.String(), table.expectedStartedResults)
+		}
+
+		if strings.Contains(str.String(), table.expectedCompletedResults) == false {
+			t.Errorf("Expected output was incorrect, %s does not contain %s", str.String(), table.expectedCompletedResults)
+		}
+	}
+}
+
+func TestToString(t *testing.T) {
+	tables := []struct {
+		statusCode               int
+		method                   string
+		path                     string
+		expectedStartedResults   string
+		expectedCompletedResults string
+	}{
+		{http.StatusOK, http.MethodGet, "/foo", fmt.Sprintf(`Started %s "%s"`, http.MethodGet, "/foo"), fmt.Sprintf("Completed %d in", http.StatusOK)},
+		{http.StatusUnauthorized, http.MethodPost, "/bar/create", fmt.Sprintf(`Started %s "%s"`, http.MethodPost, "/bar/create"), fmt.Sprintf("Completed %d in", http.StatusUnauthorized)},
+		{http.StatusNotFound, http.MethodGet, "/hello/world", fmt.Sprintf(`Started %s "%s"`, http.MethodGet, "/hello/world"), fmt.Sprintf("Completed %d in", http.StatusNotFound)},
+		{http.StatusInternalServerError, http.MethodGet, "/", fmt.Sprintf(`Started %s "%s"`, http.MethodGet, "/"), fmt.Sprintf("Completed %d in", http.StatusInternalServerError)},
+		{http.StatusServiceUnavailable, http.MethodPut, "/foo/update", fmt.Sprintf(`Started %s "%s"`, http.MethodPut, "/foo/update"), fmt.Sprintf("Completed %d in", http.StatusServiceUnavailable)},
+	}
+
+	for _, table := range tables {
+		var str bytes.Buffer
+		var logger = log.Logger{}
+		logger.SetOutput(&str)
+
+		app := &application{
+			infoLog: &logger,
+		}
+		req, err := http.NewRequest(table.method, table.path, nil)
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		testHandler := http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
+			rw.WriteHeader(table.statusCode)
+		})
+
+		rr := httptest.NewRecorder()
+		handler := app.logRequestToString(testHandler)
+		handler.ServeHTTP(rr, req)
+
+		if strings.Contains(str.String(), table.expectedStartedResults) == false {
+			t.Errorf("Expected output was incorrect, %s does not contain %s", str.String(), table.expectedStartedResults)
+		}
+
+		if strings.Contains(str.String(), table.expectedCompletedResults) == false {
+			t.Errorf("Expected output was incorrect, %s does not contain %s", str.String(), table.expectedCompletedResults)
+		}
+	}
+}
+
+// Helpers
+
+type application struct {
+	infoLog *log.Logger
+}
+
+func (app *application) logRequestToLogger(next http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		lr := LogRequest{Request: r, Writer: w, Handler: next}
+		lr.ToLogger(app.infoLog)
+	})
+}
+
+func (app *application) logRequestToString(next http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		lr := LogRequest{Request: r, Writer: w, Handler: next}
+		app.infoLog.Println(lr.ToString()["started"])
+		app.infoLog.Println(lr.ToString()["completed"])
+	})
+}