IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Plugins: Only set non-existing headers for core plugin requests (#78633)

Browse Source 
* Only set non-existing headers

- Add test scenario

* Fix test
This commit is contained in:
Andreas Christou 2023-11-30 11:51:40 +00:00 committed by GitHub
parent af7de68c65
commit f26ad881ed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 34 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
pkg/services/pluginsintegration/clientmiddleware/httpclient_middleware.go
View File

@ -50,7 +50,10 @@ func (m *HTTPClientMiddleware) applyHeaders(ctx context.Context, pReq any) conte
if h, ok := pReq.(backend.ForwardHTTPHeaders); ok {
for k, v := range h.GetHTTPHeaders() {
req.Header[k] = v
// Only set a header if it is not already set.
if req.Header.Get(k) == "" {
req.Header[k] = v
}
}
}

30
pkg/services/pluginsintegration/clientmiddleware/httpclient_middleware_test.go
View File

@ -276,6 +276,36 @@ func TestHTTPClientMiddleware(t *testing.T) {
require.Equal(t, "cookie2", reqClone.Cookies()[1].Name)
require.Equal(t, "cookie3", reqClone.Cookies()[2].Name)
})
t.Run("Should not overwrite an existing header", func(t *testing.T) {
_, err = cdt.Decorator.CheckHealth(req.Context(), &backend.CheckHealthRequest{
PluginContext: pluginCtx,
Headers: headers,
})
require.NoError(t, err)
require.NotNil(t, cdt.CheckHealthReq)
require.Len(t, cdt.CheckHealthReq.Headers, 6)
middlewares := httpclient.ContextualMiddlewareFromContext(cdt.QueryDataCtx)
require.Len(t, middlewares, 1)
require.Equal(t, forwardPluginRequestHTTPHeaders, middlewares[0].(httpclient.MiddlewareName).MiddlewareName())
reqClone := req.Clone(req.Context())
// Create a header on the request as if it had been set by some other logic e.g. preceding middleware
reqClone.Header.Set(backend.OAuthIdentityTokenHeaderName, "bearer test-token")
res, err := middlewares[0].CreateMiddleware(httpclient.Options{}, finalRoundTripper).RoundTrip(reqClone)
require.NoError(t, err)
require.NoError(t, res.Body.Close())
require.Len(t, reqClone.Header, 5)
require.Equal(t, "true", reqClone.Header.Get(ngalertmodels.FromAlertHeaderName))
require.Equal(t, "bearer test-token", reqClone.Header.Get(backend.OAuthIdentityTokenHeaderName))
require.Equal(t, "id-token", reqClone.Header.Get(backend.OAuthIdentityIDTokenHeaderName))
require.Equal(t, "uname", reqClone.Header.Get(proxyutil.UserHeaderName))
require.Len(t, reqClone.Cookies(), 3)
require.Equal(t, "cookie1", reqClone.Cookies()[0].Name)
require.Equal(t, "cookie2", reqClone.Cookies()[1].Name)
require.Equal(t, "cookie3", reqClone.Cookies()[2].Name)
})
})
})
}