middleware

README

go-middleware

A collection of generic go middlewares.

usage

utilities

middleware chaining

This module provides a function to chain middlewares together to avoid needing to wrap each middleware around the next which is harder to reason about. It's unfortunately, not as simple as some web frameworks' router.Use functions. It comes almost directly from the example provided by the ogen project.

import (
        "net/http"
        mw "go.finelli.dev/middleware"
        "go.finelli.dev/middleware/requestid"
        chi "github.com/go-chi/chi/v5/middleware"
)

// ...

        mux := http.NewServeMux()

        // ...

        &http.Server{
                Handler: mw.Chain(mux,
                        chi.Logger,
                        chi.Recoverer,
                        requestid.New(),
                ),
        }

// ...

middlewares

requestid

The requestid middleware is heavily inspired by the gin version. It also allows the possibility to override the generation function (something which is helpful during testing for example).

import "go.finelli.dev/middleware/requestid"

// ...

        &http.Server{
                Handler: requestid.New()(mux),
        }

        // or with customization

        &http.Server{
                Handler: requestid.New(requestid.WithHeader("X-Req-ID"))(mux),
        }

// ...

You can then retrieve the id in your routes:

import "go.finelli.dev/middleware/requestid"

func Route(w http.ResponseWriter, r *http.Request) {
        rid := requestid.Get(r.Context())
        // ...
}

There's also a middleware to automatically inject the request id into a zerolog hlog context.

import (
        "os"

        "github.com/rs/zerolog"
        "github.com/rs/zerolog/hlog"
        "go.finelli.dev/middleware/requestid"
)

// ...

        log := zerolog.New(os.Stdout).With().Timestamp().Logger()
        mux := http.NewServeMux()

        // ...

        &http.Server{
                Handler: requestid.New()(hlog.NewHandler(log)(
                        hlog.AccessHandler(/*...*/)(
                                requestid.LogHandler("request_id")(mux)))),
        }

// ...

func Route(w http.ResponseWriter, r *http.Request) {
        log := hlog.FromRequest(r)

        // these log messages have the "request_id" key populated now
        log.Info().Msg("test log message")

        // ...
}

license

Copyright 2024 Mario Finelli

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Documentation

Overview

The middleware package provides middleware helpers.

Index

• func Chain(h http.Handler, middlewares ...middleware) http.Handler

Functions

func Chain

func Chain(h http.Handler, middlewares ...middleware) http.Handler

Wraps the given handler with the provided middlewares.