feat: Added MongoDB and Redis connection handlers and helper functions

* Added MongoDB and Redis connection handlers
* Added MongoDB helper functions to create FindOne, Find and Update options, to create Collections and their Indexes (SingleFieldIndexes, CompoundIndexes, TTL Indexes)
* Forked from 'github.com/pixel-plaza-dev/uru-databases-2-go-service-common'

Author: ralvarezdev

.gitignore

@@ -0,0 +1,19 @@
+# IDE folders
+/.idea
+/.vscode
+
+# Environment variables
+/**/*.env
+
+# Executable files
+/**/*.exe
+
+# Private and public keys
+/**/*.ed
+/**/*.pub
+/**/*.pem
+
+# Commands
+/**/*.cmd
+/**/*.sh
+/**/*.bat

errors.go

@@ -0,0 +1,12 @@
+package go_databases
+
+import "errors"
+
+var (
+	AlreadyConnectedError   = errors.New("connection to database already established")
+	FailedToConnectError    = errors.New("failed to connect to database")
+	FailedToPingError       = errors.New("failed to ping database")
+	NotConnectedError       = errors.New("connection to database not established")
+	FailedToDisconnectError = errors.New("failed to disconnect from database")
+	InternalServerError     = errors.New("internal server error")
+)

go.mod

@@ -0,0 +1,25 @@
+module github.com/ralvarezdev/go-databases
+
+go 1.23.4
+
+require (
+	github.com/go-redis/redis/v8 v8.11.5
+	github.com/ralvarezdev/go-logger v0.1.0
+	go.mongodb.org/mongo-driver v1.17.1
+	golang.org/x/net v0.33.0
+)
+
+require (
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
+	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
+	github.com/golang/snappy v0.0.4 // indirect
+	github.com/klauspost/compress v1.13.6 // indirect
+	github.com/montanaflynn/stats v0.7.1 // 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
+	github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78 // indirect
+	golang.org/x/crypto v0.31.0 // indirect
+	golang.org/x/sync v0.10.0 // indirect
+	golang.org/x/text v0.21.0 // indirect
+)

go.sum

