Skip to content

Commit a93f29e

Browse files
sanych-sunsanych-sun
authored
CSHARP-3549: CSOT: Add timeoutMS to settings (#1721)
1 parent daae47d commit a93f29e

File tree

98 files changed

+1333
-670
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+1333
-670
lines changed

‎src/MongoDB.Driver/AggregateOptions.cs‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/* Copyright 2015-present MongoDB Inc.
1+
/* Copyright 2010-present MongoDB Inc.
22
*
33
* Licensed under the Apache License, Version 2.0 (the "License");
44
* you may not use this file except in compliance with the License.
@@ -34,6 +34,7 @@ public class AggregateOptions
3434
private BsonDocument _let;
3535
private TimeSpan? _maxAwaitTime;
3636
private TimeSpan? _maxTime;
37+
private TimeSpan? _timeout;
3738
private ExpressionTranslationOptions _translationOptions;
3839
private bool? _useCursor;
3940

@@ -127,6 +128,16 @@ public TimeSpan? MaxTime
127128
set { _maxTime = Ensure.IsNullOrInfiniteOrGreaterThanOrEqualToZero(value, nameof(value)); }
128129
}
129130

131+
/// <summary>
132+
/// Gets or sets the operation timeout.
133+
/// </summary>
134+
// TODO: CSOT: Make it public when CSOT will be ready for GA
135+
internal TimeSpan? Timeout
136+
{
137+
get => _timeout;
138+
set => _timeout = Ensure.IsNullOrValidTimeout(value, nameof(Timeout));
139+
}
140+
130141
/// <summary>
131142
/// Gets or sets the translation options.
132143
/// </summary>

‎src/MongoDB.Driver/BulkWriteOptions.cs‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313
* limitations under the License.
1414
*/
1515

16+
using System;
1617
using MongoDB.Bson;
18+
using MongoDB.Driver.Core.Misc;
1719

1820
namespace MongoDB.Driver
1921
{
@@ -27,6 +29,7 @@ public sealed class BulkWriteOptions
2729
private BsonValue _comment;
2830
private bool _isOrdered;
2931
private BsonDocument _let;
32+
private TimeSpan? _timeout;
3033

3134
// constructors
3235
/// <summary>
@@ -73,5 +76,15 @@ public BsonDocument Let
7376
get { return _let; }
7477
set { _let = value; }
7578
}
79+
80+
/// <summary>
81+
/// Gets or sets the operation timeout.
82+
/// </summary>
83+
// TODO: CSOT: Make it public when CSOT will be ready for GA
84+
internal TimeSpan? Timeout
85+
{
86+
get => _timeout;
87+
set => _timeout = Ensure.IsNullOrValidTimeout(value, nameof(Timeout));
88+
}
7689
}
7790
}

‎src/MongoDB.Driver/ChangeStreamOptions.cs‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/* Copyright 2017-present MongoDB Inc.
1+
/* Copyright 2010-present MongoDB Inc.
22
*
33
* Licensed under the Apache License, Version 2.0 (the "License");
44
* you may not use this file except in compliance with the License.
@@ -35,6 +35,7 @@ public class ChangeStreamOptions
3535
private bool? _showExpandedEvents;
3636
private BsonDocument _startAfter;
3737
private BsonTimestamp _startAtOperationTime;
38+
private TimeSpan? _timeout;
3839

3940
// public properties
4041
/// <summary>
@@ -166,5 +167,15 @@ public BsonTimestamp StartAtOperationTime
166167
get { return _startAtOperationTime; }
167168
set { _startAtOperationTime = value; }
168169
}
170+
171+
/// <summary>
172+
/// Gets or sets the operation timeout.
173+
/// </summary>
174+
// TODO: CSOT: Make it public when CSOT will be ready for GA
175+
internal TimeSpan? Timeout
176+
{
177+
get => _timeout;
178+
set => _timeout = Ensure.IsNullOrValidTimeout(value, nameof(Timeout));
179+
}
169180
}
170181
}

‎src/MongoDB.Driver/ClientBulkWriteOptions.cs‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313
* limitations under the License.
1414
*/
1515

