NODE-935, NODE-931 Introduce validateOptions option to MongoClient.co…

lib/mongo_client.js

@@ -34,7 +34,7 @@ var validOptionNames = ['poolSize', 'ssl', 'sslValidate', 'sslCA', 'sslCert',
   'serializeFunctions', 'ignoreUndefined', 'raw', 'promoteLongs', 'bufferMaxEntries',
   'readPreference', 'pkFactory', 'promiseLibrary', 'readConcern', 'maxStalenessSeconds',
   'loggerLevel', 'logger', 'promoteValues', 'promoteBuffers', 'promoteLongs',
-  'domainsEnabled', 'keepAliveInitialDelay', 'checkServerIdentity'];
+  'domainsEnabled', 'keepAliveInitialDelay', 'checkServerIdentity', 'validateOptions'];
 var ignoreOptionNames = ['native_parser'];
 var legacyOptionNames = ['server', 'replset', 'replSet', 'mongos', 'db'];
 
@@ -46,11 +46,13 @@ function validOptions(options) {
       continue;
     }
 
-    if(_validOptions.indexOf(name) == -1) {
+    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) {
+    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));
     }
@@ -121,6 +123,7 @@ function MongoClient() {
    * @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
    */
@@ -181,6 +184,7 @@ var define = MongoClient.define = new Define('MongoClient', MongoClient, false);
  * @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
  */

test/functional/mongo_client_options_tests.js

@@ -53,7 +53,7 @@ exports['should error on unexpected options'] = {
     var connect = configuration.require;
 
     connect(configuration.url(), {
-      autoReconnect: true, poolSize: 4, notlegal: {}
+      autoReconnect: true, poolSize: 4, notlegal: {}, validateOptions:true
     }, function(err, db) {
       test.ok(err.message.indexOf('option notlegal is not supported') != -1);
       test.done();