CSHARP-2525: Check only non-unknown server descriptions to determine incompatibility.

DmitryLukyanov · DmitryLukyanov · commit 74653292bd80 · 2019-06-27T21:28:53.000+03:00
diff --git a/src/MongoDB.Driver.Core/Core/Servers/ServerDescription.cs b/src/MongoDB.Driver.Core/Core/Servers/ServerDescription.cs
@@ -194,13 +194,10 @@ public TimeSpan HeartbeatInterval
         /// <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);
-            }
-        }
+        public bool IsCompatibleWithDriver =>
+            _type == ServerType.Unknown ||
+            _wireVersionRange == null || 
+            _wireVersionRange.Overlaps(Cluster.SupportedWireVersionRange);
 
         /// <summary>
         /// Gets a value indicating whether this instance is a data bearing server.
diff --git a/src/MongoDB.Driver.Core/MongoIncompatibleDriverException.cs b/src/MongoDB.Driver.Core/MongoIncompatibleDriverException.cs
@@ -20,6 +20,7 @@
 #endif
 using MongoDB.Driver.Core.Clusters;
 using MongoDB.Driver.Core.Misc;
+using MongoDB.Driver.Core.Servers;
 
 namespace MongoDB.Driver
 {
@@ -35,8 +36,7 @@ public class MongoIncompatibleDriverException : MongoClientException
         // static methods
         internal static void ThrowIfNotSupported(ClusterDescription description)
         {
-            var isIncompatible = description.Servers
-                .Any(sd => sd.WireVersionRange != null && !sd.WireVersionRange.Overlaps(Cluster.SupportedWireVersionRange));
+            var isIncompatible = description.Servers.Any(IsServerIncompatible);
 
             if (isIncompatible)
             {
@@ -46,8 +46,7 @@ internal static void ThrowIfNotSupported(ClusterDescription description)
 
         private static string FormatMessage(ClusterDescription description)
         {
-            var incompatibleServer = description.Servers
-                .FirstOrDefault(sd => sd.WireVersionRange != null && !sd.WireVersionRange.Overlaps(Cluster.SupportedWireVersionRange));
+            var incompatibleServer = description.Servers.FirstOrDefault(IsServerIncompatible);
 
             if (incompatibleServer == null)
             {
@@ -63,6 +62,14 @@ private static string FormatMessage(ClusterDescription description)
             return $"Server at {EndPointHelper.ToString(incompatibleServer.EndPoint)} requires wire version {incompatibleServer.WireVersionRange.Min},"
                 + $" but this version of the driver only supports up to {Cluster.SupportedWireVersionRange.Max}.";
         }
+
+        private static bool IsServerIncompatible(ServerDescription description)
+        {
+            return
+                description.Type != ServerType.Unknown &&
+                description.WireVersionRange != null &&
+                !description.WireVersionRange.Overlaps(Cluster.SupportedWireVersionRange);
+        }
         #endregion
 
         // constructors
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Clusters/ClusterDescriptionTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/Clusters/ClusterDescriptionTests.cs
@@ -135,7 +135,7 @@ public void IsCompatibleWithDriver_should_return_expected_result(int[] wireRange
                 var serverId = new ServerId(clusterId, endPoint);
                 var wireRange = wireRanges[i];
                 var wireVersionRange = wireRange == 0 ? new Range<int>(0, 0) : wireRange == 1 ? new Range<int>(2, 6) : null;
-                var server = new ServerDescription(serverId, endPoint, wireVersionRange: wireVersionRange);
+                var server = new ServerDescription(serverId, endPoint, wireVersionRange: wireVersionRange, type: ServerType.Standalone);
                 subject = subject.WithServerDescription(server);
             }
 
@@ -144,6 +144,40 @@ public void IsCompatibleWithDriver_should_return_expected_result(int[] wireRange
             result.Should().Be(expectedResult);
         }
 
+        [Theory]
+        [InlineData(new int[0])]
+        [InlineData(new int[] { 0 })]
+        [InlineData(new int[] { 1 })]
+        [InlineData(new int[] { 2 })]
+        [InlineData(new int[] { 0, 0 })]
+        [InlineData(new int[] { 0, 1 })]
+        [InlineData(new int[] { 0, 2 })]
+        [InlineData(new int[] { 1, 0 })]
+        [InlineData(new int[] { 1, 1 })]
+        [InlineData(new int[] { 1, 2 })]
+        [InlineData(new int[] { 2, 0 })]
+        [InlineData(new int[] { 2, 1 })]
+        [InlineData(new int[] { 2, 2 })]
+        public void IsCompatibleWithDriver_should_return_true_if_server_unknown(int[] wireRanges)
+        {
+            var clusterId = new ClusterId(1);
+            var connectionMode = ClusterConnectionMode.Automatic;
+            var subject = ClusterDescription.CreateInitial(clusterId, connectionMode);
+            for (var i = 0; i < wireRanges.Length; i++)
+            {
+                var endPoint = new DnsEndPoint("localhost", i);
+                var serverId = new ServerId(clusterId, endPoint);
+                var wireRange = wireRanges[i];
+                var wireVersionRange = wireRange == 0 ? new Range<int>(0, 0) : wireRange == 1 ? new Range<int>(2, 6) : null;
+                var server = new ServerDescription(serverId, endPoint, wireVersionRange: wireVersionRange, type: ServerType.Unknown);
+                subject = subject.WithServerDescription(server);
+            }
+
+            var result = subject.IsCompatibleWithDriver;
+
+            result.Should().BeTrue();
+        }
+
         [Fact]
         public void LogicalSessionTimeout_should_return_expected_result_with_0_servers()
         {
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Servers/ServerDescriptionTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/Servers/ServerDescriptionTests.cs
@@ -18,14 +18,12 @@
 using FluentAssertions;
 using MongoDB.Bson;
 using MongoDB.Driver.Core.Clusters;
-using MongoDB.Driver.Core.Connections;
 using MongoDB.Driver.Core.Misc;
-using MongoDB.Driver.Core.Servers;
 using Xunit;
 
 namespace MongoDB.Driver.Core.Servers
 {
-    class ServerDescriptionTests
+    public class ServerDescriptionTests
     {
         #region static
         // static fields
@@ -187,8 +185,17 @@ public void Equals_should_return_false_when_any_field_is_not_equal(string notEqu
         [Fact]
         public void Equals_should_return_true_when_all_fields_are_equal()
         {
-            ServerDescription subject = new ServerDescription(__serverId, __endPoint);
-            ServerDescription serverDescription2 = new ServerDescription(__serverId, __endPoint);
+            var lastUpdateTimestamp = DateTime.UtcNow;
+            ServerDescription subject = new ServerDescription(
+                __serverId,
+                __endPoint,
+                type: ServerType.Standalone,
+                lastUpdateTimestamp: lastUpdateTimestamp);
+            ServerDescription serverDescription2 = new ServerDescription(
+                __serverId,
+                __endPoint,
+                type: ServerType.Standalone,
+                lastUpdateTimestamp: lastUpdateTimestamp);
             subject.Equals(serverDescription2).Should().BeTrue();
             subject.Equals((object)serverDescription2).Should().BeTrue();
             subject.GetHashCode().Should().Be(serverDescription2.GetHashCode());
@@ -206,15 +213,15 @@ public void Equals_should_return_true_when_all_fields_are_equal()
         [InlineData(new[] { 2, 7 }, true)]
         [InlineData(new[] { 6, 6 }, true)]
         [InlineData(new[] { 6, 7 }, true)]
-        [InlineData(new[] { 7, 7 }, false)]
-        [InlineData(new[] { 7, 8 }, false)]
+        [InlineData(new[] { 7, 7 }, true)]
+        [InlineData(new[] { 7, 8 }, true)]
         public void IsCompatibleWithDriver_should_return_expected_result(int[] minMaxWireVersions, bool expectedResult)
         {
             var clusterId = new ClusterId(1);
             var endPoint = new DnsEndPoint("localhost", 27017);
             var serverId = new ServerId(clusterId, endPoint);
             var wireVersionRange = minMaxWireVersions == null ? null : new Range<int>(minMaxWireVersions[0], minMaxWireVersions[1]);
-            var subject = new ServerDescription(serverId, endPoint, wireVersionRange: wireVersionRange);
+            var subject = new ServerDescription(serverId, endPoint, wireVersionRange: wireVersionRange, type: ServerType.Standalone);
 
             var result = subject.IsCompatibleWithDriver;
 
@@ -373,7 +380,7 @@ public void With_should_return_same_instance_when_all_fields_are_equal()
                 version: version,
                 wireVersionRange: wireVersionRange);
 
-            result.Should().BeSameAs(subject);
+            result.ShouldBeEquivalentTo(subject);
         }
     }
 }
diff --git a/tests/MongoDB.Driver.Core.Tests/MongoIncompatibleDriverExceptionTests.cs b/tests/MongoDB.Driver.Core.Tests/MongoIncompatibleDriverExceptionTests.cs
@@ -37,7 +37,7 @@ public MongoIncompatibleDriverExceptionTests()
             var clusterType = ClusterType.Standalone;
             var endPoint = new DnsEndPoint("localhost", 27017);
             var serverId = new ServerId(clusterId, endPoint);
-            var server = new ServerDescription(serverId, endPoint, wireVersionRange: new Range<int>(0, 0));
+            var server = new ServerDescription(serverId, endPoint, wireVersionRange: new Range<int>(0, 0), type: ServerType.Standalone);
             var servers = new[] { server };
             _clusterDescription = new ClusterDescription(clusterId, connectionMode, clusterType, servers);
         }
diff --git a/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/compatible_unknown.json b/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/compatible_unknown.json
@@ -0,0 +1,39 @@
+{
+  "description": "Replica set member and an unknown server",
+  "uri": "mongodb://a,b/?replicaSet=rs",
+  "phases": [
+    {
+      "responses": [
+        [
+          "a:27017",
+          {
+            "ok": 1,
+            "ismaster": true,
+            "setName": "rs",
+            "hosts": [
+              "a:27017",
+              "b:27017"
+            ],
+            "minWireVersion": 0,
+            "maxWireVersion": 6
+          }
+        ]
+      ],
+      "outcome": {
+        "servers": {
+          "a:27017": {
+            "type": "RSPrimary",
+            "setName": "rs"
+          },
+          "b:27017": {
+            "type": "Unknown"
+          }
+        },
+        "topologyType": "ReplicaSetWithPrimary",
+        "setName": "rs",
+        "logicalSessionTimeoutMinutes": null,
+        "compatible": true
+      }
+    }
+  ]
+}
diff --git a/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/compatible_unknown.yml b/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/compatible_unknown.yml
@@ -0,0 +1,31 @@
+description: "Replica set member and an unknown server"
+uri: "mongodb://a,b/?replicaSet=rs"
+phases: [
+    {
+        responses: [
+                ["a:27017", {
+                    ok: 1,
+                    ismaster: true,
+                    setName: "rs",
+                    hosts: ["a:27017", "b:27017"],
+                    minWireVersion: 0,
+                    maxWireVersion: 6
+                }],
+        ],
+        outcome: {
+            servers: {
+                "a:27017": {
+                    type: "RSPrimary",
+                    setName: "rs"
+                },
+                "b:27017": {
+                    type: "Unknown",
+                }
+            },
+            topologyType: "ReplicaSetWithPrimary",
+            setName: "rs",
+            logicalSessionTimeoutMinutes: null,
+            compatible: true
+        }
+    }
+]
diff --git a/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/incompatible_arbiter.json b/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/incompatible_arbiter.json
@@ -0,0 +1,54 @@
+{
+  "description": "Incompatible arbiter",
+  "uri": "mongodb://a,b/?replicaSet=rs",
+  "phases": [
+    {
+      "responses": [
+        [
+          "a:27017",
+          {
+            "ok": 1,
+            "ismaster": true,
+            "setName": "rs",
+            "hosts": [
+              "a:27017",
+              "b:27017"
+            ],
+            "minWireVersion": 0,
+            "maxWireVersion": 6
+          }
+        ],
+        [
+          "b:27017",
+          {
+            "ok": 1,
+            "arbiterOnly": true,
+            "setName": "rs",
+            "hosts": [
+              "a:27017",
+              "b:27017"
+            ],
+            "minWireVersion": 0,
+            "maxWireVersion": 1
+          }
+        ]
+      ],
+      "outcome": {
+        "servers": {
+          "a:27017": {
+            "type": "RSPrimary",
+            "setName": "rs"
+          },
+          "b:27017": {
+            "type": "RSArbiter",
+            "setName": "rs"
+          }
+        },
+        "topologyType": "ReplicaSetWithPrimary",
+        "setName": "rs",
+        "logicalSessionTimeoutMinutes": null,
+        "compatible": false
+      }
+    }
+  ]
+}
diff --git a/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/incompatible_arbiter.yml b/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/incompatible_arbiter.yml
@@ -0,0 +1,32 @@
+description: "Incompatible arbiter"
+uri: "mongodb://a,b/?replicaSet=rs"
+phases:
+  - responses:
+      -
+        - "a:27017"
+        - ok: 1
+          ismaster: true
+          setName: "rs"
+          hosts: ["a:27017", "b:27017"]
+          minWireVersion: 0
+          maxWireVersion: 6
+      -
+        - "b:27017"
+        - ok: 1
+          arbiterOnly: true
+          setName: "rs"
+          hosts: ["a:27017", "b:27017"]
+          minWireVersion: 0
+          maxWireVersion: 1
+    outcome:
+      servers:
+        "a:27017":
+          type: "RSPrimary"
+          setName: "rs"
+        "b:27017":
+          type: "RSArbiter"
+          setName: "rs"
+      topologyType: "ReplicaSetWithPrimary"
+      setName: "rs"
+      logicalSessionTimeoutMinutes: ~
+      compatible: false
diff --git a/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/incompatible_ghost.json b/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/incompatible_ghost.json
@@ -0,0 +1,49 @@
+{
+  "description": "Incompatible ghost",
+  "uri": "mongodb://a,b/?replicaSet=rs",
+  "phases": [
+    {
+      "responses": [
+        [
+          "a:27017",
+          {
+            "ok": 1,
+            "ismaster": true,
+            "setName": "rs",
+            "hosts": [
+              "a:27017",
+              "b:27017"
+            ],
+            "minWireVersion": 0,
+            "maxWireVersion": 6
+          }
+        ],
+        [
+          "b:27017",
+          {
+            "ok": 1,
+            "isreplicaset": true,
+            "minWireVersion": 0,
+            "maxWireVersion": 1
+          }
+        ]
+      ],
+      "outcome": {
+        "servers": {
+          "a:27017": {
+            "type": "RSPrimary",
+            "setName": "rs"
+          },
+          "b:27017": {
+            "type": "RSGhost",
+            "setName": null
+          }
+        },
+        "topologyType": "ReplicaSetWithPrimary",
+        "setName": "rs",
+        "logicalSessionTimeoutMinutes": null,
+        "compatible": false
+      }
+    }
+  ]
+}
diff --git a/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/incompatible_ghost.yml b/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/incompatible_ghost.yml
diff --git a/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/incompatible_other.json b/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/incompatible_other.json
diff --git a/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/incompatible_other.yml b/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/incompatible_other.yml
diff --git a/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/normalize_case_me.json b/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/normalize_case_me.json
diff --git a/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/normalize_case_me.yml b/tests/MongoDB.Driver.Core.Tests/Specifications/server-discovery-and-monitoring/tests/rs/normalize_case_me.yml

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public MongoIncompatibleDriverExceptionTests()`
`37`	`37`	`var clusterType = ClusterType.Standalone;`
`38`	`38`	`var endPoint = new DnsEndPoint("localhost", 27017);`
`39`	`39`	`var serverId = new ServerId(clusterId, endPoint);`
`40`		`- var server = new ServerDescription(serverId, endPoint, wireVersionRange: new Range<int>(0, 0));`
	`40`	`+ var server = new ServerDescription(serverId, endPoint, wireVersionRange: new Range<int>(0, 0), type: ServerType.Standalone);`
`41`	`41`	`var servers = new[] { server };`
`42`	`42`	`_clusterDescription = new ClusterDescription(clusterId, connectionMode, clusterType, servers);`
`43`	`43`	`}`