Make all NewDefault* functions return structs instead of pointers

mx-psi · mx-psi · commit 2e44b9ef402f · 2025-06-06T14:21:22.000+02:00
diff --git a/config/configgrpc/configgrpc.go b/config/configgrpc/configgrpc.go
@@ -52,8 +52,8 @@ type KeepaliveClientConfig struct {
 }
 
 // NewDefaultKeepaliveClientConfig returns a new instance of KeepaliveClientConfig with default values.
-func NewDefaultKeepaliveClientConfig() *KeepaliveClientConfig {
-	return &KeepaliveClientConfig{
+func NewDefaultKeepaliveClientConfig() KeepaliveClientConfig {
+	return KeepaliveClientConfig{
 		Time:    time.Second * 10,
 		Timeout: time.Second * 10,
 	}
@@ -111,11 +111,15 @@ type ClientConfig struct {
 	Middlewares []configmiddleware.Config `mapstructure:"middlewares,omitempty"`
 }
 
+func ptr[T any](v T) *T {
+	return &v
+}
+
 // NewDefaultClientConfig returns a new instance of ClientConfig with default values.
-func NewDefaultClientConfig() *ClientConfig {
-	return &ClientConfig{
+func NewDefaultClientConfig() ClientConfig {
+	return ClientConfig{
 		TLS:          configtls.NewDefaultClientConfig(),
-		Keepalive:    NewDefaultKeepaliveClientConfig(),
+		Keepalive:    ptr(NewDefaultKeepaliveClientConfig()),
 		BalancerName: BalancerName(),
 	}
 }
@@ -129,10 +133,10 @@ type KeepaliveServerConfig struct {
 }
 
 // NewDefaultKeepaliveServerConfig returns a new instance of KeepaliveServerConfig with default values.
-func NewDefaultKeepaliveServerConfig() *KeepaliveServerConfig {
-	return &KeepaliveServerConfig{
-		ServerParameters:  NewDefaultKeepaliveServerParameters(),
-		EnforcementPolicy: NewDefaultKeepaliveEnforcementPolicy(),
+func NewDefaultKeepaliveServerConfig() KeepaliveServerConfig {
+	return KeepaliveServerConfig{
+		ServerParameters:  ptr(NewDefaultKeepaliveServerParameters()),
+		EnforcementPolicy: ptr(NewDefaultKeepaliveEnforcementPolicy()),
 	}
 }
 
@@ -150,8 +154,8 @@ type KeepaliveServerParameters struct {
 }
 
 // NewDefaultKeepaliveServerParameters creates and returns a new instance of KeepaliveServerParameters with default settings.
-func NewDefaultKeepaliveServerParameters() *KeepaliveServerParameters {
-	return &KeepaliveServerParameters{}
+func NewDefaultKeepaliveServerParameters() KeepaliveServerParameters {
+	return KeepaliveServerParameters{}
 }
 
 // KeepaliveEnforcementPolicy allow configuration of the keepalive.EnforcementPolicy.
@@ -165,8 +169,8 @@ type KeepaliveEnforcementPolicy struct {
 }
 
 // NewDefaultKeepaliveEnforcementPolicy creates and returns a new instance of KeepaliveEnforcementPolicy with default settings.
-func NewDefaultKeepaliveEnforcementPolicy() *KeepaliveEnforcementPolicy {
-	return &KeepaliveEnforcementPolicy{}
+func NewDefaultKeepaliveEnforcementPolicy() KeepaliveEnforcementPolicy {
+	return KeepaliveEnforcementPolicy{}
 }
 
 // ServerConfig defines common settings for a gRPC server configuration.
@@ -210,9 +214,9 @@ type ServerConfig struct {
 }
 
 // NewDefaultServerConfig returns a new instance of ServerConfig with default values.
-func NewDefaultServerConfig() *ServerConfig {
-	return &ServerConfig{
-		Keepalive: NewDefaultKeepaliveServerConfig(),
+func NewDefaultServerConfig() ServerConfig {
+	return ServerConfig{
+		Keepalive: ptr(NewDefaultKeepaliveServerConfig()),
 	}
 }
 
diff --git a/config/configgrpc/configgrpc_test.go b/config/configgrpc/configgrpc_test.go
@@ -60,9 +60,10 @@ func TestNewDefaultKeepaliveClientConfig(t *testing.T) {
 }
 
 func TestNewDefaultClientConfig(t *testing.T) {
+	keepalive := NewDefaultKeepaliveClientConfig()
 	expected := &ClientConfig{
 		TLS:          configtls.NewDefaultClientConfig(),
-		Keepalive:    NewDefaultKeepaliveClientConfig(),
+		Keepalive:    &keepalive,
 		BalancerName: BalancerName(),
 	}
 
@@ -87,17 +88,20 @@ func TestNewDefaultKeepaliveEnforcementPolicy(t *testing.T) {
 }
 
 func TestNewDefaultKeepaliveServerConfig(t *testing.T) {
+	serverParameters := NewDefaultKeepaliveServerParameters()
+	enforcementPolicy := NewDefaultKeepaliveEnforcementPolicy()
 	expected := &KeepaliveServerConfig{
-		ServerParameters:  NewDefaultKeepaliveServerParameters(),
-		EnforcementPolicy: NewDefaultKeepaliveEnforcementPolicy(),
+		ServerParameters:  &serverParameters,
+		EnforcementPolicy: &enforcementPolicy,
 	}
 	result := NewDefaultKeepaliveServerConfig()
 	assert.Equal(t, expected, result)
 }
 
 func TestNewDefaultServerConfig(t *testing.T) {
+	keepalive := NewDefaultKeepaliveServerConfig()
 	expected := &ServerConfig{
-		Keepalive: NewDefaultKeepaliveServerConfig(),
+		Keepalive: &keepalive,
 	}
 
 	result := NewDefaultServerConfig()
diff --git a/config/confighttp/confighttp.go b/config/confighttp/confighttp.go
@@ -373,12 +373,16 @@ type ServerConfig struct {
 	Middlewares []configmiddleware.Config `mapstructure:"middleware,omitempty"`
 }
 
+func ptr[T any](v T) *T {
+	return &v
+}
+
 // NewDefaultServerConfig returns ServerConfig type object with default values.
 // We encourage to use this function to create an object of ServerConfig.
 func NewDefaultServerConfig() ServerConfig {
 	return ServerConfig{
 		ResponseHeaders:   map[string]configopaque.String{},
-		CORS:              NewDefaultCORSConfig(),
+		CORS:              ptr(NewDefaultCORSConfig()),
 		WriteTimeout:      30 * time.Second,
 		ReadHeaderTimeout: 1 * time.Minute,
 		IdleTimeout:       1 * time.Minute,
@@ -594,8 +598,8 @@ type CORSConfig struct {
 }
 
 // NewDefaultCORSConfig creates a default cross-origin resource sharing (CORS) configuration.
-func NewDefaultCORSConfig() *CORSConfig {
-	return &CORSConfig{}
+func NewDefaultCORSConfig() CORSConfig {
+	return CORSConfig{}
 }
 
 func authInterceptor(next http.Handler, server extensionauth.Server, requestParams []string, serverOpts *internal.ToServerOptions) http.Handler {
diff --git a/config/confighttp/confighttp_test.go b/config/confighttp/confighttp_test.go
@@ -740,7 +740,7 @@ func TestHttpCors(t *testing.T) {
 		},
 		{
 			name:             "emptyCORS",
-			CORSConfig:       NewDefaultCORSConfig(),
+			CORSConfig:       ptr(NewDefaultCORSConfig()),
 			allowedWorks:     false,
 			disallowedWorks:  false,
 			extraHeaderWorks: false,
diff --git a/exporter/otlpexporter/factory.go b/exporter/otlpexporter/factory.go
@@ -31,7 +31,7 @@ func NewFactory() exporter.Factory {
 }
 
 func createDefaultConfig() component.Config {
-	clientCfg := *configgrpc.NewDefaultClientConfig()
+	clientCfg := configgrpc.NewDefaultClientConfig()
 	// Default to gzip compression
 	clientCfg.Compression = configcompression.TypeGzip
 	// We almost read 0 bytes, so no need to tune ReadBufferSize.
diff --git a/receiver/otlpreceiver/config_test.go b/receiver/otlpreceiver/config_test.go
@@ -163,6 +163,10 @@ func TestUnmarshalConfig(t *testing.T) {
 		}, cfg)
 }
 
+func ptr[T any](v T) *T {
+	return &v
+}
+
 func TestUnmarshalConfigUnix(t *testing.T) {
 	cm, err := confmaptest.LoadConf(filepath.Join("testdata", "uds.yaml"))
 	require.NoError(t, err)
@@ -178,12 +182,12 @@ func TestUnmarshalConfigUnix(t *testing.T) {
 						Transport: confignet.TransportTypeUnix,
 					},
 					ReadBufferSize: 512 * 1024,
-					Keepalive:      configgrpc.NewDefaultKeepaliveServerConfig(),
+					Keepalive:      ptr(configgrpc.NewDefaultKeepaliveServerConfig()),
 				}),
 				HTTP: configoptional.Some(HTTPConfig{
 					ServerConfig: confighttp.ServerConfig{
 						Endpoint:        "/tmp/http_otlp.sock",
-						CORS:            confighttp.NewDefaultCORSConfig(),
+						CORS:            ptr(confighttp.NewDefaultCORSConfig()),
 						ResponseHeaders: map[string]configopaque.String{},
 					},
 					TracesURLPath:  defaultTracesURLPath,
diff --git a/receiver/otlpreceiver/factory.go b/receiver/otlpreceiver/factory.go
@@ -57,7 +57,7 @@ func createDefaultConfig() component.Config {
 
 	return &Config{
 		Protocols: Protocols{
-			GRPC: configoptional.Default(*grpcCfg),
+			GRPC: configoptional.Default(grpcCfg),
 			HTTP: configoptional.Default(HTTPConfig{
 				ServerConfig:   httpCfg,
 				TracesURLPath:  defaultTracesURLPath,

Original file line number	Diff line number	Diff line change
`@@ -52,8 +52,8 @@ type KeepaliveClientConfig struct {`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`// NewDefaultKeepaliveClientConfig returns a new instance of KeepaliveClientConfig with default values.`
`55`		`-func NewDefaultKeepaliveClientConfig() *KeepaliveClientConfig {`
`56`		`- return &KeepaliveClientConfig{`
	`55`	`+func NewDefaultKeepaliveClientConfig() KeepaliveClientConfig {`
	`56`	`+ return KeepaliveClientConfig{`
`57`	`57`	`Time: time.Second * 10,`
`58`	`58`	`Timeout: time.Second * 10,`
`59`	`59`	`}`
`@@ -111,11 +111,15 @@ type ClientConfig struct {`
`111`	`111`	Middlewares []configmiddleware.Config `mapstructure:"middlewares,omitempty"`
`112`	`112`	`}`
`113`	`113`
	`114`	`+func ptr[T any](v T) *T {`
	`115`	`+ return &v`
	`116`	`+}`
	`117`	`+`
`114`	`118`	`// NewDefaultClientConfig returns a new instance of ClientConfig with default values.`
`115`		`-func NewDefaultClientConfig() *ClientConfig {`
`116`		`- return &ClientConfig{`
	`119`	`+func NewDefaultClientConfig() ClientConfig {`
	`120`	`+ return ClientConfig{`
`117`	`121`	`TLS: configtls.NewDefaultClientConfig(),`
`118`		`- Keepalive: NewDefaultKeepaliveClientConfig(),`
	`122`	`+ Keepalive: ptr(NewDefaultKeepaliveClientConfig()),`
`119`	`123`	`BalancerName: BalancerName(),`
`120`	`124`	`}`
`121`	`125`	`}`
`@@ -129,10 +133,10 @@ type KeepaliveServerConfig struct {`
`129`	`133`	`}`
`130`	`134`
`131`	`135`	`// NewDefaultKeepaliveServerConfig returns a new instance of KeepaliveServerConfig with default values.`
`132`		`-func NewDefaultKeepaliveServerConfig() *KeepaliveServerConfig {`
`133`		`- return &KeepaliveServerConfig{`
`134`		`- ServerParameters: NewDefaultKeepaliveServerParameters(),`
`135`		`- EnforcementPolicy: NewDefaultKeepaliveEnforcementPolicy(),`
	`136`	`+func NewDefaultKeepaliveServerConfig() KeepaliveServerConfig {`
	`137`	`+ return KeepaliveServerConfig{`
	`138`	`+ ServerParameters: ptr(NewDefaultKeepaliveServerParameters()),`
	`139`	`+ EnforcementPolicy: ptr(NewDefaultKeepaliveEnforcementPolicy()),`
`136`	`140`	`}`
`137`	`141`	`}`
`138`	`142`
`@@ -150,8 +154,8 @@ type KeepaliveServerParameters struct {`
`150`	`154`	`}`
`151`	`155`
`152`	`156`	`// NewDefaultKeepaliveServerParameters creates and returns a new instance of KeepaliveServerParameters with default settings.`
`153`		`-func NewDefaultKeepaliveServerParameters() *KeepaliveServerParameters {`
`154`		`- return &KeepaliveServerParameters{}`
	`157`	`+func NewDefaultKeepaliveServerParameters() KeepaliveServerParameters {`
	`158`	`+ return KeepaliveServerParameters{}`
`155`	`159`	`}`
`156`	`160`
`157`	`161`	`// KeepaliveEnforcementPolicy allow configuration of the keepalive.EnforcementPolicy.`
`@@ -165,8 +169,8 @@ type KeepaliveEnforcementPolicy struct {`
`165`	`169`	`}`
`166`	`170`
`167`	`171`	`// NewDefaultKeepaliveEnforcementPolicy creates and returns a new instance of KeepaliveEnforcementPolicy with default settings.`
`168`		`-func NewDefaultKeepaliveEnforcementPolicy() *KeepaliveEnforcementPolicy {`
`169`		`- return &KeepaliveEnforcementPolicy{}`
	`172`	`+func NewDefaultKeepaliveEnforcementPolicy() KeepaliveEnforcementPolicy {`
	`173`	`+ return KeepaliveEnforcementPolicy{}`
`170`	`174`	`}`
`171`	`175`
`172`	`176`	`// ServerConfig defines common settings for a gRPC server configuration.`
`@@ -210,9 +214,9 @@ type ServerConfig struct {`
`210`	`214`	`}`
`211`	`215`
`212`	`216`	`// NewDefaultServerConfig returns a new instance of ServerConfig with default values.`
`213`		`-func NewDefaultServerConfig() *ServerConfig {`
`214`		`- return &ServerConfig{`
`215`		`- Keepalive: NewDefaultKeepaliveServerConfig(),`
	`217`	`+func NewDefaultServerConfig() ServerConfig {`
	`218`	`+ return ServerConfig{`
	`219`	`+ Keepalive: ptr(NewDefaultKeepaliveServerConfig()),`
`216`	`220`	`}`
`217`	`221`	`}`
`218`	`222`
Original file line number	Diff line number	Diff line change
`@@ -60,9 +60,10 @@ func TestNewDefaultKeepaliveClientConfig(t *testing.T) {`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`func TestNewDefaultClientConfig(t *testing.T) {`
	`63`	`+ keepalive := NewDefaultKeepaliveClientConfig()`
`63`	`64`	`expected := &ClientConfig{`
`64`	`65`	`TLS: configtls.NewDefaultClientConfig(),`
`65`		`- Keepalive: NewDefaultKeepaliveClientConfig(),`
	`66`	`+ Keepalive: &keepalive,`
`66`	`67`	`BalancerName: BalancerName(),`
`67`	`68`	`}`
`68`	`69`
`@@ -87,17 +88,20 @@ func TestNewDefaultKeepaliveEnforcementPolicy(t *testing.T) {`
`87`	`88`	`}`
`88`	`89`
`89`	`90`	`func TestNewDefaultKeepaliveServerConfig(t *testing.T) {`
	`91`	`+ serverParameters := NewDefaultKeepaliveServerParameters()`
	`92`	`+ enforcementPolicy := NewDefaultKeepaliveEnforcementPolicy()`
`90`	`93`	`expected := &KeepaliveServerConfig{`
`91`		`- ServerParameters: NewDefaultKeepaliveServerParameters(),`
`92`		`- EnforcementPolicy: NewDefaultKeepaliveEnforcementPolicy(),`
	`94`	`+ ServerParameters: &serverParameters,`
	`95`	`+ EnforcementPolicy: &enforcementPolicy,`
`93`	`96`	`}`
`94`	`97`	`result := NewDefaultKeepaliveServerConfig()`
`95`	`98`	`assert.Equal(t, expected, result)`
`96`	`99`	`}`
`97`	`100`
`98`	`101`	`func TestNewDefaultServerConfig(t *testing.T) {`
	`102`	`+ keepalive := NewDefaultKeepaliveServerConfig()`
`99`	`103`	`expected := &ServerConfig{`
`100`		`- Keepalive: NewDefaultKeepaliveServerConfig(),`
	`104`	`+ Keepalive: &keepalive,`
`101`	`105`	`}`
`102`	`106`
`103`	`107`	`result := NewDefaultServerConfig()`
Original file line number	Diff line number	Diff line change
`@@ -740,7 +740,7 @@ func TestHttpCors(t *testing.T) {`
`740`	`740`	`},`
`741`	`741`	`{`
`742`	`742`	`name: "emptyCORS",`
`743`		`- CORSConfig: NewDefaultCORSConfig(),`
	`743`	`+ CORSConfig: ptr(NewDefaultCORSConfig()),`
`744`	`744`	`allowedWorks: false,`
`745`	`745`	`disallowedWorks: false,`
`746`	`746`	`extraHeaderWorks: false,`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ func NewFactory() exporter.Factory {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`func createDefaultConfig() component.Config {`
`34`		`- clientCfg := *configgrpc.NewDefaultClientConfig()`
	`34`	`+ clientCfg := configgrpc.NewDefaultClientConfig()`
`35`	`35`	`// Default to gzip compression`
`36`	`36`	`clientCfg.Compression = configcompression.TypeGzip`
`37`	`37`	`// We almost read 0 bytes, so no need to tune ReadBufferSize.`