pkg/web: closure-style middlewares (#51238)

* pkg/web: closure-style middlewares

Switches the middleware execution model from web.Handlers in a slice to
web.Middleware.
Middlewares are temporarily kept in a slice to preserve ordering, but
prior to execution they are applied, forming a giant call-stack, giving
granular control over the execution flow.

* pkg/middleware: adapt to web.Middleware

* pkg/middleware/recovery: use c.Req over req

c.Req gets updated by future handlers, while req stays static.

The current recovery implementation needs this newer information

* pkg/web: correct middleware ordering

* pkg/webtest: adapt middleware

* pkg/web/hack: set w and r onto web.Context

By adopting std middlewares, it may happen they invoke next(w,r) without
putting their modified w,r into the web.Context, leading old-style
handlers to operate on outdated fields.

pkg/web now takes care of this

* pkg/middleware: selectively use future context

* pkg/web: accept closure-style on Use()

* webtest: Middleware testing

adds a utility function to web/webtest to obtain a http.ResponseWriter,
http.Request and http.Handler the same as a middleware that runs would receive

* *: cleanup

* pkg/web: don't wrap Middleware from Router

* pkg/web: require chain to write response

* *: remove temp files

* webtest: don't require chain write

* *: cleanup
This commit is contained in:
sh0rez
2022-08-09 14:58:50 +02:00
committed by GitHub
parent 3893c46976
commit 534ece064b
17 changed files with 357 additions and 264 deletions
+13 -24
View File
@@ -29,8 +29,7 @@ import (
// Context represents the runtime context of current request of Macaron instance.
// It is the integration of most frequently used middlewares and helper methods.
type Context struct {
handlers []http.Handler
index int
mws []Middleware
*Router
Req *http.Request
@@ -39,30 +38,20 @@ type Context struct {
logger log.Logger
}
func (ctx *Context) handler() http.Handler {
if ctx.index < len(ctx.handlers) {
return ctx.handlers[ctx.index]
}
if ctx.index == len(ctx.handlers) {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
}
panic("invalid index for context handler")
}
// Next runs the next handler in the context chain
func (ctx *Context) Next() {
ctx.index++
ctx.run()
}
func (ctx *Context) run() {
for ctx.index <= len(ctx.handlers) {
ctx.handler().ServeHTTP(ctx.Resp, ctx.Req)
h := http.Handler(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {}))
for i := len(ctx.mws) - 1; i >= 0; i-- {
h = ctx.mws[i](h)
}
ctx.index++
if ctx.Resp.Written() {
return
}
rw := ctx.Resp
h.ServeHTTP(ctx.Resp, ctx.Req)
// Prevent the handler chain from not writing anything.
// This indicates nearly always that a middleware is misbehaving and not calling its next.ServeHTTP().
// In rare cases where a blank http.StatusOK without any body is wished, explicitly state that using w.WriteStatus(http.StatusOK)
if !rw.Written() {
panic("chain did not write HTTP response")
}
}