Plugins: Add token to gcom requests (#96261)

This commit is contained in:
Hugo Kiyodi Oshiro
2024-11-26 11:42:55 +01:00
committed by GitHub
parent 3b8499eaee
commit a8174f9285
6 changed files with 53 additions and 12 deletions
+4 -2
View File
@@ -18,7 +18,8 @@ type PluginManagementCfg struct {
PluginsCDNURLTemplate string
GrafanaComAPIURL string
GrafanaComAPIURL string
GrafanaComAPIToken string
GrafanaAppURL string
@@ -38,7 +39,7 @@ type Features struct {
// NewPluginManagementCfg returns a new PluginManagementCfg.
func NewPluginManagementCfg(devMode bool, pluginsPath string, pluginSettings setting.PluginSettings, pluginsAllowUnsigned []string,
pluginsCDNURLTemplate string, appURL string, features Features, angularSupportEnabled bool,
grafanaComAPIURL string, disablePlugins []string, hideAngularDeprecation []string, forwardHostEnvVars []string,
grafanaComAPIURL string, disablePlugins []string, hideAngularDeprecation []string, forwardHostEnvVars []string, grafanaComAPIToken string,
) *PluginManagementCfg {
return &PluginManagementCfg{
PluginsPath: pluginsPath,
@@ -53,5 +54,6 @@ func NewPluginManagementCfg(devMode bool, pluginsPath string, pluginSettings set
AngularSupportEnabled: angularSupportEnabled,
HideAngularDeprecation: hideAngularDeprecation,
ForwardHostEnvVars: forwardHostEnvVars,
GrafanaComAPIToken: grafanaComAPIToken,
}
}
+15 -1
View File
@@ -23,15 +23,17 @@ type Client struct {
httpClient http.Client
httpClientNoTimeout http.Client
retryCount int
grafanaComAPIToken string
log log.PrettyLogger
}
func NewClient(skipTLSVerify bool, logger log.PrettyLogger) *Client {
func NewClient(skipTLSVerify bool, grafanaComAPIToken string, logger log.PrettyLogger) *Client {
return &Client{
httpClient: MakeHttpClient(skipTLSVerify, 10*time.Second),
httpClientNoTimeout: MakeHttpClient(skipTLSVerify, 0),
log: logger,
grafanaComAPIToken: grafanaComAPIToken,
}
}
@@ -153,6 +155,14 @@ func (c *Client) downloadFile(ctx context.Context, tmpFile *os.File, pluginURL,
// Note: This is also used as part of the grafana plugin install CLI operation
bodyReader, err := c.sendReqNoTimeout(ctx, u, compatOpts)
if err != nil {
var errResp ErrResponse4xx
if errors.As(err, &errResp) {
if errResp.StatusCode() == 401 {
c.log.Error("Unauthorized download plugin", "error", err)
return err
}
}
if c.retryCount < 3 {
c.retryCount++
c.log.Debug("Failed downloading. Will retry.")
@@ -223,6 +233,10 @@ func (c *Client) createReq(ctx context.Context, url *url.URL, compatOpts CompatO
req.Header.Set("grafana-origin", orig.(string))
}
if c.grafanaComAPIToken != "" {
req.Header.Set("Authorization", "Bearer "+c.grafanaComAPIToken)
}
return req, err
}
+18
View File
@@ -69,4 +69,22 @@ func Test_Download(t *testing.T) {
require.NoError(t, err)
require.Equal(t, 2, count, "should retry on error")
})
t.Run("it should use gcom token when it's available", func(t *testing.T) {
expectedToken := "token-test"
var gcomCalled bool
fakeServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
token := r.Header.Get("Authorization")
require.Equal(t, "Bearer "+expectedToken, token, "gcom token should be set")
err := writeFakeZip(w)
require.NoError(t, err)
gcomCalled = true
}))
defer fakeServer.Close()
cli := fakeServer.Client()
repo := Client{httpClient: *cli, httpClientNoTimeout: *cli, log: log.NewPrettyLogger("test"), grafanaComAPIToken: expectedToken}
_, err := repo.Download(context.Background(), fakeServer.URL, "", CompatOpts{})
require.NoError(t, err)
require.True(t, gcomCalled)
})
}
+9 -7
View File
@@ -27,22 +27,24 @@ func ProvideService(cfg *config.PluginManagementCfg) (*Manager, error) {
}
return NewManager(ManagerCfg{
SkipTLSVerify: false,
BaseURL: baseURL,
Logger: log.NewPrettyLogger("plugin.repository"),
SkipTLSVerify: false,
BaseURL: baseURL,
Logger: log.NewPrettyLogger("plugin.repository"),
GrafanaComAPIToken: cfg.GrafanaComAPIToken,
}), nil
}
type ManagerCfg struct {
SkipTLSVerify bool
BaseURL string
Logger log.PrettyLogger
SkipTLSVerify bool
BaseURL string
GrafanaComAPIToken string
Logger log.PrettyLogger
}
func NewManager(cfg ManagerCfg) *Manager {
return &Manager{
baseURL: cfg.BaseURL,
client: NewClient(cfg.SkipTLSVerify, cfg.Logger),
client: NewClient(cfg.SkipTLSVerify, cfg.GrafanaComAPIToken, cfg.Logger),
log: cfg.Logger,
}
}