mongodb 3.6.4 → 3.6.8

package/lib/collection.js

@@ -2,6 +2,7 @@
 
 const deprecate = require('util').deprecate;
 const deprecateOptions = require('./utils').deprecateOptions;
+const emitWarningOnce = require('./utils').emitWarningOnce;
 const checkCollectionName = require('./utils').checkCollectionName;
 const ObjectID = require('./core').BSON.ObjectID;
 const MongoError = require('./core').MongoError;
@@ -323,7 +324,7 @@ Collection.prototype.find = deprecateOptions(
   function(query, options, callback) {
     if (typeof callback === 'object') {
       // TODO(MAJOR): throw in the future
-      console.warn('Third parameter to `find()` must be a callback or undefined');
+      emitWarningOnce('Third parameter to `find()` must be a callback or undefined');
     }
 
     let selector = query;
@@ -1092,7 +1093,7 @@ Collection.prototype.findOne = deprecateOptions(
   function(query, options, callback) {
     if (typeof callback === 'object') {
       // TODO(MAJOR): throw in the future
-      console.warn('Third parameter to `findOne()` must be a callback or undefined');
+      emitWarningOnce('Third parameter to `findOne()` must be a callback or undefined');
     }
 
     if (typeof query === 'function') (callback = query), (query = {}), (options = {});
@@ -1654,7 +1655,7 @@ Collection.prototype.stats = function(options, callback) {
 
 /**
  * @typedef {Object} Collection~findAndModifyWriteOpResult
- * @property {object} value Document returned from the `findAndModify` command. If no documents were found, `value` will be `null` by default (`returnOriginal: true`), even if a document was upserted; if `returnOriginal` was false, the upserted document will be returned in that case.
+ * @property {object} value Document returned from the `findAndModify` command. If no documents were found, `value` will be `null` by default even if a document was upserted unless `returnDocument` is specified as `'after'`, in which case the upserted document will be returned.
  * @property {object} lastErrorObject The raw lastErrorObject returned from the command. See {@link https://docs.mongodb.com/manual/reference/command/findAndModify/index.html#lasterrorobject|findAndModify command documentation}.
  * @property {Number} ok Is 1 if the command executed correctly.
  */
@@ -1715,7 +1716,8 @@ Collection.prototype.findOneAndDelete = function(filter, options, callback) {
  * @param {object} [options.projection] Limits the fields to return for all matching documents.
  * @param {object} [options.sort] Determines which document the operation modifies if the query selects multiple documents.
  * @param {boolean} [options.upsert=false] Upsert the document if it does not exist.
- * @param {boolean} [options.returnOriginal=true] When false, returns the updated document rather than the original. The default is true.
+ * @param {'before'|'after'} [options.returnDocument='before'] When set to `'after'`, returns the updated document rather than the original. The default is `'before'`.
+ * @param {boolean} [options.returnOriginal=true] **Deprecated** Use `options.returnDocument` instead.
  * @param {boolean} [options.checkKeys=false] If true, will throw if bson documents start with `$` or include a `.` in any key value
  * @param {boolean} [options.serializeFunctions=false] Serialize functions on any object.
  * @param {boolean} [options.ignoreUndefined=false] Specify if the BSON serializer should ignore undefined fields.
@@ -1724,22 +1726,29 @@ Collection.prototype.findOneAndDelete = function(filter, options, callback) {
  * @param {Collection~findAndModifyCallback} [callback] The collection result callback
  * @return {Promise<Collection~findAndModifyWriteOpResultObject>} returns Promise if no callback passed
  */
-Collection.prototype.findOneAndReplace = function(filter, replacement, options, callback) {
-  if (typeof options === 'function') (callback = options), (options = {});
-  options = options || {};
+Collection.prototype.findOneAndReplace = deprecateOptions(
+  {
+    name: 'collection.findOneAndReplace',
+    deprecatedOptions: ['returnOriginal'],
+    optionsIndex: 2
+  },
+  function(filter, replacement, options, callback) {
+    if (typeof options === 'function') (callback = options), (options = {});
+    options = options || {};
 
-  // Add ignoreUndefined
-  if (this.s.options.ignoreUndefined) {
-    options = Object.assign({}, options);
-    options.ignoreUndefined = this.s.options.ignoreUndefined;
-  }
+    // Add ignoreUndefined
+    if (this.s.options.ignoreUndefined) {
+      options = Object.assign({}, options);
+      options.ignoreUndefined = this.s.options.ignoreUndefined;
+    }
 
-  return executeOperation(
-    this.s.topology,
-    new FindOneAndReplaceOperation(this, filter, replacement, options),
-    callback
-  );
-};
+    return executeOperation(
+      this.s.topology,
+      new FindOneAndReplaceOperation(this, filter, replacement, options),
+      callback
+    );
+  }
+);
 
 /**
  * Find a document and update it in one atomic operation. Requires a write lock for the duration of the operation.
@@ -1756,7 +1765,8 @@ Collection.prototype.findOneAndReplace = function(filter, replacement, options,
  * @param {object} [options.projection] Limits the fields to return for all matching documents.
  * @param {object} [options.sort] Determines which document the operation modifies if the query selects multiple documents.
  * @param {boolean} [options.upsert=false] Upsert the document if it does not exist.
- * @param {boolean} [options.returnOriginal=true] When false, returns the updated document rather than the original. The default is true.
+ * @param {'before'|'after'} [options.returnDocument='before'] When set to `'after'`, returns the updated document rather than the original. The default is `'before'`.
+ * @param {boolean} [options.returnOriginal=true] **Deprecated** Use `options.returnDocument` instead.
  * @param {boolean} [options.checkKeys=false] If true, will throw if bson documents start with `$` or include a `.` in any key value
  * @param {boolean} [options.serializeFunctions=false] Serialize functions on any object.
  * @param {boolean} [options.ignoreUndefined=false] Specify if the BSON serializer should ignore undefined fields.
@@ -1765,22 +1775,29 @@ Collection.prototype.findOneAndReplace = function(filter, replacement, options,
  * @param {Collection~findAndModifyCallback} [callback] The collection result callback
  * @return {Promise<Collection~findAndModifyWriteOpResultObject>} returns Promise if no callback passed
  */
-Collection.prototype.findOneAndUpdate = function(filter, update, options, callback) {
-  if (typeof options === 'function') (callback = options), (options = {});
-  options = options || {};
+Collection.prototype.findOneAndUpdate = deprecateOptions(
+  {
+    name: 'collection.findOneAndUpdate',
+    deprecatedOptions: ['returnOriginal'],
+    optionsIndex: 2
+  },
+  function(filter, update, options, callback) {
+    if (typeof options === 'function') (callback = options), (options = {});
+    options = options || {};
 
-  // Add ignoreUndefined
-  if (this.s.options.ignoreUndefined) {
-    options = Object.assign({}, options);
-    options.ignoreUndefined = this.s.options.ignoreUndefined;
-  }
+    // Add ignoreUndefined
+    if (this.s.options.ignoreUndefined) {
+      options = Object.assign({}, options);
+      options.ignoreUndefined = this.s.options.ignoreUndefined;
+    }
 
-  return executeOperation(
-    this.s.topology,
-    new FindOneAndUpdateOperation(this, filter, update, options),
-    callback
-  );
-};
+    return executeOperation(
+      this.s.topology,
+      new FindOneAndUpdateOperation(this, filter, update, options),
+      callback
+    );
+  }
+);
 
 /**
  * Find and update a document.
@@ -2198,7 +2215,6 @@ Collection.prototype.initializeUnorderedBulkOp = function(options) {
  * @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @param {boolean} [options.ignoreUndefined=false] Specify if the BSON serializer should ignore undefined fields.
- * @param {OrderedBulkOperation} callback The command result callback
  * @return {null}
  */
 Collection.prototype.initializeOrderedBulkOp = function(options) {

package/lib/core/auth/mongo_credentials.js

@@ -49,16 +49,16 @@ class MongoCredentials {
     this.mechanism = options.mechanism || 'default';
     this.mechanismProperties = options.mechanismProperties || {};
 
-    if (this.mechanism.match(/MONGODB-AWS/i)) {
-      if (this.username == null && process.env.AWS_ACCESS_KEY_ID) {
+    if (/MONGODB-AWS/i.test(this.mechanism)) {
+      if (!this.username && process.env.AWS_ACCESS_KEY_ID) {
         this.username = process.env.AWS_ACCESS_KEY_ID;
       }
 
-      if (this.password == null && process.env.AWS_SECRET_ACCESS_KEY) {
+      if (!this.password && process.env.AWS_SECRET_ACCESS_KEY) {
         this.password = process.env.AWS_SECRET_ACCESS_KEY;
       }
 
-      if (this.mechanismProperties.AWS_SESSION_TOKEN == null && process.env.AWS_SESSION_TOKEN) {
+      if (!this.mechanismProperties.AWS_SESSION_TOKEN && process.env.AWS_SESSION_TOKEN) {
         this.mechanismProperties.AWS_SESSION_TOKEN = process.env.AWS_SESSION_TOKEN;
       }
     }
@@ -90,7 +90,7 @@ class MongoCredentials {
    */
   resolveAuthMechanism(ismaster) {
     // If the mechanism is not "default", then it does not need to be resolved
-    if (this.mechanism.match(/DEFAULT/i)) {
+    if (/DEFAULT/i.test(this.mechanism)) {
       return new MongoCredentials({
         username: this.username,
         password: this.password,

package/lib/core/auth/scram.js

@@ -4,6 +4,7 @@ const Buffer = require('safe-buffer').Buffer;
 const retrieveBSON = require('../connection/utils').retrieveBSON;
 const MongoError = require('../error').MongoError;
 const AuthProvider = require('./auth_provider').AuthProvider;
+const emitWarningOnce = require('../../utils').emitWarning;
 
 const BSON = retrieveBSON();
 const Binary = BSON.Binary;
@@ -24,7 +25,7 @@ class ScramSHA extends AuthProvider {
   prepare(handshakeDoc, authContext, callback) {
     const cryptoMethod = this.cryptoMethod;
     if (cryptoMethod === 'sha256' && saslprep == null) {
-      console.warn('Warning: no saslprep library specified. Passwords will not be sanitized');
+      emitWarningOnce('Warning: no saslprep library specified. Passwords will not be sanitized');
     }
 
     crypto.randomBytes(24, (err, nonce) => {

package/lib/core/connection/connect.js

@@ -243,7 +243,7 @@ function parseSslOptions(family, options) {
   }
 
   // Set default sni servername to be the same as host
-  if (result.servername == null) {
+  if (result.servername == null && !net.isIP(result.host)) {
     result.servername = result.host;
   }
 

package/lib/core/connection/logger.js

@@ -37,6 +37,7 @@ var Logger = function(className, options) {
   if (options.logger) {
     currentLogger = options.logger;
   } else if (currentLogger == null) {
+    // eslint-disable-next-line no-console
     currentLogger = console.log;
   }
 

package/lib/core/connection/msg.js

@@ -31,6 +31,7 @@ const Buffer = require('safe-buffer').Buffer;
 const opcodes = require('../wireprotocol/shared').opcodes;
 const databaseNamespace = require('../wireprotocol/shared').databaseNamespace;
 const ReadPreference = require('../topologies/read_preference');
+const MongoError = require('../../core/error').MongoError;
 
 // Incrementing request id
 let _requestId = 0;
@@ -196,7 +197,8 @@ class BinMsg {
     while (this.index < this.data.length) {
       const payloadType = this.data.readUInt8(this.index++);
       if (payloadType === 1) {
-        console.error('TYPE 1');
+        // It was decided that no driver makes use of payload type 1
+        throw new MongoError('OP_MSG Payload Type 1 detected unsupported protocol');
       } else if (payloadType === 0) {
         const bsonSize = this.data.readUInt32LE(this.index);
         const bin = this.data.slice(this.index, this.index + bsonSize);

package/lib/core/connection/utils.js

@@ -1,9 +1,9 @@
 'use strict';
 
-const require_optional = require('require_optional');
+const require_optional = require('optional-require')(require);
 
 function debugOptions(debugFields, options) {
-  var finaloptions = {};
+  const finaloptions = {};
   debugFields.forEach(function(n) {
     finaloptions[n] = options[n];
   });
@@ -12,16 +12,14 @@ function debugOptions(debugFields, options) {
 }
 
 function retrieveBSON() {
-  var BSON = require('bson');
+  const BSON = require('bson');
   BSON.native = false;
 
-  try {
-    var optionalBSON = require_optional('bson-ext');
-    if (optionalBSON) {
-      optionalBSON.native = true;
-      return optionalBSON;
-    }
-  } catch (err) {} // eslint-disable-line
+  const optionalBSON = require_optional('bson-ext');
+  if (optionalBSON) {
+    optionalBSON.native = true;
+    return optionalBSON;
+  }
 
   return BSON;
 }
@@ -35,10 +33,7 @@ function noSnappyWarning() {
 
 // Facilitate loading Snappy optionally
 function retrieveSnappy() {
-  var snappy = null;
-  try {
-    snappy = require_optional('snappy');
-  } catch (error) {} // eslint-disable-line
+  let snappy = require_optional('snappy');
   if (!snappy) {
     snappy = {
       compress: noSnappyWarning,

package/lib/core/error.js

@@ -102,8 +102,8 @@ class MongoNetworkError extends MongoError {
     super(message);
     this.name = 'MongoNetworkError';
 
-    if (options && options.beforeHandshake === true) {
-      this[kBeforeHandshake] = true;
+    if (options && typeof options.beforeHandshake === 'boolean') {
+      this[kBeforeHandshake] = options.beforeHandshake;
     }
   }
 }

package/lib/core/index.js

@@ -1,7 +1,7 @@
 'use strict';
 
 let BSON = require('bson');
-const require_optional = require('require_optional');
+const require_optional = require('optional-require')(require);
 const EJSON = require('./utils').retrieveEJSON();
 
 try {

package/lib/core/sdam/monitor.js

@@ -91,6 +91,10 @@ class Monitor extends EventEmitter {
 
     // ensure no authentication is used for monitoring
     delete connectOptions.credentials;
+
+    // ensure encryption is not requested for monitoring
+    delete connectOptions.autoEncrypter;
+
     this.connectOptions = Object.freeze(connectOptions);
   }
 
@@ -222,9 +226,10 @@ function checkServer(monitor, callback) {
       }
 
       const isMaster = result.result;
-      const duration = isAwaitable
-        ? monitor[kRTTPinger].roundTripTime
-        : calculateDurationInMs(start);
+      const rttPinger = monitor[kRTTPinger];
+
+      const duration =
+        isAwaitable && rttPinger ? rttPinger.roundTripTime : calculateDurationInMs(start);
 
       monitor.emit(
         'serverHeartbeatSucceeded',

package/lib/core/sdam/topology.js

@@ -27,6 +27,7 @@ const ServerSessionPool = require('../sessions').ServerSessionPool;
 const makeClientMetadata = require('../utils').makeClientMetadata;
 const CMAP_EVENT_NAMES = require('../../cmap/events').CMAP_EVENT_NAMES;
 const compareTopologyVersion = require('./server_description').compareTopologyVersion;
+const emitWarning = require('../../utils').emitWarning;
 
 const common = require('./common');
 const drainTimerQueue = common.drainTimerQueue;
@@ -358,7 +359,6 @@ class Topology extends EventEmitter {
           this.emit('topologyClosed', new events.TopologyClosedEvent(this.s.id));
 
           stateTransition(this, STATE_CLOSED);
-          this.emit('close');
 
           if (typeof callback === 'function') {
             callback(err);
@@ -739,7 +739,7 @@ class Topology extends EventEmitter {
   }
 
   unref() {
-    console.log('not implemented: `unref`');
+    emitWarning('not implemented: `unref`');
   }
 
   // NOTE: There are many places in code where we explicitly check the last isMaster

package/lib/core/sdam/topology_description.js

@@ -72,12 +72,30 @@ class TopologyDescription {
     // value among ServerDescriptions of all data-bearing server types. If any have a null
     // logicalSessionTimeoutMinutes, then TopologyDescription.logicalSessionTimeoutMinutes MUST be
     // set to null.
-    const readableServers = Array.from(this.servers.values()).filter(s => s.isReadable);
-    this.logicalSessionTimeoutMinutes = readableServers.reduce((result, server) => {
-      if (server.logicalSessionTimeoutMinutes == null) return null;
-      if (result == null) return server.logicalSessionTimeoutMinutes;
-      return Math.min(result, server.logicalSessionTimeoutMinutes);
-    }, null);
+    this.logicalSessionTimeoutMinutes = null;
+    for (const addressServerTuple of this.servers) {
+      const server = addressServerTuple[1];
+      if (server.isReadable) {
+        if (server.logicalSessionTimeoutMinutes == null) {
+          // If any of the servers have a null logicalSessionsTimeout, then the whole topology does
+          this.logicalSessionTimeoutMinutes = null;
+          break;
+        }
+
+        if (this.logicalSessionTimeoutMinutes == null) {
+          // First server with a non null logicalSessionsTimeout
+          this.logicalSessionTimeoutMinutes = server.logicalSessionTimeoutMinutes;
+          continue;
+        }
+
+        // Always select the smaller of the:
+        // current server logicalSessionsTimeout and the topologies logicalSessionsTimeout
+        this.logicalSessionTimeoutMinutes = Math.min(
+          this.logicalSessionTimeoutMinutes,
+          server.logicalSessionTimeoutMinutes
+        );
+      }
+    }
   }
 
   /**

package/lib/core/tools/smoke_plugin.js

@@ -52,6 +52,7 @@ exports.attachToRunner = function(runner, outputFile) {
     fs.writeFileSync(outputFile, JSON.stringify(smokeOutput));
 
     // Standard NodeJS uncaught exception handler
+    // eslint-disable-next-line no-console
     console.error(err.stack);
     process.exit(1);
   });

package/lib/core/topologies/read_preference.js

@@ -1,4 +1,5 @@
 'use strict';
+const emitWarningOnce = require('../../utils').emitWarningOnce;
 
 /**
  * The **ReadPreference** class is a class that represents a MongoDB ReadPreference and is
@@ -20,7 +21,7 @@ const ReadPreference = function(mode, tags, options) {
 
   // TODO(major): tags MUST be an array of tagsets
   if (tags && !Array.isArray(tags)) {
-    console.warn(
+    emitWarningOnce(
       'ReadPreference tags must be an array, this will change in the next major version'
     );
 

package/lib/core/topologies/replset.js

@@ -558,7 +558,7 @@ var monitorServer = function(host, self, options) {
               self.s.options.secondaryOnlyConnectionAllowed) ||
               self.s.replicaSetState.hasPrimary())
           ) {
-            stateTransition(self, CONNECTED);
+            stateTransition(self, CONNECTING);
 
             // Rexecute any stalled operation
             rexecuteOperations(self);

package/lib/core/uri_parser.js

@@ -4,6 +4,7 @@ const qs = require('querystring');
 const dns = require('dns');
 const MongoParseError = require('./error').MongoParseError;
 const ReadPreference = require('./topologies/read_preference');
+const emitWarningOnce = require('../utils').emitWarningOnce;
 
 /**
  * The following regular expression validates a connection string and breaks the
@@ -438,7 +439,7 @@ function parseQueryString(query, options) {
   // special cases for known deprecated options
   if (result.wtimeout && result.wtimeoutms) {
     delete result.wtimeout;
-    console.warn('Unsupported option `wtimeout` specified');
+    emitWarningOnce('Unsupported option `wtimeout` specified');
   }
 
   return Object.keys(result).length ? result : null;

package/lib/core/utils.js

@@ -1,7 +1,7 @@
 'use strict';
 const os = require('os');
 const crypto = require('crypto');
-const requireOptional = require('require_optional');
+const requireOptional = require('optional-require')(require);
 
 /**
  * Generate a UUIDv4
@@ -46,10 +46,7 @@ const noEJSONError = function() {
 
 // Facilitate loading EJSON optionally
 function retrieveEJSON() {
-  let EJSON = null;
-  try {
-    EJSON = requireOptional('mongodb-extjson');
-  } catch (error) {} // eslint-disable-line
+  let EJSON = requireOptional('mongodb-extjson');
   if (!EJSON) {
     EJSON = {
       parse: noEJSONError,

package/lib/core/wireprotocol/command.js

@@ -45,14 +45,19 @@ function _command(server, ns, cmd, options, callback) {
   const shouldUseOpMsg = supportsOpMsg(server);
   const session = options.session;
 
-  let clusterTime = server.clusterTime;
+  const serverClusterTime = server.clusterTime;
+  let clusterTime = serverClusterTime;
   let finalCmd = Object.assign({}, cmd);
   if (hasSessionSupport(server) && session) {
+    const sessionClusterTime = session.clusterTime;
     if (
-      session.clusterTime &&
-      session.clusterTime.clusterTime.greaterThan(clusterTime.clusterTime)
+      serverClusterTime &&
+      serverClusterTime.clusterTime &&
+      sessionClusterTime &&
+      sessionClusterTime.clusterTime &&
+      sessionClusterTime.clusterTime.greaterThan(serverClusterTime.clusterTime)
     ) {
-      clusterTime = session.clusterTime;
+      clusterTime = sessionClusterTime;
     }
 
     const err = applySession(session, finalCmd, options);
@@ -61,8 +66,8 @@ function _command(server, ns, cmd, options, callback) {
     }
   }
 
-  // if we have a known cluster time, gossip it
   if (clusterTime) {
+    // if we have a known cluster time, gossip it
     finalCmd.$clusterTime = clusterTime;
   }
 

package/lib/core/wireprotocol/kill_cursors.js

@@ -5,6 +5,7 @@ const MongoError = require('../error').MongoError;
 const MongoNetworkError = require('../error').MongoNetworkError;
 const collectionNamespace = require('./shared').collectionNamespace;
 const maxWireVersion = require('../utils').maxWireVersion;
+const emitWarning = require('../utils').emitWarning;
 const command = require('./command');
 
 function killCursors(server, ns, cursorState, callback) {
@@ -31,7 +32,7 @@ function killCursors(server, ns, cursorState, callback) {
         if (typeof callback === 'function') {
           callback(err, null);
         } else {
-          console.warn(err);
+          emitWarning(err);
         }
       }
     }

package/lib/db.js

@@ -12,7 +12,7 @@ const MongoError = require('./core').MongoError;
 const ObjectID = require('./core').ObjectID;
 const Logger = require('./core').Logger;
 const Collection = require('./collection');
-const mergeOptionsAndWriteConcern = require('./utils').mergeOptionsAndWriteConcern;
+const conditionallyMergeWriteConcern = require('./utils').conditionallyMergeWriteConcern;
 const executeLegacyOperation = require('./utils').executeLegacyOperation;
 const ChangeStream = require('./change_stream');
 const deprecate = require('util').deprecate;
@@ -382,7 +382,7 @@ Db.prototype.admin = function() {
  * @param {AggregationCursor} cursor The cursor if the aggregation command was executed successfully.
  */
 
-const collectionKeys = [
+const COLLECTION_OPTION_KEYS = [
   'pkFactory',
   'readPreference',
   'serializeFunctions',
@@ -433,8 +433,14 @@ Db.prototype.collection = function(name, options, callback) {
     options.ignoreUndefined = this.s.options.ignoreUndefined;
   }
 
+  for (const collectionOptionKey of COLLECTION_OPTION_KEYS) {
+    if (!(collectionOptionKey in options) && this.s.options[collectionOptionKey] !== undefined) {
+      options[collectionOptionKey] = this.s.options[collectionOptionKey];
+    }
+  }
+
   // Merge in all needed options and ensure correct writeConcern merging from db level
-  options = mergeOptionsAndWriteConcern(options, this.s.options, collectionKeys, true);
+  options = conditionallyMergeWriteConcern(options, this.s.options);
 
   // Execute
   if (options == null || !options.strict) {