Alerting: Use mux router to match hooks, add support for path variables and methods (#79345)

* Use a router inside hooks rather than plain string matching

* Add test for mismatched method
This commit is contained in:
Alexander Weaver
2023-12-12 14:43:11 -06:00
committed by GitHub
parent 415f2c8458
commit aa63e91a43
2 changed files with 57 additions and 30 deletions

View File

@ -1,8 +1,10 @@
package api
import (
"net/http"
"net/url"
"github.com/gorilla/mux"
"github.com/grafana/grafana/pkg/api/response"
"github.com/grafana/grafana/pkg/infra/log"
contextmodel "github.com/grafana/grafana/pkg/services/contexthandler/model"
@ -11,31 +13,40 @@ import (
type RequestHandlerFunc func(*contextmodel.ReqContext) response.Response
type Hooks struct {
logger log.Logger
hooks map[string]RequestHandlerFunc
logger log.Logger
router *mux.Router
routeHooks map[*mux.Route]RequestHandlerFunc
}
// NewHooks creates an empty set of request handler hooks. Hooks can be used
// to replace handlers for specific paths.
func NewHooks(logger log.Logger) *Hooks {
return &Hooks{
logger: logger,
hooks: make(map[string]RequestHandlerFunc),
logger: logger,
router: mux.NewRouter(),
routeHooks: make(map[*mux.Route]RequestHandlerFunc),
}
}
// Add creates a new request hook for a path, causing requests to the path to
// be handled by the hook function, and not the original handler.
func (h *Hooks) Set(path string, hook RequestHandlerFunc) {
func (h *Hooks) Set(method string, path string, hook RequestHandlerFunc) {
h.logger.Info("Setting hook override for the specified route", "path", path)
h.hooks[path] = hook
route := h.router.NewRoute().Path(path).Methods(method)
h.routeHooks[route] = hook
}
// Get returns a hook if one is defined for the matching URL.
// Get also returns a bool indicating whether or not a matching hook exists.
func (h *Hooks) Get(url *url.URL) (RequestHandlerFunc, bool) {
hook, ok := h.hooks[url.Path]
return hook, ok
func (h *Hooks) Get(method string, url *url.URL) (RequestHandlerFunc, bool) {
req := http.Request{Method: method, URL: url}
match := mux.RouteMatch{}
if ok := h.router.Match(&req, &match); ok {
return h.routeHooks[match.Route], ok
}
return nil, false
}
// Wrap returns a new handler which will intercept paths with hooks configured,
@ -43,7 +54,7 @@ func (h *Hooks) Get(url *url.URL) (RequestHandlerFunc, bool) {
// then the given handler is invoked.
func (h *Hooks) Wrap(next RequestHandlerFunc) RequestHandlerFunc {
return func(req *contextmodel.ReqContext) response.Response {
if hook, ok := h.Get(req.Context.Req.URL); ok {
if hook, ok := h.Get(req.Context.Req.Method, req.Context.Req.URL); ok {
h.logger.Debug("Hook defined - invoking new handler", "path", req.Context.Req.URL.Path)
return hook(req)
}