[confmap/provider/s3] Switch to NewFactory

.chloggen/s3provider-factory.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: deprecation
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: confmap/provider/s3
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Deprecate `s3provider.New` in favor of `s3provider.NewFactory`
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [32742]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [api]

confmap/provider/s3provider/provider.go

@@ -33,6 +33,26 @@ type provider struct {
 	client s3Client
 }
 
+// NewFactory returns a new confmap.ProviderFactory that creates a confmap.Provider
+// which reads configuration from a file obtained from an s3 bucket.
+//
+// This Provider supports "s3" scheme, and can be called with a "uri" that follows:
+//
+//	s3-uri : s3://[BUCKET].s3.[REGION].amazonaws.com/[KEY]
+//
+// One example for s3-uri be like: s3://doc-example-bucket.s3.us-west-2.amazonaws.com/photos/puppy.jpg
+// References: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html
+//
+// Examples:
+// `s3://DOC-EXAMPLE-BUCKET.s3.us-west-2.amazonaws.com/photos/puppy.jpg` - (unix, windows)
+func NewFactory() confmap.ProviderFactory {
+	return confmap.NewProviderFactory(newWithSettings)
+}
+
+func newWithSettings(_ confmap.ProviderSettings) confmap.Provider {
+	return &provider{client: nil}
+}
+
 // New returns a new confmap.Provider that reads the configuration from a file.
 //
 // This Provider supports "s3" scheme, and can be called with a "uri" that follows:
@@ -44,6 +64,8 @@ type provider struct {
 //
 // Examples:
 // `s3://DOC-EXAMPLE-BUCKET.s3.us-west-2.amazonaws.com/photos/puppy.jpg` - (unix, windows)
+//
+// Deprecated: [v0.100.0] Use NewFactory() instead.
 func New() confmap.Provider {
 	return &provider{client: nil}
 }

confmap/provider/s3provider/provider_test.go

@@ -125,3 +125,9 @@ func TestScheme(t *testing.T) {
 	assert.Equal(t, "s3", fp.Scheme())
 	require.NoError(t, fp.Shutdown(context.Background()))
 }
+
+func TestFactory(t *testing.T) {
+	p := NewFactory().Create(confmap.ProviderSettings{})
+	_, ok := p.(*provider)
+	require.True(t, ok)
+}