CSHARP-2031: Parse logicalSessionTimeoutMinutes and update SDAM tests and runners.

Author: rstam

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

@@ -1,4 +1,4 @@
-/* Copyright 2013-2015 MongoDB Inc.
+/* Copyright 2013-2017 MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -38,8 +38,17 @@ internal abstract class Cluster : ICluster
         #region static
         // static fields
         private static readonly TimeSpan __minHeartbeatInterval = TimeSpan.FromMilliseconds(500);
-        private static readonly Range<int> __supportedWireVersionRange = new Range<int>(0, 3);
+        private static readonly Range<int> __supportedWireVersionRange = new Range<int>(2, 6);
         private static readonly IServerSelector __randomServerSelector = new RandomServerSelector();
+
+        // static properties
+        /// <summary>
+        /// Gets the supported wire version range.
+        /// </summary>
+        /// <value>
+        /// The supported wire version range.
+        /// </value>
+        public static Range<int> SupportedWireVersionRange => __supportedWireVersionRange;
         #endregion
 
         // fields

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

@@ -1,4 +1,4 @@
-/* Copyright 2013-2015 MongoDB Inc.
+/* Copyright 2013-2017 MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -43,6 +43,7 @@ internal static ClusterDescription CreateInitial(ClusterId clusterId, ClusterCon
         // fields
         private readonly ClusterId _clusterId;
         private readonly ClusterConnectionMode _connectionMode;
+        private readonly TimeSpan? _logicalSessionTimeout;
         private readonly IReadOnlyList<ServerDescription> _servers;
         private readonly ClusterType _type;
 
@@ -64,6 +65,7 @@ public ClusterDescription(
             _connectionMode = connectionMode;
             _type = type;
             _servers = (servers ?? new ServerDescription[0]).OrderBy(n => n.EndPoint, new ToStringComparer<EndPoint>()).ToList();
+            _logicalSessionTimeout = CalculateLogicalSessionTimeout(_servers);
         }
 
         // properties
@@ -83,6 +85,28 @@ public ClusterConnectionMode ConnectionMode
             get { return _connectionMode; }
         }
 
+        /// <summary>
+        /// Gets a value indicating whether this cluster is compatible with the driver.
+        /// </summary>
+        /// <value>
+        ///   <c>true</c> if this cluster is compatible with the driver; otherwise, <c>false</c>.
+        /// </value>
+        public bool IsCompatibleWithDriver
+        {
+            get
+            {
+                return _servers.All(s => s.IsCompatibleWithDriver);
+            }
+        }
+
+        /// <summary>
+        /// Gets the logical session timeout.
+        /// </summary>
+        public TimeSpan? LogicalSessionTimeout
+        {
+            get { return _logicalSessionTimeout; }
+        }
+
         /// <summary>
         /// Gets the servers.
         /// </summary>
@@ -216,5 +240,26 @@ public ClusterDescription WithType(ClusterType value)
         {
             return _type == value ? this : new ClusterDescription(_clusterId, _connectionMode, value, _servers);
         }
+
+        // private methods
+        private TimeSpan? CalculateLogicalSessionTimeout(IEnumerable<ServerDescription> servers)
+        {
+            TimeSpan? logicalSessionTimeout = null;
+
+            foreach (var server in servers)
+            {
+                if (server.LogicalSessionTimeout == null)
+                {
+                    return null;
+                }
+
+                if (logicalSessionTimeout == null || server.LogicalSessionTimeout.Value < logicalSessionTimeout.Value)
+                {
+                    logicalSessionTimeout = server.LogicalSessionTimeout;
+                }
+            }
+
+            return logicalSessionTimeout;
+        }
     }
 }

src/MongoDB.Driver.Core/Core/Connections/IsMasterResult.cs

@@ -1,4 +1,4 @@
-/* Copyright 2013-2016 MongoDB Inc.
+/* Copyright 2013-2017 MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -17,9 +17,6 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Net;
-using System.Net.Sockets;
-using System.Text;
-using System.Threading.Tasks;
 using MongoDB.Bson;
 using MongoDB.Driver.Core.Clusters;
 using MongoDB.Driver.Core.Misc;
@@ -105,6 +102,33 @@ public DateTime? LastWriteTimestamp
             }
         }
 
+        /// <summary>
+        /// Gets the logical session timeout.
+        /// </summary>
+        /// <value>
+        /// The logical session timeout.
+        /// </value>
+        public TimeSpan? LogicalSessionTimeout
+        {
+            get
+            {
+                BsonValue value;
+                if (_wrapped.TryGetValue("logicalSessionTimeoutMinutes", out value))
+                {
+                    if (value.BsonType == BsonType.Null)
+                    {
+                        return null;
+                    }
+                    else
+                    {
+                        return TimeSpan.FromMinutes(value.ToDouble());
+                    }
+                }
+
+                return null;
+            }
+        }
+
         /// <summary>
         /// Gets the maximum number of documents in a batch.
         /// </summary>

src/MongoDB.Driver.Core/Core/Servers/ServerDescription.cs

@@ -1,4 +1,4 @@
-/* Copyright 2013-2016 MongoDB Inc.
+/* Copyright 2013-2017 MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -14,15 +14,9 @@
 */
 
 using System;
