chore: use pgxpool (#1594)

Signed-off-by: Miguel Martinez <[email protected]>
Signed-off-by: Miguel Martinez Trivino <[email protected]>

Author: migmartri

Diff for: app/controlplane/cmd/wire.go

@@ -63,7 +63,7 @@ func wireApp(*conf.Bootstrap, credentials.ReaderWriter, log.Logger, sdk.Availabl
 }
 
 func newDataConf(in *conf.Data_Database) *data.NewConfig {
-	c := &data.NewConfig{Driver: in.Driver, Source: in.Source, MaxIdleConns: int(in.MaxIdleConns), MaxOpenConns: int(in.MaxOpenConns)}
+	c := &data.NewConfig{Driver: in.Driver, Source: in.Source, MinOpenConns: in.MinOpenConns, MaxOpenConns: in.MaxOpenConns}
 	if in.MaxConnIdleTime != nil {
 		c.MaxConnIdleTime = in.MaxConnIdleTime.AsDuration()
 	}

Diff for: app/controlplane/cmd/wire_gen.go

@@ -51,9 +51,9 @@ data:
   database:
     driver: pgx
     source: postgresql://postgres:@${DB_HOST:0.0.0.0}/controlplane
-    # max_open_conns: 5
-    # max_idle_conns: 10
-    # max_conn_idle_time: 120s
+    max_open_conns: 5
+    min_open_conns: 1
+    max_conn_idle_time: 120s
 
 # Development credentials for the SSO authentication roundtrip
 auth:

Diff for: app/controlplane/configs/config.devel.yaml

@@ -132,13 +132,11 @@ message Data {
   message Database {
     string driver = 1;
     string source = 2;
-    //  sets the maximum amount of time a connection may be idle.
-    // default to 10
-    int32 max_idle_conns = 3;
-    // if not set defaults to dynamic up to the max number of connections
-    // provided by the target database
+    //  default 0
+    int32 min_open_conns = 3;
+    // default max(4, runtime.NumCPU())
     int32 max_open_conns = 4;
-    // sets the maximum amount of time a connection may be idle
+    // default 30 minutes
     google.protobuf.Duration max_conn_idle_time = 5;
   }
   Database database = 1;

Diff for: app/controlplane/internal/conf/controlplane/config/v1/conf.pb.go

@@ -21,8 +21,6 @@ import (
 	"io"
 	"time"
 
-	"database/sql"
-
 	"entgo.io/ent/dialect"
 	entsql "entgo.io/ent/dialect/sql"
 
@@ -33,7 +31,9 @@ import (
 	"github.com/google/wire"
 
 	// Load PGX driver
-	_ "github.com/jackc/pgx/v5/stdlib"
+
+	"github.com/jackc/pgx/v5/pgxpool"
+	"github.com/jackc/pgx/v5/stdlib"
 )
 
 // ProviderSet is data providers.
@@ -73,7 +73,7 @@ func (data *Data) SchemaLoad() error {
 
 type NewConfig struct {
 	Driver, Source             string
-	MaxIdleConns, MaxOpenConns int
+	MinOpenConns, MaxOpenConns int32
 	MaxConnIdleTime            time.Duration
 }
 
@@ -100,47 +100,38 @@ func NewData(c *NewConfig, logger log.Logger) (*Data, func(), error) {
 	return &Data{DB: db}, cleanup, nil
 }
 
-const (
-	DefaultMaxIdleConns = 10
-	DefaultMaxOpenConns = 50
-	DefaultMaxIdleTime  = 5 * time.Minute
-)
-
 func initSQLDatabase(c *NewConfig, log *log.Helper) (*ent.Client, error) {
+	if c.Driver != "pgx" {
+		return nil, fmt.Errorf("unsupported driver: %s", c.Driver)
+	}
+
 	log.Debugf("connecting to db: driver=%s", c.Driver)
-	db, err := sql.Open(
-		c.Driver,
-		c.Source,
-	)
+	poolConfig, err := pgxpool.ParseConfig(c.Source)
 	if err != nil {
-		return nil, fmt.Errorf("error opening the connection, driver=%s:  %w", c.Driver, err)
+		log.Fatal(err)
 	}
 
-	maxOpenConns := DefaultMaxOpenConns
 	if c.MaxOpenConns > 0 {
-		maxOpenConns = c.MaxOpenConns
+		log.Infof("DB: setting max open conns: %d", c.MaxOpenConns)
+		poolConfig.MaxConns = c.MaxOpenConns
 	}
 
-	log.Infof("DB: setting max open conns: %d", maxOpenConns)
-	db.SetMaxOpenConns(maxOpenConns)
-
-	maxIdleConns := DefaultMaxIdleConns
-	if c.MaxIdleConns > 0 {
-		maxIdleConns = c.MaxIdleConns
+	if n := c.MinOpenConns; n > 0 {
+		log.Infof("DB: setting min open conns: %v", n)
+		poolConfig.MinConns = c.MinOpenConns
 	}
 
-	log.Infof("DB: setting max idle conns: %d", maxIdleConns)
-	db.SetMaxIdleConns(maxIdleConns)
-
-	maxIdleTime := DefaultMaxIdleTime
-	if c.MaxConnIdleTime > 0 {
-		maxIdleTime = c.MaxConnIdleTime
+	if t := c.MaxConnIdleTime; t > 0 {
+		log.Infof("DB: setting max conn idle time: %v", t)
+		poolConfig.MaxConnIdleTime = t
 	}
 
-	log.Infof("DB: setting max conn idle time: %v", maxIdleTime)
-	db.SetConnMaxIdleTime(maxIdleTime)
+	pool, err := pgxpool.NewWithConfig(context.TODO(), poolConfig)
+	if err != nil {
+		return nil, fmt.Errorf("error creating the pool: %w", err)
+	}
 
-	// Create an ent.Driver from `db`.
+	db := stdlib.OpenDBFromPool(pool)
 	drv := entsql.OpenDB(dialect.Postgres, db)
 	client := ent.NewClient(ent.Driver(drv))
 

Diff for: app/controlplane/internal/conf/controlplane/config/v1/conf.proto

@@ -7,7 +7,7 @@ description: Chainloop is an open source software supply chain control plane, a
 
 type: application
 # Bump the patch (not minor, not major) version on each change in the Chart Source code
-version: 1.146.1
+version: 1.146.2
 # Do not update appVersion, this is handled automatically by the release process
 appVersion: v0.128.0
 

Diff for: app/controlplane/pkg/data/data.go

@@ -57,8 +57,8 @@ stringData:
         {{- if and .Values.controlplane.externalDatabase.maxOpenConns  }}
         max_open_conns: {{ .Values.controlplane.externalDatabase.maxOpenConns }}
         {{- end }}
-        {{- if and .Values.controlplane.externalDatabase.maxIdleConns  }}
-        max_idle_conns: {{ .Values.controlplane.externalDatabase.maxIdleConns }}
+        {{- if and .Values.controlplane.externalDatabase.minOpenConns  }}
+        min_open_conns: {{ .Values.controlplane.externalDatabase.minOpenConns }}
         {{- end }}
         {{- if and .Values.controlplane.externalDatabase.maxIdleTime  }}
         max_conn_idle_time: "{{ .Values.controlplane.externalDatabase.maxIdleTime }}" 

Diff for: deployment/chainloop/Chart.yaml

@@ -217,9 +217,9 @@ controlplane:
   ## @param controlplane.externalDatabase.user Non-root username
   ## @param controlplane.externalDatabase.database Database name
   ## @param controlplane.externalDatabase.password Password for the non-root username
-  ## @extra controlplane.externalDatabase.maxOpenConns Maximum number of open connections to the database. Default: 50
-  ## @extra controlplane.externalDatabase.maxIdleConns Maximum number of connections in the idle connection pool. Default: 10
-  ## @extra controlplane.externalDatabase.maxIdleTime Max time a connection may be idle. Default: 5m
+  ## @extra controlplane.externalDatabase.maxOpenConns Maximum number of open connections to the database. Default: max(4, num_cpus)
+  ## @extra controlplane.externalDatabase.minOpenConns Min number of connections. Default: 0
+  ## @extra controlplane.externalDatabase.maxIdleTime Max time a connection may be idle. Default: 30m
   ##
   externalDatabase:
     host: ""
@@ -228,7 +228,7 @@ controlplane:
     database: ""
     password: ""
     # maxOpenConns: 50
-    # maxIdleConns: 10
+    # minOpenConns: 5
     # maxIdleTime: 5m
 
   ## @section Control Plane Authentication

Diff for: deployment/chainloop/templates/controlplane/secret-config.yaml

@@ -76,7 +76,7 @@ require (
 	github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.1.0
 	github.com/in-toto/attestation v0.1.1-0.20231010121940-09a03152c04a
 	github.com/invopop/jsonschema v0.7.0
-	github.com/jackc/pgx/v5 v5.6.0
+	github.com/jackc/pgx/v5 v5.7.1
 	github.com/muesli/reflow v0.3.0
 	github.com/open-policy-agent/opa v0.68.0
 	github.com/openvex/go-vex v0.2.5
@@ -288,7 +288,7 @@ require (
 	github.com/imdario/mergo v0.3.16 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/jackc/pgpassfile v1.0.0 // indirect
-	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
+	github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
 	github.com/jedisct1/go-minisign v0.0.0-20230811132847-661be99b8267 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect

Diff for: deployment/chainloop/values.yaml

@@ -836,10 +836,10 @@ github.com/invopop/jsonschema v0.7.0 h1:2vgQcBz1n256N+FpX3Jq7Y17AjYt46Ig3zIWyy77
 github.com/invopop/jsonschema v0.7.0/go.mod h1:O9uiLokuu0+MGFlyiaqtWxwqJm41/+8Nj0lD7A36YH0=
 github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
 github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
-github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a h1:bbPeKD0xmW/Y25WS6cokEszi5g+S0QxI/d45PkRi7Nk=
-github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
-github.com/jackc/pgx/v5 v5.6.0 h1:SWJzexBzPL5jb0GEsrPMLIsi/3jOo7RHlzTjcAeDrPY=
-github.com/jackc/pgx/v5 v5.6.0/go.mod h1:DNZ/vlrUnhWCoFGxHAG8U2ljioxukquj7utPDgtQdTw=
+github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 h1:iCEnooe7UlwOQYpKFhBabPMi4aNAfoODPEFNiAnClxo=
+github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
+github.com/jackc/pgx/v5 v5.7.1 h1:x7SYsPBYDkHDksogeSmZZ5xzThcTgRz++I5E+ePFUcs=
+github.com/jackc/pgx/v5 v5.7.1/go.mod h1:e7O26IywZZ+naJtWWos6i6fvWK+29etgITqrqHLfoZA=
 github.com/jackc/puddle/v2 v2.2.2 h1:PR8nw+E/1w0GLuRFSmiioY6UooMp6KJv0/61nB7icHo=
 github.com/jackc/puddle/v2 v2.2.2/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A=