Skip to content
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

Jump to bottom

GODRIVER-3168 Retry KMS requests on transient errors. #1887

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

GODRIVER-3168 Retry KMS requests on transient errors. #1887

wants to merge 5 commits into from

Conversation

qingyang-hu
Copy link
Collaborator

@qingyang-hu qingyang-hu commented Nov 11, 2024 •
edited
Loading

@mongodb-drivers-pr-bot mongodb-drivers-pr-bot bot added the priority-3-low Low Priority PR for Review label Nov 11, 2024
@mongodb-drivers-pr-bot mongodb-drivers-pr-bot
Copy link
Contributor

mongodb-drivers-pr-bot bot commented Nov 11, 2024 •
edited
Loading

API Change Report

./v2/mongo

incompatible changes

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

./v2/mongo/options

incompatible changes

(*AutoEncryptionOptions).SetBypassAutoEncryption: removed
(*AutoEncryptionOptions).SetBypassQueryAnalysis: removed
(*AutoEncryptionOptions).SetEncryptedFieldsMap: removed
(*AutoEncryptionOptions).SetExtraOptions: removed
(*AutoEncryptionOptions).SetKeyVaultClientOptions: removed
(*AutoEncryptionOptions).SetKeyVaultNamespace: removed
(*AutoEncryptionOptions).SetKmsProviders: removed
(*AutoEncryptionOptions).SetSchemaMap: removed
(*AutoEncryptionOptions).SetTLSConfig: removed
(*ClientOptions).ApplyURI: removed
(*ClientOptions).SetAppName: removed
(*ClientOptions).SetAuth: removed
(*ClientOptions).SetAutoEncryptionOptions: removed
(*ClientOptions).SetBSONOptions: removed
(*ClientOptions).SetCompressors: removed
(*ClientOptions).SetConnectTimeout: removed
(*ClientOptions).SetDialer: removed
(*ClientOptions).SetDirect: removed
(*ClientOptions).SetDisableOCSPEndpointCheck: removed
(*ClientOptions).SetDriverInfo: removed
(*ClientOptions).SetHTTPClient: removed
(*ClientOptions).SetHeartbeatInterval: removed
(*ClientOptions).SetHosts: removed
(*ClientOptions).SetLoadBalanced: removed
(*ClientOptions).SetLocalThreshold: removed
(*ClientOptions).SetLoggerOptions: removed
(*ClientOptions).SetMaxConnIdleTime: removed
(*ClientOptions).SetMaxConnecting: removed
(*ClientOptions).SetMaxPoolSize: removed
(*ClientOptions).SetMinPoolSize: removed
(*ClientOptions).SetMonitor: removed
(*ClientOptions).SetPoolMonitor: removed
(*ClientOptions).SetReadConcern: removed
(*ClientOptions).SetReadPreference: removed
(*ClientOptions).SetRegistry: removed
(*ClientOptions).SetReplicaSet: removed
(*ClientOptions).SetRetryReads: removed
(*ClientOptions).SetRetryWrites: removed
(*ClientOptions).SetSRVMaxHosts: removed
(*ClientOptions).SetSRVServiceName: removed
(*ClientOptions).SetServerAPIOptions: removed
(*ClientOptions).SetServerMonitor: removed
(*ClientOptions).SetServerMonitoringMode: removed
(*ClientOptions).SetServerSelectionTimeout: removed
(*ClientOptions).SetTLSConfig: removed
(*ClientOptions).SetTimeout: removed
(*ClientOptions).SetWriteConcern: removed
(*ClientOptions).SetZlibLevel: removed
(*ClientOptions).SetZstdLevel: removed
(*ClientOptions).Validate: removed
(*DistinctOptionsBuilder).SetHint: removed
(*FindOneOptionsBuilder).SetOplogReplay: removed
(*FindOptionsBuilder).SetOplogReplay: removed
(*LoggerOptions).SetComponentLevel: removed
(*LoggerOptions).SetMaxDocumentLength: removed
(*LoggerOptions).SetSink: removed
(*ServerAPIOptions).SetDeprecationErrors: removed
(*ServerAPIOptions).SetStrict: removed
AutoEncryption: changed from func() *AutoEncryptionOptions to func() *AutoEncryptionOptionsBuilder
AutoEncryptionOptions.KeyVaultClientOptions: changed from *ClientOptions to Lister[ClientOptions]
Client: changed from func() *ClientOptions to func() *ClientOptionsBuilder
ClientOptions.AutoEncryptionOptions: changed from *AutoEncryptionOptions to Lister[AutoEncryptionOptions]
ClientOptions.DriverInfo: removed
ClientOptions.LoggerOptions: changed from *LoggerOptions to Lister[LoggerOptions]
ClientOptions.ServerAPIOptions: changed from *ServerAPIOptions to Lister[ServerAPIOptions]
DistinctOptions.Hint: removed
DriverInfo: removed
FindOneOptions.OplogReplay: removed
FindOptions.OplogReplay: removed
Logger: changed from func() *LoggerOptions to func() *LoggerOptionsBuilder
MergeClientOptions: removed
ServerAPI: changed from func(ServerAPIVersion) *ServerAPIOptions to func(ServerAPIVersion) *ServerAPIOptionsBuilder