-using System.Collections.Generic;
-using System.Linq;
 using System.Net;
-using System.Net.Sockets;
 using System.Text;
-using System.Threading.Tasks;
-using MongoDB.Bson;
 using MongoDB.Driver.Core.Clusters;
-using MongoDB.Driver.Core.Connections;
 using MongoDB.Driver.Core.Misc;
 using MongoDB.Shared;
 
@@ -42,6 +36,7 @@ public sealed class ServerDescription : IEquatable<ServerDescription>
         private readonly TimeSpan _heartbeatInterval;
         private readonly DateTime _lastUpdateTimestamp;
         private readonly DateTime? _lastWriteTimestamp;
+        private readonly TimeSpan? _logicalSessionTimeout;
         private readonly int _maxBatchCount;
         private readonly int _maxDocumentSize;
         private readonly int _maxMessageSize;
@@ -67,6 +62,7 @@ public sealed class ServerDescription : IEquatable<ServerDescription>
         /// <param name="heartbeatInterval">The heartbeat interval.</param>
         /// <param name="lastUpdateTimestamp">The last update timestamp.</param>
         /// <param name="lastWriteTimestamp">The last write timestamp.</param>
+        /// <param name="logicalSessionTimeout">The logical session timeout.</param>
         /// <param name="maxBatchCount">The maximum batch count.</param>
         /// <param name="maxDocumentSize">The maximum size of a document.</param>
         /// <param name="maxMessageSize">The maximum size of a message.</param>
@@ -77,6 +73,7 @@ public sealed class ServerDescription : IEquatable<ServerDescription>
         /// <param name="type">The server type.</param>
         /// <param name="version">The server version.</param>
         /// <param name="wireVersionRange">The wire version range.</param>
