Move MapProvider to config package (open-telemetry#4178)

* Move MapProvider and Watchable interfaces to config package

* Rename `Watchable` to `WatchableMapProvider`

* Add CHANGELOG entry

* Update CHANGELOG.md

Co-authored-by: Bogdan Drutu <lazy@splunk.com>

Author: mx-psi

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 🛑 Breaking changes 🛑
+
+- Rename `parserprovider.MapProvider` as `config.MapProvider` (#4178)
+- Rename `parserprovider.Watchable` as `config.WatchableMapProvider` (#4178)
+
 ## v0.37.0 Beta
 
 ## 🛑 Breaking changes 🛑

service/parserprovider/provider.go config/provider.goservice/parserprovider/provider.go renamed to config/provider.go

@@ -12,29 +12,27 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package parserprovider // import "go.opentelemetry.io/collector/service/parserprovider"
+package config // import "go.opentelemetry.io/collector/config"
 
 import (
 	"context"
-
-	"go.opentelemetry.io/collector/config"
 )
 
 // MapProvider is an interface that helps providing configuration's parser.
 // Implementations may load the parser from a file, a database or any other source.
 type MapProvider interface {
-	// Get returns the config.Map if succeed or error otherwise.
-	Get(ctx context.Context) (*config.Map, error)
+	// Get returns the Map if succeed or error otherwise.
+	Get(ctx context.Context) (*Map, error)
 
 	// Close signals that the configuration for which it was used to retrieve values is no longer in use
 	// and the object should close and release any watchers that it may have created.
 	// This method must be called when the service ends, either in case of success or error.
 	Close(ctx context.Context) error
 }
 
-// Watchable is an extension for MapProvider that is implemented if the given provider
+// WatchableMapProvider is an extension for MapProvider that is implemented if the given provider
 // supports monitoring of configuration updates.
-type Watchable interface {
+type WatchableMapProvider interface {
 	// WatchForUpdate waits for updates on any of the values retrieved from config sources.
 	// It blocks until configuration updates are received and can
 	// return an error if anything fails. WatchForUpdate is used once during the

service/collector.go

@@ -34,12 +34,12 @@ import (
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/config/configunmarshaler"
 	"go.opentelemetry.io/collector/config/experimental/configsource"
 	"go.opentelemetry.io/collector/extension/ballastextension"
 	"go.opentelemetry.io/collector/service/internal"
 	"go.opentelemetry.io/collector/service/internal/telemetrylogs"
-	"go.opentelemetry.io/collector/service/parserprovider"
 )
 
 // State defines Collector's state.
@@ -194,7 +194,7 @@ func (col *Collector) setupConfigurationComponents(ctx context.Context) error {
 	}
 
 	// If provider is watchable start a goroutine watching for updates.
-	if watchable, ok := col.set.ConfigMapProvider.(parserprovider.Watchable); ok {
+	if watchable, ok := col.set.ConfigMapProvider.(config.WatchableMapProvider); ok {
 		go col.watchForConfigUpdates(watchable)
 	}
 
@@ -285,7 +285,7 @@ func (col *Collector) reloadService(ctx context.Context) error {
 	return nil
 }
 
-func (col *Collector) watchForConfigUpdates(watchable parserprovider.Watchable) {
+func (col *Collector) watchForConfigUpdates(watchable config.WatchableMapProvider) {
 	err := watchable.WatchForUpdate()
 	if errors.Is(err, configsource.ErrSessionClosed) {
 		// This is the case of shutdown of the whole collector server, nothing to do.

service/collector_test.go

@@ -282,7 +282,7 @@ func TestCollector_reloadService(t *testing.T) {
 
 	tests := []struct {
 		name           string
-		parserProvider parserprovider.MapProvider
+		parserProvider config.MapProvider
 		service        *service
 	}{
 		{

service/parserprovider/default.go

@@ -14,9 +14,11 @@
 
 package parserprovider // import "go.opentelemetry.io/collector/service/parserprovider"
 
-// NewDefaultMapProvider returns the default MapProvider, and it creates configuration from a file
+import "go.opentelemetry.io/collector/config"
+
+// NewDefaultMapProvider returns the default config.MapProvider, and it creates configuration from a file
 // defined by the given configFile and overwrites fields using properties.
-func NewDefaultMapProvider(configFileName string, properties []string) MapProvider {
+func NewDefaultMapProvider(configFileName string, properties []string) config.MapProvider {
 	return NewExpandMapProvider(
 		NewMergeMapProvider(
 			NewFileMapProvider(configFileName),

service/parserprovider/expand.go

@@ -22,12 +22,12 @@ import (
 )
 
 type expandMapProvider struct {
-	base MapProvider
+	base config.MapProvider
 }
 
-// NewExpandMapProvider returns a MapProvider, that expands all environment variables for a
-// config.Map provided by the given MapProvider.
-func NewExpandMapProvider(base MapProvider) MapProvider {
+// NewExpandMapProvider returns a config.MapProvider, that expands all environment variables for a
+// config.Map provided by the given config.MapProvider.
+func NewExpandMapProvider(base config.MapProvider) config.MapProvider {
 	return &expandMapProvider{
 		base: base,
 	}

service/parserprovider/file.go

@@ -26,8 +26,8 @@ type fileMapProvider struct {
 	fileName string
 }
 
-// NewFileMapProvider returns a new MapProvider that reads the configuration from the given file.
-func NewFileMapProvider(fileName string) MapProvider {
+// NewFileMapProvider returns a new config.MapProvider that reads the configuration from the given file.
+func NewFileMapProvider(fileName string) config.MapProvider {
 	return &fileMapProvider{
 		fileName: fileName,
 	}

service/parserprovider/inmemory.go

@@ -25,8 +25,8 @@ type inMemoryMapProvider struct {
 	buf io.Reader
 }
 
-// NewInMemoryMapProvider returns a new MapProvider that reads the configuration, from the provided buffer, as YAML.
-func NewInMemoryMapProvider(buf io.Reader) MapProvider {
+// NewInMemoryMapProvider returns a new config.MapProvider that reads the configuration, from the provided buffer, as YAML.
+func NewInMemoryMapProvider(buf io.Reader) config.MapProvider {
 	return &inMemoryMapProvider{buf: buf}
 }
 

service/parserprovider/merge.go

@@ -25,13 +25,13 @@ import (
 // TODO: Add support to "merge" watchable interface.
 
 type mergeMapProvider struct {
-	providers []MapProvider
+	providers []config.MapProvider
 }
 
-// NewMergeMapProvider returns a config.MapProvider, that merges the result from multiple MapProvider.
+// NewMergeMapProvider returns a config.MapProvider, that merges the result from multiple config.MapProvider.
 //
 // The ConfigMaps are merged in the given order, by merging all of them in order into an initial empty map.
-func NewMergeMapProvider(ps ...MapProvider) MapProvider {
+func NewMergeMapProvider(ps ...config.MapProvider) config.MapProvider {
 	return &mergeMapProvider{providers: ps}
 }
 

service/parserprovider/properties.go

@@ -29,12 +29,12 @@ type propertiesMapProvider struct {
 	properties []string
 }
 
-// NewPropertiesMapProvider returns a MapProvider, that provides a config.Map from the given properties.
+// NewPropertiesMapProvider returns a config.MapProvider, that provides a config.Map from the given properties.
 //
 // Properties must follow the Java properties format, key-value list separated by equal sign with a "."
 // as key delimiter.
 //  ["processors.batch.timeout=2s", "processors.batch/foo.timeout=3s"]
-func NewPropertiesMapProvider(properties []string) MapProvider {
+func NewPropertiesMapProvider(properties []string) config.MapProvider {
 	return &propertiesMapProvider{
 		properties: properties,
 	}