middleware

package

v0.0.0-...-bf09d72 Latest Latest Go to latest Published: Dec 15, 2020 License: Apache-2.0 Imports: 15 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	HeaderRequestID = "x-request-id"
)

This section is empty.

func GetDefaultLogger(serviceName, environment string, level int) *logrus.Entry

GetDefaultLogger gets a default logger to use. level is a number from 0-7, 0 being the most strict and 7 the most verbose

func GetInsecureUserIDFromContext(ctx context.Context) string

getInsecureUserIDFromContext returns the user id or empty string if missing

func GetLoggerFromContext(ctx context.Context) *logrus.Entry

GetLoggerFromContext returns a logrus entry from the context, defaulting to a standard one if its not found

func GetRequestIDFromContext(ctx context.Context) string

GetRequestIDFromContext returns the requestID or empty string if missing

func HandlerFunc(h func(w http.ResponseWriter, r *http.Request) error) http.Handler

HandlerFunc converts a handler with an error to a standard handler

func NoCache(h http.Handler) http.Handler

NoCache will add the following headers to the response:

Cache-Control: no-cache, no-store, must-revalidate
Pragma: no-cache
Expires: 0

func Recovery(h http.Handler) http.Handler

Recovery handles panics

func RequestID(h http.Handler) http.Handler

RequestID adds a request id to the context, if available it will use the one in the x-request-id header

type JWTDecoder interface {
	DecodeSegment(seg string) ([]byte, error)
}

type Logger interface {
	Log(h http.Handler) http.Handler
}

Logger injects a logger into the context

func NewLogrusLogger(baseEntry *logrus.Entry, logRequests bool) Logger

NewLogrusLogger allows you to setup a base entry to use for logging

type Timer interface {
	Time(name string) alice.Constructor
}

Timer can time a handler and log it

func NewNullTimer() Timer

type UserIDIngector interface {
	Inject(h http.Handler) http.Handler
}

UserIDIngector injects a UserID from a JWT into the context

func NewUserIDInjector(jwt JWTDecoder) UserIDIngector

NewLogrusLogger allows you to setup a base entry to use for logging