Documentation
¶
Index ¶
- Variables
- func CanonicalizeListFilters(session handlers.SessionManager) func(next http.Handler) http.Handler
- func CanonicalizeSearchParams(session handlers.SessionManager) func(next http.Handler) http.Handler
- func DetectClient(req *http.Request) models.ClientType
- func ExtractUserFromSession(users UserService, auth *auth0.Authenticator, session handlers.SessionManager, ...) func(next http.Handler) http.Handler
- func Logger(next http.Handler) http.Handler
- func NoCache(next http.Handler) http.Handler
- func Otel(next http.Handler) http.Handler
- func RateLimit(next http.Handler) http.Handler
- func Recoverer(next http.Handler) http.Handler
- func RequireValidUser(next http.Handler) http.Handler
- func SetClient(next http.Handler) http.Handler
- type AppConfig
- type RateLimiter
- type UserService
Constants ¶
This section is empty.
Variables ¶
var NewRateLimiter = sync.OnceValue(func() RateLimiter { strategy, err := realclientip.NewRightmostNonPrivateStrategy(clientIPHeader) if err != nil { panic("realclientip.NewRightmostNonPrivateStrategy returned error (bad input)") } lmt := tollbooth.NewLimiter(maxRequestsPerSecond, &limiter.ExpirableOptions{DefaultExpirationTTL: time.Hour}). SetIPLookup(limiter.IPLookup{ Name: clientIPHeader, IndexFromRight: 0, }). SetBurst(3) rateLimiter = RateLimiter{ strategy: strategy, limiter: lmt, } return rateLimiter })
NewRateLimiter initialises data for a rate limiter middleware.
Functions ¶
func CanonicalizeListFilters ¶ added in v0.221.2
CanonicalizeListFilters handles processing and storing the fully-specified, whitelisted list filters for the user.
func CanonicalizeSearchParams ¶ added in v0.221.2
CanonicalizeSearchParams processes and stores the search params requested by a user.
func DetectClient ¶ added in v0.154.0
func DetectClient(req *http.Request) models.ClientType
DetectClient detects the type of client accessing the app.
func ExtractUserFromSession ¶ added in v0.143.0
func ExtractUserFromSession( users UserService, auth *auth0.Authenticator, session handlers.SessionManager, httpClient *resty.Client, ) func(next http.Handler) http.Handler
ExtractUserFromSession will extract the user data from the session, retrieve the user details from the backend and then store the user object in the context for use by later handlers.
func RateLimit ¶
RateLimit middleware will try to rate limit incoming requests with a pre-defined strategy.
func Recoverer ¶ added in v0.134.0
Recoverer is a modified version of the standard chi Recoverer middleware that additional logs to the GCP error console.
func RequireValidUser ¶ added in v0.143.0
RequireValidUser will ensure that protected routes have a valid user status before continuing.
Types ¶
type RateLimiter ¶
type RateLimiter struct {
// contains filtered or unexported fields
}
RateLimiter holds options for controlling a rate limiter middleware.
Source Files