Merge pull request #10 from holidayextras/db-filter

Handle all filtering at the database layer

Author: Oliver Rumbelow

CHANGELOG.md

@@ -2,3 +2,5 @@
 2015-12-21 - Pagination support
 2015-12-21 - Sort support
 2015-12-21 - v1.0.0
+2015-12-30 - Offload queries to Mongo
+2015-12-30 - v1.1.0

lib/mongoHandler.js

@@ -1,6 +1,5 @@
 "use strict";
 var _ = {
-  clone: require("lodash.clone"),
   omit: require("lodash.omit")
 };
 var async = require("async");
@@ -30,7 +29,7 @@ MongoStore._isRelationshipAttribute = function(attribute) {
 
 
 MongoStore._toMongoDocument = function(resource) {
-  var document = _.clone(resource, true);
+  var document = _.omit(resource, function(value) { return value === undefined; });
   document._id = MongoStore._mongoUuid(document.id);
   return document;
 };
@@ -49,18 +48,46 @@ MongoStore._getRelationshipAttributeNames = function(attributes) {
 };
 
 
-MongoStore._getSearchCriteria = function(relationships) {
-  if (!relationships) return {};
+MongoStore.prototype._getSearchCriteria = function(request) {
+  var self = this;
+  if (!request.params.filter) return { };
+
+  var criteria = Object.keys(request.params.filter).map(function(attribute) {
+    var attributeConfig = self.resourceConfig.attributes[attribute];
+    // If the filter attribute doens't exist, skip it
+    if (!attributeConfig) return null;
+
+    var values = request.params.filter[attribute];
+    // Relationships need to be queried via .id
+    if (attributeConfig._settings) {
+      attribute += ".id";
+      // Filters on nested resources should be skipped
+      if (values instanceof Object) return null;
+    }
 
-  var relationshipNames = Object.getOwnPropertyNames(relationships);
-  var criteria = relationshipNames.reduce(function(partialCriteria, relationshipName) {
-    var relationshipId = relationships[relationshipName];
-    partialCriteria[relationshipName + ".id"] = relationshipId;
-    return partialCriteria;
-  }, {});
-  debug("criteria>", JSON.stringify(criteria, null, 2));
+    // Coerce values to an array to simplify the logic
+    if (!(values instanceof Array)) values = [ values ];
+    values = values.map(function(value) {
+      if (value[0] === "<") return { $lt: value.substring(1) };
+      if (value[0] === ">") return { $gt: value.substring(1) };
+      if (value[0] === "~") return new RegExp("^" + value.substring(1) + "$", "i");
+      if (value[0] === ":") return new RegExp(value.substring(1));
+      return value;
+    }).map(function(value) {
+      var tmp = { };
+      tmp[attribute] = value;
+      return tmp;
+    });
+
+    return { $or: values };
+  }).filter(function(value) {
+    return value !== null;
+  });
 
-  return criteria;
+  if (criteria.length === 0) {
+    return { };
+  }
+  return { $and: criteria };
 };
 
 
@@ -95,7 +122,6 @@ MongoStore.prototype._applySort = function(request, cursor) {
   }
   var sortParam = { };
   sortParam[attribute] = order;
-  debug("sort>", sortParam);
 
   return cursor.sort(sortParam);
 };
@@ -104,7 +130,6 @@ MongoStore.prototype._applySort = function(request, cursor) {
 MongoStore.prototype._applyPagination = function(request, cursor) {
   if (!request.params.page) return cursor;
 
-  debug("pagination>", request.params.page.offset, request.params.page.limit);
   return cursor.skip(request.params.page.offset).limit(request.params.page.limit);
 };
 
@@ -125,7 +150,6 @@ MongoStore.prototype.initialise = function(resourceConfig) {
     return console.error("error connecting to MongoDB:", err.message);
   }).then(function() {
     var resourceName = resourceConfig.resource;
-    debug("initialising resource [" + resourceName + "]");
     var collection = self._db.collection(resourceName);
     self._createIndexesForRelationships(collection, self.relationshipAttributeNames);
     self.ready = true;
@@ -156,7 +180,8 @@ MongoStore.prototype.populate = function(callback) {
 MongoStore.prototype.search = function(request, callback) {
   var self = this;
   var collection = self._db.collection(request.params.type);
-  var criteria = MongoStore._getSearchCriteria(request.params.relationships);
+  var criteria = self._getSearchCriteria(request);
+  debug("search", JSON.stringify(criteria));
 
   async.parallel({
     resultSet: function(asyncCallback) {
@@ -180,6 +205,8 @@ MongoStore.prototype.search = function(request, callback) {
 MongoStore.prototype.find = function(request, callback) {
   var collection = this._db.collection(request.params.type);
   var documentId = MongoStore._mongoUuid(request.params.id);
+
+  debug("findOne", JSON.stringify({ _id: documentId }));
   collection.findOne({ _id: documentId }, { _id: 0 }, function(err, result) {
     if (err || !result) {
       return callback(MongoStore._notFoundError(request.params.type, request.params.id));
@@ -195,6 +222,7 @@ MongoStore.prototype.find = function(request, callback) {
 MongoStore.prototype.create = function(request, newResource, callback) {
   var collection = this._db.collection(newResource.type);
   var document = MongoStore._toMongoDocument(newResource);
+  debug("insert", JSON.stringify(document));
   collection.insertOne(document, function(err) {
     if (err) return callback(err);
     collection.findOne(document, { _id: 0 }, callback);
@@ -226,7 +254,7 @@ MongoStore.prototype.update = function(request, partialResource, callback) {
   var collection = this._db.collection(request.params.type);
   var documentId = MongoStore._mongoUuid(request.params.id);
   var partialDocument = _.omit(partialResource, function(value) { return value === undefined; });
-  debug("partialDocument>", JSON.stringify(partialDocument, null, 2));
+  debug("findOneAndUpdate", JSON.stringify(partialDocument));
   collection.findOneAndUpdate({
     _id: documentId
   }, {
@@ -235,12 +263,16 @@ MongoStore.prototype.update = function(request, partialResource, callback) {
     returnOriginal: false,
     projection: { _id: 0 }
   }, function(err, result) {
-    debug("err>", JSON.stringify(err, null, 2));
-    debug("result>", JSON.stringify(result, null, 2));
-    if (err) return callback(err);
+    if (err) {
+      debug("err", JSON.stringify(err));
+      return callback(err);
+    }
+
     if (!result || !result.value) {
       return callback(MongoStore._notFoundError(request.params.type, request.params.id));
     }
+
+    debug("result", JSON.stringify(result));
     return callback(null, result.value);
   });
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsonapi-store-mongodb",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "MongoDB data store for jsonapi-server.",
   "main": "lib/mongoHandler.js",
   "repository": {
@@ -27,7 +27,6 @@
   "dependencies": {
     "async": "1.5.0",
     "debug": "2.2.0",
-    "lodash.clone": "3.0.3",
     "lodash.omit": "3.1.0",
     "mongodb": "2.0.48"
   },