Adding context to database provider

[mfreeman451]

Pull Request Template

Description:

• Added the ability to pass a context down through the DB provider to the Connect() call
• Connect() now returns an error.
• Currently the Connect() interface doesn't accept a context, invalid connections to databases will not be known.

Breaking Changes (if applicable):

• Connect() calls in the DB provider will now return an error and require a context to be passed.
• This breaks the ability to daisy chain method calls.

Additional Information:

• Mention any relevant dependencies or external libraries used.
• Include screenshots or code snippets (if necessary) to clarify the changes.
• Closes mongo driver doesnt support contexts #1117

Checklist:

• I have formatted my code using goimport and golangci-lint.
• All new code is covered by unit tests.
• This PR does not decrease the overall code coverage.
• I have reviewed the code comments and documentation for clarity.

Thank you for your contribution!

[vipul-rawat]

Hey @mfreeman451, the mocks have not been updated, but before that can we discuss some approaches and implementations?

I feel like AddMongo, AddClickhouse, etc... should not return any error but log the error, as we do with the SQL, Redis, etc...

One other train of thought would be to FATAL log the errors, as it would panic the code even if it starts as the handler might expect the databases to be connected.

[ccoVeille]

Here is a suggestion, feel free to consider it or ignore it

Suggested change

	// ErrInvalidURI is returned when the MongoDB URI is invalid or cannot be parsed.
	ErrInvalidURI = errors.New("invalid MongoDB URI")
	// ErrAuthentication is returned when authentication fails.
	ErrAuthentication = errors.New("authentication failed")
	// ErrDatabaseConnection is returned when the client fails to connect to the specified database.
	ErrDatabaseConnection = errors.New("failed to connect to database")
	// ErrGenericConnection is returned for general connection issues.
	ErrGenericConnection = errors.New("MongoDB connection error")
	// ErrInvalidURI is returned when the MongoDB URI is invalid or cannot be parsed.
	ErrInvalidURI = fmt.Errorf("%w: invalid MongoDB URI", ErrConnection)
	// ErrAuthentication is returned when authentication fails.
	ErrAuthentication = fmt.Errorf("%w: authentication failed", ErrConnection)
	// ErrDatabaseConnection is returned when the client fails to connect to the specified database.
	ErrDatabaseConnection = fmt.Errorf("%w: failed to connect to database", ErrConnection)
	// ErrGenericConnection is returned for general connection issues.
	ErrConnection = errors.New("MongoDB connection error")

This way the caller can catch all mongodb error with an errors.Is(err, ErrConnection)

[ccoVeille]

I have a big problem with this

Validating errors with what they contains is a bad idea

If you have no other way to do that, then you have to add a clear comment about it

[ccoVeille]

Take a look at the code

https://github.com/mongodb/mongo-go-driver/blob/b823409f1094fc54099bf64799a1e5a1d9e6fa67/x/mongo/driver/auth/auth.go#L148

An error could be caught with an errors.As, looking for auth.Error

https://pkg.go.dev/go.mongodb.org/[email protected]/x/mongo/driver/auth#Error

[ccoVeille]

Suggested change

	return fmt.Errorf("%w: client disconnected", ErrGenericConnection)
	return fmt.Errorf("%w: client disconnected: %w", ErrGenericConnection, err)

[ccoVeille]

Suggested change

	return fmt.Errorf("%w: connection timeout", ErrGenericConnection)
	return fmt.Errorf("%w: connection timeout: %w", ErrGenericConnection, err)

You should never hide low level error with yours. You should wrap them with yours

[ccoVeille]

Is there a reason to do not rely only on mongo.IsTimeOut ?

It seems strange to check if error contains a text

If you have to, something I'm not sure, you should add a comment explaining it.