Merged back 2.0 branch

Author: christkv

HISTORY.md

@@ -1,3 +1,11 @@
+2.0.43
+-----------------
+* Propegate timeout event correctly to db instances
+
+2.0.42 08-18-2015
+-----------------
+* Added test case to exercise all non-crud methods on mongos topologies, fixed numberOfConnectedServers on mongos topology instance.
+
 2.0.41 08-14-2015
 -----------------
 * Added missing Mongos.prototype.parserType function.

README.md

@@ -43,7 +43,7 @@ http://jira.mongodb.org/browse/NODE
 
 QuickStart
 ==========
-The quick start guide will show you how to setup a simple application using node.js and MongoDB. It scope is only how to set up the driver and perform the simple crud operations. For more in depth coverage we encourage reading the tutorials.
+The quick start guide will show you how to setup a simple application using node.js and MongoDB. Its scope is only how to set up the driver and perform the simple crud operations. For more in depth coverage we encourage reading the tutorials.
 
 Create the package.json file
 ----------------------------

conf.json

@@ -21,6 +21,7 @@
       "lib/bulk/ordered.js",
       "lib/bulk/unordered.js",
       "lib/gridfs/grid_store.js",
+      "node_modules/mongodb-core/lib/error.js",
       "node_modules/mongodb-core/lib/connection/logger.js",
       "node_modules/bson/lib/bson/binary.js",
       "node_modules/bson/lib/bson/code.js",

lib/collection.js

@@ -355,7 +355,7 @@ define.classMethod('find', {callback: false, promise:false, returns: [Cursor]});
  * @param {boolean} [options.j=false] Specify a journal write concern.
  * @param {boolean} [options.serializeFunctions=false] Serialize functions on any object.
  * @param {boolean} [options.forceServerObjectId=false] Force server to assign _id values instead of driver.
