GODRIVER-3434 Revert builder-lister pattern for client options #1899

prestonvasquez · 2024-11-21T19:51:29Z

Summary

Don't apply the builder-lister pattern for client options.

Background & Motivation

This update has been a source of frustration for users migrating to the v2 beta. While the lister-builder pattern is effective for operational options, client options are often defined as struct literals and used in test / general comparison within a users code. For example:

opts := options.Client().SetAppName("x")

// ...

if opts.AppName != nil && opts.AppName == "x" {
    // do something
}

While this isn't too difficult to manage in v2, it does require a code change. The primarily discussed alternative is to apply a Merge function to ClientOptionsBuilder. However, this would still require a code change and is kind of confusing for people who aren't familiar with the history of the problem in the Go Driver. This PR suggests deferring that question to v3, as client options are rather unique.

mongodb-drivers-pr-bot · 2024-11-21T19:53:42Z

API Change Report

./v2/mongo

incompatible changes

##Connect: changed from func(..../v2/mongo/options.Lister[./v2/mongo/options.ClientOptions]) (Client, error) to func(..../v2/mongo/options.ClientOptions) (*Client, error)

./v2/mongo/options

incompatible changes

(*AutoEncryptionOptionsBuilder).List: removed
(*AutoEncryptionOptionsBuilder).SetKeyVaultClientOptions: changed from func(Lister[ClientOptions]) *AutoEncryptionOptionsBuilder to func(*ClientOptions) *AutoEncryptionOptions
(*ClientOptionsBuilder).List: removed
(*ClientOptionsBuilder).SetAutoEncryptionOptions: changed from func(Lister[AutoEncryptionOptions]) *ClientOptionsBuilder to func(*AutoEncryptionOptions) *ClientOptions
(*ClientOptionsBuilder).SetLoggerOptions: changed from func(Lister[LoggerOptions]) *ClientOptionsBuilder to func(*LoggerOptions) *ClientOptions
(*ClientOptionsBuilder).SetServerAPIOptions: changed from func(Lister[ServerAPIOptions]) *ClientOptionsBuilder to func(*ServerAPIOptions) *ClientOptions
(*LoggerOptionsBuilder).List: removed
(*ServerAPIOptionsBuilder).List: removed
AutoEncryptionOptions.KeyVaultClientOptions: changed from Lister[ClientOptions] to *ClientOptions
AutoEncryptionOptionsBuilder.Opts: removed
AutoEncryptionOptionsBuilder: removed
ClientOptions.AutoEncryptionOptions: changed from Lister[AutoEncryptionOptions] to *AutoEncryptionOptions
ClientOptions.LoggerOptions: changed from Lister[LoggerOptions] to *LoggerOptions
ClientOptions.ServerAPIOptions: changed from Lister[ServerAPIOptions] to *ServerAPIOptions
ClientOptionsBuilder.Opts: removed
ClientOptionsBuilder: removed
LoggerOptionsBuilder.Opts: removed
LoggerOptionsBuilder: removed
ServerAPIOptionsBuilder.Opts: removed
ServerAPIOptionsBuilder: removed

compatible changes

