Expose http middlewares

Author: zivkovicmilos

faucet.go

@@ -30,9 +30,12 @@ type Faucet struct {
 
 	mux *chi.Mux // HTTP routing
 
-	config         *config.Config     // faucet configuration
-	middlewares    []Middleware       // request middlewares
-	handlers       []Handler          // request handlers
+	config *config.Config // faucet configuration
+
+	httpMiddlewares []func(http.Handler) http.Handler // http middlewares (http.Handler -> http.Handler)
+	rpcMiddlewares  []Middleware                      // JSON-RPC request middlewares (Handler -> Handler)
+	rpcHandlers     []Handler                         // JSON-RPC request handlers
+
 	prepareTxMsgFn PrepareTxMessageFn // transaction message creator
 
 	maxSendAmount std.Coins // the max send amount per drip
@@ -52,13 +55,13 @@ func NewFaucet(
 		logger:         noopLogger,
 		config:         config.DefaultConfig(),
 		prepareTxMsgFn: defaultPrepareTxMessage,
-		middlewares:    nil, // no middlewares by default
+		rpcMiddlewares: nil, // no rpcMiddlewares by default
 
 		mux: chi.NewMux(),
 	}
 
 	// Set the single default HTTP handler
-	f.handlers = []Handler{
+	f.rpcHandlers = []Handler{
 		{
 			f.defaultHTTPHandler,
 			"/",
@@ -99,11 +102,17 @@ func NewFaucet(
 	// Branch off another route group, so they don't influence
 	// "standard" routes like health
 	f.mux.Group(func(r chi.Router) {
-		for _, h := range f.handlers {
+		// Apply HTTP transport middlewares
+		for _, mw := range f.httpMiddlewares {
+			r.Use(mw)
+		}
+
+		// Apply JSON-RPC request middlewares
+		for _, h := range f.rpcHandlers {
 			r.Post(h.Pattern,
 				wrapJSONRPC(
 					h.HandlerFunc,
-					f.middlewares...,
+					f.rpcMiddlewares...,
 				),
 			)
 		}

faucet_test.go

@@ -86,7 +86,7 @@ func TestFaucet_NewFaucet(t *testing.T) {
 			&mockEstimator{},
 			&mockClient{},
 			WithConfig(config.DefaultConfig()),
-			WithHandlers(handlers),
+			WithRPCHandlers(handlers),
 		)
 
 		require.NotNil(t, f)

handler.go

@@ -24,7 +24,7 @@ var (
 	errInvalidMethod      = errors.New("unknown RPC method call")
 )
 
-// wrapJSONRPC wraps the given handler and middlewares into a JSON-RPC 2.0 pipeline
+// wrapJSONRPC wraps the given handler and rpcMiddlewares into a JSON-RPC 2.0 pipeline
 func wrapJSONRPC(handlerFn HandlerFunc, mws ...Middleware) http.HandlerFunc {
 	callChain := chainMiddlewares(mws...)(handlerFn)
 
@@ -60,7 +60,7 @@ func wrapJSONRPC(handlerFn HandlerFunc, mws ...Middleware) http.HandlerFunc {
 			}
 
 			// Parse the request.
-			// This executes all the middlewares, and
+			// This executes all the rpcMiddlewares, and
 			// finally the base handler for the endpoint
 			resp := callChain(ctx, req)
 
@@ -84,7 +84,7 @@ func wrapJSONRPC(handlerFn HandlerFunc, mws ...Middleware) http.HandlerFunc {
 	}
 }
 
-// chainMiddlewares combines the given middlewares
+// chainMiddlewares combines the given rpcMiddlewares
 func chainMiddlewares(mw ...Middleware) Middleware {
 	return func(final HandlerFunc) HandlerFunc {
 		h := final

options.go

@@ -2,6 +2,7 @@ package faucet
 
 import (
 	"log/slog"
+	"net/http"
 
 	"github.com/gnolang/faucet/config"
 )
@@ -22,18 +23,26 @@ func WithConfig(c *config.Config) Option {
 	}
 }
 
-// WithMiddlewares specifies the request middlewares for the faucet.
-// Middlewares are applied for each handler
+// WithMiddlewares specifies the rpc request middlewares for the faucet.
+// Middlewares are applied for each endpoint
 func WithMiddlewares(middlewares []Middleware) Option {
 	return func(f *Faucet) {
-		f.middlewares = middlewares
+		f.rpcMiddlewares = middlewares
 	}
 }
 
-// WithHandlers specifies the HTTP handlers for the faucet
-func WithHandlers(handlers []Handler) Option {
+// WithHTTPMiddlewares specifies the http request middlewares for the faucet.
+// Middlewares are applied for each endpoint
+func WithHTTPMiddlewares(middlewares []func(http.Handler) http.Handler) Option {
 	return func(f *Faucet) {
-		f.handlers = append(f.handlers, handlers...)
+		f.httpMiddlewares = middlewares
+	}
+}
+
+// WithRPCHandlers specifies the HTTP handlers for the faucet
+func WithRPCHandlers(handlers []Handler) Option {
+	return func(f *Faucet) {
+		f.rpcHandlers = append(f.rpcHandlers, handlers...)
 	}
 }