Skip to content

Move GrafanaCfg to dedicated package #1284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Move GrafanaCfg to dedicated package #1284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
28d37ec
introduce new package
wbrowne Mar 26, 2025
03f4ceb
update package refs
wbrowne Mar 26, 2025
a7f6139
lessen breaking changes
wbrowne Mar 27, 2025
a3a821f
fix func name
wbrowne Mar 27, 2025
a38a211
add type aliases
wbrowne Mar 27, 2025
23a170d
make context limit check the fallback
wbrowne Mar 27, 2025
41c1f76
fix test
wbrowne Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions backend/app/instance_provider_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (

"github.com/grafana/grafana-plugin-sdk-go/backend"
"github.com/grafana/grafana-plugin-sdk-go/backend/instancemgmt"
"github.com/grafana/grafana-plugin-sdk-go/config"
"github.com/stretchr/testify/require"
)

Expand Down Expand Up @@ -39,22 +40,22 @@ func TestInstanceProvider(t *testing.T) {
})

t.Run("When both the configuration and updated field of current app instance settings are equal to the cache, should return false", func(t *testing.T) {
config := map[string]string{
cfg := map[string]string{
"foo": "bar",
}

curSettings := backend.PluginContext{
AppInstanceSettings: &backend.AppInstanceSettings{
Updated: time.Now(),
},
GrafanaConfig: backend.NewGrafanaCfg(config),
GrafanaConfig: config.NewGrafanaCfg(cfg),
}

cachedSettings := backend.PluginContext{
AppInstanceSettings: &backend.AppInstanceSettings{
Updated: curSettings.AppInstanceSettings.Updated,
},
GrafanaConfig: backend.NewGrafanaCfg(config),
GrafanaConfig: config.NewGrafanaCfg(cfg),
}

cachedInstance := instancemgmt.CachedInstance{
Expand Down Expand Up @@ -84,11 +85,11 @@ func TestInstanceProvider(t *testing.T) {
require.True(t, needsUpdate)

t.Run("Should return true when cached config is changed", func(t *testing.T) {
curSettings.GrafanaConfig = backend.NewGrafanaCfg(map[string]string{
curSettings.GrafanaConfig = config.NewGrafanaCfg(map[string]string{
"foo": "bar",
})

cachedSettings.GrafanaConfig = backend.NewGrafanaCfg(map[string]string{
cachedSettings.GrafanaConfig = config.NewGrafanaCfg(map[string]string{
"baz": "qux",
})

Expand Down Expand Up @@ -163,14 +164,14 @@ func Test_instanceProvider_NeedsUpdate(t *testing.T) {
AppInstanceSettings: &backend.AppInstanceSettings{
Updated: ts,
},
GrafanaConfig: backend.NewGrafanaCfg(map[string]string{"foo": "bar", "baz": "qux"}),
GrafanaConfig: config.NewGrafanaCfg(map[string]string{"foo": "bar", "baz": "qux"}),
},
cachedInstance: instancemgmt.CachedInstance{
PluginContext: backend.PluginContext{
AppInstanceSettings: &backend.AppInstanceSettings{
Updated: ts,
},
GrafanaConfig: backend.NewGrafanaCfg(map[string]string{"foo": "bar", "baz": "qux"}),
GrafanaConfig: config.NewGrafanaCfg(map[string]string{"foo": "bar", "baz": "qux"}),
},
},
},
Expand Down Expand Up @@ -201,7 +202,7 @@ func Test_instanceProvider_NeedsUpdate(t *testing.T) {
AppInstanceSettings: &backend.AppInstanceSettings{
Updated: ts,
},
GrafanaConfig: backend.NewGrafanaCfg(map[string]string{"foo": "bar"}),
GrafanaConfig: config.NewGrafanaCfg(map[string]string{"foo": "bar"}),
},
cachedInstance: instancemgmt.CachedInstance{
PluginContext: backend.PluginContext{
Expand Down
15 changes: 8 additions & 7 deletions backend/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"github.com/grafana/grafana-plugin-sdk-go/backend/httpclient"
"github.com/grafana/grafana-plugin-sdk-go/backend/proxy"
"github.com/grafana/grafana-plugin-sdk-go/backend/useragent"
"github.com/grafana/grafana-plugin-sdk-go/config"
"github.com/grafana/grafana-plugin-sdk-go/internal/tenant"
)

Expand Down Expand Up @@ -141,11 +142,11 @@ func (s *DataSourceInstanceSettings) HTTPClientOptions(ctx context.Context) (htt
setCustomOptionsFromHTTPSettings(&opts, httpSettings)

cfg := GrafanaConfigFromContext(ctx)
proxy, err := cfg.proxy()
proxy, err := cfg.Proxy()
if err != nil {
return opts, err
}
opts.ProxyOptions, err = s.ProxyOptions(proxy.clientCfg)
opts.ProxyOptions, err = s.ProxyOptions(proxy.ClientCfg)
if err != nil {
return opts, err
}
Expand Down Expand Up @@ -197,7 +198,7 @@ type PluginContext struct {
DataSourceInstanceSettings *DataSourceInstanceSettings

// GrafanaConfig is the configuration settings provided by Grafana.
GrafanaConfig *GrafanaCfg
GrafanaConfig *config.GrafanaCfg

// UserAgent is the user agent of the Grafana server that initiated the gRPC request.
// Will only be set if request is made from Grafana v10.2.0 or later.
Expand Down Expand Up @@ -299,11 +300,11 @@ func SecureJSONDataFromHTTPClientOptions(opts httpclient.Options) (res map[strin

func (s *DataSourceInstanceSettings) ProxyOptionsFromContext(ctx context.Context) (*proxy.Options, error) {
cfg := GrafanaConfigFromContext(ctx)
p, err := cfg.proxy()
p, err := cfg.Proxy()
if err != nil {
return nil, err
}
return s.ProxyOptions(p.clientCfg)
return s.ProxyOptions(p.ClientCfg)
}

func (s *DataSourceInstanceSettings) ProxyOptions(clientCfg *proxy.ClientCfg) (*proxy.Options, error) {
Expand Down Expand Up @@ -360,11 +361,11 @@ func (s *DataSourceInstanceSettings) ProxyOptions(clientCfg *proxy.ClientCfg) (*

func (s *DataSourceInstanceSettings) ProxyClient(ctx context.Context) (proxy.Client, error) {
cfg := GrafanaConfigFromContext(ctx)
p, err := cfg.proxy()
p, err := cfg.Proxy()
if err != nil {
return nil, err
}
proxyOpts, err := s.ProxyOptions(p.clientCfg)
proxyOpts, err := s.ProxyOptions(p.ClientCfg)
if err != nil {
return nil, err
}
Expand Down
13 changes: 7 additions & 6 deletions backend/common_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (

"github.com/grafana/grafana-plugin-sdk-go/backend/httpclient"
"github.com/grafana/grafana-plugin-sdk-go/backend/proxy"
"github.com/grafana/grafana-plugin-sdk-go/config"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down Expand Up @@ -403,7 +404,7 @@ func TestProxyOptionsFromContext(t *testing.T) {
tcs := []struct {
name string
instanceSettings *DataSourceInstanceSettings
grafanaCfg *GrafanaCfg
grafanaCfg *config.GrafanaCfg
expectedClientOptions *proxy.Options
err error
}{
Expand All @@ -415,7 +416,7 @@ func TestProxyOptionsFromContext(t *testing.T) {
JSONData: []byte("{ \"enableSecureSocksProxy\": true, \"timeout\": 10, \"keepAlive\": 15, \"secureSocksProxyUsername\": \"user\" }"),
DecryptedSecureJSONData: map[string]string{"secureSocksProxyPassword": "pass"},
},
grafanaCfg: NewGrafanaCfg(
grafanaCfg: config.NewGrafanaCfg(
map[string]string{
proxy.PluginSecureSocksProxyEnabled: "true",
proxy.PluginSecureSocksProxyClientCert: "/path/to/client-cert",
Expand Down Expand Up @@ -463,7 +464,7 @@ func TestProxyOptionsFromContext(t *testing.T) {
JSONData: []byte("{ \"enableSecureSocksProxy\": true, \"timeout\": 10, \"keepAlive\": 15 }"),
DecryptedSecureJSONData: map[string]string{"secureSocksProxyPassword": "pass"},
},
grafanaCfg: NewGrafanaCfg(
grafanaCfg: config.NewGrafanaCfg(
map[string]string{
proxy.PluginSecureSocksProxyEnabled: "true",
proxy.PluginSecureSocksProxyClientCert: "/path/to/client-cert",
Expand Down Expand Up @@ -510,7 +511,7 @@ func TestProxyOptionsFromContext(t *testing.T) {
Type: "example-datasource",
JSONData: []byte("{ \"enableSecureSocksProxy\": false }"),
},
grafanaCfg: NewGrafanaCfg(
grafanaCfg: config.NewGrafanaCfg(
map[string]string{
proxy.PluginSecureSocksProxyEnabled: "true",
proxy.PluginSecureSocksProxyClientCert: "/path/to/client-cert",
Expand All @@ -534,7 +535,7 @@ func TestProxyOptionsFromContext(t *testing.T) {
Type: "example-datasource",
JSONData: []byte("{ \"enableSecureSocksProxy\": true }"),
},
grafanaCfg: NewGrafanaCfg(
grafanaCfg: config.NewGrafanaCfg(
map[string]string{
proxy.PluginSecureSocksProxyEnabled: "false",
},
Expand All @@ -556,7 +557,7 @@ func TestProxyOptionsFromContext(t *testing.T) {
}

for _, tc := range tcs {
ctx := WithGrafanaConfig(context.Background(), tc.grafanaCfg)
ctx := config.WithGrafanaConfig(context.Background(), tc.grafanaCfg)
opts, err := tc.instanceSettings.ProxyOptionsFromContext(ctx)
if tc.err != nil {
require.ErrorIs(t, err, tc.err)
Expand Down
Loading
Loading