Skip to content

refactor: refactor config to use constants for default values #845

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

refactor: refactor config to use constants for default values #845

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0b02476
refactor: refactor config to use constants for default values
appleboy Sep 6, 2025
14b9c3f
fix: enforce positive defaults for queue and worker configuration values
appleboy Sep 6, 2025
84b503e
fix: tighten file permissions for YAML test temp files
appleboy Sep 6, 2025
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
36 changes: 25 additions & 11 deletions config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,18 @@ import (
"github.com/spf13/viper"
)

// Configuration constants
const (
DefaultWorkerNum = 0 // 0 means use runtime.NumCPU()
DefaultQueueNum = 8192
DefaultMaxNotification = 100
DefaultShutdownTimeout = 30
DefaultFeedbackTimeout = 10
DefaultPort = "8088"
DefaultGRPCPort = "9000"
DefaultMaxConcurrentPush = 100
)

var defaultConf = []byte(`
core:
enabled: true # enable httpd server
Expand Down Expand Up @@ -316,13 +328,13 @@ func setDefaults() {
// Core defaults
viper.SetDefault("core.enabled", true)
viper.SetDefault("core.address", "")
viper.SetDefault("core.shutdown_timeout", 30)
viper.SetDefault("core.port", "8088")
viper.SetDefault("core.worker_num", 0)
viper.SetDefault("core.queue_num", 0)
viper.SetDefault("core.max_notification", 100)
viper.SetDefault("core.shutdown_timeout", DefaultShutdownTimeout)
viper.SetDefault("core.port", DefaultPort)
viper.SetDefault("core.worker_num", DefaultWorkerNum)
viper.SetDefault("core.queue_num", DefaultWorkerNum) // 0, will be set to DefaultQueueNum at runtime if still 0
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using DefaultWorkerNum for setting the default value of core.queue_num is confusing. While it currently works because DefaultWorkerNum is 0, this creates a hidden dependency between the two settings. If DefaultWorkerNum were to change in the future, it would unintentionally affect queue_num. For better clarity and maintainability, it's recommended to use the literal 0 here.

Suggested change
viper.SetDefault("core.queue_num", DefaultWorkerNum) // 0, will be set to DefaultQueueNum at runtime if still 0
viper.SetDefault("core.queue_num", 0) // 0, will be set to DefaultQueueNum at runtime if still 0

viper.SetDefault("core.max_notification", DefaultMaxNotification)
viper.SetDefault("core.sync", false)
viper.SetDefault("core.feedback_timeout", 10)
viper.SetDefault("core.feedback_timeout", DefaultFeedbackTimeout)
viper.SetDefault("core.mode", "release")
viper.SetDefault("core.ssl", false)
viper.SetDefault("core.cert_path", "cert.pem")
Expand All @@ -337,7 +349,7 @@ func setDefaults() {
viper.SetDefault("ios.enabled", false)
viper.SetDefault("ios.key_type", "pem")
viper.SetDefault("ios.production", false)
viper.SetDefault("ios.max_concurrent_pushes", uint(100))
viper.SetDefault("ios.max_concurrent_pushes", uint(DefaultMaxConcurrentPush))
viper.SetDefault("ios.max_retry", 0)

// Android defaults
Expand All @@ -346,7 +358,7 @@ func setDefaults() {

// gRPC defaults
viper.SetDefault("grpc.enabled", false)
viper.SetDefault("grpc.port", "9000")
viper.SetDefault("grpc.port", DefaultGRPCPort)

// Queue defaults
viper.SetDefault("queue.engine", "local")
Expand Down Expand Up @@ -505,12 +517,14 @@ func loadConfigFromViper() (*ConfYaml, error) {
conf.GRPC.Enabled = viper.GetBool("grpc.enabled")
conf.GRPC.Port = viper.GetString("grpc.port")

if conf.Core.WorkerNum == int64(0) {
// Apply runtime-computed defaults for zero or negative values
// This ensures optimal resource utilization and prevents panics from negative values
if conf.Core.WorkerNum <= 0 {
conf.Core.WorkerNum = int64(runtime.NumCPU())
}

if conf.Core.QueueNum == int64(0) {
conf.Core.QueueNum = int64(8192)
if conf.Core.QueueNum <= 0 {
conf.Core.QueueNum = DefaultQueueNum
}

return conf, nil
Expand Down
147 changes: 130 additions & 17 deletions config/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
content := []byte("invalid: yaml: content: [unclosed")

// Write invalid content to a temporary file
err := os.WriteFile(tmpFile, content, 0o644)

Check failure on line 32 in config/config_test.go

View workflow job for this annotation

GitHub Actions / lint 

G306: Expect WriteFile permissions to be 0600 or less (gosec)
assert.NoError(t, err)
defer os.Remove(tmpFile) // Clean up

Expand Down Expand Up @@ -67,7 +67,7 @@
panic("failed to load config.yml from file")
}

assert.Equal(t, uint(100), conf.Ios.MaxConcurrentPushes)
assert.Equal(t, uint(DefaultMaxConcurrentPush), conf.Ios.MaxConcurrentPushes)
}

type ConfigTestSuite struct {
Expand All @@ -91,22 +91,22 @@
func (suite *ConfigTestSuite) TestValidateConfDefault() {
// Core
assert.Equal(suite.T(), "", suite.ConfGorushDefault.Core.Address)
assert.Equal(suite.T(), "8088", suite.ConfGorushDefault.Core.Port)
assert.Equal(suite.T(), int64(30), suite.ConfGorushDefault.Core.ShutdownTimeout)
assert.Equal(suite.T(), DefaultPort, suite.ConfGorushDefault.Core.Port)
assert.Equal(suite.T(), int64(DefaultShutdownTimeout), suite.ConfGorushDefault.Core.ShutdownTimeout)
assert.Equal(suite.T(), true, suite.ConfGorushDefault.Core.Enabled)
assert.Equal(suite.T(), int64(runtime.NumCPU()), suite.ConfGorushDefault.Core.WorkerNum)
assert.Equal(suite.T(), int64(8192), suite.ConfGorushDefault.Core.QueueNum)
assert.Equal(suite.T(), int64(DefaultQueueNum), suite.ConfGorushDefault.Core.QueueNum)
assert.Equal(suite.T(), "release", suite.ConfGorushDefault.Core.Mode)
assert.Equal(suite.T(), false, suite.ConfGorushDefault.Core.Sync)
assert.Equal(suite.T(), "", suite.ConfGorushDefault.Core.FeedbackURL)
assert.Equal(suite.T(), 0, len(suite.ConfGorushDefault.Core.FeedbackHeader))
assert.Equal(suite.T(), int64(10), suite.ConfGorushDefault.Core.FeedbackTimeout)
assert.Equal(suite.T(), int64(DefaultFeedbackTimeout), suite.ConfGorushDefault.Core.FeedbackTimeout)
assert.Equal(suite.T(), false, suite.ConfGorushDefault.Core.SSL)
assert.Equal(suite.T(), "cert.pem", suite.ConfGorushDefault.Core.CertPath)
assert.Equal(suite.T(), "key.pem", suite.ConfGorushDefault.Core.KeyPath)
assert.Equal(suite.T(), "", suite.ConfGorushDefault.Core.KeyBase64)
assert.Equal(suite.T(), "", suite.ConfGorushDefault.Core.CertBase64)
assert.Equal(suite.T(), int64(100), suite.ConfGorushDefault.Core.MaxNotification)
assert.Equal(suite.T(), int64(DefaultMaxNotification), suite.ConfGorushDefault.Core.MaxNotification)
assert.Equal(suite.T(), "", suite.ConfGorushDefault.Core.HTTPProxy)
// Pid
assert.Equal(suite.T(), false, suite.ConfGorushDefault.Core.PID.Enabled)
Expand Down Expand Up @@ -138,7 +138,7 @@
assert.Equal(suite.T(), "pem", suite.ConfGorushDefault.Ios.KeyType)
assert.Equal(suite.T(), "", suite.ConfGorushDefault.Ios.Password)
assert.Equal(suite.T(), false, suite.ConfGorushDefault.Ios.Production)
assert.Equal(suite.T(), uint(100), suite.ConfGorushDefault.Ios.MaxConcurrentPushes)
assert.Equal(suite.T(), uint(DefaultMaxConcurrentPush), suite.ConfGorushDefault.Ios.MaxConcurrentPushes)
assert.Equal(suite.T(), 0, suite.ConfGorushDefault.Ios.MaxRetry)
assert.Equal(suite.T(), "", suite.ConfGorushDefault.Ios.KeyID)
assert.Equal(suite.T(), "", suite.ConfGorushDefault.Ios.TeamID)
Expand Down Expand Up @@ -186,28 +186,28 @@

// gRPC
assert.Equal(suite.T(), false, suite.ConfGorushDefault.GRPC.Enabled)
assert.Equal(suite.T(), "9000", suite.ConfGorushDefault.GRPC.Port)
assert.Equal(suite.T(), DefaultGRPCPort, suite.ConfGorushDefault.GRPC.Port)
}

func (suite *ConfigTestSuite) TestValidateConf() {
// Core
assert.Equal(suite.T(), "8088", suite.ConfGorush.Core.Port)
assert.Equal(suite.T(), int64(30), suite.ConfGorush.Core.ShutdownTimeout)
assert.Equal(suite.T(), DefaultPort, suite.ConfGorush.Core.Port)
assert.Equal(suite.T(), int64(DefaultShutdownTimeout), suite.ConfGorush.Core.ShutdownTimeout)
assert.Equal(suite.T(), true, suite.ConfGorush.Core.Enabled)
assert.Equal(suite.T(), int64(runtime.NumCPU()), suite.ConfGorush.Core.WorkerNum)
assert.Equal(suite.T(), int64(8192), suite.ConfGorush.Core.QueueNum)
assert.Equal(suite.T(), int64(DefaultQueueNum), suite.ConfGorush.Core.QueueNum)
assert.Equal(suite.T(), "release", suite.ConfGorush.Core.Mode)
assert.Equal(suite.T(), false, suite.ConfGorush.Core.Sync)
assert.Equal(suite.T(), "", suite.ConfGorush.Core.FeedbackURL)
assert.Equal(suite.T(), int64(10), suite.ConfGorush.Core.FeedbackTimeout)
assert.Equal(suite.T(), int64(DefaultFeedbackTimeout), suite.ConfGorush.Core.FeedbackTimeout)
assert.Equal(suite.T(), 1, len(suite.ConfGorush.Core.FeedbackHeader))
assert.Equal(suite.T(), "x-gorush-token:4e989115e09680f44a645519fed6a976", suite.ConfGorush.Core.FeedbackHeader[0])
assert.Equal(suite.T(), false, suite.ConfGorush.Core.SSL)
assert.Equal(suite.T(), "cert.pem", suite.ConfGorush.Core.CertPath)
assert.Equal(suite.T(), "key.pem", suite.ConfGorush.Core.KeyPath)
assert.Equal(suite.T(), "", suite.ConfGorush.Core.CertBase64)
assert.Equal(suite.T(), "", suite.ConfGorush.Core.KeyBase64)
assert.Equal(suite.T(), int64(100), suite.ConfGorush.Core.MaxNotification)
assert.Equal(suite.T(), int64(DefaultMaxNotification), suite.ConfGorush.Core.MaxNotification)
assert.Equal(suite.T(), "", suite.ConfGorush.Core.HTTPProxy)
// Pid
assert.Equal(suite.T(), false, suite.ConfGorush.Core.PID.Enabled)
Expand Down Expand Up @@ -239,7 +239,7 @@
assert.Equal(suite.T(), "pem", suite.ConfGorush.Ios.KeyType)
assert.Equal(suite.T(), "", suite.ConfGorush.Ios.Password)
assert.Equal(suite.T(), false, suite.ConfGorush.Ios.Production)
assert.Equal(suite.T(), uint(100), suite.ConfGorush.Ios.MaxConcurrentPushes)
assert.Equal(suite.T(), uint(DefaultMaxConcurrentPush), suite.ConfGorush.Ios.MaxConcurrentPushes)
assert.Equal(suite.T(), 0, suite.ConfGorush.Ios.MaxRetry)
assert.Equal(suite.T(), "", suite.ConfGorush.Ios.KeyID)
assert.Equal(suite.T(), "", suite.ConfGorush.Ios.TeamID)
Expand Down Expand Up @@ -268,7 +268,7 @@

// gRPC
assert.Equal(suite.T(), false, suite.ConfGorush.GRPC.Enabled)
assert.Equal(suite.T(), "9000", suite.ConfGorush.GRPC.Port)
assert.Equal(suite.T(), DefaultGRPCPort, suite.ConfGorush.GRPC.Port)
}

func TestConfigTestSuite(t *testing.T) {
Expand Down Expand Up @@ -556,7 +556,7 @@
name: "valid config",
cfg: &ConfYaml{
Core: SectionCore{
Port: "8088",
Port: DefaultPort,
Address: "0.0.0.0",
},
Stat: SectionStat{
Expand Down Expand Up @@ -620,7 +620,7 @@
// Test that all validation functions work together
t.Run("complete security validation", func(t *testing.T) {
// Test valid inputs
if err := ValidatePort("8088"); err != nil {
if err := ValidatePort(DefaultPort); err != nil {
t.Errorf("Valid port should not error: %v", err)
}

Expand All @@ -646,3 +646,116 @@
}
})
}

// TestNegativeValues tests that negative configuration values are handled safely
func TestNegativeValues(t *testing.T) {
tests := []struct {
name string
workerNum int64
queueNum int64
expectedWorker int64
expectedQueue int64
description string
}{
{
name: "negative_worker_num_should_use_cpu_count",
workerNum: -5,
queueNum: DefaultQueueNum,
expectedWorker: int64(runtime.NumCPU()),
expectedQueue: DefaultQueueNum,
description: "Negative WorkerNum should be replaced with CPU count",
},
{
name: "negative_queue_num_should_use_default",
workerNum: 4, // Valid positive value
queueNum: -100,
expectedWorker: 4,
expectedQueue: DefaultQueueNum,
description: "Negative QueueNum should be replaced with default",
},
{
name: "both_negative_should_use_defaults",
workerNum: -1,
queueNum: -1,
expectedWorker: int64(runtime.NumCPU()),
expectedQueue: DefaultQueueNum,
description: "Both negative values should be replaced with defaults",
},
{
name: "zero_worker_num_should_use_cpu_count",
workerNum: 0,
queueNum: DefaultQueueNum,
expectedWorker: int64(runtime.NumCPU()),
expectedQueue: DefaultQueueNum,
description: "Zero WorkerNum should be replaced with CPU count",
},
{
name: "zero_queue_num_should_use_default",
workerNum: 4,
queueNum: 0,
expectedWorker: 4,
expectedQueue: DefaultQueueNum,
description: "Zero QueueNum should be replaced with default",
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Create config with test values
conf := &ConfYaml{}
conf.Core.WorkerNum = tt.workerNum
conf.Core.QueueNum = tt.queueNum

// Apply the same logic as loadConfigFromViper
if conf.Core.WorkerNum <= 0 {
conf.Core.WorkerNum = int64(runtime.NumCPU())
}
if conf.Core.QueueNum <= 0 {
conf.Core.QueueNum = DefaultQueueNum
}

// Verify results
assert.Equal(t, tt.expectedWorker, conf.Core.WorkerNum,
"WorkerNum: %s", tt.description)
assert.Equal(t, tt.expectedQueue, conf.Core.QueueNum,
"QueueNum: %s", tt.description)

// Ensure values are always positive (safety check)
assert.True(t, conf.Core.WorkerNum > 0,
"WorkerNum should be positive to prevent panics")
assert.True(t, conf.Core.QueueNum > 0,
"QueueNum should be positive to prevent panics")
})
}
}
Comment on lines +650 to +730
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

⚠️ Potential issue

Tests re-implement prod logic; call the real loader instead

These assertions duplicate the fallback rules inline, so they can pass even if the production logic regresses. Drive the config via YAML + LoadConf to exercise the real defaults/sanitizers.

Apply:

 func TestNegativeValues(t *testing.T) {
-	tests := []struct {
-		name           string
-		workerNum      int64
-		queueNum       int64
-		expectedWorker int64
-		expectedQueue  int64
-		description    string
-	}{
-		{
-			name:           "negative_worker_num_should_use_cpu_count",
-			workerNum:      -5,
-			queueNum:       DefaultQueueNum,
-			expectedWorker: int64(runtime.NumCPU()),
-			expectedQueue:  DefaultQueueNum,
-			description:    "Negative WorkerNum should be replaced with CPU count",
-		},
-		{
-			name:           "negative_queue_num_should_use_default",
-			workerNum:      4, // Valid positive value
-			queueNum:       -100,
-			expectedWorker: 4,
-			expectedQueue:  DefaultQueueNum,
-			description:    "Negative QueueNum should be replaced with default",
-		},
-		{
-			name:           "both_negative_should_use_defaults",
-			workerNum:      -1,
-			queueNum:       -1,
-			expectedWorker: int64(runtime.NumCPU()),
-			expectedQueue:  DefaultQueueNum,
-			description:    "Both negative values should be replaced with defaults",
-		},
-		{
-			name:           "zero_worker_num_should_use_cpu_count",
-			workerNum:      0,
-			queueNum:       DefaultQueueNum,
-			expectedWorker: int64(runtime.NumCPU()),
-			expectedQueue:  DefaultQueueNum,
-			description:    "Zero WorkerNum should be replaced with CPU count",
-		},
-		{
-			name:           "zero_queue_num_should_use_default",
-			workerNum:      4,
-			queueNum:       0,
-			expectedWorker: 4,
-			expectedQueue:  DefaultQueueNum,
-			description:    "Zero QueueNum should be replaced with default",
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			// Create config with test values
-			conf := &ConfYaml{}
-			conf.Core.WorkerNum = tt.workerNum
-			conf.Core.QueueNum = tt.queueNum
-
-			// Apply the same logic as loadConfigFromViper
-			if conf.Core.WorkerNum <= 0 {
-				conf.Core.WorkerNum = int64(runtime.NumCPU())
-			}
-			if conf.Core.QueueNum <= 0 {
-				conf.Core.QueueNum = DefaultQueueNum
-			}
-
-			// Verify results
-			assert.Equal(t, tt.expectedWorker, conf.Core.WorkerNum,
-				"WorkerNum: %s", tt.description)
-			assert.Equal(t, tt.expectedQueue, conf.Core.QueueNum,
-				"QueueNum: %s", tt.description)
-
-			// Ensure values are always positive (safety check)
-			assert.True(t, conf.Core.WorkerNum > 0,
-				"WorkerNum should be positive to prevent panics")
-			assert.True(t, conf.Core.QueueNum > 0,
-				"QueueNum should be positive to prevent panics")
-		})
-	}
+	tests := []struct {
+		name           string
+		workerNum      int64
+		queueNum       int64
+		expectedWorker int64
+		expectedQueue  int64
+	}{
+		{"negative_worker_num_should_use_cpu_count", -5, DefaultQueueNum, int64(runtime.NumCPU()), DefaultQueueNum},
+		{"negative_queue_num_should_use_default", 4, -100, 4, DefaultQueueNum},
+		{"both_negative_should_use_defaults", -1, -1, int64(runtime.NumCPU()), DefaultQueueNum},
+		{"zero_worker_num_should_use_cpu_count", 0, DefaultQueueNum, int64(runtime.NumCPU()), DefaultQueueNum},
+		{"zero_queue_num_should_use_default", 4, 0, 4, DefaultQueueNum},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			dir := t.TempDir()
+			path := filepath.Join(dir, "cfg.yml")
+			yml := fmt.Sprintf("core:\n  worker_num: %d\n  queue_num: %d\n", tt.workerNum, tt.queueNum)
+			err := os.WriteFile(path, []byte(yml), 0o600)
+			assert.NoError(t, err)
+
+			conf, err := LoadConf(path)
+			assert.NoError(t, err)
+			assert.Equal(t, tt.expectedWorker, conf.Core.WorkerNum)
+			assert.Equal(t, tt.expectedQueue, conf.Core.QueueNum)
+			assert.Greater(t, conf.Core.WorkerNum, int64(0))
+			assert.Greater(t, conf.Core.QueueNum, int64(0))
+		})
+	}
 }

Add imports:

import (
  // ...
  "fmt"
  "path/filepath"
)


// TestConfigSafetyBoundaries tests edge cases for configuration safety
func TestConfigSafetyBoundaries(t *testing.T) {
tests := []struct {
name string
value int64
expected int64
usesCPU bool
}{
{"very_negative", -9999, DefaultQueueNum, false},
{"negative_one", -1, DefaultQueueNum, false},
{"zero", 0, DefaultQueueNum, false},
{"positive_one", 1, 1, false},
}

for _, tt := range tests {
t.Run(tt.name+"_queue", func(t *testing.T) {
conf := &ConfYaml{}
conf.Core.QueueNum = tt.value
conf.Core.WorkerNum = 1 // Set to valid positive value

// Apply safety logic
if conf.Core.QueueNum <= 0 {
conf.Core.QueueNum = DefaultQueueNum
}

assert.Equal(t, tt.expected, conf.Core.QueueNum)
assert.True(t, conf.Core.QueueNum > 0, "QueueNum must be positive")
})
}
}
Loading