mongodb 3.6.4 → 3.6.8

package/HISTORY.md

@@ -2,6 +2,49 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [3.6.8](https://github.com/mongodb/node-mongodb-native/compare/v3.6.7...v3.6.8) (2021-05-21)
+
+
+### Bug Fixes
+
+* **cmap:** undo flipping of `beforeHandshake` flag for timeout errors ([#2813](https://github.com/mongodb/node-mongodb-native/issues/2813)) ([6e3bab3](https://github.com/mongodb/node-mongodb-native/commit/6e3bab32204ea905ab9b949edccb68556b50d382))
+
+### [3.6.7](https://github.com/mongodb/node-mongodb-native/compare/v3.6.6...v3.6.7) (2021-05-18)
+
+
+### Bug Fixes
+
+* **docs:** removing incorrect apm docs ([#2793](https://github.com/mongodb/node-mongodb-native/issues/2793)) ([971259a](https://github.com/mongodb/node-mongodb-native/commit/971259a868a8018e90ebc2f28d151eb7af3dd50a))
+* **NODE-3173:** Preserve sort key order for numeric string keys ([#2790](https://github.com/mongodb/node-mongodb-native/issues/2790)) ([730f43a](https://github.com/mongodb/node-mongodb-native/commit/730f43af6d9e53603af998353b720d8161426d8c))
+* **NODE-3176:** handle errors from MessageStream ([#2774](https://github.com/mongodb/node-mongodb-native/issues/2774)) ([f1afcc4](https://github.com/mongodb/node-mongodb-native/commit/f1afcc4efbc41ce436812a6bfa22843e939ab5cf))
+* **NODE-3192:** check clusterTime is defined before access ([#2806](https://github.com/mongodb/node-mongodb-native/issues/2806)) ([6ceace6](https://github.com/mongodb/node-mongodb-native/commit/6ceace6b245c42b8498fb1b13e7c37a97a46946d))
+* **NODE-3252:** state transistion from DISCONNECTED ([#2807](https://github.com/mongodb/node-mongodb-native/issues/2807)) ([5d8f649](https://github.com/mongodb/node-mongodb-native/commit/5d8f6493a0ba4b525434c0868e2ae12315b4c249))
+* **sdam:** topology no longer causes close event ([#2791](https://github.com/mongodb/node-mongodb-native/issues/2791)) ([16e7064](https://github.com/mongodb/node-mongodb-native/commit/16e70642f25954a03b91a2c2991cea96b8356de7))
+* invalid case on writeconcern makes skip check fail ([#2773](https://github.com/mongodb/node-mongodb-native/issues/2773)) ([b1363c2](https://github.com/mongodb/node-mongodb-native/commit/b1363c26db5da5003f9db43be7e8d6e9007d45bd))
+
+### [3.6.6](https://github.com/mongodb/node-mongodb-native/compare/v3.6.5...v3.6.6) (2021-04-06)
+
+
+### Bug Fixes
+
+* always close gridfs upload stream on finish ([#2758](https://github.com/mongodb/node-mongodb-native/issues/2758)) ([c976a01](https://github.com/mongodb/node-mongodb-native/commit/c976a01bf385941bee07fa7f021adf1d425109a8))
+* **csfle:** ensure that monitoring connections are not encrypted ([#2749](https://github.com/mongodb/node-mongodb-native/issues/2749)) ([86bddf1](https://github.com/mongodb/node-mongodb-native/commit/86bddf1ef516d6b8c752082e33c15624753579ab))
+* ensure cursor readPreference is applied to find operations ([#2751](https://github.com/mongodb/node-mongodb-native/issues/2751)) ([91ba19e](https://github.com/mongodb/node-mongodb-native/commit/91ba19efdc4713903584c6161cfdd7b91b0e61f9))
+* ensure monitor has rtt pinger in when calculating rtt ([#2757](https://github.com/mongodb/node-mongodb-native/issues/2757)) ([b94519b](https://github.com/mongodb/node-mongodb-native/commit/b94519ba894b4442d3dabbac59bd12784d8b7178))
+* no infinite loop on windows requiring optional deps ([f2a4ff8](https://github.com/mongodb/node-mongodb-native/commit/f2a4ff870178fbbe8de616c45891368665f29f4b))
+* **NODE-2995:** Add shared metadata MongoClient ([#2760](https://github.com/mongodb/node-mongodb-native/issues/2760)) ([9256242](https://github.com/mongodb/node-mongodb-native/commit/9256242d51c037059c0af5ada9639fc0a74ad033))
+* **NODE-3109:** prevent servername from being IP ([#2763](https://github.com/mongodb/node-mongodb-native/issues/2763)) ([312ffef](https://github.com/mongodb/node-mongodb-native/commit/312ffef18c66a0020f19bdc1d654987d9148d709))
+
+### [3.6.5](https://github.com/mongodb/node-mongodb-native/compare/v3.6.4...v3.6.5) (2021-03-16)
+
+
+### Bug Fixes
+
+* MongoError circular dependency warning ([#2734](https://github.com/mongodb/node-mongodb-native/issues/2734)) ([d67ffa7](https://github.com/mongodb/node-mongodb-native/commit/d67ffa7a2e3f86734c7e9b6944aab1d765b9e75e))
+* move session support check to operation layer ([#2739](https://github.com/mongodb/node-mongodb-native/issues/2739)) ([8b370a7](https://github.com/mongodb/node-mongodb-native/commit/8b370a7ad784f5759c964cdfaec62e06c896dc95))
+* session support detection spec compliance ([#2732](https://github.com/mongodb/node-mongodb-native/issues/2732)) ([9baec71](https://github.com/mongodb/node-mongodb-native/commit/9baec7128f612f2d9c290c85d24e33602f911499))
+* use emitWarning API for internal messages ([#2743](https://github.com/mongodb/node-mongodb-native/issues/2743)) ([8bd9777](https://github.com/mongodb/node-mongodb-native/commit/8bd9777b0aedd56b81675c3e79fae63432319982))
+
 ### [3.6.4](https://github.com/mongodb/node-mongodb-native/compare/v3.6.3...v3.6.4) (2021-02-02)
 
 

package/README.md

@@ -1,21 +1,24 @@
-[![npm](https://nodei.co/npm/mongodb.png?downloads=true&downloadRank=true)](https://nodei.co/npm/mongodb/) [![npm](https://nodei.co/npm-dl/mongodb.png?months=6&height=3)](https://nodei.co/npm/mongodb/)
+# MongoDB NodeJS Driver
 
-[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mongodb/node-mongodb-native?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![npm](https://nodei.co/npm/mongodb.png?downloads=true&downloadRank=true)](https://nodei.co/npm/mongodb/)
 
-# Description
+The official [MongoDB](https://www.mongodb.com/) driver for Node.js.
 
-The official [MongoDB](https://www.mongodb.com/) driver for Node.js. Provides a high-level API on top of [mongodb-core](https://www.npmjs.com/package/mongodb-core) that is meant for end users.
+**NOTE: v3.x released with breaking API changes. You can find a list of changes [here](CHANGES_3.0.0.md).**
 
-**NOTE: v3.x was recently released with breaking API changes. You can find a list of changes [here](CHANGES_3.0.0.md).**
+## Version 4.0
 
-## MongoDB Node.JS Driver
+**Looking for the latest?** We're working on the next major version of the driver, now in beta.
+Check out our [beta version 4.0 here](https://github.com/mongodb/node-mongodb-native/tree/4.0), which includes a full migration of the driver to TypeScript.
 
-| what          | where                                          |
-|---------------|------------------------------------------------|
-| documentation | http://mongodb.github.io/node-mongodb-native  |
-| api-doc        | http://mongodb.github.io/node-mongodb-native/3.6/api  |
-| source        | https://github.com/mongodb/node-mongodb-native |
-| mongodb       | http://www.mongodb.org                        |
+## Quick Links
+
+| what          | where                                                |
+| ------------- | ---------------------------------------------------- |
+| documentation | http://mongodb.github.io/node-mongodb-native         |
+| api-doc       | http://mongodb.github.io/node-mongodb-native/3.6/api |
+| source        | https://github.com/mongodb/node-mongodb-native       |
+| mongodb       | http://www.mongodb.org                               |
 
 ### Bugs / Feature Requests
 
@@ -41,12 +44,12 @@ Change history can be found in [`HISTORY.md`](HISTORY.md).
 
 For version compatibility matrices, please refer to the following links:
 
- * [MongoDB](https://docs.mongodb.com/ecosystem/drivers/driver-compatibility-reference/#reference-compatibility-mongodb-node)
- * [NodeJS](https://docs.mongodb.com/ecosystem/drivers/driver-compatibility-reference/#reference-compatibility-language-node)
+- [MongoDB](https://docs.mongodb.com/ecosystem/drivers/driver-compatibility-reference/#reference-compatibility-mongodb-node)
+- [NodeJS](https://docs.mongodb.com/ecosystem/drivers/driver-compatibility-reference/#reference-compatibility-language-node)
 
-# Installation
+## Installation
 
-The recommended way to get started using the Node.js 3.0 driver is by using the `npm` (Node Package Manager) to install the dependency in your project.
+The recommended way to get started using the Node.js driver is by using `npm` (Node Package Manager) to install the dependency in your project.
 
 ## MongoDB Driver
 
@@ -64,10 +67,10 @@ You can also use the [Yarn](https://yarnpkg.com/en) package manager.
 
 The MongoDB driver depends on several other packages. These are:
 
-* [mongodb-core](https://github.com/mongodb-js/mongodb-core)
-* [bson](https://github.com/mongodb/js-bson)
-* [kerberos](https://github.com/mongodb-js/kerberos)
-* [node-gyp](https://github.com/nodejs/node-gyp)
+- [bson](https://github.com/mongodb/js-bson)
+- [bson-ext](https://github.com/mongodb-js/bson-ext)
+- [kerberos](https://github.com/mongodb-js/kerberos)
+- [mongodb-client-encryption](https://github.com/mongodb/libmongocrypt#readme)
 
 The `kerberos` package is a C++ extension that requires a build environment to be installed on your system. You must be able to build Node.js itself in order to compile and install the `kerberos` module. Furthermore, the `kerberos` module requires the MIT Kerberos package to correctly compile on UNIX operating systems. Consult your UNIX operation system package manager for what libraries to install.
 
@@ -108,9 +111,9 @@ This will print out all the steps npm is performing while trying to install the
 
 A compiler tool chain known to work for compiling `kerberos` on Windows is the following.
 
-* Visual Studio C++ 2010 (do not use higher versions)
-* Windows 7 64bit SDK
-* Python 2.7 or higher
+- Visual Studio C++ 2010 (do not use higher versions)
+- Windows 7 64bit SDK
+- Python 2.7 or higher
 
 Open the Visual Studio command prompt. Ensure `node.exe` is in your path and install `node-gyp`.
 
@@ -168,7 +171,7 @@ For complete MongoDB installation instructions, see [the manual](https://docs.mo
 
 1. Download the right MongoDB version from [MongoDB](https://www.mongodb.org/downloads)
 2. Create a database directory (in this case under **/data**).
-3. Install and start a ``mongod`` process.
+3. Install and start a `mongod` process.
 
 ```bash
 mongod --dbpath=/data
@@ -192,11 +195,11 @@ const url = 'mongodb://localhost:27017';
 
 // Database Name
 const dbName = 'myproject';
-
+const client = new MongoClient(url);
 // Use connect method to connect to the server
-MongoClient.connect(url, function(err, client) {
+client.connect(function(err) {
   assert.equal(null, err);
-  console.log("Connected successfully to server");
+  console.log('Connected successfully to server');
 
   const db = client.db(dbName);
 
@@ -222,23 +225,21 @@ const insertDocuments = function(db, callback) {
   // Get the documents collection
   const collection = db.collection('documents');
   // Insert some documents
-  collection.insertMany([
-    {a : 1}, {a : 2}, {a : 3}
-  ], function(err, result) {
+  collection.insertMany([{ a: 1 }, { a: 2 }, { a: 3 }], function(err, result) {
     assert.equal(err, null);
     assert.equal(3, result.result.n);
     assert.equal(3, result.ops.length);
-    console.log("Inserted 3 documents into the collection");
+    console.log('Inserted 3 documents into the collection');
     callback(result);
   });
-}
+};
 ```
 
 The **insert** command returns an object with the following fields:
 
-* **result** Contains the result document from MongoDB
-* **ops** Contains the documents inserted with added **_id** fields
-* **connection** Contains the connection used to perform the insert
+- **result** Contains the result document from MongoDB
+- **ops** Contains the documents inserted with added **\_id** fields
+- **connection** Contains the connection used to perform the insert
 
 Add the following code to call the **insertDocuments** function:
 
@@ -255,7 +256,7 @@ const dbName = 'myproject';
 // Use connect method to connect to the server
 MongoClient.connect(url, function(err, client) {
   assert.equal(null, err);
-  console.log("Connected successfully to server");
+  console.log('Connected successfully to server');
 
   const db = client.db(dbName);
 
@@ -289,11 +290,11 @@ const findDocuments = function(db, callback) {
   // Find some documents
   collection.find({}).toArray(function(err, docs) {
     assert.equal(err, null);
-    console.log("Found the following records");
-    console.log(docs)
+    console.log('Found the following records');
+    console.log(docs);
     callback(docs);
   });
-}
+};
 ```
 
 This query returns all the documents in the **documents** collection. Add the **findDocument** method to the **MongoClient.connect** callback:
@@ -311,7 +312,7 @@ const dbName = 'myproject';
 // Use connect method to connect to the server
 MongoClient.connect(url, function(err, client) {
   assert.equal(null, err);
-  console.log("Connected correctly to server");
+  console.log('Connected correctly to server');
 
   const db = client.db(dbName);
 
@@ -332,16 +333,16 @@ const findDocuments = function(db, callback) {
   // Get the documents collection
   const collection = db.collection('documents');
   // Find some documents
-  collection.find({'a': 3}).toArray(function(err, docs) {
+  collection.find({ a: 3 }).toArray(function(err, docs) {
     assert.equal(err, null);
-    console.log("Found the following records");
+    console.log('Found the following records');
     console.log(docs);
     callback(docs);
   });
-}
+};
 ```
 
-Only the documents which match ``'a' : 3`` should be returned.
+Only the documents which match `'a' : 3` should be returned.
 
 ### Update a document
 
@@ -352,14 +353,13 @@ const updateDocument = function(db, callback) {
   // Get the documents collection
   const collection = db.collection('documents');
   // Update document where a is 2, set b equal to 1
-  collection.updateOne({ a : 2 }
-    , { $set: { b : 1 } }, function(err, result) {
+  collection.updateOne({ a: 2 }, { $set: { b: 1 } }, function(err, result) {
     assert.equal(err, null);
     assert.equal(1, result.result.n);
-    console.log("Updated the document with the field a equal to 2");
+    console.log('Updated the document with the field a equal to 2');
     callback(result);
   });
-}
+};
 ```
 
 The method updates the first document where the field **a** is equal to **2** by adding a new field **b** to the document set to **1**. Next, update the callback function from **MongoClient.connect** to include the update method.
@@ -377,7 +377,7 @@ const dbName = 'myproject';
 // Use connect method to connect to the server
 MongoClient.connect(url, function(err, client) {
   assert.equal(null, err);
-  console.log("Connected successfully to server");
+  console.log('Connected successfully to server');
 
   const db = client.db(dbName);
 
@@ -398,13 +398,13 @@ const removeDocument = function(db, callback) {
   // Get the documents collection
   const collection = db.collection('documents');
   // Delete document where a is 3
-  collection.deleteOne({ a : 3 }, function(err, result) {
+  collection.deleteOne({ a: 3 }, function(err, result) {
     assert.equal(err, null);
     assert.equal(1, result.result.n);
-    console.log("Removed the document with the field a equal to 3");
+    console.log('Removed the document with the field a equal to 3');
     callback(result);
   });
-}
+};
 ```
 
 Add the new method to the **MongoClient.connect** callback function.
@@ -422,7 +422,7 @@ const dbName = 'myproject';
 // Use connect method to connect to the server
 MongoClient.connect(url, function(err, client) {
   assert.equal(null, err);
-  console.log("Connected successfully to server");
+  console.log('Connected successfully to server');
 
   const db = client.db(dbName);
 
@@ -444,18 +444,14 @@ performance. The following function creates an index on the **a** field in the
 
 ```js
 const indexCollection = function(db, callback) {
-  db.collection('documents').createIndex(
-    { "a": 1 },
-      null,
-      function(err, results) {
-        console.log(results);
-        callback();
-    }
-  );
+  db.collection('documents').createIndex({ a: 1 }, null, function(err, results) {
+    console.log(results);
+    callback();
+  });
 };
 ```
 
-Add the ``indexCollection`` method to your app:
+Add the `indexCollection` method to your app:
 
 ```js
 const MongoClient = require('mongodb').MongoClient;
@@ -469,7 +465,7 @@ const dbName = 'myproject';
 // Use connect method to connect to the server
 MongoClient.connect(url, function(err, client) {
   assert.equal(null, err);
-  console.log("Connected successfully to server");
+  console.log('Connected successfully to server');
 
   const db = client.db(dbName);
 
@@ -485,13 +481,13 @@ For more detailed information, see the [tutorials](docs/reference/content/tutori
 
 ## Next Steps
 
- * [MongoDB Documentation](http://mongodb.org)
- * [Read about Schemas](http://learnmongodbthehardway.com)
- * [Star us on GitHub](https://github.com/mongodb/node-mongodb-native)
+- [MongoDB Documentation](http://mongodb.org)
+- [Read about Schemas](http://learnmongodbthehardway.com)
+- [Star us on GitHub](https://github.com/mongodb/node-mongodb-native)
 
 ## License
 
 [Apache 2.0](LICENSE.md)
 
-© 2009-2012 Christian Amor Kvalheim  
+© 2009-2012 Christian Amor Kvalheim
 © 2012-present MongoDB [Contributors](CONTRIBUTORS.md)

package/lib/bulk/common.js

@@ -5,6 +5,7 @@ const MongoError = require('../core').MongoError;
 const ObjectID = require('../core').BSON.ObjectID;
 const BSON = require('../core').BSON;
 const MongoWriteConcernError = require('../core').MongoWriteConcernError;
+const emitWarningOnce = require('../utils').emitWarningOnce;
 const toError = require('../utils').toError;
 const handleCallback = require('../utils').handleCallback;
 const applyRetryableWrites = require('../utils').applyRetryableWrites;
@@ -70,6 +71,45 @@ class BulkWriteResult {
     this.result = bulkResult;
   }
 
+  /** Number of documents inserted. */
+  get insertedCount() {
+    return typeof this.result.nInserted !== 'number' ? 0 : this.result.nInserted;
+  }
+  /** Number of documents matched for update. */
+  get matchedCount() {
+    return typeof this.result.nMatched !== 'number' ? 0 : this.result.nMatched;
+  }
+  /** Number of documents modified. */
+  get modifiedCount() {
+    return typeof this.result.nModified !== 'number' ? 0 : this.result.nModified;
+  }
+  /** Number of documents deleted. */
+  get deletedCount() {
+    return typeof this.result.nRemoved !== 'number' ? 0 : this.result.nRemoved;
+  }
+  /** Number of documents upserted. */
+  get upsertedCount() {
+    return !this.result.upserted ? 0 : this.result.upserted.length;
+  }
+
+  /** Upserted document generated Id's, hash key is the index of the originating operation */
+  get upsertedIds() {
+    const upserted = {};
+    for (const doc of !this.result.upserted ? [] : this.result.upserted) {
+      upserted[doc.index] = doc._id;
+    }
+    return upserted;
+  }
+
+  /** Inserted document generated Id's, hash key is the index of the originating operation */
+  get insertedIds() {
+    const inserted = {};
+    for (const doc of !this.result.insertedIds ? [] : this.result.insertedIds) {
+      inserted[doc.index] = doc._id;
+    }
+    return inserted;
+  }
+
   /**
    * Evaluates to true if the bulk operation correctly executes
    * @type {boolean}
@@ -571,6 +611,35 @@ class BulkWriteError extends MongoError {
     this.name = 'BulkWriteError';
     this.result = result;
   }
+
+  /** Number of documents inserted. */
+  get insertedCount() {
+    return this.result.insertedCount;
+  }
+  /** Number of documents matched for update. */
+  get matchedCount() {
+    return this.result.matchedCount;
+  }
+  /** Number of documents modified. */
+  get modifiedCount() {
+    return this.result.modifiedCount;
+  }
+  /** Number of documents deleted. */
+  get deletedCount() {
+    return this.result.deletedCount;
+  }
+  /** Number of documents upserted. */
+  get upsertedCount() {
+    return this.result.upsertedCount;
+  }
+  /** Inserted document generated Id's, hash key is the index of the originating operation */
+  get insertedIds() {
+    return this.result.insertedIds;
+  }
+  /** Upserted document generated Id's, hash key is the index of the originating operation */
+  get upsertedIds() {
+    return this.result.upsertedIds;
+  }
 }
 
 /**
@@ -737,15 +806,19 @@ class FindOperators {
 
   /**
    * backwards compatability for deleteOne
+   * @deprecated
    */
   removeOne() {
+    emitWarningOnce('bulk operation `removeOne` has been deprecated, please use `deleteOne`');
     return this.deleteOne();
   }
 
   /**
    * backwards compatability for delete
+   * @deprecated
    */
   remove() {
+    emitWarningOnce('bulk operation `remove` has been deprecated, please use `delete`');
     return this.delete();
   }
 }
@@ -1041,6 +1114,9 @@ class BulkOperationBase {
     }
 
     if (op.insertMany) {
+      emitWarningOnce(
+        'bulk operation `insertMany` has been deprecated; use multiple `insertOne` ops instead'
+      );
       for (let i = 0; i < op.insertMany.length; i++) {
         if (forceServerObjectId !== true && op.insertMany[i]._id == null)
           op.insertMany[i]._id = new ObjectID();

package/lib/cmap/connection.js

@@ -58,38 +58,9 @@ class Connection extends EventEmitter {
       /* ignore errors, listen to `close` instead */
     });
 
-    stream.on('close', () => {
-      if (this.closed) {
-        return;
-      }
-
-      this.closed = true;
-      this[kQueue].forEach(op =>
-        op.cb(new MongoNetworkError(`connection ${this.id} to ${this.address} closed`))
-      );
-      this[kQueue].clear();
-
-      this.emit('close');
-    });
-
-    stream.on('timeout', () => {
-      if (this.closed) {
-        return;
-      }
-
-      stream.destroy();
-      this.closed = true;
-      this[kQueue].forEach(op =>
-        op.cb(
-          new MongoNetworkTimeoutError(`connection ${this.id} to ${this.address} timed out`, {
-            beforeHandshake: this[kIsMaster] == null
-          })
-        )
-      );
-
-      this[kQueue].clear();
-      this.emit('close');
-    });
+    this[kMessageStream].on('error', error => this.handleIssue({ destroy: error }));
+    stream.on('close', () => this.handleIssue({ isClose: true }));
+    stream.on('timeout', () => this.handleIssue({ isTimeout: true, destroy: true }));
 
     // hook the message stream up to the passed in stream
     stream.pipe(this[kMessageStream]);
@@ -132,6 +103,39 @@ class Connection extends EventEmitter {
     this[kLastUseTime] = now();
   }
 
+  /**
+   * @param {{ isTimeout?: boolean; isClose?: boolean; destroy?: boolean | Error }} issue
+   */
+  handleIssue(issue) {
+    if (this.closed) {
+      return;
+    }
+
+    if (issue.destroy) {
+      this[kStream].destroy(typeof issue.destroy === 'boolean' ? undefined : issue.destroy);
+    }
+
+    this.closed = true;
+
+    for (const idAndOp of this[kQueue]) {
+      const op = idAndOp[1];
+      if (issue.isTimeout) {
+        op.cb(
+          new MongoNetworkTimeoutError(`connection ${this.id} to ${this.address} timed out`, {
+            beforeHandshake: this.ismaster == null
+          })
+        );
+      } else if (issue.isClose) {
+        op.cb(new MongoNetworkError(`connection ${this.id} to ${this.address} closed`));
+      } else {
+        op.cb(typeof issue.destroy === 'boolean' ? undefined : issue.destroy);
+      }
+    }
+
+    this[kQueue].clear();
+    this.emit('close');
+  }
+
   destroy(options, callback) {
     if (typeof options === 'function') {
       callback = options;