added collation support and tests

Author: christkv

lib/collection.js

@@ -122,6 +122,8 @@ var Collection = function(db, topology, dbName, name, pkFactory, options) {
     , promiseLibrary: promiseLibrary
     // Read Concern
     , readConcern: options.readConcern
+    // Collation
+    , collation: options.collation
   }
 }
 
@@ -351,6 +353,9 @@ Collection.prototype.find = function() {
     findCommand.readConcern = this.s.readConcern;
   }
 
+  // Decorate find command with collation options
+  decorateWithCollation(findCommand, this, options);
+
   // Create the cursor
   if(typeof callback == 'function') return handleCallback(callback, null, this.s.topology.cursor(this.s.namespace, findCommand, newOptions));
   return this.s.topology.cursor(this.s.namespace, findCommand, newOptions);
@@ -623,11 +628,6 @@ var bulkWrite = function(self, operations, options, callback) {
       return callback(toError(r.getWriteErrorAt(0)), r);
     }
 
-    // console.log("!!!!!! BULK EXECUTE FINISHED")
-    // console.dir(err)
-    // console.dir(r)
-
-    // if(err) return callback(err);
     r.insertedCount = r.nInserted;
     r.matchedCount = r.nMatched;
     r.modifiedCount = r.nModified || 0;
