hmiddleware

func ACMEValidationMiddleware ¶ added in v0.0.4

func ACMEValidationMiddleware(validationURL *url.URL) func(http.Handler) http.Handler

ACMEValidationMiddleware implements the HTTP01 based redirect protocol specific to heroku ACM.

func CORS ¶

func CORS(next http.Handler) http.Handler

CORS adds Cross-Origin Resource Sharing headers to all outgoing requests. This is known as something that is kind of hard to get right. See docs at https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS for more information.

r := chi.NewRouter()
r.Use(CORS)

// OR

var h http.Handler

//nolint: gosec
if err := http.ListenAndServe(":"+os.Getenv("PORT"), CORS(h)); err != nil {
	log.Fatal(err)
}

Output:

func DisableKeepalive ¶

func DisableKeepalive(next http.Handler) http.Handler

DisableKeepalive instructs the Go HTTP stack to close the incoming HTTP connection once all requests processed by this middleware are complete.

r := chi.NewRouter()
r.Use(DisableKeepalive)

// OR

var h http.Handler

//nolint: gosec
if err := http.ListenAndServe(":"+os.Getenv("PORT"), DisableKeepalive(h)); err != nil {
	log.Fatal(err)
}

Output:

func EnsureTLS ¶

func EnsureTLS(next http.Handler) http.Handler

EnsureTLS ensures all incoming requests identify as having been proxied via https from the upstream reverse proxy. The way that this uses to check relies on the `X-Forwarded-Proto` header which is not defined by any formal standard. For more information on this header, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto.

r := chi.NewRouter()
r.Use(EnsureTLS)

// OR

var h http.Handler

//nolint: gosec
if err := http.ListenAndServe(":"+os.Getenv("PORT"), EnsureTLS(h)); err != nil {
	log.Fatal(err)
}

Output:

func PostRequestLogger ¶ added in v0.0.16

func PostRequestLogger(l logrus.FieldLogger) func(next http.Handler) http.Handler

PostRequestLogger is a middleware for the github.com/sirupsen/logrus to log requests. It logs things similar to heroku logs and adds remote_addr and user_agent. If you are using Chi, consider using the RequestLogger middleware instead.

func PreRequestLogger ¶ added in v0.0.16

func PreRequestLogger(l logrus.FieldLogger) func(next http.Handler) http.Handler

PreRequestLogger is a middleware for the github.com/sirupsen/logrus to log requests. It logs things similar to heroku logs and adds remote_addr and user_agent. If you are using Chi, consider using the RequestLogger middleware instead.

func RequestID ¶ added in v0.0.17

func RequestID(next http.Handler) http.Handler

func Tags ¶ added in v0.0.20

func Tags(next http.Handler) http.Handler

Tags provides a middleware function for seeding the context with a per-request tags that are eventually retrieved and logged by the StructuredLogger

r := chi.NewRouter()
r.Use(Tags)
logger := logrus.StandardLogger()
l := &StructuredLogger{
	Logger: logger,
}
r.Use(middleware.RequestLogger(l))

r.Get("/", func(w http.ResponseWriter, r *http.Request) {
	// foo=bar will show up in the HTTP request logs generated by StructuredLogger
	tags.Extract(r.Context()).Set("foo", "bar")
	w.WriteHeader(http.StatusOK)
})

Output: