Plugins: Fix status_source always being "plugin" in plugin request logs (#77433)

* Plugins: Fix status_source always being "plugin" in plugin logs * add tests * Fix TestInstrumentationMiddlewareStatusSource
2023-10-31 13:42:39 +01:00
parent 165a76a12b
commit 46261de32d
7 changed files with 299 additions and 33 deletions
@@ -0,0 +1,88 @@
+package clientmiddleware
+
+import (
+	"context"
+	"errors"
+	"testing"
+
+	"github.com/grafana/grafana-plugin-sdk-go/backend"
+	"github.com/stretchr/testify/require"
+
+	"github.com/grafana/grafana/pkg/plugins/manager/client/clienttest"
+	"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 := clienttest.NewClientDecoratorTest(t,
+				clienttest.WithMiddlewares(
+					NewPluginRequestMetaMiddleware(),
+					NewStatusSourceMiddleware(),
+				),
+			)
+			cdt.TestClient.QueryDataFunc = func(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
+				cdt.QueryDataCtx = ctx
+				return tc.queryDataResponse, nil
+			}
+
+			_, _ = cdt.Decorator.QueryData(context.Background(), &backend.QueryDataRequest{})
+
+			ss := pluginrequestmeta.StatusSourceFromContext(cdt.QueryDataCtx)
+			require.Equal(t, tc.expStatusSource, ss)
+		})
+	}
+}