fix(pprof): settings rates can be nil

internal/configuration/sources/env/pprof.go

@@ -12,12 +12,12 @@ func readPprof() (settings pprof.Settings, err error) {
 		return settings, fmt.Errorf("environment variable PPROF_ENABLED: %w", err)
 	}
 
-	settings.BlockProfileRate, err = envToInt("PPROF_BLOCK_PROFILE_RATE")
+	settings.BlockProfileRate, err = envToIntPtr("PPROF_BLOCK_PROFILE_RATE")
 	if err != nil {
 		return settings, fmt.Errorf("environment variable PPROF_BLOCK_PROFILE_RATE: %w", err)
 	}
 
-	settings.MutexProfileRate, err = envToInt("PPROF_MUTEX_PROFILE_RATE")
+	settings.MutexProfileRate, err = envToIntPtr("PPROF_MUTEX_PROFILE_RATE")
 	if err != nil {
 		return settings, fmt.Errorf("environment variable PPROF_MUTEX_PROFILE_RATE: %w", err)
 	}

internal/pprof/helpers_test.go

@@ -8,6 +8,8 @@ import (
 
 func boolPtr(b bool) *bool { return &b }
 
+func intPtr(n int) *int { return &n }
+
 var _ gomock.Matcher = (*regexMatcher)(nil)
 
 type regexMatcher struct {

internal/pprof/server.go

@@ -13,8 +13,8 @@ import (
 // with the settings given. It returns an error
 // if one of the settings is not valid.
 func New(settings Settings) (server *httpserver.Server, err error) {
-	runtime.SetBlockProfileRate(settings.BlockProfileRate)
-	runtime.SetMutexProfileFraction(settings.MutexProfileRate)
+	runtime.SetBlockProfileRate(*settings.BlockProfileRate)
+	runtime.SetMutexProfileFraction(*settings.MutexProfileRate)
 
 	handler := http.NewServeMux()
 	handler.HandleFunc("/debug/pprof/", pprof.Index)

internal/pprof/server_test.go

@@ -26,6 +26,8 @@ func Test_Server(t *testing.T) {
 
 	const httpServerShutdownTimeout = 10 * time.Second // 10s in case test worker is slow
 	settings := Settings{
+		BlockProfileRate: intPtr(0),
+		MutexProfileRate: intPtr(0),
 		HTTPServer: httpserver.Settings{
 			Address:         address,
 			Logger:          logger,
@@ -112,7 +114,8 @@ func Test_Server_BadSettings(t *testing.T) {
 	t.Parallel()
 
 	settings := Settings{
-		BlockProfileRate: -1,
+		BlockProfileRate: intPtr(-1),
+		MutexProfileRate: intPtr(0),
 	}
 
 	server, err := New(settings)

internal/pprof/settings.go

@@ -16,10 +16,10 @@ type Settings struct {
 	Enabled *bool
 	// See runtime.SetBlockProfileRate
 	// Set to 0 to disable profiling.
-	BlockProfileRate int
+	BlockProfileRate *int
 	// See runtime.SetMutexProfileFraction
 	// Set to 0 to disable profiling.
-	MutexProfileRate int
+	MutexProfileRate *int
 	// HTTPServer contains settings to configure
 	// the HTTP server serving pprof data.
 	HTTPServer httpserver.Settings
@@ -44,15 +44,15 @@ func (s Settings) Copy() (copied Settings) {
 
 func (s *Settings) MergeWith(other Settings) {
 	s.Enabled = helpers.MergeWithBool(s.Enabled, other.Enabled)
-	s.BlockProfileRate = helpers.MergeWithInt(s.BlockProfileRate, other.BlockProfileRate)
-	s.MutexProfileRate = helpers.MergeWithInt(s.MutexProfileRate, other.MutexProfileRate)
+	s.BlockProfileRate = helpers.MergeWithIntPtr(s.BlockProfileRate, other.BlockProfileRate)
+	s.MutexProfileRate = helpers.MergeWithIntPtr(s.MutexProfileRate, other.MutexProfileRate)
 	s.HTTPServer.MergeWith(other.HTTPServer)
 }
 
 func (s *Settings) OverrideWith(other Settings) {
 	s.Enabled = helpers.OverrideWithBool(s.Enabled, other.Enabled)
-	s.BlockProfileRate = helpers.OverrideWithInt(s.BlockProfileRate, other.BlockProfileRate)
-	s.MutexProfileRate = helpers.OverrideWithInt(s.MutexProfileRate, other.MutexProfileRate)
+	s.BlockProfileRate = helpers.OverrideWithIntPtr(s.BlockProfileRate, other.BlockProfileRate)
+	s.MutexProfileRate = helpers.OverrideWithIntPtr(s.MutexProfileRate, other.MutexProfileRate)
 	s.HTTPServer.OverrideWith(other.HTTPServer)
 }
 
@@ -62,11 +62,11 @@ var (
 )
 
 func (s Settings) Validate() (err error) {
-	if s.BlockProfileRate < 0 {
+	if *s.BlockProfileRate < 0 {
 		return ErrBlockProfileRateNegative
 	}
 
-	if s.MutexProfileRate < 0 {
+	if *s.MutexProfileRate < 0 {
 		return ErrMutexProfileRateNegative
 	}
 
@@ -80,12 +80,12 @@ func (s Settings) ToLinesNode() (node *gotree.Node) {
 
 	node = gotree.New("Pprof settings:")
 
-	if s.BlockProfileRate > 0 {
-		node.Appendf("Block profile rate: %d", s.BlockProfileRate)
+	if *s.BlockProfileRate > 0 {
+		node.Appendf("Block profile rate: %d", *s.BlockProfileRate)
 	}
 
-	if s.MutexProfileRate > 0 {
-		node.Appendf("Mutex profile rate: %d", s.MutexProfileRate)
+	if *s.MutexProfileRate > 0 {
+		node.Appendf("Mutex profile rate: %d", *s.MutexProfileRate)
 	}
 
 	node.AppendNode(s.HTTPServer.ToLinesNode())

internal/pprof/settings_test.go

@@ -31,8 +31,8 @@ func Test_Settings_SetDefaults(t *testing.T) {
 		"non empty settings": {
 			initial: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 1,
-				MutexProfileRate: 1,
+				BlockProfileRate: intPtr(1),
+				MutexProfileRate: intPtr(1),
 				HTTPServer: httpserver.Settings{
 					Address:           ":6061",
 					ReadHeaderTimeout: time.Second,
@@ -42,8 +42,8 @@ func Test_Settings_SetDefaults(t *testing.T) {
 			},
 			expected: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 1,
-				MutexProfileRate: 1,
+				BlockProfileRate: intPtr(1),
+				MutexProfileRate: intPtr(1),
 				HTTPServer: httpserver.Settings{
 					Address:           ":6061",
 					ReadHeaderTimeout: time.Second,
@@ -77,8 +77,8 @@ func Test_Settings_Copy(t *testing.T) {
 		"non empty settings": {
 			initial: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 1,
-				MutexProfileRate: 1,
+				BlockProfileRate: intPtr(1),
+				MutexProfileRate: intPtr(1),
 				HTTPServer: httpserver.Settings{
 					Address:         ":6061",
 					ShutdownTimeout: time.Second,
@@ -86,8 +86,8 @@ func Test_Settings_Copy(t *testing.T) {
 			},
 			expected: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 1,
-				MutexProfileRate: 1,
+				BlockProfileRate: intPtr(1),
+				MutexProfileRate: intPtr(1),
 				HTTPServer: httpserver.Settings{
 					Address:         ":6061",
 					ShutdownTimeout: time.Second,
@@ -120,16 +120,16 @@ func Test_Settings_MergeWith(t *testing.T) {
 		"merge empty with filled": {
 			other: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 1,
-				MutexProfileRate: 1,
+				BlockProfileRate: intPtr(1),
+				MutexProfileRate: intPtr(1),
 				HTTPServer: httpserver.Settings{
 					Address: ":8001",
 				},
 			},
 			expected: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 1,
-				MutexProfileRate: 1,
+				BlockProfileRate: intPtr(1),
+				MutexProfileRate: intPtr(1),
 				HTTPServer: httpserver.Settings{
 					Address: ":8001",
 				},
@@ -138,16 +138,16 @@ func Test_Settings_MergeWith(t *testing.T) {
 		"merge filled with empty": {
 			settings: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 1,
-				MutexProfileRate: 1,
+				BlockProfileRate: intPtr(1),
+				MutexProfileRate: intPtr(1),
 				HTTPServer: httpserver.Settings{
 					Address: ":8001",
 				},
 			},
 			expected: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 1,
-				MutexProfileRate: 1,
+				BlockProfileRate: intPtr(1),
+				MutexProfileRate: intPtr(1),
 				HTTPServer: httpserver.Settings{
 					Address: ":8001",
 				},
@@ -179,16 +179,16 @@ func Test_Settings_OverrideWith(t *testing.T) {
 		"override empty with filled": {
 			other: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 1,
-				MutexProfileRate: 1,
+				BlockProfileRate: intPtr(1),
+				MutexProfileRate: intPtr(1),
 				HTTPServer: httpserver.Settings{
 					Address: ":8001",
 				},
 			},
 			expected: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 1,
-				MutexProfileRate: 1,
+				BlockProfileRate: intPtr(1),
+				MutexProfileRate: intPtr(1),
 				HTTPServer: httpserver.Settings{
 					Address: ":8001",
 				},
@@ -197,16 +197,16 @@ func Test_Settings_OverrideWith(t *testing.T) {
 		"override filled with empty": {
 			settings: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 1,
-				MutexProfileRate: 1,
+				BlockProfileRate: intPtr(1),
+				MutexProfileRate: intPtr(1),
 				HTTPServer: httpserver.Settings{
 					Address: ":8001",
 				},
 			},
 			expected: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 1,
-				MutexProfileRate: 1,
+				BlockProfileRate: intPtr(1),
+				MutexProfileRate: intPtr(1),
 				HTTPServer: httpserver.Settings{
 					Address: ":8001",
 				},
@@ -215,24 +215,24 @@ func Test_Settings_OverrideWith(t *testing.T) {
 		"override filled with filled": {
 			settings: Settings{
 				Enabled:          boolPtr(false),
-				BlockProfileRate: 1,
-				MutexProfileRate: 1,
+				BlockProfileRate: intPtr(1),
+				MutexProfileRate: intPtr(1),
 				HTTPServer: httpserver.Settings{
 					Address: ":8001",
 				},
 			},
 			other: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 2,
-				MutexProfileRate: 3,
+				BlockProfileRate: intPtr(2),
+				MutexProfileRate: intPtr(3),
 				HTTPServer: httpserver.Settings{
 					Address: ":8002",
 				},
 			},
 			expected: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 2,
-				MutexProfileRate: 3,
+				BlockProfileRate: intPtr(2),
+				MutexProfileRate: intPtr(3),
 				HTTPServer: httpserver.Settings{
 					Address: ":8002",
 				},
@@ -262,20 +262,24 @@ func Test_Settings_Validate(t *testing.T) {
 	}{
 		"negative block profile rate": {
 			settings: Settings{
-				BlockProfileRate: -1,
+				BlockProfileRate: intPtr(-1),
+				MutexProfileRate: intPtr(0),
 			},
 			errWrapped: ErrBlockProfileRateNegative,
 			errMessage: ErrBlockProfileRateNegative.Error(),
 		},
 		"negative mutex profile rate": {
 			settings: Settings{
-				MutexProfileRate: -1,
+				BlockProfileRate: intPtr(0),
+				MutexProfileRate: intPtr(-1),
 			},
 			errWrapped: ErrMutexProfileRateNegative,
 			errMessage: ErrMutexProfileRateNegative.Error(),
 		},
 		"http server validation error": {
 			settings: Settings{
+				BlockProfileRate: intPtr(0),
+				MutexProfileRate: intPtr(0),
 				HTTPServer:       httpserver.Settings{},
 			},
 			errWrapped: address.ErrValueNotValid,
@@ -283,6 +287,8 @@ func Test_Settings_Validate(t *testing.T) {
 		},
 		"valid settings": {
 			settings: Settings{
+				BlockProfileRate: intPtr(0),
+				MutexProfileRate: intPtr(0),
 				HTTPServer: httpserver.Settings{
 					Address:           ":8000",
 					Handler:           http.NewServeMux(),
@@ -325,8 +331,8 @@ func Test_Settings_String(t *testing.T) {
 		"all values": {
 			settings: Settings{
 				Enabled:          boolPtr(true),
-				BlockProfileRate: 2,
-				MutexProfileRate: 1,
+				BlockProfileRate: intPtr(2),
+				MutexProfileRate: intPtr(1),
 				HTTPServer: httpserver.Settings{
 					Address:         ":8000",
 					ShutdownTimeout: time.Second,