CSHARP-3550: CSOT: Server Selection #1705

sanych-sun · 2025-06-06T01:11:08Z

No description provided.

src/MongoDB.Driver/OperationCancellationContext.cs

BorisDog · 2025-06-06T22:11:44Z

src/MongoDB.Driver/Core/ConnectionPools/ExclusiveConnectionPool.Helpers.cs


                message =
-                    $"Timed out after {stopwatch.ElapsedMilliseconds}ms waiting for a connection from the connection pool. " +
+                    $"Timed out after {operationContext.Elapsed.TotalMilliseconds}ms waiting for a connection from the connection pool. " +


minor: Looks like Elapsed.TotalMilliseconds is frequently used, does this award a shortcut property:
ElapsedMilleseconds?

Reverted to use stopwatch here.

BorisDog · 2025-06-06T22:14:07Z

src/MongoDB.Driver/OperationContext.cs

+        // TODO: this static field is temporary here and will be removed in a future PRs in scope of CSOT.
+        public static readonly OperationContext NoTimeout = new(System.Threading.Timeout.InfiniteTimeSpan, CancellationToken.None);
+
+        private readonly Stopwatch _stopwatch;


So we are saving the multiple stopwatches creation on operation execution path, it's minor but still nice.

Yep, but as it was discussed had to revert the change =)

src/MongoDB.Driver/Core/ConnectionPools/ExclusiveConnectionPool.Helpers.cs

sanych-sun · 2025-06-06T23:48:47Z

tests/MongoDB.Driver.Tests/Core/Clusters/ClusterTests.cs

            bool async)
        {
-            var subject = CreateSubject();
+            var subject = CreateSubject(serverSelectionTimeout: TimeSpan.FromMilliseconds(10));


This adjusted serverSelectionTimeout is an optimization of the test: we probably do not have to wait whole 2 seconds here (the default server selection for this test class, see line 49).

sanych-sun · 2025-06-07T00:05:06Z

tests/MongoDB.Driver.Tests/OperationExecutorTests.cs

                .Subject.ParamName.Should().Be("session");
        }

-        private OperationExecutor CreateSubject(out Mock<IClusterInternal> clusterMock, out Mock<ICoreSessionHandle> implicitSessionMock)


Leftovers of the implicit session creation, that was factored out in one of the latest commits related to OperationExecutor refactoing.

Copilot

Pull Request Overview

This PR refactors various server selection and connection pool APIs to use a new OperationContext abstraction instead of separate CancellationToken and timeout TimeSpan parameters. Key changes include:

Replaced all CancellationToken (and internal Stopwatch timeout logic) with OperationContext throughout connection pool helpers, cluster selection, and binding classes.
Updated CreateTimeoutException methods to accept a TimeSpan elapsed rather than a Stopwatch.
Removed legacy overloads and helper classes associated with CancellationToken/TimeSpan and simplified server selection wait logic using OperationContext.

Reviewed Changes

