mirror of https://github.com/grafana/grafana
Plugins: Auto instrumentation improvements (#94193)
Marcus Efraimsson
8 months ago
committed by
GitHub
parent
4a3c6325a4
commit
b28085110d
@ -1,59 +0,0 @@ |
||||
package pluginrequestmeta |
||||
|
||||
import ( |
||||
"context" |
||||
"errors" |
||||
|
||||
"github.com/grafana/grafana-plugin-sdk-go/backend" |
||||
) |
||||
|
||||
// StatusSource is an enum-like string value representing the source of a
|
||||
// plugin query data response status code
|
||||
type StatusSource string |
||||
|
||||
const ( |
||||
StatusSourcePlugin StatusSource = "plugin" |
||||
StatusSourceDownstream StatusSource = "downstream" |
||||
) |
||||
|
||||
// DefaultStatusSource is the default StatusSource that should be used when it is not explicitly set by the plugin.
|
||||
const DefaultStatusSource StatusSource = StatusSourcePlugin |
||||
|
||||
type statusSourceCtxKey struct{} |
||||
|
||||
// StatusSourceFromContext returns the plugin request status source stored in the context.
|
||||
// If no plugin request status source is stored in the context, [DefaultStatusSource] is returned.
|
||||
func StatusSourceFromContext(ctx context.Context) StatusSource { |
||||
value, ok := ctx.Value(statusSourceCtxKey{}).(*StatusSource) |
||||
if ok { |
||||
return *value |
||||
} |
||||
return DefaultStatusSource |
||||
} |
||||
|
||||
// WithStatusSource sets the plugin request status source for the context.
|
||||
func WithStatusSource(ctx context.Context, s StatusSource) context.Context { |
||||
return context.WithValue(ctx, statusSourceCtxKey{}, &s) |
||||
} |
||||
|
||||
// WithDownstreamStatusSource mutates the provided context by setting the plugin request status source to
|
||||
// StatusSourceDownstream. If the provided context does not have a plugin request status source, the context
|
||||
// will not be mutated. This means that [WithStatusSource] has to be called before this function.
|
||||
func WithDownstreamStatusSource(ctx context.Context) error { |
||||
v, ok := ctx.Value(statusSourceCtxKey{}).(*StatusSource) |
||||
if !ok { |
||||
return errors.New("the provided context does not have a plugin request status source") |
||||
} |
||||
*v = StatusSourceDownstream |
||||
return nil |
||||
} |
||||
|
||||
// StatusSourceFromPluginErrorSource takes an error source returned by a plugin and returns the corresponding
|
||||
// StatusSource. If the provided value is a zero-value (i.e.: the plugin did not set it), the function returns
|
||||
// DefaultStatusSource.
|
||||
func StatusSourceFromPluginErrorSource(pluginErrorSource backend.ErrorSource) StatusSource { |
||||
if pluginErrorSource == "" { |
||||
return DefaultStatusSource |
||||
} |
||||
return StatusSource(pluginErrorSource) |
||||
} |
||||
@ -1,50 +0,0 @@ |
||||
package pluginrequestmeta |
||||
|
||||
import ( |
||||
"context" |
||||
"testing" |
||||
|
||||
"github.com/stretchr/testify/require" |
||||
) |
||||
|
||||
func TestStatusSource(t *testing.T) { |
||||
t.Run("WithStatusSource", func(t *testing.T) { |
||||
ctx := context.Background() |
||||
ss := StatusSourceFromContext(ctx) |
||||
require.Equal(t, StatusSourcePlugin, ss) |
||||
|
||||
ctx = WithStatusSource(ctx, StatusSourceDownstream) |
||||
ss = StatusSourceFromContext(ctx) |
||||
require.Equal(t, StatusSourceDownstream, ss) |
||||
}) |
||||
|
||||
t.Run("WithDownstreamStatusSource", func(t *testing.T) { |
||||
t.Run("Returns error if no status source is set", func(t *testing.T) { |
||||
ctx := context.Background() |
||||
err := WithDownstreamStatusSource(ctx) |
||||
require.Error(t, err) |
||||
require.Equal(t, StatusSourcePlugin, StatusSourceFromContext(ctx)) |
||||
}) |
||||
|
||||
t.Run("Should mutate context if status source is set", func(t *testing.T) { |
||||
ctx := WithStatusSource(context.Background(), StatusSourcePlugin) |
||||
err := WithDownstreamStatusSource(ctx) |
||||
require.NoError(t, err) |
||||
require.Equal(t, StatusSourceDownstream, StatusSourceFromContext(ctx)) |
||||
}) |
||||
}) |
||||
|
||||
t.Run("StatusSourceFromContext", func(t *testing.T) { |
||||
t.Run("Background returns StatusSourcePlugin", func(t *testing.T) { |
||||
ctx := context.Background() |
||||
ss := StatusSourceFromContext(ctx) |
||||
require.Equal(t, StatusSourcePlugin, ss) |
||||
}) |
||||
|
||||
t.Run("Context with status source returns the set status source", func(t *testing.T) { |
||||
ctx := WithStatusSource(context.Background(), StatusSourcePlugin) |
||||
ss := StatusSourceFromContext(ctx) |
||||
require.Equal(t, StatusSourcePlugin, ss) |
||||
}) |
||||
}) |
||||
} |
||||
@ -1,86 +0,0 @@ |
||||
package clientmiddleware |
||||
|
||||
import ( |
||||
"context" |
||||
|
||||
"github.com/grafana/grafana-plugin-sdk-go/backend" |
||||
|
||||
"github.com/grafana/grafana/pkg/plugins/pluginrequestmeta" |
||||
) |
||||
|
||||
// NewPluginRequestMetaMiddleware returns a new backend.HandlerMiddleware that sets up the default
|
||||
// values for the plugin request meta in the context.Context. All middlewares that are executed
|
||||
// after this one are be able to access plugin request meta via the pluginrequestmeta package.
|
||||
func NewPluginRequestMetaMiddleware() backend.HandlerMiddleware { |
||||
return backend.HandlerMiddlewareFunc(func(next backend.Handler) backend.Handler { |
||||
return &PluginRequestMetaMiddleware{ |
||||
BaseHandler: backend.NewBaseHandler(next), |
||||
defaultStatusSource: pluginrequestmeta.DefaultStatusSource, |
||||
} |
||||
}) |
||||
} |
||||
|
||||
type PluginRequestMetaMiddleware struct { |
||||
backend.BaseHandler |
||||
defaultStatusSource pluginrequestmeta.StatusSource |
||||
} |
||||
|
||||
func (m *PluginRequestMetaMiddleware) withDefaultPluginRequestMeta(ctx context.Context) context.Context { |
||||
// Setup plugin request status source
|
||||
ctx = pluginrequestmeta.WithStatusSource(ctx, m.defaultStatusSource) |
||||
|
||||
return ctx |
||||
} |
||||
|
||||
func (m *PluginRequestMetaMiddleware) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) { |
||||
ctx = m.withDefaultPluginRequestMeta(ctx) |
||||
return m.BaseHandler.QueryData(ctx, req) |
||||
} |
||||
|
||||
func (m *PluginRequestMetaMiddleware) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error { |
||||
ctx = m.withDefaultPluginRequestMeta(ctx) |
||||
return m.BaseHandler.CallResource(ctx, req, sender) |
||||
} |
||||
|
||||
func (m *PluginRequestMetaMiddleware) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) { |
||||
ctx = m.withDefaultPluginRequestMeta(ctx) |
||||
return m.BaseHandler.CheckHealth(ctx, req) |
||||
} |
||||
|
||||
func (m *PluginRequestMetaMiddleware) CollectMetrics(ctx context.Context, req *backend.CollectMetricsRequest) (*backend.CollectMetricsResult, error) { |
||||
ctx = m.withDefaultPluginRequestMeta(ctx) |
||||
return m.BaseHandler.CollectMetrics(ctx, req) |
||||
} |
||||
|
||||
func (m *PluginRequestMetaMiddleware) SubscribeStream(ctx context.Context, req *backend.SubscribeStreamRequest) (*backend.SubscribeStreamResponse, error) { |
||||
ctx = m.withDefaultPluginRequestMeta(ctx) |
||||
return m.BaseHandler.SubscribeStream(ctx, req) |
||||
} |
||||
|
||||
func (m *PluginRequestMetaMiddleware) PublishStream(ctx context.Context, req *backend.PublishStreamRequest) (*backend.PublishStreamResponse, error) { |
||||
ctx = m.withDefaultPluginRequestMeta(ctx) |
||||
return m.BaseHandler.PublishStream(ctx, req) |
||||
} |
||||
|
||||
func (m *PluginRequestMetaMiddleware) RunStream(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error { |
||||
ctx = m.withDefaultPluginRequestMeta(ctx) |
||||
return m.BaseHandler.RunStream(ctx, req, sender) |
||||
} |
||||
|
||||
// ValidateAdmission implements backend.AdmissionHandler.
|
||||
func (m *PluginRequestMetaMiddleware) ValidateAdmission(ctx context.Context, req *backend.AdmissionRequest) (*backend.ValidationResponse, error) { |
||||
ctx = m.withDefaultPluginRequestMeta(ctx) |
||||
return m.BaseHandler.ValidateAdmission(ctx, req) |
||||
} |
||||
|
||||
// MutateAdmission implements backend.AdmissionHandler.
|
||||
func (m *PluginRequestMetaMiddleware) MutateAdmission(ctx context.Context, req *backend.AdmissionRequest) (*backend.MutationResponse, error) { |
||||
ctx = m.withDefaultPluginRequestMeta(ctx) |
||||
return m.BaseHandler.MutateAdmission(ctx, req) |
||||
} |
||||
|
||||
// ConvertObject implements backend.AdmissionHandler.
|
||||
func (m *PluginRequestMetaMiddleware) ConvertObjects(ctx context.Context, req *backend.ConversionRequest) (*backend.ConversionResponse, error) { |
||||
ctx = m.withDefaultPluginRequestMeta(ctx) |
||||
return m.BaseHandler.ConvertObjects(ctx, req) |
||||
} |
||||
@ -1,39 +0,0 @@ |
||||
package clientmiddleware |
||||
|
||||
import ( |
||||
"context" |
||||
"testing" |
||||
|
||||
"github.com/grafana/grafana-plugin-sdk-go/backend" |
||||
"github.com/grafana/grafana-plugin-sdk-go/backend/handlertest" |
||||
"github.com/stretchr/testify/require" |
||||
|
||||
"github.com/grafana/grafana/pkg/plugins/pluginrequestmeta" |
||||
) |
||||
|
||||
func TestPluginRequestMetaMiddleware(t *testing.T) { |
||||
t.Run("default", func(t *testing.T) { |
||||
cdt := handlertest.NewHandlerMiddlewareTest(t, |
||||
handlertest.WithMiddlewares(NewPluginRequestMetaMiddleware()), |
||||
) |
||||
_, err := cdt.MiddlewareHandler.QueryData(context.Background(), &backend.QueryDataRequest{}) |
||||
require.NoError(t, err) |
||||
ss := pluginrequestmeta.StatusSourceFromContext(cdt.QueryDataCtx) |
||||
require.Equal(t, pluginrequestmeta.StatusSourcePlugin, ss) |
||||
}) |
||||
|
||||
t.Run("other value", func(t *testing.T) { |
||||
cdt := handlertest.NewHandlerMiddlewareTest(t, |
||||
handlertest.WithMiddlewares(backend.HandlerMiddlewareFunc(func(next backend.Handler) backend.Handler { |
||||
return &PluginRequestMetaMiddleware{ |
||||
BaseHandler: backend.NewBaseHandler(next), |
||||
defaultStatusSource: "test", |
||||
} |
||||
})), |
||||
) |
||||
_, err := cdt.MiddlewareHandler.QueryData(context.Background(), &backend.QueryDataRequest{}) |
||||
require.NoError(t, err) |
||||
ss := pluginrequestmeta.StatusSourceFromContext(cdt.QueryDataCtx) |
||||
require.Equal(t, pluginrequestmeta.StatusSource("test"), ss) |
||||
}) |
||||
} |
||||
@ -1,58 +0,0 @@ |
||||
package clientmiddleware |
||||
|
||||
import ( |
||||
"context" |
||||
"fmt" |
||||
|
||||
"github.com/grafana/grafana-plugin-sdk-go/backend" |
||||
|
||||
"github.com/grafana/grafana/pkg/plugins/pluginrequestmeta" |
||||
) |
||||
|
||||
// NewStatusSourceMiddleware returns a new backend.HandlerMiddleware that sets the status source in the
|
||||
// plugin request meta stored in the context.Context, according to the query data responses returned by QueryError.
|
||||
// If at least one query data response has a "downstream" status source and there isn't one with a "plugin" status source,
|
||||
// the plugin request meta in the context is set to "downstream".
|
||||
func NewStatusSourceMiddleware() backend.HandlerMiddleware { |
||||
return backend.HandlerMiddlewareFunc(func(next backend.Handler) backend.Handler { |
||||
return &StatusSourceMiddleware{ |
||||
BaseHandler: backend.NewBaseHandler(next), |
||||
} |
||||
}) |
||||
} |
||||
|
||||
type StatusSourceMiddleware struct { |
||||
backend.BaseHandler |
||||
} |
||||
|
||||
func (m *StatusSourceMiddleware) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) { |
||||
resp, err := m.BaseHandler.QueryData(ctx, req) |
||||
if resp == nil || len(resp.Responses) == 0 { |
||||
return resp, err |
||||
} |
||||
|
||||
// Set downstream status source in the context if there's at least one response with downstream status source,
|
||||
// and if there's no plugin error
|
||||
var hasPluginError bool |
||||
var hasDownstreamError bool |
||||
for _, r := range resp.Responses { |
||||
if r.Error == nil { |
||||
continue |
||||
} |
||||
if r.ErrorSource == backend.ErrorSourceDownstream { |
||||
hasDownstreamError = true |
||||
} else { |
||||
hasPluginError = true |
||||
} |
||||
} |
||||
|
||||
// A plugin error has higher priority than a downstream error,
|
||||
// so set to downstream only if there's no plugin error
|
||||
if hasDownstreamError && !hasPluginError { |
||||
if err := pluginrequestmeta.WithDownstreamStatusSource(ctx); err != nil { |
||||
return resp, fmt.Errorf("failed to set downstream status source: %w", err) |
||||
} |
||||
} |
||||
|
||||
return resp, err |
||||
} |
||||
@ -1,88 +0,0 @@ |
||||
package clientmiddleware |
||||
|
||||
import ( |
||||
"context" |
||||
"errors" |
||||
"testing" |
||||
|
||||
"github.com/grafana/grafana-plugin-sdk-go/backend" |
||||
"github.com/grafana/grafana-plugin-sdk-go/backend/handlertest" |
||||
"github.com/stretchr/testify/require" |
||||
|
||||
"github.com/grafana/grafana/pkg/plugins/pluginrequestmeta" |
||||
) |
||||
|
||||
func TestStatusSourceMiddleware(t *testing.T) { |
||||
someErr := errors.New("oops") |
||||
|
||||
for _, tc := range []struct { |
||||
name string |
||||
|
||||
queryDataResponse *backend.QueryDataResponse |
||||
|
||||
expStatusSource pluginrequestmeta.StatusSource |
||||
}{ |
||||
{ |
||||
name: `no error should be "plugin" status source`, |
||||
queryDataResponse: nil, |
||||
expStatusSource: pluginrequestmeta.StatusSourcePlugin, |
||||
}, |
||||
{ |
||||
name: `single downstream error should be "downstream" status source`, |
||||
queryDataResponse: &backend.QueryDataResponse{ |
||||
Responses: map[string]backend.DataResponse{ |
||||
"A": {Error: someErr, ErrorSource: backend.ErrorSourceDownstream}, |
||||
}, |
||||
}, |
||||
expStatusSource: pluginrequestmeta.StatusSourceDownstream, |
||||
}, |
||||
{ |
||||
name: `single plugin error should be "plugin" status source`, |
||||
queryDataResponse: &backend.QueryDataResponse{ |
||||
Responses: map[string]backend.DataResponse{ |
||||
"A": {Error: someErr, ErrorSource: backend.ErrorSourcePlugin}, |
||||
}, |
||||
}, |
||||
expStatusSource: pluginrequestmeta.StatusSourcePlugin, |
||||
}, |
||||
{ |
||||
name: `multiple downstream errors should be "downstream" status source`, |
||||
queryDataResponse: &backend.QueryDataResponse{ |
||||
Responses: map[string]backend.DataResponse{ |
||||
"A": {Error: someErr, ErrorSource: backend.ErrorSourceDownstream}, |
||||
"B": {Error: someErr, ErrorSource: backend.ErrorSourceDownstream}, |
||||
}, |
||||
}, |
||||
expStatusSource: pluginrequestmeta.StatusSourceDownstream, |
||||
}, |
||||
{ |
||||
name: `single plugin error mixed with downstream errors should be "plugin" status source`, |
||||
queryDataResponse: &backend.QueryDataResponse{ |
||||
Responses: map[string]backend.DataResponse{ |
||||
"A": {Error: someErr, ErrorSource: backend.ErrorSourceDownstream}, |
||||
"B": {Error: someErr, ErrorSource: backend.ErrorSourcePlugin}, |
||||
"C": {Error: someErr, ErrorSource: backend.ErrorSourceDownstream}, |
||||
}, |
||||
}, |
||||
expStatusSource: pluginrequestmeta.StatusSourcePlugin, |
||||
}, |
||||
} { |
||||
t.Run(tc.name, func(t *testing.T) { |
||||
cdt := handlertest.NewHandlerMiddlewareTest(t, |
||||
handlertest.WithMiddlewares( |
||||
NewPluginRequestMetaMiddleware(), |
||||
NewStatusSourceMiddleware(), |
||||
), |
||||
) |
||||
cdt.TestHandler.QueryDataFunc = func(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) { |
||||
cdt.QueryDataCtx = ctx |
||||
return tc.queryDataResponse, nil |
||||
} |
||||
|
||||
_, _ = cdt.MiddlewareHandler.QueryData(context.Background(), &backend.QueryDataRequest{}) |
||||
|
||||
ss := pluginrequestmeta.StatusSourceFromContext(cdt.QueryDataCtx) |
||||
require.Equal(t, tc.expStatusSource, ss) |
||||
}) |
||||
} |
||||
} |
||||
@ -0,0 +1,32 @@ |
||||
import { InlineField, InlineFieldRow, Select } from '@grafana/ui'; |
||||
|
||||
import { EditorProps } from '../QueryEditor'; |
||||
|
||||
const OPTIONS = [ |
||||
{ |
||||
label: 'Plugin', |
||||
value: 'plugin', |
||||
}, |
||||
{ |
||||
label: 'Downstream', |
||||
value: 'downstream', |
||||
}, |
||||
]; |
||||
|
||||
const ErrorWithSourceQueryEditor = ({ query, onChange }: EditorProps) => { |
||||
return ( |
||||
<InlineFieldRow> |
||||
<InlineField labelWidth={14} label="Error source"> |
||||
<Select |
||||
options={OPTIONS} |
||||
value={query.errorSource} |
||||
onChange={(v) => { |
||||
onChange({ ...query, errorSource: v.value }); |
||||
}} |
||||
/> |
||||
</InlineField> |
||||
</InlineFieldRow> |
||||
); |
||||
}; |
||||
|
||||
export default ErrorWithSourceQueryEditor; |
||||
Loading…
Reference in new issue