@@ -0,0 +1,74 @@
+github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
+github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78=
+github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=
+github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4=
+github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ=
+github.com/go-redis/redis/v8 v8.11.5 h1:AcZZR7igkdvfVmQTPnu9WE37LRrO/YrBH5zWyjDC0oI=
+github.com/go-redis/redis/v8 v8.11.5/go.mod h1:gREzHqY1hg6oD9ngVRbLStwAWKhA0FEgq8Jd4h5lpwo=
+github.com/golang/snappy v0.0.4 h1:yAGX7huGHXlcLOEtBnF4w7FQwA26wojNCwOYAEhLjQM=
+github.com/golang/snappy v0.0.4/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
+github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/klauspost/compress v1.13.6 h1:P76CopJELS0TiO2mebmnzgWaajssP/EszplttgQxcgc=
+github.com/klauspost/compress v1.13.6/go.mod h1:/3/Vjq9QcHkK5uEr5lBEmyoZ1iFhe47etQ6QUkpK6sk=
+github.com/montanaflynn/stats v0.7.1 h1:etflOAAHORrCC44V+aR6Ftzort912ZU+YLiSTuV8eaE=
+github.com/montanaflynn/stats v0.7.1/go.mod h1:etXPPgVO6n31NxCd9KQUMvCM+ve0ruNzt6R8Bnaayow=
+github.com/nxadm/tail v1.4.8 h1:nPr65rt6Y5JFSKQO7qToXr7pePgD6Gwiw05lkbyAQTE=
+github.com/nxadm/tail v1.4.8/go.mod h1:+ncqLTQzXmGhMZNUePPaPqPvBxHAIsmXswZKocGu+AU=
+github.com/onsi/ginkgo v1.16.5 h1:8xi0RTUf59SOSfEtZMvwTvXYMzG4gV23XVHOZiXNtnE=
+github.com/onsi/ginkgo v1.16.5/go.mod h1:+E8gABHa3K6zRBolWtd+ROzc/U5bkGt0FwiG042wbpU=
+github.com/onsi/gomega v1.18.1 h1:M1GfJqGRrBrrGGsbxzV5dqM2U2ApXefZCQpkukxYRLE=
+github.com/onsi/gomega v1.18.1/go.mod h1:0q+aL8jAiMXy9hbwj2mr5GziHiwhAIQpFmmtT5hitRs=
+github.com/ralvarezdev/go-logger v0.1.0 h1:i2AI1nlxU6Hizvk75Vc8wtFydiVrqIeeRbJwiuO/69A=
+github.com/ralvarezdev/go-logger v0.1.0/go.mod h1:v5OvFrkS+wsYNTCVegXWiRhBtcYrQJr4LDMDntvpAos=
+github.com/xdg-go/pbkdf2 v1.0.0 h1:Su7DPu48wXMwC3bs7MCNG+z4FhcyEuz5dlvchbq0B0c=
+github.com/xdg-go/pbkdf2 v1.0.0/go.mod h1:jrpuAogTd400dnrH08LKmI/xc1MbPOebTwRqcT5RDeI=
+github.com/xdg-go/scram v1.1.2 h1:FHX5I5B4i4hKRVRBCFRxq1iQRej7WO3hhBuJf+UUySY=
+github.com/xdg-go/scram v1.1.2/go.mod h1:RT/sEzTbU5y00aCK8UOx6R7YryM0iF1N2MOmC3kKLN4=
+github.com/xdg-go/stringprep v1.0.4 h1:XLI/Ng3O1Atzq0oBs3TWm+5ZVgkq2aqdlvP9JtoZ6c8=
+github.com/xdg-go/stringprep v1.0.4/go.mod h1:mPGuuIYwz7CmR2bT9j4GbQqutWS1zV24gijq1dTyGkM=
+github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78 h1:ilQV1hzziu+LLM3zUTJ0trRztfwgjqKnBWNtSRkbmwM=
+github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78/go.mod h1:aL8wCCfTfSfmXjznFBSZNN13rSJjlIOI1fUNAtF7rmI=
+github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
+go.mongodb.org/mongo-driver v1.17.1 h1:Wic5cJIwJgSpBhe3lx3+/RybR5PiYRMpVFgO7cOHyIM=
+go.mongodb.org/mongo-driver v1.17.1/go.mod h1:wwWm/+BuOddhcq3n68LKRmgk2wXzmF6s0SFOa0GINL4=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
+golang.org/x/crypto v0.31.0 h1:ihbySMvVjLAeSH1IbfcRTkD/iNscyz8rGzjF/E5hV6U=
+golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk=
+golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
+golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
+golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
+golang.org/x/net v0.33.0 h1:74SYHlV8BIgHIFC/LrYkOGIwL19eTYXQ5wc6TBuO36I=
+golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4=
+golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.10.0 h1:3NQrjDixjgGwUOCaF8w2+VYHv0Ve/vGYSbdkTa98gmQ=
+golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA=
+golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
+golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ=
+golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=
+golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
+golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ=
+gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw=
+gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
+gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=

logger.go

@@ -0,0 +1,31 @@
+package go_databases
+
+import (
+	gologger "github.com/ralvarezdev/go-logger"
+	gologgerstatus "github.com/ralvarezdev/go-logger/status"
+)
+
+// Logger is the logger for the database connection
+type Logger struct {
+	logger gologger.Logger
+}
+
+// NewLogger is the logger for the database connection
+func NewLogger(logger gologger.Logger) (*Logger, error) {
+	// Check if the logger is nil
+	if logger == nil {
+		return nil, gologger.NilLoggerError
+	}
+
+	return &Logger{logger: logger}, nil
+}
+
+// ConnectedToDatabase logs a success message when the server connects to the database
+func (l *Logger) ConnectedToDatabase() {
+	l.logger.LogMessage(gologger.NewLogMessage("connected to database", gologgerstatus.StatusDebug, nil))
+}
+
+// DisconnectedFromDatabase logs a success message when the server disconnects from the database
+func (l *Logger) DisconnectedFromDatabase() {
+	l.logger.LogMessage(gologger.NewLogMessage("disconnected from database", gologgerstatus.StatusDebug, nil))
+}

mongodb/collection.go

@@ -0,0 +1,60 @@
+package mongodb
+
+import (
+	"fmt"
+	"go.mongodb.org/mongo-driver/mongo"
+	"golang.org/x/net/context"
+)
+
+// Collection represents a MongoDB collection
+type Collection struct {
+	Name    string
+	Indexes *[]*mongo.IndexModel
+}
+
+// NewCollection creates a new MongoDB collection
+func NewCollection(
+	name string,
+	indexes *[]*mongo.IndexModel,
+) *Collection {
+	return &Collection{
+		Name:    name,
+		Indexes: indexes,
+	}
+}
+
+// CreateCollection creates the collection
+func (c *Collection) CreateCollection(database *mongo.Database) (
+	collection *mongo.Collection, err error,
+) {
+	// Get the collection
+	collection = database.Collection(c.Name)
+
+	// Create the indexes
+	if err = c.createIndexes(collection); err != nil {
+		return nil, err
+	}
+
+	return collection, nil
+}
+
+// createIndexes creates the indexes for the collection
+func (c *Collection) createIndexes(collection *mongo.Collection) (err error) {
+	if c.Indexes != nil {
+		for _, index := range *c.Indexes {
+			// Check if the index is nil
+			if index == nil {
+				continue
+			}
+
+			// Create the index
+			_, err = collection.Indexes().CreateOne(
+				context.Background(), *index,
+			)
+			if err != nil {
+				return fmt.Errorf(FailedToCreateIndexError, *index)
+			}
+		}
+	}
+	return nil
+}

