chore(wireVersion): update max-wire-version

daprahamian · daprahamian · commit f88da4efb791 · 2019-03-12T13:16:56.000-04:00
Also updates error messages for wire-version incompatibility.

Fixes NODE-1697
diff --git a/lib/connection/connect.js b/lib/connection/connect.js
@@ -6,6 +6,11 @@ const Query = require('./commands').Query;
 const createClientInfo = require('../topologies/shared').createClientInfo;
 const MongoError = require('../error').MongoError;
 const defaultAuthProviders = require('../auth/defaultAuthProviders').defaultAuthProviders;
+const WIRE_CONSTANTS = require('../wireprotocol/constants');
+const MAX_SUPPORTED_WIRE_VERSION = WIRE_CONSTANTS.MAX_SUPPORTED_WIRE_VERSION;
+const MAX_SUPPORTED_SERVER_VERSION = WIRE_CONSTANTS.MAX_SUPPORTED_SERVER_VERSION;
+const MIN_SUPPORTED_WIRE_VERSION = WIRE_CONSTANTS.MIN_SUPPORTED_WIRE_VERSION;
+const MIN_SUPPORTED_SERVER_VERSION = WIRE_CONSTANTS.MIN_SUPPORTED_SERVER_VERSION;
 let AUTH_PROVIDERS;
 
 function connect(options, callback) {
@@ -44,10 +49,6 @@ function connect(options, callback) {
   });
 }
 
-function isSupportedServer(ismaster) {
-  return ismaster && typeof ismaster.maxWireVersion === 'number' && ismaster.maxWireVersion >= 2;
-}
-
 function getSaslSupportedMechs(options) {
   if (!(options && options.credentials)) {
     return {};
@@ -71,6 +72,34 @@ function getSaslSupportedMechs(options) {
   return { saslSupportedMechs: `${authSource}.${user}` };
 }
 
+function checkSupportedServer(ismaster, options) {
+  const serverVersionHighEnough =
+    ismaster &&
+    typeof ismaster.maxWireVersion === 'number' &&
+    ismaster.maxWireVersion >= MIN_SUPPORTED_WIRE_VERSION;
+  const serverVersionLowEnough =
+    ismaster &&
+    typeof ismaster.minWireVersion === 'number' &&
+    ismaster.minWireVersion <= MAX_SUPPORTED_WIRE_VERSION;
+
+  if (serverVersionHighEnough) {
+    if (serverVersionLowEnough) {
+      return null;
+    }
+
+    const message = `Server at ${options.host}:${options.port} reports minimum wire version ${
+      ismaster.minWireVersion
+    }, but this version of the Node.js Driver requires at most ${MAX_SUPPORTED_WIRE_VERSION} (MongoDB ${MAX_SUPPORTED_SERVER_VERSION})`;
+    return new MongoError(message);
+  }
+
+  const message = `Server at ${options.host}:${
+    options.port
+  } reports maximum wire version ${ismaster.maxWireVersion ||
+    0}, but this version of the Node.js Driver requires at least ${MIN_SUPPORTED_WIRE_VERSION} (MongoDB ${MIN_SUPPORTED_SERVER_VERSION})`;
+  return new MongoError(message);
+}
+
 function performInitialHandshake(conn, options, callback) {
   let compressors = [];
   if (options.compression && options.compression.compressors) {
@@ -98,23 +127,9 @@ function performInitialHandshake(conn, options, callback) {
       return;
     }
 
-    if (!isSupportedServer(ismaster)) {
-      const latestSupportedVersion = '2.6';
-      const latestSupportedMaxWireVersion = 2;
-      const message =
-        'Server at ' +
-        options.host +
-        ':' +
-        options.port +
-        ' reports wire version ' +
-        (ismaster.maxWireVersion || 0) +
-        ', but this version of the Node.js Driver requires at least ' +
-        latestSupportedMaxWireVersion +
-        ' (MongoDB' +
-        latestSupportedVersion +
-        ').';
-
-      callback(new MongoError(message), null);
+    const supportedServerErr = checkSupportedServer(ismaster, options);
+    if (supportedServerErr) {
+      callback(supportedServerErr, null);
       return;
     }
 
diff --git a/lib/sdam/topology_description.js b/lib/sdam/topology_description.js
@@ -2,11 +2,13 @@
 const ServerType = require('./server_description').ServerType;
 const ServerDescription = require('./server_description').ServerDescription;
 const ReadPreference = require('../topologies/read_preference');
+const WIRE_CONSTANTS = require('../wireprotocol/constants');
 
 // contstants related to compatability checks
-const MIN_SUPPORTED_SERVER_VERSION = '2.6';
-const MIN_SUPPORTED_WIRE_VERSION = 2;
-const MAX_SUPPORTED_WIRE_VERSION = 5;
+const MIN_SUPPORTED_SERVER_VERSION = WIRE_CONSTANTS.MIN_SUPPORTED_SERVER_VERSION;
+const MAX_SUPPORTED_SERVER_VERSION = WIRE_CONSTANTS.MAX_SUPPORTED_SERVER_VERSION;
+const MIN_SUPPORTED_WIRE_VERSION = WIRE_CONSTANTS.MIN_SUPPORTED_WIRE_VERSION;
+const MAX_SUPPORTED_WIRE_VERSION = WIRE_CONSTANTS.MAX_SUPPORTED_WIRE_VERSION;
 
 // An enumeration of topology types we know about
 const TopologyType = {
@@ -66,7 +68,7 @@ class TopologyDescription {
         this.compatible = false;
         this.compatibilityError = `Server at ${serverDescription.address} requires wire version ${
           serverDescription.minWireVersion
-        }, but this version of the driver only supports up to ${MAX_SUPPORTED_WIRE_VERSION}.`;
+        }, but this version of the driver only supports up to ${MAX_SUPPORTED_WIRE_VERSION} (MongoDB ${MAX_SUPPORTED_SERVER_VERSION})`;
       }
 
       if (serverDescription.maxWireVersion < MIN_SUPPORTED_WIRE_VERSION) {
diff --git a/lib/wireprotocol/constants.js b/lib/wireprotocol/constants.js
@@ -0,0 +1,13 @@
+'use strict';
+
+const MIN_SUPPORTED_SERVER_VERSION = '2.6';
+const MAX_SUPPORTED_SERVER_VERSION = '4.2';
+const MIN_SUPPORTED_WIRE_VERSION = 2;
+const MAX_SUPPORTED_WIRE_VERSION = 8;
+
+module.exports = {
+  MIN_SUPPORTED_SERVER_VERSION,
+  MAX_SUPPORTED_SERVER_VERSION,
+  MIN_SUPPORTED_WIRE_VERSION,
+  MAX_SUPPORTED_WIRE_VERSION
+};
