mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Chore: Delete unused cookie forward middleware (#70403)
Delete unused cookie forward middleware
This commit is contained in:
parent
ebdba3b359
commit
680fc85cdf
@ -1,85 +0,0 @@
|
|||||||
package httpclientprovider_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/http"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/grafana/grafana-plugin-sdk-go/backend/httpclient"
|
|
||||||
"github.com/grafana/grafana/pkg/infra/httpclient/httpclientprovider"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestForwardedCookiesMiddleware(t *testing.T) {
|
|
||||||
tcs := []struct {
|
|
||||||
desc string
|
|
||||||
allowedCookies []string
|
|
||||||
disallowedCookies []string
|
|
||||||
expectedCookieHeader string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
desc: "With nil allowedCookies should not populate Cookie header",
|
|
||||||
allowedCookies: nil,
|
|
||||||
expectedCookieHeader: "",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
desc: "With empty allowed cookies should not populate Cookie header",
|
|
||||||
allowedCookies: []string{},
|
|
||||||
expectedCookieHeader: "",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
desc: "When provided with allowed cookies should populate Cookie header",
|
|
||||||
allowedCookies: []string{"c1", "c3"},
|
|
||||||
expectedCookieHeader: "c1=1; c3=3",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
desc: "When provided with allowed and not allowed cookies should populate Cookie header",
|
|
||||||
allowedCookies: []string{"c1", "c3"},
|
|
||||||
disallowedCookies: []string{"c1"},
|
|
||||||
expectedCookieHeader: "c3=3",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tcs {
|
|
||||||
t.Run(tc.desc, func(t *testing.T) {
|
|
||||||
ctx := &testContext{}
|
|
||||||
finalRoundTripper := ctx.createRoundTripper()
|
|
||||||
forwarded := []*http.Cookie{
|
|
||||||
{Name: "c1", Value: "1"},
|
|
||||||
{Name: "c2", Value: "2"},
|
|
||||||
{Name: "c3", Value: "3"},
|
|
||||||
}
|
|
||||||
mw := httpclientprovider.ForwardedCookiesMiddleware(forwarded, tc.allowedCookies, tc.disallowedCookies)
|
|
||||||
opts := httpclient.Options{}
|
|
||||||
rt := mw.CreateMiddleware(opts, finalRoundTripper)
|
|
||||||
require.NotNil(t, rt)
|
|
||||||
middlewareName, ok := mw.(httpclient.MiddlewareName)
|
|
||||||
require.True(t, ok)
|
|
||||||
require.Equal(t, "forwarded-cookies", middlewareName.MiddlewareName())
|
|
||||||
|
|
||||||
req, err := http.NewRequest(http.MethodGet, "http://", nil)
|
|
||||||
require.NoError(t, err)
|
|
||||||
res, err := rt.RoundTrip(req)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NotNil(t, res)
|
|
||||||
if res.Body != nil {
|
|
||||||
require.NoError(t, res.Body.Close())
|
|
||||||
}
|
|
||||||
require.Len(t, ctx.callChain, 1)
|
|
||||||
require.ElementsMatch(t, []string{"final"}, ctx.callChain)
|
|
||||||
require.Equal(t, tc.expectedCookieHeader, ctx.req.Header.Get("Cookie"))
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type testContext struct {
|
|
||||||
callChain []string
|
|
||||||
req *http.Request
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *testContext) createRoundTripper() http.RoundTripper {
|
|
||||||
return httpclient.RoundTripperFunc(func(req *http.Request) (*http.Response, error) {
|
|
||||||
c.callChain = append(c.callChain, "final")
|
|
||||||
c.req = req
|
|
||||||
return &http.Response{StatusCode: http.StatusOK}, nil
|
|
||||||
})
|
|
||||||
}
|
|
@ -1,24 +0,0 @@
|
|||||||
package httpclientprovider
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/http"
|
|
||||||
|
|
||||||
"github.com/grafana/grafana-plugin-sdk-go/backend/httpclient"
|
|
||||||
"github.com/grafana/grafana/pkg/util/proxyutil"
|
|
||||||
)
|
|
||||||
|
|
||||||
const ForwardedCookiesMiddlewareName = "forwarded-cookies"
|
|
||||||
|
|
||||||
// ForwardedCookiesMiddleware middleware that sets Cookie header on the
|
|
||||||
// outgoing request, if forwarded cookies configured/provided.
|
|
||||||
func ForwardedCookiesMiddleware(forwardedCookies []*http.Cookie, allowedCookies []string, disallowedCookies []string) httpclient.Middleware {
|
|
||||||
return httpclient.NamedMiddlewareFunc(ForwardedCookiesMiddlewareName, func(opts httpclient.Options, next http.RoundTripper) http.RoundTripper {
|
|
||||||
return httpclient.RoundTripperFunc(func(req *http.Request) (*http.Response, error) {
|
|
||||||
for _, cookie := range forwardedCookies {
|
|
||||||
req.AddCookie(cookie)
|
|
||||||
}
|
|
||||||
proxyutil.ClearCookieHeader(req, allowedCookies, disallowedCookies)
|
|
||||||
return next.RoundTrip(req)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
Loading…
Reference in New Issue
Block a user