mongodb 3.6.1 → 3.6.5

package/lib/operations/common_functions.js

@@ -11,6 +11,7 @@ const MongoError = require('../core').MongoError;
 const ReadPreference = require('../core').ReadPreference;
 const toError = require('../utils').toError;
 const CursorState = require('../core/cursor').CursorState;
+const maxWireVersion = require('../core/utils').maxWireVersion;
 
 /**
  * Build the count command.
@@ -57,14 +58,6 @@ function buildCountCommand(collectionOrCursor, query, options) {
   return cmd;
 }
 
-function deleteCallback(err, r, callback) {
-  if (callback == null) return;
-  if (err && callback) return callback(err);
-  if (r == null) return callback(null, { result: { ok: 1 } });
-  r.deletedCount = r.result.n;
-  if (callback) callback(null, r);
-}
-
 /**
  * Find and update a document.
  *
@@ -308,6 +301,12 @@ function removeDocuments(coll, selector, options, callback) {
     return callback(err, null);
   }
 
+  if (options.explain !== undefined && maxWireVersion(coll.s.topology) < 3) {
+    return callback
+      ? callback(new MongoError(`server does not support explain on remove`))
+      : undefined;
+  }
+
   // Execute the remove
   coll.s.topology.remove(coll.s.namespace, [op], finalOptions, (err, result) => {
     if (callback == null) return;
@@ -369,6 +368,12 @@ function updateDocuments(coll, selector, document, options, callback) {
     return callback(err, null);
   }
 
+  if (options.explain !== undefined && maxWireVersion(coll.s.topology) < 3) {
+    return callback
+      ? callback(new MongoError(`server does not support explain on update`))
+      : undefined;
+  }
+
   // Update options
   coll.s.topology.update(coll.s.namespace, [op], finalOptions, (err, result) => {
     if (callback == null) return;
@@ -382,31 +387,13 @@ function updateDocuments(coll, selector, document, options, callback) {
   });
 }
 
-function updateCallback(err, r, callback) {
-  if (callback == null) return;
-  if (err) return callback(err);
-  if (r == null) return callback(null, { result: { ok: 1 } });
-  r.modifiedCount = r.result.nModified != null ? r.result.nModified : r.result.n;
-  r.upsertedId =
-    Array.isArray(r.result.upserted) && r.result.upserted.length > 0
-      ? r.result.upserted[0] // FIXME(major): should be `r.result.upserted[0]._id`
-      : null;
-  r.upsertedCount =
-    Array.isArray(r.result.upserted) && r.result.upserted.length ? r.result.upserted.length : 0;
-  r.matchedCount =
-    Array.isArray(r.result.upserted) && r.result.upserted.length > 0 ? 0 : r.result.n;
-  callback(null, r);
-}
-
 module.exports = {
   buildCountCommand,
-  deleteCallback,
   findAndModify,
   indexInformation,
   nextObject,
   prepareDocs,
   insertDocuments,
   removeDocuments,
-  updateDocuments,
-  updateCallback
+  updateDocuments
 };

package/lib/operations/connect.js

@@ -13,7 +13,9 @@ const ReplSet = require('../topologies/replset');
 const Server = require('../topologies/server');
 const ServerSessionPool = require('../core').Sessions.ServerSessionPool;
 const emitDeprecationWarning = require('../utils').emitDeprecationWarning;
+const emitWarningOnce = require('../utils').emitWarningOnce;
 const fs = require('fs');
+const WriteConcern = require('../write_concern');
 const BSON = require('../core/connection/utils').retrieveBSON();
 const CMAP_EVENT_NAMES = require('../cmap/events').CMAP_EVENT_NAMES;
 
@@ -105,6 +107,7 @@ const validOptionNames = [
   'w',
   'wtimeout',
   'j',
+  'writeConcern',
   'forceServerObjectId',
   'serializeFunctions',
   'ignoreUndefined',
@@ -180,12 +183,12 @@ function validOptions(options) {
       if (options.validateOptions) {
         return new MongoError(`option ${name} is not supported`);
       } else {
-        console.warn(`the options [${name}] is not supported`);
+        emitWarningOnce(`the options [${name}] is not supported`);
       }
     }
 
     if (legacyOptionNames.indexOf(name) !== -1) {
-      console.warn(
+      emitWarningOnce(
         `the server/replset/mongos/db options are deprecated, ` +
           `all their options are supported at the top level of the options object [${validOptionNames}]`
       );
@@ -255,9 +258,6 @@ function resolveTLSOptions(options) {
   });
 }
 
-const emitDeprecationForNonUnifiedTopology = deprecate(() => {},
-'current Server Discovery and Monitoring engine is deprecated, and will be removed in a future version. ' + 'To use the new Server Discover and Monitoring engine, pass option { useUnifiedTopology: true } to the MongoClient constructor.');
-
 function connect(mongoClient, url, options, callback) {
   options = Object.assign({}, options);
 
@@ -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;
@@ -300,18 +300,16 @@ function connect(mongoClient, url, options, callback) {
       delete _finalOptions.db_options.auth;
     }
 
-    // `journal` should be translated to `j` for the driver
-    if (_finalOptions.journal != null) {
-      _finalOptions.j = _finalOptions.journal;
-      _finalOptions.journal = undefined;
-    }
-
     // resolve tls options if needed
     resolveTLSOptions(_finalOptions);
 
     // Store the merged options object
     mongoClient.s.options = _finalOptions;
 
+    // Apply read and write concern from parsed url
+    mongoClient.s.readPreference = ReadPreference.fromOptions(_finalOptions);
+    mongoClient.s.writeConcern = WriteConcern.fromOptions(_finalOptions);
+
     // Failure modes
     if (object.servers.length === 0) {
       return callback(new Error('connection string must contain at least one seed host'));
@@ -335,7 +333,9 @@ function connect(mongoClient, url, options, callback) {
       return createTopology(mongoClient, 'unified', _finalOptions, connectCallback);
     }
 
-    emitDeprecationForNonUnifiedTopology();
+    emitWarningOnce(
+      'Current Server Discovery and Monitoring engine is deprecated, and will be removed in a future version. To use the new Server Discover and Monitoring engine, pass option { useUnifiedTopology: true } to the MongoClient constructor.'
+    );
 
     // Do we have a replicaset then skip discovery and go straight to connectivity
     if (_finalOptions.replicaSet || _finalOptions.rs_name) {
@@ -616,9 +616,12 @@ function createUnifiedOptions(finalOptions, options) {
     'mongos_options'
   ];
   const noMerge = ['readconcern', 'compression', 'autoencryption'];
+  const skip = ['w', 'wtimeout', 'j', 'journal', 'fsync', 'writeConcern'];
 
   for (const name in options) {
-    if (noMerge.indexOf(name.toLowerCase()) !== -1) {
+    if (skip.indexOf(name.toLowerCase()) !== -1) {
+      continue;
+    } else if (noMerge.indexOf(name.toLowerCase()) !== -1) {
       finalOptions[name] = options[name];
     } else if (childOptions.indexOf(name.toLowerCase()) !== -1) {
       finalOptions = mergeOptions(finalOptions, options[name], false);
@@ -636,6 +639,14 @@ function createUnifiedOptions(finalOptions, options) {
     }
   }
 
+  // Handle write concern keys separately, since `options` may have the keys at the top level or
+  // under `options.writeConcern`. The final merged keys will be under `finalOptions.writeConcern`.
+  // This way, `fromOptions` will warn once if `options` is using deprecated write concern options
+  const optionsWriteConcern = WriteConcern.fromOptions(options);
+  if (optionsWriteConcern) {
+    finalOptions.writeConcern = Object.assign({}, finalOptions.writeConcern, optionsWriteConcern);
+  }
+
   return finalOptions;
 }
 
@@ -760,12 +771,24 @@ function transformUrlOptions(_object) {
 
   if (object.wTimeoutMS) {
     object.wtimeout = object.wTimeoutMS;
+    object.wTimeoutMS = undefined;
   }
 
   if (_object.srvHost) {
     object.srvHost = _object.srvHost;
   }
 
+  // Any write concern options from the URL will be top-level, so we manually
+  // move them options under `object.writeConcern` to avoid warnings later
+  const wcKeys = ['w', 'wtimeout', 'j', 'journal', 'fsync'];
+  for (const key of wcKeys) {
+    if (object[key] !== undefined) {
+      if (object.writeConcern === undefined) object.writeConcern = {};
+      object.writeConcern[key] = object[key];
+      object[key] = undefined;
+    }
+  }
+
   return object;
 }
 
@@ -788,7 +811,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) {

package/lib/operations/delete_many.js

@@ -1,8 +1,9 @@
 'use strict';
 
 const OperationBase = require('./operation').OperationBase;
-const deleteCallback = require('./common_functions').deleteCallback;
 const removeDocuments = require('./common_functions').removeDocuments;
+const Aspect = require('./operation').Aspect;
+const defineAspects = require('./operation').defineAspects;
 
 class DeleteManyOperation extends OperationBase {
   constructor(collection, filter, options) {
@@ -18,8 +19,20 @@ class DeleteManyOperation extends OperationBase {
     const options = this.options;
 
     options.single = false;
-    removeDocuments(coll, filter, options, (err, r) => deleteCallback(err, r, callback));
+    removeDocuments(coll, filter, options, (err, r) => {
+      if (callback == null) return;
+      if (err && callback) return callback(err);
+      if (r == null) return callback(null, { result: { ok: 1 } });
+
+      // If an explain operation was executed, don't process the server results
+      if (this.explain) return callback(undefined, r.result);
+
+      r.deletedCount = r.result.n;
+      callback(null, r);
+    });
   }
 }
 
+defineAspects(DeleteManyOperation, [Aspect.EXPLAINABLE]);
+
 module.exports = DeleteManyOperation;

package/lib/operations/delete_one.js

@@ -1,8 +1,9 @@
 'use strict';
 
 const OperationBase = require('./operation').OperationBase;
-const deleteCallback = require('./common_functions').deleteCallback;
 const removeDocuments = require('./common_functions').removeDocuments;
+const Aspect = require('./operation').Aspect;
+const defineAspects = require('./operation').defineAspects;
 
 class DeleteOneOperation extends OperationBase {
   constructor(collection, filter, options) {
@@ -18,8 +19,20 @@ class DeleteOneOperation extends OperationBase {
     const options = this.options;
 
     options.single = true;
-    removeDocuments(coll, filter, options, (err, r) => deleteCallback(err, r, callback));
+    removeDocuments(coll, filter, options, (err, r) => {
+      if (callback == null) return;
+      if (err && callback) return callback(err);
+      if (r == null) return callback(null, { result: { ok: 1 } });
+
+      // If an explain operation was executed, don't process the server results
+      if (this.explain) return callback(undefined, r.result);
+
+      r.deletedCount = r.result.n;
+      callback(null, r);
+    });
   }
 }
 
+defineAspects(DeleteOneOperation, [Aspect.EXPLAINABLE]);
+
 module.exports = DeleteOneOperation;

package/lib/operations/distinct.js

@@ -5,6 +5,8 @@ const defineAspects = require('./operation').defineAspects;
 const CommandOperationV2 = require('./command_v2');
 const decorateWithCollation = require('../utils').decorateWithCollation;
 const decorateWithReadConcern = require('../utils').decorateWithReadConcern;
+const maxWireVersion = require('../core/utils').maxWireVersion;
+const MongoError = require('../error').MongoError;
 
 /**
  * Return a list of distinct values for the given key across a collection.
@@ -65,13 +67,18 @@ class DistinctOperation extends CommandOperationV2 {
       return callback(err, null);
     }
 
+    if (this.explain && maxWireVersion(server) < 4) {
+      callback(new MongoError(`server does not support explain on distinct`));
+      return;
+    }
+
     super.executeCommand(server, cmd, (err, result) => {
       if (err) {
         callback(err);
         return;
       }
 
-      callback(null, this.options.full ? result : result.values);
+      callback(null, this.options.full || this.explain ? result : result.values);
     });
   }
 }
@@ -79,7 +86,8 @@ class DistinctOperation extends CommandOperationV2 {
 defineAspects(DistinctOperation, [
   Aspect.READ_OPERATION,
   Aspect.RETRYABLE,
-  Aspect.EXECUTE_WITH_SELECTION
+  Aspect.EXECUTE_WITH_SELECTION,
+  Aspect.EXPLAINABLE
 ]);
 
 module.exports = DistinctOperation;

package/lib/operations/execute_operation.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const maybePromise = require('../utils').maybePromise;
 const MongoError = require('../core/error').MongoError;
 const Aspect = require('./operation').Aspect;
 const OperationBase = require('./operation').OperationBase;
@@ -21,7 +22,7 @@ const isUnifiedTopology = require('../core/utils').isUnifiedTopology;
  * @param {Operation} operation The operation to execute
  * @param {function} callback The command result callback
  */
