Add ability to customize some timeouts in MongoDB database plugin #11600
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| ```release-note:improvement | ||
| secrets/database/mongodb: Add ability to customize `SocketTimeout`, `ConnectTimeout`, and `ServerSelectionTimeout` | ||
| ``` | ||
| ```release-note:improvement | ||
| secrets/database/mongodb: Increased throughput by allowing for multiple request threads to simultaneously update users in MongoDB | ||
| ``` | ||
| ```release-note:bug | ||
| secrets/database: Fixed minor race condition when rotate-root is called | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,6 +13,7 @@ import ( | |
| "github.com/hashicorp/errwrap" | ||
| "github.com/hashicorp/vault/sdk/database/helper/connutil" | ||
| "github.com/hashicorp/vault/sdk/database/helper/dbutil" | ||
| "github.com/mitchellh/mapstructure" | ||
| "go.mongodb.org/mongo-driver/mongo" | ||
| "go.mongodb.org/mongo-driver/mongo/options" | ||
| "go.mongodb.org/mongo-driver/mongo/readpref" | ||
|
|
@@ -31,6 +32,10 @@ type mongoDBConnectionProducer struct { | |
| TLSCertificateKeyData []byte `json:"tls_certificate_key" structs:"-" mapstructure:"tls_certificate_key"` | ||
| TLSCAData []byte `json:"tls_ca" structs:"-" mapstructure:"tls_ca"` | ||
|
|
||
| SocketTimeout time.Duration `json:"socket_timeout" structs:"-" mapstructure:"socket_timeout"` | ||
| ConnectTimeout time.Duration `json:"connect_timeout" structs:"-" mapstructure:"connect_timeout"` | ||
| ServerSelectionTimeout time.Duration `json:"server_selection_timeout" structs:"-" mapstructure:"server_selection_timeout"` | ||
|
|
||
| Initialized bool | ||
| RawConfig map[string]interface{} | ||
| Type string | ||
|
|
@@ -48,15 +53,47 @@ type writeConcern struct { | |
| J bool // Sync via the journal if present | ||
| } | ||
|
|
||
| func (c *mongoDBConnectionProducer) loadConfig(cfg map[string]interface{}) error { | ||
| err := mapstructure.WeakDecode(cfg, c) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if len(c.ConnectionURL) == 0 { | ||
| return fmt.Errorf("connection_url cannot be empty") | ||
| } | ||
|
|
||
| if c.SocketTimeout < 0 { | ||
| return fmt.Errorf("socket_timeout must be >= 0") | ||
| } | ||
| if c.ConnectTimeout < 0 { | ||
| return fmt.Errorf("connect_timeout must be >= 0") | ||
| } | ||
| if c.ServerSelectionTimeout < 0 { | ||
| return fmt.Errorf("server_selection_timeout must be >= 0") | ||
| } | ||
|
|
||
| opts, err := c.makeClientOpts() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| c.clientOptions = opts | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // Connection creates or returns an existing a database connection. If the session fails | ||
| // on a ping check, the session will be closed and then re-created. | ||
| // This method does locks the mutex on its own. | ||
| func (c *mongoDBConnectionProducer) Connection(ctx context.Context) (*mongo.Client, error) { | ||
| if !c.Initialized { | ||
| return nil, connutil.ErrNotInitialized | ||
| } | ||
|
|
||
| c.Mutex.Lock() | ||
| defer c.Mutex.Unlock() | ||
|
|
||
| if c.client != nil { | ||
| if err := c.client.Ping(ctx, readpref.Primary()); err == nil { | ||
| return c.client, nil | ||
|
|
@@ -65,23 +102,22 @@ func (c *mongoDBConnectionProducer) Connection(ctx context.Context) (interface{} | |
| _ = c.client.Disconnect(ctx) | ||
| } | ||
|
|
||
| client, err := c.createClient(ctx) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| c.client = client | ||
| return c.client, nil | ||
| } | ||
|
|
||
| func (c *mongoDBConnectionProducer) createClient(ctx context.Context) (client *mongo.Client, err error) { | ||
| if !c.Initialized { | ||
| return nil, fmt.Errorf("failed to create client: connection producer is not initialized") | ||
| } | ||
| if c.clientOptions == nil { | ||
| return nil, fmt.Errorf("missing client options") | ||
| } | ||
| client, err = mongo.Connect(ctx, options.MergeClientOptions(options.Client().ApplyURI(c.getConnectionURL()), c.clientOptions)) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
@@ -120,6 +156,26 @@ func (c *mongoDBConnectionProducer) getConnectionURL() (connURL string) { | |
| return connURL | ||
| } | ||
|
|
||
| func (c *mongoDBConnectionProducer) makeClientOpts() (*options.ClientOptions, error) { | ||
| writeOpts, err := c.getWriteConcern() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| authOpts, err := c.getTLSAuth() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| timeoutOpts, err := c.getTimeoutOpts() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| opts := options.MergeClientOptions(writeOpts, authOpts, timeoutOpts) | ||
| return opts, nil | ||
| } | ||
|
|
||
| func (c *mongoDBConnectionProducer) getWriteConcern() (opts *options.ClientOptions, err error) { | ||
| if c.WriteConcern == "" { | ||
| return nil, nil | ||
|
|
@@ -206,3 +262,29 @@ func (c *mongoDBConnectionProducer) getTLSAuth() (opts *options.ClientOptions, e | |
| opts.SetTLSConfig(tlsConfig) | ||
| return opts, nil | ||
| } | ||
|
|
||
| func (c *mongoDBConnectionProducer) getTimeoutOpts() (opts *options.ClientOptions, err error) { | ||
|
There was a problem hiding this comment. nit: Getters don't have to include the There was a problem hiding this comment. Agreed that we should try to be consistent about this, however I argue that this isn't a getter. This is creating a new There was a problem hiding this comment. I think that |
||
| opts = options.Client() | ||
|
|
||
| if c.SocketTimeout < 0 { | ||
| return nil, fmt.Errorf("socket_timeout must be >= 0") | ||
| } | ||
|
|
||
| if c.SocketTimeout == 0 { | ||
| opts.SetSocketTimeout(1 * time.Minute) | ||
| } else { | ||
| opts.SetSocketTimeout(c.SocketTimeout) | ||
| } | ||
|
|
||
| if c.ConnectTimeout == 0 { | ||
| opts.SetConnectTimeout(1 * time.Minute) | ||
| } else { | ||
| opts.SetConnectTimeout(c.ConnectTimeout) | ||
| } | ||
|
|
||
| if c.ServerSelectionTimeout != 0 { | ||
| opts.SetServerSelectionTimeout(c.ServerSelectionTimeout) | ||
| } | ||
|
|
||
| return opts, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it make sense to also move the
dbilock/unlock up so that it's before the lambda defer func above? We're modifyingdbithere so we should have that lock held before releasing it right?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch! I don't think we strictly need to since the DBI instance is being removed and shouldn't be referenced by anything else at this point, but I'll move the dbi lock up just to be safe.