mongodb 3.3.1 → 3.3.4

package/lib/core/topologies/mongos.js

@@ -30,14 +30,15 @@ var DISCONNECTED = 'disconnected';
 var CONNECTING = 'connecting';
 var CONNECTED = 'connected';
 var UNREFERENCED = 'unreferenced';
+var DESTROYING = 'destroying';
 var DESTROYED = 'destroyed';
 
 function stateTransition(self, newState) {
   var legalTransitions = {
-    disconnected: [CONNECTING, DESTROYED, DISCONNECTED],
-    connecting: [CONNECTING, DESTROYED, CONNECTED, DISCONNECTED],
-    connected: [CONNECTED, DISCONNECTED, DESTROYED, UNREFERENCED],
-    unreferenced: [UNREFERENCED, DESTROYED],
+    disconnected: [CONNECTING, DESTROYING, DESTROYED, DISCONNECTED],
+    connecting: [CONNECTING, DESTROYING, DESTROYED, CONNECTED, DISCONNECTED],
+    connected: [CONNECTED, DISCONNECTED, DESTROYING, DESTROYED, UNREFERENCED],
+    unreferenced: [UNREFERENCED, DESTROYING, DESTROYED],
     destroyed: [DESTROYED]
   };
 
@@ -46,9 +47,9 @@ function stateTransition(self, newState) {
   if (legalStates && legalStates.indexOf(newState) !== -1) {
     self.state = newState;
   } else {
-    self.logger.error(
+    self.s.logger.error(
       f(
-        'Pool with id [%s] failed attempted illegal state transition from [%s] to [%s] only following state allowed [%s]',
+        'Mongos with id [%s] failed attempted illegal state transition from [%s] to [%s] only following state allowed [%s]',
         self.id,
         self.state,
         newState,
@@ -292,7 +293,10 @@ Mongos.prototype.auth = function(credentials, callback) {
 
 function handleEvent(self) {
   return function() {
-    if (self.state === DESTROYED) return;
+    if (self.state === DESTROYED || self.state === DESTROYING) {
+      return;
+    }
+
     // Move to list of disconnectedProxies
     moveServerFrom(self.connectedProxies, self.disconnectedProxies, this);
     // Emit the initial topology
@@ -366,7 +370,8 @@ function handleInitialConnectEvent(self, event) {
           self.s.logger.warn(f(message, _this.name));
         }
 
-        // This is not a mongos proxy, remove it completely
+        // This is not a mongos proxy, destroy and remove it completely
+        _this.destroy(true);
         removeProxyFrom(self.connectingProxies, _this);
         // Emit the left event
         self.emit('left', 'server', _this);
@@ -445,10 +450,9 @@ function connectProxies(self, servers) {
       server.connect(self.s.connectOptions);
     }, timeoutInterval);
   }
+
   // Start all the servers
-  while (servers.length > 0) {
-    connect(servers.shift(), timeoutInterval++);
-  }
+  servers.forEach(server => connect(server, timeoutInterval++));
 }
 
 function pickProxy(self, session) {
@@ -541,14 +545,14 @@ function reconnectProxies(self, proxies, callback) {
       count = count - 1;
 
       // Destroyed
-      if (self.state === DESTROYED || self.state === UNREFERENCED) {
+      if (self.state === DESTROYED || self.state === DESTROYING || self.state === UNREFERENCED) {
         moveServerFrom(self.connectingProxies, self.disconnectedProxies, _self);
         return this.destroy();
       }
 
       if (event === 'connect') {
         // Destroyed
-        if (self.state === DESTROYED || self.state === UNREFERENCED) {
+        if (self.state === DESTROYED || self.state === DESTROYING || self.state === UNREFERENCED) {
           moveServerFrom(self.connectingProxies, self.disconnectedProxies, _self);
           return _self.destroy();
         }
@@ -592,7 +596,7 @@ function reconnectProxies(self, proxies, callback) {
   function execute(_server, i) {
     setTimeout(function() {
       // Destroyed
-      if (self.state === DESTROYED || self.state === UNREFERENCED) {
+      if (self.state === DESTROYED || self.state === DESTROYING || self.state === UNREFERENCED) {
         return;
       }
 
@@ -608,7 +612,7 @@ function reconnectProxies(self, proxies, callback) {
         })
       );
 
-      destroyServer(_server);
+      destroyServer(_server, { force: true });
       removeProxyFrom(self.disconnectedProxies, _server);
 
       // Relay the server description change
@@ -645,9 +649,17 @@ function reconnectProxies(self, proxies, callback) {
 function topologyMonitor(self, options) {
   options = options || {};
 
+  // no need to set up the monitor if we're already closed
+  if (self.state === DESTROYED || self.state === DESTROYING || self.state === UNREFERENCED) {
+    return;
+  }
+
   // Set momitoring timeout
   self.haTimeoutId = setTimeout(function() {
-    if (self.state === DESTROYED || self.state === UNREFERENCED) return;
+    if (self.state === DESTROYED || self.state === DESTROYING || self.state === UNREFERENCED) {
+      return;
+    }
+
     // If we have a primary and a disconnect handler, execute
     // buffered operations
     if (self.isConnected() && self.s.disconnectHandler) {
@@ -678,7 +690,11 @@ function topologyMonitor(self, options) {
           socketTimeout: self.s.options.connectionTimeout || 2000
         },
         function(err, r) {
-          if (self.state === DESTROYED || self.state === UNREFERENCED) {
+          if (
+            self.state === DESTROYED ||
+            self.state === DESTROYING ||
+            self.state === UNREFERENCED
+          ) {
             // Move from connectingProxies
             moveServerFrom(self.connectedProxies, self.disconnectedProxies, _server);
             _server.destroy();
@@ -727,7 +743,9 @@ function topologyMonitor(self, options) {
 
       // Attempt to connect to any unknown servers
       return reconnectProxies(self, self.disconnectedProxies, function() {
-        if (self.state === DESTROYED || self.state === UNREFERENCED) return;
+        if (self.state === DESTROYED || self.state === DESTROYING || self.state === UNREFERENCED) {
+          return;
+        }
 
         // Are we connected ? emit connect event
         if (self.state === CONNECTING && options.firstConnect) {
@@ -751,11 +769,24 @@ function topologyMonitor(self, options) {
         count = count - 1;
 
         if (count === 0) {
-          if (self.state === DESTROYED || self.state === UNREFERENCED) return;
+          if (
+            self.state === DESTROYED ||
+            self.state === DESTROYING ||
+            self.state === UNREFERENCED
+          ) {
+            return;
+          }
 
           // Attempt to connect to any unknown servers
           reconnectProxies(self, self.disconnectedProxies, function() {
-            if (self.state === DESTROYED || self.state === UNREFERENCED) return;
+            if (
+              self.state === DESTROYED ||
+              self.state === DESTROYING ||
+              self.state === UNREFERENCED
+            ) {
+              return;
+            }
+
             // Perform topology monitor
             topologyMonitor(self);
           });
@@ -796,6 +827,14 @@ Mongos.prototype.unref = function() {
  * @method
  */
 Mongos.prototype.destroy = function(options, callback) {
+  if (typeof options === 'function') {
+    callback = options;
+    options = {};
+  }
+
+  options = options || {};
+
+  stateTransition(this, DESTROYING);
   if (this.haTimeoutId) {
     clearTimeout(this.haTimeoutId);
   }
@@ -929,7 +968,9 @@ Mongos.prototype.insert = function(ns, ops, options, callback) {
     (callback = options), (options = {}), (options = options || {});
   }
 
-  if (this.state === DESTROYED) return callback(new MongoError(f('topology was destroyed')));
+  if (this.state === DESTROYED) {
+    return callback(new MongoError(f('topology was destroyed')));
+  }
 
   // Not connected but we have a disconnecthandler
   if (!this.isConnected() && this.s.disconnectHandler != null) {
@@ -963,7 +1004,9 @@ Mongos.prototype.update = function(ns, ops, options, callback) {
     (callback = options), (options = {}), (options = options || {});
   }
 
-  if (this.state === DESTROYED) return callback(new MongoError(f('topology was destroyed')));
+  if (this.state === DESTROYED) {
+    return callback(new MongoError(f('topology was destroyed')));
+  }
 
   // Not connected but we have a disconnecthandler
   if (!this.isConnected() && this.s.disconnectHandler != null) {
@@ -997,7 +1040,9 @@ Mongos.prototype.remove = function(ns, ops, options, callback) {
     (callback = options), (options = {}), (options = options || {});
   }
 
-  if (this.state === DESTROYED) return callback(new MongoError(f('topology was destroyed')));
+  if (this.state === DESTROYED) {
+    return callback(new MongoError(f('topology was destroyed')));
+  }
 
   // Not connected but we have a disconnecthandler
   if (!this.isConnected() && this.s.disconnectHandler != null) {
@@ -1036,7 +1081,10 @@ Mongos.prototype.command = function(ns, cmd, options, callback) {
     (callback = options), (options = {}), (options = options || {});
   }
 
-  if (this.state === DESTROYED) return callback(new MongoError(f('topology was destroyed')));
+  if (this.state === DESTROYED) {
+    return callback(new MongoError(f('topology was destroyed')));
+  }
+
   var self = this;
 
   // Pick a proxy

package/lib/core/topologies/replset.js

@@ -277,27 +277,34 @@ function rexecuteOperations(self) {
 }
 
 function connectNewServers(self, servers, callback) {
+  // No new servers
+  if (servers.length === 0) {
+    return callback();
+  }
+
   // Count lefts
   var count = servers.length;
   var error = null;
 
+  function done() {
+    count = count - 1;
+    if (count === 0) {
+      callback(error);
+    }
+  }
+
   // Handle events
   var _handleEvent = function(self, event) {
     return function(err) {
       var _self = this;
-      count = count - 1;
 
       // Destroyed
       if (self.state === DESTROYED || self.state === UNREFERENCED) {
-        return this.destroy({ force: true });
+        this.destroy({ force: true });
+        return done();
       }
 
       if (event === 'connect') {
-        // Destroyed
-        if (self.state === DESTROYED || self.state === UNREFERENCED) {
-          return _self.destroy({ force: true });
-        }
-
         // Update the state
         var result = self.s.replicaSetState.update(_self);
         // Update the state with the new server
@@ -332,17 +339,10 @@ function connectNewServers(self, servers, callback) {
 
       // Rexecute any stalled operation
       rexecuteOperations(self);
-
-      // Are we done finish up callback
-      if (count === 0) {
-        callback(error);
-      }
+      done();
     };
   };
 
-  // No new servers
-  if (count === 0) return callback();
-
   // Execute method
   function execute(_server, i) {
     setTimeout(function() {
@@ -351,6 +351,17 @@ function connectNewServers(self, servers, callback) {
         return;
       }
 
+      // remove existing connecting server if it's failed to connect, otherwise
+      // wait for that server to connect
+      const existingServerIdx = self.s.connectingServers.findIndex(s => s.name === _server);
+      if (existingServerIdx >= 0) {
+        const connectingServer = self.s.connectingServers[existingServerIdx];
+        connectingServer.destroy({ force: true });
+
+        self.s.connectingServers.splice(existingServerIdx, 1);
+        return done();
+      }
+
       // Create a new server instance
       var server = new Server(
         Object.assign({}, self.s.options, {
@@ -378,6 +389,7 @@ function connectNewServers(self, servers, callback) {
       // Command Monitoring events
       relayEvents(server, self, ['commandStarted', 'commandSucceeded', 'commandFailed']);
 
+      self.s.connectingServers.push(server);
       server.connect(self.s.connectOptions);
     }, i);
   }
@@ -951,6 +963,11 @@ ReplSet.prototype.auth = function(credentials, callback) {
  * @method
  */
 ReplSet.prototype.destroy = function(options, callback) {
+  if (typeof options === 'function') {
+    callback = options;
+    options = {};
+  }
+
   options = options || {};
 
   let destroyCount = this.s.connectingServers.length + 1; // +1 for the callback from `replicaSetState.destroy`
@@ -1202,6 +1219,7 @@ function executeWriteOperation(args, options, callback) {
 
     // Per SDAM, remove primary from replicaset
     if (self.s.replicaSetState.primary) {
+      self.s.replicaSetState.primary.destroy();
       self.s.replicaSetState.remove(self.s.replicaSetState.primary, { force: true });
     }
 
@@ -1363,6 +1381,7 @@ ReplSet.prototype.command = function(ns, cmd, options, callback) {
 
     // Per SDAM, remove primary from replicaset
     if (this.s.replicaSetState.primary) {
+      this.s.replicaSetState.primary.destroy();
       this.s.replicaSetState.remove(this.s.replicaSetState.primary, { force: true });
     }
 

package/lib/core/topologies/replset_state.js

@@ -391,7 +391,7 @@ ReplSetState.prototype.update = function(server) {
     removeFrom(server, self.unknownServers);
 
     // Destroy the instance
-    server.destroy();
+    server.destroy({ force: true });
 
     // Set the type of topology we have
     if (this.primary && !this.primary.equals(server)) {
@@ -555,7 +555,7 @@ ReplSetState.prototype.update = function(server) {
     // Signal primary left
     self.emit('left', 'primary', this.primary);
     // Destroy the instance
-    self.primary.destroy();
+    self.primary.destroy({ force: true });
     // Set the new instance
     self.primary = server;
     // Set the set information
@@ -607,7 +607,7 @@ ReplSetState.prototype.update = function(server) {
 
     // Remove primary
     if (this.primary && this.primary.name.toLowerCase() === serverName) {
-      server.destroy();
+      server.destroy({ force: true });
       this.primary = null;
       self.emit('left', 'primary', server);
     }
@@ -659,7 +659,7 @@ ReplSetState.prototype.update = function(server) {
 
     // Remove primary
     if (this.primary && this.primary.name.toLowerCase() === serverName) {
-      server.destroy();
+      server.destroy({ force: true });
       this.primary = null;
       self.emit('left', 'primary', server);
     }
@@ -674,7 +674,7 @@ ReplSetState.prototype.update = function(server) {
   //
   if (this.set[serverName] && this.set[serverName].type === ServerType.RSPrimary) {
     self.emit('left', 'primary', this.primary);
-    this.primary.destroy();
+    this.primary.destroy({ force: true });
     this.primary = null;
     this.topologyType = TopologyType.ReplicaSetNoPrimary;
     return false;

package/lib/core/topologies/server.js

@@ -55,6 +55,10 @@ var serverAccounting = false;
 var servers = {};
 var BSON = retrieveBSON();
 
+function topologyId(server) {
+  return server.s.parent == null ? server.id : server.s.parent.id;
+}
+
 /**
  * Creates a new Server instance
  * @class
@@ -151,8 +155,6 @@ var Server = function(options) {
     // Monitoring timeout
     monitoringInterval:
       typeof options.monitoringInterval === 'number' ? options.monitoringInterval : 5000,
-    // Topology id
-    topologyId: -1,
     compression: { compressors: createCompressionInfo(options) },
     // Optional parent topology
     parent: options.parent
@@ -486,14 +488,11 @@ Server.prototype.connect = function(options) {
 
   // Emit toplogy opening event if not in topology
   if (!self.s.inTopology) {
-    this.emit('topologyOpening', { topologyId: self.id });
+    this.emit('topologyOpening', { topologyId: topologyId(self) });
   }
 
   // Emit opening server event
-  self.emit('serverOpening', {
-    topologyId: self.s.topologyId !== -1 ? self.s.topologyId : self.id,
-    address: self.name
-  });
+  self.emit('serverOpening', { topologyId: topologyId(self), address: self.name });
 
   self.s.pool.connect();
 };
@@ -843,6 +842,11 @@ Server.prototype.destroy = function(options, callback) {
     return;
   }
 
+  if (typeof options === 'function') {
+    callback = options;
+    options = {};
+  }
+
   options = options || {};
   var self = this;
 
@@ -878,14 +882,11 @@ Server.prototype.destroy = function(options, callback) {
 
   // Emit opening server event
   if (self.listeners('serverClosed').length > 0)
-    self.emit('serverClosed', {
-      topologyId: self.s.topologyId !== -1 ? self.s.topologyId : self.id,
-      address: self.name
-    });
+    self.emit('serverClosed', { topologyId: topologyId(self), address: self.name });
 
   // Emit toplogy opening event if not in topology
   if (self.listeners('topologyClosed').length > 0 && !self.s.inTopology) {
-    self.emit('topologyClosed', { topologyId: self.id });
+    self.emit('topologyClosed', { topologyId: topologyId(self) });
   }
 
   if (self.s.logger.isDebug()) {

package/lib/core/topologies/shared.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const os = require('os');
-const f = require('util').format;
 const ReadPreference = require('./read_preference');
 const Buffer = require('safe-buffer').Buffer;
 const TopologyType = require('../sdam/topology_description').TopologyType;
@@ -20,20 +19,19 @@ function emitSDAMEvent(self, event, description) {
 }
 
 // Get package.json variable
-var driverVersion = require('../../../package.json').version;
-var nodejsversion = f('Node.js %s, %s', process.version, os.endianness());
-var type = os.type();
-var name = process.platform;
-var architecture = process.arch;
-var release = os.release();
+const driverVersion = require('../../../package.json').version;
+const nodejsVersion = `'Node.js ${process.version}, ${os.endianness}`;
+const type = os.type();
+const name = process.platform;
+const architecture = process.arch;
+const release = os.release();
 
 function createClientInfo(options) {
-  // Build default client information
-  var clientInfo = options.clientInfo
+  const clientInfo = options.clientInfo
     ? clone(options.clientInfo)
     : {
         driver: {
-          name: 'nodejs-core',
+          name: 'nodejs',
           version: driverVersion
         },
         os: {
@@ -44,11 +42,8 @@ function createClientInfo(options) {
         }
       };
 
-  // Is platform specified
-  if (clientInfo.platform && clientInfo.platform.indexOf('mongodb-core') === -1) {
-    clientInfo.platform = f('%s, mongodb-core: %s', clientInfo.platform, driverVersion);
-  } else if (!clientInfo.platform) {
-    clientInfo.platform = nodejsversion;
+  if (options.useUnifiedTopology) {
+    clientInfo.platform = `${nodejsVersion} (${options.useUnifiedTopology ? 'unified' : 'legacy'})`;
   }
 
   // Do we have an application specific string
@@ -473,3 +468,4 @@ module.exports.Interval = Interval;
 module.exports.Timeout = Timeout;
 module.exports.isRetryableWritesSupported = isRetryableWritesSupported;
 module.exports.getMMAPError = getMMAPError;
+module.exports.topologyType = topologyType;

package/lib/core/uri_parser.js

@@ -534,6 +534,10 @@ function parseConnectionString(uri, options, callback) {
     if (parsedOptions.auth.username) auth.username = parsedOptions.auth.username;
     if (parsedOptions.auth.user) auth.username = parsedOptions.auth.user;
     if (parsedOptions.auth.password) auth.password = parsedOptions.auth.password;
+  } else {
+    if (parsedOptions.username) auth.username = parsedOptions.username;
+    if (parsedOptions.user) auth.username = parsedOptions.user;
+    if (parsedOptions.password) auth.password = parsedOptions.password;
   }
 
   if (cap[4].split('?')[0].indexOf('@') !== -1) {
@@ -551,8 +555,8 @@ function parseConnectionString(uri, options, callback) {
       return callback(new MongoParseError('Unescaped colon in authority section'));
     }
 
-    auth.username = qs.unescape(authParts[0]);
-    auth.password = authParts[1] ? qs.unescape(authParts[1]) : null;
+    if (!auth.username) auth.username = qs.unescape(authParts[0]);
+    if (!auth.password) auth.password = authParts[1] ? qs.unescape(authParts[1]) : null;
   }
 
   let hostParsingError = null;
@@ -617,6 +621,8 @@ function parseConnectionString(uri, options, callback) {
 
   if (result.auth && result.auth.db) {
     result.defaultDatabase = result.auth.db;
+  } else {
+    result.defaultDatabase = 'test';
   }
 
   try {

package/lib/core/utils.js

@@ -150,7 +150,12 @@ function eachAsync(arr, eachFn, callback) {
   }
 
   for (let idx = 0; idx < length; ++idx) {
-    eachFn(arr[idx], eachCallback);
+    try {
+      eachFn(arr[idx], eachCallback);
+    } catch (err) {
+      callback(err);
+      return;
+    }
   }
 }
 
@@ -158,6 +163,36 @@ function isUnifiedTopology(topology) {
   return topology.description != null;
 }
 
+function arrayStrictEqual(arr, arr2) {
+  if (!Array.isArray(arr) || !Array.isArray(arr2)) {
+    return false;
+  }
+
+  return arr.length === arr2.length && arr.every((elt, idx) => elt === arr2[idx]);
+}
+
+function tagsStrictEqual(tags, tags2) {
+  const tagsKeys = Object.keys(tags);
+  const tags2Keys = Object.keys(tags2);
+  return tagsKeys.length === tags2Keys.length && tagsKeys.every(key => tags2[key] === tags[key]);
+}
+
+function makeStateMachine(stateTable) {
+  return function stateTransition(target, newState) {
+    const legalStates = stateTable[target.s.state];
+    if (legalStates && legalStates.indexOf(newState) < 0) {
+      throw new TypeError(
+        `illegal state transition from [${
+          target.s.state
+        }] => [${newState}], allowed: [${legalStates}]`
+      );
+    }
+
+    target.emit('stateChanged', target.s.state, newState);
+    target.s.state = newState;
+  };
+}
+
 module.exports = {
   uuidV4,
   calculateDurationInMs,
@@ -168,5 +203,8 @@ module.exports = {
   maxWireVersion,
   isPromiseLike,
   eachAsync,
-  isUnifiedTopology
+  isUnifiedTopology,
+  arrayStrictEqual,
+  tagsStrictEqual,
+  makeStateMachine
 };

package/lib/cursor.js

@@ -543,7 +543,7 @@ class Cursor extends CoreCursor {
   /**
    * Set the batch size for the cursor.
    * @method
-   * @param {number} value The batchSize for the cursor.
+   * @param {number} value The number of documents to return per batch. See {@link https://docs.mongodb.com/manual/reference/command/find/|find command documentation}.
    * @throws {MongoError}
    * @return {Cursor}
    */

package/lib/db.js

@@ -302,7 +302,7 @@ Db.prototype.command = function(command, options, callback) {
  * @param {object} [options] Optional settings.
  * @param {(ReadPreference|string)} [options.readPreference] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
  * @param {object} [options.cursor] Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.
- * @param {number} [options.cursor.batchSize] The batchSize for the cursor
+ * @param {number} [options.cursor.batchSize=1000] The number of documents to return per batch. See {@link https://docs.mongodb.com/manual/reference/command/aggregate|aggregation documentation}.
  * @param {boolean} [options.explain=false] Explain returns the aggregation execution plan (requires mongodb 2.6 >).
  * @param {boolean} [options.allowDiskUse=false] allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).
  * @param {number} [options.maxTimeMS] maxTimeMS specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point.
@@ -563,7 +563,7 @@ Db.prototype.stats = function(options, callback) {
  * @param {object} [filter={}] Query to filter collections by
  * @param {object} [options] Optional settings.
  * @param {boolean} [options.nameOnly=false] Since 4.0: If true, will only return the collection name in the response, and will omit additional info
- * @param {number} [options.batchSize] The batchSize for the returned command cursor or if pre 2.8 the systems batch collection
+ * @param {number} [options.batchSize=1000] The batchSize for the returned command cursor or if pre 2.8 the systems batch collection
  * @param {(ReadPreference|string)} [options.readPreference] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @return {CommandCursor}
@@ -930,7 +930,7 @@ Db.prototype.unref = function() {
  * @param {string} [options.fullDocument='default'] Allowed values: ‘default’, ‘updateLookup’. When set to ‘updateLookup’, the change stream will include both a delta describing the changes to the document, as well as a copy of the entire document that was changed from some time after the change occurred.
  * @param {object} [options.resumeAfter] Specifies the logical starting point for the new change stream. This should be the _id field from a previously returned change stream document.
  * @param {number} [options.maxAwaitTimeMS] The maximum amount of time for the server to wait on new documents to satisfy a change stream query
- * @param {number} [options.batchSize] The number of documents to return per batch. See {@link https://docs.mongodb.com/manual/reference/command/aggregate|aggregation documentation}.
+ * @param {number} [options.batchSize=1000] The number of documents to return per batch. See {@link https://docs.mongodb.com/manual/reference/command/aggregate|aggregation documentation}.
  * @param {object} [options.collation] Specify collation settings for operation. See {@link https://docs.mongodb.com/manual/reference/command/aggregate|aggregation documentation}.
  * @param {ReadPreference} [options.readPreference] The read preference. Defaults to the read preference of the database. See {@link https://docs.mongodb.com/manual/reference/read-preference|read preference documentation}.
  * @param {Timestamp} [options.startAtOperationTime] receive change events that occur after the specified timestamp

package/lib/gridfs-stream/download.js

@@ -185,12 +185,19 @@ function doRead(_this) {
     }
     if (!doc) {
       _this.push(null);
-      return _this.s.cursor.close(function(error) {
-        if (error) {
-          return __handleError(_this, error);
-        }
-        _this.emit('close');
+
+      process.nextTick(() => {
+        _this.s.cursor.close(function(error) {
+          if (error) {
+            __handleError(_this, error);
+            return;
+          }
+
+          _this.emit('close');
+        });
       });
+
+      return;
     }
 
     var bytesRemaining = _this.s.file.length - _this.s.bytesRead;

package/lib/gridfs-stream/index.js

@@ -198,7 +198,7 @@ function _delete(_this, id, callback) {
  * @method
  * @param {Object} filter
  * @param {Object} [options] Optional settings for cursor
- * @param {number} [options.batchSize] Optional batch size for cursor
+ * @param {number} [options.batchSize=1000] The number of documents to return per batch. See {@link https://docs.mongodb.com/manual/reference/command/find|find command documentation}.
  * @param {number} [options.limit] Optional limit for cursor
  * @param {number} [options.maxTimeMS] Optional maxTimeMS for cursor
  * @param {boolean} [options.noCursorTimeout] Optionally set cursor's `noCursorTimeout` flag