fix: 🔥 Change socket timeout default to 0

Socket timeout by default is infinity.

NODE-2835

Author: nbbeeken

lib/cmap/connection.js

@@ -32,7 +32,7 @@ class Connection extends EventEmitter {
     this.id = options.id;
     this.address = streamIdentifier(stream);
     this.bson = options.bson;
-    this.socketTimeout = typeof options.socketTimeout === 'number' ? options.socketTimeout : 360000;
+    this.socketTimeout = typeof options.socketTimeout === 'number' ? options.socketTimeout : 0;
     this.host = options.host || 'localhost';
     this.port = options.port || 27017;
     this.monitorCommands =

lib/core/connection/connect.js

@@ -263,7 +263,7 @@ function makeConnection(family, options, cancellationToken, _callback) {
       : typeof options.connectTimeoutMS === 'number'
       ? options.connectTimeoutMS
       : 30000;
-  const socketTimeout = typeof options.socketTimeout === 'number' ? options.socketTimeout : 360000;
+  const socketTimeout = typeof options.socketTimeout === 'number' ? options.socketTimeout : 0;
   const rejectUnauthorized =
     typeof options.rejectUnauthorized === 'boolean' ? options.rejectUnauthorized : true;
 

lib/core/connection/connection.js

@@ -69,7 +69,7 @@ class Connection extends EventEmitter {
    * @param {boolean} [options.keepAlive=true] TCP Connection keep alive enabled
    * @param {number} [options.keepAliveInitialDelay=120000] Initial delay before TCP keep alive enabled
    * @param {number} [options.connectionTimeout=30000] TCP Connection timeout setting
-   * @param {number} [options.socketTimeout=360000] TCP Socket timeout setting
+   * @param {number} [options.socketTimeout=0] TCP Socket timeout setting
    * @param {boolean} [options.promoteLongs] Convert Long values from the db into Numbers if they fit into 53 bits
    * @param {boolean} [options.promoteValues] Promotes BSON values to native types where possible, set to false to only receive wrapper types.
    * @param {boolean} [options.promoteBuffers] Promotes Binary BSON values to native Node Buffers.
@@ -92,7 +92,7 @@ class Connection extends EventEmitter {
 
     this.port = options.port || 27017;
     this.host = options.host || 'localhost';
-    this.socketTimeout = typeof options.socketTimeout === 'number' ? options.socketTimeout : 360000;
+    this.socketTimeout = typeof options.socketTimeout === 'number' ? options.socketTimeout : 0;
 
     // These values are inspected directly in tests, but maybe not necessary to keep around
     this.keepAlive = typeof options.keepAlive === 'boolean' ? options.keepAlive : true;
@@ -316,8 +316,7 @@ class Connection extends EventEmitter {
     if (typeof options === 'function') (callback = options), (options = {});
 
     const conn = this;
-    const socketTimeout =
-      typeof options.socketTimeout === 'number' ? options.socketTimeout : 360000;
+    const socketTimeout = typeof options.socketTimeout === 'number' ? options.socketTimeout : 0;
     const bson = conn.options.bson;
     const query = new Query(bson, ns, command, {
       numberToSkip: 0,

lib/core/connection/pool.js

@@ -63,8 +63,8 @@ var _id = 0;
  * @param {number} [options.keepAliveInitialDelay=120000] Initial delay before TCP keep alive enabled
  * @param {boolean} [options.noDelay=true] TCP Connection no delay
  * @param {number} [options.connectionTimeout=30000] TCP Connection timeout setting
- * @param {number} [options.socketTimeout=360000] TCP Socket timeout setting
- * @param {number} [options.monitoringSocketTimeout=30000] TCP Socket timeout setting for replicaset monitoring socket
+ * @param {number} [options.socketTimeout=0] TCP Socket timeout setting
+ * @param {number} [options.monitoringSocketTimeout=0] TCP Socket timeout setting for replicaset monitoring socket
  * @param {boolean} [options.ssl=false] Use SSL for connection
  * @param {boolean|function} [options.checkServerIdentity=true] Ensure we check server identify during SSL, set to false to disable checking. Only works for Node 0.12.x or higher. You can pass in a boolean or your own checkServerIdentity override function.
  * @param {Buffer} [options.ca] SSL Certificate store binary buffer
@@ -111,7 +111,7 @@ var Pool = function(topology, options) {
       minSize: 0,
       // socket settings
       connectionTimeout: 30000,
-      socketTimeout: 360000,
+      socketTimeout: 0,
       keepAlive: true,
       keepAliveInitialDelay: 120000,
       noDelay: true,

lib/core/topologies/replset.js

@@ -919,7 +919,7 @@ ReplSet.prototype.connect = function(options) {
     );
   });
 
-  // Error out as high availbility interval must be < than socketTimeout
+  // Error out as high availability interval must be < than socketTimeout
   if (
     this.s.options.socketTimeout > 0 &&
     this.s.options.socketTimeout <= this.s.options.haInterval

lib/core/topologies/server.js

@@ -75,7 +75,7 @@ function topologyId(server) {
  * @param {number} [options.keepAliveInitialDelay=120000] Initial delay before TCP keep alive enabled
  * @param {boolean} [options.noDelay=true] TCP Connection no delay
  * @param {number} [options.connectionTimeout=30000] TCP Connection timeout setting
- * @param {number} [options.socketTimeout=360000] TCP Socket timeout setting
+ * @param {number} [options.socketTimeout=0] TCP Socket timeout setting
  * @param {boolean} [options.ssl=false] Use SSL for connection
  * @param {boolean|function} [options.checkServerIdentity=true] Ensure we check server identify during SSL, set to false to disable checking. Only works for Node 0.12.x or higher. You can pass in a boolean or your own checkServerIdentity override function.
  * @param {Buffer} [options.ca] SSL Certificate store binary buffer

lib/mongo_client.js

@@ -97,7 +97,7 @@ const validOptions = require('./operations/connect').validOptions;
  * @param {boolean} [options.keepAlive=true] TCP Connection keep alive enabled
  * @param {number} [options.keepAliveInitialDelay=120000] The number of milliseconds to wait before initiating keepAlive on the TCP socket
  * @param {number} [options.connectTimeoutMS=10000] How long to wait for a connection to be established before timing out
- * @param {number} [options.socketTimeoutMS=360000] How long a send or receive on a socket can take before timing out
+ * @param {number} [options.socketTimeoutMS=0] How long a send or receive on a socket can take before timing out
  * @param {number} [options.family] Version of IP stack. Can be 4, 6 or null (default).
  * If null, will attempt to connect with IPv6, and will fall back to IPv4 on failure
  * @param {number} [options.reconnectTries=30] Server attempt to reconnect #times
@@ -371,7 +371,7 @@ MongoClient.prototype.isConnected = function(options) {
  * @param {boolean} [options.keepAlive=true] TCP Connection keep alive enabled
  * @param {number} [options.keepAliveInitialDelay=120000] The number of milliseconds to wait before initiating keepAlive on the TCP socket
  * @param {number} [options.connectTimeoutMS=10000] How long to wait for a connection to be established before timing out
- * @param {number} [options.socketTimeoutMS=360000] How long a send or receive on a socket can take before timing out
+ * @param {number} [options.socketTimeoutMS=0] How long a send or receive on a socket can take before timing out
  * @param {number} [options.family] Version of IP stack. Can be 4, 6 or null (default).
  * If null, will attempt to connect with IPv6, and will fall back to IPv4 on failure
  * @param {number} [options.reconnectTries=30] Server attempt to reconnect #times

lib/operations/connect.js

@@ -290,7 +290,7 @@ function connect(mongoClient, url, options, callback) {
     const _finalOptions = createUnifiedOptions(object, options);
 
     // Check if we have connection and socket timeout set
-    if (_finalOptions.socketTimeoutMS == null) _finalOptions.socketTimeoutMS = 360000;
+    if (_finalOptions.socketTimeoutMS == null) _finalOptions.socketTimeoutMS = 0;
     if (_finalOptions.connectTimeoutMS == null) _finalOptions.connectTimeoutMS = 10000;
     if (_finalOptions.retryWrites == null) _finalOptions.retryWrites = true;
     if (_finalOptions.useRecoveryToken == null) _finalOptions.useRecoveryToken = true;
@@ -788,7 +788,7 @@ function translateOptions(options, translationOptions) {
   }
 
   // Set the socket and connection timeouts
-  if (options.socketTimeoutMS == null) options.socketTimeoutMS = 360000;
+  if (options.socketTimeoutMS == null) options.socketTimeoutMS = 0;
   if (options.connectTimeoutMS == null) options.connectTimeoutMS = 10000;
 
   if (!translationOptions.createServers) {

lib/topologies/mongos.js

@@ -84,7 +84,7 @@ var legalOptionNames = [
  * @param {boolean} [options.socketOptions.keepAlive=true] TCP Connection keep alive enabled
  * @param {number} [options.socketOptions.keepAliveInitialDelay=120000] The number of milliseconds to wait before initiating keepAlive on the TCP socket
  * @param {number} [options.socketOptions.connectTimeoutMS=10000] How long to wait for a connection to be established before timing out
- * @param {number} [options.socketOptions.socketTimeoutMS=360000] How long a send or receive on a socket can take before timing out
+ * @param {number} [options.socketOptions.socketTimeoutMS=0] How long a send or receive on a socket can take before timing out
  * @param {boolean} [options.domainsEnabled=false] Enable the wrapping of the callback in the current domain, disabled by default to avoid perf hit.
  * @param {boolean} [options.monitorCommands=false] Enable command monitoring for this topology
  * @fires Mongos#connect

lib/topologies/server.js

@@ -86,7 +86,7 @@ var legalOptionNames = [
  * @param {boolean} [options.socketOptions.keepAlive=true] TCP Connection keep alive enabled
  * @param {number} [options.socketOptions.keepAliveInitialDelay=120000] The number of milliseconds to wait before initiating keepAlive on the TCP socket
  * @param {number} [options.socketOptions.connectTimeoutMS=10000] How long to wait for a connection to be established before timing out
- * @param {number} [options.socketOptions.socketTimeoutMS=360000] How long a send or receive on a socket can take before timing out
+ * @param {number} [options.socketOptions.socketTimeoutMS=0] How long a send or receive on a socket can take before timing out
  * @param {number} [options.reconnectTries=30] Server attempt to reconnect #times
  * @param {number} [options.reconnectInterval=1000] Server will wait # milliseconds between retries
  * @param {boolean} [options.monitoring=true] Triggers the server instance to call ismaster

test/functional/mongo_client.test.js

@@ -517,7 +517,10 @@ describe('MongoClient', function() {
         {},
         {
           keepAlive: true,
-          keepAliveInitialDelay: 100
+          keepAliveInitialDelay: 100,
+          // keepAliveInitialDelay is clamped to half the size of socketTimeout
+          // if socketTimeout is less than keepAliveInitialDelay
+          socketTimeout: 101
         }
       );