mongodb 2.2.20 → 2.2.24

package/HISTORY.md

@@ -1,14 +1,43 @@
+2.2.24 2017-02-14
+-----------------
+* NODE-935, NODE-931 Make MongoClient strict options validation optional and instead print annoying console.warn entries.
+
+2.2.23 2017-02-13
+-----------------
+* Updated mongodb-core to 2.1.8.
+  * NODE-925 ensure we reschedule operations while pool is < poolSize while pool is growing and there are no connections with not currently performing work.
+  * NODE-927 fixes issue where authentication was performed against arbiter instances.
+  * NODE-915 Normalize all host names to avoid comparison issues.
+  * Fixed issue where pool.destroy would never finish due to a single operation not being executed and keeping it open.
+* NODE-931 Validates all the options for MongoClient.connect and fixes missing connection settings.
+* NODE-929 Update SSL tutorial to correctly reflect the non-need for server/mongos/replset subobjects
+* Fix sensitive command check (Issue #1473, https://github.com/Annoraaq)
+
+2.2.22 2017-01-24
+-----------------
+* Updated mongodb-core to 2.1.7.
+  * NODE-919 ReplicaSet connection does not close immediately (Issue #156).
+  * NODE-901 Fixed bug when normalizing host names.
+  * NODE-909 Fixed readPreference issue caused by direct connection to primary.
+  * NODE-910 Fixed issue when bufferMaxEntries == 0 and read preference set to nearest.
+* Add missing unref implementations for replset, mongos (Issue #1455, https://github.com/zbjornson)
+
+2.2.21 2017-01-13
+-----------------
+* Updated mongodb-core to 2.1.6.
+  * NODE-908 Keep auth contexts in replset and mongos topology to ensure correct application of authentication credentials when primary is first server to be detected causing an immediate connect event to happen.
+
 2.2.20 2017-01-11
 -----------------
-- Updated mongodb-core to 2.1.5 to include bson 1.0.4 and bson-ext 1.0.4 due to Buffer.from being broken in early node 4.x versions.
+* Updated mongodb-core to 2.1.5 to include bson 1.0.4 and bson-ext 1.0.4 due to Buffer.from being broken in early node 4.x versions.
 
 2.2.19 2017-01-03
 -----------------
-- Corrupted Npm release fix.
+* Corrupted Npm release fix.
 
 2.2.18 2017-01-03
 -----------------
-- Updated mongodb-core to 2.1.4 to fix bson ObjectId toString issue with utils.inspect messing with toString parameters in node 6.
+* Updated mongodb-core to 2.1.4 to fix bson ObjectId toString issue with utils.inspect messing with toString parameters in node 6.
 
 2.2.17 2017-01-02
 -----------------

package/conf.json

@@ -36,7 +36,10 @@
       "node_modules/bson/lib/bson/symbol.js",
       "node_modules/bson/lib/bson/timestamp.js",
       "node_modules/bson/lib/bson/max_key.js",
-      "node_modules/bson/lib/bson/min_key.js"
+      "node_modules/bson/lib/bson/min_key.js",
+      "node_modules/bson/lib/bson/decimal128.js",
+      "node_modules/bson/lib/bson/int_32.js",
+      "node_modules/bson/lib/bson/regexp.js"
     ]
   },
   "templates": {

package/lib/apm.js

@@ -181,7 +181,7 @@ var Instrumentation = function(core, options, callback) {
       };
 
       // Filter out any sensitive commands
-      if(senstiveCommands.indexOf(commandName.toLowerCase())) {
+      if(senstiveCommands.indexOf(commandName.toLowerCase()) != -1) {
         command.commandObj = {};
         command.commandObj[commandName] = true;
       }
@@ -208,7 +208,7 @@ var Instrumentation = function(core, options, callback) {
           command.failure = err || r.result.writeErrors || r.result;
 
           // Filter out any sensitive commands
-          if(senstiveCommands.indexOf(commandName.toLowerCase())) {
+          if(senstiveCommands.indexOf(commandName.toLowerCase()) != -1) {
             command.failure = {};
           }
 

package/lib/db.js

@@ -1032,8 +1032,6 @@ Db.prototype.createIndex = function(name, fieldOrSpec, options, callback) {
   options = options == null ? {} : options;
   // Shallow clone the options
   options = shallowClone(options);
-  // Run only against primary
-  options.readPreference = ReadPreference.PRIMARY;
 
   // If we have a callback fallback
   if(typeof callback == 'function') return createIndex(self, name, fieldOrSpec, options, callback);
@@ -1048,12 +1046,15 @@ Db.prototype.createIndex = function(name, fieldOrSpec, options, callback) {
 
 var createIndex = function(self, name, fieldOrSpec, options, callback) {
   // Get the write concern options
-  var finalOptions = writeConcern({}, self, options);
+  var finalOptions = writeConcern({}, self, options, { readPreference: ReadPreference.PRIMARY });
   // Ensure we have a callback
   if(finalOptions.writeConcern && typeof callback != 'function') {
     throw MongoError.create({message: "Cannot use a writeConcern without a provided callback", driver:true});
   }
 
+  // Run only against primary
+  options.readPreference = ReadPreference.PRIMARY;
+
   // Did the user destroy the topology
   if(self.serverConfig && self.serverConfig.isDestroyed()) return callback(new MongoError('topology was destroyed'));
 
@@ -1136,6 +1137,9 @@ var ensureIndex = function(self, name, fieldOrSpec, options, callback) {
   // Did the user destroy the topology
   if(self.serverConfig && self.serverConfig.isDestroyed()) return callback(new MongoError('topology was destroyed'));
 
+  // Merge primary readPreference
+  finalOptions.readPreference = ReadPreference.PRIMARY
+
   // Check if the index allready exists
   self.indexInformation(name, finalOptions, function(err, indexInformation) {
     if(err != null && err.code != 26) return handleCallback(callback, err, null);
@@ -1645,7 +1649,6 @@ var indexInformation = function(self, name, options, callback) {
 
   // Did the user destroy the topology
   if(self.serverConfig && self.serverConfig.isDestroyed()) return callback(new MongoError('topology was destroyed'));
-
   // Process all the results from the index command and collection
   var processResults = function(indexes) {
     // Contains all the information
@@ -1664,7 +1667,7 @@ var indexInformation = function(self, name, options, callback) {
   }
 
   // Get the list of indexes of the specified collection
-  self.collection(name).listIndexes().toArray(function(err, indexes) {
+  self.collection(name).listIndexes(options).toArray(function(err, indexes) {
     if(err) return callback(toError(err));
     if(!Array.isArray(indexes)) return handleCallback(callback, null, []);
     if(full) return handleCallback(callback, null, indexes);

package/lib/mongo_client.js

@@ -26,6 +26,38 @@ var parse = require('./url_parser')
  *   db.close();
  * });
  */
+var validOptionNames = ['poolSize', 'ssl', 'sslValidate', 'sslCA', 'sslCert',
+  'sslKey', 'sslPass', 'autoReconnect', 'noDelay', 'keepAlive', 'connectTimeoutMS',
+  'socketTimeoutMS', 'reconnectTries', 'reconnectInterval', 'ha', 'haInterval',
+  'replicaSet', 'secondaryAcceptableLatencyMS', 'acceptableLatencyMS',
+  'connectWithNoPrimary', 'authSource', 'w', 'wtimeout', 'j', 'forceServerObjectId',
+  'serializeFunctions', 'ignoreUndefined', 'raw', 'promoteLongs', 'bufferMaxEntries',
+  'readPreference', 'pkFactory', 'promiseLibrary', 'readConcern', 'maxStalenessSeconds',
+  'loggerLevel', 'logger', 'promoteValues', 'promoteBuffers', 'promoteLongs',
+  'domainsEnabled', 'keepAliveInitialDelay', 'checkServerIdentity', 'validateOptions'];
+var ignoreOptionNames = ['native_parser'];
+var legacyOptionNames = ['server', 'replset', 'replSet', 'mongos', 'db'];
+
+function validOptions(options) {
+  var _validOptions = validOptionNames.concat(legacyOptionNames);
+
+  for(var name in options) {
+    if(ignoreOptionNames.indexOf(name) != -1) {
+      continue;
+    }
+
+    if(_validOptions.indexOf(name) == -1 && options.validateOptions) {
+      return new MongoError(f('option %s is not supported', name));
+    } else if(_validOptions.indexOf(name) == -1) {
+      console.warn(f('the options [%s] is not supported', name));
+    }
+
+    if(legacyOptionNames.indexOf(name) != -1) {
+      console.warn(f('the server/replset/mongos options are deprecated, '
+      + 'all their options are supported at the top level of the options object [%s]', validOptionNames));
+    }
+  }
+}
 
 /**
  * Creates a new MongoClient instance
@@ -49,13 +81,49 @@ function MongoClient() {
    *
    * @method
    * @param {string} url The connection URI string
-   * @param {object} [options=null] Optional settings.
-   * @param {boolean} [options.uri_decode_auth=false] Uri decode the user name and password for authentication
-   * @param {object} [options.db=null] A hash of options to set on the db object, see **Db constructor**
-   * @param {object} [options.server=null] A hash of options to set on the server objects, see **Server** constructor**
-   * @param {object} [options.replSet=null] A hash of options to set on the replSet object, see **ReplSet** constructor**
-   * @param {object} [options.mongos=null] A hash of options to set on the mongos object, see **Mongos** constructor**
+   * @param {object} [options] Optional settings.
+   * @param {number} [options.poolSize=5] poolSize The maximum size of the individual server pool.
+   * @param {boolean} [options.ssl=false] Enable SSL connection.
+   * @param {Buffer} [options.sslCA=undefined] SSL Certificate store binary buffer
+   * @param {Buffer} [options.sslCert=undefined] SSL Certificate binary buffer
+   * @param {Buffer} [options.sslKey=undefined] SSL Key file binary buffer
+   * @param {string} [options.sslPass=undefined] SSL Certificate pass phrase
+   * @param {boolean|function} [options.checkServerIdentity=true] Ensure we check server identify during SSL, set to false to disable checking. Only works for Node 0.12.x or higher. You can pass in a boolean or your own checkServerIdentity override function.
+   * @param {boolean} [options.autoReconnect=true] Enable autoReconnect for single server instances
+   * @param {boolean} [options.noDelay=true] TCP Connection no delay
+   * @param {boolean} [options.keepAlive=0] The number of milliseconds to wait before initiating keepAlive on the TCP socket.
+   * @param {number} [options.connectTimeoutMS=30000] TCP Connection timeout setting
+   * @param {number} [options.socketTimeoutMS=30000] TCP Socket timeout setting
+   * @param {number} [options.reconnectTries=30] Server attempt to reconnect #times
+   * @param {number} [options.reconnectInterval=1000] Server will wait # milliseconds between retries
+   * @param {boolean} [options.ha=true] Control if high availability monitoring runs for Replicaset or Mongos proxies.
+   * @param {number} [options.haInterval=10000] The High availability period for replicaset inquiry
+   * @param {string} [options.replicaSet=undefined] The Replicaset set name
+   * @param {number} [options.secondaryAcceptableLatencyMS=15] Cutoff latency point in MS for Replicaset member selection
+   * @param {number} [options.acceptableLatencyMS=15] Cutoff latency point in MS for Mongos proxies selection.
+   * @param {boolean} [options.connectWithNoPrimary=false] Sets if the driver should connect even if no primary is available
+   * @param {string} [options.authSource=undefined] Define the database to authenticate against
+   * @param {(number|string)} [options.w=null] The write concern.
+   * @param {number} [options.wtimeout=null] The write concern timeout.
+   * @param {boolean} [options.j=false] Specify a journal write concern.
+   * @param {boolean} [options.forceServerObjectId=false] Force server to assign _id values instead of driver.
+   * @param {boolean} [options.serializeFunctions=false] Serialize functions on any object.
+   * @param {Boolean} [options.ignoreUndefined=false] Specify if the BSON serializer should ignore undefined fields.
+   * @param {boolean} [options.raw=false] Return document results as raw BSON buffers.
+   * @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 {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=null] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
+   * @param {boolean} [options.domainsEnabled=false] Enable the wrapping of the callback in the current domain, disabled by default to avoid perf hit.
+   * @param {object} [options.pkFactory=null] A primary key factory object for generation of custom _id keys.
    * @param {object} [options.promiseLibrary=null] A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible
+   * @param {object} [options.readConcern=null] Specify a read concern for the collection. (only MongoDB 3.2 or higher supported)
+   * @param {object} [options.readConcern.level='local'] Specify a read concern level for the collection operations, one of [local|majority]. (only MongoDB 3.2 or higher supported)
+   * @param {number} [options.maxStalenessSeconds=undefined] The max staleness to secondary reads (values under 10 seconds cannot be guaranteed);
+   * @param {string} [options.loggerLevel=undefined] The logging level (error/warn/info/debug)
+   * @param {object} [options.logger=undefined] Custom logger object
+   * @param {object} [options.validateOptions=false] Validate MongoClient passed in options for correctness.
    * @param {MongoClient~connectCallback} [callback] The command result callback
    * @return {Promise} returns Promise if no callback passed
    */
@@ -74,13 +142,49 @@ var define = MongoClient.define = new Define('MongoClient', MongoClient, false);
  * @method
  * @static
  * @param {string} url The connection URI string
- * @param {object} [options=null] Optional settings.
- * @param {boolean} [options.uri_decode_auth=false] Uri decode the user name and password for authentication
- * @param {object} [options.db=null] A hash of options to set on the db object, see **Db constructor**
- * @param {object} [options.server=null] A hash of options to set on the server objects, see **Server** constructor**
- * @param {object} [options.replSet=null] A hash of options to set on the replSet object, see **ReplSet** constructor**
- * @param {object} [options.mongos=null] A hash of options to set on the mongos object, see **Mongos** constructor**
+ * @param {object} [options] Optional settings.
+ * @param {number} [options.poolSize=5] poolSize The maximum size of the individual server pool.
+ * @param {boolean} [options.ssl=false] Enable SSL connection.
+ * @param {Buffer} [options.sslCA=undefined] SSL Certificate store binary buffer
+ * @param {Buffer} [options.sslCert=undefined] SSL Certificate binary buffer
+ * @param {Buffer} [options.sslKey=undefined] SSL Key file binary buffer
+ * @param {string} [options.sslPass=undefined] SSL Certificate pass phrase
+ * @param {boolean|function} [options.checkServerIdentity=true] Ensure we check server identify during SSL, set to false to disable checking. Only works for Node 0.12.x or higher. You can pass in a boolean or your own checkServerIdentity override function.
+ * @param {boolean} [options.autoReconnect=true] Enable autoReconnect for single server instances
+ * @param {boolean} [options.noDelay=true] TCP Connection no delay
+ * @param {boolean} [options.keepAlive=0] The number of milliseconds to wait before initiating keepAlive on the TCP socket.
+ * @param {number} [options.connectTimeoutMS=30000] TCP Connection timeout setting
+ * @param {number} [options.socketTimeoutMS=30000] TCP Socket timeout setting
+ * @param {number} [options.reconnectTries=30] Server attempt to reconnect #times
+ * @param {number} [options.reconnectInterval=1000] Server will wait # milliseconds between retries
+ * @param {boolean} [options.ha=true] Control if high availability monitoring runs for Replicaset or Mongos proxies.
+ * @param {number} [options.haInterval=10000] The High availability period for replicaset inquiry
+ * @param {string} [options.replicaSet=undefined] The Replicaset set name
+ * @param {number} [options.secondaryAcceptableLatencyMS=15] Cutoff latency point in MS for Replicaset member selection
+ * @param {number} [options.acceptableLatencyMS=15] Cutoff latency point in MS for Mongos proxies selection.
+ * @param {boolean} [options.connectWithNoPrimary=false] Sets if the driver should connect even if no primary is available
+ * @param {string} [options.authSource=undefined] Define the database to authenticate against
+ * @param {(number|string)} [options.w=null] The write concern.
+ * @param {number} [options.wtimeout=null] The write concern timeout.
+ * @param {boolean} [options.j=false] Specify a journal write concern.
+ * @param {boolean} [options.forceServerObjectId=false] Force server to assign _id values instead of driver.
+ * @param {boolean} [options.serializeFunctions=false] Serialize functions on any object.
+ * @param {Boolean} [options.ignoreUndefined=false] Specify if the BSON serializer should ignore undefined fields.
+ * @param {boolean} [options.raw=false] Return document results as raw BSON buffers.
+ * @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 {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=null] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
+ * @param {boolean} [options.domainsEnabled=false] Enable the wrapping of the callback in the current domain, disabled by default to avoid perf hit.
+ * @param {object} [options.pkFactory=null] A primary key factory object for generation of custom _id keys.
  * @param {object} [options.promiseLibrary=null] A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible
+ * @param {object} [options.readConcern=null] Specify a read concern for the collection. (only MongoDB 3.2 or higher supported)
+ * @param {object} [options.readConcern.level='local'] Specify a read concern level for the collection operations, one of [local|majority]. (only MongoDB 3.2 or higher supported)
+ * @param {number} [options.maxStalenessSeconds=undefined] The max staleness to secondary reads (values under 10 seconds cannot be guaranteed);
+ * @param {string} [options.loggerLevel=undefined] The logging level (error/warn/info/debug)
+ * @param {object} [options.logger=undefined] Custom logger object
+ * @param {object} [options.validateOptions=false] Validate MongoClient passed in options for correctness.
  * @param {MongoClient~connectCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
@@ -90,6 +194,9 @@ MongoClient.connect = function(url, options, callback) {
   options = args.length ? args.shift() : null;
   options = options || {};
 
+  // Validate options object
+  var err = validOptions(options);
+
   // Get the promiseLibrary
   var promiseLibrary = options.promiseLibrary;
 
@@ -102,6 +209,9 @@ MongoClient.connect = function(url, options, callback) {
   // Return a promise
   if(typeof callback != 'function') {
     return new promiseLibrary(function(resolve, reject) {
+      // Did we have a validation error
+      if(err) return reject(err);
+      // Attempt to connect
       connect(url, options, function(err, db) {
         if(err) return reject(err);
         resolve(db);
@@ -109,6 +219,8 @@ MongoClient.connect = function(url, options, callback) {
     });
   }
 
+  // Did we have a validation error
+  if(err) return callback(err);
   // Fallback to callback based connect
   connect(url, options, callback);
 }

package/lib/mongos.js

@@ -397,8 +397,18 @@ Mongos.prototype.lastIsMaster = function() {
   return this.s.mongos.lastIsMaster();
 }
 
+/**
+ * Unref all sockets
+ * @method
+ */
+Mongos.prototype.unref = function () {
+  return this.s.mongos.unref();
+}
+
 Mongos.prototype.close = function(forceClosed) {
-  this.s.mongos.destroy();
+  this.s.mongos.destroy({
+    force: typeof forceClosed == 'boolean' ? forceClosed : false,
+  });
   // We need to wash out all stored processes
   if(forceClosed == true) {
     this.s.storeOptions.force = forceClosed;

package/lib/replset.js

@@ -45,7 +45,7 @@ var legalOptionNames = ['ha', 'haInterval', 'replicaSet', 'rs_name', 'secondaryA
   , 'store', 'auto_reconnect', 'autoReconnect', 'emitError'
   , 'keepAlive', 'noDelay', 'connectTimeoutMS', 'socketTimeoutMS', 'strategy', 'debug'
   , 'loggerLevel', 'logger', 'reconnectTries', 'appname', 'domainsEnabled'
-  , 'servername', 'promoteLongs', 'promoteValues', 'promoteBuffers'];
+  , 'servername', 'promoteLongs', 'promoteValues', 'promoteBuffers', 'maxStalenessSeconds'];
 
 // Get package.json variable
 var driverVersion = require(__dirname + '/../package.json').version;
@@ -81,6 +81,7 @@ var release = os.release();
  * @param {number} [options.socketOptions.connectTimeoutMS=10000] TCP Connection timeout setting
  * @param {number} [options.socketOptions.socketTimeoutMS=0] TCP Socket timeout setting
  * @param {boolean} [options.domainsEnabled=false] Enable the wrapping of the callback in the current domain, disabled by default to avoid perf hit.
+ * @param {number} [options.maxStalenessSeconds=undefined] The max staleness to secondary reads (values under 10 seconds cannot be guaranteed);
  * @fires ReplSet#connect
  * @fires ReplSet#ha
  * @fires ReplSet#joined
@@ -445,9 +446,20 @@ ReplSet.prototype.lastIsMaster = function() {
   return this.s.replset.lastIsMaster();
 }
 
+/**
+ * Unref all sockets
+ * @method
+ */
+ReplSet.prototype.unref = function() {
+  return this.s.replset.unref();
+}
+
 ReplSet.prototype.close = function(forceClosed) {
   var self = this;
-  this.s.replset.destroy();
+  // Call destroy on the topology
+  this.s.replset.destroy({
+    force: typeof forceClosed == 'boolean' ? forceClosed : false,
+  });
   // We need to wash out all stored processes
   if(forceClosed == true) {
     this.s.storeOptions.force = forceClosed;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb",
-  "version": "2.2.20",
+  "version": "2.2.24",
   "description": "The official MongoDB driver for Node.js",
   "main": "index.js",
   "repository": {
@@ -14,14 +14,14 @@
   ],
   "dependencies": {
     "es6-promise": "3.2.1",
-    "mongodb-core": "2.1.5",
+    "mongodb-core": "2.1.8",
     "readable-stream": "2.1.5"
   },
   "devDependencies": {
     "JSONStream": "^1.0.7",
     "betterbenchmarks": "^0.1.0",
     "bluebird": "3.4.6",
-    "bson": "1.0.0",
+    "bson": "latest",
     "cli-table": "^0.3.1",
     "co": "4.6.0",
     "colors": "^1.1.2",