Fixing connection string super bug and improving structure

Author: miguelpragier

README.md

@@ -37,6 +37,7 @@ type testDocStruct struct {
 
 func main() {
 	const (
+        appName = "my app"
 		connTimeoutSeconds         = 10 // Time to wait for the first connection
 		execTimeoutSeconds         = 10 // Time to wait for execution
 		reconnTimeoutSeconds       = 10 // Time between reconnection attempts
@@ -53,7 +54,7 @@ func main() {
 
 	log.Println("Connecting db...")
 
-	if _m, err := mongohelper.New(testConnectionString, mongohelper.OptionsNew(connTimeoutSeconds, execTimeoutSeconds, reconnTimeoutSeconds, reconnAttemptsLimit, reconnAttemptsLimitMinutes, insistOnFailure, logDebugMessages)); err != nil {
+	if _m, err := mongohelper.New(mongohelper.OptionsNew(appName,testConnectionString,connTimeoutSeconds, execTimeoutSeconds, reconnTimeoutSeconds, reconnAttemptsLimit, reconnAttemptsLimitMinutes, insistOnFailure, logDebugMessages)); err != nil {
 		log.Fatal(err)
 	} else {
 		mdb = *_m

collection.go

@@ -0,0 +1,12 @@
+package mongohelper
+
+import "go.mongodb.org/mongo-driver/mongo"
+
+// Collection returns a collection from the target database
+func (l Link) Collection(database, collection string) (*mongo.Collection, error) {
+	if err := l.linkCheck("link.Collection"); err != nil {
+		return nil, err
+	}
+
+	return l.client.Database(database).Collection(collection), nil
+}

connect.go

@@ -0,0 +1,72 @@
+package mongohelper
+
+import (
+	"context"
+	"go.mongodb.org/mongo-driver/mongo"
+	"go.mongodb.org/mongo-driver/mongo/options"
+	"go.mongodb.org/mongo-driver/mongo/readpref"
+	"time"
+)
+
+func (l Link) ping() error {
+	ctx, cancel := context.WithTimeout(context.Background(), l.connTimeout())
+
+	defer cancel()
+
+	return l.client.Ping(ctx, readpref.Primary())
+}
+
+// connect tries to conect database using the given options
+func (l *Link) connect() error {
+	var ctx context.Context
+
+	// Context with timeout can't be used in loops, because they expire before the loop complete its job
+	if l.insistOnFail() {
+		ctx = context.Background()
+	} else {
+		timeout := time.Duration(l.options.connTimeoutSeconds) * time.Second
+
+		_ctx, cancel := context.WithTimeout(context.Background(), timeout)
+
+		ctx = _ctx
+
+		defer cancel()
+	}
+
+	for {
+		var err error
+
+		opts := options.Client().ApplyURI(l.connectionString())
+		opts.SetConnectTimeout(l.connTimeout())
+		opts.SetMaxConnIdleTime(8 * time.Hour)
+		opts.SetSocketTimeout(l.execTimeout())
+		opts.SetMinPoolSize(10)
+		opts.SetAppName(l.appName())
+
+		l.client, err = mongo.Connect(ctx, opts)
+
+		if err != nil {
+			l.log("mongo.Connect", err.Error())
+		}
+
+		err = l.client.Ping(context.Background(), readpref.Primary())
+
+		if err != nil {
+			l.log("mongo.Ping", err.Error())
+		} else {
+			l.notifyConnection()
+
+			return nil
+		}
+
+		if l.insistOnFail() {
+			if l.canInsist() {
+				l.wait()
+				l.increment()
+				continue
+			}
+		}
+
+		return err
+	}
+}

countdocs.go

@@ -3,7 +3,6 @@ package mongohelper
 import (
 	"context"
 	"errors"
-	"fmt"
 	"go.mongodb.org/mongo-driver/mongo"
 	"go.mongodb.org/mongo-driver/mongo/options"
 )
@@ -15,8 +14,8 @@ import (
 // cannot be nil. An empty document (e.g. bson.D{}) should be used to count all documents in the collection. This will
 // result in a full collection scan.
 func (l *Link) CountDocs(database, collection string, filter interface{}) (int64, error) {
-	if l.client == nil {
-		return 0, fmt.Errorf("mongohelper is not connected")
+	if err := l.linkCheck("link.CountDocs"); err != nil {
+		return 0, err
 	}
 
 	ctx, cancel := context.WithTimeout(context.Background(), l.execTimeout())

deletemany.go

@@ -3,16 +3,15 @@ package mongohelper
 import (
 	"context"
 	"errors"
-	"fmt"
 	"go.mongodb.org/mongo-driver/mongo"
 	"go.mongodb.org/mongo-driver/mongo/options"
 )
 
 // DeleteMany wraps the mongo.Database.Collection.DeleteMany() method
 // It returns the number of affected records and an error
 func (l *Link) DeleteMany(database, collection string, filter interface{}) (int64, error) {
-	if l.client == nil {
-		return 0, fmt.Errorf("mongohelper is not connected")
+	if err := l.linkCheck("link.DeleteMany"); err != nil {
+		return 0, err
 	}
 
 	ctx, cancel := context.WithTimeout(context.Background(), l.execTimeout())

deleteone.go

@@ -3,16 +3,15 @@ package mongohelper
 import (
 	"context"
 	"errors"
-	"fmt"
 	"go.mongodb.org/mongo-driver/mongo"
 	"go.mongodb.org/mongo-driver/mongo/options"
 )
 
 // DeleteOne wraps the mongo.Database.Collection.DeleteOne() method
 // It returns the number of affected records and an error
 func (l *Link) DeleteOne(database, collection string, filter interface{}) (int64, error) {
-	if l.client == nil {
-		return 0, fmt.Errorf("mongohelper is not connected")
+	if err := l.linkCheck("link.DeleteOne"); err != nil {
+		return 0, err
 	}
 
 	ctx, cancel := context.WithTimeout(context.Background(), l.execTimeout())

find.go

@@ -21,8 +21,8 @@ import (
 // The filter parameter must be a document containing query operators and can be used to select which documents are
 // included in the result. An empty document (e.g. bson.D{}) should be used to include all documents.
 func (l *Link) Find(database, collection string, filter interface{}, dest interface{}) error {
-	if l.client == nil {
-		return fmt.Errorf("mongohelper is not connected")
+	if err := l.linkCheck("link.Find"); err != nil {
+		return err
 	}
 
 	if dest == nil {

findone.go

@@ -16,8 +16,8 @@ import (
 // returned. If the filter does not match any documents, a SingleResult with an error set to
 // ErrNoDocuments will be returned. If the filter matches multiple documents, one will be selected from the matched set.
 func (l *Link) FindOne(database, collection string, filter interface{}, dest interface{}) error {
-	if l.client == nil {
-		return fmt.Errorf("mongohelper is not connected")
+	if err := l.linkCheck("link.FindOne"); err != nil {
+		return err
 	}
 
 	if dest == nil {

go.mod

@@ -6,6 +6,6 @@ require (
 	github.com/klauspost/compress v1.10.7 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	go.mongodb.org/mongo-driver v1.3.3
-	golang.org/x/crypto v0.0.0-20200510223506-06a226fb4e37 // indirect
+	golang.org/x/crypto v0.0.0-20200602180216-279210d13fed // indirect
 	golang.org/x/sync v0.0.0-20200317015054-43a5402ce75a // indirect
 )

go.sum

@@ -76,17 +76,15 @@ github.com/xdg/scram v0.0.0-20180814205039-7eeb5667e42c h1:u40Z8hqBAAQyv+vATcGgV
 github.com/xdg/scram v0.0.0-20180814205039-7eeb5667e42c/go.mod h1:lB8K/P019DLNhemzwFU4jHLhdvlE6uDZjXFejJXr49I=
 github.com/xdg/stringprep v0.0.0-20180714160509-73f8eece6fdc h1:n+nNi93yXLkJvKwXNP9d55HC7lGK4H/SRcwB5IaUZLo=
 github.com/xdg/stringprep v0.0.0-20180714160509-73f8eece6fdc/go.mod h1:Jhud4/sHMO4oL310DaZAKk9ZaJ08SJfe+sJh0HrGL1Y=
-go.mongodb.org/mongo-driver v1.3.2 h1:IYppNjEV/C+/3VPbhHVxQ4t04eVW0cLp0/pNdW++6Ug=
-go.mongodb.org/mongo-driver v1.3.2/go.mod h1:MSWZXKOynuguX+JSvwP8i+58jYCXxbia8HS3gZBapIE=
 go.mongodb.org/mongo-driver v1.3.3 h1:9kX7WY6sU/5qBuhm5mdnNWdqaDAQKB2qSZOd5wMEPGQ=
 go.mongodb.org/mongo-driver v1.3.3/go.mod h1:MSWZXKOynuguX+JSvwP8i+58jYCXxbia8HS3gZBapIE=
 golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20190422162423-af44ce270edf/go.mod h1:WFFai1msRO1wXaEeE5yQxYXgSfI8pQAWXbQop6sCtWE=
 golang.org/x/crypto v0.0.0-20190530122614-20be4c3c3ed5 h1:8dUaAV7K4uHsF56JQWkprecIQKdPHtR9jCHF5nB8uzc=
 golang.org/x/crypto v0.0.0-20190530122614-20be4c3c3ed5/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
-golang.org/x/crypto v0.0.0-20200510223506-06a226fb4e37 h1:cg5LA/zNPRzIXIWSCxQW10Rvpy94aQh3LT/ShoCpkHw=
-golang.org/x/crypto v0.0.0-20200510223506-06a226fb4e37/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
+golang.org/x/crypto v0.0.0-20200602180216-279210d13fed h1:g4KENRiCMEx58Q7/ecwfT0N2o8z35Fnbsjig/Alf2T4=
+golang.org/x/crypto v0.0.0-20200602180216-279210d13fed/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/sync v0.0.0-20190227155943-e225da77a7e6/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=

insertmany.go

@@ -3,7 +3,6 @@ package mongohelper
 import (
 	"context"
 	"errors"
-	"fmt"
 	"go.mongodb.org/mongo-driver/bson/primitive"
 	"go.mongodb.org/mongo-driver/mongo"
 	"go.mongodb.org/mongo-driver/mongo/options"
@@ -12,8 +11,8 @@ import (
 // InsertMany wraps the mongo.Database.Collection.InsertMany() method
 // It returns an array with generated ObjectIDs and an error
 func (l *Link) InsertMany(database, collection string, document []interface{}) ([]string, error) {
-	if l.client == nil {
-		return []string{}, fmt.Errorf("mongohelper is not connected")
+	if err := l.linkCheck("link.InsertMany"); err != nil {
+		return []string{}, err
 	}
 
 	ctx, cancel := context.WithTimeout(context.Background(), l.execTimeout())

insertone.go

@@ -3,7 +3,6 @@ package mongohelper
 import (
 	"context"
 	"errors"
-	"fmt"
 	"go.mongodb.org/mongo-driver/bson/primitive"
 	"go.mongodb.org/mongo-driver/mongo"
 	"go.mongodb.org/mongo-driver/mongo/options"
@@ -12,8 +11,8 @@ import (
 // InsertOne wraps the mongo.Database.Collection.InsertOne() method
 // It returns the generated ObjectId and an error
 func (l *Link) InsertOne(database, collection string, document interface{}) (string, error) {
-	if l.client == nil {
-		return ``, fmt.Errorf("mongohelper is not connected")
+	if err := l.linkCheck("link.InsertOne"); err != nil {
+		return "", err
 	}
 
 	ctx, cancel := context.WithTimeout(context.Background(), l.execTimeout())

link.go

@@ -1,20 +1,16 @@
 package mongohelper
 
 import (
-	"context"
-	"fmt"
-	"go.mongodb.org/mongo-driver/mongo"
-	"go.mongodb.org/mongo-driver/mongo/options"
-	"go.mongodb.org/mongo-driver/mongo/readpref"
 	"log"
 	"time"
+
+	"go.mongodb.org/mongo-driver/mongo"
 )
 
 // Link is a concentrator wrapper for mongodb client
 type Link struct {
-	client           *mongo.Client
-	connectionString string
-	options          Options
+	client  *mongo.Client
+	options Options
 }
 
 // insistOnFail returns l.options.reconnectionInsistOnFail value
@@ -39,7 +35,7 @@ func (l Link) canInsist() bool {
 	return false
 }
 
-// wait N seconds before next 9re)connection attempt
+// wait N seconds before next (9)re)connection attempt
 func (l Link) wait() {
 	timeout := time.Duration(l.options.reconnectionSecondsBetweenAttempts) * time.Second
 
@@ -64,7 +60,7 @@ func (l *Link) notifyConnection() {
 	}
 
 	if l.options.printLogMessages {
-		log.Println("mongodb connected")
+		l.log("link.notifyConnection", "mongodb connected")
 	}
 }
 
@@ -75,86 +71,18 @@ func (l Link) log(routine, message string) {
 	}
 }
 
-// connect tries to conect database using the given options
-func (l *Link) connect() error {
-	var ctx context.Context
-
-	// Context with timeout can't be used in loops, because they expire before the loop complete its job
-	if l.insistOnFail() {
-		ctx = context.Background()
-	} else {
-		timeout := time.Duration(l.options.connectionTimeoutInSeconds) * time.Second
-
-		_ctx, cancel := context.WithTimeout(context.Background(), timeout)
-
-		ctx = _ctx
-
-		defer cancel()
-	}
-
-	for {
-		var err error
-
-		opts := options.Client().ApplyURI(l.connectionString)
-		opts.SetConnectTimeout(l.connTimeout())
-		opts.SetMaxConnIdleTime(8 * time.Hour)
-		opts.SetSocketTimeout(l.execTimeout())
-		opts.SetMinPoolSize(10)
-
-		l.client, err = mongo.Connect(ctx)
-
-		if err != nil {
-			l.log("mongo.Connect", err.Error())
-		}
-
-		err = l.client.Ping(context.Background(), readpref.Primary())
-
-		if err != nil {
-			l.log("mongo.Ping", err.Error())
-		} else {
-			l.notifyConnection()
-
-			return nil
-		}
-
-		if l.insistOnFail() {
-			if l.canInsist() {
-				l.wait()
-				l.increment()
-				continue
-			}
-		}
+func (l Link) appName() string {
+	return l.options.appName
+}
 
-		return err
-	}
+func (l Link) connectionString() string {
+	return l.options.connString
 }
 
 func (l Link) connTimeout() time.Duration {
-	return time.Duration(l.options.connectionTimeoutInSeconds) * time.Second
+	return time.Duration(l.options.connTimeoutSeconds) * time.Second
 }
 
 func (l Link) execTimeout() time.Duration {
-	return time.Duration(l.options.executionTimeoutInSeconds) * time.Second
-}
-
-// quickPing tries to reach the database in 10 seconds
-func (l Link) quickPing() error {
-	ctx, cancel := context.WithTimeout(context.Background(), l.connTimeout())
-
-	defer cancel()
-
-	return l.client.Ping(ctx, readpref.Primary())
-}
-
-// Collection returns a collection from the target database
-func (l Link) Collection(database, collection string) (*mongo.Collection, error) {
-	if l.client == nil {
-		return nil, fmt.Errorf("use of uninitialized connection")
-	}
-
-	if err := l.quickPing(); err != nil {
-		return nil, err
-	}
-
-	return l.client.Database(database).Collection(collection), nil
+	return time.Duration(l.options.execTimeoutSeconds) * time.Second
 }

linkcheck.go

@@ -0,0 +1,13 @@
+package mongohelper
+
+import "fmt"
+
+func (l Link) linkCheck(routine string) error {
+	if l.client == nil {
+		l.log(routine, "use of uninitialized connection")
+
+		return fmt.Errorf("use of uninitialized connection")
+	}
+
+	return nil
+}