scroll-tech#1042 Allow configure db ConnMaxLifetime & ConnMaxIdleTime

jeswinsimon · Mar 25, 2024 · 86ac5f8 · 86ac5f8
1 parent b01b581
commit 86ac5f8
Show file tree

Hide file tree

Showing 19 changed files with 89 additions and 44 deletions.
diff --git a/bridge-history-api/conf/config.json b/bridge-history-api/conf/config.json
@@ -40,7 +40,9 @@
 		"dsn": "postgres://postgres:123456@localhost:5444/test?sslmode=disable",
 		"driverName": "postgres",
 		"maxOpenNum": 200,
-		"maxIdleNum": 20
+		"maxIdleNum": 20,
+		"maxLifetime": 600,
+		"maxIdleTime": 300
 	},
 	"redis": {
 		"address": "localhost:6379",

diff --git a/common/database/config.go b/common/database/config.go
@@ -8,4 +8,6 @@ type Config struct {
 
 	MaxOpenNum int `json:"maxOpenNum"`
 	MaxIdleNum int `json:"maxIdleNum"`
+	MaxLifetime int `json:"maxLifetime,omitempty"`
+	MaxIdleTime int `json:"maxIdleTime,omitempty"`
 }
diff --git a/common/database/db.go b/common/database/db.go
@@ -70,8 +70,17 @@ func InitDB(config *Config) (*gorm.DB, error) {
 		return nil, pingErr
 	}
 
-	sqlDB.SetConnMaxLifetime(time.Minute * 10)
-	sqlDB.SetConnMaxIdleTime(time.Minute * 5)
+	if (config.MaxLifetime != 0) {
+		sqlDB.SetConnMaxLifetime(time.Second * config.MaxLifetime)
+	} else {
+		sqlDB.SetConnMaxLifetime(time.Minute * 10)
+	}
+
+	if (config.MaxIdleTime != 0) {
+		sqlDB.SetConnMaxIdleTime(time.Second * config.MaxIdleTime)
+	} else {
+		sqlDB.SetConnMaxIdleTime(time.Minute * 5)
+	}
 
 	sqlDB.SetMaxOpenConns(config.MaxOpenNum)
 	sqlDB.SetMaxIdleConns(config.MaxIdleNum)

diff --git a/common/database/db_test.go b/common/database/db_test.go
@@ -44,10 +44,12 @@ func TestDB(t *testing.T) {
 	base.RunDBImage(t)
 
 	dbCfg := &Config{
-		DSN:        base.DBConfig.DSN,
-		DriverName: base.DBConfig.DriverName,
-		MaxOpenNum: base.DBConfig.MaxOpenNum,
-		MaxIdleNum: base.DBConfig.MaxIdleNum,
+		DSN:         base.DBConfig.DSN,
+		DriverName:  base.DBConfig.DriverName,
+		MaxOpenNum:  base.DBConfig.MaxOpenNum,
+		MaxIdleNum:  base.DBConfig.MaxIdleNum,
+		MaxLifetime: base.DBConfig.MaxLifetime,
+		MaxIdleTime: base.DBConfig.MaxIdleTime,
 	}
 
 	var err error

diff --git a/common/docker/docker_app.go b/common/docker/docker_app.go
@@ -167,6 +167,8 @@ func (b *App) mockDBConfig() error {
 		DriverName: "postgres",
 		MaxOpenNum: 200,
 		MaxIdleNum: 20,
+		MaxLifetime: 600,
+		MaxIdleTime: 300,
 	}
 
 	if b.DBImg != nil {

diff --git a/coordinator/conf/config.json b/coordinator/conf/config.json
@@ -16,7 +16,9 @@
     "driver_name": "postgres",
     "dsn": "postgres://localhost/scroll?sslmode=disable",
     "maxOpenNum": 200,
-    "maxIdleNum": 20
+    "maxIdleNum": 20,
+    "maxLifetime": 600,
+    "maxIdleTime": 300
   },
   "l2": {
     "chain_id": 111

diff --git a/coordinator/internal/config/config_test.go b/coordinator/internal/config/config_test.go
@@ -29,7 +29,9 @@ func TestConfig(t *testing.T) {
 			"driver_name": "postgres",
 			"dsn": "postgres://admin:123456@localhost/test?sslmode=disable",
 			"maxOpenNum": 200,
-			"maxIdleNum": 20
+			"maxIdleNum": 20,
+			"maxLifetime": 600,
+			"maxIdleTime": 300
 		},
 		"l2": {
 			"chain_id": 111

diff --git a/coordinator/internal/orm/orm_test.go b/coordinator/internal/orm/orm_test.go
@@ -38,10 +38,12 @@ func setupEnv(t *testing.T) {
 	var err error
 	db, err = database.InitDB(
 		&database.Config{
-			DSN:        base.DBConfig.DSN,
-			DriverName: base.DBConfig.DriverName,
-			MaxOpenNum: base.DBConfig.MaxOpenNum,
-			MaxIdleNum: base.DBConfig.MaxIdleNum,
+			DSN:         base.DBConfig.DSN,
+			DriverName:  base.DBConfig.DriverName,
+			MaxOpenNum:  base.DBConfig.MaxOpenNum,
+			MaxIdleNum:  base.DBConfig.MaxIdleNum,
+			MaxLifetime: base.DBConfig.MaxLifetime,
+			MaxIdleTime: base.DBConfig.MaxIdleTime,
 		},
 	)
 	assert.NoError(t, err)

diff --git a/coordinator/test/api_test.go b/coordinator/test/api_test.go
@@ -155,10 +155,12 @@ func setEnv(t *testing.T) {
 	base.RunDBImage(t)
 
 	dbCfg = &database.Config{
-		DSN:        base.DBConfig.DSN,
-		DriverName: base.DBConfig.DriverName,
-		MaxOpenNum: base.DBConfig.MaxOpenNum,
-		MaxIdleNum: base.DBConfig.MaxIdleNum,
+		DSN:         base.DBConfig.DSN,
+		DriverName:  base.DBConfig.DriverName,
+		MaxOpenNum:  base.DBConfig.MaxOpenNum,
+		MaxIdleNum:  base.DBConfig.MaxIdleNum,
+		MaxLifetime: base.DBConfig.MaxLifetime,
+		MaxIdleTime: base.DBConfig.MaxIdleTime,
 	}
 
 	var err error

diff --git a/database/config.go b/database/config.go
@@ -14,6 +14,8 @@ type DBConfig struct {
 
 	MaxOpenNum int `json:"maxOpenNum"`
 	MaxIdleNum int `json:"maxIdleNum"`
+	MaxLifetime int `json:"maxLifetime,omitempty"`
+	MaxIdleTime int `json:"maxIdleTime,omitempty"`
 }
 
 // NewConfig returns a new instance of Config.

diff --git a/database/config.json b/database/config.json
@@ -2,5 +2,7 @@
   "dsn": "postgres://postgres:123456@localhost:5444/test?sslmode=disable",
   "driver_name": "postgres",
   "maxOpenNum": 200,
-  "maxIdleNum": 20
+  "maxIdleNum": 20,
+  "maxLifetime": 600,
+  "maxIdleTime": 300
 }
diff --git a/database/config_test.go b/database/config_test.go
@@ -15,7 +15,9 @@ func TestConfig(t *testing.T) {
 		"dsn": "postgres://postgres:123456@localhost:5444/test?sslmode=disable",
 		"driver_name": "postgres",
 		"maxOpenNum": %d,
-		"maxIdleNum": %d
+		"maxIdleNum": %d,
+		"maxLifetime": %d,
+		"maxIdleTime": %d
 	}`
 
 	t.Run("Success Case", func(t *testing.T) {

diff --git a/rollup/conf/config.json b/rollup/conf/config.json
@@ -81,6 +81,8 @@
     "driver_name": "postgres",
     "dsn": "postgres://localhost/scroll?sslmode=disable",
     "maxOpenNum": 200,
-    "maxIdleNum": 20
+    "maxIdleNum": 20,
+    "maxLifetime": 600,
+    "maxIdleTime": 300
   }
 }
diff --git a/rollup/internal/controller/relayer/relayer_test.go b/rollup/internal/controller/relayer/relayer_test.go
@@ -56,10 +56,12 @@ func setupEnv(t *testing.T) {
 	cfg.L2Config.RelayerConfig.SenderConfig.Endpoint = base.L1gethImg.Endpoint()
 	cfg.L1Config.RelayerConfig.SenderConfig.Endpoint = base.L2gethImg.Endpoint()
 	cfg.DBConfig = &database.Config{
-		DSN:        base.DBConfig.DSN,
-		DriverName: base.DBConfig.DriverName,
-		MaxOpenNum: base.DBConfig.MaxOpenNum,
-		MaxIdleNum: base.DBConfig.MaxIdleNum,
+		DSN:         base.DBConfig.DSN,
+		DriverName:  base.DBConfig.DriverName,
+		MaxOpenNum:  base.DBConfig.MaxOpenNum,
+		MaxIdleNum:  base.DBConfig.MaxIdleNum,
+		MaxLifetime: base.DBConfig.MaxLifetime,
+		MaxIdleTime: base.DBConfig.MaxIdleTime,
 	}
 	port, err := rand.Int(rand.Reader, big.NewInt(10000))
 	assert.NoError(t, err)

diff --git a/rollup/internal/controller/sender/sender_test.go b/rollup/internal/controller/sender/sender_test.go
@@ -85,10 +85,12 @@ func setupEnv(t *testing.T) {
 	base.RunDBImage(t)
 	db, err = database.InitDB(
 		&database.Config{
-			DSN:        base.DBConfig.DSN,
-			DriverName: base.DBConfig.DriverName,
-			MaxOpenNum: base.DBConfig.MaxOpenNum,
-			MaxIdleNum: base.DBConfig.MaxIdleNum,
+			DSN:         base.DBConfig.DSN,
+			DriverName:  base.DBConfig.DriverName,
+			MaxOpenNum:  base.DBConfig.MaxOpenNum,
+			MaxIdleNum:  base.DBConfig.MaxIdleNum,
+			MaxLifetime: base.DBConfig.MaxLifetime,
+			MaxIdleTime: base.DBConfig.MaxIdleTime,
 		},
 	)
 	assert.NoError(t, err)

diff --git a/rollup/internal/controller/watcher/watcher_test.go b/rollup/internal/controller/watcher/watcher_test.go
@@ -47,10 +47,12 @@ func setupEnv(t *testing.T) (err error) {
 	cfg.L2Config.RelayerConfig.SenderConfig.Endpoint = base.L1gethImg.Endpoint()
 	cfg.L1Config.RelayerConfig.SenderConfig.Endpoint = base.L2gethImg.Endpoint()
 	cfg.DBConfig = &database.Config{
-		DSN:        base.DBConfig.DSN,
-		DriverName: base.DBConfig.DriverName,
-		MaxOpenNum: base.DBConfig.MaxOpenNum,
-		MaxIdleNum: base.DBConfig.MaxIdleNum,
+		DSN:         base.DBConfig.DSN,
+		DriverName:  base.DBConfig.DriverName,
+		MaxOpenNum:  base.DBConfig.MaxOpenNum,
+		MaxIdleNum:  base.DBConfig.MaxIdleNum,
+		MaxLifetime: base.DBConfig.MaxLifetime,
+		MaxIdleTime: base.DBConfig.MaxIdleTime,
 	}
 
 	// Create l2geth client.

diff --git a/rollup/internal/orm/orm_test.go b/rollup/internal/orm/orm_test.go
@@ -50,10 +50,12 @@ func setupEnv(t *testing.T) {
 	var err error
 	db, err = database.InitDB(
 		&database.Config{
-			DSN:        base.DBConfig.DSN,
-			DriverName: base.DBConfig.DriverName,
-			MaxOpenNum: base.DBConfig.MaxOpenNum,
-			MaxIdleNum: base.DBConfig.MaxIdleNum,
+			DSN:         base.DBConfig.DSN,
+			DriverName:  base.DBConfig.DriverName,
+			MaxOpenNum:  base.DBConfig.MaxOpenNum,
+			MaxIdleNum:  base.DBConfig.MaxIdleNum,
+			MaxLifetime: base.DBConfig.MaxLifetime,
+			MaxIdleTime: base.DBConfig.MaxIdleTime,
 		},
 	)
 	assert.NoError(t, err)

diff --git a/rollup/tests/bridge_test.go b/rollup/tests/bridge_test.go
@@ -48,10 +48,12 @@ var (
 
 func setupDB(t *testing.T) *gorm.DB {
 	cfg := &database.Config{
-		DSN:        base.DBConfig.DSN,
-		DriverName: base.DBConfig.DriverName,
-		MaxOpenNum: base.DBConfig.MaxOpenNum,
-		MaxIdleNum: base.DBConfig.MaxIdleNum,
+		DSN:         base.DBConfig.DSN,
+		DriverName:  base.DBConfig.DriverName,
+		MaxOpenNum:  base.DBConfig.MaxOpenNum,
+		MaxIdleNum:  base.DBConfig.MaxIdleNum,
+		MaxLifetime: base.DBConfig.MaxLifetime,
+		MaxIdleTime: base.DBConfig.MaxIdleTime,
 	}
 	db, err := database.InitDB(cfg)
 	assert.NoError(t, err)

diff --git a/tests/integration-test/integration_test.go b/tests/integration-test/integration_test.go
@@ -48,10 +48,12 @@ func TestCoordinatorProverInteraction(t *testing.T) {
 
 	// Init data
 	dbCfg := &database.Config{
-		DSN:        base.DBConfig.DSN,
-		DriverName: base.DBConfig.DriverName,
-		MaxOpenNum: base.DBConfig.MaxOpenNum,
-		MaxIdleNum: base.DBConfig.MaxIdleNum,
+		DSN:         base.DBConfig.DSN,
+		DriverName:  base.DBConfig.DriverName,
+		MaxOpenNum:  base.DBConfig.MaxOpenNum,
+		MaxIdleNum:  base.DBConfig.MaxIdleNum,
+		MaxLifetime: base.DBConfig.MaxLifetime,
+		MaxIdleTime: base.DBConfig.MaxIdleTime,
 	}
 
 	db, err := database.InitDB(dbCfg)