-function executeOperation(topology, operation, callback) {
+function executeOperation(topology, operation, cb) {
   if (topology == null) {
     throw new TypeError('This method requires a valid topology instance');
   }
@@ -30,64 +31,57 @@ function executeOperation(topology, operation, callback) {
     throw new TypeError('This method requires a valid operation instance');
   }
 
-  if (isUnifiedTopology(topology) && topology.shouldCheckForSessionSupport()) {
-    return selectServerForSessionSupport(topology, operation, callback);
-  }
-
-  const Promise = topology.s.promiseLibrary;
-
-  // The driver sessions spec mandates that we implicitly create sessions for operations
-  // that are not explicitly provided with a session.
-  let session, owner;
-  if (topology.hasSessionSupport()) {
-    if (operation.session == null) {
-      owner = Symbol();
-      session = topology.startSession({ owner });
-      operation.session = session;
-    } else if (operation.session.hasEnded) {
-      throw new MongoError('Use of expired sessions is not permitted');
+  return maybePromise(topology, cb, callback => {
+    if (isUnifiedTopology(topology) && topology.shouldCheckForSessionSupport()) {
+      // Recursive call to executeOperation after a server selection
+      return selectServerForSessionSupport(topology, operation, callback);
     }
-  }
-
-  let result;
-  if (typeof callback !== 'function') {
-    result = new Promise((resolve, reject) => {
-      callback = (err, res) => {
-        if (err) return reject(err);
-        resolve(res);
-      };
-    });
-  }
 
-  function executeCallback(err, result) {
-    if (session && session.owner === owner) {
-      session.endSession();
-      if (operation.session === session) {
-        operation.clearSession();
+    // The driver sessions spec mandates that we implicitly create sessions for operations
+    // that are not explicitly provided with a session.
+    let session, owner;
+    if (topology.hasSessionSupport()) {
+      if (operation.session == null) {
+        owner = Symbol();
+        session = topology.startSession({ owner });
+        operation.session = session;
+      } else if (operation.session.hasEnded) {
+        return callback(new MongoError('Use of expired sessions is not permitted'));
       }
+    } else if (operation.session) {
+      // If the user passed an explicit session and we are still, after server selection,
+      // trying to run against a topology that doesn't support sessions we error out.
+      return callback(new MongoError('Current topology does not support sessions'));
     }
 
-    callback(err, result);
-  }
-
-  try {
-    if (operation.hasAspect(Aspect.EXECUTE_WITH_SELECTION)) {
-      executeWithServerSelection(topology, operation, executeCallback);
-    } else {
-      operation.execute(executeCallback);
-    }
-  } catch (e) {
-    if (session && session.owner === owner) {
-      session.endSession();
-      if (operation.session === session) {
-        operation.clearSession();
+    function executeCallback(err, result) {
+      if (session && session.owner === owner) {
+        session.endSession();
+        if (operation.session === session) {
+          operation.clearSession();
+        }
       }
+
+      callback(err, result);
     }
 
-    throw e;
-  }
+    try {
+      if (operation.hasAspect(Aspect.EXECUTE_WITH_SELECTION)) {
+        executeWithServerSelection(topology, operation, executeCallback);
+      } else {
+        operation.execute(executeCallback);
+      }
+    } catch (error) {
+      if (session && session.owner === owner) {
+        session.endSession();
+        if (operation.session === session) {
+          operation.clearSession();
+        }
+      }
 
-  return result;
+      callback(error);
+    }
+  });
 }
 
 function supportsRetryableReads(server) {
@@ -139,7 +133,6 @@ function executeWithServerSelection(topology, operation, callback) {
       callback(err, null);
       return;
     }
-
     const shouldRetryReads =
       topology.s.options.retryReads !== false &&
       operation.session &&
@@ -156,31 +149,16 @@ function executeWithServerSelection(topology, operation, callback) {
   });
 }
 
-// TODO: This is only supported for unified topology, it should go away once
-//       we remove support for legacy topology types.
+// The Unified Topology runs serverSelection before executing every operation
+// Session support is determined by the result of a monitoring check triggered by this selection
 function selectServerForSessionSupport(topology, operation, callback) {
-  const Promise = topology.s.promiseLibrary;
-
-  let result;
-  if (typeof callback !== 'function') {
-    result = new Promise((resolve, reject) => {
-      callback = (err, result) => {
-        if (err) return reject(err);
-        resolve(result);
-      };
-    });
-  }
-
   topology.selectServer(ReadPreference.primaryPreferred, err => {
     if (err) {
-      callback(err);
-      return;
+      return callback(err);
     }
 
     executeOperation(topology, operation, callback);
   });
-
-  return result;
 }
 
 module.exports = executeOperation;

package/lib/operations/find.js

@@ -25,6 +25,11 @@ class FindOperation extends OperationBase {
       return;
     }
 
+    if (this.explain) {
+      // We need to manually ensure explain is in the options.
+      this.options.explain = this.explain.verbosity;
+    }
+
     // TOOD: use `MongoDBNamespace` through and through
     const cursorState = this.cursorState || {};
     server.query(this.ns.toString(), this.cmd, cursorState, this.options, callback);
@@ -34,7 +39,8 @@ class FindOperation extends OperationBase {
 defineAspects(FindOperation, [
   Aspect.READ_OPERATION,
   Aspect.RETRYABLE,
-  Aspect.EXECUTE_WITH_SELECTION
+  Aspect.EXECUTE_WITH_SELECTION,
+  Aspect.EXPLAINABLE
 ]);
 
 module.exports = FindOperation;

package/lib/operations/find_and_modify.js

@@ -10,6 +10,9 @@ const handleCallback = require('../utils').handleCallback;
 const ReadPreference = require('../core').ReadPreference;
 const maxWireVersion = require('../core/utils').maxWireVersion;
 const MongoError = require('../error').MongoError;
+const Aspect = require('./operation').Aspect;
+const defineAspects = require('./operation').defineAspects;
+const decorateWithExplain = require('../utils').decorateWithExplain;
 
 class FindAndModifyOperation extends OperationBase {
   constructor(collection, query, sort, doc, options) {
@@ -29,7 +32,7 @@ class FindAndModifyOperation extends OperationBase {
     let options = this.options;
 
     // Create findAndModify command object
-    const queryObject = {
+    let queryObject = {
       findAndModify: coll.collectionName,
       query: query
     };
@@ -103,6 +106,14 @@ class FindAndModifyOperation extends OperationBase {
       queryObject.hint = options.hint;
     }
 
+    if (this.explain) {
+      if (maxWireVersion(coll.s.topology) < 4) {
+        callback(new MongoError(`server does not support explain on findAndModify`));
+        return;
+      }
+      queryObject = decorateWithExplain(queryObject, this.explain);
+    }
+
     // Execute the command
     executeCommand(coll.s.db, queryObject, options, (err, result) => {
       if (err) return handleCallback(callback, err, null);
@@ -112,4 +123,6 @@ class FindAndModifyOperation extends OperationBase {
   }
 }
 
+defineAspects(FindAndModifyOperation, [Aspect.EXPLAINABLE]);
+
 module.exports = FindAndModifyOperation;

package/lib/operations/find_one.js

@@ -3,6 +3,8 @@
 const handleCallback = require('../utils').handleCallback;
 const OperationBase = require('./operation').OperationBase;
 const toError = require('../utils').toError;
+const Aspect = require('./operation').Aspect;
+const defineAspects = require('./operation').defineAspects;
 
 class FindOneOperation extends OperationBase {
   constructor(collection, query, options) {
@@ -34,4 +36,6 @@ class FindOneOperation extends OperationBase {
   }
 }
 
+defineAspects(FindOneOperation, [Aspect.EXPLAINABLE]);
+
 module.exports = FindOneOperation;

package/lib/operations/map_reduce.js

@@ -11,8 +11,14 @@ const loadDb = require('../dynamic_loaders').loadDb;
 const OperationBase = require('./operation').OperationBase;
 const ReadPreference = require('../core').ReadPreference;
 const toError = require('../utils').toError;
+const Aspect = require('./operation').Aspect;
+const defineAspects = require('./operation').defineAspects;
+const decorateWithExplain = require('../utils').decorateWithExplain;
+const maxWireVersion = require('../core/utils').maxWireVersion;
+const MongoError = require('../error').MongoError;
 
 const exclusionList = [
+  'explain',
   'readPreference',
   'session',
   'bypassDocumentValidation',
@@ -59,7 +65,7 @@ class MapReduceOperation extends OperationBase {
     const reduce = this.reduce;
     let options = this.options;
 
-    const mapCommandHash = {
+    let mapCommandHash = {
       mapReduce: coll.collectionName,
       map: map,
       reduce: reduce
@@ -110,6 +116,14 @@ class MapReduceOperation extends OperationBase {
       return callback(err, null);
     }
 
+    if (this.explain) {
+      if (maxWireVersion(coll.s.topology) < 9) {
+        callback(new MongoError(`server does not support explain on mapReduce`));
+        return;
+      }
+      mapCommandHash = decorateWithExplain(mapCommandHash, this.explain);
+    }
+
     // Execute command
     executeCommand(coll.s.db, mapCommandHash, options, (err, result) => {
       if (err) return handleCallback(callback, err);
@@ -118,6 +132,9 @@ class MapReduceOperation extends OperationBase {
         return handleCallback(callback, toError(result));
       }
 
+      // If an explain operation was executed, don't process the server results
+      if (this.explain) return callback(undefined, result);
+
       // Create statistics value
       const stats = {};
       if (result.timeMillis) stats['processtime'] = result.timeMillis;
@@ -187,4 +204,6 @@ function processScope(scope) {
   return new_scope;
 }
 
+defineAspects(MapReduceOperation, [Aspect.EXPLAINABLE]);
+
 module.exports = MapReduceOperation;

package/lib/operations/operation.js

@@ -1,11 +1,15 @@
 'use strict';
 
+const Explain = require('../explain').Explain;
+const MongoError = require('../core/error').MongoError;
+
 const Aspect = {
   READ_OPERATION: Symbol('READ_OPERATION'),
   WRITE_OPERATION: Symbol('WRITE_OPERATION'),
   RETRYABLE: Symbol('RETRYABLE'),
   EXECUTE_WITH_SELECTION: Symbol('EXECUTE_WITH_SELECTION'),
-  NO_INHERIT_OPTIONS: Symbol('NO_INHERIT_OPTIONS')
+  NO_INHERIT_OPTIONS: Symbol('NO_INHERIT_OPTIONS'),
+  EXPLAINABLE: Symbol('EXPLAINABLE')
 };
 
 /**
@@ -17,6 +21,12 @@ const Aspect = {
 class OperationBase {
   constructor(options) {
     this.options = Object.assign({}, options);
+
+    if (this.hasAspect(Aspect.EXPLAINABLE)) {
+      this.explain = Explain.fromOptions(options);
+    } else if (this.options.explain !== undefined) {
+      throw new MongoError(`explain is not supported on this command`);
+    }
   }
 
   hasAspect(aspect) {