(*AutoEncryptionOptions).SetBypassAutoEncryption: added
(*AutoEncryptionOptions).SetBypassQueryAnalysis: added
(*AutoEncryptionOptions).SetEncryptedFieldsMap: added
(*AutoEncryptionOptions).SetExtraOptions: added
(*AutoEncryptionOptions).SetKeyVaultClientOptions: added
(*AutoEncryptionOptions).SetKeyVaultNamespace: added
(*AutoEncryptionOptions).SetKmsProviders: added
(*AutoEncryptionOptions).SetSchemaMap: added
(*AutoEncryptionOptions).SetTLSConfig: added
(*ClientOptions).ApplyURI: added
(*ClientOptions).SetAppName: added
(*ClientOptions).SetAuth: added
(*ClientOptions).SetAutoEncryptionOptions: added
(*ClientOptions).SetBSONOptions: added
(*ClientOptions).SetCompressors: added
(*ClientOptions).SetConnectTimeout: added
(*ClientOptions).SetDialer: added
(*ClientOptions).SetDirect: added
(*ClientOptions).SetDisableOCSPEndpointCheck: added
(*ClientOptions).SetDriverInfo: added
(*ClientOptions).SetHTTPClient: added
(*ClientOptions).SetHeartbeatInterval: added
(*ClientOptions).SetHosts: added
(*ClientOptions).SetLoadBalanced: added
(*ClientOptions).SetLocalThreshold: added
(*ClientOptions).SetLoggerOptions: added
(*ClientOptions).SetMaxConnIdleTime: added
(*ClientOptions).SetMaxConnecting: added
(*ClientOptions).SetMaxPoolSize: added
(*ClientOptions).SetMinPoolSize: added
(*ClientOptions).SetMonitor: added
(*ClientOptions).SetPoolMonitor: added
(*ClientOptions).SetReadConcern: added
(*ClientOptions).SetReadPreference: added
(*ClientOptions).SetRegistry: added
(*ClientOptions).SetReplicaSet: added
(*ClientOptions).SetRetryReads: added
(*ClientOptions).SetRetryWrites: added
(*ClientOptions).SetSRVMaxHosts: added
(*ClientOptions).SetSRVServiceName: added
(*ClientOptions).SetServerAPIOptions: added
(*ClientOptions).SetServerMonitor: added
(*ClientOptions).SetServerMonitoringMode: added
(*ClientOptions).SetServerSelectionTimeout: added
(*ClientOptions).SetTLSConfig: added
(*ClientOptions).SetTimeout: added
(*ClientOptions).SetWriteConcern: added
(*ClientOptions).SetZlibLevel: added
(*ClientOptions).SetZstdLevel: added
(*ClientOptions).Validate: added
(*LoggerOptions).SetComponentLevel: added
(*LoggerOptions).SetMaxDocumentLength: added
(*LoggerOptions).SetSink: added
(*ServerAPIOptions).SetDeprecationErrors: added
(*ServerAPIOptions).SetStrict: added
AutoEncryptionOptionsBuilder.BypassAutoEncryption: added
AutoEncryptionOptionsBuilder.BypassQueryAnalysis: added
AutoEncryptionOptionsBuilder.EncryptedFieldsMap: added
AutoEncryptionOptionsBuilder.ExtraOptions: added
AutoEncryptionOptionsBuilder.HTTPClient: added
AutoEncryptionOptionsBuilder.KeyVaultClientOptions: added
AutoEncryptionOptionsBuilder.KeyVaultNamespace: added
AutoEncryptionOptionsBuilder.KmsProviders: added
AutoEncryptionOptionsBuilder.SchemaMap: added
AutoEncryptionOptionsBuilder.TLSConfig: added
ClientOptionsBuilder.AppName: added
ClientOptionsBuilder.Auth: added
ClientOptionsBuilder.AutoEncryptionOptions: added
ClientOptionsBuilder.BSONOptions: added
ClientOptionsBuilder.Compressors: added
ClientOptionsBuilder.ConnectTimeout: added
ClientOptionsBuilder.Crypt: added
ClientOptionsBuilder.Deployment: added
ClientOptionsBuilder.Dialer: added
ClientOptionsBuilder.Direct: added
ClientOptionsBuilder.DisableOCSPEndpointCheck: added
ClientOptionsBuilder.DriverInfo: added
ClientOptionsBuilder.HTTPClient: added
ClientOptionsBuilder.HeartbeatInterval: added
ClientOptionsBuilder.Hosts: added
ClientOptionsBuilder.LoadBalanced: added
ClientOptionsBuilder.LocalThreshold: added
ClientOptionsBuilder.LoggerOptions: added
ClientOptionsBuilder.MaxConnIdleTime: added
ClientOptionsBuilder.MaxConnecting: added
ClientOptionsBuilder.MaxPoolSize: added
ClientOptionsBuilder.MinPoolSize: added
ClientOptionsBuilder.Monitor: added
ClientOptionsBuilder.PoolMonitor: added
ClientOptionsBuilder.ReadConcern: added
ClientOptionsBuilder.ReadPreference: added
ClientOptionsBuilder.Registry: added
ClientOptionsBuilder.ReplicaSet: added
ClientOptionsBuilder.RetryReads: added
ClientOptionsBuilder.RetryWrites: added
ClientOptionsBuilder.SRVMaxHosts: added
ClientOptionsBuilder.SRVServiceName: added
ClientOptionsBuilder.ServerAPIOptions: added
ClientOptionsBuilder.ServerMonitor: added
ClientOptionsBuilder.ServerMonitoringMode: added
ClientOptionsBuilder.ServerSelectionTimeout: added
ClientOptionsBuilder.TLSConfig: added
ClientOptionsBuilder.Timeout: added
ClientOptionsBuilder.WriteConcern: added
ClientOptionsBuilder.ZlibLevel: added
ClientOptionsBuilder.ZstdLevel: added
LoggerOptionsBuilder.ComponentLevels: added
LoggerOptionsBuilder.MaxDocumentLength: added
LoggerOptionsBuilder.Sink: added
MergeClientOptions: added
ServerAPIOptionsBuilder.DeprecationErrors: added
ServerAPIOptionsBuilder.ServerAPIVersion: added
ServerAPIOptionsBuilder.Strict: added