mongodb/connection.go

@@ -0,0 +1,104 @@
+package mongodb
+
+import (
+	godatabases "github.com/ralvarezdev/go-databases"
+	"go.mongodb.org/mongo-driver/mongo"
+	"go.mongodb.org/mongo-driver/mongo/options"
+	"golang.org/x/net/context"
+	"time"
+)
+
+type (
+	// ConnectionHandler interface
+	ConnectionHandler interface {
+		Connect() (*mongo.Client, error)
+		GetClient() (*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
+	}
+)
+
+// NewDefaultConnectionHandler creates a new connection
+func NewDefaultConnectionHandler(config *Config) (*DefaultConnectionHandler, error) {
+	// Check if the config is nil
+	if config == nil {
+		return nil, NilClientError
+	}
+
+	// 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,
+	}, nil
+}
+
+// Connect returns a new MongoDB client
+func (d *DefaultConnectionHandler) Connect() (*mongo.Client, error) {
+	// Check if the connection is already established
+	if d.Client != nil {
+		return d.Client, godatabases.AlreadyConnectedError
+	}
+
+	// Connect to MongoDB
+	client, err := mongo.Connect(d.Ctx, d.ClientOptions)
+
+	// Create MongoDB Connection struct
+	if err != nil {
+		return nil, godatabases.FailedToConnectError
+	}
+
+	// Check the connection
+	err = client.Ping(context.Background(), nil)
+	if err != nil {
+		return nil, godatabases.FailedToPingError
+	}
+
+	// Set client
+	d.Client = client
+
+	return client, nil
+}
+
+// GetClient returns the MongoDB client
+func (d *DefaultConnectionHandler) GetClient() (*mongo.Client, error) {
+	// Check if the connection is established
+	if d.Client == nil {
+		return nil, godatabases.NotConnectedError
+	}
+
+	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.FailedToDisconnectError)
+		}
+	}()
+}

mongodb/errors.go

@@ -0,0 +1,11 @@
+package mongodb
+
+import "errors"
+
+var (
+	FailedToCreateDocumentError = errors.New("failed to create document")
+	FailedToStartSessionError   = errors.New("failed to start session")
+	FailedToCreateIndexError    = "failed to create index: %v"
+	NilConfigError              = errors.New("mongodb connection config cannot be nil")
+	NilClientError              = errors.New("mongodb client cannot be nil")
+)

mongodb/index.go

@@ -0,0 +1,53 @@
+package mongodb
+
+import (
+	"go.mongodb.org/mongo-driver/bson"
+	"go.mongodb.org/mongo-driver/mongo"
+	"go.mongodb.org/mongo-driver/mongo/options"
+)
+
+type FieldIndex struct {
+	Name  string
+	Order Order
+}
+
+// NewFieldIndex creates a new field index
+func NewFieldIndex(name string, order Order) *FieldIndex {
+	return &FieldIndex{Name: name, Order: 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()}},
+		Options: options.Index().SetUnique(unique),
+	}
+}
+
+// NewTTLIndex creates a new TTL index model
+func NewTTLIndex(fieldName string, expireAfterSeconds int32) *mongo.IndexModel {
+	return &mongo.IndexModel{
+		Keys:    bson.D{{fieldName, 1}},
+		Options: options.Index().SetExpireAfterSeconds(expireAfterSeconds),
+	}
+}
+
+// NewCompoundFieldIndex creates a new compound field index model
+func NewCompoundFieldIndex(
+	fieldIndexes []*FieldIndex, unique bool,
+) *mongo.IndexModel {
+	// Create the keys
+	keys := bson.D{}
+	for _, fieldIndex := range fieldIndexes {
+		keys = append(
+			keys,
+			bson.E{Key: fieldIndex.Name, Value: fieldIndex.Order.OrderInt()},
+		)
+	}
+
+	// Create the index model
+	return &mongo.IndexModel{
+		Keys:    keys,
+		Options: options.Index().SetUnique(unique),
+	}
+}