mongodb 3.3.5 → 3.4.0

package/lib/mongo_client.js

@@ -55,26 +55,12 @@ const CloseOperation = require('./operations/close');
  */
 
 /**
- * Configuration options for a automatic client encryption.
- *
- * **NOTE**: Support for client side encryption is in beta. Backwards-breaking changes may be made before the final release.
+ * Configuration options for drivers wrapping the node driver.
  *
- * @typedef {Object} AutoEncryptionOptions
- * @property {MongoClient} [keyVaultClient] A `MongoClient` used to fetch keys from a key vault
- * @property {string} [keyVaultNamespace] The namespace where keys are stored in the key vault
- * @property {object} [kmsProviders] Provider details for the desired Key Management Service to use for encryption
- * @property {object} [kmsProviders.aws] Optional settings for the AWS KMS provider
- * @property {string} [kmsProviders.aws.accessKeyId] The access key used for the AWS KMS provider
- * @property {string} [kmsProviders.aws.secretAccessKey] The secret access key used for the AWS KMS provider
- * @property {object} [kmsProviders.local] Optional settings for the local KMS provider
- * @property {string} [kmsProviders.local.key] The master key used to encrypt/decrypt data keys
- * @property {object} [schemaMap] A map of namespaces to a local JSON schema for encryption
- * @property {boolean} [bypassAutoEncryption] Allows the user to bypass auto encryption, maintaining implicit decryption
- * @property {object} [extraOptions] Extra options related to the mongocryptd process
- * @property {string} [extraOptions.mongocryptURI] A local process the driver communicates with to determine how to encrypt values in a command. Defaults to "mongodb://%2Fvar%2Fmongocryptd.sock" if domain sockets are available or "mongodb://localhost:27020" otherwise
- * @property {boolean} [extraOptions.mongocryptdBypassSpawn=false] If true, autoEncryption will not attempt to spawn a mongocryptd before connecting
- * @property {string} [extraOptions.mongocryptdSpawnPath] The path to the mongocryptd executable on the system
- * @property {string[]} [extraOptions.mongocryptdSpawnArgs] Command line arguments to use when auto-spawning a mongocryptd
+ * @typedef {Object} DriverInfoOptions
+ * @property {string} [name] The name of the driver
+ * @property {string} [version] The version of the driver
+ * @property {string} [platform] Optional platform information
  */
 
 /**
@@ -92,13 +78,21 @@ const CloseOperation = require('./operations/close');
  * @param {string} url The connection URI string
  * @param {object} [options] Optional settings
  * @param {number} [options.poolSize=5] The maximum size of the individual server pool
- * @param {boolean} [options.ssl=false] Enable SSL connection.
+ * @param {boolean} [options.ssl=false] Enable SSL connection. *deprecated* use `tls` variants
  * @param {boolean} [options.sslValidate=false] Validate mongod server certificate against Certificate Authority
- * @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 {buffer} [options.sslCRL=undefined] SSL Certificate revocation list binary buffer
+ * @param {buffer} [options.sslCA=undefined] SSL Certificate store binary buffer *deprecated* use `tls` variants
+ * @param {buffer} [options.sslCert=undefined] SSL Certificate binary buffer *deprecated* use `tls` variants
+ * @param {buffer} [options.sslKey=undefined] SSL Key file binary buffer *deprecated* use `tls` variants
+ * @param {string} [options.sslPass=undefined] SSL Certificate pass phrase *deprecated* use `tls` variants
+ * @param {buffer} [options.sslCRL=undefined] SSL Certificate revocation list binary buffer *deprecated* use `tls` variants
+ * @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. *deprecated* use `tls` variants
+ * @param {boolean} [options.tls=false] Enable TLS connections
+ * @param {boolean} [options.tlsinsecure=false] Relax TLS constraints, disabling validation
+ * @param {string} [options.tlsCAFile] A path to file with either a single or bundle of certificate authorities to be considered trusted when making a TLS connection
+ * @param {string} [options.tlsCertificateKeyFile] A path to the client certificate file or the client private key file; in the case that they both are needed, the files should be concatenated
+ * @param {string} [options.tlsCertificateKeyFilePassword] The password to decrypt the client private key to be used for TLS connections
+ * @param {boolean} [options.tlsAllowInvalidCertificates] Specifies whether or not the driver should error when the server’s TLS certificate is invalid
+ * @param {boolean} [options.tlsAllowInvalidHostnames] Specifies whether or not the driver should error when there is a mismatch between the server’s hostname and the hostname specified by the TLS certificate
  * @param {boolean} [options.autoReconnect=true] Enable autoReconnect for single server instances
  * @param {boolean} [options.noDelay=true] TCP Connection no delay
  * @param {boolean} [options.keepAlive=true] TCP Connection keep alive enabled
@@ -136,7 +130,6 @@ const CloseOperation = require('./operations/close');
  * @param {boolean} [options.promoteBuffers=false] Promotes Binary BSON values to native Node Buffers
  * @param {boolean} [options.promoteLongs=true] Promotes long values to number if they fit inside the 53 bits resolution
  * @param {boolean} [options.domainsEnabled=false] Enable the wrapping of the callback in the current domain, disabled by default to avoid perf hit
- * @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 {object} [options.validateOptions=false] Validate MongoClient passed in options for correctness
  * @param {string} [options.appname=undefined] The name of the application that created this MongoClient instance. MongoDB 3.4 and newer will print this value in the server log upon establishing each connection. It is also recorded in the slow query log and profile collections
  * @param {string} [options.auth.user=undefined] The username for auth
@@ -151,7 +144,7 @@ const CloseOperation = require('./operations/close');
  * @param {number} [options.minSize] If present, the connection pool will be initialized with minSize connections, and will never dip below minSize connections
  * @param {boolean} [options.useNewUrlParser=true] Determines whether or not to use the new url parser. Enables the new, spec-compliant, url parser shipped in the core driver. This url parser fixes a number of problems with the original parser, and aims to outright replace that parser in the near future. Defaults to true, and must be explicitly set to false to use the legacy url parser.
  * @param {boolean} [options.useUnifiedTopology] Enables the new unified topology layer
- * @param {AutoEncryptionOptions} [options.autoEncryption] Optionally enable client side auto encryption
+ * @param {AutoEncrypter~AutoEncryptionOptions} [options.autoEncryption] Optionally enable client side auto encryption
  * @param {DriverInfoOptions} [options.driverInfo] Allows a wrapping driver to amend the client metadata generated by the driver to include information about the wrapping driver
  * @param {MongoClient~connectCallback} [callback] The command result callback
  * @return {MongoClient} a MongoClient instance
@@ -318,13 +311,21 @@ MongoClient.prototype.isConnected = function(options) {
  * @param {string} url The connection URI string
  * @param {object} [options] Optional settings
  * @param {number} [options.poolSize=5] The maximum size of the individual server pool
- * @param {boolean} [options.ssl=false] Enable SSL connection.
- * @param {boolean} [options.sslValidate=false] Validate mongod server certificate against Certificate Authority
- * @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 {buffer} [options.sslCRL=undefined] SSL Certificate revocation list binary buffer
+ * @param {boolean} [options.ssl=false] Enable SSL connection. *deprecated* use `tls` variants
+ * @param {boolean} [options.sslValidate=false] Validate mongod server certificate against Certificate Authority *deprecated* use `tls` variants
+ * @param {buffer} [options.sslCA=undefined] SSL Certificate store binary buffer *deprecated* use `tls` variants
+ * @param {buffer} [options.sslCert=undefined] SSL Certificate binary buffer *deprecated* use `tls` variants
+ * @param {buffer} [options.sslKey=undefined] SSL Key file binary buffer *deprecated* use `tls` variants
+ * @param {string} [options.sslPass=undefined] SSL Certificate pass phrase *deprecated* use `tls` variants
+ * @param {buffer} [options.sslCRL=undefined] SSL Certificate revocation list binary buffer *deprecated* use `tls` variants
+ * @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. *deprecated* use `tls` variants
+ * @param {boolean} [options.tls=false] Enable TLS connections
+ * @param {boolean} [options.tlsinsecure=false] Relax TLS constraints, disabling validation
+ * @param {string} [options.tlsCAFile] A path to file with either a single or bundle of certificate authorities to be considered trusted when making a TLS connection
+ * @param {string} [options.tlsCertificateKeyFile] A path to the client certificate file or the client private key file; in the case that they both are needed, the files should be concatenated
+ * @param {string} [options.tlsCertificateKeyFilePassword] The password to decrypt the client private key to be used for TLS connections
+ * @param {boolean} [options.tlsAllowInvalidCertificates] Specifies whether or not the driver should error when the server’s TLS certificate is invalid
+ * @param {boolean} [options.tlsAllowInvalidHostnames] Specifies whether or not the driver should error when there is a mismatch between the server’s hostname and the hostname specified by the TLS certificate
  * @param {boolean} [options.autoReconnect=true] Enable autoReconnect for single server instances
  * @param {boolean} [options.noDelay=true] TCP Connection no delay
  * @param {boolean} [options.keepAlive=true] TCP Connection keep alive enabled
@@ -362,7 +363,6 @@ MongoClient.prototype.isConnected = function(options) {
  * @param {boolean} [options.promoteBuffers=false] Promotes Binary BSON values to native Node Buffers
  * @param {boolean} [options.promoteLongs=true] Promotes long values to number if they fit inside the 53 bits resolution
  * @param {boolean} [options.domainsEnabled=false] Enable the wrapping of the callback in the current domain, disabled by default to avoid perf hit
- * @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 {object} [options.validateOptions=false] Validate MongoClient passed in options for correctness
  * @param {string} [options.appname=undefined] The name of the application that created this MongoClient instance. MongoDB 3.4 and newer will print this value in the server log upon establishing each connection. It is also recorded in the slow query log and profile collections
  * @param {string} [options.auth.user=undefined] The username for auth

package/lib/operations/command_v2.js

@@ -52,9 +52,7 @@ class CommandOperationV2 extends OperationBase {
     if (options.collation && serverWireVersion < SUPPORTS_WRITE_CONCERN_AND_COLLATION) {
       callback(
         new MongoError(
-          `Server ${
-            server.name
-          }, which reports wire version ${serverWireVersion}, does not support collation`
+          `Server ${server.name}, which reports wire version ${serverWireVersion}, does not support collation`
         )
       );
       return;

package/lib/operations/common_functions.js

@@ -183,8 +183,7 @@ function indexInformation(db, name, options, callback) {
   }
 
   // Get the list of indexes of the specified collection
-  db
-    .collection(name)
+  db.collection(name)
     .listIndexes(options)
     .toArray((err, indexes) => {
       if (err) return callback(toError(err));

package/lib/operations/connect.js

@@ -16,6 +16,7 @@ const ReplSet = require('../topologies/replset');
 const Server = require('../topologies/server');
 const ServerSessionPool = require('../core').Sessions.ServerSessionPool;
 const emitDeprecationWarning = require('../utils').emitDeprecationWarning;
+const fs = require('fs');
 
 let client;
 function loadClient() {
@@ -139,7 +140,15 @@ const validOptionNames = [
   'serverSelectionTimeoutMS',
   'useRecoveryToken',
   'autoEncryption',
-  'driverInfo'
+  'driverInfo',
+  'tls',
+  'tlsinsecure',
+  'tlsAllowInvalidCertificates',
+  'tlsAllowInvalidHostnames',
+  'tlsCAFile',
+  'tlsCertificateFile',
+  'tlsCertificateKeyFile',
+  'tlsCertificateKeyFilePassword'
 ];
 
 const ignoreOptionNames = ['native_parser'];
@@ -243,6 +252,18 @@ function collectEvents(mongoClient, topology) {
   return collectedEvents;
 }
 
+function resolveTLSOptions(options) {
+  if (options.tls == null) {
+    return;
+  }
+
+  ['sslCA', 'sslKey', 'sslCert'].forEach(optionName => {
+    if (options[optionName]) {
+      options[optionName] = fs.readFileSync(options[optionName]);
+    }
+  });
+}
+
 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.');
 
@@ -288,6 +309,9 @@ function connect(mongoClient, url, options, callback) {
       delete _finalOptions.db_options.auth;
     }
 
+    // resolve tls options if needed
+    resolveTLSOptions(_finalOptions);
+
     // Store the merged options object
     mongoClient.s.options = _finalOptions;
 
@@ -504,7 +528,13 @@ function createTopology(mongoClient, topologyType, options, callback) {
       return;
     }
     try {
-      AutoEncrypter = require('mongodb-client-encryption')(require('../../index')).AutoEncrypter;
+      let mongodbClientEncryption = require('mongodb-client-encryption');
+      if (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`'
+        );
+      }
+      AutoEncrypter = mongodbClientEncryption.extension(require('../../index')).AutoEncrypter;
     } catch (err) {
       callback(err);
       return;
@@ -530,7 +560,7 @@ function createUnifiedOptions(finalOptions, options) {
     'rs_options',
     'mongos_options'
   ];
-  const noMerge = ['readconcern', 'compression'];
+  const noMerge = ['readconcern', 'compression', 'autoencryption'];
 
   for (const name in options) {
     if (noMerge.indexOf(name.toLowerCase()) !== -1) {

package/lib/operations/create_collection.js

@@ -69,8 +69,7 @@ class CreateCollectionOperation extends CommandOperation {
     listCollectionOptions = applyWriteConcern(listCollectionOptions, { db }, listCollectionOptions);
 
     // Check if we have the name
-    db
-      .listCollections({ name }, listCollectionOptions)
+    db.listCollections({ name }, listCollectionOptions)
       .setReadPreference(ReadPreference.PRIMARY)
       .toArray((err, collections) => {
         if (err != null) return handleCallback(callback, err, null);

package/lib/operations/db_ops.js

@@ -474,8 +474,7 @@ function indexInformation(db, name, options, callback) {
   }
 
   // Get the list of indexes of the specified collection
-  db
-    .collection(name)
+  db.collection(name)
     .listIndexes(options)
     .toArray((err, indexes) => {
       if (err) return callback(toError(err));
@@ -496,8 +495,7 @@ function indexInformation(db, name, options, callback) {
  */
 function profilingInfo(db, options, callback) {
   try {
-    db
-      .collection('system.profile')
+    db.collection('system.profile')
       .find({}, options)
       .toArray(callback);
   } catch (err) {

package/lib/operations/execute_operation.js

@@ -155,7 +155,8 @@ function executeWithServerSelection(topology, operation, callback) {
 
     const shouldRetryReads =
       topology.s.options.retryReads !== false &&
-      (operation.session && !inTransaction) &&
+      operation.session &&
+      !inTransaction &&
       supportsRetryableReads(server) &&
       operation.canRetryRead;
 

package/lib/operations/map_reduce.js

@@ -87,7 +87,8 @@ class MapReduceOperation extends OperationBase {
       options.readPreference !== false &&
       options.readPreference !== 'primary' &&
       options['out'] &&
-      (options['out'].inline !== 1 && options['out'] !== 'inline')
+      options['out'].inline !== 1 &&
+      options['out'] !== 'inline'
     ) {
       // Force readPreference to primary
       options.readPreference = 'primary';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb",
-  "version": "3.3.5",
+  "version": "3.4.0",
   "description": "The official MongoDB driver for Node.js",
   "main": "index.js",
   "files": [
@@ -30,6 +30,7 @@
   },
   "devDependencies": {
     "bluebird": "3.5.0",
+    "bl": "^2.2.0",
     "chai": "^4.1.1",
     "chai-subset": "^1.6.0",
     "chalk": "^2.4.2",
@@ -44,15 +45,15 @@
     "mocha-sinon": "^2.1.0",
     "mongodb-extjson": "^2.1.1",
     "mongodb-mock-server": "^1.0.1",
-    "prettier": "~1.12.0",
+    "prettier": "^1.19.1",
     "semver": "^5.5.0",
     "sinon": "^4.3.0",
     "sinon-chai": "^3.2.0",
     "snappy": "^6.1.2",
     "standard-version": "^4.4.0",
-    "yargs": "^14.2.0",
     "worker-farm": "^1.5.0",
-    "wtfnode": "^0.8.0"
+    "wtfnode": "^0.8.0",
+    "yargs": "^14.2.0"
   },
   "license": "Apache-2.0",
   "engines": {
@@ -62,13 +63,13 @@
     "url": "https://github.com/mongodb/node-mongodb-native/issues"
   },
   "scripts": {
-    "atlas": "node ./test/atlas_connectivity_tests.js",
+    "atlas": "node ./test/tools/atlas_connectivity_tests.js",
     "test": "npm run lint && mocha --recursive test/functional test/unit test/core",
     "test-nolint": "mocha --recursive test/functional test/unit test/core",
     "coverage": "istanbul cover mongodb-test-runner -- -t 60000 test/core test/unit test/functional",
     "lint": "eslint lib test",
     "format": "prettier --print-width 100 --tab-width 2 --single-quote --write 'test/**/*.js' 'lib/**/*.js'",
-    "bench": "node test/driverBench/",
+    "bench": "node test/benchmarks/driverBench/",
     "generate-evergreen": "node .evergreen/generate_evergreen_tasks.js",
     "release": "standard-version -i HISTORY.md"
   },