- * @param {Collection~writeOpCallback} [callback] The command result callback
+ * @param {Collection~insertWriteOpCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Collection.prototype.insertOne = function(doc, options, callback) {
@@ -420,7 +420,7 @@ define.classMethod('insertOne', {callback: true, promise:true});
  * @param {boolean} [options.j=false] Specify a journal write concern.
  * @param {boolean} [options.serializeFunctions=false] Serialize functions on any object.
  * @param {boolean} [options.forceServerObjectId=false] Force server to assign _id values instead of driver.
- * @param {Collection~writeOpCallback} [callback] The command result callback
+ * @param {Collection~insertWriteOpCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Collection.prototype.insertMany = function(docs, options, callback) {
@@ -652,6 +652,24 @@ define.classMethod('bulkWrite', {callback: true, promise:true});
  * @param {Collection~WriteOpResult} result The result object if the command was executed successfully.
  */
 
+/**
+ * @typedef {Object} Collection~insertWriteOpResult
+ * @property {Number} insertedCount The total amount of documents inserted.
+ * @property {object[]} ops All the documents inserted using insertOne/insertMany/replaceOne. Documents contain the _id field if forceServerObjectId == false for insertOne/insertMany
+ * @property {ObjectId[]} insertedIds All the generated _id's for the inserted documents.
+ * @property {object} connection The connection object used for the operation.
+ * @property {object} result The raw command result object returned from MongoDB (content might vary by server version).
+ * @property {Number} result.ok Is 1 if the command executed correctly.
+ * @property {Number} result.n The total count of documents inserted.
+ */
+
+/**
+ * The callback format for inserts
+ * @callback Collection~insertWriteOpCallback
+ * @param {MongoError} error An error instance representing the error during the execution.
+ * @param {Collection~insertWriteOpResult} result The result object if the command was executed successfully.
+ */
+
 /**
  * Inserts a single document or a an array of documents into MongoDB.
  * @method
@@ -662,7 +680,7 @@ define.classMethod('bulkWrite', {callback: true, promise:true});
  * @param {boolean} [options.j=false] Specify a journal write concern.
  * @param {boolean} [options.serializeFunctions=false] Serialize functions on any object.
  * @param {boolean} [options.forceServerObjectId=false] Force server to assign _id values instead of driver.
- * @param {Collection~writeOpCallback} [callback] The command result callback
+ * @param {Collection~insertWriteOpCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  * @deprecated Use insertOne, insertMany or bulkWrite
  */
@@ -681,6 +699,27 @@ Collection.prototype.insert = function(docs, options, callback) {
 
 define.classMethod('insert', {callback: true, promise:true});
 
+/**
+ * @typedef {Object} Collection~updateWriteOpResult
+ * @property {Object} result The raw result returned from MongoDB, field will vary depending on server version.
+ * @property {Number} result.ok Is 1 if the command executed correctly.
+ * @property {Number} result.n The total count of documents scanned.
+ * @property {Number} result.nModified The total count of documents modified.
+ * @property {Object} connection The connection object used for the operation.
+ * @property {Number} matchedCount The number of documents that matched the filter.
+ * @property {Number} modifiedCount The number of documents that were modified.
+ * @property {Number} upsertedCount The number of documents upserted.
+ * @property {Object} upsertedId The upserted id.
+ * @property {ObjectId} upsertedId._id The upserted _id returned from the server.
+ */
+
+/**
+ * The callback format for inserts
+ * @callback Collection~updateWriteOpCallback
+ * @param {MongoError} error An error instance representing the error during the execution.
+ * @param {Collection~updateWriteOpResult} result The result object if the command was executed successfully.
+ */
+
 /**
  * Update a single document on MongoDB
  * @method
@@ -691,7 +730,7 @@ define.classMethod('insert', {callback: true, promise:true});
  * @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 {Collection~writeOpCallback} [callback] The command result callback
+ * @param {Collection~updateWriteOpCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Collection.prototype.updateOne = function(filter, update, options, callback) {
@@ -739,7 +778,7 @@ define.classMethod('updateOne', {callback: true, promise:true});
  * @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 {Collection~writeOpCallback} [callback] The command result callback
+ * @param {Collection~updateWriteOpCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Collection.prototype.replaceOne = function(filter, update, options, callback) {
@@ -788,7 +827,7 @@ define.classMethod('replaceOne', {callback: true, promise:true});
  * @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 {Collection~writeOpCallback} [callback] The command result callback
+ * @param {Collection~updateWriteOpCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Collection.prototype.updateMany = function(filter, update, options, callback) {
@@ -892,6 +931,22 @@ Collection.prototype.update = function(selector, document, options, callback) {
 
 define.classMethod('update', {callback: true, promise:true});
 
+/**
+ * @typedef {Object} Collection~deleteWriteOpResult
+ * @property {Object} result The raw result returned from MongoDB, field will vary depending on server version.
+ * @property {Number} result.ok Is 1 if the command executed correctly.
+ * @property {Number} result.n The total count of documents deleted.
+ * @property {Object} connection The connection object used for the operation.
+ * @property {Number} deletedCount The number of documents deleted.
+ */
+
+/**
+ * The callback format for inserts
+ * @callback Collection~deleteWriteOpCallback
+ * @param {MongoError} error An error instance representing the error during the execution.
+ * @param {Collection~deleteWriteOpResult} result The result object if the command was executed successfully.
+ */
+
 /**
  * Delete a document on MongoDB
  * @method
@@ -900,7 +955,7 @@ define.classMethod('update', {callback: true, promise:true});
  * @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 {Collection~writeOpCallback} [callback] The command result callback
+ * @param {Collection~deleteWriteOpCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Collection.prototype.deleteOne = function(filter, options, callback) {
@@ -945,7 +1000,7 @@ define.classMethod('removeOne', {callback: true, promise:true});
  * @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 {Collection~writeOpCallback} [callback] The command result callback
+ * @param {Collection~deleteWriteOpCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Collection.prototype.deleteMany = function(filter, options, callback) {
@@ -1056,6 +1111,7 @@ define.classMethod('remove', {callback: true, promise:true});
  * @param {boolean} [options.j=false] Specify a journal write concern.
  * @param {Collection~writeOpCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated use insertOne, insertMany, updateOne or updateMany
  */
 Collection.prototype.save = function(doc, options, callback) {
   var self = this;
@@ -1879,6 +1935,20 @@ var stats = function(self, options, callback) {
 
 define.classMethod('stats', {callback: true, promise:true});
 
+/**
+ * @typedef {Object} Collection~findAndModifyWriteOpResult
+ * @property {object} value Document returned from findAndModify command.
+ * @property {object} lastErrorObject The raw lastErrorObject returned from the command.
+ * @property {Number} ok Is 1 if the command executed correctly.
+ */
+
+/**
+ * The callback format for inserts
+ * @callback Collection~findAndModifyCallback
+ * @param {MongoError} error An error instance representing the error during the execution.
+ * @param {Collection~findAndModifyWriteOpResult} result The result object if the command was executed successfully.
+ */
+
 /**
  * Find a document and delete it in one atomic operation, requires a write lock for the duration of the operation.
  *
@@ -1888,7 +1958,7 @@ define.classMethod('stats', {callback: true, promise:true});
  * @param {object} [options.projection=null] Limits the fields to return for all matching documents.
  * @param {object} [options.sort=null] Determines which document the operation modifies if the query selects multiple documents.
  * @param {number} [options.maxTimeMS=null] The maximum amount of time to allow the query to run.
- * @param {Collection~resultCallback} [callback] The collection result callback
+ * @param {Collection~findAndModifyCallback} [callback] The collection result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Collection.prototype.findOneAndDelete = function(filter, options, callback) {
@@ -1937,7 +2007,7 @@ define.classMethod('findOneAndDelete', {callback: true, promise:true});
  * @param {number} [options.maxTimeMS=null] The maximum amount of time to allow the query to run.
  * @param {boolean} [options.upsert=false] Upsert the document if it does not exist.
  * @param {boolean} [options.returnOriginal=true] When false, returns the updated document rather than the original. The default is true.
- * @param {Collection~resultCallback} [callback] The collection result callback
+ * @param {Collection~findAndModifyCallback} [callback] The collection result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Collection.prototype.findOneAndReplace = function(filter, replacement, options, callback) {
@@ -1988,7 +2058,7 @@ define.classMethod('findOneAndReplace', {callback: true, promise:true});
  * @param {number} [options.maxTimeMS=null] The maximum amount of time to allow the query to run.
  * @param {boolean} [options.upsert=false] Upsert the document if it does not exist.
  * @param {boolean} [options.returnOriginal=true] When false, returns the updated document rather than the original. The default is true.
- * @param {Collection~resultCallback} [callback] The collection result callback
+ * @param {Collection~findAndModifyCallback} [callback] The collection result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Collection.prototype.findOneAndUpdate = function(filter, update, options, callback) {

lib/command_cursor.js

@@ -142,7 +142,7 @@ inherits(CommandCursor, Readable);
 // Set the methods to inherit from prototype
 var methodsToInherit = ['_next', 'next', 'each', 'forEach', 'toArray'
   , 'rewind', 'bufferedCount', 'readBufferedDocuments', 'close', 'isClosed', 'kill'
-  , '_find', '_getmore', '_killcursor', 'isDead', 'explain', 'isNotified'];
+  , '_find', '_getmore', '_killcursor', 'isDead', 'explain', 'isNotified', 'isKilled'];
 
 // Only inherit the types we need
 for(var i = 0; i < methodsToInherit.length; i++) {

lib/cursor.js

@@ -176,7 +176,6 @@ var define = Cursor.define = new Define('Cursor', Cursor, true);
  * @method
  * @param {Cursor~resultCallback} [callback] The result callback.
  * @throws {MongoError}
- * @deprecated
  * @return {Promise} returns Promise if no callback passed
  */
 Cursor.prototype.hasNext = function(callback) {
@@ -208,7 +207,6 @@ define.classMethod('hasNext', {callback: true, promise:true});
  * @method
  * @param {Cursor~resultCallback} [callback] The result callback.
  * @throws {MongoError}
- * @deprecated
  * @return {Promise} returns Promise if no callback passed
  */
 Cursor.prototype.next = function(callback) {

lib/db.js

@@ -188,10 +188,10 @@ var Db = function(databaseName, topology, options) {
   if(this.s.noListener) return;
 
   // Add listeners
-  topology.once('error', createListener(self, 'error', self));
-  topology.once('timeout', createListener(self, 'timeout', self));
+  topology.on('error', createListener(self, 'error', self));
+  topology.on('timeout', createListener(self, 'timeout', self));
   topology.on('close', createListener(self, 'close', self));
-  topology.once('parseError', createListener(self, 'parseError', self));
+  topology.on('parseError', createListener(self, 'parseError', self));
   topology.once('open', createListener(self, 'open', self));
   topology.once('fullsetup', createListener(self, 'fullsetup', self));
   topology.once('all', createListener(self, 'all', self));
@@ -659,6 +659,7 @@ var evaluate = function(self, code, parameters, options, callback) {
  * @param {boolean} [options.nolock=false] Tell MongoDB not to block on the evaulation of the javascript.
  * @param {Db~resultCallback} [callback] The results callback
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated MongoDB 3.2 and higher no longer support eval.
  */
 Db.prototype.eval = function(code, parameters, options, callback) {
   var self = this;
@@ -1631,47 +1632,65 @@ var createListener = function(self, e, object) {
 /**
  * Db close event
  *
+ * Emitted after a socket closed against a single server or mongos proxy.
+ *
  * @event Db#close
- * @type {object}
+ * @type {MongoError}
  */
 
 /**
  * Db authenticated event
  *
+ * Emitted after all server members in the topology (single server, replicaset or mongos) have successfully authenticated.
+ *
  * @event Db#authenticated
  * @type {object}
  */
 
 /**
  * Db reconnect event
  *
+ *  * Server: Emitted when the driver has reconnected and re-authenticated.
+ *  * ReplicaSet: N/A
+ *  * Mongos: Emitted when the driver reconnects and re-authenticates successfully against a Mongos.
+ *
  * @event Db#reconnect
  * @type {object}
  */
 
 /**
  * Db error event
  *
+ * Emitted after an error occurred against a single server or mongos proxy.
+ *
  * @event Db#error
  * @type {MongoError}
  */
 
 /**
  * Db timeout event
  *
+ * Emitted after a socket timeout occurred against a single server or mongos proxy.
+ *
  * @event Db#timeout
- * @type {object}
+ * @type {MongoError}
  */
 
 /**
  * Db parseError event
  *
+ * The parseError event is emitted if the driver detects illegal or corrupt BSON being received from the server.
+ *
  * @event Db#parseError
- * @type {object}
+ * @type {MongoError}
  */
 
 /**
- * Db fullsetup event, emitted when all servers in the topology have been connected to.
+ * Db fullsetup event, emitted when all servers in the topology have been connected to at start up time.
+ *
+ * * Server: Emitted when the driver has connected to the single server and has authenticated.
+ * * ReplSet: Emitted after the driver has attempted to connect to all replicaset members.
+ * * Mongos: Emitted after the driver has attempted to connect to all mongos proxies.
  *
  * @event Db#fullsetup
  * @type {Db}

lib/mongos.js

@@ -195,7 +195,9 @@ var Mongos = function(servers, options) {
 
   // Last ismaster
   Object.defineProperty(this, 'numberOfConnectedServers', {
-    enumerable:true, get: function() { return self.s.mongos.connectedServers().length; }
+    enumerable:true, get: function() { 
+      return self.s.mongos.s.mongosState.connectedServers().length; 
+    }
   });
 
   // BSON property

package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb",
-  "version": "2.0.41",
+  "version": "2.0.42",
   "description": "MongoDB legacy driver emulation layer on top of mongodb-core",
   "main": "index.js",
   "repository": {