+        /// <exception cref="ArgumentException">EndPoint and ServerId.EndPoint must match.</exception>
         public ServerDescription(
             ServerId serverId,
             EndPoint endPoint,
@@ -87,6 +84,7 @@ public ServerDescription(
             Optional<TimeSpan> heartbeatInterval = default(Optional<TimeSpan>),
             Optional<DateTime> lastUpdateTimestamp = default(Optional<DateTime>),
             Optional<DateTime?> lastWriteTimestamp = default(Optional<DateTime?>),
+            Optional<TimeSpan?> logicalSessionTimeout = default(Optional<TimeSpan?>),
             Optional<int> maxBatchCount = default(Optional<int>),
             Optional<int> maxDocumentSize = default(Optional<int>),
             Optional<int> maxMessageSize = default(Optional<int>),
@@ -113,6 +111,7 @@ public ServerDescription(
             _heartbeatInterval = heartbeatInterval.WithDefault(TimeSpan.Zero);
             _lastUpdateTimestamp = lastUpdateTimestamp.WithDefault(DateTime.UtcNow);
             _lastWriteTimestamp = lastWriteTimestamp.WithDefault(null);
+            _logicalSessionTimeout = logicalSessionTimeout.WithDefault(null);
             _maxBatchCount = maxBatchCount.WithDefault(1000);
             _maxDocumentSize = maxDocumentSize.WithDefault(4 * 1024 * 1024);
             _maxMessageSize = maxMessageSize.WithDefault(Math.Max(_maxDocumentSize + 1024, 16000000));
@@ -189,6 +188,20 @@ public TimeSpan HeartbeatInterval
             get { return _heartbeatInterval; }
         }
 
+        /// <summary>
+        /// Gets a value indicating whether this server is compatible with the driver.
+        /// </summary>
+        /// <value>
+        /// <c>true</c> if this server is compatible with the driver; otherwise, <c>false</c>.
+        /// </value>
+        public bool IsCompatibleWithDriver
+        {
+            get
+            {
+                return _wireVersionRange == null || _wireVersionRange.Overlaps(Cluster.SupportedWireVersionRange);
+            }
+        }
+
         /// <summary>
         /// Gets the last update timestamp (when the ServerDescription itself was last updated).
         /// </summary>
@@ -211,6 +224,17 @@ public DateTime? LastWriteTimestamp
             get { return _lastWriteTimestamp; }
         }
 
+        /// <summary>
+        /// Gets the logical session timeout.
+        /// </summary>
+        /// <value>
+        /// The logical session timeout.
+        /// </value>
+        public TimeSpan? LogicalSessionTimeout
+        {
+            get { return _logicalSessionTimeout; }
+        }
+
         /// <summary>
         /// Gets the maximum number of documents in a batch.
         /// </summary>
@@ -356,6 +380,7 @@ public bool Equals(ServerDescription other)
                 _heartbeatInterval == other._heartbeatInterval &&
                 _lastUpdateTimestamp == other._lastUpdateTimestamp &&
                 _lastWriteTimestamp == other._lastWriteTimestamp &&
+                _logicalSessionTimeout == other._logicalSessionTimeout &&
                 _maxBatchCount == other._maxBatchCount &&
                 _maxDocumentSize == other._maxDocumentSize &&
                 _maxMessageSize == other._maxMessageSize &&
@@ -382,6 +407,7 @@ public override int GetHashCode()
                 .Hash(_heartbeatInterval)
                 .Hash(_lastUpdateTimestamp)
                 .Hash(_lastWriteTimestamp)
+                .Hash(_logicalSessionTimeout)
                 .Hash(_maxBatchCount)
                 .Hash(_maxDocumentSize)
                 .Hash(_maxMessageSize)
@@ -423,6 +449,7 @@ public override string ToString()
         /// <param name="heartbeatInterval">The heartbeat interval.</param>
         /// <param name="lastUpdateTimestamp">The last update timestamp.</param>
         /// <param name="lastWriteTimestamp">The last write timestamp.</param>
+        /// <param name="logicalSessionTimeout">The logical session timeout.</param>
         /// <param name="maxBatchCount">The maximum batch count.</param>
         /// <param name="maxDocumentSize">The maximum size of a document.</param>
         /// <param name="maxMessageSize">The maximum size of a message.</param>
@@ -444,6 +471,7 @@ public ServerDescription With(
             Optional<TimeSpan> heartbeatInterval = default(Optional<TimeSpan>),
             Optional<DateTime> lastUpdateTimestamp = default(Optional<DateTime>),
             Optional<DateTime?> lastWriteTimestamp = default(Optional<DateTime?>),
+            Optional<TimeSpan?> logicalSessionTimeout = default(Optional<TimeSpan?>),
             Optional<int> maxBatchCount = default(Optional<int>),
             Optional<int> maxDocumentSize = default(Optional<int>),
             Optional<int> maxMessageSize = default(Optional<int>),
@@ -468,6 +496,7 @@ public ServerDescription With(
                 heartbeatInterval.Replaces(_heartbeatInterval) ||
                 lastUpdateTimestamp.Replaces(_lastUpdateTimestamp) ||
                 lastWriteTimestamp.Replaces(_lastWriteTimestamp) ||
+                logicalSessionTimeout.Replaces(_logicalSessionTimeout) ||
                 maxBatchCount.Replaces(_maxBatchCount) ||
                 maxDocumentSize.Replaces(_maxDocumentSize) ||
                 maxMessageSize.Replaces(_maxMessageSize) ||
@@ -489,6 +518,7 @@ public ServerDescription With(
                     heartbeatInterval: heartbeatInterval.WithDefault(_heartbeatInterval),
                     lastUpdateTimestamp: lastUpdateTimestamp.WithDefault(_lastUpdateTimestamp),
                     lastWriteTimestamp: lastWriteTimestamp.WithDefault(_lastWriteTimestamp),
+                    logicalSessionTimeout: logicalSessionTimeout.WithDefault(_logicalSessionTimeout),
                     maxBatchCount: maxBatchCount.WithDefault(_maxBatchCount),
                     maxDocumentSize: maxDocumentSize.WithDefault(_maxDocumentSize),
                     maxMessageSize: maxMessageSize.WithDefault(_maxMessageSize),

src/MongoDB.Driver.Core/Core/Servers/ServerMonitor.cs

@@ -1,4 +1,4 @@
-/* Copyright 2016 MongoDB Inc.
+/* Copyright 2016-2017 MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -177,6 +177,7 @@ private async Task<bool> HeartbeatAsync(CancellationToken cancellationToken)
                     canonicalEndPoint: isMasterResult.Me,
                     electionId: isMasterResult.ElectionId,
                     lastWriteTimestamp: isMasterResult.LastWriteTimestamp,
+                    logicalSessionTimeout: isMasterResult.LogicalSessionTimeout,
                     maxBatchCount: isMasterResult.MaxBatchCount,
                     maxDocumentSize: isMasterResult.MaxDocumentSize,
                     maxMessageSize: isMasterResult.MaxMessageSize,