Standarize Settings, Params and Parameters in Extensions (#3294)

pmatyjasek-sumo · web-flow · commit 827f5e17020f · 2021-06-01T22:08:31.000-07:00
* Replace ExtensionCreateParams with ExtensionCreateSettings.
Replace all dependencies in Extensions.

Signed-off-by: Patryk Matyjasek &lt;pmatyjasek@sumologic.com&gt;

* Update changelog

Signed-off-by: Patryk Matyjasek &lt;pmatyjasek@sumologic.com&gt;

# Conflicts:
#	CHANGELOG.md

* Add missing files

Signed-off-by: Patryk Matyjasek &lt;pmatyjasek@sumologic.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@
 - Remove unused testutil.TempSocketName (#3291)
 - Move BigEndian helper functions in `tracetranslator` to an internal package.(#3298)
 - Rename `configtest.LoadConfigFile` to `configtest.LoadConfigAndValidate` (#3306)
+- Replace `ExtensionCreateParams` with `ExtensionCreateSettings` (#3294)
 
 ## 💡 Enhancements 💡
 
diff --git a/component/componenttest/nop_extension.go b/component/componenttest/nop_extension.go
@@ -51,7 +51,7 @@ func (f *nopExtensionFactory) CreateDefaultConfig() config.Extension {
 // CreateExtension implements component.ExtensionFactory interface.
 func (f *nopExtensionFactory) CreateExtension(
 	_ context.Context,
-	_ component.ExtensionCreateParams,
+	_ component.ExtensionCreateSettings,
 	_ config.Extension,
 ) (component.Extension, error) {
 	return nopExtensionInstance, nil
diff --git a/component/componenttest/nop_extension_test.go b/component/componenttest/nop_extension_test.go
@@ -32,7 +32,7 @@ func TestNewNopExtensionFactory(t *testing.T) {
 	cfg := factory.CreateDefaultConfig()
 	assert.Equal(t, &nopExtensionConfig{ExtensionSettings: config.NewExtensionSettings(config.NewID("nop"))}, cfg)
 
-	traces, err := factory.CreateExtension(context.Background(), component.ExtensionCreateParams{}, cfg)
+	traces, err := factory.CreateExtension(context.Background(), component.ExtensionCreateSettings{}, cfg)
 	require.NoError(t, err)
 	assert.NoError(t, traces.Start(context.Background(), NewNopHost()))
 	assert.NoError(t, traces.Shutdown(context.Background()))
diff --git a/component/extension.go b/component/extension.go
@@ -46,8 +46,8 @@ type PipelineWatcher interface {
 	NotReady() error
 }
 
-// ExtensionCreateParams is passed to ExtensionFactory.Create* functions.
-type ExtensionCreateParams struct {
+// ExtensionCreateSettings is passed to ExtensionFactory.Create* functions.
+type ExtensionCreateSettings struct {
 	// Logger that the factory can use during creation and can pass to the created
 	// component to be used later as well.
 	Logger *zap.Logger
@@ -70,5 +70,5 @@ type ExtensionFactory interface {
 	CreateDefaultConfig() config.Extension
 
 	// CreateExtension creates a service extension based on the given config.
-	CreateExtension(ctx context.Context, params ExtensionCreateParams, cfg config.Extension) (Extension, error)
+	CreateExtension(ctx context.Context, set ExtensionCreateSettings, cfg config.Extension) (Extension, error)
 }
diff --git a/config/configcheck/configcheck_test.go b/config/configcheck/configcheck_test.go
@@ -198,6 +198,6 @@ func (b badConfigExtensionFactory) CreateDefaultConfig() config.Extension {
 	}{}
 }
 
-func (b badConfigExtensionFactory) CreateExtension(_ context.Context, _ component.ExtensionCreateParams, _ config.Extension) (component.Extension, error) {
+func (b badConfigExtensionFactory) CreateExtension(_ context.Context, _ component.ExtensionCreateSettings, _ config.Extension) (component.Extension, error) {
 	return nil, nil
 }
diff --git a/extension/ballastextension/factory.go b/extension/ballastextension/factory.go
@@ -41,6 +41,6 @@ func createDefaultConfig() config.Extension {
 	}
 }
 
-func createExtension(_ context.Context, params component.ExtensionCreateParams, cfg config.Extension) (component.Extension, error) {
-	return newMemoryBallast(cfg.(*Config), params.Logger), nil
+func createExtension(_ context.Context, set component.ExtensionCreateSettings, cfg config.Extension) (component.Extension, error) {
+	return newMemoryBallast(cfg.(*Config), set.Logger), nil
 }
diff --git a/extension/ballastextension/factory_test.go b/extension/ballastextension/factory_test.go
@@ -32,14 +32,14 @@ func TestFactory_CreateDefaultConfig(t *testing.T) {
 	assert.Equal(t, &Config{ExtensionSettings: config.NewExtensionSettings(config.NewID(typeStr))}, cfg)
 
 	assert.NoError(t, configcheck.ValidateConfig(cfg))
-	ext, err := createExtension(context.Background(), component.ExtensionCreateParams{Logger: zap.NewNop()}, cfg)
+	ext, err := createExtension(context.Background(), component.ExtensionCreateSettings{Logger: zap.NewNop()}, cfg)
 	require.NoError(t, err)
 	require.NotNil(t, ext)
 }
 
 func TestFactory_CreateExtension(t *testing.T) {
 	cfg := createDefaultConfig().(*Config)
-	ext, err := createExtension(context.Background(), component.ExtensionCreateParams{Logger: zap.NewNop()}, cfg)
+	ext, err := createExtension(context.Background(), component.ExtensionCreateSettings{Logger: zap.NewNop()}, cfg)
 	require.NoError(t, err)
 	require.NotNil(t, ext)
 }
diff --git a/extension/extensionhelper/factory.go b/extension/extensionhelper/factory.go
@@ -28,7 +28,7 @@ type FactoryOption func(o *factory)
 type CreateDefaultConfig func() config.Extension
 
 // CreateServiceExtension is the equivalent of component.ExtensionFactory.CreateExtension()
-type CreateServiceExtension func(context.Context, component.ExtensionCreateParams, config.Extension) (component.Extension, error)
+type CreateServiceExtension func(context.Context, component.ExtensionCreateSettings, config.Extension) (component.Extension, error)
 
 type factory struct {
 	cfgType                config.Type
@@ -66,7 +66,7 @@ func (f *factory) CreateDefaultConfig() config.Extension {
 // CreateExtension creates a component.TraceExtension based on this config.
 func (f *factory) CreateExtension(
 	ctx context.Context,
-	params component.ExtensionCreateParams,
+	set component.ExtensionCreateSettings,
 	cfg config.Extension) (component.Extension, error) {
-	return f.createServiceExtension(ctx, params, cfg)
+	return f.createServiceExtension(ctx, set, cfg)
 }
diff --git a/extension/extensionhelper/factory_test.go b/extension/extensionhelper/factory_test.go
@@ -38,7 +38,7 @@ func TestNewFactory(t *testing.T) {
 		createExtension)
 	assert.EqualValues(t, typeStr, factory.Type())
 	assert.EqualValues(t, &defaultCfg, factory.CreateDefaultConfig())
-	ext, err := factory.CreateExtension(context.Background(), component.ExtensionCreateParams{}, &defaultCfg)
+	ext, err := factory.CreateExtension(context.Background(), component.ExtensionCreateSettings{}, &defaultCfg)
 	assert.NoError(t, err)
 	assert.Same(t, nopExtensionInstance, ext)
 }
@@ -47,7 +47,7 @@ func defaultConfig() config.Extension {
 	return &defaultCfg
 }
 
-func createExtension(context.Context, component.ExtensionCreateParams, config.Extension) (component.Extension, error) {
+func createExtension(context.Context, component.ExtensionCreateSettings, config.Extension) (component.Extension, error) {
 	return nopExtensionInstance, nil
 }
 
diff --git a/extension/healthcheckextension/factory.go b/extension/healthcheckextension/factory.go
@@ -49,8 +49,8 @@ func createDefaultConfig() config.Extension {
 	}
 }
 
-func createExtension(_ context.Context, params component.ExtensionCreateParams, cfg config.Extension) (component.Extension, error) {
+func createExtension(_ context.Context, set component.ExtensionCreateSettings, cfg config.Extension) (component.Extension, error) {
 	config := cfg.(*Config)
 
-	return newServer(*config, params.Logger), nil
+	return newServer(*config, set.Logger), nil
 }
diff --git a/extension/healthcheckextension/factory_test.go b/extension/healthcheckextension/factory_test.go
@@ -39,7 +39,7 @@ func TestFactory_CreateDefaultConfig(t *testing.T) {
 	}, cfg)
 
 	assert.NoError(t, configcheck.ValidateConfig(cfg))
-	ext, err := createExtension(context.Background(), component.ExtensionCreateParams{Logger: zap.NewNop()}, cfg)
+	ext, err := createExtension(context.Background(), component.ExtensionCreateSettings{Logger: zap.NewNop()}, cfg)
 	require.NoError(t, err)
 	require.NotNil(t, ext)
 }
@@ -48,7 +48,7 @@ func TestFactory_CreateExtension(t *testing.T) {
 	cfg := createDefaultConfig().(*Config)
 	cfg.TCPAddr.Endpoint = testutil.GetAvailableLocalAddress(t)
 
-	ext, err := createExtension(context.Background(), component.ExtensionCreateParams{Logger: zap.NewNop()}, cfg)
+	ext, err := createExtension(context.Background(), component.ExtensionCreateSettings{Logger: zap.NewNop()}, cfg)
 	require.NoError(t, err)
 	require.NotNil(t, ext)
 }
diff --git a/extension/oidcauthextension/factory.go b/extension/oidcauthextension/factory.go
@@ -44,6 +44,6 @@ func createDefaultConfig() config.Extension {
 	}
 }
 
-func createExtension(_ context.Context, params component.ExtensionCreateParams, cfg config.Extension) (component.Extension, error) {
-	return newExtension(cfg.(*Config), params.Logger)
+func createExtension(_ context.Context, set component.ExtensionCreateSettings, cfg config.Extension) (component.Extension, error) {
+	return newExtension(cfg.(*Config), set.Logger)
 }
diff --git a/extension/oidcauthextension/factory_test.go b/extension/oidcauthextension/factory_test.go
@@ -46,7 +46,7 @@ func TestCreateExtension(t *testing.T) {
 	cfg.Audience = "collector"
 	cfg.IssuerURL = "https://auth.example.com"
 
-	ext, err := createExtension(context.Background(), component.ExtensionCreateParams{Logger: zap.NewNop()}, cfg)
+	ext, err := createExtension(context.Background(), component.ExtensionCreateSettings{Logger: zap.NewNop()}, cfg)
 	assert.NoError(t, err)
 	assert.NotNil(t, ext)
 }
diff --git a/extension/pprofextension/factory.go b/extension/pprofextension/factory.go
@@ -48,11 +48,11 @@ func createDefaultConfig() config.Extension {
 	}
 }
 
-func createExtension(_ context.Context, params component.ExtensionCreateParams, cfg config.Extension) (component.Extension, error) {
+func createExtension(_ context.Context, set component.ExtensionCreateSettings, cfg config.Extension) (component.Extension, error) {
 	config := cfg.(*Config)
 	if config.TCPAddr.Endpoint == "" {
 		return nil, errors.New("\"endpoint\" is required when using the \"pprof\" extension")
 	}
 
-	return newServer(*config, params.Logger), nil
+	return newServer(*config, set.Logger), nil
 }
diff --git a/extension/pprofextension/factory_test.go b/extension/pprofextension/factory_test.go
@@ -38,7 +38,7 @@ func TestFactory_CreateDefaultConfig(t *testing.T) {
 		cfg)
 
 	assert.NoError(t, configcheck.ValidateConfig(cfg))
-	ext, err := createExtension(context.Background(), component.ExtensionCreateParams{Logger: zap.NewNop()}, cfg)
+	ext, err := createExtension(context.Background(), component.ExtensionCreateSettings{Logger: zap.NewNop()}, cfg)
 	require.NoError(t, err)
 	require.NotNil(t, ext)
 }
@@ -47,7 +47,7 @@ func TestFactory_CreateExtension(t *testing.T) {
 	cfg := createDefaultConfig().(*Config)
 	cfg.TCPAddr.Endpoint = testutil.GetAvailableLocalAddress(t)
 
-	ext, err := createExtension(context.Background(), component.ExtensionCreateParams{Logger: zap.NewNop()}, cfg)
+	ext, err := createExtension(context.Background(), component.ExtensionCreateSettings{Logger: zap.NewNop()}, cfg)
 	require.NoError(t, err)
 	require.NotNil(t, ext)
 }
diff --git a/extension/zpagesextension/factory.go b/extension/zpagesextension/factory.go
@@ -49,11 +49,11 @@ func createDefaultConfig() config.Extension {
 }
 
 // createExtension creates the extension based on this config.
-func createExtension(_ context.Context, params component.ExtensionCreateParams, cfg config.Extension) (component.Extension, error) {
+func createExtension(_ context.Context, set component.ExtensionCreateSettings, cfg config.Extension) (component.Extension, error) {
 	config := cfg.(*Config)
 	if config.TCPAddr.Endpoint == "" {
 		return nil, errors.New("\"endpoint\" is required when using the \"zpages\" extension")
 	}
 
-	return newServer(*config, params.Logger), nil
+	return newServer(*config, set.Logger), nil
 }
diff --git a/extension/zpagesextension/factory_test.go b/extension/zpagesextension/factory_test.go
@@ -40,7 +40,7 @@ func TestFactory_CreateDefaultConfig(t *testing.T) {
 		cfg)
 
 	assert.NoError(t, configcheck.ValidateConfig(cfg))
-	ext, err := createExtension(context.Background(), component.ExtensionCreateParams{Logger: zap.NewNop()}, cfg)
+	ext, err := createExtension(context.Background(), component.ExtensionCreateSettings{Logger: zap.NewNop()}, cfg)
 	require.NoError(t, err)
 	require.NotNil(t, ext)
 }
@@ -49,7 +49,7 @@ func TestFactory_CreateExtension(t *testing.T) {
 	cfg := createDefaultConfig().(*Config)
 	cfg.TCPAddr.Endpoint = testutil.GetAvailableLocalAddress(t)
 
-	ext, err := createExtension(context.Background(), component.ExtensionCreateParams{Logger: zap.NewNop()}, cfg)
+	ext, err := createExtension(context.Background(), component.ExtensionCreateSettings{Logger: zap.NewNop()}, cfg)
 	require.NoError(t, err)
 	require.NotNil(t, ext)
 }
diff --git a/internal/testcomponents/example_extension.go b/internal/testcomponents/example_extension.go
@@ -48,6 +48,6 @@ func createExtensionDefaultConfig() config.Extension {
 }
 
 // CreateExtension creates an Extension based on this config.
-func createExtension(context.Context, component.ExtensionCreateParams, config.Extension) (component.Extension, error) {
+func createExtension(context.Context, component.ExtensionCreateSettings, config.Extension) (component.Extension, error) {
 	return componenthelper.New(), nil
 }
diff --git a/service/defaultcomponents/default_extensions_test.go b/service/defaultcomponents/default_extensions_test.go
@@ -95,7 +95,7 @@ type getExtensionConfigFn func() config.Extension
 func verifyExtensionLifecycle(t *testing.T, factory component.ExtensionFactory, getConfigFn getExtensionConfigFn) {
 	ctx := context.Background()
 	host := newAssertNoErrorHost(t)
-	extCreateParams := component.ExtensionCreateParams{
+	extCreateSet := component.ExtensionCreateSettings{
 		Logger:    zap.NewNop(),
 		BuildInfo: component.DefaultBuildInfo(),
 	}
@@ -104,12 +104,12 @@ func verifyExtensionLifecycle(t *testing.T, factory component.ExtensionFactory,
 		getConfigFn = factory.CreateDefaultConfig
 	}
 
-	firstExt, err := factory.CreateExtension(ctx, extCreateParams, getConfigFn())
+	firstExt, err := factory.CreateExtension(ctx, extCreateSet, getConfigFn())
 	require.NoError(t, err)
 	require.NoError(t, firstExt.Start(ctx, host))
 	require.NoError(t, firstExt.Shutdown(ctx))
 
-	secondExt, err := factory.CreateExtension(ctx, extCreateParams, getConfigFn())
+	secondExt, err := factory.CreateExtension(ctx, extCreateSet, getConfigFn())
 	require.NoError(t, err)
 	require.NoError(t, secondExt.Start(ctx, host))
 	require.NoError(t, secondExt.Shutdown(ctx))
diff --git a/service/internal/builder/extensions_builder.go b/service/internal/builder/extensions_builder.go
@@ -156,12 +156,12 @@ func (eb *extensionsBuilder) buildExtension(logger *zap.Logger, buildInfo compon
 		logger: logger,
 	}
 
-	creationParams := component.ExtensionCreateParams{
+	creationSet := component.ExtensionCreateSettings{
 		Logger:    logger,
 		BuildInfo: buildInfo,
 	}
 
-	ex, err := factory.CreateExtension(context.Background(), creationParams, cfg)
+	ex, err := factory.CreateExtension(context.Background(), creationSet, cfg)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create extension %v: %w", cfg.ID(), err)
 	}
diff --git a/service/internal/builder/extensions_builder_test.go b/service/internal/builder/extensions_builder_test.go
@@ -34,7 +34,7 @@ func TestService_setupExtensions(t *testing.T) {
 			cfg := config.NewExtensionSettings(config.NewID("err"))
 			return &cfg
 		},
-		func(ctx context.Context, params component.ExtensionCreateParams, extension config.Extension) (component.Extension, error) {
+		func(ctx context.Context, set component.ExtensionCreateSettings, extension config.Extension) (component.Extension, error) {
 			return nil, fmt.Errorf("cannot create \"err\" extension type")
 		},
 	)
diff --git a/service/internal/builder/factories_test.go b/service/internal/builder/factories_test.go
@@ -96,7 +96,7 @@ func newBadExtensionFactory() component.ExtensionFactory {
 				ExtensionSettings: config.NewExtensionSettings(config.NewID("bf")),
 			}
 		},
-		func(ctx context.Context, params component.ExtensionCreateParams, extension config.Extension) (component.Extension, error) {
+		func(ctx context.Context, set component.ExtensionCreateSettings, extension config.Extension) (component.Extension, error) {
 			return nil, nil
 		},
 	)

Original file line number	Diff line number	Diff line change
`@@ -198,6 +198,6 @@ func (b badConfigExtensionFactory) CreateDefaultConfig() config.Extension {`
`198`	`198`	`}{}`
`199`	`199`	`}`
`200`	`200`
`201`		`-func (b badConfigExtensionFactory) CreateExtension(_ context.Context, _ component.ExtensionCreateParams, _ config.Extension) (component.Extension, error) {`
	`201`	`+func (b badConfigExtensionFactory) CreateExtension(_ context.Context, _ component.ExtensionCreateSettings, _ config.Extension) (component.Extension, error) {`
`202`	`202`	`return nil, nil`
`203`	`203`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,6 @@ func createDefaultConfig() config.Extension {`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`
`44`		`-func createExtension(_ context.Context, params component.ExtensionCreateParams, cfg config.Extension) (component.Extension, error) {`
`45`		`- return newMemoryBallast(cfg.(*Config), params.Logger), nil`
	`44`	`+func createExtension(_ context.Context, set component.ExtensionCreateSettings, cfg config.Extension) (component.Extension, error) {`
	`45`	`+ return newMemoryBallast(cfg.(*Config), set.Logger), nil`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ func TestNewFactory(t *testing.T) {`
`38`	`38`	`createExtension)`
`39`	`39`	`assert.EqualValues(t, typeStr, factory.Type())`
`40`	`40`	`assert.EqualValues(t, &defaultCfg, factory.CreateDefaultConfig())`
`41`		`- ext, err := factory.CreateExtension(context.Background(), component.ExtensionCreateParams{}, &defaultCfg)`
	`41`	`+ ext, err := factory.CreateExtension(context.Background(), component.ExtensionCreateSettings{}, &defaultCfg)`
`42`	`42`	`assert.NoError(t, err)`
`43`	`43`	`assert.Same(t, nopExtensionInstance, ext)`
`44`	`44`	`}`
`@@ -47,7 +47,7 @@ func defaultConfig() config.Extension {`
`47`	`47`	`return &defaultCfg`
`48`	`48`	`}`
`49`	`49`
`50`		`-func createExtension(context.Context, component.ExtensionCreateParams, config.Extension) (component.Extension, error) {`
	`50`	`+func createExtension(context.Context, component.ExtensionCreateSettings, config.Extension) (component.Extension, error) {`
`51`	`51`	`return nopExtensionInstance, nil`
`52`	`52`	`}`
`53`	`53`
Original file line number	Diff line number	Diff line change
`@@ -49,8 +49,8 @@ func createDefaultConfig() config.Extension {`
`49`	`49`	`}`
`50`	`50`	`}`
`51`	`51`
`52`		`-func createExtension(_ context.Context, params component.ExtensionCreateParams, cfg config.Extension) (component.Extension, error) {`
	`52`	`+func createExtension(_ context.Context, set component.ExtensionCreateSettings, cfg config.Extension) (component.Extension, error) {`
`53`	`53`	`config := cfg.(*Config)`
`54`	`54`
`55`		`- return newServer(*config, params.Logger), nil`
	`55`	`+ return newServer(*config, set.Logger), nil`
`56`	`56`	`}`