GODRIVER-3473 Short-cicruit cursor.next() on invalid timeouts #2135
Conversation
This file contains hidden or 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
API Change Report./v2/x/mongo/drivercompatible changes(*BatchCursor).MaxAwaitTime: added |
prestonvasquez
force-pushed
the
GODRIVER-3473
branch
from
9bb1fb5 to
5006d50
Compare
prestonvasquez
requested review from
qingyang-hu and
matthewdale
and removed request for
qingyang-hu
matthewdale
reviewed
Jul 31, 2025
| // TimeoutWithinContext will return true if the provided timeout is nil or if | ||
| // it is less than the context deadline. If the context does not have a | ||
| // deadline, it will return true. | ||
| func TimeoutWithinContext(ctx context.Context, timeout *time.Duration) bool { |
There was a problem hiding this comment.
We can simplify the behavior by letting the caller decide what a nil timeout means. TimeoutWIthinContext should take a time.Duration instead of a *time.Duration.
Comment on lines
+428
to
+429
| mt.Run("short-circuiting getMore", func(mt *mtest.T) { | ||
| tests := []struct { |
There was a problem hiding this comment.
This subtest should be refactored into one or many test functions.
|
|
||
| var docs []interface{} | ||
| for i := 1; i <= 5; i++ { | ||
| docs = append(docs, bson.D{{"x", int32(i)}}) | ||
| } | ||
|
|
||
| _, err := coll.InsertMany(context.Background(), docs) | ||
| assert.Nil(mt, err, "InsertMany error for initial data: %v", err) | ||
| assert.Nil(tb, err, "InsertMany error for initial data: %v", err) |
There was a problem hiding this comment.
Optional: Consider using assert.NoError
Comment on lines
+329
to
+331
| mt.RunOpts("apply remaining timeoutMS if less than maxAwaitTimeMS", mtOpts, func(mt *mtest.T) { | ||
| cappedColl := newCappedCollection(mt, "tailable_awaitData_capped") | ||
| initCollection(mt, cappedColl) |
There was a problem hiding this comment.
Optional: You can use mtest.Options.CollectionCreateOptions to create a capped collection.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
GODRIVER-3473
Summary
Short-circuit calls to
cursor.Next()where maxAwaitTimeMS >= operation timeout, which would result in socket timeouts.Background & Motivation
The specifications assume that drivers iteratively apply the timeout provided at the constructor level (e.g.,
(*collection).Find) for tailable awaitData cursors:The Go Driver might decide to support the above behavior with DRIVERS-2722. The principal concern is that it would be unexpected for users to apply an operation-level timeout via contexts to a constructor and then have that timeout later be applied while working with a resulting cursor. Instead, it is more idiomatic to apply the timeout to the context passed to
NextorTryNext.