Copilot reviewed 141 out of 141 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/MongoDB.Driver/Core/ConnectionPools/ExclusiveConnectionPool.Helpers.cs	Swapped `Stopwatch` usage and token/timeouts for `OperationContext`
src/MongoDB.Driver/Core/Clusters/LoadBalancedCluster.cs	Updated server selection to use `OperationContext` and `WithTimeout`
src/MongoDB.Driver/Core/Clusters/IClusterExtensions.cs	Changed extension methods to accept `OperationContext`
src/MongoDB.Driver/Core/Clusters/ICluster.cs	Updated interface signatures to use `OperationContext`
src/MongoDB.Driver/Core/Clusters/Cluster.cs	Refactored internal select/wait loops to data in `OperationContext`
src/MongoDB.Driver/Core/Bindings/*/.cs	Replaced all `CancellationToken` parameters in binding APIs with `OperationContext`

Comments suppressed due to low confidence (3)

src/MongoDB.Driver/Core/ConnectionPools/ExclusiveConnectionPool.Helpers.cs:50

[nitpick] Using TotalMilliseconds can include fractional values (e.g., 12.345ms). Consider formatting with a fixed precision or rounding (e.g., {elapsed.TotalMilliseconds:F0}) to produce a cleaner integer-based message.

message = $"Timed out after {elapsed.TotalMilliseconds}ms waiting for a connection from the connection pool. " +

src/MongoDB.Driver/Core/Clusters/LoadBalancedCluster.cs:179

The new WithTimeout logic and WaitTask behavior are significant changes to server selection. Please add unit tests that simulate both timeout and cancellation scenarios for SelectServer/SelectServerAsync using mocks/stubs for _serverReadyTaskCompletionSource.

var serverSelectionOperationContext = operationContext.WithTimeout(_settings.ServerSelectionTimeout);

src/MongoDB.Driver/Core/Clusters/ICluster.cs:64

Removing the old CancellationToken overloads is a breaking API change. Consider retaining the old overloads (marked obsolete) to preserve backward compatibility, or provide clear upgrade guidance in release notes.

IServer SelectServer(IServerSelector selector, OperationContext operationContext);

Copilot · 2025-06-09T21:17:04Z

src/MongoDB.Driver/Core/Clusters/LoadBalancedCluster.cs

-            if (index != 0)
+            try
+            {
+                serverSelectionOperationContext.WaitTask(_serverReadyTaskCompletionSource.Task);


The original code explicitly threw on cancellation (cancellationToken.ThrowIfCancellationRequested()), but this method only catches TimeoutException. Consider catching OperationCanceledException from WaitTask or explicitly checking operationContext.CancellationToken to ensure cancellations are surfaced correctly.

Copilot · 2025-06-09T21:17:05Z

src/MongoDB.Driver/Core/Clusters/IClusterExtensions.cs

+            // Server selection also updates the cluster type, allowing us to determine if the server
            // should be pinned.
-            var server = cluster.SelectServer(selector, cancellationToken);
+            var server = cluster.SelectServer(selector, operationContext);


[nitpick] We added non-null checks for selector and operationContext in core cluster methods; consider adding Ensure.IsNotNull(operationContext, nameof(operationContext)); here as well to maintain consistent validation.

For some reasons we do not validate other parameters in the IClusterExtensions methods. Will keep it as is for now.

Copilot · 2025-06-09T21:17:05Z

src/MongoDB.Driver/Core/Bindings/WritableServerBinding.cs

        {
-            return GetReadChannelSource(null, cancellationToken);
+            return GetReadChannelSource(null, operationContext);
        }

-        public Task<IChannelSourceHandle> GetReadChannelSourceAsync(CancellationToken cancellationToken)
+        public Task<IChannelSourceHandle> GetReadChannelSourceAsync(OperationContext operationContext)
        {


[nitpick] Most public API methods now guard against null operationContext. Add an Ensure.IsNotNull(operationContext, nameof(operationContext)); at the top of this method to match the pattern in cluster selection.

src/MongoDB.Driver/Core/Bindings/ChannelReadWriteBinding.cs

src/MongoDB.Driver/Core/Bindings/CoreSession.cs

src/MongoDB.Driver/Core/Bindings/IBinding.cs

src/MongoDB.Driver/Core/Clusters/ICluster.cs

rstam · 2025-06-10T17:13:25Z

src/MongoDB.Driver/Core/Clusters/Cluster.cs

                }
+                catch (TimeoutException)
+                {
+                    var message = BuildTimeoutExceptionMessage(_settings.ServerSelectionTimeout, selector, helper.Description);


BuildTimeoutExceptionMessage doesn't inform the user whether the operation timed out or the server selection timed out.

src/MongoDB.Driver/Core/Clusters/IClusterExtensions.cs

src/MongoDB.Driver/Core/Operations/AggregateOperation.cs

BorisDog · 2025-06-10T20:00:25Z

src/MongoDB.Driver/Core/ConnectionPools/MaintenanceHelper.cs

+                    using (var connectionCreator = new ConnectionCreator(_connectionPool))
                    {
-                        var connection = connectionCreator.CreateOpened(cancellationToken);
+                        var connection = connectionCreator.CreateOpened(operationContext);


The reason for tiny 20ms timeout is just try to take turn in the connecting queue without blocking checkouts.
This timeout is applied to every step individually: MaxConnections and MaxConnecting.
Seems that this code changes this and allocates 20ms to

MaxConnections

MaxConnecting

Whole Connection creation operation (excluding open)

If this thought is correct, it's really surprising that this was not caught by tests.

@sanych-sun was this addressed?

What about _maxConnectingQueue inside ConnectionCreator ?
We don't want to block on that for whole timeout, just a quick try instead.

src/MongoDB.Driver/Core/ConnectionPools/ExclusiveConnectionPool.Helpers.cs

tests/MongoDB.Driver.Tests/OperationContextTests.cs

src/MongoDB.Driver/OperationContext.cs

src/MongoDB.Driver/OperationOptionsBase.cs

rstam

LGTM

adelinowona · 2025-06-11T17:44:59Z

src/MongoDB.Driver/OperationExecutor.cs

            Ensure.IsNotNull(session, nameof(session));
            ThrowIfDisposed();

+            var cancellationContext = options.ToOperationContext(cancellationToken);


rename this variable (and other instances) to operationContext?

adelinowona · 2025-06-11T17:45:48Z

tests/MongoDB.Driver.Tests/Core/Clusters/LoadBalancedClusterTests.cs

-                    {
-                        exception = Record.Exception(() => subject.SelectServer(Mock.Of<IServerSelector>(), cancellationTokenSource.Token));
-                    }
+                    var cancellationContext = new OperationContext(Timeout.InfiniteTimeSpan, cancellationTokenSource.Token);


rename variable to operationContext?

src/MongoDB.Driver/Core/ConnectionPools/ExclusiveConnectionPool.Helpers.cs

BorisDog · 2025-06-11T18:27:16Z

src/MongoDB.Driver/Core/ConnectionPools/MaintenanceHelper.cs

+                    using (var connectionCreator = new ConnectionCreator(_connectionPool))
                    {
-                        var connection = connectionCreator.CreateOpened(cancellationToken);
+                        var connection = connectionCreator.CreateOpened(operationContext);


@sanych-sun was this addressed?

tests/MongoDB.Driver.Tests/OperationContextTests.cs

rstam · 2025-06-11T20:25:48Z

src/MongoDB.Driver/Core/ConnectionPools/ExclusiveConnectionPool.Helpers.cs

                _enteredWaitQueue = true;
            }

+            private void EnsureTimeout(OperationContext operationContext, Stopwatch stopwatch)


Would ThrowIfTimedOut be a better name?

Normally we use EnsureXyz for argument validation.

adelinowona

LGTM

tests/MongoDB.Driver.Tests/OperationContextTests.cs

BorisDog

LGTM

BorisDog · 2025-06-11T23:15:31Z

src/MongoDB.Driver/Core/ConnectionPools/ExclusiveConnectionPool.Helpers.cs


-                    return CreateOpenedInternal(cancellationToken);
+                    var operationContext = new OperationContext(Timeout.InfiniteTimeSpan, cancellationToken);
+                    return CreateOpenedInternal(operationContext);


minor: return CreateOpenedInternal(new(Timeout.InfiniteTimeSpan, cancellationToken));

CSHARP-3550: CSOT: Server Selection

de8c0ce

sanych-sun requested review from BorisDog, adelinowona and rstam June 6, 2025 01:11

sanych-sun requested a review from a team as a code owner June 6, 2025 01:11

sanych-sun added the feature Adds new user-facing functionality. label Jun 6, 2025

sanych-sun removed the request for review from a team June 6, 2025 01:16

rstam requested changes Jun 6, 2025

View reviewed changes

src/MongoDB.Driver/OperationCancellationContext.cs Outdated Show resolved Hide resolved

Rename OperationCancellationContext to OperationContext

6f38b2a

BorisDog reviewed Jun 6, 2025

View reviewed changes

sanych-sun commented Jun 6, 2025

View reviewed changes

PR

b819cc7

sanych-sun commented Jun 7, 2025

View reviewed changes

pr

fa4b6d3

sanych-sun requested a review from rstam June 7, 2025 00:55

pr

da1d212

sanych-sun requested a review from BorisDog June 9, 2025 20:48

BorisDog requested a review from Copilot June 9, 2025 21:15

Copilot AI reviewed Jun 9, 2025

View reviewed changes

rstam requested changes Jun 10, 2025

View reviewed changes

PR

d80fa50

sanych-sun requested a review from rstam June 10, 2025 19:09

BorisDog requested changes Jun 10, 2025

View reviewed changes

adelinowona requested changes Jun 10, 2025

View reviewed changes

src/MongoDB.Driver/OperationContext.cs Outdated Show resolved Hide resolved

src/MongoDB.Driver/OperationContext.cs Show resolved Hide resolved

src/MongoDB.Driver/OperationOptionsBase.cs Outdated Show resolved Hide resolved

sanych-sun added 2 commits June 10, 2025 17:06

PR

102c945

pr

4d6d939

sanych-sun requested review from BorisDog and adelinowona June 11, 2025 00:19

rstam approved these changes Jun 11, 2025

View reviewed changes

adelinowona requested changes Jun 11, 2025

View reviewed changes

BorisDog requested changes Jun 11, 2025

View reviewed changes

sanych-sun added 2 commits June 11, 2025 11:31

pr

3a05fa6

PR

a09bf95

sanych-sun requested review from BorisDog and adelinowona June 11, 2025 19:28

rstam reviewed Jun 11, 2025

View reviewed changes

adelinowona approved these changes Jun 11, 2025

View reviewed changes

BorisDog requested changes Jun 11, 2025

View reviewed changes

tests/MongoDB.Driver.Tests/OperationContextTests.cs Outdated Show resolved Hide resolved

tests/MongoDB.Driver.Tests/OperationContextTests.cs Show resolved Hide resolved

tests/MongoDB.Driver.Tests/OperationContextTests.cs Outdated Show resolved Hide resolved

pr

2687205

sanych-sun requested a review from BorisDog June 11, 2025 21:28

PR

27d728c

BorisDog approved these changes Jun 12, 2025

View reviewed changes

pr

7dba679

sanych-sun merged commit cc69339 into mongodb:main Jun 12, 2025
31 of 35 checks passed

sanych-sun deleted the csharp3550 branch June 12, 2025 15:39

CSHARP-3550: CSOT: Server Selection #1705

CSHARP-3550: CSOT: Server Selection #1705

Uh oh!

Conversation

sanych-sun commented Jun 6, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rstam left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment