router

type CapturingSender ¶

type CapturingSender struct {
	Response *backend.CallResourceResponse
}

CapturingSender is a backend.CallResourceResponseSender that captures the sent response, allowing other to tweak with it and send it afterwards.

func (c *CapturingSender) Send(res *backend.CallResourceResponse) error

type HandlerFunc ¶

type HandlerFunc func(context.Context, *backend.CallResourceRequest, backend.CallResourceResponseSender)

HandlerFunc defines the signatures handlers need to have in order to be used in this router.

var DefaultNotFoundHandler HandlerFunc = func(
	ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender,
) {
	_ = sender.Send(&backend.CallResourceResponse{
		Status: http.StatusNotFound,
		Body:   []byte(fmt.Sprintf("no route match for path %s", req.Path)),
	})
}

type JSONErrorHandler ¶

type JSONErrorHandler func(err plugin.Error) (int, JSONResponse)

JSONErrorHandler is a function that takes an error and transforms it into an HTTP code and JSON response pair. It is used by JSONRouter when processing errors returned by route handlers.

type JSONErrorResponse ¶

type JSONErrorResponse struct {
	Code  int    `json:"code"`
	Error string `json:"error"`
}

JSONErrorResponse is the default response format used to render errors from JSON route handlers.

type JSONHandlerFunc ¶

type JSONHandlerFunc func(context.Context, JSONRequest) (JSONResponse, error)

JSONHandlerFunc is a JSON request handler, that takes a context and request and returns a response or an error. It's valid to return a response and a nil error, an error and a nil response OR a nil response and a nil error. In the latter case the response is interpreted as a successful 204 No Content response.

type JSONRequest ¶

type JSONRequest struct {
	Method  string
	URL     url.URL
	Vars    Vars
	Headers http.Header
	Context backend.PluginContext
	Body    io.Reader
}

JSONRequest is the request that is parsed by JSONRouter and passed to its handlers. It contains all information that is available from the route (e.g. vars) or plugin request or plugin context.

type JSONResourceHandler ¶

type JSONResourceHandler struct {
	Create JSONHandlerFunc
	Read   JSONHandlerFunc
	Update JSONHandlerFunc
	Delete JSONHandlerFunc
	List   JSONHandlerFunc
}

JSONResourceHandler is a resource handler that uses the following routing convention:

* GET "/{name}" - `List` all resources "name" * POST "/{name}" - `Create` a new resource "name" * GET "/{name}/{id}" - `Read` a resource "name" with id "id" * PUT "/{name}/{id}" - `Update` a resource "name" with id "id" * DELETE "/{name}/{id}" - `Delete` a resource "name" with id "id"

type JSONResponse ¶

type JSONResponse any

JSONResponse is the response that is returned by JSONRouter handlers. It is serialized to JSON by the router and sent to the requester. Therefore the response must be a JSON-marshalable value, or nil.

type JSONRouter ¶

type JSONRouter struct {
	*Subrouter
	// contains filtered or unexported fields
}

JSONRouter is a router that assumes that responses are JSON-encoded messages and errors carry response codes. JSON router will automatically serialize responses to JSON and send them to the requester, or send back erroneous responses with codes passed in the error (or fall back to 500 if no code is found). For errors it will return a JSON response with error code and err.Error() message. For 500 errors the message will be a generic "internal server error" message.

func NewJSONRouter() *JSONRouter

func NewJSONRouterWithErrorHandler(errHandler JSONErrorHandler) *JSONRouter

func (j *JSONRouter) Handle(path string, handler JSONHandlerFunc, methods ...string) *RouteHandler

func (j *JSONRouter) HandleResource(name string, handler JSONResourceHandler) []*RouteHandler

func (j *JSONRouter) HandleWithCode(path string, handler JSONHandlerFunc, okCode int, methods ...string) *RouteHandler

func (j *JSONRouter) Subroute(path string) *JSONRouter

func (j *JSONRouter) SubrouteWithErrorHandler(path string, errHandler JSONErrorHandler) *JSONRouter

func (j *JSONRouter) WrapHandlerFunc(handler JSONHandlerFunc, okCode int) HandlerFunc

