feat: added pgxpool Config, Handler and Service interfaces and implementations

* Added pgxpool Config, Handler and Service interfaces and implementations
* Remove redundant code
* Improved config structs
* Upgraded dependencies

Author: ralvarezdev

errors.go

@@ -3,10 +3,16 @@ package go_databases
 import "errors"
 
 var (
-	ErrNilDatabase        = errors.New("database cannot be nil")
-	ErrAlreadyConnected   = errors.New("connection to database already established")
-	ErrConnectionFailed   = errors.New("failed to connect to database")
-	ErrPingFailed         = errors.New("failed to ping database")
-	ErrNotConnected       = errors.New("connection to database not established")
-	ErrFailedToDisconnect = errors.New("failed to disconnect from database")
+	ErrNilConfig           = errors.New("config cannot be nil")
+	ErrNilConnection       = errors.New("connection cannot be nil")
+	ErrNilPool             = errors.New("pool cannot be nil")
+	ErrAlreadyConnected    = errors.New("connection to database already established")
+	ErrConnectionFailed    = errors.New("failed to connect to database")
+	ErrPingFailed          = errors.New("failed to ping database")
+	ErrNotConnected        = errors.New("connection to database not established")
+	ErrFailedToDisconnect  = errors.New("failed to disconnect from database")
+	ErrEmptyDriverName     = errors.New("driver name cannot be empty")
+	ErrEmptyDataSourceName = errors.New("data source name cannot be empty")
+	ErrNilQuery            = errors.New("sql query cannot be nil")
+	ErrNilRow              = errors.New("sql row cannot be nil")
 )

go.mod

