mux

mux

A minimal HTTP router that wraps the https://github.com/julienschmidt/httprouter.

Quick Start

go get github.com/josestg/mux

Example

package main

import (
	"context"
	"log"
	"net/http"
	"os"
	"time"

	"github.com/google/uuid"
	"github.com/josestg/mux"
)

func main() {

	requestIDMaker := new(IDMaker)
	shutdownChannel := make(chan os.Signal, 1)

	router := mux.NewRouter(
		requestIDMaker,
		shutdownChannel,
		logger,
	)

	router.Get("/check", func(w http.ResponseWriter, r *http.Request) error {
		status := map[string]string{
			"status": "running",
		}
		return mux.ToJSON(r.Context(), w, &status, http.StatusOK)
	})

	router.With(auth).Post("/auth", func(w http.ResponseWriter, r *http.Request) error {
		data := struct {
			Status string
		}{
			Status: "Authenticated",
		}

		return mux.ToJSON(r.Context(), w, &data, http.StatusOK)
	})

	server := http.Server{
		Addr:    "0.0.0.0:8080",
		Handler: router,
	}

	routerErr := make(chan error, 1)
	go func() {
		log.Printf("server is listening on: %s", server.Addr)
		routerErr <- server.ListenAndServe()
	}()

	select {
	case <-shutdownChannel:
		if err := server.Shutdown(context.Background()); err != nil {
			_ = server.Close()
		}
	case err := <-routerErr:
		log.Printf("server not listening: %v", err)
	}
}

type IDMaker struct {
}

func (I IDMaker) NextRequestID() string {
	return uuid.NewString()
}

// logger is a logger middleware.
func logger(handleFunc mux.HandleFunc) mux.HandleFunc {
	return func(w http.ResponseWriter, r *http.Request) error {
		state, err := mux.GetState(r.Context())
		if err != nil {
			return mux.NewShutdownError(err.Error())
		}

		log.Println("request started")
		defer func() {
			log.Printf("request completed: %v", time.Since(state.RequestCreated))
		}()

		return handleFunc(w, r)
	}
}

// auth is a fake auth middleware.
func auth(handleFunc mux.HandleFunc) mux.HandleFunc {
	return func(w http.ResponseWriter, r *http.Request) error {
		var body struct {
			Password string `json:"password"`
		}

		if err := mux.FromJSON(r.Body, &body); err != nil {
			return mux.NewShutdownError(err.Error())
		}

		if body.Password != "secret" {
			resp := struct {
				Message string `json:"message"`
			}{
				Message: "Invalid password",
			}

			return mux.ToJSON(r.Context(), w, &resp, http.StatusUnauthorized)
		}

		return handleFunc(w, r)
	}
}