Create confmap module factory types

confmap/confmap.go

@@ -417,3 +417,23 @@ func zeroSliceHookFunc() mapstructure.DecodeHookFuncValue {
 		return from.Interface(), nil
 	}
 }
+
+type moduleFactory[T any, S any] interface {
+	Create(s S) T
+}
+
+type createConfmapFunc[T any, S any] func(s S) T
+
+type confmapModuleFactory[T any, S any] struct {
+	f createConfmapFunc[T, S]
+}
+
+func (c confmapModuleFactory[T, S]) Create(s S) T {
+	return c.f(s)
+}
+
+func newConfmapModuleFactory[T any, S any](f createConfmapFunc[T, S]) moduleFactory[T, S] {
+	return confmapModuleFactory[T, S]{
+		f: f,
+	}
+}

confmap/converter.go

@@ -8,9 +8,20 @@ import (
 )
 
 // ConverterSettings are the settings to initialize a Converter.
-// Any Converter should take this as a parameter in its constructor.
 type ConverterSettings struct{}
 
+// ConverterFactory defines a factory that can be used to instantiate
+// new instances of a Converter.
+type ConverterFactory = moduleFactory[Converter, ConverterSettings]
+
+// CreateConverterFunc is a function that creates a Converter instance.
+type CreateConverterFunc = createConfmapFunc[Converter, ConverterSettings]
+
+// NewConverterFactory can be used to create a ConverterFactory.
+func NewConverterFactory(f CreateConverterFunc) ConverterFactory {
+	return newConfmapModuleFactory(f)
+}
+
 // Converter is a converter interface for the confmap.Conf that allows distributions
 // (in the future components as well) to build backwards compatible config converters.
 type Converter interface {

confmap/converter/expandconverter/expand.go

@@ -22,6 +22,7 @@ type converter struct {
 }
 
 // New returns a confmap.Converter, that expands all environment variables for a given confmap.Conf.
+// Deprecated [v0.99.0]: Use NewFactory instead.
 //
 // Notice: This API is experimental.
 func New(_ confmap.ConverterSettings) confmap.Converter {
@@ -31,6 +32,12 @@ func New(_ confmap.ConverterSettings) confmap.Converter {
 	}
 }
 
+// NewFactory returns a factory for a  confmap.Converter,
+// which expands all environment variables for a given confmap.Conf.
+func NewFactory() confmap.ConverterFactory {
+	return confmap.NewConverterFactory(New)
+}
+
 func (c converter) Convert(_ context.Context, conf *confmap.Conf) error {
 	out := make(map[string]any)
 	for _, k := range conf.AllKeys() {

confmap/provider.go

@@ -11,11 +11,22 @@ import (
 )
 
 // ProviderSettings are the settings to initialize a Provider.
-// Any Provider should take this as a parameter in its constructor.
 type ProviderSettings struct {
 	Logger *zap.Logger
 }
 
+// ProviderFactory defines a factory that can be used to instantiate
+// new instances of a Provider.
+type ProviderFactory = moduleFactory[Provider, ProviderSettings]
+
+// CreateProviderFunc is a function that creates a Provider instance.
+type CreateProviderFunc = createConfmapFunc[Provider, ProviderSettings]
+
+// NewProviderFactory can be used to create a ProviderFactory.
+func NewProviderFactory(f CreateProviderFunc) ProviderFactory {
+	return newConfmapModuleFactory(f)
+}
+
 // Provider is an interface that helps to retrieve a config map and watch for any
 // changes to the config map. Implementations may load the config from a file,
 // a database or any other source.

confmap/provider/envprovider/provider.go

@@ -22,6 +22,7 @@ type provider struct {
 }
 
 // NewWithSettings returns a new confmap.Provider that reads the configuration from the given environment variable.
+// Deprecated [v0.99.0]: Use NewFactory instead.
 //
 // This Provider supports "env" scheme, and can be called with a selector:
 // `env:NAME_OF_ENVIRONMENT_VARIABLE`
@@ -31,6 +32,14 @@ func NewWithSettings(ps confmap.ProviderSettings) confmap.Provider {
 	}
 }
 
+// NewWithSettings returns a new confmap.Provider that reads the configuration from the given environment variable.
+//
+// This Provider supports "env" scheme, and can be called with a selector:
+// `env:NAME_OF_ENVIRONMENT_VARIABLE`
+func NewFactory() confmap.ProviderFactory {
+	return confmap.NewProviderFactory(NewWithSettings)
+}
+
 func (emp *provider) Retrieve(_ context.Context, uri string, _ confmap.WatcherFunc) (*confmap.Retrieved, error) {
 	if !strings.HasPrefix(uri, schemeName+":") {
 		return nil, fmt.Errorf("%q uri is not supported by %q provider", uri, schemeName)

confmap/provider/fileprovider/provider.go

@@ -19,6 +19,7 @@ const schemeName = "file"
 type provider struct{}
 
 // NewWithSettings returns a new confmap.Provider that reads the configuration from a file.
+// Deprecated [v0.99.0]: Use NewFactory instead.
 //
 // This Provider supports "file" scheme, and can be called with a "uri" that follows:
 //
@@ -37,6 +38,25 @@ func NewWithSettings(confmap.ProviderSettings) confmap.Provider {
 	return &provider{}
 }
 
+// NewFactory returns a factory for a confmap.Provider that reads the configuration from a file.
+//
+// This Provider supports "file" scheme, and can be called with a "uri" that follows:
+//
+//	file-uri		= "file:" local-path
+//	local-path		= [ drive-letter ] file-path
+//	drive-letter	= ALPHA ":"
+//
+// The "file-path" can be relative or absolute, and it can be any OS supported format.
+//
+// Examples:
+// `file:path/to/file` - relative path (unix, windows)
+// `file:/path/to/file` - absolute path (unix, windows)
+// `file:c:/path/to/file` - absolute path including drive-letter (windows)
+// `file:c:\path\to\file` - absolute path including drive-letter (windows)
+func NewFactory() confmap.ProviderFactory {
+	return confmap.NewProviderFactory(NewWithSettings)
+}
+
 func (fmp *provider) Retrieve(_ context.Context, uri string, _ confmap.WatcherFunc) (*confmap.Retrieved, error) {
 	if !strings.HasPrefix(uri, schemeName+":") {
 		return nil, fmt.Errorf("%q uri is not supported by %q provider", uri, schemeName)

confmap/provider/httpprovider/provider.go

@@ -9,10 +9,20 @@ import (
 )
 
 // NewWithSettings returns a new confmap.Provider that reads the configuration from a http server.
+// Deprecated [v0.99.0]: Use NewFactory instead.
 //
 // This Provider supports "http" scheme.
 //
 // One example for HTTP URI is: http://localhost:3333/getConfig
 func NewWithSettings(set confmap.ProviderSettings) confmap.Provider {
 	return configurablehttpprovider.New(configurablehttpprovider.HTTPScheme, set)
 }
+
+// NewFactory returns a factory for a confmap.Provider that reads the configuration from a http server.
+//
+// This Provider supports "http" scheme.
+//
+// One example for HTTP URI is: http://localhost:3333/getConfig
+func NewFactory() confmap.ProviderFactory {
+	return confmap.NewProviderFactory(NewWithSettings)
+}

confmap/provider/httpsprovider/provider.go

@@ -8,7 +8,8 @@ import (
 	"go.opentelemetry.io/collector/confmap/provider/internal/configurablehttpprovider"
 )
 
-// New returns a new confmap.Provider that reads the configuration from a https server.
+// NewWithSettings returns a new confmap.Provider that reads the configuration from a https server.
+// Deprecated [v0.99.0]: Use NewFactory instead.
 //
 // This Provider supports "https" scheme. One example of an HTTPS URI is: https://localhost:3333/getConfig
 //
@@ -17,3 +18,13 @@ import (
 func NewWithSettings(set confmap.ProviderSettings) confmap.Provider {
 	return configurablehttpprovider.New(configurablehttpprovider.HTTPSScheme, set)
 }
+
+// NewFactory returns a factory for a confmap.Provider that reads the configuration from a https server.
+//
+// This Provider supports "https" scheme. One example of an HTTPS URI is: https://localhost:3333/getConfig
+//
+// To add extra CA certificates you need to install certificates in the system pool. This procedure is operating system
+// dependent. E.g.: on Linux please refer to the `update-ca-trust` command.
+func NewFactory() confmap.ProviderFactory {
+	return confmap.NewProviderFactory(NewWithSettings)
+}

confmap/provider/yamlprovider/provider.go

@@ -29,6 +29,20 @@ func NewWithSettings(confmap.ProviderSettings) confmap.Provider {
 	return &provider{}
 }
 
+// NewFactory returns a factory for a confmap.Provider that allows to provide yaml bytes.
+// Deprecated [v0.99.0]: Use NewFactory instead.
+//
+// This Provider supports "yaml" scheme, and can be called with a "uri" that follows:
+//
+//	bytes-uri = "yaml:" yaml-bytes
+//
+// Examples:
+// `yaml:processors::batch::timeout: 2s`
+// `yaml:processors::batch/foo::timeout: 3s`
+func NewFactory() confmap.ProviderFactory {
+	return confmap.NewProviderFactory(NewWithSettings)
+}
+
 func (s *provider) Retrieve(_ context.Context, uri string, _ confmap.WatcherFunc) (*confmap.Retrieved, error) {
 	if !strings.HasPrefix(uri, schemeName+":") {
 		return nil, fmt.Errorf("%q uri is not supported by %q provider", uri, schemeName)

confmap/resolver.go

@@ -27,10 +27,6 @@ type Resolver struct {
 	watcher chan error
 }
 
-type ConverterFactory = func(ConverterSettings) Converter
-
-type ProviderFactory = func(ProviderSettings) Provider
-
 // ResolverSettings are the settings to configure the behavior of the Resolver.
 type ResolverSettings struct {
 	// URIs locations from where the Conf is retrieved, and merged in the given order.
@@ -97,8 +93,8 @@ func NewResolver(set ResolverSettings) (*Resolver, error) {
 		providers = set.Providers
 	} else {
 		providers = make(map[string]Provider, len(set.ProviderFactories))
-		for _, newProvider := range set.ProviderFactories {
-			provider := newProvider(set.ProviderSettings)
+		for _, factory := range set.ProviderFactories {
+			provider := factory.Create(set.ProviderSettings)
 			providers[provider.Scheme()] = provider
 		}
 	}
@@ -110,8 +106,8 @@ func NewResolver(set ResolverSettings) (*Resolver, error) {
 		converters = set.Converters
 	} else {
 		converters = make([]Converter, len(set.ConverterFactories))
-		for i, newConverter := range set.ConverterFactories {
-			converters[i] = newConverter(set.ConverterSettings)
+		for i, factory := range set.ConverterFactories {
+			converters[i] = factory.Create(set.ConverterSettings)
 		}
 	}
 

confmap/resolver_test.go

@@ -48,9 +48,9 @@ func (m *mockProvider) Shutdown(context.Context) error {
 }
 
 func newMockProvider(m *mockProvider) ProviderFactory {
-	return func(_ ProviderSettings) Provider {
+	return NewProviderFactory(func(_ ProviderSettings) Provider {
 		return m
-	}
+	})
 }
 
 type fakeProvider struct {
@@ -65,12 +65,12 @@ func newFileProvider(t testing.TB) ProviderFactory {
 }
 
 func newFakeProvider(scheme string, ret func(ctx context.Context, uri string, watcher WatcherFunc) (*Retrieved, error)) ProviderFactory {
-	return func(ProviderSettings) Provider {
+	return NewProviderFactory(func(ProviderSettings) Provider {
 		return &fakeProvider{
 			scheme: scheme,
 			ret:    ret,
 		}
-	}
+	})
 }
 
 func (f *fakeProvider) Retrieve(ctx context.Context, uri string, watcher WatcherFunc) (*Retrieved, error) {
@@ -174,12 +174,12 @@ func TestResolverErrors(t *testing.T) {
 			mockProviderFuncs := make([]ProviderFactory, len(tt.providers))
 			for i, provider := range tt.providers {
 				p := provider
-				mockProviderFuncs[i] = func(_ ProviderSettings) Provider { return p }
+				mockProviderFuncs[i] = NewProviderFactory(func(_ ProviderSettings) Provider { return p })
 			}
 			converterFuncs := make([]ConverterFactory, len(tt.converters))
 			for i, converter := range tt.converters {
 				c := converter
-				converterFuncs[i] = func(_ ConverterSettings) Converter { return c }
+				converterFuncs[i] = NewConverterFactory(func(_ ConverterSettings) Converter { return c })
 			}
 			resolver, err := NewResolver(ResolverSettings{URIs: tt.locations, ProviderFactories: mockProviderFuncs, ConverterFactories: converterFuncs})
 			if tt.expectBuildErr {
@@ -376,7 +376,7 @@ func TestCantConfigureTwoConverterSettings(t *testing.T) {
 	_, err := NewResolver(ResolverSettings{
 		URIs:               []string{filepath.Join("testdata", "config.yaml")},
 		ProviderFactories:  []ProviderFactory{newFileProvider(t)},
-		ConverterFactories: []ConverterFactory{func(_ ConverterSettings) Converter { return &mockConverter{} }},
+		ConverterFactories: []ConverterFactory{NewConverterFactory(func(_ ConverterSettings) Converter { return &mockConverter{} })},
 		Converters:         []Converter{&mockConverter{err: errors.New("converter_err")}},
 	})
 	require.Error(t, err)

otelcol/collector_test.go

@@ -440,7 +440,7 @@ func TestPassConfmapToServiceFailure(t *testing.T) {
 		ConfigProviderSettings: ConfigProviderSettings{
 			ResolverSettings: confmap.ResolverSettings{
 				URIs:              []string{filepath.Join("testdata", "otelcol-invalid.yaml")},
-				ProviderFactories: []confmap.ProviderFactory{newFailureProvider},
+				ProviderFactories: []confmap.ProviderFactory{confmap.NewProviderFactory(newFailureProvider)},
 			},
 		},
 	}

otelcol/command_test.go

@@ -53,8 +53,8 @@ func TestAddFlagToSettings(t *testing.T) {
 		ConfigProviderSettings: ConfigProviderSettings{
 			ResolverSettings: confmap.ResolverSettings{
 				URIs:               []string{filepath.Join("testdata", "otelcol-invalid.yaml")},
-				ProviderFactories:  []confmap.ProviderFactory{fileprovider.NewWithSettings},
-				ConverterFactories: []confmap.ConverterFactory{expandconverter.New},
+				ProviderFactories:  []confmap.ProviderFactory{fileprovider.NewFactory()},
+				ConverterFactories: []confmap.ConverterFactory{expandconverter.NewFactory()},
 			},
 		},
 	}
@@ -88,7 +88,7 @@ func TestInvalidCollectorSettings(t *testing.T) {
 	set := CollectorSettings{
 		ConfigProviderSettings: ConfigProviderSettings{
 			ResolverSettings: confmap.ResolverSettings{
-				ConverterFactories: []confmap.ConverterFactory{expandconverter.New},
+				ConverterFactories: []confmap.ConverterFactory{expandconverter.NewFactory()},
 				URIs:               []string{"--config=otelcol-nop.yaml"},
 			},
 		},
@@ -102,8 +102,8 @@ func TestNewCommandInvalidComponent(t *testing.T) {
 	set := ConfigProviderSettings{
 		ResolverSettings: confmap.ResolverSettings{
 			URIs:               []string{filepath.Join("testdata", "otelcol-invalid.yaml")},
-			ProviderFactories:  []confmap.ProviderFactory{fileprovider.NewWithSettings},
-			ConverterFactories: []confmap.ConverterFactory{expandconverter.New},
+			ProviderFactories:  []confmap.ProviderFactory{fileprovider.NewFactory()},
+			ConverterFactories: []confmap.ConverterFactory{expandconverter.NewFactory()},
 		},
 	}
 

otelcol/command_validate_test.go

@@ -27,8 +27,8 @@ func TestValidateSubCommandInvalidComponents(t *testing.T) {
 		ConfigProviderSettings{
 			ResolverSettings: confmap.ResolverSettings{
 				URIs:               []string{filepath.Join("testdata", "otelcol-invalid-components.yaml")},
-				ProviderFactories:  []confmap.ProviderFactory{fileprovider.NewWithSettings},
-				ConverterFactories: []confmap.ConverterFactory{expandconverter.New},
+				ProviderFactories:  []confmap.ProviderFactory{fileprovider.NewFactory()},
+				ConverterFactories: []confmap.ConverterFactory{expandconverter.NewFactory()},
 			},
 		})
 	require.NoError(t, err)

otelcol/configprovider.go

@@ -136,13 +136,13 @@ func newDefaultConfigProviderSettings(uris []string) ConfigProviderSettings {
 		ResolverSettings: confmap.ResolverSettings{
 			URIs: uris,
 			ProviderFactories: []confmap.ProviderFactory{
-				fileprovider.NewWithSettings,
-				envprovider.NewWithSettings,
-				yamlprovider.NewWithSettings,
-				httpprovider.NewWithSettings,
-				httpsprovider.NewWithSettings,
+				fileprovider.NewFactory(),
+				envprovider.NewFactory(),
+				yamlprovider.NewFactory(),
+				httpprovider.NewFactory(),
+				httpsprovider.NewFactory(),
 			},
-			ConverterFactories: []confmap.ConverterFactory{expandconverter.New},
+			ConverterFactories: []confmap.ConverterFactory{expandconverter.NewFactory()},
 		},
 	}
 }

otelcol/configprovider_test.go

@@ -51,7 +51,7 @@ func TestConfigProviderYaml(t *testing.T) {
 	set := ConfigProviderSettings{
 		ResolverSettings: confmap.ResolverSettings{
 			URIs:              []string{uriLocation},
-			ProviderFactories: []confmap.ProviderFactory{yamlprovider.NewWithSettings},
+			ProviderFactories: []confmap.ProviderFactory{yamlprovider.NewFactory()},
 		},
 	}
 
@@ -75,7 +75,7 @@ func TestConfigProviderFile(t *testing.T) {
 	set := ConfigProviderSettings{
 		ResolverSettings: confmap.ResolverSettings{
 			URIs:              []string{uriLocation},
-			ProviderFactories: []confmap.ProviderFactory{fileprovider.NewWithSettings},
+			ProviderFactories: []confmap.ProviderFactory{fileprovider.NewFactory()},
 		},
 	}
 
@@ -102,7 +102,7 @@ func TestGetConfmap(t *testing.T) {
 	set := ConfigProviderSettings{
 		ResolverSettings: confmap.ResolverSettings{
 			URIs:              []string{uriLocation},
-			ProviderFactories: []confmap.ProviderFactory{fileprovider.NewWithSettings},
+			ProviderFactories: []confmap.ProviderFactory{fileprovider.NewFactory()},
 		},
 	}