./v2/x/mongo/driver/topology

incompatible changes

##ConvertToDriverAPIOptions: changed from func(./v2/mongo/options.Lister[./v2/mongo/options.ServerAPIOptions]) ./v2/x/mongo/driver.ServerAPIOptions to func(./v2/mongo/options.ServerAPIOptions) ./v2/x/mongo/driver.ServerAPIOptions
##NewConfig: changed from func(./v2/mongo/options.ClientOptionsBuilder, *./v2/x/mongo/driver/session.ClusterClock) (Config, error) to func(./v2/mongo/options.ClientOptions, *./v2/x/mongo/driver/session.ClusterClock) (*Config, error)
NewConfigFromOptions: removed

…iver into GODRIVER-3434

This reverts commit fa6cb74.

This reverts commit 6132140.

qingyang-hu

LGTM

matthewdale · 2024-12-04T03:46:19Z

mongo/options/clientoptions.go

-
-		return nil
-	})
+func (c *ClientOptions) SetAutoEncryptionOptions(aeopts Lister[AutoEncryptionOptions]) *ClientOptions {


For AutoEncryptionOptions, LoggerOptions, and ServerAPIOptions, should we also revert to the previous pattern (i.e. not use of Lister type)?

…iver into GODRIVER-3434

matthewdale

Looks good! 👍

mongo/options/serverapioptions.go

mongo/client.go

qingyang-hu

It looks good other than some typos.

Co-authored-by: Qingyang Hu <[email protected]>

qingyang-hu

👍

GODRIVER-3434 Revert builder-lister pattern for client options

e821f2d

prestonvasquez marked this pull request as draft November 21, 2024 19:52

mongodb-drivers-pr-bot bot added the review-priority-low Low Priority PR for Review: within 3 business days label Nov 21, 2024

prestonvasquez added review-priority-urgent High Priority PR for Review: review immediately! and removed review-priority-low Low Priority PR for Review: within 3 business days labels Nov 21, 2024

prestonvasquez added 8 commits November 21, 2024 12:59

GODRIER-3434 Fix license in CSE test

a10d403

Merge branch 'master' into GODRIVER-3434

0b8261e

GODRIVER-3434 Rename args to clientOpts in newClient

fa6cb74

Merge branch 'GODRIVER-3434' of github.com:prestonvasquez/mongo-go-dr…

239e3f0

…iver into GODRIVER-3434

GODRIVER-3434 Add MergeClientOptions tests back

41ab684

Revert "GODRIVER-3434 Rename args to clientOpts in newClient"

6132140

This reverts commit fa6cb74.

Revert "Revert "GODRIVER-3434 Rename args to clientOpts in newClient""

930d177

This reverts commit 6132140.

GODRIVER-3434 Fix memory deallocaiton issue

05e9a7e

prestonvasquez marked this pull request as ready for review November 21, 2024 22:11

prestonvasquez requested a review from matthewdale November 21, 2024 22:11

alcaeus requested a review from qingyang-hu November 25, 2024 15:42

Merge branch 'master' into GODRIVER-3434

ff9edf6

qingyang-hu previously approved these changes Dec 3, 2024

View reviewed changes

matthewdale reviewed Dec 4, 2024

View reviewed changes

prestonvasquez added 3 commits December 4, 2024 11:12

Merge branch 'master' into GODRIVER-3434

ad9c732

GODRIVER-3434 Revert lister-builder pattern for client suboptions

b0038e6

Merge branch 'GODRIVER-3434' of github.com:prestonvasquez/mongo-go-dr…

eec8ca4

…iver into GODRIVER-3434

prestonvasquez dismissed qingyang-hu’s stale review via eec8ca4 December 4, 2024 21:21

prestonvasquez requested review from matthewdale and qingyang-hu December 4, 2024 21:21

matthewdale previously approved these changes Dec 4, 2024

View reviewed changes

qingyang-hu reviewed Dec 4, 2024

View reviewed changes

mongo/options/serverapioptions.go Outdated Show resolved Hide resolved

qingyang-hu reviewed Dec 4, 2024

View reviewed changes

mongo/client.go Show resolved Hide resolved

qingyang-hu requested changes Dec 4, 2024

View reviewed changes

prestonvasquez dismissed matthewdale’s stale review via 53fd79f December 4, 2024 21:58

prestonvasquez and others added 2 commits December 4, 2024 14:58

Update mongo/client.go

53fd79f

Co-authored-by: Qingyang Hu <[email protected]>

Update mongo/options/serverapioptions.go

683ed58

Co-authored-by: Qingyang Hu <[email protected]>

prestonvasquez requested review from matthewdale and qingyang-hu December 4, 2024 21:59

qingyang-hu approved these changes Dec 4, 2024

View reviewed changes

matthewdale approved these changes Dec 4, 2024

View reviewed changes

prestonvasquez merged commit 17a547f into mongodb:master Dec 5, 2024
28 of 35 checks passed

prestonvasquez deleted the GODRIVER-3434 branch December 5, 2024 00:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

GODRIVER-3434 Revert builder-lister pattern for client options #1899

GODRIVER-3434 Revert builder-lister pattern for client options #1899

Uh oh!

prestonvasquez commented Nov 21, 2024

Uh oh!

mongodb-drivers-pr-bot bot commented Nov 21, 2024 •

edited

Loading

Uh oh!

qingyang-hu left a comment

Uh oh!

matthewdale Dec 4, 2024

Uh oh!

matthewdale left a comment

Uh oh!

Uh oh!

Uh oh!

qingyang-hu left a comment

Uh oh!

qingyang-hu left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

GODRIVER-3434 Revert builder-lister pattern for client options #1899

GODRIVER-3434 Revert builder-lister pattern for client options #1899

Uh oh!

Conversation

prestonvasquez commented Nov 21, 2024

Summary

Background & Motivation

Uh oh!

mongodb-drivers-pr-bot bot commented Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Change Report

./v2/mongo

incompatible changes

./v2/mongo/options

incompatible changes

compatible changes

./v2/x/mongo/driver/topology

incompatible changes

Uh oh!

qingyang-hu left a comment

Choose a reason for hiding this comment

Uh oh!

matthewdale Dec 4, 2024

Choose a reason for hiding this comment

Uh oh!

matthewdale left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

qingyang-hu left a comment

Choose a reason for hiding this comment

Uh oh!

qingyang-hu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mongodb-drivers-pr-bot bot commented Nov 21, 2024 •

edited

Loading