type MiddlewareFunc ¶

type MiddlewareFunc func(HandlerFunc) HandlerFunc

MiddlewareFunc is a function that receives a HandlerFunc and returns another HandlerFunc. This allows one to intercept incoming request, before and after the actual handler execution.

func NewCapturingMiddleware(f func(ctx context.Context, r *backend.CallResourceRequest, n NextFunc)) MiddlewareFunc

func NewLoggingMiddleware(logger logging.Logger) MiddlewareFunc

func NewMetricsMiddleware(cfg metrics.Config, registerer prometheus.Registerer) MiddlewareFunc

func NewTracingMiddleware(tracer trace.Tracer) MiddlewareFunc

func (m MiddlewareFunc) Middleware(handler HandlerFunc) HandlerFunc

type NextFunc ¶

type NextFunc func(ctx context.Context) *backend.CallResourceResponse

NextFunc is the main function to call the downstream middleware when using a capturing middleware.

type ResourceGroupRouter ¶

type ResourceGroupRouter struct {
	*JSONRouter
	// contains filtered or unexported fields
}

ResourceGroupRouter is a Router which exposes generic CRUD routes for every resource contained in a given group.

func NewResourceGroupRouter(
	resourceGroup resource.KindCollection,
	namespace string,
	clientGenerator resource.ClientGenerator,
) (*ResourceGroupRouter, error)

func NewResourceGroupRouterWithStore(
	resourceGroup resource.KindCollection,
	namespace string,
	store Store,
) (*ResourceGroupRouter, error)

type RouteHandler ¶

type RouteHandler struct {
	// contains filtered or unexported fields
}

RouteHandler is a Handler function assigned to a route

func (h *RouteHandler) Methods(methods []string) *RouteHandler

func (h *RouteHandler) Name(name string) *RouteHandler

type RouteInfo ¶

type RouteInfo struct {
	// Name is the user-provided name on the route, if a name was provided
	Name string
	// Path is the matched route path, as provided by the user when adding the route to the router
	Path string
	// Method is the matched route method
	Method string
}

RouteInfo stores information about a matched route

func MatchedRouteFromContext(ctx context.Context) RouteInfo

type Router ¶

type Router struct {
	// Handler called when there's no route match.
	NotFoundHandler HandlerFunc
	// contains filtered or unexported fields
}

Router is a simple request router specific to the grafana plugin SDK backend.CallResourceRequest HTTP calls. It allows the user to treat the grafana plugin backend as a traditional HTTP server, registering routes and using path parameters as normal.

func NewRouter() *Router

func (r *Router) CallResource(
	ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender,
) error

func (r *Router) Handle(path string, handler HandlerFunc, methods ...string) *RouteHandler

func (r *Router) ListenAndServe() error

func (r *Router) RouteByName(name string) *RouteHandler

func (r *Router) Subrouter(path string) *Subrouter

func (r *Router) Use(middlewares ...middleware)

type Store ¶

type Store interface {
	Add(ctx context.Context, obj resource.Object) (resource.Object, error)
	Get(ctx context.Context, kind string, identifier resource.Identifier) (resource.Object, error)
	List(ctx context.Context, kind, namespace string, filters ...string) (resource.ListObject, error)
	Update(ctx context.Context, obj resource.Object) (resource.Object, error)
	Delete(ctx context.Context, kind string, identifier resource.Identifier) error
}

Store is the interface for a CRD storage component.

type Subrouter ¶

type Subrouter struct {
	Router
	// contains filtered or unexported fields
}

Subrouter is a slightly-extended router meant for being registered a with Subrouter() on either a Router or Subrouter.

func (r *Subrouter) Path() string

type Vars ¶

type Vars map[string]string

Vars is a mapping of string keys to string values, which holds variables captured from the route. e.g. if the route was defined as "/foo/{id}/bar", Vars will contains a key with "id" and value passed in the actual URL.

func NewVars(from map[string]string) Vars

func VarsFromCtx(ctx context.Context) Vars

func (v Vars) Add(k, s string) Vars

func (v Vars) Get(k string) (string, bool)

func (v Vars) MustGet(k string) string