middleware

README

middleware

Useful middlewares for Pipes library.

What's in the box?

Context middleware

Creates request Context and passes it forward.

Panic recovery middleware

Handles panic and allows to provide user friendly message or redirect to error page using http.ResponseWriter.

Rate limiter middleware (NOT TESTED IN PRODUCTION)

Limits network requests from single IP using provided time function.

Cookie auth middleware

Decodes user object from requests cookie and adds to context

Documentation

Index

• Constants
• func AddOptions(options map[interface{}]interface{}) pipes.Middleware
• func Context(ctx context.Context, w http.ResponseWriter, r *http.Request, next pipes.Next)
• func CookieAuth(authCookieName string, cookieDec cookieDecoder, userFac userFactory) pipes.Middleware
• func LimitPerMinute(t time.Time) time.Time
• func LimitRate(timeFun func(time.Time) time.Time, limit int) pipes.Middleware
• func PanicHandler(...) pipes.Middleware

Constants

const User = pipes.ContextKey("User")

User context key

Functions

func AddOptions

func AddOptions(options map[interface{}]interface{}) pipes.Middleware

AddOptions adds context options

func Context

func Context(ctx context.Context, w http.ResponseWriter, r *http.Request, next pipes.Next)

Context adds context to the request pipeline

func CookieAuth

func CookieAuth(authCookieName string, cookieDec cookieDecoder, userFac userFactory) pipes.Middleware

CookieAuth creates cookie auth middleware.

func LimitPerMinute

func LimitPerMinute(t time.Time) time.Time

LimitPerMinute round time to a minute

func LimitRate

func LimitRate(timeFun func(time.Time) time.Time, limit int) pipes.Middleware

LimitRate creates rate limitter middleware using provided time bucketing function

func PanicHandler

func PanicHandler(handler func(ctx context.Context, w http.ResponseWriter, r *http.Request, err interface{})) pipes.Middleware

PanicHandler creates middleware which recovers from panic in the pipeline and can return user friedly message or page. Should be added as early as possible in the pipeline to handle panics from other middlewares.