Add multitenancy

Author: buildymcbuildy

common/models/change.js

@@ -186,27 +186,51 @@ module.exports = function(Change) {
 
     cb = cb || utils.createPromiseCallback();
 
-    change.currentRevision(function(err, rev) {
+    var model = this.getModelCtor();
+    var id = this.getModelId();
+
+    model.findById(id, function(err, inst) {
       if (err) return cb(err);
 
-      // avoid setting rev and prev to the same value
-      if (currentRev === rev) {
-        change.debug('rev and prev are equal (not updating anything)');
-        return cb(null, change);
-      }
+      change.tenant = getTenant(model, inst);
 
-      // FIXME(@bajtos) Allo callers to pass in the checkpoint value
-      // (or even better - a memoized async function to get the cp value)
-      // That will enable `rectifyAll` to cache the checkpoint value
-      change.constructor.getCheckpointModel().current(
-        function(err, checkpoint) {
-          if (err) return cb(err);
-          doRectify(checkpoint, rev);
+      change.currentRevision(inst, function(err, rev) {
+        if (err) return cb(err);
+
+        // avoid setting rev and prev to the same value
+        if (currentRev === rev) {
+          change.debug('rev and prev are equal (not updating anything)');
+          return cb(null, change);
         }
-      );
+
+        // FIXME(@bajtos) Allow callers to pass in the checkpoint value
+        // (or even better - a memoized async function to get the cp value)
+        // That will enable `rectifyAll` to cache the checkpoint value
+        change.constructor.getCheckpointModel().current(
+          function(err, checkpoint) {
+            if (err) return cb(err);
+            doRectify(checkpoint, rev);
+          }
+        );
+      });
     });
     return cb.promise;
 
+    function getTenant(model, inst) {
+      var tenant = null;
+      var tenantProperty;
+
+      if (model && model.settings && model.settings.tenantProperty) {
+        tenantProperty = model.settings.tenantProperty;
+      }
+
+      if (tenantProperty && inst && inst[tenantProperty]) {
+        tenant = inst[tenantProperty];
+      }
+
+      return tenant;
+    }
+
     function doRectify(checkpoint, rev) {
       if (rev) {
         if (currentRev === rev) {
@@ -230,7 +254,7 @@ module.exports = function(Change) {
           if (currentRev) {
             change.prev = currentRev;
           } else if (!change.prev) {
-            change.debug('ERROR - could not determing prev');
+            change.debug('ERROR - could not determining prev');
             change.prev = Change.UNKNOWN;
           }
           change.debug('updated prev');
@@ -254,23 +278,35 @@ module.exports = function(Change) {
 
   /**
    * Get a change's current revision based on current data.
+   * @param  {Object} instance Optional instance object to get the revision string for, if not provided it will be queried
    * @callback  {Function} callback
    * @param {Error} err
    * @param {String} rev The current revision
    */
 
-  Change.prototype.currentRevision = function(cb) {
+  Change.prototype.currentRevision = function(instance, cb) {
+    // if only one argument was provided, then set that as the callback
+    if (typeof instance === 'function') {
+      cb = instance;
+      instance = null;
+    }
+
     cb = cb || utils.createPromiseCallback();
-    var model = this.getModelCtor();
-    var id = this.getModelId();
-    model.findById(id, function(err, inst) {
-      if (err) return cb(err);
-      if (inst) {
-        cb(null, Change.revisionForInst(inst));
-      } else {
-        cb(null, null);
-      }
-    });
+
+    if (instance) {
+      cb(null, Change.revisionForInst(instance));
+    } else {
+      var model = this.getModelCtor();
+      var id = this.getModelId();
+      model.findById(id, function(err, inst) {
+        if (err) return cb(err);
+        if (inst) {
+          cb(null, Change.revisionForInst(inst));
+        } else {
+          cb(null, null);
+        }
+      });
+    }
     return cb.promise;
   };
 

common/models/change.json

@@ -20,6 +20,10 @@
     },
     "modelId": {
       "type": "string"
+    },
+    "tenant": {
+      "type": "string",
+      "default": null
     }
   }
 }

lib/persisted-model.js

@@ -740,8 +740,8 @@ module.exports = function(registry) {
       accepts: [
         { arg: 'id', type: 'any', description: 'Model id', required: true,
           http: { source: 'path' }},
-          { arg: 'data', type: 'object', model: typeName, http: { source: 'body' }, description:
-        'Model instance data' },
+        { arg: 'data', type: 'object', model: typeName, http: { source: 'body' }, description:
+          'Model instance data' },
       ],
       returns: { arg: 'data', type: typeName, root: true },
       http: [{ verb: 'post', path: '/:id/replace' }],
@@ -813,7 +813,7 @@ module.exports = function(registry) {
       description: 'Delete a model instance by {{id}} from the data source.',
       accessType: 'WRITE',
       accepts: {arg: 'id', type: 'any', description: 'Model id', required: true,
-                http: {source: 'path'}},
+        http: {source: 'path'}},
       http: {verb: 'del', path: '/:id'},
       returns: {arg: 'count', type: 'object', root: true}
     });
@@ -865,7 +865,8 @@ module.exports = function(registry) {
         accessType: 'READ',
         accepts: [
           {arg: 'since', type: 'number', description: 'Only return changes since this checkpoint'},
-          {arg: 'filter', type: 'object', description: 'Only include changes that match this filter'}
+          {arg: 'filter', type: 'object', description: 'Only include changes that match this filter'},
+          {arg: 'tenant', type: 'string', description: 'Only include changes that match this tenant'},
         ],
         returns: {arg: 'changes', type: 'array', root: true},
         http: {verb: 'get', path: '/changes'}
@@ -996,12 +997,13 @@ module.exports = function(registry) {
    * to reduce the number of results returned.
    * @param  {Number}   since    Return only changes since this checkpoint.
    * @param  {Object}   filter   Include only changes that match this filter, the same as for [#persistedmodel-find](find()).
+   * @param  {String}   tenant   Include only changes for this tenant
    * @callback {Function} callback Callback function called with `(err, changes)` arguments.  Required.
    * @param {Error} err Error object; see [Error object](http://docs.strongloop.com/display/LB/Error+object).
    * @param {Array} changes An array of [Change](#change) objects.
    */
 
-  PersistedModel.changes = function(since, filter, callback) {
+  PersistedModel.changes = function(since, filter, tenant, callback) {
     if (typeof since === 'function') {
       filter = {};
       callback = since;
@@ -1012,21 +1014,32 @@ module.exports = function(registry) {
       since = -1;
       filter = {};
     }
+    if (typeof tenant === 'function') {
+      callback = tenant;
+      tenant = null;
+    }
 
     var idName = this.dataSource.idName(this.modelName);
     var Change = this.getChangeModel();
     var model = this;
+    var changeFilter = {
+      where: {
+        checkpoint: {gte: since},
+        modelName: this.modelName
+      }
+    };
+
+    if (tenant) {
+      changeFilter.where.tenant = tenant;
+    }
 
     filter = filter || {};
     filter.fields = {};
     filter.where = filter.where || {};
     filter.fields[idName] = true;
 
     // TODO(ritch) this whole thing could be optimized a bit more
-    Change.find({ where: {
-      checkpoint: { gte: since },
-      modelName: this.modelName
-    }}, function(err, changes) {
+    Change.find(changeFilter, function(err, changes) {
       if (err) return callback(err);
       if (!Array.isArray(changes) || changes.length === 0) return callback(null, []);
       var ids = changes.map(function(change) {
@@ -1176,7 +1189,7 @@ module.exports = function(registry) {
     async.waterfall(tasks, done);
 
     function getSourceChanges(cb) {
-      sourceModel.changes(since.source, options.filter, debug.enabled ? log : cb);
+      sourceModel.changes(since.source, options.filter, options.tenant, debug.enabled ? log : cb);
 
       function log(err, result) {
         if (err) return cb(err);