Merge pull request #29 from holidayextras/use-processed-filter-from-latest-server

Use processed filter from latest server

Author: pmcnr-hx

CHANGELOG.md

@@ -1,3 +1,5 @@
+- 2016-05-31 - v1.4.0
+- 2016-05-31 - Use latest `jsonapi-server` processed filter
 - 2016-04-22 - v1.3.0
 - 2016-04-22 - Improved index creation
 - 2016-04-22 - Better error handling on .find()

lib/mongoHandler.js

@@ -1,26 +1,35 @@
 "use strict";
 var _ = {
-  omit: require("lodash.omit")
+  omitBy: require("lodash.omitby")
 };
 var async = require("async");
 var debug = require("./debugging");
 var mongodb = require("mongodb");
 var Joi = require("joi");
+var semver = require("semver");
+
+var MIN_SERVER_VERSION = "1.10.0";
 
 var MongoStore = module.exports = function MongoStore(config) {
+  MongoStore._checkMinServerVersion();
   this._config = config;
 };
 
-
-var FILTER_OPERATORS = ["<", ">", "~", ":"];
-
-
 /**
   Handlers readiness status. This should be set to `true` once all handlers are ready to process requests.
  */
 MongoStore.prototype.ready = false;
 
 
+MongoStore._checkMinServerVersion = function() {
+  var serverVersion = require('jsonapi-server')._version;
+  if (!serverVersion) return;
+  if (semver.lt(serverVersion, MIN_SERVER_VERSION)) {
+    throw new Error("This version of jsonapi-store-mongodb requires jsonapi-server>=" + MIN_SERVER_VERSION + ".");
+  }
+};
+
+
 MongoStore._mongoUuid = function(uuid) {
   return new mongodb.Binary(uuid, mongodb.Binary.SUBTYPE_UUID);
 };
@@ -32,7 +41,7 @@ MongoStore._isRelationshipAttribute = function(attribute) {
 
 
 MongoStore._toMongoDocument = function(resource) {
-  var document = _.omit(resource, function(value) { return value === undefined; });
+  var document = _.omitBy(resource, function(value) { return value === undefined; });
   document._id = MongoStore._mongoUuid(document.id);
   return document;
 };
@@ -51,26 +60,9 @@ MongoStore._getRelationshipAttributeNames = function(attributes) {
 };
 
 
-MongoStore._splitFilterElement = function(filterElementStr) {
-  if (FILTER_OPERATORS.indexOf(filterElementStr[0]) !== -1) {
-    return { operator: filterElementStr[0], value: filterElementStr.substring(1) };
-  }
-  return { operator: null, value: filterElementStr };
-};
-
-
-MongoStore._filterElementToMongoExpr = function(attributeConfig, filterElementStr) {
-  var filterElement = MongoStore._splitFilterElement(filterElementStr);
+MongoStore._filterElementToMongoExpr = function(filterElement) {
   var value = filterElement.value;
-  if (!attributeConfig._settings) {  // not a relationship attribute
-    var validationResult = attributeConfig.validate(filterElement.value);
-    if (validationResult.error) return null;
-    value = validationResult.value;
-  }
   if (!filterElement.operator) return value;
-  if (["~", ":"].indexOf(filterElement.operator) !== -1 && typeof value !== "string") {
-    return null;
-  }
   var mongoExpr = {
     ">": { $gt: value },
     "<": { $lt: value },
@@ -83,24 +75,15 @@ MongoStore._filterElementToMongoExpr = function(attributeConfig, filterElementSt
 
 MongoStore.prototype._getSearchCriteria = function(request) {
   var self = this;
-  if (!request.params.filter) return { };
-
-  var criteria = Object.keys(request.params.filter).map(function(attribute) {
+  var filter = request.processedFilter;
+  if (!filter) return { };
+  var criteria = Object.keys(filter).map(function(attribute) {
+    var values = filter[attribute].map(MongoStore._filterElementToMongoExpr);
     var attributeConfig = self.resourceConfig.attributes[attribute];
-    // If the filter attribute doesn'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;
     }
-
-    values = [].concat(values); // Coerce values to an array to simplify the logic
-    var filterElemForAttrToMongoExpr = MongoStore._filterElementToMongoExpr.bind(null, attributeConfig);
-    values = values.map(filterElemForAttrToMongoExpr);
     values = values.reduce(function(mongoExpressions, mongoExpr) {
       if (mongoExpr !== null) {
         var mongoExprForAttr = { };
@@ -333,7 +316,7 @@ MongoStore.prototype.delete = function(request, callback) {
 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; });
+  var partialDocument = _.omitBy(partialResource, function(value) { return value === undefined; });
   debug("findOneAndUpdate", JSON.stringify(partialDocument));
   collection.findOneAndUpdate({
     _id: documentId

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsonapi-store-mongodb",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "MongoDB data store for jsonapi-server.",
   "main": "lib/mongoHandler.js",
   "repository": {
@@ -25,21 +25,22 @@
     "node": "*"
   },
   "dependencies": {
-    "async": "1.5.0",
-    "debug": "2.2.0",
-    "joi": "6.10.1",
-    "lodash.omit": "3.1.0",
-    "mongodb": "2.0.48"
+    "async": "^1.5.2",
+    "debug": "^2.2.0",
+    "joi": "^6.10.1",
+    "lodash.omitby": "^4.4.0",
+    "mongodb": "^2.1.20",
+    "semver": "^5.1.0"
   },
   "devDependencies": {
-    "blanket": "1.1.7",
-    "coveralls": "2.11.2",
-    "eslint": "0.24.1",
-    "jsonapi-server": "1.4.0",
-    "mocha": "2.2.5",
-    "mocha-lcov-reporter": "0.0.2",
-    "mocha-performance": "0.1.0",
-    "plato": "1.5.0",
+    "blanket": "^1.2.3",
+    "coveralls": "^2.11.9",
+    "eslint": "^2.11.0",
+    "jsonapi-server": "^1.10.0",
+    "mocha": "^2.5.3",
+    "mocha-lcov-reporter": "^1.2.0",
+    "mocha-performance": "^0.1.1",
+    "plato": "^1.5.0",
     "v8-profiler": "^5.6.0"
   },
   "scripts": {