Merge pull request #5106 from Automattic/5105

Make sharding into a plugin instead of core

Author: vkarpov15

.eslintignore

@@ -2,4 +2,5 @@ docs/
 bin/
 test/triage/
 test/model.discriminator.test.js
+tools/
 test/es6/

lib/document.js

@@ -328,7 +328,6 @@ Document.prototype.init = function(doc, opts, fn) {
   }
 
   init(this, doc, this._doc);
-  this.$__storeShard();
 
   this.emit('init', this);
   this.constructor.emit('init', this);
@@ -416,44 +415,6 @@ function init(self, obj, doc, prefix) {
   }
 }
 
-/**
- * Stores the current values of the shard keys.
- *
- * ####Note:
- *
- * _Shard key values do not / are not allowed to change._
- *
- * @api private
- * @method $__storeShard
- * @memberOf Document
- */
-
-Document.prototype.$__storeShard = function() {
-  // backwards compat
-  var key = this.schema.options.shardKey || this.schema.options.shardkey;
-  if (!(key && utils.getFunctionName(key.constructor) === 'Object')) {
-    return;
-  }
-
-  var orig = this.$__.shardval = {},
-      paths = Object.keys(key),
-      len = paths.length,
-      val;
-
-  for (var i = 0; i < len; ++i) {
-    val = this.getValue(paths[i]);
-    if (isMongooseObject(val)) {
-      orig[paths[i]] = val.toObject({depopulate: true, _isNested: true});
-    } else if (val !== null && val !== undefined && val.valueOf &&
-          // Explicitly don't take value of dates
-        (!val.constructor || utils.getFunctionName(val.constructor) !== 'Date')) {
-      orig[paths[i]] = val.valueOf();
-    } else {
-      orig[paths[i]] = val;
-    }
-  }
-};
-
 /*!
  * Set up middleware support
  */

lib/index.js

@@ -22,6 +22,7 @@ var validateBeforeSave = require('./plugins/validateBeforeSave');
 
 var Aggregate = require('./aggregate');
 var PromiseProvider = require('./promise_provider');
