Merge pull request #17 from taimaifika/release/v1.5.3

Enhance MongoDB component with additional configuration options and methods

Author: taimh3

component/mongodbc/mongodbc.go

@@ -2,6 +2,7 @@ package mongodbc
 
 import (
 	"context"
+	"errors"
 	"flag"
 	"log/slog"
 	"time"
@@ -13,10 +14,16 @@ import (
 )
 
 type config struct {
-	url      string
-	username string
-	password string
-	timeout  time.Duration
+	url                    string
+	username               string
+	password               string
+	authMechanism          string
+	authSource             string
+	maxPoolSize            uint64
+	minPoolSize            uint64
+	timeout                time.Duration
+	connectionTimeout      time.Duration
+	ServerSelectionTimeout time.Duration
 }
 
 type mongoDbComponent struct {
@@ -34,39 +41,93 @@ func NewMongoDbComponent(id string) *mongoDbComponent {
 	}
 }
 
+// GetMongoClient returns the mongo client
 func (m *mongoDbComponent) GetMongoClient() *mongo.Client {
 	return m.mongoClient
 }
 
+// GetMongoClientWithName returns the mongo client with the given name in config
+func (m *mongoDbComponent) GetDatabase() *mongo.Database {
+	return m.mongoClient.Database(m.config.authSource)
+}
+
+// GetCollection returns the mongo client with the given collection name
+func (m *mongoDbComponent) GetCollection(collectionName string) *mongo.Collection {
+	return m.mongoClient.Database(m.config.authSource).Collection(collectionName)
+}
+
+// GetDatabaseName returns the mongo client with the given name in config
+func (m *mongoDbComponent) GetDatabaseName() string {
+	return m.config.authSource
+}
+
+// GetDatabaseWithName returns the mongo client with the given name
+func (m *mongoDbComponent) GetDatabaseWithName(dbName string) *mongo.Database {
+	return m.mongoClient.Database(dbName)
+}
+
+// GetCollection returns the mongo client with the given name
+func (m *mongoDbComponent) GetCollectionWithDatabase(dbName, collectionName string) *mongo.Collection {
+	return m.mongoClient.Database(dbName).Collection(collectionName)
+}
+
 func (m *mongoDbComponent) ID() string {
 	return m.id
 }
 
 func (m *mongoDbComponent) InitFlags() {
 	flag.StringVar(&m.url, m.id+"-url", "mongodb://localhost:27017", "redis urls. default: mongodb://localhost:27017")
-	flag.StringVar(&m.username, m.id+"-username", "", "redis username. default: ''")
-	flag.StringVar(&m.password, m.id+"-password", "", "redis password. default: ''")
 
-	flag.DurationVar(&m.timeout, m.id+"-timeout", 10*time.Second, "redis timeout. default: 10s")
+	flag.StringVar(&m.username, m.id+"-username", "", "mongodb username. default: ''")
+	flag.StringVar(&m.password, m.id+"-password", "", "mongodb password. default: ''")
+	flag.StringVar(&m.authMechanism, m.id+"-auth-mechanism", "SCRAM-SHA-256", "AuthMechanism supported values include SCRAM-SHA-256, SCRAM-SHA-1, MONGODB-CR, PLAIN, GSSAPI, MONGODB-X509, and MONGODB-AWS. default: 'SCRAM-SHA-256'")
+	flag.StringVar(&m.authSource, m.id+"-auth-source", "", "AuthSource. default: ''")
+
+	flag.Uint64Var(&m.minPoolSize, m.id+"-min-pool-size", 10, "mongodb min pool size. default: 10")
+	flag.Uint64Var(&m.maxPoolSize, m.id+"-max-pool-size", 100, "mongodb max pool size. default: 100")
+
+	flag.DurationVar(&m.timeout, m.id+"-timeout", 10*time.Second, "mongodb timeout. default: 10s")
+	flag.DurationVar(&m.connectionTimeout, m.id+"-connection-timeout", 30*time.Second, "mongodb connection timeout. default: 30s")
+	flag.DurationVar(&m.ServerSelectionTimeout, m.id+"-server-selection-timeout", 30*time.Second, "mongodb server selection timeout. default: 30s")
+
 }
 
 func (m *mongoDbComponent) Activate(ctx sctx.ServiceContext) error {
 	// create mongo client
 	opts := options.Client()
 	// set url
 	opts.ApplyURI(m.url)
+
+	// set min pool size
+	opts.SetMinPoolSize(m.minPoolSize)
+
+	// set max pool size
+	opts.SetMaxPoolSize(m.maxPoolSize)
+
 	// set timeout
 	opts.SetTimeout(m.timeout)
 
-	// set auth
+	// set connection timeout
+	opts.SetConnectTimeout(m.connectionTimeout)
+
+	// set ConnectTimeout
+	opts.SetServerSelectionTimeout(m.ServerSelectionTimeout)
+
+	// set auth database
 	if m.username != "" && m.password != "" {
 		opts.SetAuth(options.Credential{
-			Username: m.username,
-			Password: m.password,
+			Username:      m.username,
+			Password:      m.password,
+			AuthMechanism: m.authMechanism,
+			AuthSource:    m.authSource,
 		})
 	}
+	// validate auth source, return err
+	if opts.Auth.AuthSource == "" {
+		return errors.New("auth source is empty")
+	}
 
-	slog.Info("Connecting to mongo db")
+	slog.Info("Connecting to mongo db ...")
 
 	client, err := mongo.Connect(opts)
 	if err != nil {
@@ -81,7 +142,7 @@ func (m *mongoDbComponent) Activate(ctx sctx.ServiceContext) error {
 
 	m.mongoClient = client
 
-	slog.Info("Connect to mongo db success")
+	slog.Info("Connect to mongo db success !!!")
 
 	return nil
 }

examples/mongodbcomp/.env.example

@@ -1,21 +1,33 @@
 # Env for service. Ex: dev | stg | prd (-app-env)
 APP_ENV="dev"
 
-# Log format: text | json . Default json (-log-format)
-LOG_FORMAT="json"
+# AuthMechanism supported values include SCRAM-SHA-256, SCRAM-SHA-1, MONGODB-CR, PLAIN, GSSAPI, MONGODB-X509, and MONGODB-AWS. default: 'SCRAM-SHA-256' (-mongodb-auth-mechanism)
+MONGODB_AUTH_MECHANISM="SCRAM-SHA-256"
 
-# Log level: panic | fatal | error | warn | info | debug | trace (-log-level)
-LOG_LEVEL="trace"
+# AuthSource. default: '' (-mongodb-auth-source)
+MONGODB_AUTH_SOURCE=
 
-# redis password. default: '' (-mongodb-password)
+# mongodb connection timeout. default: 30s (-mongodb-connection-timeout)
+MONGODB_CONNECTION_TIMEOUT=30s
+
+# mongodb max pool size. default: 100 (-mongodb-max-pool-size)
+MONGODB_MAX_POOL_SIZE=100
+
+# mongodb min pool size. default: 10 (-mongodb-min-pool-size)
+MONGODB_MIN_POOL_SIZE=10
+
+# mongodb password. default: '' (-mongodb-password)
 MONGODB_PASSWORD=
 
-# redis timeout. default: 10s (-mongodb-timeout)
+# mongodb server selection timeout. default: 30s (-mongodb-server-selection-timeout)
+MONGODB_SERVER_SELECTION_TIMEOUT=30s
+
+# mongodb timeout. default: 10s (-mongodb-timeout)
 MONGODB_TIMEOUT=10s
 
 # redis urls. default: mongodb://localhost:27017 (-mongodb-url)
 MONGODB_URL="mongodb://localhost:27017"
 
-# redis username. default: '' (-mongodb-username)
+# mongodb username. default: '' (-mongodb-username)
 MONGODB_USERNAME=
 

examples/mongodbcomp/cmd/root.go

@@ -22,6 +22,7 @@ func newServiceCtx() sctx.ServiceContext {
 
 type MongoDbComponent interface {
 	GetMongoClient() *mongo.Client
+	GetDatabaseName() string
 }
 
 var rootCmd = &cobra.Command{
@@ -38,17 +39,18 @@ var rootCmd = &cobra.Command{
 		// get mongodb component
 		mongoDbComponent := serviceCtx.MustGet("mongodb").(MongoDbComponent)
 		mongoClient := mongoDbComponent.GetMongoClient()
+		databaseName := mongoDbComponent.GetDatabaseName()
 
 		// insert data
-		res, err := mongoClient.Database("test").Collection("test").InsertOne(context.Background(), map[string]string{"test": "test"})
+		res, err := mongoClient.Database(databaseName).Collection("test").InsertOne(context.Background(), map[string]string{"test": "test"})
 		if err != nil {
 			slog.Error("insert data error", "error", err)
 		}
 		fmt.Println(res)
 
 		// get all data
 		var result []map[string]interface{}
-		cursor, err := mongoClient.Database("test").Collection("test").Find(
+		cursor, err := mongoClient.Database(databaseName).Collection("test").Find(
 			context.Background(), bson.M{
 				"test": "test",
 			})
@@ -73,15 +75,15 @@ var rootCmd = &cobra.Command{
 			slog.Error("convert id to object id error", "error", err)
 		}
 		filter := bson.M{"_id": objID}
-		err = mongoClient.Database("test").Collection("test").FindOne(
+		err = mongoClient.Database(databaseName).Collection("test").FindOne(
 			context.Background(), filter).Decode(&resultOne)
 		if err != nil {
 			slog.Error("find one data error", "error", err)
 		}
 		fmt.Println(resultOne)
 
 		// delete data
-		_, err = mongoClient.Database("test").Collection("test").DeleteOne(context.Background(), bson.M{"test": "test"})
+		_, err = mongoClient.Database(databaseName).Collection("test").DeleteOne(context.Background(), bson.M{"test": "test"})
 		if err != nil {
 			slog.Error("delete data error", "error", err)
 		}

go.mod

@@ -114,7 +114,7 @@ require (
 	github.com/spf13/pflag v1.0.6 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	github.com/ugorji/go/codec v1.2.12 // indirect
-	go.mongodb.org/mongo-driver/v2 v2.1.0
+	go.mongodb.org/mongo-driver/v2 v2.2.0
 	go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin v0.60.0
 	golang.org/x/arch v0.15.0 // indirect
 	golang.org/x/crypto v0.36.0 // indirect

go.sum

@@ -237,8 +237,8 @@ github.com/xdg-go/stringprep v1.0.4/go.mod h1:mPGuuIYwz7CmR2bT9j4GbQqutWS1zV24gi
 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/v2 v2.1.0 h1:/ELnVNjmfUKDsoBisXxuJL0noR9CfeUIrP7Yt3R+egg=
-go.mongodb.org/mongo-driver/v2 v2.1.0/go.mod h1:AWiLRShSrk5RHQS3AEn3RL19rqOzVq49MCpWQ3x/huI=
+go.mongodb.org/mongo-driver/v2 v2.2.0 h1:WwhNgGrijwU56ps9RtIsgKfGLEZeypxqbEYfThrBScM=
+go.mongodb.org/mongo-driver/v2 v2.2.0/go.mod h1:qQkDMhCGWl3FN509DfdPd4GRBLU/41zqF/k8eTRceps=
 go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=
 go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=
 go.opentelemetry.io/contrib/bridges/otelslog v0.10.0 h1:lRKWBp9nWoBe1HKXzc3ovkro7YZSb72X2+3zYNxfXiU=