Skip to content
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.

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

ExtensionDefaultConfigFunc should be ExtensionCreateDefaultConfigFunc #5451

Merged
merged 4 commits into from
Jun 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
- Package `expandmapconverter` -> `expandconverter`
- Package `filemapprovider` -> `fileprovider`
- Package `overwritepropertiesmapconverter` -> `overwritepropertiesconverter`
- Deprecate `component.ExtensionDefaultConfigFunc` in favor of `component.ExtensionCreateDefaultConfigFunc` (#5451)

### 💡 Enhancements 💡

Expand Down
19 changes: 11 additions & 8 deletions component/extension.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,14 @@ type ExtensionCreateSettings struct {
BuildInfo BuildInfo
}

// ExtensionDefaultConfigFunc is the equivalent of component.ExtensionFactory.CreateDefaultConfig()
type ExtensionDefaultConfigFunc func() config.Extension
// Deprecated: [v0.53.0] use ExtensionCreateDefaultConfigFunc.
type ExtensionDefaultConfigFunc = ExtensionCreateDefaultConfigFunc

// ExtensionCreateDefaultConfigFunc is the equivalent of component.ExtensionFactory.CreateDefaultConfig()
type ExtensionCreateDefaultConfigFunc func() config.Extension

// CreateDefaultConfig implements ExtensionFactory.CreateDefaultConfig()
func (f ExtensionDefaultConfigFunc) CreateDefaultConfig() config.Extension {
func (f ExtensionCreateDefaultConfigFunc) CreateDefaultConfig() config.Extension {
return f()
}

Expand Down Expand Up @@ -87,17 +90,17 @@ type ExtensionFactory interface {

type extensionFactory struct {
baseFactory
ExtensionDefaultConfigFunc
ExtensionCreateDefaultConfigFunc
CreateExtensionFunc
}

func NewExtensionFactory(
cfgType config.Type,
createDefaultConfig ExtensionDefaultConfigFunc,
createDefaultConfig ExtensionCreateDefaultConfigFunc,
createServiceExtension CreateExtensionFunc) ExtensionFactory {
return &extensionFactory{
baseFactory: baseFactory{cfgType: cfgType},
ExtensionDefaultConfigFunc: createDefaultConfig,
CreateExtensionFunc: createServiceExtension,
baseFactory: baseFactory{cfgType: cfgType},
ExtensionCreateDefaultConfigFunc: createDefaultConfig,
CreateExtensionFunc: createServiceExtension,
}
}