Merge pull request #20 from dynamiccast/test-custom-validation-message

Test custom validation message from sails-hook-validation

Author: dynamiccast

.travis.yml

@@ -3,4 +3,4 @@ node_js:
     - "6"
 before_script:
     - npm install -g mocha
-    - cd ./tests/dummy && npm install
+    - cd ./tests/dummy && npm install && cd ../../

README.md

@@ -46,6 +46,13 @@ As shown in [tests/dummy/api/controllers/UserController.js:24](https://github.co
 - `destroyOneRecord` DELETE /{model}
 - `updateOneRecord` PATCH /{model}/{id}
 
+## Data validation
+
+This module is compatible with default Sails.js waterline validations and *sails-hook-validation*. It will produce a JSON API error compliant object.
+
+When a validation error object is returned by Waterline, you can reject the request with `res.invalid(err)` where `err` is your response object.
+`res.negociate(err)` will also forward the request to the `invalid` response as expected.
+
 ## Customize serialized JSON models' attributes keys case
 
 While JSON API recommends multiple words variable to use a '-' as separator (http://jsonapi.org/recommendations/#naming) *sails-json-api-blueprints* remains open to `kebab-case` (the preferred), `snake_case`, `camelCase` or simply no change at all during serialization.

lib/api/responses/invalid.js

@@ -7,7 +7,7 @@
  * err must be returned from waterline with an error of type "E_VALIDATION"
  */
 
-module.exports = function badRequest(data, options) {
+module.exports = function invalid(data, options) {
 
   // Get access to `req`, `res`, & `sails`
   var req = this.req;
@@ -23,26 +23,7 @@ module.exports = function badRequest(data, options) {
     return res.serverError('res.invalid was called with invalid waterline error data\n');
   }
 
-  var errors = [];
-
-  for (var attributeName in data.invalidAttributes) {
-
-    var attributes = data.invalidAttributes[attributeName];
-
-    for (var index in attributes) {
-
-      var error = attributes[index];
-
-      errors.push({
-        detail: error.message,
-        source: {
-          pointer: "data/attributes/" + JsonApiService._convertCase(attributeName, JsonApiService.getAttributesSerializedCaseSetting())
-        }
-      });
-    }
-  }
-
   return res.json({
-    'errors': errors
+    'errors': JsonApiService.serializeWaterlineValidationError(data)
   });
 };

lib/api/services/JsonApiService.js

@@ -1,3 +1,4 @@
+const _ = require("lodash");
 const cleanObject = require('clean-object');
 const JSONAPISerializer = require('json-api-serializer');
 const Serializer = new JSONAPISerializer();
@@ -124,5 +125,33 @@ module.exports = {
     delete returnedValue.jsonapi; // Let's ignore the version for now
 
     return returnedValue;
+  },
+
+  // Turn a waterline validation error object into a JSON API compliant error object
+  serializeWaterlineValidationError: function(data) {
+
+    var errors = [];
+
+    // data.Errors is populated by sails-hook-validations and data.invalidAttributes is the default
+    var targetAttributes = (data.Errors !== undefined)  ? data.Errors : data.invalidAttributes;
+
+    for (var attributeName in targetAttributes) {
+
+      var attributes = targetAttributes[attributeName];
+
+      for (var index in attributes) {
+
+        var error = attributes[index];
+
+        errors.push({
+          detail: error.message,
+          source: {
+            pointer: "data/attributes/" + this._convertCase(attributeName, this.getAttributesSerializedCaseSetting())
+          }
+        });
+      }
+    }
+
+    return errors;
   }
 }

package.json

@@ -4,7 +4,9 @@
   "description": "Blueprints to turn a Sails.js API into a JSON API",
   "main": "index.js",
   "scripts": {
-    "test": "cd tests/dummy ; npm test"
+    "test": "npm run-script test-jsonapi ; npm run-script test-unit",
+    "test-jsonapi": "cd tests/dummy ; npm test",
+    "test-unit": "mocha tests/unit/**/*.test.js"
   },
   "repository": {
     "type": "git",
@@ -32,5 +34,10 @@
   },
   "sails": {
     "isHook": true
+  },
+  "devDependencies": {
+    "chai": "^3.5.0",
+    "mocha": "2.4.5",
+    "jsonapi-validator": "1.0.1"
   }
 }

tests/dummy/api/models/Category.js

@@ -8,7 +8,21 @@
 module.exports = {
 
   attributes: {
-    name: 'string'
+    name: {
+      type: 'string',
+      minLength: 2,
+      maxLength: 15,
+      required: true
+    }
+  },
+
+  //model validation messages definitions
+  validationMessages: { //hand for i18n & l10n
+    name: {
+      minLength: 'Minimum length is 2',
+      maxLength: 'Minimum length is 15',
+      required: 'Name is required'
+    }
   },
 
   autoCreatedAt: false,

tests/dummy/package.json

@@ -22,7 +22,8 @@
     "pluralize": "2.0.0",
     "rc": "1.0.1",
     "sails": "~0.12.3",
-    "sails-disk": "~0.10.9"
+    "sails-disk": "~0.10.9",
+    "sails-hook-validation": "^0.4.6"
   },
   "devDependencies": {
     "supertest": "^1.2.0",

tests/dummy/test/integration/controllers/Errors.test.js

@@ -124,7 +124,7 @@ describe('Error handling', function() {
         .expect({
           "errors": [
             {
-              "detail": "\"minLength\" validation rule failed for input: 'a'\nSpecifically, it threw an error.  Details:\n undefined",
+              "detail": "user.firstName.minLength",
               "source": {
                 "pointer": "data/attributes/first-name"
               }
@@ -135,4 +135,34 @@ describe('Error handling', function() {
     });
   });
 
+  describe("POST /categories with invalid attributes", function() {
+    it('Should return human readable errors from sails-hook-validation', function (done) {
+
+      var categoryToCreate = {
+        'data': {
+          'attributes': {
+            name: "a" // Invalid because minLength is 2
+          },
+          'type':'categories'
+        }
+      };
+
+      request(sails.hooks.http.app)
+        .post('/categories')
+        .send(categoryToCreate)
+        .expect(400)
+        .expect(validateJSONapi)
+        .expect({
+          errors: [
+            {
+              detail: "Minimum length is 2",
+              source: {
+                pointer: "data/attributes/name"
+              }
+            }
+            ]
+        })
+        .end(done);
+    });
+  });
 });

tests/unit/services/JsonApiService.test.js

@@ -0,0 +1,123 @@
+const JsonApiService = require("../../../lib/api/services/JsonApiService");
+var JSONAPIValidator = require('jsonapi-validator').Validator;
+const expect = require('chai').expect;
+
+validateJSONapi = function(data) {
+  var validator = new JSONAPIValidator();
+
+  try {
+    validator.validate(data);
+    return true;
+  } catch (e) {
+    return false;
+  }
+};
+
+sails = {
+  config: {}
+};
+
+describe("Is JsonApiService present", function() {
+
+  it("Should be an object", function() {
+
+    expect(JsonApiService).to.be.an('object');
+  });
+});
+
+describe("Serialize Waterline validation error", function() {
+
+  describe("Serialize default Waterline error object", function() {
+
+    const waterlineErr = {
+      "error": "E_VALIDATION",
+      "status": 400,
+      "summary": "1 attribute is invalid",
+      "model": "User",
+      "invalidAttributes": {
+        "firstName": [
+          {
+            "rule": "minLength",
+            "message": "\"minLength\" validation rule failed for input: 'a'\nSpecifically, it threw an error.  Details:\n undefined"
+          }
+        ]
+      }
+    };
+
+    const expectedOutput = {
+        "errors": [
+          {
+            "detail": "\"minLength\" validation rule failed for input: 'a'\nSpecifically, it threw an error.  Details:\n undefined",
+            "source": {
+              "pointer": "data/attributes/firstName"
+            }
+          }
+        ]
+      };
+
+    var jsonApiError = {
+      errors: JsonApiService.serializeWaterlineValidationError(waterlineErr)
+    };
+
+    it("Should be valid JSON API", function() {
+
+      expect(jsonApiError).to.satisfy(validateJSONapi);
+    });
+
+    it("Should produce expected output", function() {
+
+      expect(jsonApiError).to.deep.equal(expectedOutput);
+    });
+  });
+
+  describe("Serialize Waterline error object produces by sails-validation-hook", function() {
+
+    const waterlineErr = {
+      "error": "E_VALIDATION",
+      "status": 400,
+      "summary": "1 attribute is invalid",
+      "model": "User",
+      "invalidAttributes": {
+        "firstName": [
+          {
+            "rule": "minLength",
+            "message": "\"minLength\" validation rule failed for input: 'a'\nSpecifically, it threw an error.  Details:\n undefined"
+          }
+        ]
+      },
+      "Errors": {
+        "firstName": [
+          {
+            "rule": "minLength",
+            "message": "Minimum length is 2"
+          }
+        ]
+      }
+    };
+
+    const expectedOutput = {
+      "errors": [
+        {
+          "detail": "Minimum length is 2",
+          "source": {
+            "pointer": "data/attributes/firstName"
+          }
+        }
+      ]
+    };
+
+    var jsonApiError = {
+      errors: JsonApiService.serializeWaterlineValidationError(waterlineErr)
+    };
+
+    it("Should be valid JSON API", function() {
+
+      expect(jsonApiError).to.satisfy(validateJSONapi);
+    });
+
+    it("Should produce expected output", function() {
+
+      expect(jsonApiError).to.deep.equal(expectedOutput);
+    });
+  });
+});