extract handlers

Author: moukoublen

api/sample.http

@@ -5,6 +5,8 @@ Accept-Encoding: gzip, deflate, br
 GET http://localhost:8888/echo
 Accept: application/json
 Accept-Encoding: gzip, deflate, br
+Content-Type: application/json
+X-Auth-Key: _Named must your fear be before banish it you can_
 {
   "glossary": {
     "title": "example glossary",

internal/httpx/handlers.go

@@ -0,0 +1,85 @@
+package httpx
+
+import (
+	"encoding/json"
+	"io"
+	"net/http"
+	"strings"
+
+	"github.com/moukoublen/goboilerplate/build"
+	"github.com/moukoublen/goboilerplate/internal/logx"
+)
+
+func AboutHandler(w http.ResponseWriter, r *http.Request) {
+	RespondJSON(r.Context(), w, http.StatusOK, build.GetInfo())
+}
+
+func EchoHandler(w http.ResponseWriter, r *http.Request) {
+	var cErr error
+	defer DrainAndCloseRequest(r, &cErr)
+
+	logger := logx.GetFromContext(r.Context())
+
+	if h := r.Header.Get("X-Auth-Key"); h != `_Named must your fear be before banish it you can_` {
+		w.WriteHeader(http.StatusUnauthorized)
+		return
+	}
+
+	b := map[string]any{}
+	{
+		b["method"] = r.Method
+		b["proto"] = r.Proto
+		b["protoMajor"] = r.ProtoMajor
+		b["protoMinor"] = r.ProtoMinor
+
+		if r.URL != nil {
+			u := map[string]any{}
+			u["scheme"] = r.URL.Scheme
+			u["opaque"] = r.URL.Opaque
+			u["user"] = r.URL.User
+			u["host"] = r.URL.Host
+			u["path"] = r.URL.Path
+			u["rawPath"] = r.URL.RawPath
+			u["omitHost"] = r.URL.OmitHost
+			u["forceQuery"] = r.URL.ForceQuery
+			u["rawQuery"] = r.URL.RawQuery
+			u["fragment"] = r.URL.Fragment
+			u["rawFragment"] = r.URL.RawFragment
+		}
+
+		headers := map[string]string{}
+		for k := range r.Header {
+			headers[k] = r.Header.Get(k)
+		}
+		b["headers"] = headers
+
+		if ct := r.Header.Get("Content-Type"); strings.Contains(ct, "application/json") {
+			body := map[string]any{}
+			_ = json.NewDecoder(r.Body).Decode(&body)
+			b["body"] = body
+		} else {
+			body, _ := io.ReadAll(r.Body)
+			b["body"] = body
+		}
+
+		b["contentLength"] = r.ContentLength
+		b["transferEncoding"] = r.TransferEncoding
+		b["host"] = r.Host
+
+		trailer := map[string]string{}
+		for k := range r.Trailer {
+			trailer[k] = r.Header.Get(k)
+		}
+		b["trailer"] = trailer
+
+		b["remoteAddr"] = r.RemoteAddr
+		b["requestURI"] = r.RequestURI
+	}
+
+	w.Header().Add("Content-Type", "application/json")
+	w.WriteHeader(http.StatusOK)
+	err := json.NewEncoder(w).Encode(b)
+	if err != nil {
+		logger.Error("error during json encoding", logx.Error(err))
+	}
+}

internal/httpx/inbound.go

@@ -10,20 +10,26 @@ import (
 	"github.com/moukoublen/goboilerplate/internal/logx"
 )
 
+// DrainAndCloseRequest can be used (most probably with defer) from the server side to ensure that the http request body is fully consumed and closed.
+func DrainAndCloseRequest(r *http.Request, errOut *error) {
+	if r == nil || r.Body == nil || r.Body == http.NoBody {
+		return
+	}
+
+	_, discardErr := io.Copy(io.Discard, r.Body)
+	closeErr := r.Body.Close()
+
+	if discardErr != nil || closeErr != nil {
+		*errOut = errors.Join(*errOut, discardErr, closeErr)
+	}
+}
+
 func ReadJSONRequest(r *http.Request, decodeTo any) (e error) {
 	if r == nil || r.Body == nil || r.Body == http.NoBody {
 		return nil
 	}
 
-	defer func() {
-		_, discardErr := io.Copy(io.Discard, r.Body)
-		closeErr := r.Body.Close()
-		e = errors.Join(
-			e,
-			discardErr,
-			closeErr,
-		)
-	}()
+	defer DrainAndCloseRequest(r, &e)
 
 	if err := json.NewDecoder(r.Body).Decode(decodeTo); err != nil {
 		return err

internal/httpx/outbound.go

@@ -3,8 +3,8 @@ package httpx
 import (
 	"compress/flate"
 	"compress/gzip"
-	"context"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"io"
 	"net"
@@ -13,31 +13,30 @@ import (
 )
 
 // DrainAndCloseResponse can be used (most probably with defer) from the client side to ensure that the http response body is consumed til the end and closed.
-func DrainAndCloseResponse(res *http.Response) {
-	if res == nil || res.Body == nil {
+func DrainAndCloseResponse(res *http.Response, errOut *error) {
+	if res == nil || res.Body == nil || res.Body == http.NoBody {
 		return
 	}
 
-	_, _ = io.Copy(io.Discard, res.Body)
-	_ = res.Body.Close()
-}
+	_, discardErr := io.Copy(io.Discard, res.Body)
+	closeErr := res.Body.Close()
 
-type InnerClient interface {
-	Do(req *http.Request) (*http.Response, error)
+	if discardErr != nil || closeErr != nil {
+		*errOut = errors.Join(*errOut, discardErr, closeErr)
+	}
 }
 
-// Client wraps an http.Client and offers `DoAndDecode` as an extra function.
-type Client struct {
-	InnerClient
+type HTTPClient interface {
+	Do(req *http.Request) (*http.Response, error)
 }
 
-// DoAndDecode performs the request (req) and tries to json decodes the response to output, it handles gzip and flate compression and also logs in debug level the http transaction (request/response).
-func (c *Client) DoAndDecode(_ context.Context, req *http.Request, output any) error {
+// DoAndDecode performs the request (req) and tries to json decodes the response to output, it handles gzip and flate compression.
+func DoAndDecode(c HTTPClient, req *http.Request, output any) (er error) {
 	res, err := c.Do(req)
 	if err != nil {
 		return err
 	}
-	defer DrainAndCloseResponse(res)
+	defer DrainAndCloseResponse(res, &er)
 
 	if res.StatusCode >= http.StatusBadRequest {
 		return NewStatusCodeError(res.StatusCode)

internal/httpx/router.go

@@ -11,7 +11,6 @@ import (
 	"github.com/go-chi/chi/v5"
 	"github.com/go-chi/chi/v5/middleware"
 	"github.com/knadh/koanf/v2"
-	"github.com/moukoublen/goboilerplate/build"
 	"github.com/moukoublen/goboilerplate/internal/httpx/httplog"
 	"github.com/moukoublen/goboilerplate/internal/logx"
 )
@@ -121,21 +120,6 @@ func LogRoutes(ctx context.Context, r *chi.Mux) {
 	}
 }
 
-func AboutHandler(w http.ResponseWriter, r *http.Request) {
-	RespondJSON(r.Context(), w, http.StatusOK, build.GetInfo())
-}
-
-func EchoHandler(w http.ResponseWriter, r *http.Request) {
-	logger := logx.GetFromContext(r.Context())
-
-	req := map[string]any{}
-	if err := ReadJSONRequest(r, &req); err != nil {
-		logger.Error("error reading request", logx.Error(err))
-	}
-
-	RespondJSON(r.Context(), w, http.StatusOK, req)
-}
-
 // StartListenAndServe creates and runs server.ListenAndServe in a separate go routine.
 // Any error produced by ListenAndServe will be sent to fatalErrCh.
 // It returns the server struct.