mongodb 3.6.9 → 3.7.0

package/lib/core/wireprotocol/kill_cursors.js

@@ -8,8 +8,13 @@ const maxWireVersion = require('../utils').maxWireVersion;
 const emitWarning = require('../utils').emitWarning;
 const command = require('./command');
 
-function killCursors(server, ns, cursorState, callback) {
+function killCursors(server, ns, cursorState, defaultOptions, callback) {
+  if (typeof defaultOptions === 'function') {
+    callback = defaultOptions;
+    defaultOptions = {};
+  }
   callback = typeof callback === 'function' ? callback : () => {};
+
   const cursorId = cursorState.cursorId;
 
   if (maxWireVersion(server) < 4) {
@@ -45,7 +50,7 @@ function killCursors(server, ns, cursorState, callback) {
     cursors: [cursorId]
   };
 
-  const options = {};
+  const options = defaultOptions || {};
   if (typeof cursorState.session === 'object') options.session = cursorState.session;
 
   command(server, ns, killCursorCmd, options, (err, result) => {

package/lib/core/wireprotocol/query.js

@@ -37,9 +37,13 @@ function query(server, ns, cmd, cursorState, options, callback) {
 
   // If we have explain, we need to rewrite the find command
   // to wrap it in the explain command
-  const explain = Explain.fromOptions(options);
-  if (explain) {
-    findCmd = decorateWithExplain(findCmd, explain);
+  try {
+    const explain = Explain.fromOptions(options);
+    if (explain) {
+      findCmd = decorateWithExplain(findCmd, explain);
+    }
+  } catch (err) {
+    return callback(err);
   }
 
   // NOTE: This actually modifies the passed in cmd, and our code _depends_ on this
@@ -140,8 +144,8 @@ function prepareFindCommand(server, ns, cmd, cursorState) {
   if (cmd.maxTimeMS) findCmd.maxTimeMS = cmd.maxTimeMS;
   if (cmd.min) findCmd.min = cmd.min;
   if (cmd.max) findCmd.max = cmd.max;
-  findCmd.returnKey = cmd.returnKey ? cmd.returnKey : false;
-  findCmd.showRecordId = cmd.showDiskLoc ? cmd.showDiskLoc : false;
+  if (typeof cmd.returnKey === 'boolean') findCmd.returnKey = cmd.returnKey;
+  if (typeof cmd.showDiskLoc === 'boolean') findCmd.showRecordId = cmd.showDiskLoc;
   if (cmd.snapshot) findCmd.snapshot = cmd.snapshot;
   if (cmd.tailable) findCmd.tailable = cmd.tailable;
   if (cmd.oplogReplay) findCmd.oplogReplay = cmd.oplogReplay;

package/lib/core/wireprotocol/shared.js

@@ -57,6 +57,7 @@ function applyCommonQueryOptions(queryOptions, options) {
     promoteLongs: typeof options.promoteLongs === 'boolean' ? options.promoteLongs : true,
     promoteValues: typeof options.promoteValues === 'boolean' ? options.promoteValues : true,
     promoteBuffers: typeof options.promoteBuffers === 'boolean' ? options.promoteBuffers : false,
+    bsonRegExp: typeof options.bsonRegExp === 'boolean' ? options.bsonRegExp : false,
     monitoring: typeof options.monitoring === 'boolean' ? options.monitoring : false,
     fullResult: typeof options.fullResult === 'boolean' ? options.fullResult : false
   });

package/lib/cursor.js

@@ -165,6 +165,10 @@ class Cursor extends CoreCursor {
     return this.cmd.sort;
   }
 
+  set session(clientSession) {
+    this.cursorState.session = clientSession;
+  }
+
   _initializeCursor(callback) {
     if (this.operation && this.operation.session != null) {
       this.cursorState.session = this.operation.session;
@@ -742,7 +746,12 @@ class Cursor extends CoreCursor {
           return false;
         }
         if (doc != null) {
-          iterator(doc);
+          try {
+            iterator(doc);
+          } catch (error) {
+            callback(error);
+            return false;
+          }
           return true;
         }
         if (doc == null && callback) {
@@ -762,7 +771,12 @@ class Cursor extends CoreCursor {
             fulfill(null);
             return false;
           } else {
-            iterator(doc);
+            try {
+              iterator(doc);
+            } catch (error) {
+              reject(error);
+              return false;
+            }
             return true;
           }
         });

package/lib/db.js

@@ -83,7 +83,6 @@ const legalOptionNames = [
   'bufferMaxEntries',
   'authSource',
   'ignoreUndefined',
-  'promoteLongs',
   'promiseLibrary',
   'readConcern',
   'retryMiliSeconds',
@@ -95,6 +94,7 @@ const legalOptionNames = [
   'promoteBuffers',
   'promoteLongs',
   'promoteValues',
+  'bsonRegExp',
   'compression',
   'retryWrites'
 ];
@@ -117,6 +117,7 @@ const legalOptionNames = [
  * @param {boolean} [options.promoteLongs=true] Promotes Long values to number if they fit inside the 53 bits resolution.
  * @param {boolean} [options.promoteBuffers=false] Promotes Binary BSON values to native Node Buffers.
  * @param {boolean} [options.promoteValues=true] Promotes BSON values to native types where possible, set to false to only receive wrapper types.
+ * @param {boolean} [options.bsonRegExp=false] By default, regex returned from MDB will be native to the language. Setting to true will ensure that a BSON.BSONRegExp object is returned.
  * @param {number} [options.bufferMaxEntries=-1] Sets a cap on how many operations the driver will buffer up before giving up on getting a working connection, default is -1 which is unlimited.
  * @param {(ReadPreference|string)} [options.readPreference] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
  * @param {object} [options.pkFactory] A primary key factory object for generation of custom _id keys.
@@ -323,6 +324,7 @@ Db.prototype.command = function(command, options, callback) {
  * @param {boolean} [options.promoteLongs=true] Promotes Long values to number if they fit inside the 53 bits resolution.
  * @param {boolean} [options.promoteValues=true] Promotes BSON values to native types where possible, set to false to only receive wrapper types.
  * @param {boolean} [options.promoteBuffers=false] Promotes Binary BSON values to native Node Buffers.
+ * @param {boolean} [options.bsonRegExp=false] By default, regex returned from MDB will be native to the language. Setting to true will ensure that a BSON.BSONRegExp object is returned.
  * @param {object} [options.collation] Specify collation (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).
  * @param {string} [options.comment] Add a comment to an aggregation command
  * @param {string|object} [options.hint] Add an index selection hint to an aggregation command
@@ -391,7 +393,8 @@ const COLLECTION_OPTION_KEYS = [
   'ignoreUndefined',
   'promoteValues',
   'promoteBuffers',
-  'promoteLongs'
+  'promoteLongs',
+  'bsonRegExp'
 ];
 
 /**
@@ -409,91 +412,98 @@ const COLLECTION_OPTION_KEYS = [
  * @param {object} [options.pkFactory] A primary key factory object for generation of custom _id keys.
  * @param {(ReadPreference|string)} [options.readPreference] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
  * @param {boolean} [options.serializeFunctions=false] Serialize functions on any object.
- * @param {boolean} [options.strict=false] Returns an error if the collection does not exist
+ * @param {boolean} [options.strict=false] **Deprecated** Returns an error if the collection does not exist
  * @param {object} [options.readConcern] Specify a read concern for the collection. (only MongoDB 3.2 or higher supported)
  * @param {ReadConcernLevel} [options.readConcern.level='local'] Specify a read concern level for the collection operations (only MongoDB 3.2 or higher supported)
  * @param {Db~collectionResultCallback} [callback] The collection result callback
  * @return {Collection} return the new Collection instance if not in strict mode
  */
-Db.prototype.collection = function(name, options, callback) {
-  if (typeof options === 'function') (callback = options), (options = {});
-  options = options || {};
-  options = Object.assign({}, options);
-
-  // Set the promise library
-  options.promiseLibrary = this.s.promiseLibrary;
+Db.prototype.collection = deprecateOptions(
+  {
+    name: 'Db.collection',
+    deprecatedOptions: ['strict'],
+    optionsIndex: 1
+  },
+  function(name, options, callback) {
+    if (typeof options === 'function') (callback = options), (options = {});
+    options = options || {};
+    options = Object.assign({}, options);
 
-  // If we have not set a collection level readConcern set the db level one
-  options.readConcern = options.readConcern
-    ? new ReadConcern(options.readConcern.level)
-    : this.readConcern;
+    // Set the promise library
+    options.promiseLibrary = this.s.promiseLibrary;
 
-  // Do we have ignoreUndefined set
-  if (this.s.options.ignoreUndefined) {
-    options.ignoreUndefined = this.s.options.ignoreUndefined;
-  }
+    // If we have not set a collection level readConcern set the db level one
+    options.readConcern = options.readConcern
+      ? new ReadConcern(options.readConcern.level)
+      : this.readConcern;
 
-  for (const collectionOptionKey of COLLECTION_OPTION_KEYS) {
-    if (!(collectionOptionKey in options) && this.s.options[collectionOptionKey] !== undefined) {
-      options[collectionOptionKey] = this.s.options[collectionOptionKey];
+    // Do we have ignoreUndefined set
+    if (this.s.options.ignoreUndefined) {
+      options.ignoreUndefined = this.s.options.ignoreUndefined;
     }
-  }
 
-  // Merge in all needed options and ensure correct writeConcern merging from db level
-  options = conditionallyMergeWriteConcern(options, this.s.options);
-
-  // Execute
-  if (options == null || !options.strict) {
-    try {
-      const collection = new Collection(
-        this,
-        this.s.topology,
-        this.databaseName,
-        name,
-        this.s.pkFactory,
-        options
-      );
-      if (callback) callback(null, collection);
-      return collection;
-    } catch (err) {
-      if (err instanceof MongoError && callback) return callback(err);
-      throw err;
+    for (const collectionOptionKey of COLLECTION_OPTION_KEYS) {
+      if (!(collectionOptionKey in options) && this.s.options[collectionOptionKey] !== undefined) {
+        options[collectionOptionKey] = this.s.options[collectionOptionKey];
+      }
     }
-  }
 
-  // Strict mode
-  if (typeof callback !== 'function') {
-    throw toError(`A callback is required in strict mode. While getting collection ${name}`);
-  }
+    // Merge in all needed options and ensure correct writeConcern merging from db level
+    options = conditionallyMergeWriteConcern(options, this.s.options);
+
+    // Execute
+    if (options == null || !options.strict) {
+      try {
+        const collection = new Collection(
+          this,
+          this.s.topology,
+          this.databaseName,
+          name,
+          this.s.pkFactory,
+          options
+        );
+        if (callback) callback(null, collection);
+        return collection;
+      } catch (err) {
+        if (err instanceof MongoError && callback) return callback(err);
+        throw err;
+      }
+    }
 
-  // Did the user destroy the topology
-  if (this.serverConfig && this.serverConfig.isDestroyed()) {
-    return callback(new MongoError('topology was destroyed'));
-  }
+    // Strict mode
+    if (typeof callback !== 'function') {
+      throw toError(`A callback is required in strict mode. While getting collection ${name}`);
+    }
 
-  const listCollectionOptions = Object.assign({}, options, { nameOnly: true });
-
-  // Strict mode
-  this.listCollections({ name: name }, listCollectionOptions).toArray((err, collections) => {
-    if (err != null) return handleCallback(callback, err, null);
-    if (collections.length === 0)
-      return handleCallback(
-        callback,
-        toError(`Collection ${name} does not exist. Currently in strict mode.`),
-        null
-      );
-
-    try {
-      return handleCallback(
-        callback,
-        null,
-        new Collection(this, this.s.topology, this.databaseName, name, this.s.pkFactory, options)
-      );
-    } catch (err) {
-      return handleCallback(callback, err, null);
+    // Did the user destroy the topology
+    if (this.serverConfig && this.serverConfig.isDestroyed()) {
+      return callback(new MongoError('topology was destroyed'));
     }
-  });
-};
+
+    const listCollectionOptions = Object.assign({}, options, { nameOnly: true });
+
+    // Strict mode
+    this.listCollections({ name: name }, listCollectionOptions).toArray((err, collections) => {
+      if (err != null) return handleCallback(callback, err, null);
+      if (collections.length === 0)
+        return handleCallback(
+          callback,
+          toError(`Collection ${name} does not exist. Currently in strict mode.`),
+          null
+        );
+
+      try {
+        return handleCallback(
+          callback,
+          null,
+          new Collection(this, this.s.topology, this.databaseName, name, this.s.pkFactory, options)
+        );
+      } catch (err) {
+        return handleCallback(callback, err, null);
+      }
+    });
+  }
+);
 
 /**
  * Create a new collection on a server with the specified options. Use this to create capped collections.
@@ -941,6 +951,7 @@ Db.prototype.indexInformation = function(name, options, callback) {
 /**
  * Unref all sockets
  * @method
+ * @deprecated This function is deprecated and will be removed in the next major version.
  */
 Db.prototype.unref = function() {
   this.s.topology.unref();

package/lib/encrypter.js

@@ -3,8 +3,10 @@ const MongoClient = require('./mongo_client');
 const BSON = require('./core/connection/utils').retrieveBSON();
 const MongoError = require('./core/error').MongoError;
 
+let mongodbClientEncryption = undefined;
 try {
-  require.resolve('mongodb-client-encryption');
+  // Ensure you always wrap an optional require in the try block NODE-3199
+  mongodbClientEncryption = require('mongodb-client-encryption');
 } catch (err) {
   throw new MongoError(
     'Auto-encryption requested, but the module is not installed. ' +
@@ -12,13 +14,16 @@ try {
   );
 }
 
-const mongodbClientEncryption = require('mongodb-client-encryption');
-if (typeof mongodbClientEncryption.extension !== 'function') {
+if (
+  mongodbClientEncryption === undefined ||
+  typeof mongodbClientEncryption.extension !== 'function'
+) {
   throw new MongoError(
     'loaded version of `mongodb-client-encryption` does not have property `extension`. ' +
       'Please make sure you are loading the correct version of `mongodb-client-encryption`'
   );
 }
+
 const AutoEncrypter = mongodbClientEncryption.extension(require('../index')).AutoEncrypter;
 
 const kInternalClient = Symbol('internalClient');

package/lib/explain.js

@@ -2,16 +2,9 @@
 
 const MongoError = require('./core/error').MongoError;
 
-const ExplainVerbosity = {
-  queryPlanner: 'queryPlanner',
-  queryPlannerExtended: 'queryPlannerExtended',
-  executionStats: 'executionStats',
-  allPlansExecution: 'allPlansExecution'
-};
-
 /**
  * @class
- * @property {'queryPlanner'|'queryPlannerExtended'|'executionStats'|'allPlansExecution'} verbosity The verbosity mode for the explain output.
+ * @property {string} verbosity The verbosity mode for the explain output, e.g.: 'queryPlanner', 'queryPlannerExtended', 'executionStats', 'allPlansExecution'.
  */
 class Explain {
   /**
@@ -21,7 +14,7 @@ class Explain {
    * and false as "queryPlanner". Prior to server version 3.6, aggregate()
    * ignores the verbosity parameter and executes in "queryPlanner".
    *
-   * @param {'queryPlanner'|'queryPlannerExtended'|'executionStats'|'allPlansExecution'|boolean} [verbosity] The verbosity mode for the explain output.
+   * @param {string|boolean} [verbosity] The verbosity mode for the explain output.
    */
   constructor(verbosity) {
     if (typeof verbosity === 'boolean') {
@@ -35,7 +28,7 @@ class Explain {
    * Construct an Explain given an options object.
    *
    * @param {object} [options] The options object from which to extract the explain.
-   * @param {'queryPlanner'|'queryPlannerExtended'|'executionStats'|'allPlansExecution'|boolean} [options.explain] The verbosity mode for the explain output
+   * @param {string|boolean} [options.explain] The verbosity mode for the explain output.
    * @return {Explain}
    */
   static fromOptions(options) {
@@ -44,11 +37,11 @@ class Explain {
     }
 
     const explain = options.explain;
-    if (typeof explain === 'boolean' || explain in ExplainVerbosity) {
+    if (typeof explain === 'boolean' || typeof explain === 'string') {
       return new Explain(options.explain);
     }
 
-    throw new MongoError(`explain must be one of ${Object.keys(ExplainVerbosity)} or a boolean`);
+    throw new MongoError(`explain must be a string or a boolean`);
   }
 }
 

package/lib/gridfs-stream/index.js

@@ -7,6 +7,7 @@ var shallowClone = require('../utils').shallowClone;
 var toError = require('../utils').toError;
 var util = require('util');
 var executeLegacyOperation = require('../utils').executeLegacyOperation;
+const deprecateOptions = require('../utils').deprecateOptions;
 
 var DEFAULT_GRIDFS_BUCKET_OPTIONS = {
   bucketName: 'fs',
@@ -79,21 +80,28 @@ util.inherits(GridFSBucket, Emitter);
  * @param {object} [options.metadata] Optional object to store in the file document's `metadata` field
  * @param {string} [options.contentType] Optional string to store in the file document's `contentType` field
  * @param {array} [options.aliases] Optional array of strings to store in the file document's `aliases` field
- * @param {boolean} [options.disableMD5=false] If true, disables adding an md5 field to file data
+ * @param {boolean} [options.disableMD5=false] **Deprecated** If true, disables adding an md5 field to file data
  * @return {GridFSBucketWriteStream}
  */
 
-GridFSBucket.prototype.openUploadStream = function(filename, options) {
-  if (options) {
-    options = shallowClone(options);
-  } else {
-    options = {};
-  }
-  if (!options.chunkSizeBytes) {
-    options.chunkSizeBytes = this.s.options.chunkSizeBytes;
+GridFSBucket.prototype.openUploadStream = deprecateOptions(
+  {
+    name: 'GridFSBucket.openUploadStream',
+    deprecatedOptions: ['disableMD5'],
+    optionsIndex: 1
+  },
+  function(filename, options) {
+    if (options) {
+      options = shallowClone(options);
+    } else {
+      options = {};
+    }
+    if (!options.chunkSizeBytes) {
+      options.chunkSizeBytes = this.s.options.chunkSizeBytes;
+    }
+    return new GridFSBucketWriteStream(this, filename, options);
   }
-  return new GridFSBucketWriteStream(this, filename, options);
-};
+);
 
 /**
  * Returns a writable stream (GridFSBucketWriteStream) for writing
@@ -107,25 +115,32 @@ GridFSBucket.prototype.openUploadStream = function(filename, options) {
  * @param {object} [options.metadata] Optional object to store in the file document's `metadata` field
  * @param {string} [options.contentType] Optional string to store in the file document's `contentType` field
  * @param {array} [options.aliases] Optional array of strings to store in the file document's `aliases` field
- * @param {boolean} [options.disableMD5=false] If true, disables adding an md5 field to file data
+ * @param {boolean} [options.disableMD5=false] **Deprecated** If true, disables adding an md5 field to file data
  * @return {GridFSBucketWriteStream}
  */
 
-GridFSBucket.prototype.openUploadStreamWithId = function(id, filename, options) {
-  if (options) {
-    options = shallowClone(options);
-  } else {
-    options = {};
-  }
+GridFSBucket.prototype.openUploadStreamWithId = deprecateOptions(
+  {
+    name: 'GridFSBucket.openUploadStreamWithId',
+    deprecatedOptions: ['disableMD5'],
+    optionsIndex: 2
+  },
+  function(id, filename, options) {
+    if (options) {
+      options = shallowClone(options);
+    } else {
+      options = {};
+    }
 
-  if (!options.chunkSizeBytes) {
-    options.chunkSizeBytes = this.s.options.chunkSizeBytes;
-  }
+    if (!options.chunkSizeBytes) {
+      options.chunkSizeBytes = this.s.options.chunkSizeBytes;
+    }
 
-  options.id = id;
+    options.id = id;
 
-  return new GridFSBucketWriteStream(this, filename, options);
-};
+    return new GridFSBucketWriteStream(this, filename, options);
+  }
+);
 
 /**
  * Returns a readable stream (GridFSBucketReadStream) for streaming file

package/lib/gridfs-stream/upload.js

@@ -5,10 +5,9 @@ var crypto = require('crypto');
 var stream = require('stream');
 var util = require('util');
 var Buffer = require('safe-buffer').Buffer;
+const deprecateOptions = require('../utils').deprecateOptions;
 
-var ERROR_NAMESPACE_NOT_FOUND = 26;
-
-module.exports = GridFSBucketWriteStream;
+const ERROR_NAMESPACE_NOT_FOUND = 26;
 
 /**
  * A writable stream that enables you to write buffers to GridFS.
@@ -31,42 +30,49 @@ module.exports = GridFSBucketWriteStream;
  * @fires GridFSBucketWriteStream#finish
  */
 
-function GridFSBucketWriteStream(bucket, filename, options) {
-  options = options || {};
-  stream.Writable.call(this, options);
-  this.bucket = bucket;
-  this.chunks = bucket.s._chunksCollection;
-  this.filename = filename;
-  this.files = bucket.s._filesCollection;
-  this.options = options;
-  // Signals the write is all done
-  this.done = false;
-
-  this.id = options.id ? options.id : core.BSON.ObjectId();
-  this.chunkSizeBytes = this.options.chunkSizeBytes;
-  this.bufToStore = Buffer.alloc(this.chunkSizeBytes);
-  this.length = 0;
-  this.md5 = !options.disableMD5 && crypto.createHash('md5');
-  this.n = 0;
-  this.pos = 0;
-  this.state = {
-    streamEnd: false,
-    outstandingRequests: 0,
-    errored: false,
-    aborted: false,
-    promiseLibrary: this.bucket.s.promiseLibrary
-  };
-
-  if (!this.bucket.s.calledOpenUploadStream) {
-    this.bucket.s.calledOpenUploadStream = true;
-
-    var _this = this;
-    checkIndexes(this, function() {
-      _this.bucket.s.checkedIndexes = true;
-      _this.bucket.emit('index');
-    });
+const GridFSBucketWriteStream = deprecateOptions(
+  {
+    name: 'GridFSBucketWriteStream',
+    deprecatedOptions: ['disableMD5'],
+    optionsIndex: 2
+  },
+  function(bucket, filename, options) {
+    options = options || {};
+    stream.Writable.call(this, options);
+    this.bucket = bucket;
+    this.chunks = bucket.s._chunksCollection;
+    this.filename = filename;
+    this.files = bucket.s._filesCollection;
+    this.options = options;
+    // Signals the write is all done
+    this.done = false;
+
+    this.id = options.id ? options.id : core.BSON.ObjectId();
+    this.chunkSizeBytes = this.options.chunkSizeBytes;
+    this.bufToStore = Buffer.alloc(this.chunkSizeBytes);
+    this.length = 0;
+    this.md5 = !options.disableMD5 && crypto.createHash('md5');
+    this.n = 0;
+    this.pos = 0;
+    this.state = {
+      streamEnd: false,
+      outstandingRequests: 0,
+      errored: false,
+      aborted: false,
+      promiseLibrary: this.bucket.s.promiseLibrary
+    };
+
+    if (!this.bucket.s.calledOpenUploadStream) {
+      this.bucket.s.calledOpenUploadStream = true;
+
+      var _this = this;
+      checkIndexes(this, function() {
+        _this.bucket.s.checkedIndexes = true;
+        _this.bucket.emit('index');
+      });
+    }
   }
-}
+);
 
 util.inherits(GridFSBucketWriteStream, stream.Writable);
 
@@ -539,3 +545,5 @@ function checkAborted(_this, callback) {
   }
   return false;
 }
+
+module.exports = GridFSBucketWriteStream;