public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Plugins: Forward HTTP headers to plugin streaming calls (#101960)

Browse Source 
* forward HTTP headers to plugin streaming calls

* fixup

* fix test based on feedback

* improve test assertions
This commit is contained in:
Will Browne
2025-03-12 10:37:07 +00:00
committed by GitHub
parent 8de665cbeb
commit 5a2cba7b01
8 changed files with 747 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/services/pluginsintegration/clientmiddleware/clear_auth_headers_middleware_test.go
+222 -22
View File
@@ -32,7 +32,7 @@ func TestClearAuthHeadersMiddleware(t *testing.T) {
DataSourceInstanceSettings: &backend.DataSourceInstanceSettings{},
}
t.Run("Should not attach delete headers middleware when calling QueryData", func(t *testing.T) {
t.Run("No auth headers to clear when calling QueryData", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.QueryData(req.Context(), &backend.QueryDataRequest{
PluginContext: pluginCtx,
Headers: map[string]string{otherHeader: "test"},
@@ -40,9 +40,10 @@ func TestClearAuthHeadersMiddleware(t *testing.T) {
require.NoError(t, err)
require.NotNil(t, cdt.QueryDataReq)
require.Len(t, cdt.QueryDataReq.Headers, 1)
require.Empty(t, cdt.QueryDataReq.GetHTTPHeaders())
})
t.Run("Should not attach delete headers middleware when calling CallResource", func(t *testing.T) {
t.Run("No auth headers to clear when calling CallResource", func(t *testing.T) {
err = cdt.MiddlewareHandler.CallResource(req.Context(), &backend.CallResourceRequest{
PluginContext: pluginCtx,
Headers: map[string][]string{otherHeader: {"test"}},
@@ -50,9 +51,10 @@ func TestClearAuthHeadersMiddleware(t *testing.T) {
require.NoError(t, err)
require.NotNil(t, cdt.CallResourceReq)
require.Len(t, cdt.CallResourceReq.Headers, 1)
require.Equal(t, http.Header{http.CanonicalHeaderKey(otherHeader): {"test"}}, cdt.CallResourceReq.GetHTTPHeaders())
})
t.Run("Should not attach delete headers middleware when calling CheckHealth", func(t *testing.T) {
t.Run("No auth headers to clear when calling CheckHealth", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.CheckHealth(req.Context(), &backend.CheckHealthRequest{
PluginContext: pluginCtx,
Headers: map[string]string{otherHeader: "test"},
@@ -60,6 +62,40 @@ func TestClearAuthHeadersMiddleware(t *testing.T) {
require.NoError(t, err)
require.NotNil(t, cdt.CheckHealthReq)
require.Len(t, cdt.CheckHealthReq.Headers, 1)
require.Empty(t, cdt.CheckHealthReq.GetHTTPHeaders())
})
t.Run("No auth headers to clear when calling SubscribeStream", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.SubscribeStream(req.Context(), &backend.SubscribeStreamRequest{
PluginContext: pluginCtx,
Headers: map[string]string{otherHeader: "test"},
})
require.NoError(t, err)
require.NotNil(t, cdt.SubscribeStreamReq)
require.Len(t, cdt.SubscribeStreamReq.Headers, 1)
require.Empty(t, cdt.SubscribeStreamReq.GetHTTPHeaders())
})
t.Run("No auth headers to clear when calling PublishStream", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.PublishStream(req.Context(), &backend.PublishStreamRequest{
PluginContext: pluginCtx,
Headers: map[string]string{otherHeader: "test"},
})
require.NoError(t, err)
require.NotNil(t, cdt.PublishStreamReq)
require.Len(t, cdt.PublishStreamReq.Headers, 1)
require.Empty(t, cdt.PublishStreamReq.GetHTTPHeaders())
})
t.Run("No auth headers to clear when calling RunStream", func(t *testing.T) {
err = cdt.MiddlewareHandler.RunStream(req.Context(), &backend.RunStreamRequest{
PluginContext: pluginCtx,
Headers: map[string]string{otherHeader: "test"},
}, &backend.StreamSender{})
require.NoError(t, err)
require.NotNil(t, cdt.RunStreamReq)
require.Len(t, cdt.RunStreamReq.Headers, 1)
require.Empty(t, cdt.RunStreamReq.GetHTTPHeaders())
})
})
@@ -73,7 +109,7 @@ func TestClearAuthHeadersMiddleware(t *testing.T) {
AppInstanceSettings: &backend.AppInstanceSettings{},
}
t.Run("Should not attach delete headers middleware when calling QueryData", func(t *testing.T) {
t.Run("No auth headers to clear when calling QueryData", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.QueryData(req.Context(), &backend.QueryDataRequest{
PluginContext: pluginCtx,
Headers: map[string]string{otherHeader: "test"},
@@ -81,9 +117,11 @@ func TestClearAuthHeadersMiddleware(t *testing.T) {
require.NoError(t, err)
require.NotNil(t, cdt.QueryDataReq)
require.Len(t, cdt.QueryDataReq.Headers, 1)
require.Equal(t, "test", cdt.QueryDataReq.Headers[otherHeader])
require.Empty(t, cdt.QueryDataReq.GetHTTPHeaders())
})
t.Run("Should not attach delete headers middleware when calling CallResource", func(t *testing.T) {
t.Run("No auth headers to clear when calling CallResource", func(t *testing.T) {
err = cdt.MiddlewareHandler.CallResource(req.Context(), &backend.CallResourceRequest{
PluginContext: pluginCtx,
Headers: map[string][]string{otherHeader: {"test"}},
@@ -91,9 +129,11 @@ func TestClearAuthHeadersMiddleware(t *testing.T) {
require.NoError(t, err)
require.NotNil(t, cdt.CallResourceReq)
require.Len(t, cdt.CallResourceReq.Headers, 1)
require.Equal(t, []string{"test"}, cdt.CallResourceReq.Headers[otherHeader])
require.Equal(t, http.Header{http.CanonicalHeaderKey(otherHeader): {"test"}}, cdt.CallResourceReq.GetHTTPHeaders())
})
t.Run("Should not attach delete headers middleware when calling CheckHealth", func(t *testing.T) {
t.Run("No auth headers to clear when calling CheckHealth", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.CheckHealth(req.Context(), &backend.CheckHealthRequest{
PluginContext: pluginCtx,
Headers: map[string]string{otherHeader: "test"},
@@ -101,6 +141,44 @@ func TestClearAuthHeadersMiddleware(t *testing.T) {
require.NoError(t, err)
require.NotNil(t, cdt.CheckHealthReq)
require.Len(t, cdt.CheckHealthReq.Headers, 1)
require.Equal(t, "test", cdt.CheckHealthReq.Headers[otherHeader])
require.Empty(t, cdt.CheckHealthReq.GetHTTPHeaders())
})
t.Run("No auth headers to clear when calling SubscribeStream", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.SubscribeStream(req.Context(), &backend.SubscribeStreamRequest{
PluginContext: pluginCtx,
Headers: map[string]string{otherHeader: "test"},
})
require.NoError(t, err)
require.NotNil(t, cdt.SubscribeStreamReq)
require.Len(t, cdt.SubscribeStreamReq.Headers, 1)
require.Equal(t, "test", cdt.SubscribeStreamReq.Headers[otherHeader])
require.Empty(t, cdt.SubscribeStreamReq.GetHTTPHeaders())
})
t.Run("No auth headers to clear when calling PublishStream", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.PublishStream(req.Context(), &backend.PublishStreamRequest{
PluginContext: pluginCtx,
Headers: map[string]string{otherHeader: "test"},
})
require.NoError(t, err)
require.NotNil(t, cdt.PublishStreamReq)
require.Len(t, cdt.PublishStreamReq.Headers, 1)
require.Equal(t, "test", cdt.PublishStreamReq.Headers[otherHeader])
require.Empty(t, cdt.PublishStreamReq.GetHTTPHeaders())
})
t.Run("No auth headers to clear when calling RunStream", func(t *testing.T) {
err = cdt.MiddlewareHandler.RunStream(req.Context(), &backend.RunStreamRequest{
PluginContext: pluginCtx,
Headers: map[string]string{otherHeader: "test"},
}, &backend.StreamSender{})
require.NoError(t, err)
require.NotNil(t, cdt.RunStreamReq)
require.Len(t, cdt.RunStreamReq.Headers, 1)
require.Equal(t, "test", cdt.RunStreamReq.Headers[otherHeader])
require.Empty(t, cdt.RunStreamReq.GetHTTPHeaders())
})
})
})
@@ -116,46 +194,105 @@ func TestClearAuthHeadersMiddleware(t *testing.T) {
)
req := req.WithContext(contexthandler.WithAuthHTTPHeaders(req.Context(), setting.NewCfg()))
req.Header.Set("Authorization", "val")
const otherHeader = "X-Other"
req.Header.Set(otherHeader, "test")
pluginCtx := backend.PluginContext{
DataSourceInstanceSettings: &backend.DataSourceInstanceSettings{},
}
t.Run("Should attach delete headers middleware when calling QueryData", func(t *testing.T) {
t.Run("Should clear auth headers when calling QueryData", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.QueryData(req.Context(), &backend.QueryDataRequest{
PluginContext: pluginCtx,
Headers: map[string]string{otherHeader: "test"},
Headers: map[string]string{
otherHeader: "test",
"Authorization": "secret",
"X-Grafana-Device-Id": "secret",
},
})
require.NoError(t, err)
require.NotNil(t, cdt.QueryDataReq)
require.Len(t, cdt.QueryDataReq.Headers, 1)
require.Equal(t, "test", cdt.QueryDataReq.Headers[otherHeader])
require.Empty(t, cdt.QueryDataReq.GetHTTPHeaders())
})
t.Run("Should attach delete headers middleware when calling CallResource", func(t *testing.T) {
t.Run("Should clear auth headers when calling CallResource", func(t *testing.T) {
err = cdt.MiddlewareHandler.CallResource(req.Context(), &backend.CallResourceRequest{
PluginContext: pluginCtx,
Headers: map[string][]string{otherHeader: {"test"}},
Headers: map[string][]string{
otherHeader: {"test"},
"Authorization": {"secret"},
"X-Grafana-Device-Id": {"secret"},
},
}, nopCallResourceSender)
require.NoError(t, err)
require.NotNil(t, cdt.CallResourceReq)
require.Len(t, cdt.CallResourceReq.Headers, 1)
require.Equal(t, []string{"test"}, cdt.CallResourceReq.Headers[otherHeader])
require.Equal(t, "test", cdt.CallResourceReq.GetHTTPHeader(otherHeader))
})
t.Run("Should attach delete headers middleware when calling CheckHealth", func(t *testing.T) {
t.Run("Should clear auth headers when calling CheckHealth", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.CheckHealth(req.Context(), &backend.CheckHealthRequest{
PluginContext: pluginCtx,
Headers: map[string]string{otherHeader: "test"},
Headers: map[string]string{
otherHeader: "test",
"Authorization": "secret",
"X-Grafana-Device-Id": "secret",
},
})
require.NoError(t, err)
require.NotNil(t, cdt.CheckHealthReq)
require.Len(t, cdt.CheckHealthReq.Headers, 1)
require.Equal(t, "test", cdt.CheckHealthReq.Headers[otherHeader])
require.Empty(t, cdt.CheckHealthReq.GetHTTPHeaders())
})
t.Run("Should clear auth headers when calling SubscribeStream", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.SubscribeStream(req.Context(), &backend.SubscribeStreamRequest{
PluginContext: pluginCtx,
Headers: map[string]string{
otherHeader: "test",
"Authorization": "secret",
"X-Grafana-Device-Id": "secret",
},
})
require.NoError(t, err)
require.NotNil(t, cdt.SubscribeStreamReq)
require.Len(t, cdt.SubscribeStreamReq.Headers, 1)
require.Equal(t, "test", cdt.SubscribeStreamReq.Headers[otherHeader])
require.Empty(t, cdt.SubscribeStreamReq.GetHTTPHeaders())
})
t.Run("Should clear auth headers when calling PublishStream", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.PublishStream(req.Context(), &backend.PublishStreamRequest{
PluginContext: pluginCtx,
Headers: map[string]string{
otherHeader: "test",
"Authorization": "secret",
"X-Grafana-Device-Id": "secret",
},
})
require.NoError(t, err)
require.NotNil(t, cdt.PublishStreamReq)
require.Len(t, cdt.PublishStreamReq.Headers, 1)
require.Equal(t, "test", cdt.PublishStreamReq.Headers[otherHeader])
require.Empty(t, cdt.PublishStreamReq.GetHTTPHeaders())
})
t.Run("Should clear auth headers when calling RunStream", func(t *testing.T) {
err = cdt.MiddlewareHandler.RunStream(req.Context(), &backend.RunStreamRequest{
PluginContext: pluginCtx,
Headers: map[string]string{
otherHeader: "test",
"Authorization": "secret",
"X-Grafana-Device-Id": "secret",
},
}, &backend.StreamSender{})
require.NoError(t, err)
require.NotNil(t, cdt.RunStreamReq)
require.Len(t, cdt.RunStreamReq.Headers, 1)
require.Equal(t, "test", cdt.RunStreamReq.Headers[otherHeader])
require.Empty(t, cdt.RunStreamReq.GetHTTPHeaders())
})
})
@@ -175,37 +312,100 @@ func TestClearAuthHeadersMiddleware(t *testing.T) {
AppInstanceSettings: &backend.AppInstanceSettings{},
}
t.Run("Should attach delete headers middleware when calling QueryData", func(t *testing.T) {
t.Run("Should clear auth headers when calling QueryData", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.QueryData(req.Context(), &backend.QueryDataRequest{
PluginContext: pluginCtx,
Headers: map[string]string{otherHeader: "test"},
Headers: map[string]string{
otherHeader: "test",
"Authorization": "secret",
"X-Grafana-Device-Id": "secret",
},
})
require.NoError(t, err)
require.NotNil(t, cdt.QueryDataReq)
require.Len(t, cdt.QueryDataReq.Headers, 1)
require.Equal(t, "test", cdt.QueryDataReq.Headers[otherHeader])
require.Empty(t, cdt.QueryDataReq.GetHTTPHeaders())
})
t.Run("Should attach delete headers middleware when calling CallResource", func(t *testing.T) {
t.Run("Should clear auth headers when calling CallResource", func(t *testing.T) {
err = cdt.MiddlewareHandler.CallResource(req.Context(), &backend.CallResourceRequest{
PluginContext: pluginCtx,
Headers: map[string][]string{otherHeader: {"test"}},
Headers: map[string][]string{
otherHeader: {"test"},
"Authorization": {"secret"},
"X-Grafana-Device-Id": {"secret"},
},
}, nopCallResourceSender)
require.NoError(t, err)
require.NotNil(t, cdt.CallResourceReq)
require.Len(t, cdt.CallResourceReq.Headers, 1)
require.Equal(t, []string{"test"}, cdt.CallResourceReq.Headers[otherHeader])
require.Equal(t, "test", cdt.CallResourceReq.GetHTTPHeader(otherHeader))
})
t.Run("Should attach delete headers middleware when calling CheckHealth", func(t *testing.T) {
t.Run("Should clear auth headers when calling CheckHealth", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.CheckHealth(req.Context(), &backend.CheckHealthRequest{
PluginContext: pluginCtx,
Headers: map[string]string{otherHeader: "test"},
Headers: map[string]string{
otherHeader: "test",
"Authorization": "secret",
"X-Grafana-Device-Id": "secret",
},
})
require.NoError(t, err)
require.NotNil(t, cdt.CheckHealthReq)
require.Len(t, cdt.CheckHealthReq.Headers, 1)
require.Equal(t, "test", cdt.CheckHealthReq.Headers[otherHeader])
require.Empty(t, cdt.CheckHealthReq.GetHTTPHeaders())
})
t.Run("Should clear auth headers when calling SubscribeStream", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.SubscribeStream(req.Context(), &backend.SubscribeStreamRequest{
PluginContext: pluginCtx,
Headers: map[string]string{
otherHeader: "test",
"Authorization": "secret",
"X-Grafana-Device-Id": "secret",
},
})
require.NoError(t, err)
require.NotNil(t, cdt.SubscribeStreamReq)
require.Len(t, cdt.SubscribeStreamReq.Headers, 1)
require.Equal(t, "test", cdt.SubscribeStreamReq.Headers[otherHeader])
require.Empty(t, cdt.SubscribeStreamReq.GetHTTPHeaders())
})
t.Run("Should clear auth headers when calling PublishStream", func(t *testing.T) {
_, err = cdt.MiddlewareHandler.PublishStream(req.Context(), &backend.PublishStreamRequest{
PluginContext: pluginCtx,
Headers: map[string]string{
otherHeader: "test",
"Authorization": "secret",
"X-Grafana-Device-Id": "secret",
},
})
require.NoError(t, err)
require.NotNil(t, cdt.PublishStreamReq)
require.Len(t, cdt.PublishStreamReq.Headers, 1)
require.Equal(t, "test", cdt.PublishStreamReq.Headers[otherHeader])
require.Empty(t, cdt.PublishStreamReq.GetHTTPHeaders())
})
t.Run("Should clear auth headers when calling RunStream", func(t *testing.T) {
err = cdt.MiddlewareHandler.RunStream(req.Context(), &backend.RunStreamRequest{
PluginContext: pluginCtx,
Headers: map[string]string{
otherHeader: "test",
"Authorization": "secret",
"X-Grafana-Device-Id": "secret",
},
}, &backend.StreamSender{})
require.NoError(t, err)
require.NotNil(t, cdt.RunStreamReq)
require.Len(t, cdt.RunStreamReq.Headers, 1)
require.Equal(t, "test", cdt.RunStreamReq.Headers[otherHeader])
require.Empty(t, cdt.RunStreamReq.GetHTTPHeaders())
})
})
})