Fix error source bug in ErrorResponseWithErrorSource (#1158)

* Fix error source bug in ErrorResponseWithErrorSource * Fix lint * Add tests
grafana · Nov 28, 2024 · 7ef35b2 · 7ef35b2
1 parent 316ae3b
commit 7ef35b2
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 1 deletion.
diff --git a/backend/error_source.go b/backend/error_source.go
@@ -93,7 +93,7 @@ func ErrorResponseWithErrorSource(err error) DataResponse {
 	var e ErrorWithSource
 	if errors.As(err, &e) {
 		return DataResponse{
-			Error:       e,
+			Error:       err,
 			ErrorSource: e.ErrorSource(),
 		}
 	}

diff --git a/backend/error_source_test.go b/backend/error_source_test.go
@@ -1,6 +1,8 @@
 package backend_test
 
 import (
+	"errors"
+	"fmt"
 	"testing"
 
 	"github.com/grafana/grafana-plugin-sdk-go/backend"
@@ -16,3 +18,50 @@ func TestErrorSource(t *testing.T) {
 	require.True(t, backend.ErrorSourcePlugin.IsValid())
 	require.Equal(t, "plugin", backend.ErrorSourcePlugin.String())
 }
+
+func TestResponseWithOptions(t *testing.T) {
+	for _, tc := range []struct {
+		name            string
+		err             error
+		expErrorMessage string
+		expErrorSource  backend.ErrorSource
+	}{
+		{
+			name:            "plugin error",
+			err:             backend.PluginError(errors.New("unknown")),
+			expErrorMessage: "unknown",
+			expErrorSource:  backend.ErrorSourcePlugin,
+		},
+		{
+			name:            "downstream error",
+			err:             backend.DownstreamError(errors.New("bad gateway")),
+			expErrorMessage: "bad gateway",
+			expErrorSource:  backend.ErrorSourceDownstream,
+		},
+		{
+			name:            "wrapped downstream error",
+			err:             fmt.Errorf("wrapped: %w", backend.DownstreamError(errors.New("inside error"))),
+			expErrorMessage: "wrapped: inside error",
+			expErrorSource:  backend.ErrorSourceDownstream,
+		},
+		{
+			name:            "wrapped plugin error",
+			err:             fmt.Errorf("wrapped: %w", backend.PluginError(errors.New("inside error"))),
+			expErrorMessage: "wrapped: inside error",
+			expErrorSource:  backend.ErrorSourcePlugin,
+		},
+		{
+			name:            "non error source error",
+			err:             errors.New("inside error"),
+			expErrorMessage: "inside error",
+			expErrorSource:  "",
+		},
+	} {
+		t.Run(tc.name, func(t *testing.T) {
+			res := backend.ErrorResponseWithErrorSource(tc.err)
+			require.Error(t, res.Error)
+			require.Equal(t, tc.expErrorMessage, res.Error.Error())
+			require.Equal(t, tc.expErrorSource, res.ErrorSource)
+		})
+	}
+}