compatible changes

AutoEncryptionOptionsBuilder: added
ClientOptionsBuilder: added
LoggerOptionsBuilder: added
ServerAPIOptionsBuilder: added

./v2/x/mongo/driver/auth

incompatible changes

HandshakeOptions.OuterLibraryName: removed
HandshakeOptions.OuterLibraryPlatform: removed
HandshakeOptions.OuterLibraryVersion: removed

./v2/x/mongo/driver/mongocrypt

compatible changes

(*KmsContext).RequestError: added

./v2/x/mongo/driver/operation

incompatible changes

(*Distinct).Hint: removed
(*Hello).OuterLibraryName: removed
(*Hello).OuterLibraryPlatform: removed
(*Hello).OuterLibraryVersion: removed

./v2/x/mongo/driver/topology

incompatible changes

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

compatible changes

NewConfigFromOptions: added

@qingyang-hu qingyang-hu force-pushed the godriver3168 branch 5 times, most recently from b11c2a5 to 93ebd31 Compare November 11, 2024 19:25
@qingyang-hu qingyang-hu force-pushed the godriver3168 branch 6 times, most recently from 4d94342 to fd682b7 Compare November 13, 2024 16:38
@qingyang-hu qingyang-hu force-pushed the godriver3168 branch 4 times, most recently from 6ecb7c2 to ddc0900 Compare November 20, 2024 17:02
@qingyang-hu qingyang-hu force-pushed the godriver3168 branch 5 times, most recently from 77cf4a1 to d4a0765 Compare November 20, 2024 21:49
@qingyang-hu qingyang-hu force-pushed the godriver3168 branch 5 times, most recently from 074d596 to 50549f6 Compare November 25, 2024 23:59
@qingyang-hu qingyang-hu force-pushed the godriver3168 branch 12 times, most recently from 58a6a49 to db03cdf Compare December 2, 2024 21:43
@qingyang-hu qingyang-hu marked this pull request as ready for review December 2, 2024 22:41
kevinAlbs
kevinAlbs reviewed Dec 4, 2024
View reviewed changes
x/mongo/driver/crypt.go Outdated
@@ -399,7 +397,10 @@ func (c *crypt) decryptKey(kmsCtx *mongocrypt.KmsContext) error {

res := make([]byte, bytesNeeded)
bytesRead, err := conn.Read(res)
if err != nil && !errors.Is(err, io.EOF) {
if err != nil {
if kmsCtx.Fail() {
Copy link
Contributor

Choose a reason for hiding this comment

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

See MONGOCRYPT-752. When mongocrypt_kms_ctx_fail returns false, consider wrapping the error message from mongocrypt_ctx_kms_status. The error from mongocrypt_ctx_kms_status may help identify a retry occurred (e.g. "KMS request failed after 3 retries due to a network error: last attempt failed with: ")

@qingyang-hu qingyang-hu marked this pull request as draft December 4, 2024 21:17
@qingyang-hu qingyang-hu marked this pull request as ready for review December 5, 2024 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kevinAlbs kevinAlbs kevinAlbs left review comments

@prestonvasquez prestonvasquez Awaiting requested review from prestonvasquez

@matthewdale matthewdale Awaiting requested review from matthewdale

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
priority-3-low Low Priority PR for Review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@qingyang-hu @kevinAlbs