+var shardingPlugin = require('./plugins/sharding');
 
 /**
  * Mongoose constructor.
@@ -34,7 +35,6 @@ var PromiseProvider = require('./promise_provider');
 
 function Mongoose() {
   this.connections = [];
-  this.plugins = [];
   this.models = {};
   this.modelSchemas = {};
   // default global options
@@ -45,6 +45,21 @@ function Mongoose() {
   conn.models = this.models;
 }
 
+/*!
+ * ignore
+ */
+
+Object.defineProperty(Mongoose.prototype, 'plugins', {
+  configurable: false,
+  enumerable: true,
+  writable: false,
+  value: [
+    [saveSubdocs, { deduplicate: true }],
+    [validateBeforeSave, { deduplicate: true }],
+    [shardingPlugin, { deduplicate: true }]
+  ]
+});
+
 /**
  * Expose connection states for user-land
  *
@@ -366,13 +381,6 @@ Mongoose.prototype.model = function(name, schema, collection, skipInit) {
   }
 
   if (schema) {
-    // Reverse order because these both unshift()
-    if (!schema._plugins.saveSubdocs) {
-      schema.plugin(saveSubdocs);
-    }
-    if (!schema._plugins.validateBeforeSave) {
-      schema.plugin(validateBeforeSave);
-    }
     this._applyPlugins(schema);
   }
 

lib/model.js

@@ -218,7 +218,6 @@ Model.prototype.$__save = function(options, callback) {
     }
 
     _this.$__reset();
-    _this.$__storeShard();
 
     var numAffected = 0;
     if (result) {
@@ -669,7 +668,7 @@ Model.prototype.increment = function increment() {
 };
 
 /**
- * Returns a query object which applies shardkeys if they exist.
+ * Returns a query object
  *
  * @api private
  * @method $__where
@@ -679,22 +678,10 @@ Model.prototype.increment = function increment() {
 Model.prototype.$__where = function _where(where) {
   where || (where = {});
 
-  var paths,
-      len;
-
   if (!where._id) {
     where._id = this._doc._id;
   }
 
-  if (this.$__.shardval) {
-    paths = Object.keys(this.$__.shardval);
-    len = paths.length;
-
-    for (var i = 0; i < len; ++i) {
-      where[paths[i]] = this.$__.shardval[paths[i]];
-    }
-  }
-
   if (this._doc._id == null) {
     return new Error('No _id found on document!');
   }

lib/plugins/saveSubdocs.js

@@ -7,8 +7,6 @@ var each = require('async/each');
  */
 
 module.exports = function(schema) {
-  schema._plugins.saveSubdocs = true;
-
   schema.callQueue.unshift(['pre', ['save', function(next) {
     if (this.ownerDocument) {
       next();

lib/plugins/sharding.js

@@ -0,0 +1,71 @@
+'use strict';
+
+var utils = require('../utils');
+
+module.exports = function shardingPlugin(schema) {
+  schema.post('init', function() {
+    storeShard.call(this);
+    return this;
+  });
+  schema.pre('save', function(next) {
+    applyWhere.call(this);
+    next();
+  });
+  schema.post('save', function() {
+    storeShard.call(this);
+  });
+};
+
+function applyWhere() {
+  var paths;
+  var len;
+
+  if (this.$__.shardval) {
+    paths = Object.keys(this.$__.shardval);
+    len = paths.length;
+
+    this.$where = this.$where || {};
+    for (var i = 0; i < len; ++i) {
+      this.$where[paths[i]] = this.$__.shardval[paths[i]];
+    }
+  }
+}
+
+/*!
+ * Stores the current values of the shard keys.
+ *
+ * ####Note:
+ *
+ * _Shard key values do not / are not allowed to change._
+ *
+ * @api private
+ * @method $__storeShard
+ * @memberOf Document
+ */
+module.exports.storeShard = storeShard;
+
+function storeShard() {
+  // backwards compat
+  var key = this.schema.options.shardKey || this.schema.options.shardkey;
+  if (!(key && utils.getFunctionName(key.constructor) === 'Object')) {
+    return;
+  }
+
+  var orig = this.$__.shardval = {},
+      paths = Object.keys(key),
+      len = paths.length,
+      val;
+
+  for (var i = 0; i < len; ++i) {
+    val = this.getValue(paths[i]);
+    if (utils.isMongooseObject(val)) {
+      orig[paths[i]] = val.toObject({depopulate: true, _isNested: true});
+    } else if (val !== null && val !== undefined && val.valueOf &&
+          // Explicitly don't take value of dates
+        (!val.constructor || utils.getFunctionName(val.constructor) !== 'Date')) {
+      orig[paths[i]] = val.valueOf();
+    } else {
+      orig[paths[i]] = val;
+    }
+  }
+}

lib/plugins/validateBeforeSave.js

@@ -5,8 +5,6 @@
  */
 
 module.exports = function(schema) {
-  schema._plugins.validateBeforeSave = true;
-
   schema.callQueue.unshift(['pre', ['save', function(next, options) {
     var _this = this;
     // Nested docs have their own presave

lib/schema.js

@@ -86,7 +86,7 @@ function Schema(obj, options) {
   this.tree = {};
   this.query = {};
   this.childSchemas = [];
-  this._plugins = {};
+  this.plugins = [];
 
   this.s = {
     hooks: new Kareem(),
@@ -273,7 +273,7 @@ Schema.prototype.clone = function() {
   s.callQueue = this.callQueue.map(function(f) { return f; });
   s.methods = utils.clone(this.methods);
   s.statics = utils.clone(this.statics);
-  s._plugins = utils.clone(this._plugins);
+  s.plugins = Array.prototype.slice.call(this.plugins);
   s.s.hooks = this.s.hooks.clone();
   return s;
 };
@@ -1113,6 +1113,17 @@ Schema.prototype.plugin = function(fn, opts) {
     throw new Error('First param to `schema.plugin()` must be a function, ' +
       'got "' + (typeof fn) + '"');
   }
+
+  if (opts &&
+      opts.deduplicate) {
+    for (var i = 0; i < this.plugins.length; ++i) {
+      if (this.plugins[i].fn === fn) {
+        return this;
+      }
+    }
+  }
+  this.plugins.push({ fn: fn, opts: opts });
+
   fn(this, opts);
   return this;
 };

lib/services/model/discriminator.js

@@ -84,6 +84,7 @@ module.exports = function discriminator(model, name, schema) {
     schema.options.id = id;
     schema.s.hooks = model.schema.s.hooks.merge(schema.s.hooks);
 
+    schema.plugins = Array.prototype.slice(baseSchema.plugins);
     schema.callQueue = baseSchema.callQueue.
       concat(schema.callQueue.slice(schema._defaultMiddleware.length));
     schema._requiredpaths = undefined; // reset just in case Schema#requiredPaths() was called on either schema

package.json

@@ -48,6 +48,7 @@
     "marked": "0.3.6",
     "mocha": "3.2.0",
     "mongoose-long": "0.1.1",
+    "mongodb-topology-manager": "1.0.11",
     "node-static": "0.7.7",
     "power-assert": "1.4.1",
     "q": "1.4.1",

test/connection.test.js

@@ -141,11 +141,6 @@ describe('connections:', function() {
 
     var mongod = 'mongodb://localhost:27017';
 
-    var repl1 = process.env.MONGOOSE_SET_TEST_URI;
-    var repl2 = repl1.replace('mongodb://', '').split(',');
-    repl2.push(repl2.shift());
-    repl2 = 'mongodb://' + repl2.join(',');
-
     describe('with different host/port', function() {
       it('non-replica set', function(done) {
         var db = mongoose.createConnection();
@@ -195,59 +190,6 @@ describe('connections:', function() {
           });
         });
       });
-
-      it('replica set', function(done) {
-        var db = mongoose.createConnection();
-
-        db.openSet(repl1, function(err) {
-          if (err) {
-            return done(err);
-          }
-
-          var hosts = db.hosts.slice();
-          var db1 = db.db;
-
-          db.close(function(err) {
-            if (err) {
-              return done(err);
-            }
-
-            db.openSet(repl2, function(err) {
-              if (err) {
-                return done(err);
-              }
-
-              db.hosts.forEach(function(host, i) {
-                assert.notEqual(host.port, hosts[i].port);
-              });
-              assert.ok(db1 !== db.db);
-
-              hosts = db.hosts.slice();
-              var db2 = db.db;
-
-              db.close(function(err) {
-                if (err) {
-                  return done(err);
-                }
-
-                db.openSet(repl1, function(err) {
-                  if (err) {
-                    return done(err);
-                  }
-
-                  db.hosts.forEach(function(host, i) {
-                    assert.notEqual(host.port, hosts[i].port);
-                  });
-                  assert.ok(db2 !== db.db);
-
-                  db.close();
-                  done();
-                });
-              });
-            });
-          });
-        });
-      });
     });
   });
 

test/document.unit.test.js

@@ -2,8 +2,10 @@
  * Module dependencies.
  */
 
-var start = require('./common');
 var assert = require('power-assert');
+var start = require('./common');
+var storeShard = require('../lib/plugins/sharding').storeShard;
+
 var mongoose = start.mongoose;
 
 describe('sharding', function() {
@@ -22,7 +24,7 @@ describe('sharding', function() {
     var currentTime = new Date();
     d._doc = {date: currentTime};
 
-    d.$__storeShard();
+    storeShard.call(d);
     assert.equal(d.$__.shardval.date, currentTime);
     done();
   });