@@ -1006,6 +1006,9 @@ var updateDocuments = function(self, selector, document, options, callback) {
   op.upsert = typeof options.upsert == 'boolean' ? options.upsert : false;
   op.multi = typeof options.multi == 'boolean' ? options.multi : false;
 
+  // Have we specified collation
+  decorateWithCollation(finalOptions, self, options);
+
   // Update options
   self.s.topology.update(self.s.namespace, [op], finalOptions, function(err, result) {
     if(callback == null) return;
@@ -1161,6 +1164,7 @@ Collection.prototype.deleteMany = function(filter, options, callback) {
 
 var deleteMany = function(self, filter, options, callback) {
   options.single = false;
+
   removeDocuments(self, filter, options, function(err, r) {
     if(callback == null) return;
     if(err && callback) return callback(err);
@@ -1192,6 +1196,9 @@ var removeDocuments = function(self, selector, options, callback) {
   var op = {q: selector, limit: 0};
   if(options.single) op.limit = 1;
 
+  // Have we specified collation
+  decorateWithCollation(finalOptions, self, options);
+
   // Execute the remove
   self.s.topology.remove(self.s.namespace, [op], finalOptions, function(err, result) {
     if(callback == null) return;
@@ -1989,6 +1996,9 @@ var count = function(self, query, options, callback) {
     cmd.readConcern = self.s.readConcern;
   }
 
+  // Have we specified collation
+  decorateWithCollation(cmd, self, options);
+
   // Execute command
   self.s.db.command(cmd, options, function(err, result) {
     if(err) return handleCallback(callback, err);
@@ -2050,6 +2060,9 @@ var distinct = function(self, key, query, options, callback) {
     cmd.readConcern = self.s.readConcern;
   }
 
+  // Have we specified collation
+  decorateWithCollation(cmd, self, options);
+
   // Execute the command
   self.s.db.command(cmd, options, function(err, result) {
     if(err) return handleCallback(callback, err);
@@ -2408,6 +2421,9 @@ var findAndModify = function(self, query, sort, doc, options, callback) {
     queryObject.bypassDocumentValidation = finalOptions.bypassDocumentValidation;
   }
 
+  // Have we specified collation
+  decorateWithCollation(queryObject, self, options);
+
   // Execute the command
   self.s.db.command(queryObject
     , options, function(err, result) {
@@ -2472,6 +2488,19 @@ function decorateWithWriteConcern(command, self, options) {
   }
 }
 
+function decorateWithCollation(command, self, options) {
+  // Do we support collation 3.4 and higher
+  if(self.s.topology.capabilities().commandsTakeCollation) {
+    if(options.collation && typeof options.collation == 'object') {
+      command.collation = options.collation;
+    } else if(self.s.collation && typeof self.s.collation == 'object') {
+      command.collation = self.s.collation;
+    } else if(self.s.db.s.collation && typeof self.s.db.s.collation == 'object') {
+      command.collation = self.s.db.s.collation;
+    }
+  }
+}
+
 /**
  * Execute an aggregation framework pipeline against the collection, needs MongoDB >= 2.2
  * @method
@@ -2533,6 +2562,8 @@ Collection.prototype.aggregate = function(pipeline, options, callback) {
 
   // Decorate command with writeConcern if supported
   decorateWithWriteConcern(command, self, options);
+  // Have we specified collation
+  decorateWithCollation(command, self, options);
 
   // If we have bypassDocumentValidation set
   if(typeof options.bypassDocumentValidation == 'boolean') {
@@ -2767,6 +2798,9 @@ var geoNear = function(self, x, y, point, options, callback) {
     commandObject.readConcern = self.s.readConcern;
   }
 
+  // Have we specified collation
+  decorateWithCollation(commandObject, self, options);
+
   // Execute the command
   self.s.db.command(commandObject, options, function (err, res) {
     if(err) return handleCallback(callback, err);
@@ -2976,6 +3010,9 @@ var group = function(self, keys, condition, initial, reduce, finalize, command,
       selector.readConcern = self.s.readConcern;
     }
 
+    // Have we specified collation
+    decorateWithCollation(selector, self, options);
+
     // Execute command
     self.s.db.command(selector, options, function(err, result) {
       if(err) return handleCallback(callback, err, null);
@@ -3122,6 +3159,9 @@ var mapReduce = function(self, map, reduce, options, callback) {
     mapCommandHash.bypassDocumentValidation = options.bypassDocumentValidation;
   }
 
+  // Have we specified collation
+  decorateWithCollation(mapCommandHash, self, options);
+
   // Execute command
   self.s.db.command(mapCommandHash, {readPreference:options.readPreference}, function (err, result) {
     if(err) return handleCallback(callback, err);
@@ -3254,6 +3294,7 @@ var testForFields = {
     limit: 1, sort: 1, fields:1, skip: 1, hint: 1, explain: 1, snapshot: 1, timeout: 1, tailable: 1, tailableRetryInterval: 1
   , numberOfRetries: 1, awaitdata: 1, awaitData: 1, exhaust: 1, batchSize: 1, returnKey: 1, maxScan: 1, min: 1, max: 1, showDiskLoc: 1
   , comment: 1, raw: 1, readPreference: 1, partial: 1, read: 1, dbName: 1, oplogReplay: 1, connection: 1, maxTimeMS: 1, transforms: 1
+  , collation: 1
 }
 
 module.exports = Collection;

lib/cursor.js

@@ -578,6 +578,20 @@ Cursor.prototype.batchSize = function(value) {
 
 define.classMethod('batchSize', {callback: false, promise:false, returns: [Cursor]});
 
+/**
+ * Set the collation options for the cursor.
+ * @method
+ * @param {object} value The cursor collation options
+ * @throws {MongoError}
+ * @return {Cursor}
+ */
+Cursor.prototype.collation = function(value) {
+  this.s.cmd.collation = value;
+  return this;
+}
+
+define.classMethod('collation', {callback: false, promise:false, returns: [Cursor]});
+
 /**
  * Set the limit for the cursor.
  * @method

lib/db.js

@@ -47,7 +47,7 @@ var debugFields = ['authSource', 'w', 'wtimeout', 'j', 'native_parser', 'forceSe
 var legalOptionNames = ['w', 'wtimeout', 'fsync', 'j', 'readPreference', 'readPreferenceTags', 'native_parser'
   , 'forceServerObjectId', 'pkFactory', 'serializeFunctions', 'raw', 'bufferMaxEntries', 'authSource'
   , 'ignoreUndefined', 'promoteLongs', 'promiseLibrary', 'readConcern', 'retryMiliSeconds', 'numberOfRetries'
-  , 'parentDb', 'noListener', 'loggerLevel', 'logger'];
+  , 'parentDb', 'noListener', 'loggerLevel', 'logger', 'collation'];
 
 /**
  * Creates a new Db instance
@@ -143,6 +143,8 @@ var Db = function(databaseName, topology, options) {
     , noListener: typeof options.noListener == 'boolean' ? options.noListener : false
     // ReadConcern
     , readConcern: options.readConcern
+    // Collation
+    , collation: options.collation
   }
 
   // Ensure we have a valid db name
@@ -437,6 +439,11 @@ Db.prototype.collection = function(name, options, callback) {
   // If we have not set a collection level readConcern set the db level one
   options.readConcern = options.readConcern || this.s.readConcern;
 
+  // Do we have a db level collation but not one for the collection
+  if(!options.collation && this.s.collation && typeof this.s.collation == 'object') {
+    options.collation = this.s.collation;
+  }
+
   // Do we have ignoreUndefined set
   if(this.s.options.ignoreUndefined) {
     options.ignoreUndefined = this.s.options.ignoreUndefined;

lib/mongo_client.js

@@ -131,9 +131,12 @@ var mergeOptions = function(target, source, flatten) {
 var createUnifiedOptions = function(finalOptions, options) {
   var childOptions = ['mongos', 'server', 'db'
     , 'replset', 'db_options', 'server_options', 'rs_options', 'mongos_options'];
+  var noMerge = ['collation'];
 
   for(var name in options) {
-    if(childOptions.indexOf(name.toLowerCase()) != -1) {
+    if(noMerge.indexOf(name.toLowerCase()) != -1) {
+      finalOptions[name] = options[name];
+    } else if(childOptions.indexOf(name.toLowerCase()) != -1) {
       finalOptions = mergeOptions(finalOptions, options[name], false);
     } else {
       if(options[name] && typeof options[name] == 'object' && !Buffer.isBuffer(options[name]) && !Array.isArray(options[name])) {

lib/topology_base.js

@@ -114,6 +114,7 @@ var ServerCapabilities = function(ismaster) {
   var listIndexes = false;
   var maxNumberOfDocsInBatch = ismaster.maxWriteBatchSize || 1000;
   var commandsTakeWriteConcern = false;
+  var commandsTakeCollation = false;
 
   if(ismaster.minWireVersion >= 0) {
     textSearch = true;
@@ -135,6 +136,7 @@ var ServerCapabilities = function(ismaster) {
 
   if(ismaster.maxWireVersion >= 5) {
     commandsTakeWriteConcern = true;
+    commandsTakeCollation = true;
   }
 
   // If no min or max wire version set to 0
@@ -157,6 +159,7 @@ var ServerCapabilities = function(ismaster) {
   setup_get_property(this, "maxWireVersion", ismaster.maxWireVersion);
   setup_get_property(this, "maxNumberOfDocsInBatch", maxNumberOfDocsInBatch);
   setup_get_property(this, "commandsTakeWriteConcern", commandsTakeWriteConcern);
+  setup_get_property(this, "commandsTakeCollation", commandsTakeCollation);
 }
 
 exports.Store = Store;