Skip to content

GODRIVER-3502: Refactor and remove builder pattern for MongoCryptOptions #2278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RafaelCenzano merged 13 commits into from
Jan 9, 2026
+47 −180
Merged

GODRIVER-3502: Refactor and remove builder pattern for MongoCryptOptions #2278

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
4039902
refactor: use struct literal instead of builder pattern
RafaelCenzano Jan 2, 2026
1499c99
refactor: use struct literal instead of builder pattern
RafaelCenzano Jan 2, 2026
3350f07
refactor: remove uneeded builder pattern functions for MongoCryptOptions
RafaelCenzano Jan 2, 2026
d87a039
chore: readd relevant comments
RafaelCenzano Jan 2, 2026
87be7b3
refactor: replace use of builder pattern with struct literal in tests
RafaelCenzano Jan 2, 2026
d0b152b
refactor: remove builder pattern for DataKeyOptions
RafaelCenzano Jan 6, 2026
792bb86
refactor: remove builder pattern for ExplicitEncryptionOptions
RafaelCenzano Jan 6, 2026
c6dffd7
refactor: remove builder pattern for RewrapManyDataKeyOptions
RafaelCenzano Jan 6, 2026
bc0e891
test: remove setters from tests
RafaelCenzano Jan 6, 2026
049f1dd
refactor: remove uneeded code and use struct literal syntax
RafaelCenzano Jan 7, 2026
0e017d0
Merge branch 'master' into refactor/remove-uneeded-setters-godriver-3502
RafaelCenzano Jan 7, 2026
17866ca
refactor: remove uneeded code and use struct literal syntax
RafaelCenzano Jan 7, 2026
6645c1a
refactor: remove uneeded code and use struct literal syntax
RafaelCenzano Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions mongo/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -651,15 +651,16 @@ func (c *Client) newMongoCrypt(opts *options.AutoEncryptionOptions) (*mongocrypt
bypassAutoEncryption := opts.BypassAutoEncryption != nil && *opts.BypassAutoEncryption
bypassQueryAnalysis := opts.BypassQueryAnalysis != nil && *opts.BypassQueryAnalysis

mc, err := mongocrypt.NewMongoCrypt(mcopts.MongoCrypt().
SetKmsProviders(kmsProviders).
SetLocalSchemaMap(cryptSchemaMap).
SetBypassQueryAnalysis(bypassQueryAnalysis).
SetEncryptedFieldsMap(cryptEncryptedFieldsMap).
SetCryptSharedLibDisabled(cryptSharedLibDisabled || bypassAutoEncryption).
SetCryptSharedLibOverridePath(cryptSharedLibPath).
SetHTTPClient(opts.HTTPClient).
SetKeyExpiration(opts.KeyExpiration))
mc, err := mongocrypt.NewMongoCrypt(&mcopts.MongoCryptOptions{
KmsProviders: kmsProviders,
LocalSchemaMap: cryptSchemaMap,
BypassQueryAnalysis: bypassQueryAnalysis,
EncryptedFieldsMap: cryptEncryptedFieldsMap,
CryptSharedLibDisabled: cryptSharedLibDisabled || bypassAutoEncryption,
CryptSharedLibOverridePath: cryptSharedLibPath,
HTTPClient: opts.HTTPClient,
KeyExpiration: opts.KeyExpiration,
})
if err != nil {
return nil, err
}
Expand Down
39 changes: 21 additions & 18 deletions mongo/client_encryption.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,15 @@ func NewClientEncryption(keyVaultClient *Client, opts ...options.Lister[options.
return nil, fmt.Errorf("error creating KMS providers map: %w", err)
}

mc, err := mongocrypt.NewMongoCrypt(mcopts.MongoCrypt().
SetKmsProviders(kmsProviders).
mc, err := mongocrypt.NewMongoCrypt(&mcopts.MongoCryptOptions{
KmsProviders: kmsProviders,
// Explicitly disable loading the crypt_shared library for the Crypt used for
// ClientEncryption because it's only needed for AutoEncryption and we don't expect users to
// have the crypt_shared library installed if they're using ClientEncryption.
SetCryptSharedLibDisabled(true).
SetHTTPClient(cea.HTTPClient).
SetKeyExpiration(cea.KeyExpiration))
CryptSharedLibDisabled: true,
HTTPClient: cea.HTTPClient,
KeyExpiration: cea.KeyExpiration,
})
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -173,7 +174,9 @@ func (ce *ClientEncryption) CreateDataKey(
return bson.Binary{}, fmt.Errorf("failed to construct options from builder: %w", err)
}

co := mcopts.DataKey().SetKeyAltNames(args.KeyAltNames)
co := &mcopts.DataKeyOptions{
KeyAltNames: args.KeyAltNames,
}
if args.MasterKey != nil {
keyDoc, err := marshal(
args.MasterKey,
Expand All @@ -182,10 +185,10 @@ func (ce *ClientEncryption) CreateDataKey(
if err != nil {
return bson.Binary{}, err
}
co.SetMasterKey(keyDoc)
co.MasterKey = keyDoc
}
if args.KeyMaterial != nil {
co.SetKeyMaterial(args.KeyMaterial)
co.KeyMaterial = args.KeyMaterial
}
Copy link
Collaborator

@qingyang-hu qingyang-hu Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Nitpicking] This block can be merged into L177-L179, the initialization of co.


// create data key document
Expand All @@ -208,18 +211,18 @@ func (ce *ClientEncryption) CreateDataKey(
func transformExplicitEncryptionOptions(opts ...options.Lister[options.EncryptOptions]) *mcopts.ExplicitEncryptionOptions {
args, _ := mongoutil.NewOptions[options.EncryptOptions](opts...)

transformed := mcopts.ExplicitEncryption()
transformed := &mcopts.ExplicitEncryptionOptions{}
if args.KeyID != nil {
transformed.SetKeyID(*args.KeyID)
transformed.KeyID = args.KeyID
}
if args.KeyAltName != nil {
transformed.SetKeyAltName(*args.KeyAltName)
transformed.KeyAltName = args.KeyAltName
}
transformed.SetAlgorithm(args.Algorithm)
transformed.SetQueryType(args.QueryType)
transformed.Algorithm = args.Algorithm
transformed.QueryType = args.QueryType

if args.ContentionFactor != nil {
transformed.SetContentionFactor(*args.ContentionFactor)
transformed.ContentionFactor = args.ContentionFactor
}
Copy link
Collaborator

@matthewdale matthewdale Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional: Because we're now assigning these directly without dereferencing and using setters, we can use struct literal syntax for these fields.

E.g.

transformed := &mcopts.ExplicitEncryptionOptions{
	KeyID: args.KeyID,
	KeyAltName: args.KeyAltName,
	Algorithm: args.Algorithm,
	QueryType: args.QueryType,
	ContentionFactor: args.ContentionFactor,
}

Copy link
Contributor Author

@RafaelCenzano RafaelCenzano Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea I updated the code to use this. Simplifies the code and cuts down on the number of lines, I always feel like that is the best outcome when possible.


if args.RangeOptions != nil {
Expand All @@ -241,7 +244,7 @@ func transformExplicitEncryptionOptions(opts ...options.Lister[options.EncryptOp
if rangeArgs.TrimFactor != nil {
transformedRange.TrimFactor = rangeArgs.TrimFactor
}
transformed.SetRangeOptions(transformedRange)
transformed.RangeOptions = &transformedRange
}
return transformed
}
Expand Down Expand Up @@ -468,7 +471,7 @@ func (ce *ClientEncryption) RewrapManyDataKey(
}

// Transfer rmdko options to /x/ package options to publish the mongocrypt feed.
co := mcopts.RewrapManyDataKey()
co := &mcopts.RewrapManyDataKeyOptions{}
if args.MasterKey != nil {
keyDoc, err := marshal(
args.MasterKey,
Expand All @@ -477,10 +480,10 @@ func (ce *ClientEncryption) RewrapManyDataKey(
if err != nil {
return nil, err
}
co.SetMasterKey(keyDoc)
co.MasterKey = keyDoc
}
if args.Provider != nil {
co.SetProvider(*args.Provider)
co.Provider = args.Provider
}
Copy link
Collaborator

@qingyang-hu qingyang-hu Jan 7, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Nitpicking] This block can be merged into L468.


// Prepare the filters and rewrap the data key using mongocrypt.
Expand Down
6 changes: 4 additions & 2 deletions x/mongo/driver/mongocrypt/binary_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ func createEncryptedDocForBench(b *testing.B, crypt *MongoCrypt, iter int) bsonc
Data: []byte("aaaaaaaaaaaaaaaa"),
}

encryptOpts := options.ExplicitEncryption().SetAlgorithm(algorithm).SetKeyID(keyID)
encryptOpts := &options.ExplicitEncryptionOptions{Algorithm: algorithm, KeyID: &keyID}
doc := bsoncore.NewDocumentBuilder().AppendString("v", fmt.Sprintf("value %04v", iter)).Build()

encryptCtx, err := crypt.CreateExplicitEncryptionContext(doc, encryptOpts)
Expand Down Expand Up @@ -141,7 +141,9 @@ func newCryptForBench(b *testing.B) *MongoCrypt {
AppendDocument("local", localProvider).
Build()

cryptOpts := options.MongoCrypt().SetKmsProviders(kmsProviders)
cryptOpts := &options.MongoCryptOptions{
KmsProviders: kmsProviders,
}

crypt, err := NewMongoCrypt(cryptOpts)

Expand Down
16 changes: 11 additions & 5 deletions x/mongo/driver/mongocrypt/mongocrypt_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,9 @@ func createMongoCrypt(t *testing.T) *MongoCrypt {
AppendDocument("local", localProvider).
Build()

cryptOpts := options.MongoCrypt().SetKmsProviders(kmsProviders)
cryptOpts := &options.MongoCryptOptions{
KmsProviders: kmsProviders,
}
crypt, err := NewMongoCrypt(cryptOpts)
noerr(t, err)
if crypt == nil {
Expand Down Expand Up @@ -216,7 +218,10 @@ func TestMongoCrypt(t *testing.T) {
AppendString("secretAccessKey", "example").
FinishDocument().
Build()
cryptOpts := options.MongoCrypt().SetKmsProviders(kmsProviders).SetLocalSchemaMap(schemaMap)
cryptOpts := &options.MongoCryptOptions{
KmsProviders: kmsProviders,
LocalSchemaMap: schemaMap,
}
crypt, err := NewMongoCrypt(cryptOpts)
noerr(t, err)
defer crypt.Close()
Expand Down Expand Up @@ -289,7 +294,7 @@ func TestMongoCrypt(t *testing.T) {
masterKey, _ = bsoncore.AppendDocumentEnd(masterKey, midx)

// create data key context and check initial state
dataKeyOpts := options.DataKey().SetMasterKey(masterKey)
dataKeyOpts := &options.DataKeyOptions{MasterKey: masterKey}
dataKeyCtx, err := crypt.CreateDataKeyContext("local", dataKeyOpts)
noerr(t, err)
defer dataKeyCtx.Close()
Expand Down Expand Up @@ -320,7 +325,7 @@ func TestMongoCrypt(t *testing.T) {
Subtype: 0x04, // 0x04 is UUID subtype
Data: []byte("aaaaaaaaaaaaaaaa"),
}
opts := options.ExplicitEncryption().SetKeyID(keyID).SetAlgorithm(algorithm)
opts := &options.ExplicitEncryptionOptions{KeyID: &keyID, Algorithm: algorithm}
encryptCtx, err := crypt.CreateExplicitEncryptionContext(originalDoc, opts)
noerr(t, err)
defer encryptCtx.Close()
Expand Down Expand Up @@ -353,7 +358,8 @@ func TestMongoCrypt(t *testing.T) {
defer crypt.Close()

// create explicit encryption context and check initial state
opts := options.ExplicitEncryption().SetKeyAltName("altKeyName").SetAlgorithm(algorithm)
keyAltName := "altKeyName"
opts := &options.ExplicitEncryptionOptions{KeyAltName: &keyAltName, Algorithm: algorithm}
encryptCtx, err := crypt.CreateExplicitEncryptionContext(originalDoc, opts)
noerr(t, err)
defer encryptCtx.Close()
Expand Down
81 changes: 0 additions & 81 deletions x/mongo/driver/mongocrypt/options/mongocrypt_context_options.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,29 +18,6 @@ type DataKeyOptions struct {
MasterKey bsoncore.Document
}

// DataKey creates a new DataKeyOptions instance.
func DataKey() *DataKeyOptions {
return &DataKeyOptions{}
}

// SetKeyAltNames specifies alternate key names.
func (dko *DataKeyOptions) SetKeyAltNames(names []string) *DataKeyOptions {
dko.KeyAltNames = names
return dko
}

// SetMasterKey specifies the master key.
func (dko *DataKeyOptions) SetMasterKey(key bsoncore.Document) *DataKeyOptions {
dko.MasterKey = key
return dko
}

// SetKeyMaterial specifies the key material.
func (dko *DataKeyOptions) SetKeyMaterial(keyMaterial []byte) *DataKeyOptions {
dko.KeyMaterial = keyMaterial
return dko
}

// QueryType describes the type of query the result of Encrypt is used for.
type QueryType int

Expand Down Expand Up @@ -68,47 +45,6 @@ type ExplicitRangeOptions struct {
Precision *int32
}

// ExplicitEncryption creates a new ExplicitEncryptionOptions instance.
func ExplicitEncryption() *ExplicitEncryptionOptions {
return &ExplicitEncryptionOptions{}
}

// SetKeyID sets the key identifier.
func (eeo *ExplicitEncryptionOptions) SetKeyID(keyID bson.Binary) *ExplicitEncryptionOptions {
eeo.KeyID = &keyID
return eeo
}

// SetKeyAltName sets the key alternative name.
func (eeo *ExplicitEncryptionOptions) SetKeyAltName(keyAltName string) *ExplicitEncryptionOptions {
eeo.KeyAltName = &keyAltName
return eeo
}

// SetAlgorithm specifies an encryption algorithm.
func (eeo *ExplicitEncryptionOptions) SetAlgorithm(algorithm string) *ExplicitEncryptionOptions {
eeo.Algorithm = algorithm
return eeo
}

// SetQueryType specifies the query type.
func (eeo *ExplicitEncryptionOptions) SetQueryType(queryType string) *ExplicitEncryptionOptions {
eeo.QueryType = queryType
return eeo
}

// SetContentionFactor specifies the contention factor.
func (eeo *ExplicitEncryptionOptions) SetContentionFactor(contentionFactor int64) *ExplicitEncryptionOptions {
eeo.ContentionFactor = &contentionFactor
return eeo
}

// SetRangeOptions specifies the range options.
func (eeo *ExplicitEncryptionOptions) SetRangeOptions(ro ExplicitRangeOptions) *ExplicitEncryptionOptions {
eeo.RangeOptions = &ro
return eeo
}

// RewrapManyDataKeyOptions represents all possible options used to decrypt and encrypt all matching data keys with a
// possibly new masterKey.
type RewrapManyDataKeyOptions struct {
Expand All @@ -118,20 +54,3 @@ type RewrapManyDataKeyOptions struct {
// MasterKey identifies the new masterKey. If omitted, rewraps with the current masterKey.
MasterKey bsoncore.Document
}

// RewrapManyDataKey creates a new RewrapManyDataKeyOptions instance.
func RewrapManyDataKey() *RewrapManyDataKeyOptions {
return new(RewrapManyDataKeyOptions)
}

// SetProvider sets the value for the Provider field.
func (rmdko *RewrapManyDataKeyOptions) SetProvider(provider string) *RewrapManyDataKeyOptions {
rmdko.Provider = &provider
return rmdko
}

// SetMasterKey sets the value for the MasterKey field.
func (rmdko *RewrapManyDataKeyOptions) SetMasterKey(masterKey bsoncore.Document) *RewrapManyDataKeyOptions {
rmdko.MasterKey = masterKey
return rmdko
}
55 changes: 0 additions & 55 deletions x/mongo/driver/mongocrypt/options/mongocrypt_options.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,58 +24,3 @@ type MongoCryptOptions struct {
HTTPClient *http.Client
KeyExpiration *time.Duration
}

// MongoCrypt creates a new MongoCryptOptions instance.
func MongoCrypt() *MongoCryptOptions {
return &MongoCryptOptions{}
}

// SetKmsProviders specifies the KMS providers map.
func (mo *MongoCryptOptions) SetKmsProviders(kmsProviders bsoncore.Document) *MongoCryptOptions {
mo.KmsProviders = kmsProviders
return mo
}

// SetLocalSchemaMap specifies the local schema map.
func (mo *MongoCryptOptions) SetLocalSchemaMap(localSchemaMap map[string]bsoncore.Document) *MongoCryptOptions {
mo.LocalSchemaMap = localSchemaMap
return mo
}

// SetBypassQueryAnalysis skips the NeedMongoMarkings state.
func (mo *MongoCryptOptions) SetBypassQueryAnalysis(bypassQueryAnalysis bool) *MongoCryptOptions {
mo.BypassQueryAnalysis = bypassQueryAnalysis
return mo
}

// SetEncryptedFieldsMap specifies the encrypted fields map.
func (mo *MongoCryptOptions) SetEncryptedFieldsMap(efcMap map[string]bsoncore.Document) *MongoCryptOptions {
mo.EncryptedFieldsMap = efcMap
return mo
}

// SetCryptSharedLibDisabled explicitly disables loading the crypt_shared library if set to true.
func (mo *MongoCryptOptions) SetCryptSharedLibDisabled(disabled bool) *MongoCryptOptions {
mo.CryptSharedLibDisabled = disabled
return mo
}

// SetCryptSharedLibOverridePath sets the override path to the crypt_shared library file. Setting
// an override path disables the default operating system dynamic library search path.
func (mo *MongoCryptOptions) SetCryptSharedLibOverridePath(path string) *MongoCryptOptions {
mo.CryptSharedLibOverridePath = path
return mo
}

// SetHTTPClient sets the http client.
func (mo *MongoCryptOptions) SetHTTPClient(httpClient *http.Client) *MongoCryptOptions {
mo.HTTPClient = httpClient
return mo
}

// SetKeyExpiration sets the key expiration duration. 0 means "never expire".
// The granularity is in milliseconds. Any sub-millisecond fraction will be rounded up.
func (mo *MongoCryptOptions) SetKeyExpiration(expiration *time.Duration) *MongoCryptOptions {
mo.KeyExpiration = expiration
return mo
}
Loading