@@ -5,7 +5,7 @@ go 1.23.4
 require (
 	github.com/go-redis/redis/v8 v8.11.5
 	github.com/jackc/pgx/v5 v5.7.2
-	github.com/ralvarezdev/go-logger v0.4.5
+	github.com/ralvarezdev/go-logger v0.4.6
 	go.mongodb.org/mongo-driver v1.17.2
 	golang.org/x/net v0.34.0
 	gorm.io/gorm v1.25.12
@@ -17,12 +17,13 @@ require (
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/jackc/pgpassfile v1.0.0 // indirect
 	github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
+	github.com/jackc/puddle/v2 v2.2.2 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/klauspost/compress v1.16.7 // indirect
 	github.com/montanaflynn/stats v0.7.1 // indirect
-	github.com/ralvarezdev/go-flags v0.3.1 // indirect
-	github.com/ralvarezdev/go-strings v0.1.0 // indirect
+	github.com/ralvarezdev/go-flags v0.3.2 // indirect
+	github.com/ralvarezdev/go-strings v0.1.7 // indirect
 	github.com/xdg-go/pbkdf2 v1.0.0 // indirect
 	github.com/xdg-go/scram v1.1.2 // indirect
 	github.com/xdg-go/stringprep v1.0.4 // indirect

go.sum

@@ -19,6 +19,8 @@ github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 h1:iCEnooe7Ulw
 github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
 github.com/jackc/pgx/v5 v5.7.2 h1:mLoDLV6sonKlvjIEsV56SkWNCnuNv531l94GaIzO+XI=
 github.com/jackc/pgx/v5 v5.7.2/go.mod h1:ncY89UGWxg82EykZUwSpUKEfccBGGYq1xjrOpsbsfGQ=
+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/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD/E=
 github.com/jinzhu/inflection v1.0.0/go.mod h1:h+uFLlag+Qp1Va5pdKtLDYj+kHp5pxUVkryuEj+Srlc=
 github.com/jinzhu/now v1.1.5 h1:/o9tlHleP7gOFmsnYNz3RGnqzefHA47wQpKrrdTIwXQ=
@@ -35,12 +37,12 @@ github.com/onsi/gomega v1.18.1 h1:M1GfJqGRrBrrGGsbxzV5dqM2U2ApXefZCQpkukxYRLE=
 github.com/onsi/gomega v1.18.1/go.mod h1:0q+aL8jAiMXy9hbwj2mr5GziHiwhAIQpFmmtT5hitRs=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/ralvarezdev/go-flags v0.3.1 h1:YxGYUonmr0dwJL+9oDY/4GqCl1CYwYDJExpGXXMc9rU=
-github.com/ralvarezdev/go-flags v0.3.1/go.mod h1:R3yVBYvzwqfOp26LidaiJ/zftVAnPC3pKunVpV/vosE=
-github.com/ralvarezdev/go-logger v0.4.5 h1:Lw7DdZUb4YSQDA7J9nv79soojw1eFHVVzO8wdE9d+Qg=
-github.com/ralvarezdev/go-logger v0.4.5/go.mod h1:vq47onxpED19/o3dh5/YbBKK0eZhqJENPgACYkqNNi8=
-github.com/ralvarezdev/go-strings v0.1.0 h1:bE4eEkdfsHwpgUw+s8/EdLPkRTPki/FTGZx8iEOOQBQ=
-github.com/ralvarezdev/go-strings v0.1.0/go.mod h1:8sFOqmPJpqzS7bTjf91EzUCITnwpmkfifwY80GxV5r8=
+github.com/ralvarezdev/go-flags v0.3.2 h1:l3f62CD5NysLAJH5XqSRGiakU/dn4pTGdX4yaBlAmMw=
+github.com/ralvarezdev/go-flags v0.3.2/go.mod h1:R3yVBYvzwqfOp26LidaiJ/zftVAnPC3pKunVpV/vosE=
+github.com/ralvarezdev/go-logger v0.4.6 h1:eZalm0WAdNuhzbaVh5D7gC6AFztdpqE/GQfjH2pipyE=
+github.com/ralvarezdev/go-logger v0.4.6/go.mod h1:zxuMDHqtV2eoJYtmo219lima0ZSk4p/AGj/cCc390P8=
+github.com/ralvarezdev/go-strings v0.1.7 h1:rO+4TJmHJTghRWl4Nq6gfnGSyNRerunJrkS03x1SLz4=
+github.com/ralvarezdev/go-strings v0.1.7/go.mod h1:8sFOqmPJpqzS7bTjf91EzUCITnwpmkfifwY80GxV5r8=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=

mongodb/collection.go

@@ -8,7 +8,7 @@ import (
 
 // Collection represents a MongoDB collection
 type Collection struct {
-	Name    string
+	name    string
 	Indexes *[]*mongo.IndexModel
 }
 
@@ -18,8 +18,8 @@ func NewCollection(
 	indexes *[]*mongo.IndexModel,
 ) *Collection {
 	return &Collection{
-		Name:    name,
-		Indexes: indexes,
+		name,
+		indexes,
 	}
 }
 
@@ -28,7 +28,7 @@ func (c *Collection) CreateCollection(database *mongo.Database) (
 	collection *mongo.Collection, err error,
 ) {
 	// Get the collection
-	collection = database.Collection(c.Name)
+	collection = database.Collection(c.name)
 
 	// Create the indexes
 	if err = c.createIndexes(collection); err != nil {

mongodb/config.go

@@ -0,0 +1,37 @@
+package mongodb
+
+import (
+	"time"
+)
+
+type (
+	// Config interface
+	Config interface {
+		URI() string
+		Timeout() time.Duration
+	}
+
+	// ConnConfig struct
+	ConnConfig struct {
+		uri     string
+		timeout time.Duration
+	}
+)
+
+// NewConnConfig creates a new MongoDB connection configuration
+func NewConnConfig(uri string, timeout time.Duration) *ConnConfig {
+	return &ConnConfig{
+		uri,
+		timeout,
+	}
+}
+
+// URI returns the MongoDB URI
+func (c *ConnConfig) URI() string {
+	return c.uri
+}
+
+// Timeout returns the MongoDB connection timeout
+func (c *ConnConfig) Timeout() time.Duration {
+	return c.timeout
+}

mongodb/connection.go

@@ -5,63 +5,55 @@ import (
 	"go.mongodb.org/mongo-driver/mongo"
 	"go.mongodb.org/mongo-driver/mongo/options"
 	"golang.org/x/net/context"
-	"time"
 )
 
 type (
-	// ConnectionHandler interface
-	ConnectionHandler interface {
+	// ConnHandler interface
+	ConnHandler interface {
 		Connect() (*mongo.Client, error)
-		GetClient() (*mongo.Client, error)
+		Client() (*mongo.Client, error)
 		Disconnect()
 	}
 
-	// Config struct
-	Config struct {
-		Uri     string
-		Timeout time.Duration
-	}
-
-	// DefaultConnectionHandler struct
-	DefaultConnectionHandler struct {
-		Ctx           context.Context
-		Cancel        context.CancelFunc
-		ClientOptions *options.ClientOptions
-		Client        *mongo.Client
+	// DefaultConnHandler struct
+	DefaultConnHandler struct {
+		ctx           context.Context
+		cancel        context.CancelFunc
+		clientOptions *options.ClientOptions
+		client        *mongo.Client
 	}
 )
 
-// NewDefaultConnectionHandler creates a new connection
-func NewDefaultConnectionHandler(config *Config) (
-	*DefaultConnectionHandler,
+// NewDefaultConnHandler creates a new connection
+func NewDefaultConnHandler(config Config) (
+	*DefaultConnHandler,
 	error,
 ) {
 	// Check if the config is nil
 	if config == nil {
-		return nil, ErrNilClient
+		return nil, godatabases.ErrNilConfig
 	}
 
 	// Set client options
-	ctx, cancel := context.WithTimeout(context.Background(), config.Timeout)
-	clientOptions := options.Client().ApplyURI(config.Uri)
-
-	return &DefaultConnectionHandler{
-		Cancel:        cancel,
-		Ctx:           ctx,
-		ClientOptions: clientOptions,
-		Client:        nil,
+	ctx, cancel := context.WithTimeout(context.Background(), config.Timeout())
+	clientOptions := options.Client().ApplyURI(config.URI())
+
+	return &DefaultConnHandler{
+		cancel:        cancel,
+		ctx:           ctx,
+		clientOptions: clientOptions,
 	}, nil
 }
 
 // Connect returns a new MongoDB client
-func (d *DefaultConnectionHandler) Connect() (*mongo.Client, error) {
+func (d *DefaultConnHandler) Connect() (*mongo.Client, error) {
 	// Check if the connection is already established
-	if d.Client != nil {
-		return d.Client, godatabases.ErrAlreadyConnected
+	if d.client != nil {
+		return d.client, godatabases.ErrAlreadyConnected
 	}
 
 	// Connect to MongoDB
-	client, err := mongo.Connect(d.Ctx, d.ClientOptions)
+	client, err := mongo.Connect(d.ctx, d.clientOptions)
 
 	// Create MongoDB Connection struct
 	if err != nil {
@@ -75,33 +67,31 @@ func (d *DefaultConnectionHandler) Connect() (*mongo.Client, error) {
 	}
 
 	// Set client
-	d.Client = client
+	d.client = client
 
 	return client, nil
 }
 
-// GetClient returns the MongoDB client
-func (d *DefaultConnectionHandler) GetClient() (*mongo.Client, error) {
+// Client returns the MongoDB client
+func (d *DefaultConnHandler) Client() (*mongo.Client, error) {
 	// Check if the connection is established
-	if d.Client == nil {
+	if d.client == nil {
 		return nil, godatabases.ErrNotConnected
 	}
 
-	return d.Client, nil
+	return d.client, nil
 }
 
 // Disconnect closes the MongoDB client connection
-func (d *DefaultConnectionHandler) Disconnect() {
-	defer func() {
-		// Check if the connection is established
-		if d.Client == nil {
-			return
-		}
-
-		// Close the connection
-		d.Cancel()
-		if err := d.Client.Disconnect(d.Ctx); err != nil {
-			panic(godatabases.ErrFailedToDisconnect)
-		}
-	}()
+func (d *DefaultConnHandler) Disconnect() {
+	// Check if the connection is established
+	if d.client == nil {
+		return
+	}
+
+	// Close the connection
+	d.cancel()
+	if err := d.client.Disconnect(d.ctx); err != nil {
+		panic(godatabases.ErrFailedToDisconnect)
+	}
 }

mongodb/errors.go

@@ -6,6 +6,5 @@ var (
 	ErrFailedToCreateDocument = errors.New("failed to create document")
 	ErrFailedToStartSession   = errors.New("failed to start session")
 	ErrFailedToCreateIndex    = "failed to create index '%v': %v"
-	ErrNilConfig              = errors.New("mongodb connection config cannot be nil")
 	ErrNilClient              = errors.New("mongodb client cannot be nil")
 )

mongodb/index.go

@@ -7,19 +7,19 @@ import (
 )
 
 type FieldIndex struct {
-	Name  string
-	Order Order
+	name  string
+	order Order
 }
 
 // NewFieldIndex creates a new field index
 func NewFieldIndex(name string, order Order) *FieldIndex {
-	return &FieldIndex{Name: name, Order: order}
+	return &FieldIndex{name, order}
 }
 
 // NewUniqueIndex creates a new unique field index model
 func NewUniqueIndex(fieldIndex FieldIndex, unique bool) *mongo.IndexModel {
 	return &mongo.IndexModel{
-		Keys:    bson.D{{fieldIndex.Name, fieldIndex.Order.OrderInt()}},
+		Keys:    bson.D{{fieldIndex.name, fieldIndex.order.OrderInt()}},
 		Options: options.Index().SetUnique(unique),
 	}
 }
@@ -41,7 +41,7 @@ func NewCompoundFieldIndex(
 	for _, fieldIndex := range fieldIndexes {
 		keys = append(
 			keys,
-			bson.E{Key: fieldIndex.Name, Value: fieldIndex.Order.OrderInt()},
+			bson.E{Key: fieldIndex.name, Value: fieldIndex.order.OrderInt()},
 		)
 	}
 

redis/config.go

@@ -0,0 +1,41 @@
+package redis
+
+type (
+	// Config interface
+	Config interface {
+		URI() string
+		Password() string
+		Database() int
+	}
+
+	// ConnConfig struct
+	ConnConfig struct {
+		uri      string
+		password string
+		database int
+	}
+)
+
+// NewConnConfig creates a new Redis config
+func NewConnConfig(uri, password string, database int) *ConnConfig {
+	return &ConnConfig{
+		uri,
+		password,
+		database,
+	}
+}
+
+// URI returns the URI
+func (c *ConnConfig) URI() string {
+	return c.uri
+}
+
+// Password returns the password
+func (c *ConnConfig) Password() string {
+	return c.password
+}
+
+// Database returns the database
+func (c *ConnConfig) Database() int {
+	return c.database
+}