Plugins: Move config factory to pluginsintegration package (#65716)

* move config to pluginsintegration package

* change to all plugin toggle

* fixes

* fixes

* fix lerna

* fix test

pkg/plugins/config/config.go

@@ -1,9 +1,6 @@
 package config
 
 import (
-	"fmt"
-	"strings"
-
 	"github.com/grafana/grafana-azure-sdk-go/azsettings"
 
 	"github.com/grafana/grafana/pkg/plugins/log"
@@ -33,63 +30,24 @@ type Cfg struct {
 
 	PluginsCDNURLTemplate string
 
-	Opentelemetry OpentelemetryCfg
+	Tracing Tracing
 }
 
-func ProvideConfig(settingProvider setting.Provider, grafanaCfg *setting.Cfg) (*Cfg, error) {
-	return NewCfg(settingProvider, grafanaCfg)
-}
-
-func NewCfg(settingProvider setting.Provider, grafanaCfg *setting.Cfg) (*Cfg, error) {
-	logger := log.New("plugin.cfg")
-
-	aws := settingProvider.Section("aws")
-	plugins := settingProvider.Section("plugins")
-
-	allowedUnsigned := grafanaCfg.PluginsAllowUnsigned
-	if len(plugins.KeyValue("allow_loading_unsigned_plugins").Value()) > 0 {
-		allowedUnsigned = strings.Split(plugins.KeyValue("allow_loading_unsigned_plugins").Value(), ",")
-	}
-
-	allowedAuth := grafanaCfg.AWSAllowedAuthProviders
-	if len(aws.KeyValue("allowed_auth_providers").Value()) > 0 {
-		allowedUnsigned = strings.Split(settingProvider.KeyValue("plugins", "allow_loading_unsigned_plugins").Value(), ",")
-	}
-
-	otelCfg, err := NewOpentelemetryCfg(grafanaCfg)
-	if err != nil {
-		return nil, fmt.Errorf("new opentelemetry cfg: %w", err)
-	}
+func NewCfg(devMode bool, pluginsPath string, pluginSettings setting.PluginSettings, pluginsAllowUnsigned []string,
+	awsAllowedAuthProviders []string, awsAssumeRoleEnabled bool, azure *azsettings.AzureSettings, grafanaVersion string,
+	logDatasourceRequests bool, pluginsCDNURLTemplate string, tracing Tracing) *Cfg {
 	return &Cfg{
-		log:                     logger,
-		PluginsPath:             grafanaCfg.PluginsPath,
-		BuildVersion:            grafanaCfg.BuildVersion,
-		DevMode:                 settingProvider.KeyValue("", "app_mode").MustBool(grafanaCfg.Env == setting.Dev),
-		PluginSettings:          extractPluginSettings(settingProvider),
-		PluginsAllowUnsigned:    allowedUnsigned,
-		AWSAllowedAuthProviders: allowedAuth,
-		AWSAssumeRoleEnabled:    aws.KeyValue("assume_role_enabled").MustBool(grafanaCfg.AWSAssumeRoleEnabled),
-		Azure:                   grafanaCfg.Azure,
-		LogDatasourceRequests:   grafanaCfg.PluginLogBackendRequests,
-		PluginsCDNURLTemplate:   grafanaCfg.PluginsCDNURLTemplate,
-		Opentelemetry:           otelCfg,
-	}, nil
-}
-
-func extractPluginSettings(settingProvider setting.Provider) setting.PluginSettings {
-	ps := setting.PluginSettings{}
-	for sectionName, sectionCopy := range settingProvider.Current() {
-		if !strings.HasPrefix(sectionName, "plugin.") {
-			continue
-		}
-		// Calling Current() returns a redacted version of section. We need to replace the map values with the unredacted values.
-		section := settingProvider.Section(sectionName)
-		for k := range sectionCopy {
-			sectionCopy[k] = section.KeyValue(k).MustString("")
-		}
-		pluginID := strings.Replace(sectionName, "plugin.", "", 1)
-		ps[pluginID] = sectionCopy
+		log:                     log.New("plugin.cfg"),
+		PluginsPath:             pluginsPath,
+		BuildVersion:            grafanaVersion,
+		DevMode:                 devMode,
+		PluginSettings:          pluginSettings,
+		PluginsAllowUnsigned:    pluginsAllowUnsigned,
+		AWSAllowedAuthProviders: awsAllowedAuthProviders,
+		AWSAssumeRoleEnabled:    awsAssumeRoleEnabled,
+		Azure:                   azure,
+		LogDatasourceRequests:   logDatasourceRequests,
+		PluginsCDNURLTemplate:   pluginsCDNURLTemplate,
+		Tracing:                 tracing,
 	}
-
-	return ps
 }

pkg/plugins/config/config_test.go

@@ -1,38 +0,0 @@
-package config
-
-import (
-	"testing"
-
-	"gopkg.in/ini.v1"
-
-	"github.com/grafana/grafana/pkg/setting"
-
-	"github.com/stretchr/testify/require"
-)
-
-func TestPluginSettings(t *testing.T) {
-	raw, err := ini.Load([]byte(`
-		[plugins]
-		test_key = 123
-
-		[plugin.test-datasource]
-		foo = 5m
-		bar = something
-		
-		[plugin.secret-plugin]
-		secret_key = secret
-		normal_key = not a secret`))
-	require.NoError(t, err)
-
-	cfg := &setting.Cfg{Raw: raw}
-	settings := &setting.OSSImpl{Cfg: cfg}
-
-	ps := extractPluginSettings(settings)
-	require.Len(t, ps, 2)
-	require.Len(t, ps["test-datasource"], 2)
-	require.Equal(t, ps["test-datasource"]["foo"], "5m")
-	require.Equal(t, ps["test-datasource"]["bar"], "something")
-	require.Len(t, ps["secret-plugin"], 2)
-	require.Equal(t, ps["secret-plugin"]["secret_key"], "secret")
-	require.Equal(t, ps["secret-plugin"]["normal_key"], "not a secret")
-}

pkg/plugins/config/tracing.go

@@ -1,38 +1,17 @@
 package config
 
-import (
-	"fmt"
+type Tracing struct {
+	OpenTelemetry OpenTelemetryCfg
+}
 
-	"github.com/grafana/grafana/pkg/infra/tracing"
-	"github.com/grafana/grafana/pkg/setting"
-)
-
-const otlpExporter string = "otlp"
-
-// OpentelemetryCfg contains the Opentelemetry address and propagation config values.
-// This is used to export the Opentelemetry (OTLP) config without exposing the whole *setting.Cfg.
-type OpentelemetryCfg struct {
+// OpenTelemetryCfg contains the OpenTelemetry address and propagation config values.
+// This is used to export the OpenTelemetry (OTLP) config without exposing the whole *setting.Cfg.
+type OpenTelemetryCfg struct {
 	Address     string
 	Propagation string
 }
 
 // IsEnabled returns true if OTLP tracing is enabled (address set)
-func (c OpentelemetryCfg) IsEnabled() bool {
-	return c.Address != ""
-}
-
-// NewOpentelemetryCfg creates a new OpentelemetryCfg based on the provided Grafana config.
-// If Opentelemetry (OTLP) is disabled, a zero-value OpentelemetryCfg is returned.
-func NewOpentelemetryCfg(grafanaCfg *setting.Cfg) (OpentelemetryCfg, error) {
-	ots, err := tracing.ParseSettingsOpentelemetry(grafanaCfg)
-	if err != nil {
-		return OpentelemetryCfg{}, fmt.Errorf("parse settings: %w", err)
-	}
-	if ots.Enabled != otlpExporter {
-		return OpentelemetryCfg{}, nil
-	}
-	return OpentelemetryCfg{
-		Address:     ots.Address,
-		Propagation: ots.Propagation,
-	}, nil
+func (t Tracing) IsEnabled() bool {
+	return t.OpenTelemetry.Address != ""
 }

pkg/plugins/config/tracing_test.go

@@ -1,50 +0,0 @@
-package config
-
-import (
-	"testing"
-
-	"github.com/grafana/grafana/pkg/setting"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-)
-
-func TestNewOpentelemetryCfg(t *testing.T) {
-	t.Run("empty", func(t *testing.T) {
-		cfg := setting.NewCfg()
-
-		otelCfg, err := NewOpentelemetryCfg(cfg)
-		require.NoError(t, err)
-		assert.False(t, otelCfg.IsEnabled(), "otel should be disabled")
-		assert.Empty(t, otelCfg.Address)
-		assert.Empty(t, otelCfg.Propagation)
-	})
-
-	t.Run("enabled", func(t *testing.T) {
-		for _, tc := range []struct {
-			name        string
-			propagation string
-		}{
-			{"empty", ""},
-			{"jaeger", "jaeger"},
-			{"w3c", "w3c"},
-			{"multiple", "jaeger,w3c"},
-		} {
-			t.Run(tc.name, func(t *testing.T) {
-				const address = "127.0.0.1:4317"
-
-				cfg := setting.NewCfg()
-				otlpSect := cfg.Raw.Section("tracing.opentelemetry.otlp")
-				otlpSect.Key("address").SetValue(address)
-				if tc.propagation != "" {
-					otlpSect.Key("propagation").SetValue(tc.propagation)
-				}
-
-				otelCfg, err := NewOpentelemetryCfg(cfg)
-				require.NoError(t, err)
-				assert.True(t, otelCfg.IsEnabled(), "otel should be enabled")
-				assert.Equal(t, address, otelCfg.Address)
-				assert.Equal(t, tc.propagation, otelCfg.Propagation)
-			})
-		}
-	})
-}

pkg/plugins/manager/loader/initializer/initializer.go

@@ -70,14 +70,14 @@ func (i *Initializer) envVars(plugin *plugins.Plugin) []string {
 	if v, exists := i.cfg.PluginSettings[plugin.ID]["tracing"]; exists {
 		pluginTracingEnabled = v == "true"
 	}
-	if i.cfg.Opentelemetry.IsEnabled() && pluginTracingEnabled {
+	if i.cfg.Tracing.IsEnabled() && pluginTracingEnabled {
 		if plugin.Info.Version != "" {
 			hostEnv = append(hostEnv, fmt.Sprintf("GF_PLUGIN_VERSION=%s", plugin.Info.Version))
 		}
 		hostEnv = append(
 			hostEnv,
-			fmt.Sprintf("GF_INSTANCE_OTLP_ADDRESS=%s", i.cfg.Opentelemetry.Address),
-			fmt.Sprintf("GF_INSTANCE_OTLP_PROPAGATION=%s", i.cfg.Opentelemetry.Propagation),
+			fmt.Sprintf("GF_INSTANCE_OTLP_ADDRESS=%s", i.cfg.Tracing.OpenTelemetry.Address),
+			fmt.Sprintf("GF_INSTANCE_OTLP_PROPAGATION=%s", i.cfg.Tracing.OpenTelemetry.Propagation),
 		)
 	}
 

pkg/plugins/manager/loader/initializer/initializer_test.go

@@ -185,7 +185,7 @@ func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
 		JSONData: plugins.JSONData{ID: pluginID},
 	}
 
-	defaultOtelCfg := config.OpentelemetryCfg{
+	defaultOTelCfg := config.OpenTelemetryCfg{
 		Address:     "127.0.0.1:4317",
 		Propagation: "",
 	}
@@ -250,7 +250,7 @@ func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
 		{
 			name: "otel not configured",
 			cfg: &config.Cfg{
-				Opentelemetry: config.OpentelemetryCfg{},
+				Tracing: config.Tracing{},
 			},
 			plugin: defaultPlugin,
 			exp:    expNoTracing,
@@ -258,7 +258,7 @@ func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
 		{
 			name: "otel not configured but plugin-tracing enabled",
 			cfg: &config.Cfg{
-				Opentelemetry:  config.OpentelemetryCfg{},
+				Tracing:        config.Tracing{},
 				PluginSettings: map[string]map[string]string{pluginID: {"tracing": "true"}},
 			},
 			plugin: defaultPlugin,
@@ -267,7 +267,9 @@ func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
 		{
 			name: "otlp no propagation plugin enabled",
 			cfg: &config.Cfg{
-				Opentelemetry: defaultOtelCfg,
+				Tracing: config.Tracing{
+					OpenTelemetry: defaultOTelCfg,
+				},
 				PluginSettings: map[string]map[string]string{
 					pluginID: {"tracing": "true"},
 				},
@@ -278,7 +280,9 @@ func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
 		{
 			name: "otlp no propagation disabled by default",
 			cfg: &config.Cfg{
-				Opentelemetry: defaultOtelCfg,
+				Tracing: config.Tracing{
+					OpenTelemetry: defaultOTelCfg,
+				},
 			},
 			plugin: defaultPlugin,
 			exp:    expNoTracing,
@@ -286,9 +290,11 @@ func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
 		{
 			name: "otlp propagation plugin enabled",
 			cfg: &config.Cfg{
-				Opentelemetry: config.OpentelemetryCfg{
-					Address:     "127.0.0.1:4317",
-					Propagation: "w3c",
+				Tracing: config.Tracing{
+					OpenTelemetry: config.OpenTelemetryCfg{
+						Address:     "127.0.0.1:4317",
+						Propagation: "w3c",
+					},
 				},
 				PluginSettings: map[string]map[string]string{
 					pluginID: {"tracing": "true"},
@@ -307,9 +313,11 @@ func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
 		{
 			name: "otlp enabled composite propagation",
 			cfg: &config.Cfg{
-				Opentelemetry: config.OpentelemetryCfg{
-					Address:     "127.0.0.1:4317",
-					Propagation: "w3c,jaeger",
+				Tracing: config.Tracing{
+					OpenTelemetry: config.OpenTelemetryCfg{
+						Address:     "127.0.0.1:4317",
+						Propagation: "w3c,jaeger",
+					},
 				},
 				PluginSettings: map[string]map[string]string{
 					pluginID: {"tracing": "true"},
@@ -328,9 +336,11 @@ func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
 		{
 			name: "otlp no propagation disabled by default",
 			cfg: &config.Cfg{
-				Opentelemetry: config.OpentelemetryCfg{
-					Address:     "127.0.0.1:4317",
-					Propagation: "w3c",
+				Tracing: config.Tracing{
+					OpenTelemetry: config.OpenTelemetryCfg{
+						Address:     "127.0.0.1:4317",
+						Propagation: "w3c",
+					},
 				},
 			},
 			plugin: defaultPlugin,
@@ -339,7 +349,9 @@ func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
 		{
 			name: "disabled on plugin",
 			cfg: &config.Cfg{
-				Opentelemetry: defaultOtelCfg,
+				Tracing: config.Tracing{
+					OpenTelemetry: defaultOTelCfg,
+				},
 				PluginSettings: setting.PluginSettings{
 					pluginID: map[string]string{"tracing": "false"},
 				},
@@ -350,7 +362,9 @@ func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
 		{
 			name: "disabled on plugin with other plugin settings",
 			cfg: &config.Cfg{
-				Opentelemetry: defaultOtelCfg,
+				Tracing: config.Tracing{
+					OpenTelemetry: defaultOTelCfg,
+				},
 				PluginSettings: map[string]map[string]string{
 					pluginID: {"some_other_option": "true"},
 				},
@@ -361,7 +375,9 @@ func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
 		{
 			name: "enabled on plugin with other plugin settings",
 			cfg: &config.Cfg{
-				Opentelemetry: defaultOtelCfg,
+				Tracing: config.Tracing{
+					OpenTelemetry: defaultOTelCfg,
+				},
 				PluginSettings: map[string]map[string]string{
 					pluginID: {"some_other_option": "true", "tracing": "true"},
 				},
@@ -372,7 +388,9 @@ func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
 		{
 			name: "GF_PLUGIN_VERSION is not present if tracing is disabled",
 			cfg: &config.Cfg{
-				Opentelemetry:  config.OpentelemetryCfg{}, // no OTEL config
+				Tracing: config.Tracing{
+					OpenTelemetry: config.OpenTelemetryCfg{},
+				},
 				PluginSettings: map[string]map[string]string{pluginID: {"tracing": "true"}},
 			},
 			plugin: defaultPlugin,
@@ -381,7 +399,9 @@ func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
 		{
 			name: "GF_PLUGIN_VERSION is present if tracing is enabled and plugin has version",
 			cfg: &config.Cfg{
-				Opentelemetry:  defaultOtelCfg,
+				Tracing: config.Tracing{
+					OpenTelemetry: defaultOTelCfg,
+				},
 				PluginSettings: map[string]map[string]string{pluginID: {"tracing": "true"}},
 			},
 			plugin: defaultPlugin,
@@ -390,7 +410,9 @@ func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
 		{
 			name: "GF_PLUGIN_VERSION is not present if tracing is enabled but plugin doesn't have a version",
 			cfg: &config.Cfg{
-				Opentelemetry:  config.OpentelemetryCfg{},
+				Tracing: config.Tracing{
+					OpenTelemetry: config.OpenTelemetryCfg{},
+				},
 				PluginSettings: map[string]map[string]string{pluginID: {"tracing": "true"}},
 			},
 			plugin: pluginWithoutVersion,

pkg/plugins/manager/manager_integration_test.go

@@ -18,7 +18,6 @@ import (
 	"github.com/grafana/grafana/pkg/plugins"
 	"github.com/grafana/grafana/pkg/plugins/backendplugin/coreplugin"
 	"github.com/grafana/grafana/pkg/plugins/backendplugin/provider"
-	"github.com/grafana/grafana/pkg/plugins/config"
 	"github.com/grafana/grafana/pkg/plugins/manager/client"
 	"github.com/grafana/grafana/pkg/plugins/manager/fakes"
 	"github.com/grafana/grafana/pkg/plugins/manager/loader"
@@ -31,6 +30,7 @@ import (
 	"github.com/grafana/grafana/pkg/plugins/pluginscdn"
 	"github.com/grafana/grafana/pkg/services/featuremgmt"
 	"github.com/grafana/grafana/pkg/services/licensing"
+	"github.com/grafana/grafana/pkg/services/pluginsintegration/config"
 	plicensing "github.com/grafana/grafana/pkg/services/pluginsintegration/licensing"
 	"github.com/grafana/grafana/pkg/services/searchV2"
 	"github.com/grafana/grafana/pkg/setting"