16+
using System;
1617
using MongoDB.Bson;
18+
using MongoDB.Driver.Core.Misc;
1719

1820
namespace MongoDB.Driver
1921
{
@@ -22,6 +24,8 @@ namespace MongoDB.Driver
2224
/// </summary>
2325
public sealed class ClientBulkWriteOptions
2426
{
27+
private TimeSpan? _timeout;
28+
2529
/// <summary>
2630
/// Initializes a new instance of the <see cref="BulkWriteOptions"/> class.
2731
/// </summary>
@@ -75,6 +79,16 @@ public ClientBulkWriteOptions(
7579
/// </summary>
7680
public BsonDocument Let { get; set; }
7781

82+
/// <summary>
83+
/// Gets or sets the operation timeout.
84+
/// </summary>
85+
// TODO: CSOT: Make it public when CSOT will be ready for GA
86+
internal TimeSpan? Timeout
87+
{
88+
get => _timeout;
89+
set => _timeout = Ensure.IsNullOrValidTimeout(value, nameof(Timeout));
90+
}
91+
7892
/// <summary>
7993
/// Whether detailed results for each successful operation should be included in the returned results.
8094
/// </summary>

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ public bool IsInTransaction
146146
EnsureAbortTransactionCanBeCalled(nameof(AbortTransaction));
147147

148148
// TODO: CSOT implement proper way to obtain the operationContext
149-
var operationContext = new OperationContext(Timeout.InfiniteTimeSpan, cancellationToken);
149+
var operationContext = new OperationContext(null, cancellationToken);
150150
try
151151
{
152152
if (_currentTransaction.IsEmpty)
@@ -197,7 +197,7 @@ public bool IsInTransaction
197197
EnsureAbortTransactionCanBeCalled(nameof(AbortTransaction));
198198

199199
// TODO: CSOT implement proper way to obtain the operationContext
200-
var operationContext = new OperationContext(Timeout.InfiniteTimeSpan, cancellationToken);
200+
var operationContext = new OperationContext(null, cancellationToken);
201201
try
202202
{
203203
if (_currentTransaction.IsEmpty)
@@ -297,7 +297,7 @@ public long AdvanceTransactionNumber()
297297
EnsureCommitTransactionCanBeCalled(nameof(CommitTransaction));
298298

299299
// TODO: CSOT implement proper way to obtain the operationContext
300-
var operationContext = new OperationContext(Timeout.InfiniteTimeSpan, cancellationToken);
300+
var operationContext = new OperationContext(null, cancellationToken);
301301
try
302302
{
303303
_isCommitTransactionInProgress = true;
@@ -334,7 +334,7 @@ public long AdvanceTransactionNumber()
334334
EnsureCommitTransactionCanBeCalled(nameof(CommitTransaction));
335335

336336
// TODO: CSOT implement proper way to obtain the operationContext
337-
var operationContext = new OperationContext(Timeout.InfiniteTimeSpan, cancellationToken);
337+
var operationContext = new OperationContext(null, cancellationToken);
338338
try
339339
{
340340
_isCommitTransactionInProgress = true;

‎src/MongoDB.Driver/Core/Configuration/ConnectionString.cs‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,9 @@ public sealed class ConnectionString
9898
private TimeSpan? _socketTimeout;
9999
private int? _srvMaxHosts;
100100
private string _srvServiceName;
101+
#pragma warning disable CS0649 // Field is never assigned to, and will always have its default value
102+
private TimeSpan? _timeout;
103+
#pragma warning restore CS0649 // Field is never assigned to, and will always have its default value
101104
private bool? _tls;
102105
private bool? _tlsDisableCertificateRevocationCheck;
103106
private bool? _tlsInsecure;
@@ -399,7 +402,6 @@ public bool? RetryReads
399402
get { return _retryReads; }
400403
}
401404

402-
403405
/// <summary>
404406
/// Gets a value indicating whether or not to retry writes.
405407
/// </summary>
@@ -468,6 +470,12 @@ public bool? Ssl
468470
[Obsolete("Use TlsInsecure instead.")]
469471
public bool? SslVerifyCertificate => !_tlsInsecure;
470472

473+
/// <summary>
474+
/// Gets the per-operation timeout.
475+
/// </summary>
476+
// TODO: CSOT: Make it public when CSOT will be ready for GA
477+
internal TimeSpan? Timeout => _timeout;
478+
471479
/// <summary>
472480
/// Gets whether to use TLS.
473481
/// </summary>
@@ -1089,6 +1097,12 @@ private void ParseOption(string name, string value)
10891097
var sslVerifyCertificateValue = ParseBoolean(name, value);
10901098
_tlsInsecure = EnsureTlsInsecureIsValid(!sslVerifyCertificateValue);
10911099
break;
1100+
#if DEBUG // TODO: CSOT: Make it public when CSOT will be ready for GA
1101+
case "timeout":
1102+
case "timeoutms":
1103+
_timeout = value == "0" ? System.Threading.Timeout.InfiniteTimeSpan : ParseTimeSpan(name, value);
1104+
break;
1105+
#endif
10921106
case "tlsdisablecertificaterevocationcheck":
10931107
var tlsDisableCertificateRevocationCheckValue = ParseBoolean(name, value);
10941108
_tlsDisableCertificateRevocationCheck =

‎src/MongoDB.Driver/Core/Misc/Ensure.cs‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/* Copyright 2013-present MongoDB Inc.
1+
/* Copyright 2010-present MongoDB Inc.
22
*
33
* Licensed under the Apache License, Version 2.0 (the "License");
44
* you may not use this file except in compliance with the License.
@@ -461,8 +461,7 @@ public static TimeSpan IsValidTimeout(TimeSpan value, string paramName)
461461
{
462462
if (value < TimeSpan.Zero && value != Timeout.InfiniteTimeSpan)
463463
{
464-
var message = string.Format("Invalid timeout: {0}.", value);
465-
throw new ArgumentException(message, paramName);
464+
throw new ArgumentOutOfRangeException($"Invalid timeout: {value}.", paramName);
466465
}
467466
return value;
468467
}

‎src/MongoDB.Driver/Core/Misc/Feature.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -570,7 +570,7 @@ public void ThrowIfNotSupported(IMongoClient client, CancellationToken cancellat
570570
{
571571
var cluster = client.GetClusterInternal();
572572
// TODO: CSOT implement proper way to obtain the operationContext
573-
var operationContext = new OperationContext(Timeout.InfiniteTimeSpan, cancellationToken);
573+
var operationContext = new OperationContext(null, cancellationToken);
574574
using (var binding = new ReadWriteBindingHandle(new WritableServerBinding(cluster, NoCoreSession.NewHandle())))
575575
using (var channelSource = binding.GetWriteChannelSource(operationContext))
576576
using (var channel = channelSource.GetChannel(operationContext))
@@ -589,7 +589,7 @@ public async Task ThrowIfNotSupportedAsync(IMongoClient client, CancellationToke
589589
{
590590
var cluster = client.GetClusterInternal();
591591
// TODO: CSOT implement proper way to obtain the operationContext
592-
var operationContext = new OperationContext(Timeout.InfiniteTimeSpan, cancellationToken);
592+
var operationContext = new OperationContext(null, cancellationToken);
593593
using (var binding = new ReadWriteBindingHandle(new WritableServerBinding(cluster, NoCoreSession.NewHandle())))
594594
using (var channelSource = await binding.GetWriteChannelSourceAsync(operationContext).ConfigureAwait(false))
595595
using (var channel = await channelSource.GetChannelAsync(operationContext).ConfigureAwait(false))

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ public IAsyncCursor<TResult> Execute(OperationContext operationContext, Retryabl
288288

289289
using (EventContext.BeginOperation())
290290
{
291-
var operation = CreateOperation(context);
291+
var operation = CreateOperation(operationContext, context);
292292
var result = operation.Execute(operationContext, context);
293293

294294
context.ChannelSource.Session.SetSnapshotTimeIfNeeded(result.AtClusterTime);
@@ -317,7 +317,7 @@ public async Task<IAsyncCursor<TResult>> ExecuteAsync(OperationContext operation
317317

318318
using (EventContext.BeginOperation())
319319
{
320-
var operation = CreateOperation(context);
320+
var operation = CreateOperation(operationContext, context);
321321
var result = await operation.ExecuteAsync(operationContext, context).ConfigureAwait(false);
322322

323323
context.ChannelSource.Session.SetSnapshotTimeIfNeeded(result.AtClusterTime);
@@ -326,15 +326,15 @@ public async Task<IAsyncCursor<TResult>> ExecuteAsync(OperationContext operation
326326
}
327327
}
328328

329-
internal BsonDocument CreateCommand(ConnectionDescription connectionDescription, ICoreSession session)
329+
internal BsonDocument CreateCommand(OperationContext operationContext, ICoreSession session, ConnectionDescription connectionDescription)
330330
{
331331
var readConcern = ReadConcernHelper.GetReadConcernForCommand(session, connectionDescription, _readConcern);
332332
var command = new BsonDocument
333333
{
334334
{ "aggregate", _collectionNamespace == null ? (BsonValue)1 : _collectionNamespace.CollectionName },
335335
{ "pipeline", new BsonArray(_pipeline) },
336336
{ "allowDiskUse", () => _allowDiskUse.Value, _allowDiskUse.HasValue },
337-
{ "maxTimeMS", () => MaxTimeHelper.ToMaxTimeMS(_maxTime.Value), _maxTime.HasValue },
337+
{ "maxTimeMS", () => MaxTimeHelper.ToMaxTimeMS(_maxTime.Value), _maxTime.HasValue && !operationContext.IsRootContextTimeoutConfigured() },
338338
{ "collation", () => _collation.ToBsonDocument(), _collation != null },
339339
{ "hint", _hint, _hint != null },
340340
{ "let", _let, _let != null },
@@ -354,10 +354,10 @@ internal BsonDocument CreateCommand(ConnectionDescription connectionDescription,
354354

355355
private IDisposable BeginOperation() => EventContext.BeginOperation(null, "aggregate");
356356

357-
private ReadCommandOperation<AggregateResult> CreateOperation(RetryableReadContext context)
357+
private ReadCommandOperation<AggregateResult> CreateOperation(OperationContext operationContext, RetryableReadContext context)
358358
{
359359
var databaseNamespace = _collectionNamespace == null ? _databaseNamespace : _collectionNamespace.DatabaseNamespace;
360-
var command = CreateCommand(context.Channel.ConnectionDescription, context.Binding.Session);
360+
var command = CreateCommand(operationContext, context.Binding.Session, context.Channel.ConnectionDescription);
361361
var serializer = new AggregateResultDeserializer(_resultSerializer);
362362
return new ReadCommandOperation<AggregateResult>(databaseNamespace, command, serializer, MessageEncoderSettings)
363363
{

‎src/MongoDB.Driver/Core/Operations/AggregateToCollectionOperation.cs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/* Copyright 2013-present MongoDB Inc.
1+
/* Copyright 2010-present MongoDB Inc.
22
*
33
* Licensed under the Apache License, Version 2.0 (the "License");
44
* you may not use this file except in compliance with the License.
@@ -157,7 +157,7 @@ public BsonDocument Execute(OperationContext operationContext, IWriteBinding bin
157157
using (var channel = channelSource.GetChannel(operationContext))
158158
using (var channelBinding = new ChannelReadWriteBinding(channelSource.Server, channel, binding.Session.Fork()))
159159
{
160-
var operation = CreateOperation(channelBinding.Session, channel.ConnectionDescription, mayUseSecondary.EffectiveReadPreference);
160+
var operation = CreateOperation(operationContext, channelBinding.Session, channel.ConnectionDescription, mayUseSecondary.EffectiveReadPreference);
161161
return operation.Execute(operationContext, channelBinding);
162162
}
163163
}
@@ -172,12 +172,12 @@ public async Task<BsonDocument> ExecuteAsync(OperationContext operationContext,
172172
using (var channel = await channelSource.GetChannelAsync(operationContext).ConfigureAwait(false))
173173
using (var channelBinding = new ChannelReadWriteBinding(channelSource.Server, channel, binding.Session.Fork()))
174174
{
175-
var operation = CreateOperation(channelBinding.Session, channel.ConnectionDescription, mayUseSecondary.EffectiveReadPreference);
175+
var operation = CreateOperation(operationContext, channelBinding.Session, channel.ConnectionDescription, mayUseSecondary.EffectiveReadPreference);
176176
return await operation.ExecuteAsync(operationContext, channelBinding).ConfigureAwait(false);
177177
}
178178
}
179179

180-
public BsonDocument CreateCommand(ICoreSessionHandle session, ConnectionDescription connectionDescription)
180+
public BsonDocument CreateCommand(OperationContext operationContext, ICoreSessionHandle session, ConnectionDescription connectionDescription)
181181
{
182182
var readConcern = _readConcern != null
183183
? ReadConcernHelper.GetReadConcernForCommand(session, connectionDescription, _readConcern)
@@ -189,7 +189,7 @@ public BsonDocument CreateCommand(ICoreSessionHandle session, ConnectionDescript
189189
{ "pipeline", new BsonArray(_pipeline) },
190190
{ "allowDiskUse", () => _allowDiskUse.Value, _allowDiskUse.HasValue },
191191
{ "bypassDocumentValidation", () => _bypassDocumentValidation.Value, _bypassDocumentValidation.HasValue },
192-
{ "maxTimeMS", () => MaxTimeHelper.ToMaxTimeMS(_maxTime.Value), _maxTime.HasValue },
192+
{ "maxTimeMS", () => MaxTimeHelper.ToMaxTimeMS(_maxTime.Value), _maxTime.HasValue && !operationContext.IsRootContextTimeoutConfigured() },
193193
{ "collation", () => _collation.ToBsonDocument(), _collation != null },
194194
{ "readConcern", readConcern, readConcern != null },
195195
{ "writeConcern", writeConcern, writeConcern != null },
@@ -202,9 +202,9 @@ public BsonDocument CreateCommand(ICoreSessionHandle session, ConnectionDescript
202202

203203
private IDisposable BeginOperation() => EventContext.BeginOperation("aggregate");
204204

205-
private WriteCommandOperation<BsonDocument> CreateOperation(ICoreSessionHandle session, ConnectionDescription connectionDescription, ReadPreference effectiveReadPreference)
205+
private WriteCommandOperation<BsonDocument> CreateOperation(OperationContext operationContext, ICoreSessionHandle session, ConnectionDescription connectionDescription, ReadPreference effectiveReadPreference)
206206
{
207-
var command = CreateCommand(session, connectionDescription);
207+
var command = CreateCommand(operationContext, session, connectionDescription);
208208
var operation = new WriteCommandOperation<BsonDocument>(_databaseNamespace, command, BsonDocumentSerializer.Instance, MessageEncoderSettings);
209209
if (effectiveReadPreference != null)
210210
{

0 commit comments

Comments
 (0)